1 //===--- CGStmt.cpp - Emit LLVM Code from Statements ----------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This contains code to emit Stmt nodes as LLVM code.
12 //===----------------------------------------------------------------------===//
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"
31 using namespace clang;
32 using namespace CodeGen;
34 //===----------------------------------------------------------------------===//
36 //===----------------------------------------------------------------------===//
38 void CodeGenFunction::EmitStopPoint(const Stmt *S) {
39 if (CGDebugInfo *DI = getDebugInfo()) {
41 Loc = S->getLocStart();
42 DI->EmitLocation(Builder, Loc);
48 void CodeGenFunction::EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs) {
49 assert(S && "Null statement?");
50 PGO.setCurrentStmt(S);
52 // These statements have their own debug info handling.
53 if (EmitSimpleStmt(S))
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!");
70 // Otherwise, make a new block to hold the code.
74 // Generate a stoppoint if we are emitting debug info.
77 // Ignore all OpenMP directives except for simd if OpenMP with Simd is
79 if (getLangOpts().OpenMP && getLangOpts().OpenMPSimd) {
80 if (const auto *D = dyn_cast<OMPExecutableDirective>(S)) {
81 EmitSimpleOMPExecutableDirective(*D);
86 switch (S->getStmtClass()) {
87 case Stmt::NoStmtClass:
88 case Stmt::CXXCatchStmtClass:
89 case Stmt::SEHExceptStmtClass:
90 case Stmt::SEHFinallyStmtClass:
91 case Stmt::MSDependentExistsStmtClass:
92 llvm_unreachable("invalid statement class to emit generically");
93 case Stmt::NullStmtClass:
94 case Stmt::CompoundStmtClass:
95 case Stmt::DeclStmtClass:
96 case Stmt::LabelStmtClass:
97 case Stmt::AttributedStmtClass:
98 case Stmt::GotoStmtClass:
99 case Stmt::BreakStmtClass:
100 case Stmt::ContinueStmtClass:
101 case Stmt::DefaultStmtClass:
102 case Stmt::CaseStmtClass:
103 case Stmt::SEHLeaveStmtClass:
104 llvm_unreachable("should have emitted these statements as simple");
106 #define STMT(Type, Base)
107 #define ABSTRACT_STMT(Op)
108 #define EXPR(Type, Base) \
109 case Stmt::Type##Class:
110 #include "clang/AST/StmtNodes.inc"
112 // Remember the block we came in on.
113 llvm::BasicBlock *incoming = Builder.GetInsertBlock();
114 assert(incoming && "expression emission must have an insertion point");
116 EmitIgnoredExpr(cast<Expr>(S));
118 llvm::BasicBlock *outgoing = Builder.GetInsertBlock();
119 assert(outgoing && "expression emission cleared block!");
121 // The expression emitters assume (reasonably!) that the insertion
122 // point is always set. To maintain that, the call-emission code
123 // for noreturn functions has to enter a new block with no
124 // predecessors. We want to kill that block and mark the current
125 // insertion point unreachable in the common case of a call like
126 // "exit();". Since expression emission doesn't otherwise create
127 // blocks with no predecessors, we can just test for that.
128 // However, we must be careful not to do this to our incoming
129 // block, because *statement* emission does sometimes create
130 // reachable blocks which will have no predecessors until later in
131 // the function. This occurs with, e.g., labels that are not
132 // reachable by fallthrough.
133 if (incoming != outgoing && outgoing->use_empty()) {
134 outgoing->eraseFromParent();
135 Builder.ClearInsertionPoint();
140 case Stmt::IndirectGotoStmtClass:
141 EmitIndirectGotoStmt(cast<IndirectGotoStmt>(*S)); break;
143 case Stmt::IfStmtClass: EmitIfStmt(cast<IfStmt>(*S)); break;
144 case Stmt::WhileStmtClass: EmitWhileStmt(cast<WhileStmt>(*S), Attrs); break;
145 case Stmt::DoStmtClass: EmitDoStmt(cast<DoStmt>(*S), Attrs); break;
146 case Stmt::ForStmtClass: EmitForStmt(cast<ForStmt>(*S), Attrs); break;
148 case Stmt::ReturnStmtClass: EmitReturnStmt(cast<ReturnStmt>(*S)); break;
150 case Stmt::SwitchStmtClass: EmitSwitchStmt(cast<SwitchStmt>(*S)); break;
151 case Stmt::GCCAsmStmtClass: // Intentional fall-through.
152 case Stmt::MSAsmStmtClass: EmitAsmStmt(cast<AsmStmt>(*S)); break;
153 case Stmt::CoroutineBodyStmtClass:
154 EmitCoroutineBody(cast<CoroutineBodyStmt>(*S));
156 case Stmt::CoreturnStmtClass:
157 EmitCoreturnStmt(cast<CoreturnStmt>(*S));
159 case Stmt::CapturedStmtClass: {
160 const CapturedStmt *CS = cast<CapturedStmt>(S);
161 EmitCapturedStmt(*CS, CS->getCapturedRegionKind());
164 case Stmt::ObjCAtTryStmtClass:
165 EmitObjCAtTryStmt(cast<ObjCAtTryStmt>(*S));
167 case Stmt::ObjCAtCatchStmtClass:
169 "@catch statements should be handled by EmitObjCAtTryStmt");
170 case Stmt::ObjCAtFinallyStmtClass:
172 "@finally statements should be handled by EmitObjCAtTryStmt");
173 case Stmt::ObjCAtThrowStmtClass:
174 EmitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(*S));
176 case Stmt::ObjCAtSynchronizedStmtClass:
177 EmitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(*S));
179 case Stmt::ObjCForCollectionStmtClass:
180 EmitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(*S));
182 case Stmt::ObjCAutoreleasePoolStmtClass:
183 EmitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(*S));
186 case Stmt::CXXTryStmtClass:
187 EmitCXXTryStmt(cast<CXXTryStmt>(*S));
189 case Stmt::CXXForRangeStmtClass:
190 EmitCXXForRangeStmt(cast<CXXForRangeStmt>(*S), Attrs);
192 case Stmt::SEHTryStmtClass:
193 EmitSEHTryStmt(cast<SEHTryStmt>(*S));
195 case Stmt::OMPParallelDirectiveClass:
196 EmitOMPParallelDirective(cast<OMPParallelDirective>(*S));
198 case Stmt::OMPSimdDirectiveClass:
199 EmitOMPSimdDirective(cast<OMPSimdDirective>(*S));
201 case Stmt::OMPForDirectiveClass:
202 EmitOMPForDirective(cast<OMPForDirective>(*S));
204 case Stmt::OMPForSimdDirectiveClass:
205 EmitOMPForSimdDirective(cast<OMPForSimdDirective>(*S));
207 case Stmt::OMPSectionsDirectiveClass:
208 EmitOMPSectionsDirective(cast<OMPSectionsDirective>(*S));
210 case Stmt::OMPSectionDirectiveClass:
211 EmitOMPSectionDirective(cast<OMPSectionDirective>(*S));
213 case Stmt::OMPSingleDirectiveClass:
214 EmitOMPSingleDirective(cast<OMPSingleDirective>(*S));
216 case Stmt::OMPMasterDirectiveClass:
217 EmitOMPMasterDirective(cast<OMPMasterDirective>(*S));
219 case Stmt::OMPCriticalDirectiveClass:
220 EmitOMPCriticalDirective(cast<OMPCriticalDirective>(*S));
222 case Stmt::OMPParallelForDirectiveClass:
223 EmitOMPParallelForDirective(cast<OMPParallelForDirective>(*S));
225 case Stmt::OMPParallelForSimdDirectiveClass:
226 EmitOMPParallelForSimdDirective(cast<OMPParallelForSimdDirective>(*S));
228 case Stmt::OMPParallelSectionsDirectiveClass:
229 EmitOMPParallelSectionsDirective(cast<OMPParallelSectionsDirective>(*S));
231 case Stmt::OMPTaskDirectiveClass:
232 EmitOMPTaskDirective(cast<OMPTaskDirective>(*S));
234 case Stmt::OMPTaskyieldDirectiveClass:
235 EmitOMPTaskyieldDirective(cast<OMPTaskyieldDirective>(*S));
237 case Stmt::OMPBarrierDirectiveClass:
238 EmitOMPBarrierDirective(cast<OMPBarrierDirective>(*S));
240 case Stmt::OMPTaskwaitDirectiveClass:
241 EmitOMPTaskwaitDirective(cast<OMPTaskwaitDirective>(*S));
243 case Stmt::OMPTaskgroupDirectiveClass:
244 EmitOMPTaskgroupDirective(cast<OMPTaskgroupDirective>(*S));
246 case Stmt::OMPFlushDirectiveClass:
247 EmitOMPFlushDirective(cast<OMPFlushDirective>(*S));
249 case Stmt::OMPOrderedDirectiveClass:
250 EmitOMPOrderedDirective(cast<OMPOrderedDirective>(*S));
252 case Stmt::OMPAtomicDirectiveClass:
253 EmitOMPAtomicDirective(cast<OMPAtomicDirective>(*S));
255 case Stmt::OMPTargetDirectiveClass:
256 EmitOMPTargetDirective(cast<OMPTargetDirective>(*S));
258 case Stmt::OMPTeamsDirectiveClass:
259 EmitOMPTeamsDirective(cast<OMPTeamsDirective>(*S));
261 case Stmt::OMPCancellationPointDirectiveClass:
262 EmitOMPCancellationPointDirective(cast<OMPCancellationPointDirective>(*S));
264 case Stmt::OMPCancelDirectiveClass:
265 EmitOMPCancelDirective(cast<OMPCancelDirective>(*S));
267 case Stmt::OMPTargetDataDirectiveClass:
268 EmitOMPTargetDataDirective(cast<OMPTargetDataDirective>(*S));
270 case Stmt::OMPTargetEnterDataDirectiveClass:
271 EmitOMPTargetEnterDataDirective(cast<OMPTargetEnterDataDirective>(*S));
273 case Stmt::OMPTargetExitDataDirectiveClass:
274 EmitOMPTargetExitDataDirective(cast<OMPTargetExitDataDirective>(*S));
276 case Stmt::OMPTargetParallelDirectiveClass:
277 EmitOMPTargetParallelDirective(cast<OMPTargetParallelDirective>(*S));
279 case Stmt::OMPTargetParallelForDirectiveClass:
280 EmitOMPTargetParallelForDirective(cast<OMPTargetParallelForDirective>(*S));
282 case Stmt::OMPTaskLoopDirectiveClass:
283 EmitOMPTaskLoopDirective(cast<OMPTaskLoopDirective>(*S));
285 case Stmt::OMPTaskLoopSimdDirectiveClass:
286 EmitOMPTaskLoopSimdDirective(cast<OMPTaskLoopSimdDirective>(*S));
288 case Stmt::OMPDistributeDirectiveClass:
289 EmitOMPDistributeDirective(cast<OMPDistributeDirective>(*S));
291 case Stmt::OMPTargetUpdateDirectiveClass:
292 EmitOMPTargetUpdateDirective(cast<OMPTargetUpdateDirective>(*S));
294 case Stmt::OMPDistributeParallelForDirectiveClass:
295 EmitOMPDistributeParallelForDirective(
296 cast<OMPDistributeParallelForDirective>(*S));
298 case Stmt::OMPDistributeParallelForSimdDirectiveClass:
299 EmitOMPDistributeParallelForSimdDirective(
300 cast<OMPDistributeParallelForSimdDirective>(*S));
302 case Stmt::OMPDistributeSimdDirectiveClass:
303 EmitOMPDistributeSimdDirective(cast<OMPDistributeSimdDirective>(*S));
305 case Stmt::OMPTargetParallelForSimdDirectiveClass:
306 EmitOMPTargetParallelForSimdDirective(
307 cast<OMPTargetParallelForSimdDirective>(*S));
309 case Stmt::OMPTargetSimdDirectiveClass:
310 EmitOMPTargetSimdDirective(cast<OMPTargetSimdDirective>(*S));
312 case Stmt::OMPTeamsDistributeDirectiveClass:
313 EmitOMPTeamsDistributeDirective(cast<OMPTeamsDistributeDirective>(*S));
315 case Stmt::OMPTeamsDistributeSimdDirectiveClass:
316 EmitOMPTeamsDistributeSimdDirective(
317 cast<OMPTeamsDistributeSimdDirective>(*S));
319 case Stmt::OMPTeamsDistributeParallelForSimdDirectiveClass:
320 EmitOMPTeamsDistributeParallelForSimdDirective(
321 cast<OMPTeamsDistributeParallelForSimdDirective>(*S));
323 case Stmt::OMPTeamsDistributeParallelForDirectiveClass:
324 EmitOMPTeamsDistributeParallelForDirective(
325 cast<OMPTeamsDistributeParallelForDirective>(*S));
327 case Stmt::OMPTargetTeamsDirectiveClass:
328 EmitOMPTargetTeamsDirective(cast<OMPTargetTeamsDirective>(*S));
330 case Stmt::OMPTargetTeamsDistributeDirectiveClass:
331 EmitOMPTargetTeamsDistributeDirective(
332 cast<OMPTargetTeamsDistributeDirective>(*S));
334 case Stmt::OMPTargetTeamsDistributeParallelForDirectiveClass:
335 EmitOMPTargetTeamsDistributeParallelForDirective(
336 cast<OMPTargetTeamsDistributeParallelForDirective>(*S));
338 case Stmt::OMPTargetTeamsDistributeParallelForSimdDirectiveClass:
339 EmitOMPTargetTeamsDistributeParallelForSimdDirective(
340 cast<OMPTargetTeamsDistributeParallelForSimdDirective>(*S));
342 case Stmt::OMPTargetTeamsDistributeSimdDirectiveClass:
343 EmitOMPTargetTeamsDistributeSimdDirective(
344 cast<OMPTargetTeamsDistributeSimdDirective>(*S));
349 bool CodeGenFunction::EmitSimpleStmt(const Stmt *S) {
350 switch (S->getStmtClass()) {
351 default: return false;
352 case Stmt::NullStmtClass: break;
353 case Stmt::CompoundStmtClass: EmitCompoundStmt(cast<CompoundStmt>(*S)); break;
354 case Stmt::DeclStmtClass: EmitDeclStmt(cast<DeclStmt>(*S)); break;
355 case Stmt::LabelStmtClass: EmitLabelStmt(cast<LabelStmt>(*S)); break;
356 case Stmt::AttributedStmtClass:
357 EmitAttributedStmt(cast<AttributedStmt>(*S)); break;
358 case Stmt::GotoStmtClass: EmitGotoStmt(cast<GotoStmt>(*S)); break;
359 case Stmt::BreakStmtClass: EmitBreakStmt(cast<BreakStmt>(*S)); break;
360 case Stmt::ContinueStmtClass: EmitContinueStmt(cast<ContinueStmt>(*S)); break;
361 case Stmt::DefaultStmtClass: EmitDefaultStmt(cast<DefaultStmt>(*S)); break;
362 case Stmt::CaseStmtClass: EmitCaseStmt(cast<CaseStmt>(*S)); break;
363 case Stmt::SEHLeaveStmtClass: EmitSEHLeaveStmt(cast<SEHLeaveStmt>(*S)); break;
369 /// EmitCompoundStmt - Emit a compound statement {..} node. If GetLast is true,
370 /// this captures the expression result of the last sub-statement and returns it
371 /// (for use by the statement expression extension).
372 Address CodeGenFunction::EmitCompoundStmt(const CompoundStmt &S, bool GetLast,
373 AggValueSlot AggSlot) {
374 PrettyStackTraceLoc CrashInfo(getContext().getSourceManager(),S.getLBracLoc(),
375 "LLVM IR generation of compound statement ('{}')");
377 // Keep track of the current cleanup stack depth, including debug scopes.
378 LexicalScope Scope(*this, S.getSourceRange());
380 return EmitCompoundStmtWithoutScope(S, GetLast, AggSlot);
384 CodeGenFunction::EmitCompoundStmtWithoutScope(const CompoundStmt &S,
386 AggValueSlot AggSlot) {
388 for (CompoundStmt::const_body_iterator I = S.body_begin(),
389 E = S.body_end()-GetLast; I != E; ++I)
392 Address RetAlloca = Address::invalid();
394 // We have to special case labels here. They are statements, but when put
395 // at the end of a statement expression, they yield the value of their
396 // subexpression. Handle this by walking through all labels we encounter,
397 // emitting them before we evaluate the subexpr.
398 const Stmt *LastStmt = S.body_back();
399 while (const LabelStmt *LS = dyn_cast<LabelStmt>(LastStmt)) {
400 EmitLabel(LS->getDecl());
401 LastStmt = LS->getSubStmt();
406 QualType ExprTy = cast<Expr>(LastStmt)->getType();
407 if (hasAggregateEvaluationKind(ExprTy)) {
408 EmitAggExpr(cast<Expr>(LastStmt), AggSlot);
410 // We can't return an RValue here because there might be cleanups at
411 // the end of the StmtExpr. Because of that, we have to emit the result
412 // here into a temporary alloca.
413 RetAlloca = CreateMemTemp(ExprTy);
414 EmitAnyExprToMem(cast<Expr>(LastStmt), RetAlloca, Qualifiers(),
423 void CodeGenFunction::SimplifyForwardingBlocks(llvm::BasicBlock *BB) {
424 llvm::BranchInst *BI = dyn_cast<llvm::BranchInst>(BB->getTerminator());
426 // If there is a cleanup stack, then we it isn't worth trying to
427 // simplify this block (we would need to remove it from the scope map
428 // and cleanup entry).
429 if (!EHStack.empty())
432 // Can only simplify direct branches.
433 if (!BI || !BI->isUnconditional())
436 // Can only simplify empty blocks.
437 if (BI->getIterator() != BB->begin())
440 BB->replaceAllUsesWith(BI->getSuccessor(0));
441 BI->eraseFromParent();
442 BB->eraseFromParent();
445 void CodeGenFunction::EmitBlock(llvm::BasicBlock *BB, bool IsFinished) {
446 llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
448 // Fall out of the current block (if necessary).
451 if (IsFinished && BB->use_empty()) {
456 // Place the block after the current block, if possible, or else at
457 // the end of the function.
458 if (CurBB && CurBB->getParent())
459 CurFn->getBasicBlockList().insertAfter(CurBB->getIterator(), BB);
461 CurFn->getBasicBlockList().push_back(BB);
462 Builder.SetInsertPoint(BB);
465 void CodeGenFunction::EmitBranch(llvm::BasicBlock *Target) {
466 // Emit a branch from the current block to the target one if this
467 // was a real block. If this was just a fall-through block after a
468 // terminator, don't emit it.
469 llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
471 if (!CurBB || CurBB->getTerminator()) {
472 // If there is no insert point or the previous block is already
473 // terminated, don't touch it.
475 // Otherwise, create a fall-through branch.
476 Builder.CreateBr(Target);
479 Builder.ClearInsertionPoint();
482 void CodeGenFunction::EmitBlockAfterUses(llvm::BasicBlock *block) {
483 bool inserted = false;
484 for (llvm::User *u : block->users()) {
485 if (llvm::Instruction *insn = dyn_cast<llvm::Instruction>(u)) {
486 CurFn->getBasicBlockList().insertAfter(insn->getParent()->getIterator(),
494 CurFn->getBasicBlockList().push_back(block);
496 Builder.SetInsertPoint(block);
499 CodeGenFunction::JumpDest
500 CodeGenFunction::getJumpDestForLabel(const LabelDecl *D) {
501 JumpDest &Dest = LabelMap[D];
502 if (Dest.isValid()) return Dest;
504 // Create, but don't insert, the new block.
505 Dest = JumpDest(createBasicBlock(D->getName()),
506 EHScopeStack::stable_iterator::invalid(),
507 NextCleanupDestIndex++);
511 void CodeGenFunction::EmitLabel(const LabelDecl *D) {
512 // Add this label to the current lexical scope if we're within any
513 // normal cleanups. Jumps "in" to this label --- when permitted by
514 // the language --- may need to be routed around such cleanups.
515 if (EHStack.hasNormalCleanups() && CurLexicalScope)
516 CurLexicalScope->addLabel(D);
518 JumpDest &Dest = LabelMap[D];
520 // If we didn't need a forward reference to this label, just go
521 // ahead and create a destination at the current scope.
522 if (!Dest.isValid()) {
523 Dest = getJumpDestInCurrentScope(D->getName());
525 // Otherwise, we need to give this label a target depth and remove
526 // it from the branch-fixups list.
528 assert(!Dest.getScopeDepth().isValid() && "already emitted label!");
529 Dest.setScopeDepth(EHStack.stable_begin());
530 ResolveBranchFixups(Dest.getBlock());
533 EmitBlock(Dest.getBlock());
534 incrementProfileCounter(D->getStmt());
537 /// Change the cleanup scope of the labels in this lexical scope to
538 /// match the scope of the enclosing context.
539 void CodeGenFunction::LexicalScope::rescopeLabels() {
540 assert(!Labels.empty());
541 EHScopeStack::stable_iterator innermostScope
542 = CGF.EHStack.getInnermostNormalCleanup();
544 // Change the scope depth of all the labels.
545 for (SmallVectorImpl<const LabelDecl*>::const_iterator
546 i = Labels.begin(), e = Labels.end(); i != e; ++i) {
547 assert(CGF.LabelMap.count(*i));
548 JumpDest &dest = CGF.LabelMap.find(*i)->second;
549 assert(dest.getScopeDepth().isValid());
550 assert(innermostScope.encloses(dest.getScopeDepth()));
551 dest.setScopeDepth(innermostScope);
554 // Reparent the labels if the new scope also has cleanups.
555 if (innermostScope != EHScopeStack::stable_end() && ParentScope) {
556 ParentScope->Labels.append(Labels.begin(), Labels.end());
561 void CodeGenFunction::EmitLabelStmt(const LabelStmt &S) {
562 EmitLabel(S.getDecl());
563 EmitStmt(S.getSubStmt());
566 void CodeGenFunction::EmitAttributedStmt(const AttributedStmt &S) {
567 EmitStmt(S.getSubStmt(), S.getAttrs());
570 void CodeGenFunction::EmitGotoStmt(const GotoStmt &S) {
571 // If this code is reachable then emit a stop point (if generating
572 // debug info). We have to do this ourselves because we are on the
573 // "simple" statement path.
574 if (HaveInsertPoint())
577 EmitBranchThroughCleanup(getJumpDestForLabel(S.getLabel()));
581 void CodeGenFunction::EmitIndirectGotoStmt(const IndirectGotoStmt &S) {
582 if (const LabelDecl *Target = S.getConstantTarget()) {
583 EmitBranchThroughCleanup(getJumpDestForLabel(Target));
587 // Ensure that we have an i8* for our PHI node.
588 llvm::Value *V = Builder.CreateBitCast(EmitScalarExpr(S.getTarget()),
590 llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
592 // Get the basic block for the indirect goto.
593 llvm::BasicBlock *IndGotoBB = GetIndirectGotoBlock();
595 // The first instruction in the block has to be the PHI for the switch dest,
596 // add an entry for this branch.
597 cast<llvm::PHINode>(IndGotoBB->begin())->addIncoming(V, CurBB);
599 EmitBranch(IndGotoBB);
602 void CodeGenFunction::EmitIfStmt(const IfStmt &S) {
603 // C99 6.8.4.1: The first substatement is executed if the expression compares
604 // unequal to 0. The condition must be a scalar type.
605 LexicalScope ConditionScope(*this, S.getCond()->getSourceRange());
608 EmitStmt(S.getInit());
610 if (S.getConditionVariable())
611 EmitDecl(*S.getConditionVariable());
613 // If the condition constant folds and can be elided, try to avoid emitting
614 // the condition and the dead arm of the if/else.
616 if (ConstantFoldsToSimpleInteger(S.getCond(), CondConstant,
618 // Figure out which block (then or else) is executed.
619 const Stmt *Executed = S.getThen();
620 const Stmt *Skipped = S.getElse();
621 if (!CondConstant) // Condition false?
622 std::swap(Executed, Skipped);
624 // If the skipped block has no labels in it, just emit the executed block.
625 // This avoids emitting dead code and simplifies the CFG substantially.
626 if (S.isConstexpr() || !ContainsLabel(Skipped)) {
628 incrementProfileCounter(&S);
630 RunCleanupsScope ExecutedScope(*this);
637 // Otherwise, the condition did not fold, or we couldn't elide it. Just emit
638 // the conditional branch.
639 llvm::BasicBlock *ThenBlock = createBasicBlock("if.then");
640 llvm::BasicBlock *ContBlock = createBasicBlock("if.end");
641 llvm::BasicBlock *ElseBlock = ContBlock;
643 ElseBlock = createBasicBlock("if.else");
645 EmitBranchOnBoolExpr(S.getCond(), ThenBlock, ElseBlock,
646 getProfileCount(S.getThen()));
648 // Emit the 'then' code.
649 EmitBlock(ThenBlock);
650 incrementProfileCounter(&S);
652 RunCleanupsScope ThenScope(*this);
653 EmitStmt(S.getThen());
655 EmitBranch(ContBlock);
657 // Emit the 'else' code if present.
658 if (const Stmt *Else = S.getElse()) {
660 // There is no need to emit line number for an unconditional branch.
661 auto NL = ApplyDebugLocation::CreateEmpty(*this);
662 EmitBlock(ElseBlock);
665 RunCleanupsScope ElseScope(*this);
669 // There is no need to emit line number for an unconditional branch.
670 auto NL = ApplyDebugLocation::CreateEmpty(*this);
671 EmitBranch(ContBlock);
675 // Emit the continuation block for code after the if.
676 EmitBlock(ContBlock, true);
679 void CodeGenFunction::EmitWhileStmt(const WhileStmt &S,
680 ArrayRef<const Attr *> WhileAttrs) {
681 // Emit the header for the loop, which will also become
682 // the continue target.
683 JumpDest LoopHeader = getJumpDestInCurrentScope("while.cond");
684 EmitBlock(LoopHeader.getBlock());
686 const SourceRange &R = S.getSourceRange();
687 LoopStack.push(LoopHeader.getBlock(), CGM.getContext(), WhileAttrs,
688 SourceLocToDebugLoc(R.getBegin()),
689 SourceLocToDebugLoc(R.getEnd()));
691 // Create an exit block for when the condition fails, which will
692 // also become the break target.
693 JumpDest LoopExit = getJumpDestInCurrentScope("while.end");
695 // Store the blocks to use for break and continue.
696 BreakContinueStack.push_back(BreakContinue(LoopExit, LoopHeader));
698 // C++ [stmt.while]p2:
699 // When the condition of a while statement is a declaration, the
700 // scope of the variable that is declared extends from its point
701 // of declaration (3.3.2) to the end of the while statement.
703 // The object created in a condition is destroyed and created
704 // with each iteration of the loop.
705 RunCleanupsScope ConditionScope(*this);
707 if (S.getConditionVariable())
708 EmitDecl(*S.getConditionVariable());
710 // Evaluate the conditional in the while header. C99 6.8.5.1: The
711 // evaluation of the controlling expression takes place before each
712 // execution of the loop body.
713 llvm::Value *BoolCondVal = EvaluateExprAsBool(S.getCond());
715 // while(1) is common, avoid extra exit blocks. Be sure
716 // to correctly handle break/continue though.
717 bool EmitBoolCondBranch = true;
718 if (llvm::ConstantInt *C = dyn_cast<llvm::ConstantInt>(BoolCondVal))
720 EmitBoolCondBranch = false;
722 // As long as the condition is true, go to the loop body.
723 llvm::BasicBlock *LoopBody = createBasicBlock("while.body");
724 if (EmitBoolCondBranch) {
725 llvm::BasicBlock *ExitBlock = LoopExit.getBlock();
726 if (ConditionScope.requiresCleanups())
727 ExitBlock = createBasicBlock("while.exit");
728 Builder.CreateCondBr(
729 BoolCondVal, LoopBody, ExitBlock,
730 createProfileWeightsForLoop(S.getCond(), getProfileCount(S.getBody())));
732 if (ExitBlock != LoopExit.getBlock()) {
733 EmitBlock(ExitBlock);
734 EmitBranchThroughCleanup(LoopExit);
738 // Emit the loop body. We have to emit this in a cleanup scope
739 // because it might be a singleton DeclStmt.
741 RunCleanupsScope BodyScope(*this);
743 incrementProfileCounter(&S);
744 EmitStmt(S.getBody());
747 BreakContinueStack.pop_back();
749 // Immediately force cleanup.
750 ConditionScope.ForceCleanup();
753 // Branch to the loop header again.
754 EmitBranch(LoopHeader.getBlock());
758 // Emit the exit block.
759 EmitBlock(LoopExit.getBlock(), true);
761 // The LoopHeader typically is just a branch if we skipped emitting
762 // a branch, try to erase it.
763 if (!EmitBoolCondBranch)
764 SimplifyForwardingBlocks(LoopHeader.getBlock());
767 void CodeGenFunction::EmitDoStmt(const DoStmt &S,
768 ArrayRef<const Attr *> DoAttrs) {
769 JumpDest LoopExit = getJumpDestInCurrentScope("do.end");
770 JumpDest LoopCond = getJumpDestInCurrentScope("do.cond");
772 uint64_t ParentCount = getCurrentProfileCount();
774 // Store the blocks to use for break and continue.
775 BreakContinueStack.push_back(BreakContinue(LoopExit, LoopCond));
777 // Emit the body of the loop.
778 llvm::BasicBlock *LoopBody = createBasicBlock("do.body");
780 EmitBlockWithFallThrough(LoopBody, &S);
782 RunCleanupsScope BodyScope(*this);
783 EmitStmt(S.getBody());
786 EmitBlock(LoopCond.getBlock());
788 const SourceRange &R = S.getSourceRange();
789 LoopStack.push(LoopBody, CGM.getContext(), DoAttrs,
790 SourceLocToDebugLoc(R.getBegin()),
791 SourceLocToDebugLoc(R.getEnd()));
793 // C99 6.8.5.2: "The evaluation of the controlling expression takes place
794 // after each execution of the loop body."
796 // Evaluate the conditional in the while header.
797 // C99 6.8.5p2/p4: The first substatement is executed if the expression
798 // compares unequal to 0. The condition must be a scalar type.
799 llvm::Value *BoolCondVal = EvaluateExprAsBool(S.getCond());
801 BreakContinueStack.pop_back();
803 // "do {} while (0)" is common in macros, avoid extra blocks. Be sure
804 // to correctly handle break/continue though.
805 bool EmitBoolCondBranch = true;
806 if (llvm::ConstantInt *C = dyn_cast<llvm::ConstantInt>(BoolCondVal))
808 EmitBoolCondBranch = false;
810 // As long as the condition is true, iterate the loop.
811 if (EmitBoolCondBranch) {
812 uint64_t BackedgeCount = getProfileCount(S.getBody()) - ParentCount;
813 Builder.CreateCondBr(
814 BoolCondVal, LoopBody, LoopExit.getBlock(),
815 createProfileWeightsForLoop(S.getCond(), BackedgeCount));
820 // Emit the exit block.
821 EmitBlock(LoopExit.getBlock());
823 // The DoCond block typically is just a branch if we skipped
824 // emitting a branch, try to erase it.
825 if (!EmitBoolCondBranch)
826 SimplifyForwardingBlocks(LoopCond.getBlock());
829 void CodeGenFunction::EmitForStmt(const ForStmt &S,
830 ArrayRef<const Attr *> ForAttrs) {
831 JumpDest LoopExit = getJumpDestInCurrentScope("for.end");
833 LexicalScope ForScope(*this, S.getSourceRange());
835 // Evaluate the first part before the loop.
837 EmitStmt(S.getInit());
839 // Start the loop with a block that tests the condition.
840 // If there's an increment, the continue scope will be overwritten
842 JumpDest Continue = getJumpDestInCurrentScope("for.cond");
843 llvm::BasicBlock *CondBlock = Continue.getBlock();
844 EmitBlock(CondBlock);
846 const SourceRange &R = S.getSourceRange();
847 LoopStack.push(CondBlock, CGM.getContext(), ForAttrs,
848 SourceLocToDebugLoc(R.getBegin()),
849 SourceLocToDebugLoc(R.getEnd()));
851 // If the for loop doesn't have an increment we can just use the
852 // condition as the continue block. Otherwise we'll need to create
853 // a block for it (in the current scope, i.e. in the scope of the
854 // condition), and that we will become our continue block.
856 Continue = getJumpDestInCurrentScope("for.inc");
858 // Store the blocks to use for break and continue.
859 BreakContinueStack.push_back(BreakContinue(LoopExit, Continue));
861 // Create a cleanup scope for the condition variable cleanups.
862 LexicalScope ConditionScope(*this, S.getSourceRange());
865 // If the for statement has a condition scope, emit the local variable
867 if (S.getConditionVariable()) {
868 EmitDecl(*S.getConditionVariable());
871 llvm::BasicBlock *ExitBlock = LoopExit.getBlock();
872 // If there are any cleanups between here and the loop-exit scope,
873 // create a block to stage a loop exit along.
874 if (ForScope.requiresCleanups())
875 ExitBlock = createBasicBlock("for.cond.cleanup");
877 // As long as the condition is true, iterate the loop.
878 llvm::BasicBlock *ForBody = createBasicBlock("for.body");
880 // C99 6.8.5p2/p4: The first substatement is executed if the expression
881 // compares unequal to 0. The condition must be a scalar type.
882 llvm::Value *BoolCondVal = EvaluateExprAsBool(S.getCond());
883 Builder.CreateCondBr(
884 BoolCondVal, ForBody, ExitBlock,
885 createProfileWeightsForLoop(S.getCond(), getProfileCount(S.getBody())));
887 if (ExitBlock != LoopExit.getBlock()) {
888 EmitBlock(ExitBlock);
889 EmitBranchThroughCleanup(LoopExit);
894 // Treat it as a non-zero constant. Don't even create a new block for the
895 // body, just fall into it.
897 incrementProfileCounter(&S);
900 // Create a separate cleanup scope for the body, in case it is not
901 // a compound statement.
902 RunCleanupsScope BodyScope(*this);
903 EmitStmt(S.getBody());
906 // If there is an increment, emit it next.
908 EmitBlock(Continue.getBlock());
909 EmitStmt(S.getInc());
912 BreakContinueStack.pop_back();
914 ConditionScope.ForceCleanup();
917 EmitBranch(CondBlock);
919 ForScope.ForceCleanup();
923 // Emit the fall-through block.
924 EmitBlock(LoopExit.getBlock(), true);
928 CodeGenFunction::EmitCXXForRangeStmt(const CXXForRangeStmt &S,
929 ArrayRef<const Attr *> ForAttrs) {
930 JumpDest LoopExit = getJumpDestInCurrentScope("for.end");
932 LexicalScope ForScope(*this, S.getSourceRange());
934 // Evaluate the first pieces before the loop.
935 EmitStmt(S.getRangeStmt());
936 EmitStmt(S.getBeginStmt());
937 EmitStmt(S.getEndStmt());
939 // Start the loop with a block that tests the condition.
940 // If there's an increment, the continue scope will be overwritten
942 llvm::BasicBlock *CondBlock = createBasicBlock("for.cond");
943 EmitBlock(CondBlock);
945 const SourceRange &R = S.getSourceRange();
946 LoopStack.push(CondBlock, CGM.getContext(), ForAttrs,
947 SourceLocToDebugLoc(R.getBegin()),
948 SourceLocToDebugLoc(R.getEnd()));
950 // If there are any cleanups between here and the loop-exit scope,
951 // create a block to stage a loop exit along.
952 llvm::BasicBlock *ExitBlock = LoopExit.getBlock();
953 if (ForScope.requiresCleanups())
954 ExitBlock = createBasicBlock("for.cond.cleanup");
956 // The loop body, consisting of the specified body and the loop variable.
957 llvm::BasicBlock *ForBody = createBasicBlock("for.body");
959 // The body is executed if the expression, contextually converted
961 llvm::Value *BoolCondVal = EvaluateExprAsBool(S.getCond());
962 Builder.CreateCondBr(
963 BoolCondVal, ForBody, ExitBlock,
964 createProfileWeightsForLoop(S.getCond(), getProfileCount(S.getBody())));
966 if (ExitBlock != LoopExit.getBlock()) {
967 EmitBlock(ExitBlock);
968 EmitBranchThroughCleanup(LoopExit);
972 incrementProfileCounter(&S);
974 // Create a block for the increment. In case of a 'continue', we jump there.
975 JumpDest Continue = getJumpDestInCurrentScope("for.inc");
977 // Store the blocks to use for break and continue.
978 BreakContinueStack.push_back(BreakContinue(LoopExit, Continue));
981 // Create a separate cleanup scope for the loop variable and body.
982 LexicalScope BodyScope(*this, S.getSourceRange());
983 EmitStmt(S.getLoopVarStmt());
984 EmitStmt(S.getBody());
988 // If there is an increment, emit it next.
989 EmitBlock(Continue.getBlock());
990 EmitStmt(S.getInc());
992 BreakContinueStack.pop_back();
994 EmitBranch(CondBlock);
996 ForScope.ForceCleanup();
1000 // Emit the fall-through block.
1001 EmitBlock(LoopExit.getBlock(), true);
1004 void CodeGenFunction::EmitReturnOfRValue(RValue RV, QualType Ty) {
1005 if (RV.isScalar()) {
1006 Builder.CreateStore(RV.getScalarVal(), ReturnValue);
1007 } else if (RV.isAggregate()) {
1008 LValue Dest = MakeAddrLValue(ReturnValue, Ty);
1009 LValue Src = MakeAddrLValue(RV.getAggregateAddress(), Ty);
1010 EmitAggregateCopy(Dest, Src, Ty, overlapForReturnValue());
1012 EmitStoreOfComplex(RV.getComplexVal(), MakeAddrLValue(ReturnValue, Ty),
1015 EmitBranchThroughCleanup(ReturnBlock);
1018 /// EmitReturnStmt - Note that due to GCC extensions, this can have an operand
1019 /// if the function returns void, or may be missing one if the function returns
1020 /// non-void. Fun stuff :).
1021 void CodeGenFunction::EmitReturnStmt(const ReturnStmt &S) {
1022 if (requiresReturnValueCheck()) {
1023 llvm::Constant *SLoc = EmitCheckSourceLocation(S.getLocStart());
1025 new llvm::GlobalVariable(CGM.getModule(), SLoc->getType(), false,
1026 llvm::GlobalVariable::PrivateLinkage, SLoc);
1027 SLocPtr->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1028 CGM.getSanitizerMetadata()->disableSanitizerForGlobal(SLocPtr);
1029 assert(ReturnLocation.isValid() && "No valid return location");
1030 Builder.CreateStore(Builder.CreateBitCast(SLocPtr, Int8PtrTy),
1034 // Returning from an outlined SEH helper is UB, and we already warn on it.
1035 if (IsOutlinedSEHHelper) {
1036 Builder.CreateUnreachable();
1037 Builder.ClearInsertionPoint();
1040 // Emit the result value, even if unused, to evaluate the side effects.
1041 const Expr *RV = S.getRetValue();
1043 // Treat block literals in a return expression as if they appeared
1044 // in their own scope. This permits a small, easily-implemented
1045 // exception to our over-conservative rules about not jumping to
1046 // statements following block literals with non-trivial cleanups.
1047 RunCleanupsScope cleanupScope(*this);
1048 if (const ExprWithCleanups *cleanups =
1049 dyn_cast_or_null<ExprWithCleanups>(RV)) {
1050 enterFullExpression(cleanups);
1051 RV = cleanups->getSubExpr();
1054 // FIXME: Clean this up by using an LValue for ReturnTemp,
1055 // EmitStoreThroughLValue, and EmitAnyExpr.
1056 if (getLangOpts().ElideConstructors &&
1057 S.getNRVOCandidate() && S.getNRVOCandidate()->isNRVOVariable()) {
1058 // Apply the named return value optimization for this return statement,
1059 // which means doing nothing: the appropriate result has already been
1060 // constructed into the NRVO variable.
1062 // If there is an NRVO flag for this variable, set it to 1 into indicate
1063 // that the cleanup code should not destroy the variable.
1064 if (llvm::Value *NRVOFlag = NRVOFlags[S.getNRVOCandidate()])
1065 Builder.CreateFlagStore(Builder.getTrue(), NRVOFlag);
1066 } else if (!ReturnValue.isValid() || (RV && RV->getType()->isVoidType())) {
1067 // Make sure not to return anything, but evaluate the expression
1068 // for side effects.
1072 // Do nothing (return value is left uninitialized)
1073 } else if (FnRetTy->isReferenceType()) {
1074 // If this function returns a reference, take the address of the expression
1075 // rather than the value.
1076 RValue Result = EmitReferenceBindingToExpr(RV);
1077 Builder.CreateStore(Result.getScalarVal(), ReturnValue);
1079 switch (getEvaluationKind(RV->getType())) {
1081 Builder.CreateStore(EmitScalarExpr(RV), ReturnValue);
1084 EmitComplexExprIntoLValue(RV, MakeAddrLValue(ReturnValue, RV->getType()),
1088 EmitAggExpr(RV, AggValueSlot::forAddr(
1089 ReturnValue, Qualifiers(),
1090 AggValueSlot::IsDestructed,
1091 AggValueSlot::DoesNotNeedGCBarriers,
1092 AggValueSlot::IsNotAliased,
1093 overlapForReturnValue()));
1099 if (!RV || RV->isEvaluatable(getContext()))
1100 ++NumSimpleReturnExprs;
1102 cleanupScope.ForceCleanup();
1103 EmitBranchThroughCleanup(ReturnBlock);
1106 void CodeGenFunction::EmitDeclStmt(const DeclStmt &S) {
1107 // As long as debug info is modeled with instructions, we have to ensure we
1108 // have a place to insert here and write the stop point here.
1109 if (HaveInsertPoint())
1112 for (const auto *I : S.decls())
1116 void CodeGenFunction::EmitBreakStmt(const BreakStmt &S) {
1117 assert(!BreakContinueStack.empty() && "break stmt not in a loop or switch!");
1119 // If this code is reachable then emit a stop point (if generating
1120 // debug info). We have to do this ourselves because we are on the
1121 // "simple" statement path.
1122 if (HaveInsertPoint())
1125 EmitBranchThroughCleanup(BreakContinueStack.back().BreakBlock);
1128 void CodeGenFunction::EmitContinueStmt(const ContinueStmt &S) {
1129 assert(!BreakContinueStack.empty() && "continue stmt not in a loop!");
1131 // If this code is reachable then emit a stop point (if generating
1132 // debug info). We have to do this ourselves because we are on the
1133 // "simple" statement path.
1134 if (HaveInsertPoint())
1137 EmitBranchThroughCleanup(BreakContinueStack.back().ContinueBlock);
1140 /// EmitCaseStmtRange - If case statement range is not too big then
1141 /// add multiple cases to switch instruction, one for each value within
1142 /// the range. If range is too big then emit "if" condition check.
1143 void CodeGenFunction::EmitCaseStmtRange(const CaseStmt &S) {
1144 assert(S.getRHS() && "Expected RHS value in CaseStmt");
1146 llvm::APSInt LHS = S.getLHS()->EvaluateKnownConstInt(getContext());
1147 llvm::APSInt RHS = S.getRHS()->EvaluateKnownConstInt(getContext());
1149 // Emit the code for this case. We do this first to make sure it is
1150 // properly chained from our predecessor before generating the
1151 // switch machinery to enter this block.
1152 llvm::BasicBlock *CaseDest = createBasicBlock("sw.bb");
1153 EmitBlockWithFallThrough(CaseDest, &S);
1154 EmitStmt(S.getSubStmt());
1156 // If range is empty, do nothing.
1157 if (LHS.isSigned() ? RHS.slt(LHS) : RHS.ult(LHS))
1160 llvm::APInt Range = RHS - LHS;
1161 // FIXME: parameters such as this should not be hardcoded.
1162 if (Range.ult(llvm::APInt(Range.getBitWidth(), 64))) {
1163 // Range is small enough to add multiple switch instruction cases.
1164 uint64_t Total = getProfileCount(&S);
1165 unsigned NCases = Range.getZExtValue() + 1;
1166 // We only have one region counter for the entire set of cases here, so we
1167 // need to divide the weights evenly between the generated cases, ensuring
1168 // that the total weight is preserved. E.g., a weight of 5 over three cases
1169 // will be distributed as weights of 2, 2, and 1.
1170 uint64_t Weight = Total / NCases, Rem = Total % NCases;
1171 for (unsigned I = 0; I != NCases; ++I) {
1173 SwitchWeights->push_back(Weight + (Rem ? 1 : 0));
1176 SwitchInsn->addCase(Builder.getInt(LHS), CaseDest);
1182 // The range is too big. Emit "if" condition into a new block,
1183 // making sure to save and restore the current insertion point.
1184 llvm::BasicBlock *RestoreBB = Builder.GetInsertBlock();
1186 // Push this test onto the chain of range checks (which terminates
1187 // in the default basic block). The switch's default will be changed
1188 // to the top of this chain after switch emission is complete.
1189 llvm::BasicBlock *FalseDest = CaseRangeBlock;
1190 CaseRangeBlock = createBasicBlock("sw.caserange");
1192 CurFn->getBasicBlockList().push_back(CaseRangeBlock);
1193 Builder.SetInsertPoint(CaseRangeBlock);
1195 // Emit range check.
1197 Builder.CreateSub(SwitchInsn->getCondition(), Builder.getInt(LHS));
1199 Builder.CreateICmpULE(Diff, Builder.getInt(Range), "inbounds");
1201 llvm::MDNode *Weights = nullptr;
1202 if (SwitchWeights) {
1203 uint64_t ThisCount = getProfileCount(&S);
1204 uint64_t DefaultCount = (*SwitchWeights)[0];
1205 Weights = createProfileWeights(ThisCount, DefaultCount);
1207 // Since we're chaining the switch default through each large case range, we
1208 // need to update the weight for the default, ie, the first case, to include
1210 (*SwitchWeights)[0] += ThisCount;
1212 Builder.CreateCondBr(Cond, CaseDest, FalseDest, Weights);
1214 // Restore the appropriate insertion point.
1216 Builder.SetInsertPoint(RestoreBB);
1218 Builder.ClearInsertionPoint();
1221 void CodeGenFunction::EmitCaseStmt(const CaseStmt &S) {
1222 // If there is no enclosing switch instance that we're aware of, then this
1223 // case statement and its block can be elided. This situation only happens
1224 // when we've constant-folded the switch, are emitting the constant case,
1225 // and part of the constant case includes another case statement. For
1226 // instance: switch (4) { case 4: do { case 5: } while (1); }
1228 EmitStmt(S.getSubStmt());
1232 // Handle case ranges.
1234 EmitCaseStmtRange(S);
1238 llvm::ConstantInt *CaseVal =
1239 Builder.getInt(S.getLHS()->EvaluateKnownConstInt(getContext()));
1241 // If the body of the case is just a 'break', try to not emit an empty block.
1242 // If we're profiling or we're not optimizing, leave the block in for better
1243 // debug and coverage analysis.
1244 if (!CGM.getCodeGenOpts().hasProfileClangInstr() &&
1245 CGM.getCodeGenOpts().OptimizationLevel > 0 &&
1246 isa<BreakStmt>(S.getSubStmt())) {
1247 JumpDest Block = BreakContinueStack.back().BreakBlock;
1249 // Only do this optimization if there are no cleanups that need emitting.
1250 if (isObviouslyBranchWithoutCleanups(Block)) {
1252 SwitchWeights->push_back(getProfileCount(&S));
1253 SwitchInsn->addCase(CaseVal, Block.getBlock());
1255 // If there was a fallthrough into this case, make sure to redirect it to
1256 // the end of the switch as well.
1257 if (Builder.GetInsertBlock()) {
1258 Builder.CreateBr(Block.getBlock());
1259 Builder.ClearInsertionPoint();
1265 llvm::BasicBlock *CaseDest = createBasicBlock("sw.bb");
1266 EmitBlockWithFallThrough(CaseDest, &S);
1268 SwitchWeights->push_back(getProfileCount(&S));
1269 SwitchInsn->addCase(CaseVal, CaseDest);
1271 // Recursively emitting the statement is acceptable, but is not wonderful for
1272 // code where we have many case statements nested together, i.e.:
1276 // Handling this recursively will create a new block for each case statement
1277 // that falls through to the next case which is IR intensive. It also causes
1278 // deep recursion which can run into stack depth limitations. Handle
1279 // sequential non-range case statements specially.
1280 const CaseStmt *CurCase = &S;
1281 const CaseStmt *NextCase = dyn_cast<CaseStmt>(S.getSubStmt());
1283 // Otherwise, iteratively add consecutive cases to this switch stmt.
1284 while (NextCase && NextCase->getRHS() == nullptr) {
1286 llvm::ConstantInt *CaseVal =
1287 Builder.getInt(CurCase->getLHS()->EvaluateKnownConstInt(getContext()));
1290 SwitchWeights->push_back(getProfileCount(NextCase));
1291 if (CGM.getCodeGenOpts().hasProfileClangInstr()) {
1292 CaseDest = createBasicBlock("sw.bb");
1293 EmitBlockWithFallThrough(CaseDest, &S);
1296 SwitchInsn->addCase(CaseVal, CaseDest);
1297 NextCase = dyn_cast<CaseStmt>(CurCase->getSubStmt());
1300 // Normal default recursion for non-cases.
1301 EmitStmt(CurCase->getSubStmt());
1304 void CodeGenFunction::EmitDefaultStmt(const DefaultStmt &S) {
1305 // If there is no enclosing switch instance that we're aware of, then this
1306 // default statement can be elided. This situation only happens when we've
1307 // constant-folded the switch.
1309 EmitStmt(S.getSubStmt());
1313 llvm::BasicBlock *DefaultBlock = SwitchInsn->getDefaultDest();
1314 assert(DefaultBlock->empty() &&
1315 "EmitDefaultStmt: Default block already defined?");
1317 EmitBlockWithFallThrough(DefaultBlock, &S);
1319 EmitStmt(S.getSubStmt());
1322 /// CollectStatementsForCase - Given the body of a 'switch' statement and a
1323 /// constant value that is being switched on, see if we can dead code eliminate
1324 /// the body of the switch to a simple series of statements to emit. Basically,
1325 /// on a switch (5) we want to find these statements:
1327 /// printf(...); <--
1331 /// and add them to the ResultStmts vector. If it is unsafe to do this
1332 /// transformation (for example, one of the elided statements contains a label
1333 /// that might be jumped to), return CSFC_Failure. If we handled it and 'S'
1334 /// should include statements after it (e.g. the printf() line is a substmt of
1335 /// the case) then return CSFC_FallThrough. If we handled it and found a break
1336 /// statement, then return CSFC_Success.
1338 /// If Case is non-null, then we are looking for the specified case, checking
1339 /// that nothing we jump over contains labels. If Case is null, then we found
1340 /// the case and are looking for the break.
1342 /// If the recursive walk actually finds our Case, then we set FoundCase to
1345 enum CSFC_Result { CSFC_Failure, CSFC_FallThrough, CSFC_Success };
1346 static CSFC_Result CollectStatementsForCase(const Stmt *S,
1347 const SwitchCase *Case,
1349 SmallVectorImpl<const Stmt*> &ResultStmts) {
1350 // If this is a null statement, just succeed.
1352 return Case ? CSFC_Success : CSFC_FallThrough;
1354 // If this is the switchcase (case 4: or default) that we're looking for, then
1355 // we're in business. Just add the substatement.
1356 if (const SwitchCase *SC = dyn_cast<SwitchCase>(S)) {
1359 return CollectStatementsForCase(SC->getSubStmt(), nullptr, FoundCase,
1363 // Otherwise, this is some other case or default statement, just ignore it.
1364 return CollectStatementsForCase(SC->getSubStmt(), Case, FoundCase,
1368 // If we are in the live part of the code and we found our break statement,
1369 // return a success!
1370 if (!Case && isa<BreakStmt>(S))
1371 return CSFC_Success;
1373 // If this is a switch statement, then it might contain the SwitchCase, the
1374 // break, or neither.
1375 if (const CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
1376 // Handle this as two cases: we might be looking for the SwitchCase (if so
1377 // the skipped statements must be skippable) or we might already have it.
1378 CompoundStmt::const_body_iterator I = CS->body_begin(), E = CS->body_end();
1379 bool StartedInLiveCode = FoundCase;
1380 unsigned StartSize = ResultStmts.size();
1382 // If we've not found the case yet, scan through looking for it.
1384 // Keep track of whether we see a skipped declaration. The code could be
1385 // using the declaration even if it is skipped, so we can't optimize out
1386 // the decl if the kept statements might refer to it.
1387 bool HadSkippedDecl = false;
1389 // If we're looking for the case, just see if we can skip each of the
1391 for (; Case && I != E; ++I) {
1392 HadSkippedDecl |= CodeGenFunction::mightAddDeclToScope(*I);
1394 switch (CollectStatementsForCase(*I, Case, FoundCase, ResultStmts)) {
1395 case CSFC_Failure: return CSFC_Failure;
1397 // A successful result means that either 1) that the statement doesn't
1398 // have the case and is skippable, or 2) does contain the case value
1399 // and also contains the break to exit the switch. In the later case,
1400 // we just verify the rest of the statements are elidable.
1402 // If we found the case and skipped declarations, we can't do the
1405 return CSFC_Failure;
1407 for (++I; I != E; ++I)
1408 if (CodeGenFunction::ContainsLabel(*I, true))
1409 return CSFC_Failure;
1410 return CSFC_Success;
1413 case CSFC_FallThrough:
1414 // If we have a fallthrough condition, then we must have found the
1415 // case started to include statements. Consider the rest of the
1416 // statements in the compound statement as candidates for inclusion.
1417 assert(FoundCase && "Didn't find case but returned fallthrough?");
1418 // We recursively found Case, so we're not looking for it anymore.
1421 // If we found the case and skipped declarations, we can't do the
1424 return CSFC_Failure;
1430 return CSFC_Success;
1432 assert(!HadSkippedDecl && "fallthrough after skipping decl");
1435 // If we have statements in our range, then we know that the statements are
1436 // live and need to be added to the set of statements we're tracking.
1437 bool AnyDecls = false;
1438 for (; I != E; ++I) {
1439 AnyDecls |= CodeGenFunction::mightAddDeclToScope(*I);
1441 switch (CollectStatementsForCase(*I, nullptr, FoundCase, ResultStmts)) {
1442 case CSFC_Failure: return CSFC_Failure;
1443 case CSFC_FallThrough:
1444 // A fallthrough result means that the statement was simple and just
1445 // included in ResultStmt, keep adding them afterwards.
1448 // A successful result means that we found the break statement and
1449 // stopped statement inclusion. We just ensure that any leftover stmts
1450 // are skippable and return success ourselves.
1451 for (++I; I != E; ++I)
1452 if (CodeGenFunction::ContainsLabel(*I, true))
1453 return CSFC_Failure;
1454 return CSFC_Success;
1458 // If we're about to fall out of a scope without hitting a 'break;', we
1459 // can't perform the optimization if there were any decls in that scope
1460 // (we'd lose their end-of-lifetime).
1462 // If the entire compound statement was live, there's one more thing we
1463 // can try before giving up: emit the whole thing as a single statement.
1464 // We can do that unless the statement contains a 'break;'.
1465 // FIXME: Such a break must be at the end of a construct within this one.
1466 // We could emit this by just ignoring the BreakStmts entirely.
1467 if (StartedInLiveCode && !CodeGenFunction::containsBreak(S)) {
1468 ResultStmts.resize(StartSize);
1469 ResultStmts.push_back(S);
1471 return CSFC_Failure;
1475 return CSFC_FallThrough;
1478 // Okay, this is some other statement that we don't handle explicitly, like a
1479 // for statement or increment etc. If we are skipping over this statement,
1480 // just verify it doesn't have labels, which would make it invalid to elide.
1482 if (CodeGenFunction::ContainsLabel(S, true))
1483 return CSFC_Failure;
1484 return CSFC_Success;
1487 // Otherwise, we want to include this statement. Everything is cool with that
1488 // so long as it doesn't contain a break out of the switch we're in.
1489 if (CodeGenFunction::containsBreak(S)) return CSFC_Failure;
1491 // Otherwise, everything is great. Include the statement and tell the caller
1492 // that we fall through and include the next statement as well.
1493 ResultStmts.push_back(S);
1494 return CSFC_FallThrough;
1497 /// FindCaseStatementsForValue - Find the case statement being jumped to and
1498 /// then invoke CollectStatementsForCase to find the list of statements to emit
1499 /// for a switch on constant. See the comment above CollectStatementsForCase
1500 /// for more details.
1501 static bool FindCaseStatementsForValue(const SwitchStmt &S,
1502 const llvm::APSInt &ConstantCondValue,
1503 SmallVectorImpl<const Stmt*> &ResultStmts,
1505 const SwitchCase *&ResultCase) {
1506 // First step, find the switch case that is being branched to. We can do this
1507 // efficiently by scanning the SwitchCase list.
1508 const SwitchCase *Case = S.getSwitchCaseList();
1509 const DefaultStmt *DefaultCase = nullptr;
1511 for (; Case; Case = Case->getNextSwitchCase()) {
1512 // It's either a default or case. Just remember the default statement in
1513 // case we're not jumping to any numbered cases.
1514 if (const DefaultStmt *DS = dyn_cast<DefaultStmt>(Case)) {
1519 // Check to see if this case is the one we're looking for.
1520 const CaseStmt *CS = cast<CaseStmt>(Case);
1521 // Don't handle case ranges yet.
1522 if (CS->getRHS()) return false;
1524 // If we found our case, remember it as 'case'.
1525 if (CS->getLHS()->EvaluateKnownConstInt(C) == ConstantCondValue)
1529 // If we didn't find a matching case, we use a default if it exists, or we
1530 // elide the whole switch body!
1532 // It is safe to elide the body of the switch if it doesn't contain labels
1533 // etc. If it is safe, return successfully with an empty ResultStmts list.
1535 return !CodeGenFunction::ContainsLabel(&S);
1539 // Ok, we know which case is being jumped to, try to collect all the
1540 // statements that follow it. This can fail for a variety of reasons. Also,
1541 // check to see that the recursive walk actually found our case statement.
1542 // Insane cases like this can fail to find it in the recursive walk since we
1543 // don't handle every stmt kind:
1547 bool FoundCase = false;
1549 return CollectStatementsForCase(S.getBody(), Case, FoundCase,
1550 ResultStmts) != CSFC_Failure &&
1554 void CodeGenFunction::EmitSwitchStmt(const SwitchStmt &S) {
1555 // Handle nested switch statements.
1556 llvm::SwitchInst *SavedSwitchInsn = SwitchInsn;
1557 SmallVector<uint64_t, 16> *SavedSwitchWeights = SwitchWeights;
1558 llvm::BasicBlock *SavedCRBlock = CaseRangeBlock;
1560 // See if we can constant fold the condition of the switch and therefore only
1561 // emit the live case statement (if any) of the switch.
1562 llvm::APSInt ConstantCondValue;
1563 if (ConstantFoldsToSimpleInteger(S.getCond(), ConstantCondValue)) {
1564 SmallVector<const Stmt*, 4> CaseStmts;
1565 const SwitchCase *Case = nullptr;
1566 if (FindCaseStatementsForValue(S, ConstantCondValue, CaseStmts,
1567 getContext(), Case)) {
1569 incrementProfileCounter(Case);
1570 RunCleanupsScope ExecutedScope(*this);
1573 EmitStmt(S.getInit());
1575 // Emit the condition variable if needed inside the entire cleanup scope
1576 // used by this special case for constant folded switches.
1577 if (S.getConditionVariable())
1578 EmitDecl(*S.getConditionVariable());
1580 // At this point, we are no longer "within" a switch instance, so
1581 // we can temporarily enforce this to ensure that any embedded case
1582 // statements are not emitted.
1583 SwitchInsn = nullptr;
1585 // Okay, we can dead code eliminate everything except this case. Emit the
1586 // specified series of statements and we're good.
1587 for (unsigned i = 0, e = CaseStmts.size(); i != e; ++i)
1588 EmitStmt(CaseStmts[i]);
1589 incrementProfileCounter(&S);
1591 // Now we want to restore the saved switch instance so that nested
1592 // switches continue to function properly
1593 SwitchInsn = SavedSwitchInsn;
1599 JumpDest SwitchExit = getJumpDestInCurrentScope("sw.epilog");
1601 RunCleanupsScope ConditionScope(*this);
1604 EmitStmt(S.getInit());
1606 if (S.getConditionVariable())
1607 EmitDecl(*S.getConditionVariable());
1608 llvm::Value *CondV = EmitScalarExpr(S.getCond());
1610 // Create basic block to hold stuff that comes after switch
1611 // statement. We also need to create a default block now so that
1612 // explicit case ranges tests can have a place to jump to on
1614 llvm::BasicBlock *DefaultBlock = createBasicBlock("sw.default");
1615 SwitchInsn = Builder.CreateSwitch(CondV, DefaultBlock);
1616 if (PGO.haveRegionCounts()) {
1617 // Walk the SwitchCase list to find how many there are.
1618 uint64_t DefaultCount = 0;
1619 unsigned NumCases = 0;
1620 for (const SwitchCase *Case = S.getSwitchCaseList();
1622 Case = Case->getNextSwitchCase()) {
1623 if (isa<DefaultStmt>(Case))
1624 DefaultCount = getProfileCount(Case);
1627 SwitchWeights = new SmallVector<uint64_t, 16>();
1628 SwitchWeights->reserve(NumCases);
1629 // The default needs to be first. We store the edge count, so we already
1630 // know the right weight.
1631 SwitchWeights->push_back(DefaultCount);
1633 CaseRangeBlock = DefaultBlock;
1635 // Clear the insertion point to indicate we are in unreachable code.
1636 Builder.ClearInsertionPoint();
1638 // All break statements jump to NextBlock. If BreakContinueStack is non-empty
1639 // then reuse last ContinueBlock.
1640 JumpDest OuterContinue;
1641 if (!BreakContinueStack.empty())
1642 OuterContinue = BreakContinueStack.back().ContinueBlock;
1644 BreakContinueStack.push_back(BreakContinue(SwitchExit, OuterContinue));
1646 // Emit switch body.
1647 EmitStmt(S.getBody());
1649 BreakContinueStack.pop_back();
1651 // Update the default block in case explicit case range tests have
1652 // been chained on top.
1653 SwitchInsn->setDefaultDest(CaseRangeBlock);
1655 // If a default was never emitted:
1656 if (!DefaultBlock->getParent()) {
1657 // If we have cleanups, emit the default block so that there's a
1658 // place to jump through the cleanups from.
1659 if (ConditionScope.requiresCleanups()) {
1660 EmitBlock(DefaultBlock);
1662 // Otherwise, just forward the default block to the switch end.
1664 DefaultBlock->replaceAllUsesWith(SwitchExit.getBlock());
1665 delete DefaultBlock;
1669 ConditionScope.ForceCleanup();
1671 // Emit continuation.
1672 EmitBlock(SwitchExit.getBlock(), true);
1673 incrementProfileCounter(&S);
1675 // If the switch has a condition wrapped by __builtin_unpredictable,
1676 // create metadata that specifies that the switch is unpredictable.
1677 // Don't bother if not optimizing because that metadata would not be used.
1678 auto *Call = dyn_cast<CallExpr>(S.getCond());
1679 if (Call && CGM.getCodeGenOpts().OptimizationLevel != 0) {
1680 auto *FD = dyn_cast_or_null<FunctionDecl>(Call->getCalleeDecl());
1681 if (FD && FD->getBuiltinID() == Builtin::BI__builtin_unpredictable) {
1682 llvm::MDBuilder MDHelper(getLLVMContext());
1683 SwitchInsn->setMetadata(llvm::LLVMContext::MD_unpredictable,
1684 MDHelper.createUnpredictable());
1688 if (SwitchWeights) {
1689 assert(SwitchWeights->size() == 1 + SwitchInsn->getNumCases() &&
1690 "switch weights do not match switch cases");
1691 // If there's only one jump destination there's no sense weighting it.
1692 if (SwitchWeights->size() > 1)
1693 SwitchInsn->setMetadata(llvm::LLVMContext::MD_prof,
1694 createProfileWeights(*SwitchWeights));
1695 delete SwitchWeights;
1697 SwitchInsn = SavedSwitchInsn;
1698 SwitchWeights = SavedSwitchWeights;
1699 CaseRangeBlock = SavedCRBlock;
1703 SimplifyConstraint(const char *Constraint, const TargetInfo &Target,
1704 SmallVectorImpl<TargetInfo::ConstraintInfo> *OutCons=nullptr) {
1707 while (*Constraint) {
1708 switch (*Constraint) {
1710 Result += Target.convertConstraint(Constraint);
1716 case '=': // Will see this and the following in mult-alt constraints.
1719 case '#': // Ignore the rest of the constraint alternative.
1720 while (Constraint[1] && Constraint[1] != ',')
1725 Result += *Constraint;
1726 while (Constraint[1] && Constraint[1] == *Constraint)
1737 "Must pass output names to constraints with a symbolic name");
1739 bool result = Target.resolveSymbolicName(Constraint, *OutCons, Index);
1740 assert(result && "Could not resolve symbolic name"); (void)result;
1741 Result += llvm::utostr(Index);
1752 /// AddVariableConstraints - Look at AsmExpr and if it is a variable declared
1753 /// as using a particular register add that as a constraint that will be used
1754 /// in this asm stmt.
1756 AddVariableConstraints(const std::string &Constraint, const Expr &AsmExpr,
1757 const TargetInfo &Target, CodeGenModule &CGM,
1758 const AsmStmt &Stmt, const bool EarlyClobber) {
1759 const DeclRefExpr *AsmDeclRef = dyn_cast<DeclRefExpr>(&AsmExpr);
1762 const ValueDecl &Value = *AsmDeclRef->getDecl();
1763 const VarDecl *Variable = dyn_cast<VarDecl>(&Value);
1766 if (Variable->getStorageClass() != SC_Register)
1768 AsmLabelAttr *Attr = Variable->getAttr<AsmLabelAttr>();
1771 StringRef Register = Attr->getLabel();
1772 assert(Target.isValidGCCRegisterName(Register));
1773 // We're using validateOutputConstraint here because we only care if
1774 // this is a register constraint.
1775 TargetInfo::ConstraintInfo Info(Constraint, "");
1776 if (Target.validateOutputConstraint(Info) &&
1777 !Info.allowsRegister()) {
1778 CGM.ErrorUnsupported(&Stmt, "__asm__");
1781 // Canonicalize the register here before returning it.
1782 Register = Target.getNormalizedGCCRegisterName(Register);
1783 return (EarlyClobber ? "&{" : "{") + Register.str() + "}";
1787 CodeGenFunction::EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
1788 LValue InputValue, QualType InputType,
1789 std::string &ConstraintStr,
1790 SourceLocation Loc) {
1792 if (Info.allowsRegister() || !Info.allowsMemory()) {
1793 if (CodeGenFunction::hasScalarEvaluationKind(InputType)) {
1794 Arg = EmitLoadOfLValue(InputValue, Loc).getScalarVal();
1796 llvm::Type *Ty = ConvertType(InputType);
1797 uint64_t Size = CGM.getDataLayout().getTypeSizeInBits(Ty);
1798 if (Size <= 64 && llvm::isPowerOf2_64(Size)) {
1799 Ty = llvm::IntegerType::get(getLLVMContext(), Size);
1800 Ty = llvm::PointerType::getUnqual(Ty);
1802 Arg = Builder.CreateLoad(Builder.CreateBitCast(InputValue.getAddress(),
1805 Arg = InputValue.getPointer();
1806 ConstraintStr += '*';
1810 Arg = InputValue.getPointer();
1811 ConstraintStr += '*';
1817 llvm::Value* CodeGenFunction::EmitAsmInput(
1818 const TargetInfo::ConstraintInfo &Info,
1819 const Expr *InputExpr,
1820 std::string &ConstraintStr) {
1821 // If this can't be a register or memory, i.e., has to be a constant
1822 // (immediate or symbolic), try to emit it as such.
1823 if (!Info.allowsRegister() && !Info.allowsMemory()) {
1824 llvm::APSInt Result;
1825 if (InputExpr->EvaluateAsInt(Result, getContext()))
1826 return llvm::ConstantInt::get(getLLVMContext(), Result);
1827 assert(!Info.requiresImmediateConstant() &&
1828 "Required-immediate inlineasm arg isn't constant?");
1831 if (Info.allowsRegister() || !Info.allowsMemory())
1832 if (CodeGenFunction::hasScalarEvaluationKind(InputExpr->getType()))
1833 return EmitScalarExpr(InputExpr);
1834 if (InputExpr->getStmtClass() == Expr::CXXThisExprClass)
1835 return EmitScalarExpr(InputExpr);
1836 InputExpr = InputExpr->IgnoreParenNoopCasts(getContext());
1837 LValue Dest = EmitLValue(InputExpr);
1838 return EmitAsmInputLValue(Info, Dest, InputExpr->getType(), ConstraintStr,
1839 InputExpr->getExprLoc());
1842 /// getAsmSrcLocInfo - Return the !srcloc metadata node to attach to an inline
1843 /// asm call instruction. The !srcloc MDNode contains a list of constant
1844 /// integers which are the source locations of the start of each line in the
1846 static llvm::MDNode *getAsmSrcLocInfo(const StringLiteral *Str,
1847 CodeGenFunction &CGF) {
1848 SmallVector<llvm::Metadata *, 8> Locs;
1849 // Add the location of the first line to the MDNode.
1850 Locs.push_back(llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
1851 CGF.Int32Ty, Str->getLocStart().getRawEncoding())));
1852 StringRef StrVal = Str->getString();
1853 if (!StrVal.empty()) {
1854 const SourceManager &SM = CGF.CGM.getContext().getSourceManager();
1855 const LangOptions &LangOpts = CGF.CGM.getLangOpts();
1856 unsigned StartToken = 0;
1857 unsigned ByteOffset = 0;
1859 // Add the location of the start of each subsequent line of the asm to the
1861 for (unsigned i = 0, e = StrVal.size() - 1; i != e; ++i) {
1862 if (StrVal[i] != '\n') continue;
1863 SourceLocation LineLoc = Str->getLocationOfByte(
1864 i + 1, SM, LangOpts, CGF.getTarget(), &StartToken, &ByteOffset);
1865 Locs.push_back(llvm::ConstantAsMetadata::get(
1866 llvm::ConstantInt::get(CGF.Int32Ty, LineLoc.getRawEncoding())));
1870 return llvm::MDNode::get(CGF.getLLVMContext(), Locs);
1873 void CodeGenFunction::EmitAsmStmt(const AsmStmt &S) {
1874 // Assemble the final asm string.
1875 std::string AsmString = S.generateAsmString(getContext());
1877 // Get all the output and input constraints together.
1878 SmallVector<TargetInfo::ConstraintInfo, 4> OutputConstraintInfos;
1879 SmallVector<TargetInfo::ConstraintInfo, 4> InputConstraintInfos;
1881 for (unsigned i = 0, e = S.getNumOutputs(); i != e; i++) {
1883 if (const GCCAsmStmt *GAS = dyn_cast<GCCAsmStmt>(&S))
1884 Name = GAS->getOutputName(i);
1885 TargetInfo::ConstraintInfo Info(S.getOutputConstraint(i), Name);
1886 bool IsValid = getTarget().validateOutputConstraint(Info); (void)IsValid;
1887 assert(IsValid && "Failed to parse output constraint");
1888 OutputConstraintInfos.push_back(Info);
1891 for (unsigned i = 0, e = S.getNumInputs(); i != e; i++) {
1893 if (const GCCAsmStmt *GAS = dyn_cast<GCCAsmStmt>(&S))
1894 Name = GAS->getInputName(i);
1895 TargetInfo::ConstraintInfo Info(S.getInputConstraint(i), Name);
1897 getTarget().validateInputConstraint(OutputConstraintInfos, Info);
1898 assert(IsValid && "Failed to parse input constraint"); (void)IsValid;
1899 InputConstraintInfos.push_back(Info);
1902 std::string Constraints;
1904 std::vector<LValue> ResultRegDests;
1905 std::vector<QualType> ResultRegQualTys;
1906 std::vector<llvm::Type *> ResultRegTypes;
1907 std::vector<llvm::Type *> ResultTruncRegTypes;
1908 std::vector<llvm::Type *> ArgTypes;
1909 std::vector<llvm::Value*> Args;
1911 // Keep track of inout constraints.
1912 std::string InOutConstraints;
1913 std::vector<llvm::Value*> InOutArgs;
1914 std::vector<llvm::Type*> InOutArgTypes;
1916 // An inline asm can be marked readonly if it meets the following conditions:
1917 // - it doesn't have any sideeffects
1918 // - it doesn't clobber memory
1919 // - it doesn't return a value by-reference
1920 // It can be marked readnone if it doesn't have any input memory constraints
1921 // in addition to meeting the conditions listed above.
1922 bool ReadOnly = true, ReadNone = true;
1924 for (unsigned i = 0, e = S.getNumOutputs(); i != e; i++) {
1925 TargetInfo::ConstraintInfo &Info = OutputConstraintInfos[i];
1927 // Simplify the output constraint.
1928 std::string OutputConstraint(S.getOutputConstraint(i));
1929 OutputConstraint = SimplifyConstraint(OutputConstraint.c_str() + 1,
1930 getTarget(), &OutputConstraintInfos);
1932 const Expr *OutExpr = S.getOutputExpr(i);
1933 OutExpr = OutExpr->IgnoreParenNoopCasts(getContext());
1935 OutputConstraint = AddVariableConstraints(OutputConstraint, *OutExpr,
1936 getTarget(), CGM, S,
1937 Info.earlyClobber());
1939 LValue Dest = EmitLValue(OutExpr);
1940 if (!Constraints.empty())
1943 // If this is a register output, then make the inline asm return it
1944 // by-value. If this is a memory result, return the value by-reference.
1945 if (!Info.allowsMemory() && hasScalarEvaluationKind(OutExpr->getType())) {
1946 Constraints += "=" + OutputConstraint;
1947 ResultRegQualTys.push_back(OutExpr->getType());
1948 ResultRegDests.push_back(Dest);
1949 ResultRegTypes.push_back(ConvertTypeForMem(OutExpr->getType()));
1950 ResultTruncRegTypes.push_back(ResultRegTypes.back());
1952 // If this output is tied to an input, and if the input is larger, then
1953 // we need to set the actual result type of the inline asm node to be the
1954 // same as the input type.
1955 if (Info.hasMatchingInput()) {
1957 for (InputNo = 0; InputNo != S.getNumInputs(); ++InputNo) {
1958 TargetInfo::ConstraintInfo &Input = InputConstraintInfos[InputNo];
1959 if (Input.hasTiedOperand() && Input.getTiedOperand() == i)
1962 assert(InputNo != S.getNumInputs() && "Didn't find matching input!");
1964 QualType InputTy = S.getInputExpr(InputNo)->getType();
1965 QualType OutputType = OutExpr->getType();
1967 uint64_t InputSize = getContext().getTypeSize(InputTy);
1968 if (getContext().getTypeSize(OutputType) < InputSize) {
1969 // Form the asm to return the value as a larger integer or fp type.
1970 ResultRegTypes.back() = ConvertType(InputTy);
1973 if (llvm::Type* AdjTy =
1974 getTargetHooks().adjustInlineAsmType(*this, OutputConstraint,
1975 ResultRegTypes.back()))
1976 ResultRegTypes.back() = AdjTy;
1978 CGM.getDiags().Report(S.getAsmLoc(),
1979 diag::err_asm_invalid_type_in_input)
1980 << OutExpr->getType() << OutputConstraint;
1983 ArgTypes.push_back(Dest.getAddress().getType());
1984 Args.push_back(Dest.getPointer());
1985 Constraints += "=*";
1986 Constraints += OutputConstraint;
1987 ReadOnly = ReadNone = false;
1990 if (Info.isReadWrite()) {
1991 InOutConstraints += ',';
1993 const Expr *InputExpr = S.getOutputExpr(i);
1994 llvm::Value *Arg = EmitAsmInputLValue(Info, Dest, InputExpr->getType(),
1996 InputExpr->getExprLoc());
1998 if (llvm::Type* AdjTy =
1999 getTargetHooks().adjustInlineAsmType(*this, OutputConstraint,
2001 Arg = Builder.CreateBitCast(Arg, AdjTy);
2003 if (Info.allowsRegister())
2004 InOutConstraints += llvm::utostr(i);
2006 InOutConstraints += OutputConstraint;
2008 InOutArgTypes.push_back(Arg->getType());
2009 InOutArgs.push_back(Arg);
2013 // If this is a Microsoft-style asm blob, store the return registers (EAX:EDX)
2014 // to the return value slot. Only do this when returning in registers.
2015 if (isa<MSAsmStmt>(&S)) {
2016 const ABIArgInfo &RetAI = CurFnInfo->getReturnInfo();
2017 if (RetAI.isDirect() || RetAI.isExtend()) {
2018 // Make a fake lvalue for the return value slot.
2019 LValue ReturnSlot = MakeAddrLValue(ReturnValue, FnRetTy);
2020 CGM.getTargetCodeGenInfo().addReturnRegisterOutputs(
2021 *this, ReturnSlot, Constraints, ResultRegTypes, ResultTruncRegTypes,
2022 ResultRegDests, AsmString, S.getNumOutputs());
2027 for (unsigned i = 0, e = S.getNumInputs(); i != e; i++) {
2028 const Expr *InputExpr = S.getInputExpr(i);
2030 TargetInfo::ConstraintInfo &Info = InputConstraintInfos[i];
2032 if (Info.allowsMemory())
2035 if (!Constraints.empty())
2038 // Simplify the input constraint.
2039 std::string InputConstraint(S.getInputConstraint(i));
2040 InputConstraint = SimplifyConstraint(InputConstraint.c_str(), getTarget(),
2041 &OutputConstraintInfos);
2043 InputConstraint = AddVariableConstraints(
2044 InputConstraint, *InputExpr->IgnoreParenNoopCasts(getContext()),
2045 getTarget(), CGM, S, false /* No EarlyClobber */);
2047 llvm::Value *Arg = EmitAsmInput(Info, InputExpr, Constraints);
2049 // If this input argument is tied to a larger output result, extend the
2050 // input to be the same size as the output. The LLVM backend wants to see
2051 // the input and output of a matching constraint be the same size. Note
2052 // that GCC does not define what the top bits are here. We use zext because
2053 // that is usually cheaper, but LLVM IR should really get an anyext someday.
2054 if (Info.hasTiedOperand()) {
2055 unsigned Output = Info.getTiedOperand();
2056 QualType OutputType = S.getOutputExpr(Output)->getType();
2057 QualType InputTy = InputExpr->getType();
2059 if (getContext().getTypeSize(OutputType) >
2060 getContext().getTypeSize(InputTy)) {
2061 // Use ptrtoint as appropriate so that we can do our extension.
2062 if (isa<llvm::PointerType>(Arg->getType()))
2063 Arg = Builder.CreatePtrToInt(Arg, IntPtrTy);
2064 llvm::Type *OutputTy = ConvertType(OutputType);
2065 if (isa<llvm::IntegerType>(OutputTy))
2066 Arg = Builder.CreateZExt(Arg, OutputTy);
2067 else if (isa<llvm::PointerType>(OutputTy))
2068 Arg = Builder.CreateZExt(Arg, IntPtrTy);
2070 assert(OutputTy->isFloatingPointTy() && "Unexpected output type");
2071 Arg = Builder.CreateFPExt(Arg, OutputTy);
2075 if (llvm::Type* AdjTy =
2076 getTargetHooks().adjustInlineAsmType(*this, InputConstraint,
2078 Arg = Builder.CreateBitCast(Arg, AdjTy);
2080 CGM.getDiags().Report(S.getAsmLoc(), diag::err_asm_invalid_type_in_input)
2081 << InputExpr->getType() << InputConstraint;
2083 ArgTypes.push_back(Arg->getType());
2084 Args.push_back(Arg);
2085 Constraints += InputConstraint;
2088 // Append the "input" part of inout constraints last.
2089 for (unsigned i = 0, e = InOutArgs.size(); i != e; i++) {
2090 ArgTypes.push_back(InOutArgTypes[i]);
2091 Args.push_back(InOutArgs[i]);
2093 Constraints += InOutConstraints;
2096 for (unsigned i = 0, e = S.getNumClobbers(); i != e; i++) {
2097 StringRef Clobber = S.getClobber(i);
2099 if (Clobber == "memory")
2100 ReadOnly = ReadNone = false;
2101 else if (Clobber != "cc")
2102 Clobber = getTarget().getNormalizedGCCRegisterName(Clobber);
2104 if (!Constraints.empty())
2107 Constraints += "~{";
2108 Constraints += Clobber;
2112 // Add machine specific clobbers
2113 std::string MachineClobbers = getTarget().getClobbers();
2114 if (!MachineClobbers.empty()) {
2115 if (!Constraints.empty())
2117 Constraints += MachineClobbers;
2120 llvm::Type *ResultType;
2121 if (ResultRegTypes.empty())
2122 ResultType = VoidTy;
2123 else if (ResultRegTypes.size() == 1)
2124 ResultType = ResultRegTypes[0];
2126 ResultType = llvm::StructType::get(getLLVMContext(), ResultRegTypes);
2128 llvm::FunctionType *FTy =
2129 llvm::FunctionType::get(ResultType, ArgTypes, false);
2131 bool HasSideEffect = S.isVolatile() || S.getNumOutputs() == 0;
2132 llvm::InlineAsm::AsmDialect AsmDialect = isa<MSAsmStmt>(&S) ?
2133 llvm::InlineAsm::AD_Intel : llvm::InlineAsm::AD_ATT;
2134 llvm::InlineAsm *IA =
2135 llvm::InlineAsm::get(FTy, AsmString, Constraints, HasSideEffect,
2136 /* IsAlignStack */ false, AsmDialect);
2137 llvm::CallInst *Result =
2138 Builder.CreateCall(IA, Args, getBundlesForFunclet(IA));
2139 Result->addAttribute(llvm::AttributeList::FunctionIndex,
2140 llvm::Attribute::NoUnwind);
2142 // Attach readnone and readonly attributes.
2143 if (!HasSideEffect) {
2145 Result->addAttribute(llvm::AttributeList::FunctionIndex,
2146 llvm::Attribute::ReadNone);
2148 Result->addAttribute(llvm::AttributeList::FunctionIndex,
2149 llvm::Attribute::ReadOnly);
2152 // Slap the source location of the inline asm into a !srcloc metadata on the
2154 if (const GCCAsmStmt *gccAsmStmt = dyn_cast<GCCAsmStmt>(&S)) {
2155 Result->setMetadata("srcloc", getAsmSrcLocInfo(gccAsmStmt->getAsmString(),
2158 // At least put the line number on MS inline asm blobs.
2159 auto Loc = llvm::ConstantInt::get(Int32Ty, S.getAsmLoc().getRawEncoding());
2160 Result->setMetadata("srcloc",
2161 llvm::MDNode::get(getLLVMContext(),
2162 llvm::ConstantAsMetadata::get(Loc)));
2165 if (getLangOpts().assumeFunctionsAreConvergent()) {
2166 // Conservatively, mark all inline asm blocks in CUDA or OpenCL as
2167 // convergent (meaning, they may call an intrinsically convergent op, such
2168 // as bar.sync, and so can't have certain optimizations applied around
2170 Result->addAttribute(llvm::AttributeList::FunctionIndex,
2171 llvm::Attribute::Convergent);
2174 // Extract all of the register value results from the asm.
2175 std::vector<llvm::Value*> RegResults;
2176 if (ResultRegTypes.size() == 1) {
2177 RegResults.push_back(Result);
2179 for (unsigned i = 0, e = ResultRegTypes.size(); i != e; ++i) {
2180 llvm::Value *Tmp = Builder.CreateExtractValue(Result, i, "asmresult");
2181 RegResults.push_back(Tmp);
2185 assert(RegResults.size() == ResultRegTypes.size());
2186 assert(RegResults.size() == ResultTruncRegTypes.size());
2187 assert(RegResults.size() == ResultRegDests.size());
2188 for (unsigned i = 0, e = RegResults.size(); i != e; ++i) {
2189 llvm::Value *Tmp = RegResults[i];
2191 // If the result type of the LLVM IR asm doesn't match the result type of
2192 // the expression, do the conversion.
2193 if (ResultRegTypes[i] != ResultTruncRegTypes[i]) {
2194 llvm::Type *TruncTy = ResultTruncRegTypes[i];
2196 // Truncate the integer result to the right size, note that TruncTy can be
2198 if (TruncTy->isFloatingPointTy())
2199 Tmp = Builder.CreateFPTrunc(Tmp, TruncTy);
2200 else if (TruncTy->isPointerTy() && Tmp->getType()->isIntegerTy()) {
2201 uint64_t ResSize = CGM.getDataLayout().getTypeSizeInBits(TruncTy);
2202 Tmp = Builder.CreateTrunc(Tmp,
2203 llvm::IntegerType::get(getLLVMContext(), (unsigned)ResSize));
2204 Tmp = Builder.CreateIntToPtr(Tmp, TruncTy);
2205 } else if (Tmp->getType()->isPointerTy() && TruncTy->isIntegerTy()) {
2206 uint64_t TmpSize =CGM.getDataLayout().getTypeSizeInBits(Tmp->getType());
2207 Tmp = Builder.CreatePtrToInt(Tmp,
2208 llvm::IntegerType::get(getLLVMContext(), (unsigned)TmpSize));
2209 Tmp = Builder.CreateTrunc(Tmp, TruncTy);
2210 } else if (TruncTy->isIntegerTy()) {
2211 Tmp = Builder.CreateZExtOrTrunc(Tmp, TruncTy);
2212 } else if (TruncTy->isVectorTy()) {
2213 Tmp = Builder.CreateBitCast(Tmp, TruncTy);
2217 EmitStoreThroughLValue(RValue::get(Tmp), ResultRegDests[i]);
2221 LValue CodeGenFunction::InitCapturedStruct(const CapturedStmt &S) {
2222 const RecordDecl *RD = S.getCapturedRecordDecl();
2223 QualType RecordTy = getContext().getRecordType(RD);
2225 // Initialize the captured struct.
2227 MakeAddrLValue(CreateMemTemp(RecordTy, "agg.captured"), RecordTy);
2229 RecordDecl::field_iterator CurField = RD->field_begin();
2230 for (CapturedStmt::const_capture_init_iterator I = S.capture_init_begin(),
2231 E = S.capture_init_end();
2232 I != E; ++I, ++CurField) {
2233 LValue LV = EmitLValueForFieldInitialization(SlotLV, *CurField);
2234 if (CurField->hasCapturedVLAType()) {
2235 auto VAT = CurField->getCapturedVLAType();
2236 EmitStoreThroughLValue(RValue::get(VLASizeMap[VAT->getSizeExpr()]), LV);
2238 EmitInitializerForField(*CurField, LV, *I);
2245 /// Generate an outlined function for the body of a CapturedStmt, store any
2246 /// captured variables into the captured struct, and call the outlined function.
2248 CodeGenFunction::EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K) {
2249 LValue CapStruct = InitCapturedStruct(S);
2251 // Emit the CapturedDecl
2252 CodeGenFunction CGF(CGM, true);
2253 CGCapturedStmtRAII CapInfoRAII(CGF, new CGCapturedStmtInfo(S, K));
2254 llvm::Function *F = CGF.GenerateCapturedStmtFunction(S);
2255 delete CGF.CapturedStmtInfo;
2257 // Emit call to the helper function.
2258 EmitCallOrInvoke(F, CapStruct.getPointer());
2263 Address CodeGenFunction::GenerateCapturedStmtArgument(const CapturedStmt &S) {
2264 LValue CapStruct = InitCapturedStruct(S);
2265 return CapStruct.getAddress();
2268 /// Creates the outlined function for a CapturedStmt.
2270 CodeGenFunction::GenerateCapturedStmtFunction(const CapturedStmt &S) {
2271 assert(CapturedStmtInfo &&
2272 "CapturedStmtInfo should be set when generating the captured function");
2273 const CapturedDecl *CD = S.getCapturedDecl();
2274 const RecordDecl *RD = S.getCapturedRecordDecl();
2275 SourceLocation Loc = S.getLocStart();
2276 assert(CD->hasBody() && "missing CapturedDecl body");
2278 // Build the argument list.
2279 ASTContext &Ctx = CGM.getContext();
2280 FunctionArgList Args;
2281 Args.append(CD->param_begin(), CD->param_end());
2283 // Create the function declaration.
2284 const CGFunctionInfo &FuncInfo =
2285 CGM.getTypes().arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Args);
2286 llvm::FunctionType *FuncLLVMTy = CGM.getTypes().GetFunctionType(FuncInfo);
2289 llvm::Function::Create(FuncLLVMTy, llvm::GlobalValue::InternalLinkage,
2290 CapturedStmtInfo->getHelperName(), &CGM.getModule());
2291 CGM.SetInternalFunctionAttributes(CD, F, FuncInfo);
2292 if (CD->isNothrow())
2293 F->addFnAttr(llvm::Attribute::NoUnwind);
2295 // Generate the function.
2296 StartFunction(CD, Ctx.VoidTy, F, FuncInfo, Args,
2298 CD->getBody()->getLocStart());
2299 // Set the context parameter in CapturedStmtInfo.
2300 Address DeclPtr = GetAddrOfLocalVar(CD->getContextParam());
2301 CapturedStmtInfo->setContextValue(Builder.CreateLoad(DeclPtr));
2303 // Initialize variable-length arrays.
2304 LValue Base = MakeNaturalAlignAddrLValue(CapturedStmtInfo->getContextValue(),
2305 Ctx.getTagDeclType(RD));
2306 for (auto *FD : RD->fields()) {
2307 if (FD->hasCapturedVLAType()) {
2308 auto *ExprArg = EmitLoadOfLValue(EmitLValueForField(Base, FD),
2309 S.getLocStart()).getScalarVal();
2310 auto VAT = FD->getCapturedVLAType();
2311 VLASizeMap[VAT->getSizeExpr()] = ExprArg;
2315 // If 'this' is captured, load it into CXXThisValue.
2316 if (CapturedStmtInfo->isCXXThisExprCaptured()) {
2317 FieldDecl *FD = CapturedStmtInfo->getThisFieldDecl();
2318 LValue ThisLValue = EmitLValueForField(Base, FD);
2319 CXXThisValue = EmitLoadOfLValue(ThisLValue, Loc).getScalarVal();
2322 PGO.assignRegionCounters(GlobalDecl(CD), F);
2323 CapturedStmtInfo->EmitBody(*this, CD->getBody());
2324 FinishFunction(CD->getBodyRBrace());