clang 24.0.0git
CGStmt.cpp
Go to the documentation of this file.
1//===--- CGStmt.cpp - Emit LLVM Code from Statements ----------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This contains code to emit Stmt nodes as LLVM code.
10//
11//===----------------------------------------------------------------------===//
12
13#include "CGDebugInfo.h"
14#include "CGOpenMPRuntime.h"
15#include "CodeGenFunction.h"
16#include "CodeGenModule.h"
17#include "CodeGenPGO.h"
18#include "TargetInfo.h"
19#include "clang/AST/Attr.h"
20#include "clang/AST/Expr.h"
21#include "clang/AST/Stmt.h"
22#include "clang/AST/StmtSYCL.h"
30#include "llvm/ADT/ArrayRef.h"
31#include "llvm/ADT/DenseMap.h"
32#include "llvm/ADT/SmallSet.h"
33#include "llvm/ADT/StringExtras.h"
34#include "llvm/IR/Assumptions.h"
35#include "llvm/IR/DataLayout.h"
36#include "llvm/IR/InlineAsm.h"
37#include "llvm/IR/Intrinsics.h"
38#include "llvm/IR/MDBuilder.h"
39#include "llvm/Support/SaveAndRestore.h"
40#include <optional>
41
42using namespace clang;
43using namespace CodeGen;
44
45//===----------------------------------------------------------------------===//
46// Statement Emission
47//===----------------------------------------------------------------------===//
48
50 if (CGDebugInfo *DI = getDebugInfo()) {
52 Loc = S->getBeginLoc();
53 DI->EmitLocation(Builder, Loc);
54
55 LastStopPoint = Loc;
56 }
57}
58
60 assert(S && "Null statement?");
61 PGO->setCurrentStmt(S);
62
63 // These statements have their own debug info handling.
64 if (EmitSimpleStmt(S, Attrs))
65 return;
66
67 // Check if we are generating unreachable code.
68 if (!HaveInsertPoint()) {
69 // If so, and the statement doesn't contain a label, then we do not need to
70 // generate actual code. This is safe because (1) the current point is
71 // unreachable, so we don't need to execute the code, and (2) we've already
72 // handled the statements which update internal data structures (like the
73 // local variable map) which could be used by subsequent statements.
74 if (!ContainsLabel(S)) {
75 // Verify that any decl statements were handled as simple, they may be in
76 // scope of subsequent reachable statements.
77 assert(!isa<DeclStmt>(*S) && "Unexpected DeclStmt!");
78 PGO->markStmtMaybeUsed(S);
79 return;
80 }
81
82 // Otherwise, make a new block to hold the code.
84 }
85
86 // Generate a stoppoint if we are emitting debug info.
88
89 // Ignore all OpenMP directives except for simd if OpenMP with Simd is
90 // enabled.
91 if (getLangOpts().OpenMP && getLangOpts().OpenMPSimd) {
92 if (const auto *D = dyn_cast<OMPExecutableDirective>(S)) {
94 return;
95 }
96 }
97
98 switch (S->getStmtClass()) {
100 case Stmt::CXXCatchStmtClass:
101 case Stmt::SEHExceptStmtClass:
102 case Stmt::SEHFinallyStmtClass:
103 case Stmt::MSDependentExistsStmtClass:
104 case Stmt::UnresolvedSYCLKernelCallStmtClass:
105 llvm_unreachable("invalid statement class to emit generically");
106 case Stmt::NullStmtClass:
107 case Stmt::CompoundStmtClass:
108 case Stmt::DeclStmtClass:
109 case Stmt::LabelStmtClass:
110 case Stmt::AttributedStmtClass:
111 case Stmt::GotoStmtClass:
112 case Stmt::BreakStmtClass:
113 case Stmt::ContinueStmtClass:
114 case Stmt::DefaultStmtClass:
115 case Stmt::CaseStmtClass:
116 case Stmt::DeferStmtClass:
117 case Stmt::SEHLeaveStmtClass:
118 case Stmt::SYCLKernelCallStmtClass:
119 llvm_unreachable("should have emitted these statements as simple");
120
121#define STMT(Type, Base)
122#define ABSTRACT_STMT(Op)
123#define EXPR(Type, Base) \
124 case Stmt::Type##Class:
125#include "clang/AST/StmtNodes.inc"
126 {
127 // Remember the block we came in on.
128 llvm::BasicBlock *incoming = Builder.GetInsertBlock();
129 assert(incoming && "expression emission must have an insertion point");
130
132
133 llvm::BasicBlock *outgoing = Builder.GetInsertBlock();
134 assert(outgoing && "expression emission cleared block!");
135
136 // The expression emitters assume (reasonably!) that the insertion
137 // point is always set. To maintain that, the call-emission code
138 // for noreturn functions has to enter a new block with no
139 // predecessors. We want to kill that block and mark the current
140 // insertion point unreachable in the common case of a call like
141 // "exit();". Since expression emission doesn't otherwise create
142 // blocks with no predecessors, we can just test for that.
143 // However, we must be careful not to do this to our incoming
144 // block, because *statement* emission does sometimes create
145 // reachable blocks which will have no predecessors until later in
146 // the function. This occurs with, e.g., labels that are not
147 // reachable by fallthrough.
148 if (incoming != outgoing && outgoing->use_empty()) {
149 outgoing->eraseFromParent();
150 Builder.ClearInsertionPoint();
151 }
152 break;
153 }
154
155 case Stmt::IndirectGotoStmtClass:
157
158 case Stmt::IfStmtClass: EmitIfStmt(cast<IfStmt>(*S)); break;
159 case Stmt::WhileStmtClass: EmitWhileStmt(cast<WhileStmt>(*S), Attrs); break;
160 case Stmt::DoStmtClass: EmitDoStmt(cast<DoStmt>(*S), Attrs); break;
161 case Stmt::ForStmtClass: EmitForStmt(cast<ForStmt>(*S), Attrs); break;
162
163 case Stmt::ReturnStmtClass: EmitReturnStmt(cast<ReturnStmt>(*S)); break;
164
165 case Stmt::SwitchStmtClass: EmitSwitchStmt(cast<SwitchStmt>(*S)); break;
166 case Stmt::GCCAsmStmtClass: // Intentional fall-through.
167 case Stmt::MSAsmStmtClass: EmitAsmStmt(cast<AsmStmt>(*S)); break;
168 case Stmt::CoroutineBodyStmtClass:
170 break;
171 case Stmt::CoreturnStmtClass:
173 break;
174 case Stmt::CapturedStmtClass: {
175 const CapturedStmt *CS = cast<CapturedStmt>(S);
177 }
178 break;
179 case Stmt::ObjCAtTryStmtClass:
181 break;
182 case Stmt::ObjCAtCatchStmtClass:
183 llvm_unreachable(
184 "@catch statements should be handled by EmitObjCAtTryStmt");
185 case Stmt::ObjCAtFinallyStmtClass:
186 llvm_unreachable(
187 "@finally statements should be handled by EmitObjCAtTryStmt");
188 case Stmt::ObjCAtThrowStmtClass:
190 break;
191 case Stmt::ObjCAtSynchronizedStmtClass:
193 break;
194 case Stmt::ObjCForCollectionStmtClass:
196 break;
197 case Stmt::ObjCAutoreleasePoolStmtClass:
199 break;
200
201 case Stmt::CXXTryStmtClass:
203 break;
204 case Stmt::CXXForRangeStmtClass:
206 break;
207 case Stmt::CXXExpansionStmtPatternClass:
208 llvm_unreachable("unexpanded expansion statements should not be emitted");
209 case Stmt::CXXExpansionStmtInstantiationClass:
211 break;
212 case Stmt::SEHTryStmtClass:
214 break;
215 case Stmt::OMPMetaDirectiveClass:
217 break;
218 case Stmt::OMPCanonicalLoopClass:
220 break;
221 case Stmt::OMPParallelDirectiveClass:
223 break;
224 case Stmt::OMPSimdDirectiveClass:
226 break;
227 case Stmt::OMPTileDirectiveClass:
229 break;
230 case Stmt::OMPStripeDirectiveClass:
232 break;
233 case Stmt::OMPUnrollDirectiveClass:
235 break;
236 case Stmt::OMPReverseDirectiveClass:
238 break;
239 case Stmt::OMPSplitDirectiveClass:
241 break;
242 case Stmt::OMPInterchangeDirectiveClass:
244 break;
245 case Stmt::OMPFlattenDirectiveClass:
247 break;
248 case Stmt::OMPFuseDirectiveClass:
250 break;
251 case Stmt::OMPForDirectiveClass:
253 break;
254 case Stmt::OMPForSimdDirectiveClass:
256 break;
257 case Stmt::OMPSectionsDirectiveClass:
259 break;
260 case Stmt::OMPSectionDirectiveClass:
262 break;
263 case Stmt::OMPSingleDirectiveClass:
265 break;
266 case Stmt::OMPMasterDirectiveClass:
268 break;
269 case Stmt::OMPCriticalDirectiveClass:
271 break;
272 case Stmt::OMPParallelForDirectiveClass:
274 break;
275 case Stmt::OMPParallelForSimdDirectiveClass:
277 break;
278 case Stmt::OMPParallelMasterDirectiveClass:
280 break;
281 case Stmt::OMPParallelSectionsDirectiveClass:
283 break;
284 case Stmt::OMPTaskDirectiveClass:
286 break;
287 case Stmt::OMPTaskyieldDirectiveClass:
289 break;
290 case Stmt::OMPErrorDirectiveClass:
292 break;
293 case Stmt::OMPBarrierDirectiveClass:
295 break;
296 case Stmt::OMPTaskwaitDirectiveClass:
298 break;
299 case Stmt::OMPTaskgroupDirectiveClass:
301 break;
302 case Stmt::OMPFlushDirectiveClass:
304 break;
305 case Stmt::OMPDepobjDirectiveClass:
307 break;
308 case Stmt::OMPScanDirectiveClass:
310 break;
311 case Stmt::OMPOrderedStandaloneDirectiveClass:
313 break;
314 case Stmt::OMPOrderedBlockAssocDirectiveClass:
316 break;
317 case Stmt::OMPAtomicDirectiveClass:
319 break;
320 case Stmt::OMPTargetDirectiveClass:
322 break;
323 case Stmt::OMPTeamsDirectiveClass:
325 break;
326 case Stmt::OMPCancellationPointDirectiveClass:
328 break;
329 case Stmt::OMPCancelDirectiveClass:
331 break;
332 case Stmt::OMPTargetDataDirectiveClass:
334 break;
335 case Stmt::OMPTargetEnterDataDirectiveClass:
337 break;
338 case Stmt::OMPTargetExitDataDirectiveClass:
340 break;
341 case Stmt::OMPTargetParallelDirectiveClass:
343 break;
344 case Stmt::OMPTargetParallelForDirectiveClass:
346 break;
347 case Stmt::OMPTaskLoopDirectiveClass:
349 break;
350 case Stmt::OMPTaskLoopSimdDirectiveClass:
352 break;
353 case Stmt::OMPMasterTaskLoopDirectiveClass:
355 break;
356 case Stmt::OMPMaskedTaskLoopDirectiveClass:
358 break;
359 case Stmt::OMPMasterTaskLoopSimdDirectiveClass:
362 break;
363 case Stmt::OMPMaskedTaskLoopSimdDirectiveClass:
366 break;
367 case Stmt::OMPParallelMasterTaskLoopDirectiveClass:
370 break;
371 case Stmt::OMPParallelMaskedTaskLoopDirectiveClass:
374 break;
375 case Stmt::OMPParallelMasterTaskLoopSimdDirectiveClass:
378 break;
379 case Stmt::OMPParallelMaskedTaskLoopSimdDirectiveClass:
382 break;
383 case Stmt::OMPDistributeDirectiveClass:
385 break;
386 case Stmt::OMPTargetUpdateDirectiveClass:
388 break;
389 case Stmt::OMPDistributeParallelForDirectiveClass:
392 break;
393 case Stmt::OMPDistributeParallelForSimdDirectiveClass:
396 break;
397 case Stmt::OMPDistributeSimdDirectiveClass:
399 break;
400 case Stmt::OMPTargetParallelForSimdDirectiveClass:
403 break;
404 case Stmt::OMPTargetSimdDirectiveClass:
406 break;
407 case Stmt::OMPTeamsDistributeDirectiveClass:
409 break;
410 case Stmt::OMPTeamsDistributeSimdDirectiveClass:
413 break;
414 case Stmt::OMPTeamsDistributeParallelForSimdDirectiveClass:
417 break;
418 case Stmt::OMPTeamsDistributeParallelForDirectiveClass:
421 break;
422 case Stmt::OMPTargetTeamsDirectiveClass:
424 break;
425 case Stmt::OMPTargetTeamsDistributeDirectiveClass:
428 break;
429 case Stmt::OMPTargetTeamsDistributeParallelForDirectiveClass:
432 break;
433 case Stmt::OMPTargetTeamsDistributeParallelForSimdDirectiveClass:
436 break;
437 case Stmt::OMPTargetTeamsDistributeSimdDirectiveClass:
440 break;
441 case Stmt::OMPInteropDirectiveClass:
443 break;
444 case Stmt::OMPDispatchDirectiveClass:
445 CGM.ErrorUnsupported(S, "OpenMP dispatch directive");
446 break;
447 case Stmt::OMPScopeDirectiveClass:
449 break;
450 case Stmt::OMPMaskedDirectiveClass:
452 break;
453 case Stmt::OMPGenericLoopDirectiveClass:
455 break;
456 case Stmt::OMPTeamsGenericLoopDirectiveClass:
458 break;
459 case Stmt::OMPTargetTeamsGenericLoopDirectiveClass:
462 break;
463 case Stmt::OMPParallelGenericLoopDirectiveClass:
466 break;
467 case Stmt::OMPTargetParallelGenericLoopDirectiveClass:
470 break;
471 case Stmt::OMPParallelMaskedDirectiveClass:
473 break;
474 case Stmt::OMPAssumeDirectiveClass:
476 break;
477 case Stmt::OpenACCComputeConstructClass:
479 break;
480 case Stmt::OpenACCLoopConstructClass:
482 break;
483 case Stmt::OpenACCCombinedConstructClass:
485 break;
486 case Stmt::OpenACCDataConstructClass:
488 break;
489 case Stmt::OpenACCEnterDataConstructClass:
491 break;
492 case Stmt::OpenACCExitDataConstructClass:
494 break;
495 case Stmt::OpenACCHostDataConstructClass:
497 break;
498 case Stmt::OpenACCWaitConstructClass:
500 break;
501 case Stmt::OpenACCInitConstructClass:
503 break;
504 case Stmt::OpenACCShutdownConstructClass:
506 break;
507 case Stmt::OpenACCSetConstructClass:
509 break;
510 case Stmt::OpenACCUpdateConstructClass:
512 break;
513 case Stmt::OpenACCAtomicConstructClass:
515 break;
516 case Stmt::OpenACCCacheConstructClass:
518 break;
519 }
520}
521
524 switch (S->getStmtClass()) {
525 default:
526 return false;
527 case Stmt::NullStmtClass:
528 break;
529 case Stmt::CompoundStmtClass:
531 break;
532 case Stmt::DeclStmtClass:
534 break;
535 case Stmt::LabelStmtClass:
537 break;
538 case Stmt::AttributedStmtClass:
540 break;
541 case Stmt::GotoStmtClass:
543 break;
544 case Stmt::BreakStmtClass:
546 break;
547 case Stmt::ContinueStmtClass:
549 break;
550 case Stmt::DefaultStmtClass:
552 break;
553 case Stmt::CaseStmtClass:
554 EmitCaseStmt(cast<CaseStmt>(*S), Attrs);
555 break;
556 case Stmt::DeferStmtClass:
558 break;
559 case Stmt::SEHLeaveStmtClass:
561 break;
562 case Stmt::SYCLKernelCallStmtClass:
564 break;
565 }
566 return true;
567}
568
569/// EmitCompoundStmt - Emit a compound statement {..} node. If GetLast is true,
570/// this captures the expression result of the last sub-statement and returns it
571/// (for use by the statement expression extension).
573 AggValueSlot AggSlot) {
574 PrettyStackTraceLoc CrashInfo(getContext().getSourceManager(),S.getLBracLoc(),
575 "LLVM IR generation of compound statement ('{}')");
576
577 // Keep track of the current cleanup stack depth, including debug scopes.
579
580 return EmitCompoundStmtWithoutScope(S, GetLast, AggSlot);
581}
582
585 bool GetLast,
586 AggValueSlot AggSlot) {
587
589 E = S.body_end() - GetLast;
590 I != E; ++I)
591 EmitStmt(*I);
592
593 Address RetAlloca = Address::invalid();
594 if (GetLast) {
595 // We have to special case labels here. They are statements, but when put
596 // at the end of a statement expression, they yield the value of their
597 // subexpression. Handle this by walking through all labels we encounter,
598 // emitting them before we evaluate the subexpr.
599 // Similar issues arise for attributed statements.
600 const Stmt *LastStmt = S.body_back();
601 while (!isa<Expr>(LastStmt)) {
602 if (const auto *LS = dyn_cast<LabelStmt>(LastStmt)) {
603 EmitLabel(LS->getDecl());
604 LastStmt = LS->getSubStmt();
605 } else if (const auto *AS = dyn_cast<AttributedStmt>(LastStmt)) {
606 // FIXME: Update this if we ever have attributes that affect the
607 // semantics of an expression.
608 LastStmt = AS->getSubStmt();
609 } else {
610 llvm_unreachable("unknown value statement");
611 }
612 }
613
615
616 const Expr *E = cast<Expr>(LastStmt);
617 QualType ExprTy = E->getType();
618 if (hasAggregateEvaluationKind(ExprTy)) {
619 EmitAggExpr(E, AggSlot);
620 } else {
621 // We can't return an RValue here because there might be cleanups at
622 // the end of the StmtExpr. Because of that, we have to emit the result
623 // here into a temporary alloca.
624 RetAlloca = CreateMemTempWithoutCast(ExprTy);
625 EmitAnyExprToMem(E, RetAlloca, Qualifiers(),
626 /*IsInit*/ false);
627 }
628 }
629
630 return RetAlloca;
631}
632
634 llvm::UncondBrInst *BI = dyn_cast<llvm::UncondBrInst>(BB->getTerminator());
635
636 // If there is a cleanup stack, then we it isn't worth trying to
637 // simplify this block (we would need to remove it from the scope map
638 // and cleanup entry).
639 if (!EHStack.empty())
640 return;
641
642 // Can only simplify direct branches.
643 if (!BI)
644 return;
645
646 // Can only simplify empty blocks.
647 if (BI->getIterator() != BB->begin())
648 return;
649
650 BB->replaceAllUsesWith(BI->getSuccessor());
651 BI->eraseFromParent();
652 BB->eraseFromParent();
653}
654
655void CodeGenFunction::EmitBlock(llvm::BasicBlock *BB, bool IsFinished) {
656 llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
657
658 // Fall out of the current block (if necessary).
659 EmitBranch(BB);
660
661 if (IsFinished && BB->use_empty()) {
662 delete BB;
663 return;
664 }
665
666 // Place the block after the current block, if possible, or else at
667 // the end of the function.
668 if (CurBB && CurBB->getParent())
669 CurFn->insert(std::next(CurBB->getIterator()), BB);
670 else
671 CurFn->insert(CurFn->end(), BB);
672 Builder.SetInsertPoint(BB);
673}
674
675void CodeGenFunction::EmitBranch(llvm::BasicBlock *Target) {
676 // Emit a branch from the current block to the target one if this
677 // was a real block. If this was just a fall-through block after a
678 // terminator, don't emit it.
679 llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
680
681 if (!CurBB || CurBB->hasTerminator()) {
682 // If there is no insert point or the previous block is already
683 // terminated, don't touch it.
684 } else {
685 // Otherwise, create a fall-through branch.
686 Builder.CreateBr(Target);
687 }
688
689 Builder.ClearInsertionPoint();
690}
691
692void CodeGenFunction::EmitBlockAfterUses(llvm::BasicBlock *block) {
693 bool inserted = false;
694 for (llvm::User *u : block->users()) {
695 if (llvm::Instruction *insn = dyn_cast<llvm::Instruction>(u)) {
696 CurFn->insert(std::next(insn->getParent()->getIterator()), block);
697 inserted = true;
698 break;
699 }
700 }
701
702 if (!inserted)
703 CurFn->insert(CurFn->end(), block);
704
705 Builder.SetInsertPoint(block);
706}
707
710 JumpDest &Dest = LabelMap[D];
711 if (Dest.isValid()) return Dest;
712
713 // Create, but don't insert, the new block.
714 Dest = JumpDest(createBasicBlock(D->getName()),
717 return Dest;
718}
719
721 // Add this label to the current lexical scope if we're within any
722 // normal cleanups. Jumps "in" to this label --- when permitted by
723 // the language --- may need to be routed around such cleanups.
724 if (EHStack.hasNormalCleanups() && CurLexicalScope)
725 CurLexicalScope->addLabel(D);
726
727 JumpDest &Dest = LabelMap[D];
728
729 // If we didn't need a forward reference to this label, just go
730 // ahead and create a destination at the current scope.
731 if (!Dest.isValid()) {
733
734 // Otherwise, we need to give this label a target depth and remove
735 // it from the branch-fixups list.
736 } else {
737 assert(!Dest.getScopeDepth().isValid() && "already emitted label!");
738 Dest.setScopeDepth(EHStack.stable_begin());
740 }
741
742 EmitBlock(Dest.getBlock());
743
744 // Emit debug info for labels.
745 if (CGDebugInfo *DI = getDebugInfo()) {
746 if (CGM.getCodeGenOpts().hasReducedDebugInfo()) {
747 DI->setLocation(D->getLocation());
748 DI->EmitLabel(D, Builder);
749 }
750 }
751
753}
754
755/// Change the cleanup scope of the labels in this lexical scope to
756/// match the scope of the enclosing context.
758 assert(!Labels.empty());
759 EHScopeStack::stable_iterator innermostScope
760 = CGF.EHStack.getInnermostNormalCleanup();
761
762 // Change the scope depth of all the labels.
763 for (const LabelDecl *Label : Labels) {
764 assert(CGF.LabelMap.count(Label));
765 JumpDest &dest = CGF.LabelMap.find(Label)->second;
766 assert(dest.getScopeDepth().isValid());
767 assert(innermostScope.encloses(dest.getScopeDepth()));
768 dest.setScopeDepth(innermostScope);
769 }
770
771 // Reparent the labels if the new scope also has cleanups.
772 if (innermostScope != EHScopeStack::stable_end() && ParentScope) {
773 ParentScope->Labels.append(Labels.begin(), Labels.end());
774 }
775}
776
777
779 EmitLabel(S.getDecl());
780
781 // IsEHa - emit eha.scope.begin if it's a side entry of a scope
782 if (getLangOpts().EHAsynch && S.isSideEntry())
784
785 EmitStmt(S.getSubStmt());
786}
787
789 bool nomerge = InNoMergeAttributedStmt;
790 bool noinline = InNoInlineAttributedStmt;
791 bool alwaysinline = InAlwaysInlineAttributedStmt;
792 bool noconvergent = InNoConvergentAttributedStmt;
793 StringRef amdgpuAVMode = AMDGPUAvailableVisibleMode;
794 HLSLControlFlowHintAttr::Spelling flattenOrBranch = HLSLControlFlowAttr;
795 const CallExpr *musttail = MustTailCall;
796 const AtomicAttr *AA = nullptr;
797
798 for (const auto *A : S.getAttrs()) {
799 switch (A->getKind()) {
800 default:
801 break;
802 case attr::NoMerge:
803 nomerge = true;
804 break;
805 case attr::NoInline:
806 noinline = true;
807 alwaysinline = false;
808 break;
809 case attr::AlwaysInline:
810 alwaysinline = true;
811 noinline = false;
812 break;
813 case attr::NoConvergent:
814 noconvergent = true;
815 break;
816 case attr::MustTail: {
817 const Stmt *Sub = S.getSubStmt();
818 const ReturnStmt *R = cast<ReturnStmt>(Sub);
819 musttail = cast<CallExpr>(R->getRetValue()->IgnoreParens());
820 } break;
821 case attr::CXXAssume: {
822 const Expr *Assumption = cast<CXXAssumeAttr>(A)->getAssumption();
823 if (getLangOpts().CXXAssumptions && Builder.GetInsertBlock() &&
824 !Assumption->HasSideEffects(getContext())) {
825 llvm::Value *AssumptionVal = EmitCheckedArgForAssume(Assumption);
826 Builder.CreateAssumption(AssumptionVal);
827 }
828 } break;
829 case attr::Atomic:
830 AA = cast<AtomicAttr>(A);
831 break;
832 case attr::AMDGPUAvailableVisible:
833 amdgpuAVMode = cast<AMDGPUAvailableVisibleAttr>(A)->getMode();
834 break;
835 case attr::HLSLControlFlowHint: {
836 flattenOrBranch = cast<HLSLControlFlowHintAttr>(A)->getSemanticSpelling();
837 } break;
838 }
839 }
840
841 assert(!(alwaysinline && noinline) &&
842 "alwaysinline and noinline are mutually exclusive");
843
844 SaveAndRestore save_nomerge(InNoMergeAttributedStmt, nomerge);
845 SaveAndRestore save_noinline(InNoInlineAttributedStmt, noinline);
846 SaveAndRestore save_alwaysinline(InAlwaysInlineAttributedStmt, alwaysinline);
847 SaveAndRestore save_noconvergent(InNoConvergentAttributedStmt, noconvergent);
848 SaveAndRestore save_amdgpuav(AMDGPUAvailableVisibleMode, amdgpuAVMode);
849 SaveAndRestore save_musttail(MustTailCall, musttail);
850 SaveAndRestore save_flattenOrBranch(HLSLControlFlowAttr, flattenOrBranch);
851 CGAtomicOptionsRAII AORAII(CGM, AA);
852 EmitStmt(S.getSubStmt(), S.getAttrs());
853}
854
856 // If this code is reachable then emit a stop point (if generating
857 // debug info). We have to do this ourselves because we are on the
858 // "simple" statement path.
859 if (HaveInsertPoint())
860 EmitStopPoint(&S);
861
862 // Reinitialize the variables this goto bypasses, whose scope it re-enters.
863 // Backward gotos reinit here while forward gotos are recorded for
864 // EmitAutoVarAlloca to patch once the alloca exists. Skip when jump sources
865 // are unknown (computed goto); EmitAutoVarAlloca then uses function-scope
866 // init.
867 if (HaveInsertPoint() && !Bypasses.isAlwaysBypassed()) {
869 BypassingForwardJumps.push_back({Builder.GetInsertBlock(), &S});
870 }
871
874}
875
876
879 if (const LabelDecl *Target = S.getConstantTarget()) {
881 return;
882 }
883
884 // Ensure that we have an i8* for our PHI node.
885 llvm::Value *V = Builder.CreateBitCast(EmitScalarExpr(S.getTarget()),
886 Int8PtrTy, "addr");
887 llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
888
889 // Get the basic block for the indirect goto.
890 llvm::BasicBlock *IndGotoBB = GetIndirectGotoBlock();
891
892 // The first instruction in the block has to be the PHI for the switch dest,
893 // add an entry for this branch.
894 cast<llvm::PHINode>(IndGotoBB->begin())->addIncoming(V, CurBB);
895
896 EmitBranch(IndGotoBB);
897 if (CurBB && CurBB->hasTerminator())
898 addInstToCurrentSourceAtom(CurBB->getTerminator(), nullptr);
899}
900
902 const Stmt *Else = S.getElse();
903
904 // The else branch of a consteval if statement is always the only branch that
905 // can be runtime evaluated.
906 if (S.isConsteval()) {
907 const Stmt *Executed = S.isNegatedConsteval() ? S.getThen() : Else;
908 if (Executed) {
909 RunCleanupsScope ExecutedScope(*this);
910 EmitStmt(Executed);
911 }
912 return;
913 }
914
915 // C99 6.8.4.1: The first substatement is executed if the expression compares
916 // unequal to 0. The condition must be a scalar type.
917 LexicalScope ConditionScope(*this, S.getCond()->getSourceRange());
918 ApplyDebugLocation DL(*this, S.getCond());
919
920 if (S.getInit()) {
921 EmitStmt(S.getInit());
922
923 // The init statement may have cleared the insertion point (e.g. it ended in
924 // a 'noreturn' call); the condition emitted below needs a valid one.
926 }
927
928 if (S.getConditionVariable())
930
931 // If the condition constant folds and can be elided, try to avoid emitting
932 // the condition and the dead arm of the if/else.
933 bool CondConstant;
934 if (ConstantFoldsToSimpleInteger(S.getCond(), CondConstant,
935 S.isConstexpr())) {
936 // Figure out which block (then or else) is executed.
937 const Stmt *Executed = S.getThen();
938 const Stmt *Skipped = Else;
939 if (!CondConstant) // Condition false?
940 std::swap(Executed, Skipped);
941
942 // If the skipped block has no labels in it, just emit the executed block.
943 // This avoids emitting dead code and simplifies the CFG substantially.
944 if (S.isConstexpr() || !ContainsLabel(Skipped)) {
946 /*UseBoth=*/true);
947 if (Executed) {
949 RunCleanupsScope ExecutedScope(*this);
950 EmitStmt(Executed);
951 }
952 PGO->markStmtMaybeUsed(Skipped);
953 return;
954 }
955 }
956
957 auto HasSkip = hasSkipCounter(&S);
958
959 // Otherwise, the condition did not fold, or we couldn't elide it. Just emit
960 // the conditional branch.
961 llvm::BasicBlock *ThenBlock = createBasicBlock("if.then");
962 llvm::BasicBlock *ContBlock = createBasicBlock("if.end");
963 llvm::BasicBlock *ElseBlock =
964 (Else || HasSkip ? createBasicBlock("if.else") : ContBlock);
965 // Prefer the PGO based weights over the likelihood attribute.
966 // When the build isn't optimized the metadata isn't used, so don't generate
967 // it.
968 // Also, differentiate between disabled PGO and a never executed branch with
969 // PGO. Assuming PGO is in use:
970 // - we want to ignore the [[likely]] attribute if the branch is never
971 // executed,
972 // - assuming the profile is poor, preserving the attribute may still be
973 // beneficial.
974 // As an approximation, preserve the attribute only if both the branch and the
975 // parent context were not executed.
977 uint64_t ThenCount = getProfileCount(S.getThen());
978 if (!ThenCount && !getCurrentProfileCount() &&
979 CGM.getCodeGenOpts().OptimizationLevel)
980 LH = Stmt::getLikelihood(S.getThen(), Else);
981
982 // When measuring MC/DC, always fully evaluate the condition up front using
983 // EvaluateExprAsBool() so that the test vector bitmap can be updated prior to
984 // executing the body of the if.then or if.else. This is useful for when
985 // there is a 'return' within the body, but this is particularly beneficial
986 // when one if-stmt is nested within another if-stmt so that all of the MC/DC
987 // updates are kept linear and consistent.
988 if (!CGM.getCodeGenOpts().MCDCCoverage) {
989 EmitBranchOnBoolExpr(S.getCond(), ThenBlock, ElseBlock, ThenCount, LH,
990 /*ConditionalOp=*/nullptr,
991 /*ConditionalDecl=*/S.getConditionVariable());
992 } else {
993 llvm::Value *BoolCondVal = EvaluateExprAsBool(S.getCond());
995 Builder.CreateCondBr(BoolCondVal, ThenBlock, ElseBlock);
996 }
997
998 // Emit the 'then' code.
999 EmitBlock(ThenBlock);
1001 {
1002 RunCleanupsScope ThenScope(*this);
1003 EmitStmt(S.getThen());
1004 }
1005 EmitBranch(ContBlock);
1006
1007 // Emit the 'else' code if present.
1008 if (Else) {
1009 {
1010 // There is no need to emit line number for an unconditional branch.
1011 auto NL = ApplyDebugLocation::CreateEmpty(*this);
1012 EmitBlock(ElseBlock);
1013 }
1014 // Add a counter to else block unless it has CounterExpr.
1015 if (HasSkip)
1017 {
1018 RunCleanupsScope ElseScope(*this);
1019 EmitStmt(Else);
1020 }
1021 {
1022 // There is no need to emit line number for an unconditional branch.
1023 auto NL = ApplyDebugLocation::CreateEmpty(*this);
1024 EmitBranch(ContBlock);
1025 }
1026 } else if (HasSkip) {
1027 EmitBlock(ElseBlock);
1029 EmitBranch(ContBlock);
1030 }
1031
1032 // Emit the continuation block for code after the if.
1033 EmitBlock(ContBlock, true);
1034}
1035
1036bool CodeGenFunction::checkIfLoopMustProgress(const Expr *ControllingExpression,
1037 bool HasEmptyBody) {
1039 getLangOpts(), CGM.getCodeGenOpts(), getContext(), ControllingExpression,
1040 HasEmptyBody,
1041 [this] { CurFn->removeFnAttr(llvm::Attribute::MustProgress); });
1042}
1043
1045 ArrayRef<const Attr *> WhileAttrs) {
1046 // Emit the header for the loop, which will also become
1047 // the continue target.
1048 JumpDest LoopHeader = getJumpDestInCurrentScope("while.cond");
1049 EmitBlock(LoopHeader.getBlock());
1050
1051 if (CGM.shouldEmitConvergenceTokens())
1052 ConvergenceTokenStack.push_back(
1053 emitConvergenceLoopToken(LoopHeader.getBlock()));
1054
1055 // Create an exit block for when the condition fails, which will
1056 // also become the break target.
1058
1059 // Store the blocks to use for break and continue.
1060 BreakContinueStack.push_back(BreakContinue(S, LoopExit, LoopHeader));
1061
1062 // C++ [stmt.while]p2:
1063 // When the condition of a while statement is a declaration, the
1064 // scope of the variable that is declared extends from its point
1065 // of declaration (3.3.2) to the end of the while statement.
1066 // [...]
1067 // The object created in a condition is destroyed and created
1068 // with each iteration of the loop.
1069 RunCleanupsScope ConditionScope(*this);
1070
1071 if (S.getConditionVariable())
1073
1074 // Evaluate the conditional in the while header. C99 6.8.5.1: The
1075 // evaluation of the controlling expression takes place before each
1076 // execution of the loop body.
1077 llvm::Value *BoolCondVal = EvaluateExprAsBool(S.getCond());
1078
1080
1081 // while(1) is common, avoid extra exit blocks. Be sure
1082 // to correctly handle break/continue though.
1083 llvm::ConstantInt *C = dyn_cast<llvm::ConstantInt>(BoolCondVal);
1084 bool EmitBoolCondBranch = !C || !C->isOne();
1085 const SourceRange &R = S.getSourceRange();
1086 LoopStack.push(
1087 LoopHeader.getBlock(), CGM.getContext(), CGM.getCodeGenOpts(), WhileAttrs,
1088 SourceLocToDebugLoc(R.getBegin()), SourceLocToDebugLoc(R.getEnd()),
1090
1091 // As long as the condition is true, go to the loop body.
1092 llvm::BasicBlock *LoopBody = createBasicBlock("while.body");
1093 if (EmitBoolCondBranch) {
1094 llvm::BasicBlock *ExitBlock = LoopExit.getBlock();
1095 if (hasSkipCounter(&S) || ConditionScope.requiresCleanups())
1096 ExitBlock = createBasicBlock("while.exit");
1097 llvm::MDNode *Weights =
1098 createProfileWeightsForLoop(S.getCond(), getProfileCount(S.getBody()));
1099 if (!Weights && CGM.getCodeGenOpts().OptimizationLevel)
1100 BoolCondVal = emitCondLikelihoodViaExpectIntrinsic(
1101 BoolCondVal, Stmt::getLikelihood(S.getBody()));
1102 auto *I = Builder.CreateCondBr(BoolCondVal, LoopBody, ExitBlock, Weights);
1103 // Key Instructions: Emit the condition and branch as separate source
1104 // location atoms otherwise we may omit a step onto the loop condition in
1105 // favour of the `while` keyword.
1106 // FIXME: We could have the branch as the backup location for the condition,
1107 // which would probably be a better experience. Explore this later.
1108 if (auto *CondI = dyn_cast<llvm::Instruction>(BoolCondVal))
1109 addInstToNewSourceAtom(CondI, nullptr);
1110 addInstToNewSourceAtom(I, nullptr);
1111
1112 if (ExitBlock != LoopExit.getBlock()) {
1113 EmitBlock(ExitBlock);
1116 }
1117 } else if (const Attr *A = Stmt::getLikelihoodAttr(S.getBody())) {
1118 CGM.getDiags().Report(A->getLocation(),
1119 diag::warn_attribute_has_no_effect_on_infinite_loop)
1120 << A << A->getRange();
1121 CGM.getDiags().Report(
1122 S.getWhileLoc(),
1123 diag::note_attribute_has_no_effect_on_infinite_loop_here)
1125 }
1126
1127 // Emit the loop body. We have to emit this in a cleanup scope
1128 // because it might be a singleton DeclStmt.
1129 {
1130 RunCleanupsScope BodyScope(*this);
1131 EmitBlock(LoopBody);
1133 EmitStmt(S.getBody());
1134 }
1135
1136 BreakContinueStack.pop_back();
1137
1138 // Immediately force cleanup.
1139 ConditionScope.ForceCleanup();
1140
1141 EmitStopPoint(&S);
1142 // Branch to the loop header again.
1143 EmitBranch(LoopHeader.getBlock());
1144
1145 LoopStack.pop();
1146
1147 // Emit the exit block.
1148 EmitBlock(LoopExit.getBlock(), true);
1149
1150 // The LoopHeader typically is just a branch if we skipped emitting
1151 // a branch, try to erase it.
1152 if (!EmitBoolCondBranch) {
1153 SimplifyForwardingBlocks(LoopHeader.getBlock());
1154 PGO->markStmtAsUsed(true, &S);
1155 }
1156
1157 if (CGM.shouldEmitConvergenceTokens())
1158 ConvergenceTokenStack.pop_back();
1159}
1160
1162 ArrayRef<const Attr *> DoAttrs) {
1164 JumpDest LoopCond = getJumpDestInCurrentScope("do.cond");
1165
1166 uint64_t ParentCount = getCurrentProfileCount();
1167
1168 // Store the blocks to use for break and continue.
1169 BreakContinueStack.push_back(BreakContinue(S, LoopExit, LoopCond));
1170
1171 // Emit the body of the loop.
1172 llvm::BasicBlock *LoopBody = createBasicBlock("do.body");
1173
1174 EmitBlockWithFallThrough(LoopBody, &S);
1175
1176 if (CGM.shouldEmitConvergenceTokens())
1178
1179 {
1180 RunCleanupsScope BodyScope(*this);
1181 EmitStmt(S.getBody());
1182 }
1183
1184 EmitBlock(LoopCond.getBlock());
1185
1186 // C99 6.8.5.2: "The evaluation of the controlling expression takes place
1187 // after each execution of the loop body."
1188
1189 // Evaluate the conditional in the while header.
1190 // C99 6.8.5p2/p4: The first substatement is executed if the expression
1191 // compares unequal to 0. The condition must be a scalar type.
1192 llvm::Value *BoolCondVal = EvaluateExprAsBool(S.getCond());
1193
1194 BreakContinueStack.pop_back();
1195
1196 // "do {} while (0)" is common in macros, avoid extra blocks. Be sure
1197 // to correctly handle break/continue though.
1198 llvm::ConstantInt *C = dyn_cast<llvm::ConstantInt>(BoolCondVal);
1199 bool EmitBoolCondBranch = !C || !C->isZero();
1200
1201 const SourceRange &R = S.getSourceRange();
1202 LoopStack.push(
1203 LoopBody, CGM.getContext(), CGM.getCodeGenOpts(), DoAttrs,
1204 SourceLocToDebugLoc(R.getBegin()), SourceLocToDebugLoc(R.getEnd()),
1206
1207 auto *LoopFalse = (hasSkipCounter(&S) ? createBasicBlock("do.loopfalse")
1208 : LoopExit.getBlock());
1209
1210 // As long as the condition is true, iterate the loop.
1211 if (EmitBoolCondBranch) {
1212 uint64_t BackedgeCount = getProfileCount(S.getBody()) - ParentCount;
1213 auto *I = Builder.CreateCondBr(
1214 BoolCondVal, LoopBody, LoopFalse,
1215 createProfileWeightsForLoop(S.getCond(), BackedgeCount));
1216
1217 // Key Instructions: Emit the condition and branch as separate source
1218 // location atoms otherwise we may omit a step onto the loop condition in
1219 // favour of the closing brace.
1220 // FIXME: We could have the branch as the backup location for the condition,
1221 // which would probably be a better experience (no jumping to the brace).
1222 if (auto *CondI = dyn_cast<llvm::Instruction>(BoolCondVal))
1223 addInstToNewSourceAtom(CondI, nullptr);
1224 addInstToNewSourceAtom(I, nullptr);
1225 }
1226
1227 LoopStack.pop();
1228
1229 if (LoopFalse != LoopExit.getBlock()) {
1230 EmitBlock(LoopFalse);
1231 incrementProfileCounter(UseSkipPath, &S, /*UseBoth=*/true);
1232 }
1233
1234 // Emit the exit block.
1235 EmitBlock(LoopExit.getBlock());
1236
1237 // The DoCond block typically is just a branch if we skipped
1238 // emitting a branch, try to erase it.
1239 if (!EmitBoolCondBranch)
1241
1242 if (CGM.shouldEmitConvergenceTokens())
1243 ConvergenceTokenStack.pop_back();
1244}
1245
1247 ArrayRef<const Attr *> ForAttrs) {
1249
1250 std::optional<LexicalScope> ForScope;
1252 ForScope.emplace(*this, S.getSourceRange());
1253
1254 // Evaluate the first part before the loop.
1255 if (S.getInit())
1256 EmitStmt(S.getInit());
1257
1258 // Start the loop with a block that tests the condition.
1259 // If there's an increment, the continue scope will be overwritten
1260 // later.
1261 JumpDest CondDest = getJumpDestInCurrentScope("for.cond");
1262 llvm::BasicBlock *CondBlock = CondDest.getBlock();
1263 EmitBlock(CondBlock);
1264
1265 if (CGM.shouldEmitConvergenceTokens())
1266 ConvergenceTokenStack.push_back(emitConvergenceLoopToken(CondBlock));
1267
1268 const SourceRange &R = S.getSourceRange();
1269 LoopStack.push(
1270 CondBlock, CGM.getContext(), CGM.getCodeGenOpts(), ForAttrs,
1271 SourceLocToDebugLoc(R.getBegin()), SourceLocToDebugLoc(R.getEnd()),
1273
1274 // Create a cleanup scope for the condition variable cleanups.
1275 LexicalScope ConditionScope(*this, S.getSourceRange());
1276
1277 // If the for loop doesn't have an increment we can just use the condition as
1278 // the continue block. Otherwise, if there is no condition variable, we can
1279 // form the continue block now. If there is a condition variable, we can't
1280 // form the continue block until after we've emitted the condition, because
1281 // the condition is in scope in the increment, but Sema's jump diagnostics
1282 // ensure that there are no continues from the condition variable that jump
1283 // to the loop increment.
1284 JumpDest Continue;
1285 if (!S.getInc())
1286 Continue = CondDest;
1287 else if (!S.getConditionVariable())
1288 Continue = getJumpDestInCurrentScope("for.inc");
1289 BreakContinueStack.push_back(BreakContinue(S, LoopExit, Continue));
1290
1291 if (S.getCond()) {
1292 // If the for statement has a condition scope, emit the local variable
1293 // declaration.
1294 if (S.getConditionVariable()) {
1296
1297 // We have entered the condition variable's scope, so we're now able to
1298 // jump to the continue block.
1299 Continue = S.getInc() ? getJumpDestInCurrentScope("for.inc") : CondDest;
1300 BreakContinueStack.back().ContinueBlock = Continue;
1301 }
1302
1303 llvm::BasicBlock *ExitBlock = LoopExit.getBlock();
1304 // If there are any cleanups between here and the loop-exit scope,
1305 // create a block to stage a loop exit along.
1306 if (hasSkipCounter(&S) || (ForScope && ForScope->requiresCleanups()))
1307 ExitBlock = createBasicBlock("for.cond.cleanup");
1308
1309 // As long as the condition is true, iterate the loop.
1310 llvm::BasicBlock *ForBody = createBasicBlock("for.body");
1311
1312 // C99 6.8.5p2/p4: The first substatement is executed if the expression
1313 // compares unequal to 0. The condition must be a scalar type.
1314 llvm::Value *BoolCondVal = EvaluateExprAsBool(S.getCond());
1315
1317
1318 llvm::MDNode *Weights =
1319 createProfileWeightsForLoop(S.getCond(), getProfileCount(S.getBody()));
1320 if (!Weights && CGM.getCodeGenOpts().OptimizationLevel)
1321 BoolCondVal = emitCondLikelihoodViaExpectIntrinsic(
1322 BoolCondVal, Stmt::getLikelihood(S.getBody()));
1323
1324 auto *I = Builder.CreateCondBr(BoolCondVal, ForBody, ExitBlock, Weights);
1325 // Key Instructions: Emit the condition and branch as separate atoms to
1326 // match existing loop stepping behaviour. FIXME: We could have the branch
1327 // as the backup location for the condition, which would probably be a
1328 // better experience (no jumping to the brace).
1329 if (auto *CondI = dyn_cast<llvm::Instruction>(BoolCondVal))
1330 addInstToNewSourceAtom(CondI, nullptr);
1331 addInstToNewSourceAtom(I, nullptr);
1332
1333 if (ExitBlock != LoopExit.getBlock()) {
1334 EmitBlock(ExitBlock);
1337 }
1338
1339 EmitBlock(ForBody);
1340 } else {
1341 // Treat it as a non-zero constant. Don't even create a new block for the
1342 // body, just fall into it.
1343 PGO->markStmtAsUsed(true, &S);
1344 }
1345
1347
1348 {
1349 // Create a separate cleanup scope for the body, in case it is not
1350 // a compound statement.
1351 RunCleanupsScope BodyScope(*this);
1352 EmitStmt(S.getBody());
1353 }
1354
1355 // The last block in the loop's body (which unconditionally branches to the
1356 // `inc` block if there is one).
1357 auto *FinalBodyBB = Builder.GetInsertBlock();
1358
1359 // If there is an increment, emit it next.
1360 if (S.getInc()) {
1361 EmitBlock(Continue.getBlock());
1362 EmitStmt(S.getInc());
1363 }
1364
1365 BreakContinueStack.pop_back();
1366
1367 ConditionScope.ForceCleanup();
1368
1369 EmitStopPoint(&S);
1370 EmitBranch(CondBlock);
1371
1372 if (ForScope)
1373 ForScope->ForceCleanup();
1374
1375 LoopStack.pop();
1376
1377 // Emit the fall-through block.
1378 EmitBlock(LoopExit.getBlock(), true);
1379
1380 if (CGM.shouldEmitConvergenceTokens())
1381 ConvergenceTokenStack.pop_back();
1382
1383 if (FinalBodyBB) {
1384 // Key Instructions: We want the for closing brace to be step-able on to
1385 // match existing behaviour.
1386 addInstToNewSourceAtom(FinalBodyBB->getTerminator(), nullptr);
1387 }
1388}
1389
1390void
1392 ArrayRef<const Attr *> ForAttrs) {
1394
1395 LexicalScope ForScope(*this, S.getSourceRange());
1396
1397 // Evaluate the first pieces before the loop.
1398 if (S.getInit())
1399 EmitStmt(S.getInit());
1402 EmitStmt(S.getEndStmt());
1403
1404 // Start the loop with a block that tests the condition.
1405 // If there's an increment, the continue scope will be overwritten
1406 // later.
1407 llvm::BasicBlock *CondBlock = createBasicBlock("for.cond");
1408 EmitBlock(CondBlock);
1409
1410 if (CGM.shouldEmitConvergenceTokens())
1411 ConvergenceTokenStack.push_back(emitConvergenceLoopToken(CondBlock));
1412
1413 const SourceRange &R = S.getSourceRange();
1414 LoopStack.push(CondBlock, CGM.getContext(), CGM.getCodeGenOpts(), ForAttrs,
1415 SourceLocToDebugLoc(R.getBegin()),
1416 SourceLocToDebugLoc(R.getEnd()));
1417
1418 // If there are any cleanups between here and the loop-exit scope,
1419 // create a block to stage a loop exit along.
1420 llvm::BasicBlock *ExitBlock = LoopExit.getBlock();
1421 if (hasSkipCounter(&S) || ForScope.requiresCleanups())
1422 ExitBlock = createBasicBlock("for.cond.cleanup");
1423
1424 // The loop body, consisting of the specified body and the loop variable.
1425 llvm::BasicBlock *ForBody = createBasicBlock("for.body");
1426
1427 // The body is executed if the expression, contextually converted
1428 // to bool, is true.
1429 llvm::Value *BoolCondVal = EvaluateExprAsBool(S.getCond());
1430 llvm::MDNode *Weights =
1431 createProfileWeightsForLoop(S.getCond(), getProfileCount(S.getBody()));
1432 if (!Weights && CGM.getCodeGenOpts().OptimizationLevel)
1433 BoolCondVal = emitCondLikelihoodViaExpectIntrinsic(
1434 BoolCondVal, Stmt::getLikelihood(S.getBody()));
1435 auto *I = Builder.CreateCondBr(BoolCondVal, ForBody, ExitBlock, Weights);
1436 // Key Instructions: Emit the condition and branch as separate atoms to
1437 // match existing loop stepping behaviour. FIXME: We could have the branch as
1438 // the backup location for the condition, which would probably be a better
1439 // experience.
1440 if (auto *CondI = dyn_cast<llvm::Instruction>(BoolCondVal))
1441 addInstToNewSourceAtom(CondI, nullptr);
1442 addInstToNewSourceAtom(I, nullptr);
1443
1444 if (ExitBlock != LoopExit.getBlock()) {
1445 EmitBlock(ExitBlock);
1448 }
1449
1450 EmitBlock(ForBody);
1452
1453 // Create a block for the increment. In case of a 'continue', we jump there.
1454 JumpDest Continue = getJumpDestInCurrentScope("for.inc");
1455
1456 // Store the blocks to use for break and continue.
1457 BreakContinueStack.push_back(BreakContinue(S, LoopExit, Continue));
1458
1459 {
1460 // Create a separate cleanup scope for the loop variable and body.
1461 LexicalScope BodyScope(*this, S.getSourceRange());
1463 EmitStmt(S.getBody());
1464 }
1465 // The last block in the loop's body (which unconditionally branches to the
1466 // `inc` block if there is one).
1467 auto *FinalBodyBB = Builder.GetInsertBlock();
1468
1469 EmitStopPoint(&S);
1470 // If there is an increment, emit it next.
1471 EmitBlock(Continue.getBlock());
1472 EmitStmt(S.getInc());
1473
1474 BreakContinueStack.pop_back();
1475
1476 EmitBranch(CondBlock);
1477
1478 ForScope.ForceCleanup();
1479
1480 LoopStack.pop();
1481
1482 // Emit the fall-through block.
1483 EmitBlock(LoopExit.getBlock(), true);
1484
1485 if (CGM.shouldEmitConvergenceTokens())
1486 ConvergenceTokenStack.pop_back();
1487
1488 if (FinalBodyBB) {
1489 // We want the for closing brace to be step-able on to match existing
1490 // behaviour.
1491 addInstToNewSourceAtom(FinalBodyBB->getTerminator(), nullptr);
1492 }
1493}
1494
1497 LexicalScope Scope(*this, S.getSourceRange());
1498
1499 for (const Stmt *DS : S.getPreambleStmts())
1500 EmitStmt(DS);
1501
1502 if (S.getInstantiations().empty())
1503 return;
1504
1505 JumpDest ExpandExit = getJumpDestInCurrentScope("expand.end");
1506 JumpDest ContinueDest;
1507 for (auto [N, Inst] : enumerate(S.getInstantiations())) {
1508 if (N == S.getInstantiations().size() - 1)
1509 ContinueDest = ExpandExit;
1510 else
1511 ContinueDest = getJumpDestInCurrentScope("expand.next");
1512
1513 LexicalScope ExpansionScope(*this, Inst->getSourceRange());
1514 BreakContinueStack.push_back(BreakContinue(S, ExpandExit, ContinueDest));
1515 EmitStmt(Inst);
1516 BreakContinueStack.pop_back();
1517 EmitBlock(ContinueDest.getBlock(), true);
1518 }
1519}
1520
1521void CodeGenFunction::EmitReturnOfRValue(RValue RV, QualType Ty) {
1522 if (RV.isScalar()) {
1523 Builder.CreateStore(RV.getScalarVal(), ReturnValue);
1524 } else if (RV.isAggregate()) {
1525 LValue Dest = MakeAddrLValue(ReturnValue, Ty);
1528 } else {
1530 /*init*/ true);
1531 }
1533}
1534
1535namespace {
1536// RAII struct used to save and restore a return statment's result expression.
1537struct SaveRetExprRAII {
1538 SaveRetExprRAII(const Expr *RetExpr, CodeGenFunction &CGF)
1539 : OldRetExpr(CGF.RetExpr), CGF(CGF) {
1540 CGF.RetExpr = RetExpr;
1541 }
1542 ~SaveRetExprRAII() { CGF.RetExpr = OldRetExpr; }
1543 const Expr *OldRetExpr;
1544 CodeGenFunction &CGF;
1545};
1546} // namespace
1547
1548/// Determine if the given call uses the swiftasync calling convention.
1549static bool isSwiftAsyncCallee(const CallExpr *CE) {
1550 auto calleeQualType = CE->getCallee()->getType();
1551 const FunctionType *calleeType = nullptr;
1552 if (calleeQualType->isFunctionPointerType() ||
1553 calleeQualType->isFunctionReferenceType() ||
1554 calleeQualType->isBlockPointerType() ||
1555 calleeQualType->isMemberFunctionPointerType()) {
1556 calleeType = calleeQualType->getPointeeType()->castAs<FunctionType>();
1557 } else if (auto *ty = dyn_cast<FunctionType>(calleeQualType)) {
1558 calleeType = ty;
1559 } else if (auto CMCE = dyn_cast<CXXMemberCallExpr>(CE)) {
1560 if (auto methodDecl = CMCE->getMethodDecl()) {
1561 // getMethodDecl() doesn't handle member pointers at the moment.
1562 calleeType = methodDecl->getType()->castAs<FunctionType>();
1563 } else {
1564 return false;
1565 }
1566 } else {
1567 return false;
1568 }
1569 return calleeType->getCallConv() == CallingConv::CC_SwiftAsync;
1570}
1571
1572/// EmitReturnStmt - Note that due to GCC extensions, this can have an operand
1573/// if the function returns void, or may be missing one if the function returns
1574/// non-void. Fun stuff :).
1577 if (requiresReturnValueCheck()) {
1578 llvm::Constant *SLoc = EmitCheckSourceLocation(S.getBeginLoc());
1579 auto *SLocPtr =
1580 new llvm::GlobalVariable(CGM.getModule(), SLoc->getType(), false,
1581 llvm::GlobalVariable::PrivateLinkage, SLoc);
1582 SLocPtr->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1583 CGM.getSanitizerMetadata()->disableSanitizerForGlobal(SLocPtr);
1584 assert(ReturnLocation.isValid() && "No valid return location");
1585 Builder.CreateStore(SLocPtr, ReturnLocation);
1586 }
1587
1588 // Returning from an outlined SEH helper is UB, and we already warn on it.
1589 if (IsOutlinedSEHHelper) {
1590 Builder.CreateUnreachable();
1591 Builder.ClearInsertionPoint();
1592 }
1593
1594 // Emit the result value, even if unused, to evaluate the side effects.
1595 const Expr *RV = S.getRetValue();
1596
1597 // Record the result expression of the return statement. The recorded
1598 // expression is used to determine whether a block capture's lifetime should
1599 // end at the end of the full expression as opposed to the end of the scope
1600 // enclosing the block expression.
1601 //
1602 // This permits a small, easily-implemented exception to our over-conservative
1603 // rules about not jumping to statements following block literals with
1604 // non-trivial cleanups.
1605 SaveRetExprRAII SaveRetExpr(RV, *this);
1606
1607 RunCleanupsScope cleanupScope(*this);
1608 if (const auto *EWC = dyn_cast_or_null<ExprWithCleanups>(RV))
1609 RV = EWC->getSubExpr();
1610
1611 // If we're in a swiftasynccall function, and the return expression is a
1612 // call to a swiftasynccall function, mark the call as the musttail call.
1613 std::optional<llvm::SaveAndRestore<const CallExpr *>> SaveMustTail;
1614 if (RV && CurFnInfo &&
1615 CurFnInfo->getASTCallingConvention() == CallingConv::CC_SwiftAsync) {
1616 if (auto CE = dyn_cast<CallExpr>(RV)) {
1617 if (isSwiftAsyncCallee(CE)) {
1618 SaveMustTail.emplace(MustTailCall, CE);
1619 }
1620 }
1621 }
1622
1623 // FIXME: Clean this up by using an LValue for ReturnTemp,
1624 // EmitStoreThroughLValue, and EmitAnyExpr.
1625 // Check if the NRVO candidate was not globalized in OpenMP mode.
1626 if (getLangOpts().ElideConstructors && S.getNRVOCandidate() &&
1628 (!getLangOpts().OpenMP ||
1629 !CGM.getOpenMPRuntime()
1630 .getAddressOfLocalVariable(*this, S.getNRVOCandidate())
1631 .isValid())) {
1632 // Apply the named return value optimization for this return statement,
1633 // which means doing nothing: the appropriate result has already been
1634 // constructed into the NRVO variable.
1635
1636 // If there is an NRVO flag for this variable, set it to 1 into indicate
1637 // that the cleanup code should not destroy the variable.
1638 if (llvm::Value *NRVOFlag = NRVOFlags[S.getNRVOCandidate()])
1639 Builder.CreateFlagStore(Builder.getTrue(), NRVOFlag);
1640 } else if (!ReturnValue.isValid() || (RV && RV->getType()->isVoidType())) {
1641 // Make sure not to return anything, but evaluate the expression
1642 // for side effects.
1643 if (RV) {
1644 EmitAnyExpr(RV);
1645 }
1646 } else if (!RV) {
1647 // Do nothing (return value is left uninitialized)
1648 } else if (FnRetTy->isReferenceType()) {
1649 // If this function returns a reference, take the address of the expression
1650 // rather than the value.
1652 auto *I = Builder.CreateStore(Result.getScalarVal(), ReturnValue);
1653 addInstToCurrentSourceAtom(I, I->getValueOperand());
1654 } else {
1655 switch (getEvaluationKind(RV->getType())) {
1656 case TEK_Scalar: {
1657 llvm::Value *Ret = EmitScalarExpr(RV);
1658 if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::Indirect) {
1660 /*isInit*/ true);
1661 } else {
1662 auto *I = Builder.CreateStore(Ret, ReturnValue);
1663 addInstToCurrentSourceAtom(I, I->getValueOperand());
1664 }
1665 break;
1666 }
1667 case TEK_Complex:
1669 /*isInit*/ true);
1670 break;
1671 case TEK_Aggregate:
1678 break;
1679 }
1680 }
1681
1682 ++NumReturnExprs;
1683 if (!RV || RV->isEvaluatable(getContext()))
1684 ++NumSimpleReturnExprs;
1685
1686 cleanupScope.ForceCleanup();
1688}
1689
1691 // As long as debug info is modeled with instructions, we have to ensure we
1692 // have a place to insert here and write the stop point here.
1693 if (HaveInsertPoint())
1694 EmitStopPoint(&S);
1695
1696 for (const auto *I : S.decls())
1697 EmitDecl(*I, /*EvaluateConditionDecl=*/true);
1698}
1699
1701 -> const BreakContinue * {
1702 if (!S.hasLabelTarget())
1703 return &BreakContinueStack.back();
1704
1705 const Stmt *LoopOrSwitch = S.getNamedLoopOrSwitch();
1706 assert(LoopOrSwitch && "break/continue target not set?");
1707 for (const BreakContinue &BC : llvm::reverse(BreakContinueStack))
1708 if (BC.LoopOrSwitch == LoopOrSwitch)
1709 return &BC;
1710
1711 llvm_unreachable("break/continue target not found");
1712}
1713
1715 assert(!BreakContinueStack.empty() && "break stmt not in a loop or switch!");
1716
1717 // If this code is reachable then emit a stop point (if generating
1718 // debug info). We have to do this ourselves because we are on the
1719 // "simple" statement path.
1720 if (HaveInsertPoint())
1721 EmitStopPoint(&S);
1722
1725}
1726
1728 assert(!BreakContinueStack.empty() && "continue stmt not in a loop!");
1729
1730 // If this code is reachable then emit a stop point (if generating
1731 // debug info). We have to do this ourselves because we are on the
1732 // "simple" statement path.
1733 if (HaveInsertPoint())
1734 EmitStopPoint(&S);
1735
1738}
1739
1740/// EmitCaseStmtRange - If case statement range is not too big then
1741/// add multiple cases to switch instruction, one for each value within
1742/// the range. If range is too big then emit "if" condition check.
1744 ArrayRef<const Attr *> Attrs) {
1745 assert(S.getRHS() && "Expected RHS value in CaseStmt");
1746
1747 llvm::APSInt LHS = S.getLHS()->EvaluateKnownConstInt(getContext());
1748 llvm::APSInt RHS = S.getRHS()->EvaluateKnownConstInt(getContext());
1749
1750 // Emit the code for this case. We do this first to make sure it is
1751 // properly chained from our predecessor before generating the
1752 // switch machinery to enter this block.
1753 llvm::BasicBlock *CaseDest = createBasicBlock("sw.bb");
1754 EmitBlockWithFallThrough(CaseDest, &S);
1755 EmitStmt(S.getSubStmt());
1756
1757 // If range is empty, do nothing.
1758 if (LHS.isSigned() ? RHS.slt(LHS) : RHS.ult(LHS))
1759 return;
1760
1762 llvm::APInt Range = RHS - LHS;
1763 // FIXME: parameters such as this should not be hardcoded.
1764 if (Range.getBitWidth() < 7 ||
1765 Range.ult(llvm::APInt(Range.getBitWidth(), 64))) {
1766 // Range is small enough to add multiple switch instruction cases.
1767 uint64_t Total = getProfileCount(&S);
1768 unsigned NCases = Range.getZExtValue() + 1;
1769 // We only have one region counter for the entire set of cases here, so we
1770 // need to divide the weights evenly between the generated cases, ensuring
1771 // that the total weight is preserved. E.g., a weight of 5 over three cases
1772 // will be distributed as weights of 2, 2, and 1.
1773 uint64_t Weight = Total / NCases, Rem = Total % NCases;
1774 for (unsigned I = 0; I != NCases; ++I) {
1775 if (SwitchWeights)
1776 SwitchWeights->push_back(Weight + (Rem ? 1 : 0));
1777 else if (SwitchLikelihood)
1778 SwitchLikelihood->push_back(LH);
1779
1780 if (Rem)
1781 Rem--;
1782 SwitchInsn->addCase(Builder.getInt(LHS), CaseDest);
1783 ++LHS;
1784 }
1785 return;
1786 }
1787
1788 // The range is too big. Emit "if" condition into a new block,
1789 // making sure to save and restore the current insertion point.
1790 llvm::BasicBlock *RestoreBB = Builder.GetInsertBlock();
1791
1792 // Push this test onto the chain of range checks (which terminates
1793 // in the default basic block). The switch's default will be changed
1794 // to the top of this chain after switch emission is complete.
1795 llvm::BasicBlock *FalseDest = CaseRangeBlock;
1796 CaseRangeBlock = createBasicBlock("sw.caserange");
1797
1798 CurFn->insert(CurFn->end(), CaseRangeBlock);
1799 Builder.SetInsertPoint(CaseRangeBlock);
1800
1801 // Emit range check.
1802 llvm::Value *Diff =
1803 Builder.CreateSub(SwitchInsn->getCondition(), Builder.getInt(LHS));
1804 llvm::Value *Cond =
1805 Builder.CreateICmpULE(Diff, Builder.getInt(Range), "inbounds");
1806
1807 llvm::MDNode *Weights = nullptr;
1808 if (SwitchWeights) {
1809 uint64_t ThisCount = getProfileCount(&S);
1810 uint64_t DefaultCount = (*SwitchWeights)[0];
1811 Weights = createProfileWeights(ThisCount, DefaultCount);
1812
1813 // Since we're chaining the switch default through each large case range, we
1814 // need to update the weight for the default, ie, the first case, to include
1815 // this case.
1816 (*SwitchWeights)[0] += ThisCount;
1817 } else if (SwitchLikelihood)
1818 Cond = emitCondLikelihoodViaExpectIntrinsic(Cond, LH);
1819
1820 Builder.CreateCondBr(Cond, CaseDest, FalseDest, Weights);
1821
1822 // Restore the appropriate insertion point.
1823 if (RestoreBB)
1824 Builder.SetInsertPoint(RestoreBB);
1825 else
1826 Builder.ClearInsertionPoint();
1827}
1828
1830 ArrayRef<const Attr *> Attrs) {
1831 // If there is no enclosing switch instance that we're aware of, then this
1832 // case statement and its block can be elided. This situation only happens
1833 // when we've constant-folded the switch, are emitting the constant case,
1834 // and part of the constant case includes another case statement. For
1835 // instance: switch (4) { case 4: do { case 5: } while (1); }
1836 if (!SwitchInsn) {
1837 EmitStmt(S.getSubStmt());
1838 return;
1839 }
1840
1841 // Handle case ranges.
1842 if (S.getRHS()) {
1843 EmitCaseStmtRange(S, Attrs);
1844 return;
1845 }
1846
1847 llvm::ConstantInt *CaseVal =
1849
1850 // Emit debuginfo for the case value if it is an enum value.
1851 const ConstantExpr *CE;
1852 if (auto ICE = dyn_cast<ImplicitCastExpr>(S.getLHS()))
1853 CE = dyn_cast<ConstantExpr>(ICE->getSubExpr());
1854 else
1855 CE = dyn_cast<ConstantExpr>(S.getLHS());
1856 if (CE) {
1857 if (auto DE = dyn_cast<DeclRefExpr>(CE->getSubExpr()))
1858 if (CGDebugInfo *Dbg = getDebugInfo())
1859 if (CGM.getCodeGenOpts().hasReducedDebugInfo())
1860 Dbg->EmitGlobalVariable(DE->getDecl(),
1861 APValue(llvm::APSInt(CaseVal->getValue())));
1862 }
1863
1864 if (SwitchLikelihood)
1865 SwitchLikelihood->push_back(Stmt::getLikelihood(Attrs));
1866
1867 // If the body of the case is just a 'break', try to not emit an empty block.
1868 // If we're profiling or we're not optimizing, leave the block in for better
1869 // debug and coverage analysis.
1870 if (!CGM.getCodeGenOpts().hasProfileClangInstr() &&
1871 CGM.getCodeGenOpts().OptimizationLevel > 0 &&
1873 JumpDest Block = BreakContinueStack.back().BreakBlock;
1874
1875 // Only do this optimization if there are no cleanups that need emitting.
1877 if (SwitchWeights)
1878 SwitchWeights->push_back(getProfileCount(&S));
1879 SwitchInsn->addCase(CaseVal, Block.getBlock());
1880
1881 // If there was a fallthrough into this case, make sure to redirect it to
1882 // the end of the switch as well.
1883 if (Builder.GetInsertBlock()) {
1884 Builder.CreateBr(Block.getBlock());
1885 Builder.ClearInsertionPoint();
1886 }
1887 return;
1888 }
1889 }
1890
1891 llvm::BasicBlock *CaseDest = createBasicBlock("sw.bb");
1892 EmitBlockWithFallThrough(CaseDest, &S);
1893 if (SwitchWeights)
1894 SwitchWeights->push_back(getProfileCount(&S));
1895 SwitchInsn->addCase(CaseVal, CaseDest);
1896
1897 // Recursively emitting the statement is acceptable, but is not wonderful for
1898 // code where we have many case statements nested together, i.e.:
1899 // case 1:
1900 // case 2:
1901 // case 3: etc.
1902 // Handling this recursively will create a new block for each case statement
1903 // that falls through to the next case which is IR intensive. It also causes
1904 // deep recursion which can run into stack depth limitations. Handle
1905 // sequential non-range case statements specially.
1906 //
1907 // TODO When the next case has a likelihood attribute the code returns to the
1908 // recursive algorithm. Maybe improve this case if it becomes common practice
1909 // to use a lot of attributes.
1910 const CaseStmt *CurCase = &S;
1911 const CaseStmt *NextCase = dyn_cast<CaseStmt>(S.getSubStmt());
1912
1913 // Otherwise, iteratively add consecutive cases to this switch stmt.
1914 while (NextCase && NextCase->getRHS() == nullptr) {
1915 CurCase = NextCase;
1916 llvm::ConstantInt *CaseVal =
1917 Builder.getInt(CurCase->getLHS()->EvaluateKnownConstInt(getContext()));
1918
1919 if (SwitchWeights)
1920 SwitchWeights->push_back(getProfileCount(NextCase));
1921 if (CGM.getCodeGenOpts().hasProfileClangInstr()) {
1922 CaseDest = createBasicBlock("sw.bb");
1923 EmitBlockWithFallThrough(CaseDest, CurCase);
1924 }
1925 // Since this loop is only executed when the CaseStmt has no attributes
1926 // use a hard-coded value.
1927 if (SwitchLikelihood)
1928 SwitchLikelihood->push_back(Stmt::LH_None);
1929
1930 SwitchInsn->addCase(CaseVal, CaseDest);
1931 NextCase = dyn_cast<CaseStmt>(CurCase->getSubStmt());
1932 }
1933
1934 // Generate a stop point for debug info if the case statement is
1935 // followed by a default statement. A fallthrough case before a
1936 // default case gets its own branch target.
1937 if (CurCase->getSubStmt()->getStmtClass() == Stmt::DefaultStmtClass)
1938 EmitStopPoint(CurCase);
1939
1940 // Normal default recursion for non-cases.
1941 EmitStmt(CurCase->getSubStmt());
1942}
1943
1945 ArrayRef<const Attr *> Attrs) {
1946 // If there is no enclosing switch instance that we're aware of, then this
1947 // default statement can be elided. This situation only happens when we've
1948 // constant-folded the switch.
1949 if (!SwitchInsn) {
1950 EmitStmt(S.getSubStmt());
1951 return;
1952 }
1953
1954 llvm::BasicBlock *DefaultBlock = SwitchInsn->getDefaultDest();
1955 assert(DefaultBlock->empty() &&
1956 "EmitDefaultStmt: Default block already defined?");
1957
1958 if (SwitchLikelihood)
1959 SwitchLikelihood->front() = Stmt::getLikelihood(Attrs);
1960
1961 EmitBlockWithFallThrough(DefaultBlock, &S);
1962
1963 EmitStmt(S.getSubStmt());
1964}
1965
1966namespace {
1967struct EmitDeferredStatement final : EHScopeStack::Cleanup {
1968 const DeferStmt &Stmt;
1969 EmitDeferredStatement(const DeferStmt *Stmt) : Stmt(*Stmt) {}
1970
1971 void Emit(CodeGenFunction &CGF, Flags) override {
1972 // Take care that any cleanups pushed by the body of a '_Defer' statement
1973 // don't clobber the current cleanup slot value.
1974 //
1975 // Assume we have a scope that pushes a cleanup; when that scope is exited,
1976 // we need to run that cleanup; this is accomplished by emitting the cleanup
1977 // into a separate block and then branching to that block at scope exit.
1978 //
1979 // Where this gets complicated is if we exit the scope in multiple different
1980 // ways; e.g. in a 'for' loop, we may exit the scope of its body by falling
1981 // off the end (in which case we need to run the cleanup and then branch to
1982 // the increment), or by 'break'ing out of the loop (in which case we need
1983 // to run the cleanup and then branch to the loop exit block); in both cases
1984 // we first branch to the cleanup block to run the cleanup, but the block we
1985 // need to jump to *after* running the cleanup is different.
1986 //
1987 // This is accomplished using a local integer variable called the 'cleanup
1988 // slot': before branching to the cleanup block, we store a value into that
1989 // slot. Then, in the cleanup block, after running the cleanup, we load the
1990 // value of that variable and 'switch' on it to branch to the appropriate
1991 // continuation block.
1992 //
1993 // The problem that arises once '_Defer' statements are involved is that the
1994 // body of a '_Defer' is an arbitrary statement which itself can create more
1995 // cleanups. This means we may end up overwriting the cleanup slot before we
1996 // ever have a chance to 'switch' on it, which means that once we *do* get
1997 // to the 'switch', we end up in whatever block the cleanup code happened to
1998 // pick as the default 'switch' exit label!
1999 //
2000 // That is, what is normally supposed to happen is something like:
2001 //
2002 // 1. Store 'X' to cleanup slot.
2003 // 2. Branch to cleanup block.
2004 // 3. Execute cleanup.
2005 // 4. Read value from cleanup slot.
2006 // 5. Branch to the block associated with 'X'.
2007 //
2008 // But if we encounter a _Defer' statement that contains a cleanup, then
2009 // what might instead happen is:
2010 //
2011 // 1. Store 'X' to cleanup slot.
2012 // 2. Branch to cleanup block.
2013 // 3. Execute cleanup; this ends up pushing another cleanup, so:
2014 // 3a. Store 'Y' to cleanup slot.
2015 // 3b. Run steps 2–5 recursively.
2016 // 4. Read value from cleanup slot, which is now 'Y' instead of 'X'.
2017 // 5. Branch to the block associated with 'Y'... which doesn't even
2018 // exist because the value 'Y' is only meaningful for the inner
2019 // cleanup. The result is we just branch 'somewhere random'.
2020 //
2021 // The rest of the cleanup code simply isn't prepared to handle this case
2022 // because most other cleanups can't push more cleanups, and thus, emitting
2023 // other cleanups generally cannot clobber the cleanup slot.
2024 //
2025 // To prevent this from happening, save the current cleanup slot value and
2026 // restore it after emitting the '_Defer' statement.
2027 llvm::Value *SavedCleanupDest = nullptr;
2028 if (CGF.NormalCleanupDest.isValid())
2029 SavedCleanupDest =
2030 CGF.Builder.CreateLoad(CGF.NormalCleanupDest, "cleanup.dest.saved");
2031
2032 CGF.EmitStmt(Stmt.getBody());
2033
2034 if (SavedCleanupDest && CGF.HaveInsertPoint())
2035 CGF.Builder.CreateStore(SavedCleanupDest, CGF.NormalCleanupDest);
2036
2037 // Cleanups must end with an insert point.
2038 CGF.EnsureInsertPoint();
2039 }
2040};
2041} // namespace
2042
2044 EHStack.pushCleanup<EmitDeferredStatement>(NormalAndEHCleanup, &S);
2045}
2046
2047/// CollectStatementsForCase - Given the body of a 'switch' statement and a
2048/// constant value that is being switched on, see if we can dead code eliminate
2049/// the body of the switch to a simple series of statements to emit. Basically,
2050/// on a switch (5) we want to find these statements:
2051/// case 5:
2052/// printf(...); <--
2053/// ++i; <--
2054/// break;
2055///
2056/// and add them to the ResultStmts vector. If it is unsafe to do this
2057/// transformation (for example, one of the elided statements contains a label
2058/// that might be jumped to), return CSFC_Failure. If we handled it and 'S'
2059/// should include statements after it (e.g. the printf() line is a substmt of
2060/// the case) then return CSFC_FallThrough. If we handled it and found a break
2061/// statement, then return CSFC_Success.
2062///
2063/// If Case is non-null, then we are looking for the specified case, checking
2064/// that nothing we jump over contains labels. If Case is null, then we found
2065/// the case and are looking for the break.
2066///
2067/// If the recursive walk actually finds our Case, then we set FoundCase to
2068/// true.
2069///
2072 const SwitchCase *Case,
2073 bool &FoundCase,
2074 SmallVectorImpl<const Stmt*> &ResultStmts) {
2075 // If this is a null statement, just succeed.
2076 if (!S)
2077 return Case ? CSFC_Success : CSFC_FallThrough;
2078
2079 // If this is the switchcase (case 4: or default) that we're looking for, then
2080 // we're in business. Just add the substatement.
2081 if (const SwitchCase *SC = dyn_cast<SwitchCase>(S)) {
2082 if (S == Case) {
2083 FoundCase = true;
2084 return CollectStatementsForCase(SC->getSubStmt(), nullptr, FoundCase,
2085 ResultStmts);
2086 }
2087
2088 // Otherwise, this is some other case or default statement, just ignore it.
2089 return CollectStatementsForCase(SC->getSubStmt(), Case, FoundCase,
2090 ResultStmts);
2091 }
2092
2093 // If we are in the live part of the code and we found our break statement,
2094 // return a success!
2095 if (!Case && isa<BreakStmt>(S))
2096 return CSFC_Success;
2097
2098 // If this is a switch statement, then it might contain the SwitchCase, the
2099 // break, or neither.
2100 if (const CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
2101 // Handle this as two cases: we might be looking for the SwitchCase (if so
2102 // the skipped statements must be skippable) or we might already have it.
2103 CompoundStmt::const_body_iterator I = CS->body_begin(), E = CS->body_end();
2104 bool StartedInLiveCode = FoundCase;
2105 unsigned StartSize = ResultStmts.size();
2106
2107 // If we've not found the case yet, scan through looking for it.
2108 if (Case) {
2109 // Keep track of whether we see a skipped declaration. The code could be
2110 // using the declaration even if it is skipped, so we can't optimize out
2111 // the decl if the kept statements might refer to it.
2112 bool HadSkippedDecl = false;
2113
2114 // If we're looking for the case, just see if we can skip each of the
2115 // substatements.
2116 for (; Case && I != E; ++I) {
2117 HadSkippedDecl |= CodeGenFunction::mightAddDeclToScope(*I);
2118
2119 switch (CollectStatementsForCase(*I, Case, FoundCase, ResultStmts)) {
2120 case CSFC_Failure: return CSFC_Failure;
2121 case CSFC_Success:
2122 // A successful result means that either 1) that the statement doesn't
2123 // have the case and is skippable, or 2) does contain the case value
2124 // and also contains the break to exit the switch. In the later case,
2125 // we just verify the rest of the statements are elidable.
2126 if (FoundCase) {
2127 // If we found the case and skipped declarations, we can't do the
2128 // optimization.
2129 if (HadSkippedDecl)
2130 return CSFC_Failure;
2131
2132 for (++I; I != E; ++I)
2133 if (CodeGenFunction::ContainsLabel(*I, true))
2134 return CSFC_Failure;
2135 return CSFC_Success;
2136 }
2137 break;
2138 case CSFC_FallThrough:
2139 // If we have a fallthrough condition, then we must have found the
2140 // case started to include statements. Consider the rest of the
2141 // statements in the compound statement as candidates for inclusion.
2142 assert(FoundCase && "Didn't find case but returned fallthrough?");
2143 // We recursively found Case, so we're not looking for it anymore.
2144 Case = nullptr;
2145
2146 // If we found the case and skipped declarations, we can't do the
2147 // optimization.
2148 if (HadSkippedDecl)
2149 return CSFC_Failure;
2150 break;
2151 }
2152 }
2153
2154 if (!FoundCase)
2155 return CSFC_Success;
2156
2157 assert(!HadSkippedDecl && "fallthrough after skipping decl");
2158 }
2159
2160 // If we have statements in our range, then we know that the statements are
2161 // live and need to be added to the set of statements we're tracking.
2162 bool AnyDecls = false;
2163 for (; I != E; ++I) {
2165
2166 switch (CollectStatementsForCase(*I, nullptr, FoundCase, ResultStmts)) {
2167 case CSFC_Failure: return CSFC_Failure;
2168 case CSFC_FallThrough:
2169 // A fallthrough result means that the statement was simple and just
2170 // included in ResultStmt, keep adding them afterwards.
2171 break;
2172 case CSFC_Success:
2173 // A successful result means that we found the break statement and
2174 // stopped statement inclusion. We just ensure that any leftover stmts
2175 // are skippable and return success ourselves.
2176 for (++I; I != E; ++I)
2177 if (CodeGenFunction::ContainsLabel(*I, true))
2178 return CSFC_Failure;
2179 return CSFC_Success;
2180 }
2181 }
2182
2183 // If we're about to fall out of a scope without hitting a 'break;', we
2184 // can't perform the optimization if there were any decls in that scope
2185 // (we'd lose their end-of-lifetime).
2186 if (AnyDecls) {
2187 // If the entire compound statement was live, there's one more thing we
2188 // can try before giving up: emit the whole thing as a single statement.
2189 // We can do that unless the statement contains a 'break;'.
2190 // FIXME: Such a break must be at the end of a construct within this one.
2191 // We could emit this by just ignoring the BreakStmts entirely.
2192 if (StartedInLiveCode && !CodeGenFunction::containsBreak(S)) {
2193 ResultStmts.resize(StartSize);
2194 ResultStmts.push_back(S);
2195 } else {
2196 return CSFC_Failure;
2197 }
2198 }
2199
2200 return CSFC_FallThrough;
2201 }
2202
2203 // Okay, this is some other statement that we don't handle explicitly, like a
2204 // for statement or increment etc. If we are skipping over this statement,
2205 // just verify it doesn't have labels, which would make it invalid to elide.
2206 if (Case) {
2207 if (CodeGenFunction::ContainsLabel(S, true))
2208 return CSFC_Failure;
2209 return CSFC_Success;
2210 }
2211
2212 // Otherwise, we want to include this statement. Everything is cool with that
2213 // so long as it doesn't contain a break out of the switch we're in.
2215
2216 // Otherwise, everything is great. Include the statement and tell the caller
2217 // that we fall through and include the next statement as well.
2218 ResultStmts.push_back(S);
2219 return CSFC_FallThrough;
2220}
2221
2222/// FindCaseStatementsForValue - Find the case statement being jumped to and
2223/// then invoke CollectStatementsForCase to find the list of statements to emit
2224/// for a switch on constant. See the comment above CollectStatementsForCase
2225/// for more details.
2227 const llvm::APSInt &ConstantCondValue,
2228 SmallVectorImpl<const Stmt*> &ResultStmts,
2229 ASTContext &C,
2230 const SwitchCase *&ResultCase) {
2231 // First step, find the switch case that is being branched to. We can do this
2232 // efficiently by scanning the SwitchCase list.
2233 const SwitchCase *Case = S.getSwitchCaseList();
2234 const DefaultStmt *DefaultCase = nullptr;
2235
2236 for (; Case; Case = Case->getNextSwitchCase()) {
2237 // It's either a default or case. Just remember the default statement in
2238 // case we're not jumping to any numbered cases.
2239 if (const DefaultStmt *DS = dyn_cast<DefaultStmt>(Case)) {
2240 DefaultCase = DS;
2241 continue;
2242 }
2243
2244 // Check to see if this case is the one we're looking for.
2245 const CaseStmt *CS = cast<CaseStmt>(Case);
2246 // Don't handle case ranges yet.
2247 if (CS->getRHS()) return false;
2248
2249 // If we found our case, remember it as 'case'.
2250 if (CS->getLHS()->EvaluateKnownConstInt(C) == ConstantCondValue)
2251 break;
2252 }
2253
2254 // If we didn't find a matching case, we use a default if it exists, or we
2255 // elide the whole switch body!
2256 if (!Case) {
2257 // It is safe to elide the body of the switch if it doesn't contain labels
2258 // etc. If it is safe, return successfully with an empty ResultStmts list.
2259 if (!DefaultCase)
2261 Case = DefaultCase;
2262 }
2263
2264 // Ok, we know which case is being jumped to, try to collect all the
2265 // statements that follow it. This can fail for a variety of reasons. Also,
2266 // check to see that the recursive walk actually found our case statement.
2267 // Insane cases like this can fail to find it in the recursive walk since we
2268 // don't handle every stmt kind:
2269 // switch (4) {
2270 // while (1) {
2271 // case 4: ...
2272 bool FoundCase = false;
2273 ResultCase = Case;
2274 return CollectStatementsForCase(S.getBody(), Case, FoundCase,
2275 ResultStmts) != CSFC_Failure &&
2276 FoundCase;
2277}
2278
2279static std::optional<SmallVector<uint64_t, 16>>
2281 // Are there enough branches to weight them?
2282 if (Likelihoods.size() <= 1)
2283 return std::nullopt;
2284
2285 uint64_t NumUnlikely = 0;
2286 uint64_t NumNone = 0;
2287 uint64_t NumLikely = 0;
2288 for (const auto LH : Likelihoods) {
2289 switch (LH) {
2290 case Stmt::LH_Unlikely:
2291 ++NumUnlikely;
2292 break;
2293 case Stmt::LH_None:
2294 ++NumNone;
2295 break;
2296 case Stmt::LH_Likely:
2297 ++NumLikely;
2298 break;
2299 }
2300 }
2301
2302 // Is there a likelihood attribute used?
2303 if (NumUnlikely == 0 && NumLikely == 0)
2304 return std::nullopt;
2305
2306 // When multiple cases share the same code they can be combined during
2307 // optimization. In that case the weights of the branch will be the sum of
2308 // the individual weights. Make sure the combined sum of all neutral cases
2309 // doesn't exceed the value of a single likely attribute.
2310 // The additions both avoid divisions by 0 and make sure the weights of None
2311 // don't exceed the weight of Likely.
2312 const uint64_t Likely = INT32_MAX / (NumLikely + 2);
2313 const uint64_t None = Likely / (NumNone + 1);
2314 const uint64_t Unlikely = 0;
2315
2317 Result.reserve(Likelihoods.size());
2318 for (const auto LH : Likelihoods) {
2319 switch (LH) {
2320 case Stmt::LH_Unlikely:
2321 Result.push_back(Unlikely);
2322 break;
2323 case Stmt::LH_None:
2324 Result.push_back(None);
2325 break;
2326 case Stmt::LH_Likely:
2327 Result.push_back(Likely);
2328 break;
2329 }
2330 }
2331
2332 return Result;
2333}
2334
2336 // Handle nested switch statements.
2337 llvm::SwitchInst *SavedSwitchInsn = SwitchInsn;
2338 SmallVector<uint64_t, 16> *SavedSwitchWeights = SwitchWeights;
2339 SmallVector<Stmt::Likelihood, 16> *SavedSwitchLikelihood = SwitchLikelihood;
2340 llvm::BasicBlock *SavedCRBlock = CaseRangeBlock;
2341
2342 // See if we can constant fold the condition of the switch and therefore only
2343 // emit the live case statement (if any) of the switch.
2344 llvm::APSInt ConstantCondValue;
2345 if (ConstantFoldsToSimpleInteger(S.getCond(), ConstantCondValue)) {
2347 const SwitchCase *Case = nullptr;
2348 if (FindCaseStatementsForValue(S, ConstantCondValue, CaseStmts,
2349 getContext(), Case)) {
2350 if (Case)
2352 RunCleanupsScope ExecutedScope(*this);
2353
2354 if (S.getInit())
2355 EmitStmt(S.getInit());
2356
2357 // Emit the condition variable if needed inside the entire cleanup scope
2358 // used by this special case for constant folded switches.
2359 if (S.getConditionVariable())
2360 EmitDecl(*S.getConditionVariable(), /*EvaluateConditionDecl=*/true);
2361
2362 // At this point, we are no longer "within" a switch instance, so
2363 // we can temporarily enforce this to ensure that any embedded case
2364 // statements are not emitted.
2365 SwitchInsn = nullptr;
2366
2367 // Okay, we can dead code eliminate everything except this case. Emit the
2368 // specified series of statements and we're good.
2369 for (const Stmt *CaseStmt : CaseStmts)
2372 PGO->markStmtMaybeUsed(S.getBody());
2373
2374 // Now we want to restore the saved switch instance so that nested
2375 // switches continue to function properly
2376 SwitchInsn = SavedSwitchInsn;
2377
2378 return;
2379 }
2380 }
2381
2382 JumpDest SwitchExit = getJumpDestInCurrentScope("sw.epilog");
2383
2384 RunCleanupsScope ConditionScope(*this);
2385
2386 if (S.getInit()) {
2387 EmitStmt(S.getInit());
2388
2389 // The init statement may have cleared the insertion point (e.g. it ended in
2390 // a 'noreturn' call); the condition emitted below needs a valid one.
2392 }
2393
2394 if (S.getConditionVariable())
2396 llvm::Value *CondV = EmitScalarExpr(S.getCond());
2398
2399 // Create basic block to hold stuff that comes after switch
2400 // statement. We also need to create a default block now so that
2401 // explicit case ranges tests can have a place to jump to on
2402 // failure.
2403 llvm::BasicBlock *DefaultBlock = createBasicBlock("sw.default");
2404
2405 // The dispatch is the jump that bypasses any declarations sitting between the
2406 // switch and its case labels, so the initialization goes here, ahead of the
2407 // switch instruction -- not at the case labels. A case label is also reached
2408 // by falling through from the case above it, and that edge bypasses nothing;
2409 // initializing there would clobber a variable the previous case had written.
2410 // The declarations are inside the body and so have no alloca yet, hence the
2411 // patch-it-in-later handling in EmitAutoVarAlloca.
2412 if (!Bypasses.isAlwaysBypassed())
2413 BypassingForwardJumps.push_back({Builder.GetInsertBlock(), &S});
2414
2415 SwitchInsn = Builder.CreateSwitch(CondV, DefaultBlock);
2416 addInstToNewSourceAtom(SwitchInsn, CondV);
2417
2418 if (HLSLControlFlowAttr != HLSLControlFlowHintAttr::SpellingNotCalculated) {
2419 llvm::MDBuilder MDHelper(CGM.getLLVMContext());
2420 llvm::ConstantInt *BranchHintConstant =
2422 HLSLControlFlowHintAttr::Spelling::Microsoft_branch
2423 ? llvm::ConstantInt::get(CGM.Int32Ty, 1)
2424 : llvm::ConstantInt::get(CGM.Int32Ty, 2);
2425 llvm::Metadata *Vals[] = {MDHelper.createString("hlsl.controlflow.hint"),
2426 MDHelper.createConstant(BranchHintConstant)};
2427 SwitchInsn->setMetadata("hlsl.controlflow.hint",
2428 llvm::MDNode::get(CGM.getLLVMContext(), Vals));
2429 }
2430
2431 if (PGO->haveRegionCounts()) {
2432 // Walk the SwitchCase list to find how many there are.
2433 uint64_t DefaultCount = 0;
2434 unsigned NumCases = 0;
2435 for (const SwitchCase *Case = S.getSwitchCaseList();
2436 Case;
2437 Case = Case->getNextSwitchCase()) {
2438 if (isa<DefaultStmt>(Case))
2439 DefaultCount = getProfileCount(Case);
2440 NumCases += 1;
2441 }
2442 SwitchWeights = new SmallVector<uint64_t, 16>();
2443 SwitchWeights->reserve(NumCases);
2444 // The default needs to be first. We store the edge count, so we already
2445 // know the right weight.
2446 SwitchWeights->push_back(DefaultCount);
2447 } else if (CGM.getCodeGenOpts().OptimizationLevel) {
2448 SwitchLikelihood = new SmallVector<Stmt::Likelihood, 16>();
2449 // Initialize the default case.
2450 SwitchLikelihood->push_back(Stmt::LH_None);
2451 }
2452
2453 CaseRangeBlock = DefaultBlock;
2454
2455 // Clear the insertion point to indicate we are in unreachable code.
2456 Builder.ClearInsertionPoint();
2457
2458 // All break statements jump to NextBlock. If BreakContinueStack is non-empty
2459 // then reuse last ContinueBlock.
2460 JumpDest OuterContinue;
2461 if (!BreakContinueStack.empty())
2462 OuterContinue = BreakContinueStack.back().ContinueBlock;
2463
2464 BreakContinueStack.push_back(BreakContinue(S, SwitchExit, OuterContinue));
2465
2466 // Emit switch body.
2467 EmitStmt(S.getBody());
2468
2469 BreakContinueStack.pop_back();
2470
2471 // Update the default block in case explicit case range tests have
2472 // been chained on top.
2473 SwitchInsn->setDefaultDest(CaseRangeBlock);
2474
2475 // If a default was never emitted:
2476 if (!DefaultBlock->getParent()) {
2477 // If we have cleanups, emit the default block so that there's a
2478 // place to jump through the cleanups from.
2479 if (ConditionScope.requiresCleanups()) {
2480 EmitBlock(DefaultBlock);
2481
2482 // Otherwise, just forward the default block to the switch end.
2483 } else {
2484 DefaultBlock->replaceAllUsesWith(SwitchExit.getBlock());
2485 delete DefaultBlock;
2486 }
2487 }
2488
2489 ConditionScope.ForceCleanup();
2490
2491 // Close the last case (or DefaultBlock).
2492 EmitBranch(SwitchExit.getBlock());
2493
2494 // Insert a False Counter if SwitchStmt doesn't have DefaultStmt.
2495 if (hasSkipCounter(S.getCond())) {
2496 auto *ImplicitDefaultBlock = createBasicBlock("sw.false");
2497 EmitBlock(ImplicitDefaultBlock);
2499 Builder.CreateBr(SwitchInsn->getDefaultDest());
2500 SwitchInsn->setDefaultDest(ImplicitDefaultBlock);
2501 }
2502
2503 // Emit continuation.
2504 EmitBlock(SwitchExit.getBlock(), true);
2506
2507 // If the switch has a condition wrapped by __builtin_unpredictable,
2508 // create metadata that specifies that the switch is unpredictable.
2509 // Don't bother if not optimizing because that metadata would not be used.
2510 auto *Call = dyn_cast<CallExpr>(S.getCond());
2511 if (Call && CGM.getCodeGenOpts().OptimizationLevel != 0) {
2512 auto *FD = dyn_cast_or_null<FunctionDecl>(Call->getCalleeDecl());
2513 if (FD && FD->getBuiltinID() == Builtin::BI__builtin_unpredictable) {
2514 llvm::MDBuilder MDHelper(getLLVMContext());
2515 SwitchInsn->setMetadata(llvm::LLVMContext::MD_unpredictable,
2516 MDHelper.createUnpredictable());
2517 }
2518 }
2519
2520 if (SwitchWeights) {
2521 assert(SwitchWeights->size() == 1 + SwitchInsn->getNumCases() &&
2522 "switch weights do not match switch cases");
2523 // If there's only one jump destination there's no sense weighting it.
2524 if (SwitchWeights->size() > 1)
2525 SwitchInsn->setMetadata(llvm::LLVMContext::MD_prof,
2526 createProfileWeights(*SwitchWeights));
2527 delete SwitchWeights;
2528 } else if (SwitchLikelihood) {
2529 assert(SwitchLikelihood->size() == 1 + SwitchInsn->getNumCases() &&
2530 "switch likelihoods do not match switch cases");
2531 std::optional<SmallVector<uint64_t, 16>> LHW =
2532 getLikelihoodWeights(*SwitchLikelihood);
2533 if (LHW) {
2534 llvm::MDBuilder MDHelper(CGM.getLLVMContext());
2535 SwitchInsn->setMetadata(llvm::LLVMContext::MD_prof,
2536 createProfileWeights(*LHW));
2537 }
2538 delete SwitchLikelihood;
2539 }
2540 SwitchInsn = SavedSwitchInsn;
2541 SwitchWeights = SavedSwitchWeights;
2542 SwitchLikelihood = SavedSwitchLikelihood;
2543 CaseRangeBlock = SavedCRBlock;
2544}
2545
2546std::pair<llvm::Value*, llvm::Type *> CodeGenFunction::EmitAsmInputLValue(
2547 const TargetInfo::ConstraintInfo &Info, LValue InputValue,
2548 QualType InputType, std::string &ConstraintStr, SourceLocation Loc) {
2549 if (Info.allowsRegister() || !Info.allowsMemory()) {
2551 return {EmitLoadOfLValue(InputValue, Loc).getScalarVal(), nullptr};
2552
2553 llvm::Type *Ty = ConvertType(InputType);
2554 uint64_t Size = CGM.getDataLayout().getTypeSizeInBits(Ty);
2555 if ((Size <= 64 && llvm::isPowerOf2_64(Size)) ||
2556 getTargetHooks().isScalarizableAsmOperand(*this, Ty)) {
2557 Ty = llvm::IntegerType::get(getLLVMContext(), Size);
2558
2559 return {Builder.CreateLoad(InputValue.getAddress().withElementType(Ty)),
2560 nullptr};
2561 }
2562 }
2563
2564 Address Addr = InputValue.getAddress();
2565 ConstraintStr += '*';
2566 return {InputValue.getPointer(*this), Addr.getElementType()};
2567}
2568std::pair<llvm::Value *, llvm::Type *>
2569CodeGenFunction::EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
2570 const Expr *InputExpr,
2571 std::string &ConstraintStr) {
2572 // If this can't be a register or memory, i.e., has to be a constant
2573 // (immediate or symbolic), try to emit it as such.
2574 if (!Info.allowsRegister() && !Info.allowsMemory()) {
2575 if (Info.requiresImmediateConstant()) {
2576 Expr::EvalResult EVResult;
2577 InputExpr->EvaluateAsRValue(EVResult, getContext(), true);
2578
2579 llvm::APSInt IntResult;
2580 if (EVResult.Val.toIntegralConstant(IntResult, InputExpr->getType(),
2581 getContext()))
2582 return {llvm::ConstantInt::get(getLLVMContext(), IntResult), nullptr};
2583 }
2584
2585 Expr::EvalResult Result;
2586 if (InputExpr->EvaluateAsInt(Result, getContext()))
2587 return {llvm::ConstantInt::get(getLLVMContext(), Result.Val.getInt()),
2588 nullptr};
2589 }
2590
2591 if (Info.allowsRegister() || !Info.allowsMemory())
2593 return {EmitScalarExpr(InputExpr), nullptr};
2594 if (InputExpr->getStmtClass() == Expr::CXXThisExprClass)
2595 return {EmitScalarExpr(InputExpr), nullptr};
2596 InputExpr = InputExpr->IgnoreParenNoopCasts(getContext());
2597 LValue Dest = EmitLValue(InputExpr);
2598 return EmitAsmInputLValue(Info, Dest, InputExpr->getType(), ConstraintStr,
2599 InputExpr->getExprLoc());
2600}
2601
2602/// getAsmSrcLocInfo - Return the !srcloc metadata node to attach to an inline
2603/// asm call instruction. The !srcloc MDNode contains a list of constant
2604/// integers which are the source locations of the start of each line in the
2605/// asm.
2606static llvm::MDNode *getAsmSrcLocInfo(const StringLiteral *Str,
2607 CodeGenFunction &CGF) {
2609 // Add the location of the first line to the MDNode.
2610 Locs.push_back(llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
2611 CGF.Int64Ty, Str->getBeginLoc().getRawEncoding())));
2612 StringRef StrVal = Str->getString();
2613 if (!StrVal.empty()) {
2614 const SourceManager &SM = CGF.CGM.getContext().getSourceManager();
2615 const LangOptions &LangOpts = CGF.CGM.getLangOpts();
2616 unsigned StartToken = 0;
2617 unsigned ByteOffset = 0;
2618
2619 // Add the location of the start of each subsequent line of the asm to the
2620 // MDNode.
2621 for (unsigned i = 0, e = StrVal.size() - 1; i != e; ++i) {
2622 if (StrVal[i] != '\n') continue;
2623 SourceLocation LineLoc = Str->getLocationOfByte(
2624 i + 1, SM, LangOpts, CGF.getTarget(), &StartToken, &ByteOffset);
2625 Locs.push_back(llvm::ConstantAsMetadata::get(
2626 llvm::ConstantInt::get(CGF.Int64Ty, LineLoc.getRawEncoding())));
2627 }
2628 }
2629
2630 return llvm::MDNode::get(CGF.getLLVMContext(), Locs);
2631}
2632
2633namespace clang {
2634
2635/// This structure holds the information gathered about the constraints for an
2636/// inline assembly statement. It helps in separating the constraint processing
2637/// from the code generation.
2639 CodeGenFunction &CGF;
2640 CodeGenModule &CGM; // Per-module state.
2641 const AsmStmt &S;
2642 CGBuilderTy &Builder;
2643
2644 // The final asm string.
2645 std::string AsmString;
2646
2647 // The output and input constraints.
2648 SmallVector<TargetInfo::ConstraintInfo, 4> OutputConstraintInfos;
2649 SmallVector<TargetInfo::ConstraintInfo, 4> InputConstraintInfos;
2650
2651 // Constraint strings.
2652 std::string Constraints;
2653 std::string InOutConstraints;
2654
2655 // Keep track of out constraints for tied input operand.
2656 std::vector<std::string> OutputConstraints;
2657
2658 // Keep track of argument types.
2659 std::vector<llvm::Value *> Args;
2660 std::vector<llvm::Type *> ArgTypes;
2661 std::vector<llvm::Type *> ArgElemTypes;
2662
2663 // Keep track of result register constraints.
2664 std::vector<LValue> ResultRegDests;
2665 std::vector<QualType> ResultRegQualTys;
2666 std::vector<llvm::Type *> ResultRegTypes;
2667 std::vector<llvm::Type *> ResultTruncRegTypes;
2668
2669 llvm::BitVector ResultTypeRequiresCast;
2670
2671 // Keep track of in/out constraints.
2672 std::vector<llvm::Value *> InOutArgs;
2673 std::vector<llvm::Type *> InOutArgTypes;
2674 std::vector<llvm::Type *> InOutArgElemTypes;
2675
2676 // Destination blocks for 'asm gotos'.
2677 llvm::BasicBlock *DefaultDest = nullptr;
2679
2680 std::vector<std::optional<std::pair<unsigned, unsigned>>> ResultBounds;
2681
2682 // An inline asm can be marked readonly if it meets the following
2683 // conditions:
2684 //
2685 // - it doesn't have any sideeffects
2686 // - it doesn't clobber memory
2687 // - it doesn't return a value by-reference
2688 //
2689 // It can be marked readnone if it doesn't have any input memory
2690 // constraints in addition to meeting the conditions listed above.
2691 bool ReadOnly = true;
2692 bool ReadNone = true;
2693
2694 bool GetOutputAndInputConstraints();
2695 void HandleOutputConstraints();
2696 void HandleMSStyleAsmBlob();
2697 void HandleInputConstraints();
2698 bool HandleLabels();
2699 bool HandleClobbers();
2700 void UpdateAsmCallInst(llvm::CallBase &Result, bool HasSideEffect,
2701 bool HasUnwindClobber, bool NoMerge, bool NoConvergent,
2702 std::vector<llvm::Value *> &RegResults);
2703 void EmitAsmStores(const llvm::ArrayRef<llvm::Value *> RegResults);
2704
2705 void EmitHipStdParUnsupportedAsm() {
2706 constexpr auto Name = "__ASM__hipstdpar_unsupported";
2707
2708 std::string Asm;
2709 if (auto GCCAsm = dyn_cast<GCCAsmStmt>(&S))
2710 Asm = GCCAsm->getAsmString();
2711
2712 auto &Ctx = getLLVMContext();
2713 auto StrTy = llvm::ConstantDataArray::getString(Ctx, Asm);
2714 auto FnTy = llvm::FunctionType::get(llvm::Type::getVoidTy(Ctx),
2715 {StrTy->getType()}, false);
2716 auto UBF = CGM.getModule().getOrInsertFunction(Name, FnTy);
2717
2718 Builder.CreateCall(UBF, {StrTy});
2719 }
2720
2721 ASTContext &getContext() { return CGF.getContext(); }
2722 llvm::LLVMContext &getLLVMContext() { return CGF.getLLVMContext(); }
2723 const TargetInfo &getTarget() const { return CGF.getTarget(); }
2724 const LangOptions &getLangOpts() const { return CGF.getLangOpts(); }
2725 const TargetCodeGenInfo &getTargetHooks() const {
2726 return CGM.getTargetCodeGenInfo();
2727 }
2728
2729public:
2731 : CGF(CGF), CGM(CGF.CGM), S(S), Builder(CGF.Builder),
2732 AsmString(S.generateAsmString(CGF.getContext())) {}
2733
2734 void EmitAsmStmt();
2735};
2736
2737} // namespace clang
2738
2740 // Pop all cleanup blocks at the end of the asm statement.
2741 CodeGenFunction::RunCleanupsScope Cleanups(*this);
2742
2743 // Get all the output and input constraints together.
2744 AsmConstraintsInfo AsmInfo(*this, S);
2745 AsmInfo.EmitAsmStmt();
2746}
2747
2749 if (!GetOutputAndInputConstraints())
2750 return EmitHipStdParUnsupportedAsm();
2751
2752 // Handle output constraints.
2753 HandleOutputConstraints();
2754
2755 // If this is a Microsoft-style asm blob, store the return registers (EAX:EDX)
2756 // to the return value slot. Only do this when returning in registers.
2757 HandleMSStyleAsmBlob();
2758
2759 // Handle input constraints.
2760 HandleInputConstraints();
2761
2762 // Handle 'asm goto' labels.
2763 bool IsGCCAsmGoto = HandleLabels();
2764
2765 // Handle any clobbers.
2766 bool HasUnwindClobber = HandleClobbers();
2767 assert(!(HasUnwindClobber && IsGCCAsmGoto) &&
2768 "unwind clobber can't be used with asm goto");
2769
2770 // Add machine specific clobbers
2771 std::string_view MachineClobbers = getTarget().getClobbers();
2772 if (!MachineClobbers.empty()) {
2773 if (!Constraints.empty())
2774 Constraints += ',';
2775 Constraints += MachineClobbers;
2776 }
2777
2778 llvm::Type *ResultType;
2779 if (ResultRegTypes.empty())
2780 ResultType = CGF.VoidTy;
2781 else if (ResultRegTypes.size() == 1)
2782 ResultType = ResultRegTypes[0];
2783 else
2784 ResultType = llvm::StructType::get(getLLVMContext(), ResultRegTypes);
2785
2786 llvm::FunctionType *FTy =
2787 llvm::FunctionType::get(ResultType, ArgTypes, false);
2788
2789 bool HasSideEffect = S.isVolatile() || S.getNumOutputs() == 0;
2790
2791 llvm::InlineAsm::AsmDialect GnuAsmDialect =
2792 CGM.getCodeGenOpts().getInlineAsmDialect() == CodeGenOptions::IAD_ATT
2793 ? llvm::InlineAsm::AD_ATT
2794 : llvm::InlineAsm::AD_Intel;
2795 llvm::InlineAsm::AsmDialect AsmDialect =
2796 isa<MSAsmStmt>(&S) ? llvm::InlineAsm::AD_Intel : GnuAsmDialect;
2797
2798 llvm::InlineAsm *IA = llvm::InlineAsm::get(
2799 FTy, AsmString, Constraints, HasSideEffect,
2800 /* IsAlignStack */ false, AsmDialect, HasUnwindClobber);
2801 std::vector<llvm::Value *> RegResults;
2802 llvm::CallBrInst *CBR;
2803 llvm::DenseMap<llvm::BasicBlock *, SmallVector<llvm::Value *, 4>>
2804 CBRRegResults;
2805
2806 if (IsGCCAsmGoto) {
2807 CBR = Builder.CreateCallBr(IA, DefaultDest, IndirectDests, Args);
2808 CGF.EmitBlock(DefaultDest);
2809 UpdateAsmCallInst(*CBR, HasSideEffect,
2810 /*HasUnwindClobber=*/false, CGF.InNoMergeAttributedStmt,
2811 CGF.InNoConvergentAttributedStmt, RegResults);
2812
2813 // Because we are emitting code top to bottom, we don't have enough
2814 // information at this point to know precisely whether we have a critical
2815 // edge. If we have outputs, split all indirect destinations.
2816 if (!RegResults.empty()) {
2817 unsigned I = 0;
2818 for (llvm::BasicBlock *Dest : CBR->getIndirectDests()) {
2819 llvm::Twine SynthName = Dest->getName() + ".split";
2820 llvm::BasicBlock *SynthBB = CGF.createBasicBlock(SynthName);
2821 llvm::IRBuilderBase::InsertPointGuard IPG(Builder);
2822 Builder.SetInsertPoint(SynthBB);
2823
2824 if (ResultRegTypes.size() == 1) {
2825 CBRRegResults[SynthBB].push_back(CBR);
2826 } else {
2827 for (unsigned J = 0, E = ResultRegTypes.size(); J != E; ++J) {
2828 llvm::Value *Tmp = Builder.CreateExtractValue(CBR, J, "asmresult");
2829 CBRRegResults[SynthBB].push_back(Tmp);
2830 }
2831 }
2832
2833 CGF.EmitBranch(Dest);
2834 CGF.EmitBlock(SynthBB);
2835 CBR->setIndirectDest(I++, SynthBB);
2836 }
2837 }
2838 } else if (HasUnwindClobber) {
2839 llvm::CallBase *Result = CGF.EmitCallOrInvoke(IA, Args, "");
2840 UpdateAsmCallInst(*Result, HasSideEffect,
2841 /*HasUnwindClobber=*/true, CGF.InNoMergeAttributedStmt,
2842 CGF.InNoConvergentAttributedStmt, RegResults);
2843 } else {
2844 llvm::CallInst *Result =
2845 Builder.CreateCall(IA, Args, CGF.getBundlesForFunclet(IA));
2846 UpdateAsmCallInst(*Result, HasSideEffect,
2847 /*HasUnwindClobber=*/false, CGF.InNoMergeAttributedStmt,
2848 CGF.InNoConvergentAttributedStmt, RegResults);
2849 }
2850
2851 EmitAsmStores(RegResults);
2852
2853 // If this is an asm goto with outputs, repeat EmitAsmStores, but with a
2854 // different insertion point; one for each indirect destination and with
2855 // CBRRegResults rather than RegResults.
2856 if (IsGCCAsmGoto && !CBRRegResults.empty()) {
2857 for (llvm::BasicBlock *Succ : CBR->getIndirectDests()) {
2858 llvm::IRBuilderBase::InsertPointGuard IPG(Builder);
2859 Builder.SetInsertPoint(--(Succ->end()));
2860 EmitAsmStores(CBRRegResults[Succ]);
2861 }
2862 }
2863}
2864
2865/// Gather and validate the output and input constraints for the given inline
2866/// assembly statement. This ensures that the constraints are valid for the
2867/// target and prepares them for further processing.
2868bool AsmConstraintsInfo::GetOutputAndInputConstraints() {
2869 bool IsValidTargetAsm = true;
2870 bool IsHipStdPar = getLangOpts().HIPStdPar && getLangOpts().CUDAIsDevice;
2871 for (unsigned I = 0, E = S.getNumOutputs(); I != E && IsValidTargetAsm; I++) {
2872 StringRef Name;
2873 if (const GCCAsmStmt *GAS = dyn_cast<GCCAsmStmt>(&S))
2874 Name = GAS->getOutputName(I);
2875
2876 TargetInfo::ConstraintInfo Info(S.getOutputConstraint(I), Name);
2877
2878 bool IsValid = getTarget().validateOutputConstraint(Info);
2879 if (IsHipStdPar && !IsValid)
2880 IsValidTargetAsm = false;
2881 else
2882 assert(IsValid && "Failed to parse output constraint");
2883
2884 OutputConstraintInfos.push_back(Info);
2885 }
2886
2887 for (unsigned I = 0, E = S.getNumInputs(); I != E && IsValidTargetAsm; I++) {
2888 StringRef Name;
2889 if (const GCCAsmStmt *GAS = dyn_cast<GCCAsmStmt>(&S))
2890 Name = GAS->getInputName(I);
2891
2892 TargetInfo::ConstraintInfo Info(S.getInputConstraint(I), Name);
2893
2894 bool IsValid =
2895 getTarget().validateInputConstraint(OutputConstraintInfos, Info);
2896 if (IsHipStdPar && !IsValid)
2897 IsValidTargetAsm = false;
2898 else
2899 assert(IsValid && "Failed to parse input constraint");
2900
2901 InputConstraintInfos.push_back(Info);
2902 }
2903
2904 return IsValidTargetAsm;
2905}
2906
2907/// Process the output constraints of an inline assembly statement. This method
2908/// handles the complexity of determining whether an output should be a
2909/// register or memory operand, manages tied operands, and prepares the
2910/// necessary arguments for the LLVM inline asm call.
2911void AsmConstraintsInfo::HandleOutputConstraints() {
2912 // Keep track of defined physregs.
2913 llvm::SmallSet<std::string, 8> PhysRegOutputs;
2914
2915 for (unsigned I = 0, E = S.getNumOutputs(); I != E; I++) {
2916 TargetInfo::ConstraintInfo &Info = OutputConstraintInfos[I];
2917
2918 // Simplify the output constraint.
2919 std::string OutputConstraint(S.getOutputConstraint(I));
2920 OutputConstraint = getTarget().simplifyConstraint(
2921 StringRef(OutputConstraint).substr(1), &OutputConstraintInfos);
2922
2923 const Expr *OutExpr = S.getOutputExpr(I);
2924 OutExpr = OutExpr->IgnoreParenNoopCasts(getContext());
2925
2926 std::string GCCReg;
2927 OutputConstraint = S.addVariableConstraints(
2928 OutputConstraint, *OutExpr, getTarget(), Info.earlyClobber(),
2929 [&](const Stmt *UnspStmt, StringRef Msg) {
2930 CGM.ErrorUnsupported(UnspStmt, Msg);
2931 },
2932 &GCCReg);
2933
2934 // Give an error on multiple outputs to same physreg.
2935 if (!GCCReg.empty() && !PhysRegOutputs.insert(GCCReg).second)
2936 CGM.Error(S.getAsmLoc(), "multiple outputs to hard register: " + GCCReg);
2937
2938 OutputConstraints.push_back(OutputConstraint);
2939 LValue Dest = CGF.EmitLValue(OutExpr);
2940 if (!Constraints.empty())
2941 Constraints += ',';
2942
2943 // If this is a register output, then make the inline asm return it
2944 // by-value. If this is a memory result, return the value by-reference.
2945 QualType QTy = OutExpr->getType();
2946 const bool IsScalarOrAggregate =
2949
2950 if (!Info.allowsMemory() && IsScalarOrAggregate) {
2951 Constraints += "=" + OutputConstraint;
2952 ResultRegQualTys.push_back(QTy);
2953 ResultRegDests.push_back(Dest);
2954
2955 ResultBounds.emplace_back(Info.getOutputOperandBounds());
2956
2957 llvm::Type *Ty = CGF.ConvertTypeForMem(QTy);
2958 const bool RequiresCast =
2959 Info.allowsRegister() &&
2960 (getTargetHooks().isScalarizableAsmOperand(CGF, Ty) ||
2961 Ty->isAggregateType());
2962
2963 ResultTruncRegTypes.push_back(Ty);
2964 ResultTypeRequiresCast.push_back(RequiresCast);
2965
2966 if (RequiresCast) {
2967 if (unsigned Size = getContext().getTypeSize(QTy))
2968 Ty = llvm::IntegerType::get(getLLVMContext(), Size);
2969 else
2970 CGM.Error(OutExpr->getExprLoc(), "output size should not be zero");
2971 }
2972
2973 ResultRegTypes.push_back(Ty);
2974
2975 // If this output is tied to an input, and if the input is larger, then
2976 // we need to set the actual result type of the inline asm node to be the
2977 // same as the input type.
2978 if (Info.hasMatchingInput()) {
2979 unsigned InputNo;
2980 for (InputNo = 0; InputNo != S.getNumInputs(); ++InputNo) {
2981 TargetInfo::ConstraintInfo &Input = InputConstraintInfos[InputNo];
2982 if (Input.hasTiedOperand() && Input.getTiedOperand() == I)
2983 break;
2984 }
2985 assert(InputNo != S.getNumInputs() && "Didn't find matching input!");
2986
2987 QualType InputTy = S.getInputExpr(InputNo)->getType();
2988 QualType OutputType = OutExpr->getType();
2989
2990 uint64_t InputSize = getContext().getTypeSize(InputTy);
2991 if (getContext().getTypeSize(OutputType) < InputSize)
2992 // Form the asm to return the value as a larger integer or fp type.
2993 ResultRegTypes.back() = CGF.ConvertType(InputTy);
2994 }
2995
2996 if (llvm::Type *AdjTy = getTargetHooks().adjustInlineAsmType(
2997 CGF, OutputConstraint, ResultRegTypes.back()))
2998 ResultRegTypes.back() = AdjTy;
2999 else
3000 CGM.getDiags().Report(S.getAsmLoc(),
3001 diag::err_asm_invalid_type_in_input)
3002 << OutExpr->getType() << OutputConstraint;
3003
3004 // Update largest vector width for any vector types.
3005 if (auto *VT = dyn_cast<llvm::VectorType>(ResultRegTypes.back()))
3006 CGF.LargestVectorWidth =
3007 std::max((uint64_t)CGF.LargestVectorWidth,
3008 VT->getPrimitiveSizeInBits().getKnownMinValue());
3009 } else {
3010 Address DestAddr = Dest.getAddress();
3011
3012 // Matrix types in memory are represented by arrays, but accessed through
3013 // vector pointers, with the alignment specified on the access operation.
3014 // For inline assembly, update pointer arguments to use vector pointers.
3015 // Otherwise there will be a mis-match if the matrix is also an
3016 // input-argument which is represented as vector.
3017 if (isa<MatrixType>(OutExpr->getType().getCanonicalType()))
3018 DestAddr =
3019 DestAddr.withElementType(CGF.ConvertType(OutExpr->getType()));
3020
3021 ArgTypes.push_back(DestAddr.getType());
3022 ArgElemTypes.push_back(DestAddr.getElementType());
3023 Args.push_back(DestAddr.emitRawPointer(CGF));
3024
3025 Constraints += "=*" + OutputConstraint;
3026 ReadOnly = false;
3027 ReadNone = false;
3028 }
3029
3030 if (!Info.isReadWrite())
3031 continue;
3032
3033 InOutConstraints += ',';
3034
3035 const Expr *InputExpr = S.getOutputExpr(I);
3036 llvm::Value *Arg;
3037 llvm::Type *ArgElemType;
3038 std::tie(Arg, ArgElemType) =
3039 CGF.EmitAsmInputLValue(Info, Dest, InputExpr->getType(),
3040 InOutConstraints, InputExpr->getExprLoc());
3041
3042 if (llvm::Type *AdjTy = getTargetHooks().adjustInlineAsmType(
3043 CGF, OutputConstraint, Arg->getType()))
3044 Arg = Builder.CreateBitCast(Arg, AdjTy);
3045
3046 // Update largest vector width for any vector types.
3047 if (auto *VT = dyn_cast<llvm::VectorType>(Arg->getType()))
3048 CGF.LargestVectorWidth =
3049 std::max((uint64_t)CGF.LargestVectorWidth,
3050 VT->getPrimitiveSizeInBits().getKnownMinValue());
3051
3052 // Only tie earlyclobber physregs.
3053 if (Info.allowsRegister() && (GCCReg.empty() || Info.earlyClobber()))
3054 InOutConstraints += llvm::utostr(I);
3055 else
3056 InOutConstraints += OutputConstraint;
3057
3058 InOutArgTypes.push_back(Arg->getType());
3059 InOutArgElemTypes.push_back(ArgElemType);
3060 InOutArgs.push_back(Arg);
3061 }
3062}
3063
3064/// Special handling for Microsoft-style inline assembly blocks. This ensures
3065/// that return registers (like EAX:EDX) are correctly mapped to the function's
3066/// return value slot when necessary.
3067void AsmConstraintsInfo::HandleMSStyleAsmBlob() {
3068 if (!isa<MSAsmStmt>(&S))
3069 return;
3070
3071 const ABIArgInfo &RetAI = CGF.CurFnInfo->getReturnInfo();
3072 if (!RetAI.isDirect() && !RetAI.isExtend())
3073 return;
3074
3075 // Make a fake lvalue for the return value slot.
3076 LValue ReturnSlot =
3078 CGM.getTargetCodeGenInfo().addReturnRegisterOutputs(
3079 CGF, ReturnSlot, Constraints, ResultRegTypes, ResultTruncRegTypes,
3080 ResultRegDests, AsmString, S.getNumOutputs());
3081 CGF.SawAsmBlock = true;
3082}
3083
3084/// Process the input constraints of an inline assembly statement. It handles
3085/// type conversions, extensions for tied operands, and collects the necessary
3086/// LLVM values to be passed to the inline assembly call.
3087void AsmConstraintsInfo::HandleInputConstraints() {
3088 ASTContext &Ctx = getContext();
3089
3090 for (unsigned I = 0, E = S.getNumInputs(); I != E; I++) {
3091 TargetInfo::ConstraintInfo &Info = InputConstraintInfos[I];
3092 const Expr *InputExpr = S.getInputExpr(I);
3093
3094 if (Info.allowsMemory())
3095 ReadNone = false;
3096
3097 if (!Constraints.empty())
3098 Constraints += ',';
3099
3100 // Simplify the input constraint.
3101 std::string InputConstraint(S.getInputConstraint(I));
3102 InputConstraint =
3103 getTarget().simplifyConstraint(InputConstraint, &OutputConstraintInfos);
3104
3105 InputConstraint = S.addVariableConstraints(
3106 InputConstraint, *InputExpr->IgnoreParenNoopCasts(Ctx), getTarget(),
3107 false /* No EarlyClobber */,
3108 [&](const Stmt *UnspStmt, std::string_view Msg) {
3109 CGM.ErrorUnsupported(UnspStmt, Msg);
3110 });
3111
3112 std::string ReplaceConstraint(InputConstraint);
3113 llvm::Value *Arg;
3114 llvm::Type *ArgElemType;
3115 std::tie(Arg, ArgElemType) = CGF.EmitAsmInput(Info, InputExpr, Constraints);
3116
3117 // If this input argument is tied to a larger output result, extend the
3118 // input to be the same size as the output. The LLVM backend wants to see
3119 // the input and output of a matching constraint be the same size. Note
3120 // that GCC does not define what the top bits are here. We use zext because
3121 // that is usually cheaper, but LLVM IR should really get an anyext someday.
3122 if (Info.hasTiedOperand()) {
3123 unsigned Output = Info.getTiedOperand();
3124 QualType OutputType = S.getOutputExpr(Output)->getType();
3125 QualType InputTy = InputExpr->getType();
3126
3127 if (Ctx.getTypeSize(OutputType) > Ctx.getTypeSize(InputTy)) {
3128 // Use ptrtoint as appropriate so that we can do our extension.
3129 if (isa<llvm::PointerType>(Arg->getType()))
3130 Arg = Builder.CreatePtrToInt(Arg, CGF.IntPtrTy);
3131
3132 llvm::Type *OutputTy = CGF.ConvertType(OutputType);
3133 if (isa<llvm::IntegerType>(OutputTy))
3134 Arg = Builder.CreateZExt(Arg, OutputTy);
3135 else if (isa<llvm::PointerType>(OutputTy))
3136 Arg = Builder.CreateZExt(Arg, CGF.IntPtrTy);
3137 else if (OutputTy->isFloatingPointTy())
3138 Arg = Builder.CreateFPExt(Arg, OutputTy);
3139 }
3140
3141 // Deal with the tied operands' constraint code in adjustInlineAsmType.
3142 ReplaceConstraint = OutputConstraints[Output];
3143 }
3144
3145 if (llvm::Type *AdjTy = getTargetHooks().adjustInlineAsmType(
3146 CGF, ReplaceConstraint, Arg->getType()))
3147 Arg = Builder.CreateBitCast(Arg, AdjTy);
3148 else
3149 CGM.getDiags().Report(S.getAsmLoc(), diag::err_asm_invalid_type_in_input)
3150 << InputExpr->getType() << InputConstraint;
3151
3152 // Update largest vector width for any vector types.
3153 if (auto *VT = dyn_cast<llvm::VectorType>(Arg->getType()))
3154 CGF.LargestVectorWidth =
3155 std::max((uint64_t)CGF.LargestVectorWidth,
3156 VT->getPrimitiveSizeInBits().getKnownMinValue());
3157
3158 ArgTypes.push_back(Arg->getType());
3159 ArgElemTypes.push_back(ArgElemType);
3160 Args.push_back(Arg);
3161
3162 Constraints += InputConstraint;
3163 }
3164
3165 // Append the "input" part of in/out constraints.
3166 for (unsigned I = 0, E = InOutArgs.size(); I != E; I++) {
3167 ArgTypes.push_back(InOutArgTypes[I]);
3168 ArgElemTypes.push_back(InOutArgElemTypes[I]);
3169 Args.push_back(InOutArgs[I]);
3170 }
3171
3172 Constraints += InOutConstraints;
3173}
3174
3175/// Handle labels in an 'asm goto' statement. This method resolves the symbolic
3176/// labels to LLVM basic blocks and updates the constraint string to reflect
3177/// the indirect jump targets.
3178bool AsmConstraintsInfo::HandleLabels() {
3179 if (const auto *GS = dyn_cast<GCCAsmStmt>(&S); GS && GS->isAsmGoto()) {
3180 for (const auto *E : GS->labels()) {
3181 CodeGenFunction::JumpDest Dest = CGF.getJumpDestForLabel(E->getLabel());
3182 IndirectDests.push_back(Dest.getBlock());
3183
3184 if (!Constraints.empty())
3185 Constraints += ',';
3186
3187 Constraints += "!i";
3188 }
3189
3190 DefaultDest = CGF.createBasicBlock("asm.fallthrough");
3191 return true;
3192 }
3193
3194 return false;
3195}
3196
3197/// Process clobber constraints for an inline assembly statement. This
3198/// identifies which registers or system state (like "memory" or "cc") are
3199/// modified by the assembly block, which is crucial for correct optimization
3200/// and side-effect modeling.
3201bool AsmConstraintsInfo::HandleClobbers() {
3202 bool HasUnwindClobber = false;
3203 for (unsigned I = 0, E = S.getNumClobbers(); I != E; I++) {
3204 std::string Clobber = S.getClobber(I);
3205
3206 if (Clobber == "unwind") {
3207 HasUnwindClobber = true;
3208 continue;
3209 }
3210
3211 if (Clobber == "memory") {
3212 ReadOnly = false;
3213 ReadNone = false;
3214 } else if (Clobber != "cc") {
3215 Clobber = getTarget().getNormalizedGCCRegisterName(Clobber);
3216 if (CGM.getCodeGenOpts().StackClashProtector &&
3217 getTarget().isSPRegName(Clobber)) {
3218 CGM.getDiags().Report(S.getAsmLoc(),
3219 diag::warn_stack_clash_protection_inline_asm);
3220 }
3221 }
3222
3223 if (isa<MSAsmStmt>(&S)) {
3224 if (Clobber == "eax" || Clobber == "edx") {
3225 if (Constraints.find("=&A") != std::string::npos)
3226 continue;
3227
3228 std::string::size_type position1 =
3229 Constraints.find("={" + Clobber + "}");
3230 if (position1 != std::string::npos) {
3231 Constraints.insert(position1 + 1, "&");
3232 continue;
3233 }
3234
3235 std::string::size_type position2 = Constraints.find("=A");
3236 if (position2 != std::string::npos) {
3237 Constraints.insert(position2 + 1, "&");
3238 continue;
3239 }
3240 }
3241 }
3242
3243 if (!Constraints.empty())
3244 Constraints += ',';
3245
3246 Constraints += "~{" + Clobber + '}';
3247 }
3248
3249 return HasUnwindClobber;
3250}
3251
3252void AsmConstraintsInfo::UpdateAsmCallInst(
3253 llvm::CallBase &Result, bool HasSideEffect, bool HasUnwindClobber,
3254 bool NoMerge, bool NoConvergent, std::vector<llvm::Value *> &RegResults) {
3255 if (!HasUnwindClobber)
3256 Result.addFnAttr(llvm::Attribute::NoUnwind);
3257
3258 if (NoMerge)
3259 Result.addFnAttr(llvm::Attribute::NoMerge);
3260
3261 // Attach readnone and readonly attributes.
3262 if (!HasSideEffect) {
3263 if (ReadNone)
3264 Result.setDoesNotAccessMemory();
3265 else if (ReadOnly)
3266 Result.setOnlyReadsMemory();
3267 }
3268
3269 // Add elementtype attribute for indirect constraints.
3270 for (auto Pair : llvm::enumerate(ArgElemTypes)) {
3271 if (Pair.value()) {
3272 auto Attr = llvm::Attribute::get(
3273 getLLVMContext(), llvm::Attribute::ElementType, Pair.value());
3274 Result.addParamAttr(Pair.index(), Attr);
3275 }
3276 }
3277
3278 // Slap the source location of the inline asm into a !srcloc metadata on the
3279 // call.
3280 const StringLiteral *SL;
3281 if (const auto *gccAsmStmt = dyn_cast<GCCAsmStmt>(&S);
3282 gccAsmStmt &&
3283 (SL = dyn_cast<StringLiteral>(gccAsmStmt->getAsmStringExpr()))) {
3284 Result.setMetadata("srcloc", getAsmSrcLocInfo(SL, CGF));
3285 } else {
3286 // At least put the line number on MS inline asm blobs and GCC asm constexpr
3287 // strings.
3288 llvm::Constant *Loc =
3289 llvm::ConstantInt::get(CGF.Int64Ty, S.getAsmLoc().getRawEncoding());
3290 Result.setMetadata("srcloc",
3291 llvm::MDNode::get(getLLVMContext(),
3292 llvm::ConstantAsMetadata::get(Loc)));
3293 }
3294
3295 // Make inline-asm calls Key for the debug info feature Key Instructions.
3296 CGF.addInstToNewSourceAtom(&Result, nullptr);
3297
3298 if (!NoConvergent && getLangOpts().assumeFunctionsAreConvergent())
3299 // Conservatively, mark all inline asm blocks in CUDA or OpenCL as
3300 // convergent (meaning, they may call an intrinsically convergent op, such
3301 // as bar.sync, and so can't have certain optimizations applied around
3302 // them) unless it's explicitly marked 'noconvergent'.
3303 Result.addFnAttr(llvm::Attribute::Convergent);
3304
3305 // Extract all of the register value results from the asm.
3306 if (ResultRegTypes.size() == 1) {
3307 RegResults.push_back(&Result);
3308 } else {
3309 for (unsigned i = 0, e = ResultRegTypes.size(); i != e; ++i) {
3310 llvm::Value *Tmp = Builder.CreateExtractValue(&Result, i, "asmresult");
3311 RegResults.push_back(Tmp);
3312 }
3313 }
3314}
3315
3316void AsmConstraintsInfo::EmitAsmStores(
3317 const llvm::ArrayRef<llvm::Value *> RegResults) {
3318 llvm::LLVMContext &CTX = getLLVMContext();
3319
3320 assert(RegResults.size() == ResultRegTypes.size());
3321 assert(RegResults.size() == ResultTruncRegTypes.size());
3322 assert(RegResults.size() == ResultRegDests.size());
3323
3324 // ResultRegDests can also be populated by addReturnRegisterOutputs() above,
3325 // in which case its size may grow.
3326 assert(ResultTypeRequiresCast.size() <= ResultRegDests.size());
3327 assert(ResultBounds.size() <= ResultRegDests.size());
3328
3329 for (unsigned i = 0, e = RegResults.size(); i != e; ++i) {
3330 llvm::Value *Tmp = RegResults[i];
3331 llvm::Type *TruncTy = ResultTruncRegTypes[i];
3332
3333 if (i < ResultBounds.size() && ResultBounds[i].has_value()) {
3334 const auto [LowerBound, UpperBound] = ResultBounds[i].value();
3335
3336 // FIXME: Support for nonzero lower bounds not yet implemented.
3337 assert(LowerBound == 0 && "Output operand lower bound is not zero.");
3338
3339 llvm::Constant *UpperBoundConst =
3340 llvm::ConstantInt::get(Tmp->getType(), UpperBound);
3341 llvm::Value *IsBooleanValue =
3342 Builder.CreateCmp(llvm::CmpInst::ICMP_ULT, Tmp, UpperBoundConst);
3343 llvm::Function *FnAssume = CGM.getIntrinsic(llvm::Intrinsic::assume);
3344
3345 Builder.CreateCall(FnAssume, IsBooleanValue);
3346 }
3347
3348 // If the result type of the LLVM IR asm doesn't match the result type of
3349 // the expression, do the conversion.
3350 if (ResultRegTypes[i] != TruncTy) {
3351 // Truncate the integer result to the right size, note that TruncTy can be
3352 // a pointer.
3353 if (TruncTy->isFloatingPointTy())
3354 Tmp = Builder.CreateFPTrunc(Tmp, TruncTy);
3355 else if (TruncTy->isPointerTy() && Tmp->getType()->isIntegerTy()) {
3356 uint64_t ResSize = CGM.getDataLayout().getTypeSizeInBits(TruncTy);
3357 Tmp = Builder.CreateTrunc(
3358 Tmp, llvm::IntegerType::get(CTX, (unsigned)ResSize));
3359 Tmp = Builder.CreateIntToPtr(Tmp, TruncTy);
3360 } else if (Tmp->getType()->isPointerTy() && TruncTy->isIntegerTy()) {
3361 uint64_t TmpSize =
3362 CGM.getDataLayout().getTypeSizeInBits(Tmp->getType());
3363 Tmp = Builder.CreatePtrToInt(
3364 Tmp, llvm::IntegerType::get(CTX, (unsigned)TmpSize));
3365 Tmp = Builder.CreateTrunc(Tmp, TruncTy);
3366 } else if (Tmp->getType()->isIntegerTy() && TruncTy->isIntegerTy()) {
3367 Tmp = Builder.CreateZExtOrTrunc(Tmp, TruncTy);
3368 } else if (Tmp->getType()->isVectorTy() || TruncTy->isVectorTy()) {
3369 Tmp = Builder.CreateBitCast(Tmp, TruncTy);
3370 }
3371 }
3372
3373 ApplyAtomGroup Grp(CGF.getDebugInfo());
3374 LValue Dest = ResultRegDests[i];
3375
3376 // ResultTypeRequiresCast elements correspond to the first
3377 // ResultTypeRequiresCast.size() elements of RegResults.
3378 if (i < ResultTypeRequiresCast.size() && ResultTypeRequiresCast[i]) {
3379 unsigned Size = getContext().getTypeSize(ResultRegQualTys[i]);
3380 Address A = Dest.getAddress().withElementType(ResultRegTypes[i]);
3381
3382 if (getTargetHooks().isScalarizableAsmOperand(CGF, TruncTy)) {
3383 llvm::StoreInst *S = Builder.CreateStore(Tmp, A);
3384 CGF.addInstToCurrentSourceAtom(S, S->getValueOperand());
3385 continue;
3386 }
3387
3388 QualType Ty = getContext().getIntTypeForBitwidth(Size, /*Signed=*/false);
3389 if (Ty.isNull()) {
3390 const Expr *OutExpr = S.getOutputExpr(i);
3391 CGM.getDiags().Report(OutExpr->getExprLoc(),
3392 diag::err_store_value_to_reg);
3393 return;
3394 }
3395
3396 Dest = CGF.MakeAddrLValue(A, Ty);
3397 }
3398
3399 CGF.EmitStoreThroughLValue(RValue::get(Tmp), Dest);
3400 }
3401}
3402
3404 const RecordDecl *RD = S.getCapturedRecordDecl();
3405 CanQualType RecordTy = getContext().getCanonicalTagType(RD);
3406
3407 // Initialize the captured struct.
3408 LValue SlotLV =
3409 MakeAddrLValue(CreateMemTemp(RecordTy, "agg.captured"), RecordTy);
3410
3411 RecordDecl::field_iterator CurField = RD->field_begin();
3413 E = S.capture_init_end();
3414 I != E; ++I, ++CurField) {
3415 LValue LV = EmitLValueForFieldInitialization(SlotLV, *CurField);
3416 if (CurField->hasCapturedVLAType()) {
3417 EmitLambdaVLACapture(CurField->getCapturedVLAType(), LV);
3418 } else {
3419 EmitInitializerForField(*CurField, LV, *I);
3420 }
3421 }
3422
3423 return SlotLV;
3424}
3425
3426/// Generate an outlined function for the body of a CapturedStmt, store any
3427/// captured variables into the captured struct, and call the outlined function.
3428llvm::Function *
3430 LValue CapStruct = InitCapturedStruct(S);
3431
3432 // Emit the CapturedDecl
3433 CodeGenFunction CGF(CGM, true);
3434 CGCapturedStmtRAII CapInfoRAII(CGF, new CGCapturedStmtInfo(S, K));
3435 llvm::Function *F = CGF.GenerateCapturedStmtFunction(S);
3436 delete CGF.CapturedStmtInfo;
3437
3438 // Emit call to the helper function.
3439 EmitCallOrInvoke(F, CapStruct.getPointer(*this));
3440
3441 return F;
3442}
3443
3445 LValue CapStruct = InitCapturedStruct(S);
3446 return CapStruct.getAddress();
3447}
3448
3449/// Creates the outlined function for a CapturedStmt.
3450llvm::Function *
3452 assert(CapturedStmtInfo &&
3453 "CapturedStmtInfo should be set when generating the captured function");
3454 const CapturedDecl *CD = S.getCapturedDecl();
3455 const RecordDecl *RD = S.getCapturedRecordDecl();
3456 SourceLocation Loc = S.getBeginLoc();
3457 assert(CD->hasBody() && "missing CapturedDecl body");
3458
3459 // Build the argument list.
3460 ASTContext &Ctx = CGM.getContext();
3461 FunctionArgList Args;
3462 Args.append(CD->param_begin(), CD->param_end());
3463
3464 // Create the function declaration.
3465 const CGFunctionInfo &FuncInfo =
3466 CGM.getTypes().arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Args);
3467 llvm::FunctionType *FuncLLVMTy = CGM.getTypes().GetFunctionType(FuncInfo);
3468
3469 llvm::Function *F =
3470 llvm::Function::Create(FuncLLVMTy, llvm::GlobalValue::InternalLinkage,
3471 CapturedStmtInfo->getHelperName(), &CGM.getModule());
3472 CGM.SetInternalFunctionAttributes(CD, F, FuncInfo);
3473 if (!CGM.getCodeGenOpts().SampleProfileFile.empty())
3474 F->addFnAttr("sample-profile-suffix-elision-policy", "selected");
3475 if (CD->isNothrow())
3476 F->addFnAttr(llvm::Attribute::NoUnwind);
3477
3478 // Generate the function.
3479 StartFunction(CD, Ctx.VoidTy, F, FuncInfo, Args, CD->getLocation(),
3480 CD->getBody()->getBeginLoc());
3481 // Set the context parameter in CapturedStmtInfo.
3482 Address DeclPtr = GetAddrOfLocalVar(CD->getContextParam());
3483 CapturedStmtInfo->setContextValue(Builder.CreateLoad(DeclPtr));
3484
3485 // Initialize variable-length arrays.
3487 CapturedStmtInfo->getContextValue(), Ctx.getCanonicalTagType(RD));
3488 for (auto *FD : RD->fields()) {
3489 if (FD->hasCapturedVLAType()) {
3490 auto *ExprArg =
3492 .getScalarVal();
3493 auto VAT = FD->getCapturedVLAType();
3494 VLASizeMap[VAT->getSizeExpr()] = ExprArg;
3495 }
3496 }
3497
3498 // If 'this' is captured, load it into CXXThisValue.
3499 if (CapturedStmtInfo->isCXXThisExprCaptured()) {
3500 FieldDecl *FD = CapturedStmtInfo->getThisFieldDecl();
3501 LValue ThisLValue = EmitLValueForField(Base, FD);
3502 CXXThisValue = EmitLoadOfLValue(ThisLValue, Loc).getScalarVal();
3503 }
3504
3505 PGO->assignRegionCounters(GlobalDecl(CD), F);
3506 CapturedStmtInfo->EmitBody(*this, CD->getBody());
3508
3509 return F;
3510}
3511
3512// Returns the first convergence entry/loop/anchor instruction found in |BB|.
3513// std::nullptr otherwise.
3514static llvm::ConvergenceControlInst *getConvergenceToken(llvm::BasicBlock *BB) {
3515 for (auto &I : *BB) {
3516 if (auto *CI = dyn_cast<llvm::ConvergenceControlInst>(&I))
3517 return CI;
3518 }
3519 return nullptr;
3520}
3521
3522void CodeGenFunction::addConvergenceControlBundle(
3523 SmallVectorImpl<llvm::OperandBundleDef> &Bundles) {
3524 if (!CGM.shouldEmitConvergenceTokens())
3525 return;
3526
3527 llvm::ConvergenceControlInst *ParentToken = ConvergenceTokenStack.back();
3528 assert(ParentToken);
3529 Bundles.emplace_back("convergencectrl", ParentToken);
3530}
3531
3532void CodeGenFunction::setConvergentCallSite(llvm::CallBase *Call,
3533 bool IsConvergent) {
3534 if (IsConvergent && !Call->isConvergent())
3535 Call->setConvergent();
3536
3537 assert((IsConvergent || !Call->isConvergent() ||
3538 !CGM.shouldEmitConvergenceTokens()) &&
3539 "convergent call is missing a convergence control token");
3540}
3541
3542llvm::ConvergenceControlInst *
3544 llvm::ConvergenceControlInst *ParentToken = ConvergenceTokenStack.back();
3545 assert(ParentToken);
3546 return llvm::ConvergenceControlInst::CreateLoop(*BB, ParentToken);
3547}
3548
3549llvm::ConvergenceControlInst *
3550CodeGenFunction::getOrEmitConvergenceEntryToken(llvm::Function *F) {
3551 llvm::BasicBlock *BB = &F->getEntryBlock();
3552 llvm::ConvergenceControlInst *Token = getConvergenceToken(BB);
3553 if (Token)
3554 return Token;
3555
3556 // Adding a convergence token requires the function to be marked as
3557 // convergent.
3558 F->setConvergent();
3559 return llvm::ConvergenceControlInst::CreateEntry(*BB);
3560}
#define V(N, I)
Defines enum values for all the target-independent builtin functions.
static bool FindCaseStatementsForValue(const SwitchStmt &S, const llvm::APSInt &ConstantCondValue, SmallVectorImpl< const Stmt * > &ResultStmts, ASTContext &C, const SwitchCase *&ResultCase)
FindCaseStatementsForValue - Find the case statement being jumped to and then invoke CollectStatement...
Definition CGStmt.cpp:2226
static llvm::ConvergenceControlInst * getConvergenceToken(llvm::BasicBlock *BB)
Definition CGStmt.cpp:3514
static std::optional< SmallVector< uint64_t, 16 > > getLikelihoodWeights(ArrayRef< Stmt::Likelihood > Likelihoods)
Definition CGStmt.cpp:2280
static llvm::MDNode * getAsmSrcLocInfo(const StringLiteral *Str, CodeGenFunction &CGF)
getAsmSrcLocInfo - Return the !srcloc metadata node to attach to an inline asm call instruction.
Definition CGStmt.cpp:2606
static bool isSwiftAsyncCallee(const CallExpr *CE)
Determine if the given call uses the swiftasync calling convention.
Definition CGStmt.cpp:1549
static CSFC_Result CollectStatementsForCase(const Stmt *S, const SwitchCase *Case, bool &FoundCase, SmallVectorImpl< const Stmt * > &ResultStmts)
Definition CGStmt.cpp:2071
CSFC_Result
CollectStatementsForCase - Given the body of a 'switch' statement and a constant value that is being ...
Definition CGStmt.cpp:2070
@ CSFC_Failure
Definition CGStmt.cpp:2070
@ CSFC_Success
Definition CGStmt.cpp:2070
@ CSFC_FallThrough
Definition CGStmt.cpp:2070
Result
Implement __builtin_bit_cast and related operations.
Defines the PrettyStackTraceEntry class, which is used to make crashes give more contextual informati...
Defines the SourceManager interface.
This file defines SYCL AST classes used to represent calls to SYCL kernels.
APValue - This class implements a discriminated union of [uninitialized] [APSInt] [APFloat],...
Definition APValue.h:158
bool toIntegralConstant(APSInt &Result, QualType SrcTy, const ASTContext &Ctx) const
Try to convert this value to an integral constant.
Definition APValue.cpp:1106
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition ASTContext.h:245
SourceManager & getSourceManager()
Definition ASTContext.h:917
uint64_t getTypeSize(QualType T) const
Return the size of the specified (complete) type T, in bits.
CanQualType VoidTy
CanQualType getCanonicalTagType(const TagDecl *TD) const
AsmConstraintsInfo(CodeGenFunction &CGF, const AsmStmt &S)
Definition CGStmt.cpp:2730
AsmStmt is the base class for GCCAsmStmt and MSAsmStmt.
Definition Stmt.h:3289
Attr - This represents one attribute.
Definition Attr.h:46
Represents an attribute applied to a statement.
Definition Stmt.h:2215
Stmt * getSubStmt()
Definition Stmt.h:2251
ArrayRef< const Attr * > getAttrs() const
Definition Stmt.h:2247
BreakStmt - This represents a break.
Definition Stmt.h:3147
Represents the code generated for an expanded expansion statement.
Definition StmtCXX.h:1028
ArrayRef< Stmt * > getInstantiations() const
Definition StmtCXX.h:1069
ArrayRef< Stmt * > getPreambleStmts() const
Definition StmtCXX.h:1073
CXXForRangeStmt - This represents C++0x [stmt.ranged]'s ranged for statement, represented as 'for (ra...
Definition StmtCXX.h:136
DeclStmt * getBeginStmt()
Definition StmtCXX.h:164
DeclStmt * getLoopVarStmt()
Definition StmtCXX.h:170
DeclStmt * getEndStmt()
Definition StmtCXX.h:167
DeclStmt * getRangeStmt()
Definition StmtCXX.h:163
CallExpr - Represents a function call (C99 6.5.2.2, C++ [expr.call]).
Definition Expr.h:2991
Expr * getCallee()
Definition Expr.h:3138
Represents the body of a CapturedStmt, and serves as its DeclContext.
Definition Decl.h:5086
ImplicitParamDecl * getContextParam() const
Retrieve the parameter containing captured variables.
Definition Decl.h:5144
bool isNothrow() const
Definition Decl.cpp:5787
param_iterator param_end() const
Retrieve an iterator one past the last parameter decl.
Definition Decl.h:5161
param_iterator param_begin() const
Retrieve an iterator pointing to the first parameter decl.
Definition Decl.h:5159
Stmt * getBody() const override
getBody - If this Decl represents a declaration for a body of code, such as a function or method defi...
Definition Decl.cpp:5784
This captures a statement into a function.
Definition Stmt.h:3949
CapturedDecl * getCapturedDecl()
Retrieve the outlined function declaration.
Definition Stmt.cpp:1493
const RecordDecl * getCapturedRecordDecl() const
Retrieve the record declaration for captured variables.
Definition Stmt.h:4070
capture_init_iterator capture_init_begin()
Retrieve the first initialization argument.
Definition Stmt.h:4126
SourceLocation getBeginLoc() const LLVM_READONLY
Definition Stmt.h:4144
capture_init_iterator capture_init_end()
Retrieve the iterator pointing one past the last initialization argument.
Definition Stmt.h:4136
Expr *const * const_capture_init_iterator
Const iterator that walks over the capture initialization arguments.
Definition Stmt.h:4113
CapturedRegionKind getCapturedRegionKind() const
Retrieve the captured region kind.
Definition Stmt.cpp:1508
CaseStmt - Represent a case statement.
Definition Stmt.h:1932
Stmt * getSubStmt()
Definition Stmt.h:2045
Expr * getLHS()
Definition Stmt.h:2015
Expr * getRHS()
Definition Stmt.h:2027
@ Indirect
Indirect - Pass the argument indirectly via a hidden pointer with the specified alignment (0 indicate...
Like RawAddress, an abstract representation of an aligned address, but the pointer contained in this ...
Definition Address.h:128
static Address invalid()
Definition Address.h:176
llvm::Value * emitRawPointer(CodeGenFunction &CGF) const
Return the pointer contained in this class after authenticating it and adding offset to it if necessa...
Definition Address.h:253
llvm::Type * getElementType() const
Return the type of the values stored in this address.
Definition Address.h:209
Address withElementType(llvm::Type *ElemTy) const
Return address with different element type, but same pointer and alignment.
Definition Address.h:276
llvm::PointerType * getType() const
Return the type of the pointer value.
Definition Address.h:204
An aggregate value slot.
Definition CGValue.h:551
static AggValueSlot forAddr(Address addr, Qualifiers quals, IsDestructed_t isDestructed, NeedsGCBarriers_t needsGC, IsAliased_t isAliased, Overlap_t mayOverlap, IsZeroed_t isZeroed=IsNotZeroed, IsSanitizerChecked_t isChecked=IsNotSanitizerChecked)
forAddr - Make a slot for an aggregate value.
Definition CGValue.h:634
A scoped helper to set the current source atom group for CGDebugInfo::addInstToCurrentSourceAtom.
A scoped helper to set the current debug location to the specified location or preferred location of ...
static ApplyDebugLocation CreateEmpty(CodeGenFunction &CGF)
Set the IRBuilder to not attach debug locations.
llvm::StoreInst * CreateStore(llvm::Value *Val, Address Addr, bool IsVolatile=false)
Definition CGBuilder.h:148
llvm::LoadInst * CreateLoad(Address Addr, const llvm::Twine &Name="")
Definition CGBuilder.h:120
This class gathers all debug information during compilation and is responsible for emitting to llvm g...
Definition CGDebugInfo.h:59
CGFunctionInfo - Class to encapsulate the information about a function definition.
API for captured statement code generation.
RAII for correct setting/restoring of CapturedStmtInfo.
void rescopeLabels()
Change the cleanup scope of the labels in this lexical scope to match the scope of the enclosing cont...
Definition CGStmt.cpp:757
void ForceCleanup()
Force the emission of cleanups now, instead of waiting until this object is destroyed.
Enters a new scope for capturing cleanups, all of which will be executed once the scope is exited.
void ForceCleanup(std::initializer_list< llvm::Value ** > ValuesToReload={})
Force the emission of cleanups now, instead of waiting until this object is destroyed.
bool requiresCleanups() const
Determine whether this scope requires any cleanups.
CodeGenFunction - This class organizes the per-function state that is used while generating LLVM code...
void EmitOMPParallelMaskedTaskLoopDirective(const OMPParallelMaskedTaskLoopDirective &S)
StringRef AMDGPUAvailableVisibleMode
The mode string from the amdgpu_av attribute on the current statement, or empty if the attribute is n...
void EmitOMPParallelMaskedDirective(const OMPParallelMaskedDirective &S)
void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S)
void EmitCXXTryStmt(const CXXTryStmt &S)
void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock, llvm::BasicBlock *FalseBlock, uint64_t TrueCount, Stmt::Likelihood LH=Stmt::LH_None, const Expr *ConditionalOp=nullptr, const VarDecl *ConditionalDecl=nullptr)
EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g.
JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target)
The given basic block lies in the current EH scope, but may be a target of a potentially scope-crossi...
llvm::DenseMap< const VarDecl *, llvm::Value * > NRVOFlags
A mapping from NRVO variables to the flags used to indicate when the NRVO has been applied to this va...
bool IsOutlinedSEHHelper
True if the current function is an outlined SEH helper.
void EmitOMPCanonicalLoop(const OMPCanonicalLoop *S)
Emit an OMPCanonicalLoop using the OpenMPIRBuilder.
static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts=false)
ContainsLabel - Return true if the statement contains a label in it.
void EmitCXXForRangeStmt(const CXXForRangeStmt &S, ArrayRef< const Attr * > Attrs={})
Definition CGStmt.cpp:1391
void EmitOMPGenericLoopDirective(const OMPGenericLoopDirective &S)
void EmitOMPScanDirective(const OMPScanDirective &S)
void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit)
EmitComplexExprIntoLValue - Emit the given expression of complex type and place its result into the s...
static bool hasScalarEvaluationKind(QualType T)
llvm::Type * ConvertType(QualType T)
void EmitOpenACCExitDataConstruct(const OpenACCExitDataConstruct &S)
friend class clang::AsmConstraintsInfo
LValue InitCapturedStruct(const CapturedStmt &S)
Definition CGStmt.cpp:3403
void EmitOMPFlattenDirective(const OMPFlattenDirective &S)
void addInstToNewSourceAtom(llvm::Instruction *KeyInstruction, llvm::Value *Backup)
Add KeyInstruction and an optional Backup instruction to a new atom group (See ApplyAtomGroup for mor...
CGCapturedStmtInfo * CapturedStmtInfo
void EmitOMPDistributeDirective(const OMPDistributeDirective &S)
void EmitOMPParallelForDirective(const OMPParallelForDirective &S)
llvm::CallBase * EmitCallOrInvoke(llvm::FunctionCallee Callee, ArrayRef< llvm::Value * > Args, const Twine &Name="")
Emits a call or invoke instruction to the given function, depending on the current state of the EH st...
Definition CGCall.cpp:5547
void EmitOMPMasterDirective(const OMPMasterDirective &S)
void EmitOMPParallelMasterTaskLoopSimdDirective(const OMPParallelMasterTaskLoopSimdDirective &S)
void EmitOpenACCInitConstruct(const OpenACCInitConstruct &S)
void EmitOMPFlushDirective(const OMPFlushDirective &S)
void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S)
JumpDest getJumpDestForLabel(const LabelDecl *S)
getBasicBlockForLabel - Return the LLVM basicblock that the specified label maps to.
Definition CGStmt.cpp:709
void EmitCoreturnStmt(const CoreturnStmt &S)
void EmitOMPTargetTeamsDistributeParallelForSimdDirective(const OMPTargetTeamsDistributeParallelForSimdDirective &S)
SmallVector< llvm::ConvergenceControlInst *, 4 > ConvergenceTokenStack
Stack to track the controlled convergence tokens.
void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S)
Definition CGObjC.cpp:2148
void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S)
llvm::Constant * EmitCheckSourceLocation(SourceLocation Loc)
Emit a description of a source location in a format suitable for passing to a runtime sanitizer handl...
Definition CGExpr.cpp:4160
llvm::SmallVector< BypassingForwardJump, 4 > BypassingForwardJumps
bool EmitSimpleStmt(const Stmt *S, ArrayRef< const Attr * > Attrs)
EmitSimpleStmt - Try to emit a "simple" statement which does not necessarily require an insertion poi...
Definition CGStmt.cpp:522
void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S)
llvm::BasicBlock * createBasicBlock(const Twine &name="", llvm::Function *parent=nullptr, llvm::BasicBlock *before=nullptr)
createBasicBlock - Create an LLVM basic block.
void EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S)
void addInstToCurrentSourceAtom(llvm::Instruction *KeyInstruction, llvm::Value *Backup)
See CGDebugInfo::addInstToCurrentSourceAtom.
const LangOptions & getLangOpts() const
RValue EmitReferenceBindingToExpr(const Expr *E)
Emits a reference binding to the passed in expression.
Definition CGExpr.cpp:704
void EmitOpenACCShutdownConstruct(const OpenACCShutdownConstruct &S)
bool InNoConvergentAttributedStmt
True if the current statement has noconvergent attribute.
void EmitOpenACCWaitConstruct(const OpenACCWaitConstruct &S)
void EmitBlockAfterUses(llvm::BasicBlock *BB)
EmitBlockAfterUses - Emit the given block somewhere hopefully near its uses, and leave the insertion ...
Definition CGStmt.cpp:692
void SimplifyForwardingBlocks(llvm::BasicBlock *BB)
SimplifyForwardingBlocks - If the given basic block is only a branch to another basic block,...
Definition CGStmt.cpp:633
void EmitOMPSplitDirective(const OMPSplitDirective &S)
void EmitBranchThroughCleanup(JumpDest Dest)
EmitBranchThroughCleanup - Emit a branch from the current insert block through the normal cleanup han...
bool InNoMergeAttributedStmt
True if the current statement has nomerge attribute.
void EmitOMPScopeDirective(const OMPScopeDirective &S)
LValue MakeAddrLValueWithoutTBAA(Address Addr, QualType T, AlignmentSource Source=AlignmentSource::Type)
bool hasSkipCounter(const Stmt *S) const
JumpDest ReturnBlock
ReturnBlock - Unified return block.
void EmitOMPTargetTeamsDistributeSimdDirective(const OMPTargetTeamsDistributeSimdDirective &S)
llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location)
Converts Location to a DebugLoc, if debug information is enabled.
void EmitOMPInterchangeDirective(const OMPInterchangeDirective &S)
llvm::ConvergenceControlInst * emitConvergenceLoopToken(llvm::BasicBlock *BB)
Definition CGStmt.cpp:3543
void EmitAggregateCopy(LValue Dest, LValue Src, QualType EltTy, AggValueSlot::Overlap_t MayOverlap, bool isVolatile=false)
EmitAggregateCopy - Emit an aggregate copy.
LValue EmitLValueForField(LValue Base, const FieldDecl *Field, bool IsInBounds=true)
Definition CGExpr.cpp:5944
const TargetInfo & getTarget() const
Address EmitCompoundStmtWithoutScope(const CompoundStmt &S, bool GetLast=false, AggValueSlot AVS=AggValueSlot::ignored())
Definition CGStmt.cpp:584
void EmitGotoStmt(const GotoStmt &S)
Definition CGStmt.cpp:855
void EmitOMPDepobjDirective(const OMPDepobjDirective &S)
void EmitOMPMetaDirective(const OMPMetaDirective &S)
void EmitOMPCriticalDirective(const OMPCriticalDirective &S)
void EmitIgnoredExpr(const Expr *E)
EmitIgnoredExpr - Emit an expression in a context which ignores the result.
Definition CGExpr.cpp:262
void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S)
RValue EmitLoadOfLValue(LValue V, SourceLocation Loc)
EmitLoadOfLValue - Given an expression that represents a value lvalue, this method emits the address ...
Definition CGExpr.cpp:2548
void EmitOMPCancelDirective(const OMPCancelDirective &S)
const Expr * RetExpr
If a return statement is being visited, this holds the return statment's result expression.
void EmitOMPBarrierDirective(const OMPBarrierDirective &S)
void EmitForStmt(const ForStmt &S, ArrayRef< const Attr * > Attrs={})
Definition CGStmt.cpp:1246
void EmitOMPSectionsDirective(const OMPSectionsDirective &S)
void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S)
Definition CGObjC.cpp:3706
void StartFunction(GlobalDecl GD, QualType RetTy, llvm::Function *Fn, const CGFunctionInfo &FnInfo, const FunctionArgList &Args, SourceLocation Loc=SourceLocation(), SourceLocation StartLoc=SourceLocation())
Emit code for the start of a function.
void EmitCXXExpansionStmtInstantiation(const CXXExpansionStmtInstantiation &S)
Definition CGStmt.cpp:1495
void EmitOMPInteropDirective(const OMPInteropDirective &S)
void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S)
void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S)
llvm::Value * EvaluateExprAsBool(const Expr *E)
EvaluateExprAsBool - Perform the usual unary conversions on the specified expression and compare the ...
Definition CGExpr.cpp:243
void EmitWhileStmt(const WhileStmt &S, ArrayRef< const Attr * > Attrs={})
Definition CGStmt.cpp:1044
void EmitOMPTargetParallelForSimdDirective(const OMPTargetParallelForSimdDirective &S)
void EmitOMPTargetParallelGenericLoopDirective(const OMPTargetParallelGenericLoopDirective &S)
Emit combined directive 'target parallel loop' as if its constituent constructs are 'target',...
void EmitOpenACCCombinedConstruct(const OpenACCCombinedConstruct &S)
void ResolveBranchFixups(llvm::BasicBlock *Target)
void EmitOMPTeamsDistributeParallelForSimdDirective(const OMPTeamsDistributeParallelForSimdDirective &S)
void EmitOMPMaskedDirective(const OMPMaskedDirective &S)
bool checkIfLoopMustProgress(const Expr *, bool HasEmptyBody)
Returns true if a loop must make progress, which means the mustprogress attribute can be added.
Definition CGStmt.cpp:1036
bool HaveInsertPoint() const
HaveInsertPoint - True if an insertion point is defined.
void EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S)
void EmitOMPOrderedBlockAssocDirective(const OMPOrderedBlockAssocDirective &S)
void EmitOMPMasterTaskLoopDirective(const OMPMasterTaskLoopDirective &S)
void EmitOMPReverseDirective(const OMPReverseDirective &S)
void EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S)
void EmitOpenACCDataConstruct(const OpenACCDataConstruct &S)
LValue EmitLValueForFieldInitialization(LValue Base, const FieldDecl *Field)
EmitLValueForFieldInitialization - Like EmitLValueForField, except that if the Field is a reference,...
Definition CGExpr.cpp:6106
void EmitOMPTargetTeamsDistributeParallelForDirective(const OMPTargetTeamsDistributeParallelForDirective &S)
void EmitOMPMaskedTaskLoopDirective(const OMPMaskedTaskLoopDirective &S)
void EmitObjCAtTryStmt(const ObjCAtTryStmt &S)
Definition CGObjC.cpp:2144
const TargetCodeGenInfo & getTargetHooks() const
void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S)
void EmitSEHLeaveStmt(const SEHLeaveStmt &S)
RawAddress CreateMemTempWithoutCast(QualType T, const Twine &Name="tmp")
CreateMemTemp - Create a temporary memory object of the given type, with appropriate alignmen without...
Definition CGExpr.cpp:235
void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S)
bool InNoInlineAttributedStmt
True if the current statement has noinline attribute.
void EmitOMPMaskedTaskLoopSimdDirective(const OMPMaskedTaskLoopSimdDirective &S)
void EmitCoroutineBody(const CoroutineBodyStmt &S)
void EmitOMPParallelDirective(const OMPParallelDirective &S)
void EmitOMPTaskDirective(const OMPTaskDirective &S)
void EmitOMPMasterTaskLoopSimdDirective(const OMPMasterTaskLoopSimdDirective &S)
void EmitOMPDistributeParallelForDirective(const OMPDistributeParallelForDirective &S)
void EmitOMPAssumeDirective(const OMPAssumeDirective &S)
void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S)
void EmitStopPoint(const Stmt *S)
EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Definition CGStmt.cpp:49
void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S)
void EmitOMPTargetTeamsGenericLoopDirective(const OMPTargetTeamsGenericLoopDirective &S)
void EmitIfStmt(const IfStmt &S)
Definition CGStmt.cpp:901
void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit)
EmitStoreOfComplex - Store a complex number into the specified l-value.
void EmitDeferStmt(const DeferStmt &S)
Definition CGStmt.cpp:2043
void emitBypassedVarInitsForSource(const Stmt *Source)
Re-emit trivial-auto-var-init stores for variables bypassed by the jump Source.
Definition CGDecl.cpp:1890
void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false)
EmitStoreThroughLValue - Store the specified rvalue into the specified lvalue, where both are guarant...
Definition CGExpr.cpp:2800
void EmitOpenACCAtomicConstruct(const OpenACCAtomicConstruct &S)
void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S)
Definition CGObjC.cpp:2152
Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast=false, AggValueSlot AVS=AggValueSlot::ignored())
EmitCompoundStmt - Emit a compound statement {..} node.
Definition CGStmt.cpp:572
void EmitOpenACCCacheConstruct(const OpenACCCacheConstruct &S)
void EmitOpenACCLoopConstruct(const OpenACCLoopConstruct &S)
void EmitOMPTeamsDistributeParallelForDirective(const OMPTeamsDistributeParallelForDirective &S)
void EmitOMPFuseDirective(const OMPFuseDirective &S)
void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init)
Definition CGClass.cpp:632
void EmitAsmStmt(const AsmStmt &S)
Definition CGStmt.cpp:2739
void EmitDefaultStmt(const DefaultStmt &S, ArrayRef< const Attr * > Attrs)
Definition CGStmt.cpp:1944
void EmitOMPTargetTeamsDistributeDirective(const OMPTargetTeamsDistributeDirective &S)
void EmitSwitchStmt(const SwitchStmt &S)
Definition CGStmt.cpp:2335
static bool mightAddDeclToScope(const Stmt *S)
Determine if the given statement might introduce a declaration into the current scope,...
void EmitAnyExprToMem(const Expr *E, Address Location, Qualifiers Quals, bool IsInitializer)
EmitAnyExprToMem - Emits the code necessary to evaluate an arbitrary expression into the given memory...
Definition CGExpr.cpp:313
RValue EmitAnyExpr(const Expr *E, AggValueSlot aggSlot=AggValueSlot::ignored(), bool ignoreResult=false)
EmitAnyExpr - Emit code to compute the specified expression which can have any type.
Definition CGExpr.cpp:284
void EmitStmt(const Stmt *S, ArrayRef< const Attr * > Attrs={})
EmitStmt - Emit the code for the statement.
Definition CGStmt.cpp:59
void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S)
uint64_t getCurrentProfileCount()
Get the profiler's current count.
llvm::Type * ConvertTypeForMem(QualType T)
void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S)
void EmitSYCLKernelCallStmt(const SYCLKernelCallStmt &S)
void EmitOMPTargetDirective(const OMPTargetDirective &S)
void EmitOpenACCEnterDataConstruct(const OpenACCEnterDataConstruct &S)
llvm::Function * EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K)
Generate an outlined function for the body of a CapturedStmt, store any captured variables into the c...
Definition CGStmt.cpp:3429
static TypeEvaluationKind getEvaluationKind(QualType T)
getEvaluationKind - Return the TypeEvaluationKind of QualType T.
void EmitOMPTeamsDirective(const OMPTeamsDirective &S)
static bool containsBreak(const Stmt *S)
containsBreak - Return true if the statement contains a break out of it.
void EmitSimpleOMPExecutableDirective(const OMPExecutableDirective &D)
Emit simple code for OpenMP directives in Simd-only mode.
HLSLControlFlowHintAttr::Spelling HLSLControlFlowAttr
HLSL Branch attribute.
bool InAlwaysInlineAttributedStmt
True if the current statement has always_inline attribute.
void EmitCaseStmt(const CaseStmt &S, ArrayRef< const Attr * > Attrs)
Definition CGStmt.cpp:1829
void EmitOMPErrorDirective(const OMPErrorDirective &S)
void EmitBreakStmt(const BreakStmt &S)
Definition CGStmt.cpp:1714
void EmitOMPParallelMaskedTaskLoopSimdDirective(const OMPParallelMaskedTaskLoopSimdDirective &S)
void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S)
void EmitOpenACCComputeConstruct(const OpenACCComputeConstruct &S)
void EmitDoStmt(const DoStmt &S, ArrayRef< const Attr * > Attrs={})
Definition CGStmt.cpp:1161
void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S)
Address GenerateCapturedStmtArgument(const CapturedStmt &S)
Definition CGStmt.cpp:3444
void EmitBranch(llvm::BasicBlock *Block)
EmitBranch - Emit a branch to the specified basic block from the current insert block,...
Definition CGStmt.cpp:675
void EmitOMPSimdDirective(const OMPSimdDirective &S)
RawAddress CreateMemTemp(QualType T, const Twine &Name="tmp", RawAddress *Alloca=nullptr)
CreateMemTemp - Create a temporary memory object of the given type, with appropriate alignmen and cas...
Definition CGExpr.cpp:199
void EmitOMPParallelGenericLoopDirective(const OMPLoopDirective &S)
void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S)
RawAddress NormalCleanupDest
i32s containing the indexes of the cleanup destinations.
void EmitOMPTeamsGenericLoopDirective(const OMPTeamsGenericLoopDirective &S)
void EmitOMPOrderedStandaloneDirective(const OMPOrderedStandaloneDirective &S)
AggValueSlot::Overlap_t getOverlapForReturnValue()
Determine whether a return value slot may overlap some other object.
const BreakContinue * GetDestForLoopControlStmt(const LoopControlStmt &S)
Definition CGStmt.cpp:1700
void EmitAggExpr(const Expr *E, AggValueSlot AS)
EmitAggExpr - Emit the computation of the specified expression of aggregate type.
llvm::BasicBlock * GetIndirectGotoBlock()
void EmitOpenACCHostDataConstruct(const OpenACCHostDataConstruct &S)
void EmitOpenACCUpdateConstruct(const OpenACCUpdateConstruct &S)
void EmitOMPUnrollDirective(const OMPUnrollDirective &S)
void EmitOMPStripeDirective(const OMPStripeDirective &S)
llvm::Value * EmitScalarExpr(const Expr *E, bool IgnoreResultAssign=false)
EmitScalarExpr - Emit the computation of the specified expression of LLVM scalar type,...
static bool hasAggregateEvaluationKind(QualType T)
void EmitCaseStmtRange(const CaseStmt &S, ArrayRef< const Attr * > Attrs)
EmitCaseStmtRange - If case statement range is not too big then add multiple cases to switch instruct...
Definition CGStmt.cpp:1743
LValue MakeAddrLValue(Address Addr, QualType T, AlignmentSource Source=AlignmentSource::Type)
void EmitOMPSingleDirective(const OMPSingleDirective &S)
void EmitReturnStmt(const ReturnStmt &S)
EmitReturnStmt - Note that due to GCC extensions, this can have an operand if the function returns vo...
Definition CGStmt.cpp:1575
void EmitLambdaVLACapture(const VariableArrayType *VAT, LValue LV)
void FinishFunction(SourceLocation EndLoc=SourceLocation())
FinishFunction - Complete IR generation of the current function.
llvm::Value * EmitCheckedArgForAssume(const Expr *E)
Emits an argument for a call to a __builtin_assume.
llvm::Function * GenerateCapturedStmtFunction(const CapturedStmt &S)
Creates the outlined function for a CapturedStmt.
Definition CGStmt.cpp:3451
const CGFunctionInfo * CurFnInfo
uint64_t getProfileCount(const Stmt *S)
Get the profiler's count for the given statement.
Address GetAddrOfLocalVar(const VarDecl *VD)
GetAddrOfLocalVar - Return the address of a local variable.
void EmitDeclStmt(const DeclStmt &S)
Definition CGStmt.cpp:1690
void EmitLabelStmt(const LabelStmt &S)
Definition CGStmt.cpp:778
bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result, bool AllowLabels=false)
ConstantFoldsToSimpleInteger - If the specified expression does not fold to a constant,...
void EmitOMPTileDirective(const OMPTileDirective &S)
void EmitDecl(const Decl &D, bool EvaluateConditionDecl=false)
EmitDecl - Emit a declaration.
Definition CGDecl.cpp:52
void EmitOMPAtomicDirective(const OMPAtomicDirective &S)
void EmitOpenACCSetConstruct(const OpenACCSetConstruct &S)
Address ReturnValue
ReturnValue - The temporary alloca to hold the return value.
LValue EmitLValue(const Expr *E, KnownNonNull_t IsKnownNonNull=NotKnownNonNull)
EmitLValue - Emit code to compute a designator that specifies the location of the expression.
Definition CGExpr.cpp:1776
void EmitAttributedStmt(const AttributedStmt &S)
Definition CGStmt.cpp:788
void EmitOMPParallelMasterTaskLoopDirective(const OMPParallelMasterTaskLoopDirective &S)
void EmitOMPDistributeParallelForSimdDirective(const OMPDistributeParallelForSimdDirective &S)
void EmitOMPSectionDirective(const OMPSectionDirective &S)
void EnsureInsertPoint()
EnsureInsertPoint - Ensure that an insertion point is defined so that emitted IR has a place to go.
void EmitOMPForSimdDirective(const OMPForSimdDirective &S)
llvm::LLVMContext & getLLVMContext()
bool SawAsmBlock
Whether we processed a Microsoft-style asm block during CodeGen.
void incrementProfileCounter(const Stmt *S, llvm::Value *StepV=nullptr)
Increment the profiler's counter for the given statement by StepV.
void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S)
Definition CGObjC.cpp:1823
void EmitIndirectGotoStmt(const IndirectGotoStmt &S)
Definition CGStmt.cpp:877
void MaybeEmitDeferredVarDeclInit(const VarDecl *var)
Definition CGDecl.cpp:2156
bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const
isObviouslyBranchWithoutCleanups - Return true if a branch to the specified destination obviously has...
void EmitSEHTryStmt(const SEHTryStmt &S)
void EmitOMPParallelMasterDirective(const OMPParallelMasterDirective &S)
void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S)
When instrumenting to collect profile data, the counts for some blocks such as switch cases need to n...
void EmitStoreOfScalar(llvm::Value *Value, Address Addr, bool Volatile, QualType Ty, AlignmentSource Source=AlignmentSource::Type, bool isInit=false, bool isNontemporal=false)
EmitStoreOfScalar - Store a scalar value to an address, taking care to appropriately convert from the...
void EmitOMPForDirective(const OMPForDirective &S)
void EmitLabel(const LabelDecl *D)
EmitLabel - Emit the block for the given label.
Definition CGStmt.cpp:720
void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false)
EmitBlock - Emit the given block.
Definition CGStmt.cpp:655
LValue MakeNaturalAlignRawAddrLValue(llvm::Value *V, QualType T)
void EmitContinueStmt(const ContinueStmt &S)
Definition CGStmt.cpp:1727
This class organizes the cross-function state that is used while generating LLVM code.
const LangOptions & getLangOpts() const
const llvm::DataLayout & getDataLayout() const
ASTContext & getContext() const
A saved depth on the scope stack.
bool encloses(stable_iterator I) const
Returns true if this scope encloses I.
static stable_iterator stable_end()
Create a stable reference to the bottom of the EH stack.
FunctionArgList - Type for representing both the decl and type of parameters to a function.
Definition CGCall.h:378
LValue - This represents an lvalue references.
Definition CGValue.h:183
llvm::Value * getPointer(CodeGenFunction &CGF) const
Address getAddress() const
Definition CGValue.h:373
RValue - This trivial value class is used to represent the result of an expression that is evaluated.
Definition CGValue.h:42
bool isScalar() const
Definition CGValue.h:64
static RValue get(llvm::Value *V)
Definition CGValue.h:99
bool isAggregate() const
Definition CGValue.h:66
Address getAggregateAddress() const
getAggregateAddr() - Return the Value* of the address of the aggregate.
Definition CGValue.h:84
llvm::Value * getScalarVal() const
getScalarVal() - Return the Value* of this scalar value.
Definition CGValue.h:72
std::pair< llvm::Value *, llvm::Value * > getComplexVal() const
getComplexVal - Return the real/imag components of this complex value.
Definition CGValue.h:79
TargetCodeGenInfo - This class organizes various target-specific codegeneration issues,...
Definition TargetInfo.h:80
CompoundStmt - This represents a group of statements like { stmt stmt }.
Definition Stmt.h:1752
Stmt *const * const_body_iterator
Definition Stmt.h:1824
body_iterator body_end()
Definition Stmt.h:1817
SourceLocation getLBracLoc() const
Definition Stmt.h:1869
body_iterator body_begin()
Definition Stmt.h:1816
Stmt * body_back()
Definition Stmt.h:1820
ConstantExpr - An expression that occurs in a constant context and optionally the result of evaluatin...
Definition Expr.h:1106
ContinueStmt - This represents a continue.
Definition Stmt.h:3131
DeclStmt - Adaptor class for mixing declarations with statements and expressions.
Definition Stmt.h:1643
decl_range decls()
Definition Stmt.h:1691
SourceLocation getBodyRBrace() const
getBodyRBrace - Gets the right brace of the body, if a body exists.
virtual bool hasBody() const
Returns true if this Decl represents a declaration for a body of code, such as a function or method d...
Definition DeclBase.h:1110
SourceLocation getLocation() const
Definition DeclBase.h:447
Stmt * getSubStmt()
Definition Stmt.h:2093
DeferStmt - This represents a deferred statement.
Definition Stmt.h:3248
DoStmt - This represents a 'do/while' stmt.
Definition Stmt.h:2844
Stmt * getBody()
Definition Stmt.h:2869
Expr * getCond()
Definition Stmt.h:2862
This represents one expression.
Definition Expr.h:113
bool EvaluateAsInt(EvalResult &Result, const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects, bool InConstantContext=false) const
EvaluateAsInt - Return true if this is a constant which we can fold and convert to an integer,...
Expr * IgnoreParenNoopCasts(const ASTContext &Ctx) LLVM_READONLY
Skip past any parentheses and casts which do not change the value (including ptr->int casts of the sa...
Definition Expr.cpp:3156
llvm::APSInt EvaluateKnownConstInt(const ASTContext &Ctx) const
EvaluateKnownConstInt - Call EvaluateAsRValue and return the folded integer.
bool isEvaluatable(const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects) const
isEvaluatable - Call EvaluateAsRValue to see if this expression can be constant folded without side-e...
bool EvaluateAsRValue(EvalResult &Result, const ASTContext &Ctx, bool InConstantContext=false) const
EvaluateAsRValue - Return true if this is a constant which we can fold to an rvalue using any crazy t...
bool HasSideEffects(const ASTContext &Ctx, bool IncludePossibleEffects=true) const
HasSideEffects - This routine returns true for all those expressions which have any effect other than...
Definition Expr.cpp:3728
SourceLocation getExprLoc() const LLVM_READONLY
getExprLoc - Return the preferred location for the arrow when diagnosing a problem with a generic exp...
Definition Expr.cpp:283
QualType getType() const
Definition Expr.h:145
Represents a member of a struct/union/class.
Definition Decl.h:3299
ForStmt - This represents a 'for (init;cond;inc)' stmt.
Definition Stmt.h:2900
Stmt * getInit()
Definition Stmt.h:2915
VarDecl * getConditionVariable() const
Retrieve the variable declared in this "for" statement, if any.
Definition Stmt.cpp:1120
Stmt * getBody()
Definition Stmt.h:2944
Expr * getInc()
Definition Stmt.h:2943
Expr * getCond()
Definition Stmt.h:2942
const Expr * getSubExpr() const
Definition Expr.h:1086
FunctionType - C99 6.7.5.3 - Function Declarators.
Definition TypeBase.h:4612
CallingConv getCallConv() const
Definition TypeBase.h:4967
This represents a GCC inline-assembly statement extension.
Definition Stmt.h:3458
GlobalDecl - represents a global declaration.
Definition GlobalDecl.h:60
GotoStmt - This represents a direct goto.
Definition Stmt.h:2981
LabelDecl * getLabel() const
Definition Stmt.h:2994
IfStmt - This represents an if/then/else.
Definition Stmt.h:2271
Stmt * getThen()
Definition Stmt.h:2360
Stmt * getInit()
Definition Stmt.h:2421
Expr * getCond()
Definition Stmt.h:2348
bool isConstexpr() const
Definition Stmt.h:2464
bool isNegatedConsteval() const
Definition Stmt.h:2460
Stmt * getElse()
Definition Stmt.h:2369
bool isConsteval() const
Definition Stmt.h:2451
VarDecl * getConditionVariable()
Retrieve the variable declared in this "if" statement, if any.
Definition Stmt.cpp:1068
IndirectGotoStmt - This represents an indirect goto.
Definition Stmt.h:3020
LabelDecl * getConstantTarget()
getConstantTarget - Returns the fixed target of this indirect goto, if one exists.
Definition Stmt.cpp:1269
Represents the declaration of a label.
Definition Decl.h:525
LabelStmt * getStmt() const
Definition Decl.h:549
LabelStmt - Represents a label, which has a substatement.
Definition Stmt.h:2158
LabelDecl * getDecl() const
Definition Stmt.h:2176
bool isSideEntry() const
Definition Stmt.h:2205
Stmt * getSubStmt()
Definition Stmt.h:2180
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Base class for BreakStmt and ContinueStmt.
Definition Stmt.h:3069
Represents a point when we exit a loop.
StringRef getName() const
Get the name of identifier for this declaration as a StringRef.
Definition Decl.h:302
If a crash happens while one of these objects are live, the message is printed out along with the spe...
A (possibly-)qualified type.
Definition TypeBase.h:938
bool isNull() const
Return true if this QualType doesn't point to a type yet.
Definition TypeBase.h:1005
QualType getCanonicalType() const
Definition TypeBase.h:8498
The collection of all-type qualifiers we support.
Definition TypeBase.h:332
Represents a struct/union/class.
Definition Decl.h:4464
field_range fields() const
Definition Decl.h:4667
specific_decl_iterator< FieldDecl > field_iterator
Definition Decl.h:4664
field_iterator field_begin() const
Definition Decl.cpp:5356
ReturnStmt - This represents a return, optionally of an expression: return; return 4;.
Definition Stmt.h:3172
SourceLocation getBeginLoc() const
Definition Stmt.h:3224
const VarDecl * getNRVOCandidate() const
Retrieve the variable that might be used for the named return value optimization.
Definition Stmt.h:3208
Expr * getRetValue()
Definition Stmt.h:3199
Scope - A scope is a transient data structure that is used while parsing the program.
Definition Scope.h:41
Encodes a location in the source.
UIntTy getRawEncoding() const
When a SourceLocation itself cannot be used, this returns an (opaque) 32-bit integer encoding for it.
This class handles loading and caching of source files into memory.
A trivial tuple used to represent a source range.
Stmt - This represents one statement.
Definition Stmt.h:85
@ NoStmtClass
Definition Stmt.h:88
StmtClass getStmtClass() const
Definition Stmt.h:1505
SourceRange getSourceRange() const LLVM_READONLY
SourceLocation tokens are not useful in isolation - they are low level value objects created/interpre...
Definition Stmt.cpp:343
Likelihood
The likelihood of a branch being taken.
Definition Stmt.h:1448
@ LH_Unlikely
Branch has the [[unlikely]] attribute.
Definition Stmt.h:1449
@ LH_None
No attribute set or branches of the IfStmt have the same attribute.
Definition Stmt.h:1450
@ LH_Likely
Branch has the [[likely]] attribute.
Definition Stmt.h:1452
static const Attr * getLikelihoodAttr(const Stmt *S)
Definition Stmt.cpp:176
SourceLocation getBeginLoc() const LLVM_READONLY
Definition Stmt.cpp:355
static Likelihood getLikelihood(ArrayRef< const Attr * > Attrs)
Definition Stmt.cpp:168
StringLiteral - This represents a string literal expression, e.g.
Definition Expr.h:1823
SourceLocation getBeginLoc() const LLVM_READONLY
Definition Expr.h:2021
SourceLocation getLocationOfByte(unsigned ByteNo, const SourceManager &SM, const LangOptions &Features, const TargetInfo &Target, unsigned *StartToken=nullptr, unsigned *StartTokenByteOffset=nullptr) const
Return a source location that points to the specified byte of this string literal.
Definition Expr.cpp:1336
StringRef getString() const
Definition Expr.h:1891
const SwitchCase * getNextSwitchCase() const
Definition Stmt.h:1905
SwitchStmt - This represents a 'switch' stmt.
Definition Stmt.h:2521
Expr * getCond()
Definition Stmt.h:2584
Stmt * getBody()
Definition Stmt.h:2596
VarDecl * getConditionVariable()
Retrieve the variable declared in this "switch" statement, if any.
Definition Stmt.cpp:1186
Stmt * getInit()
Definition Stmt.h:2601
SwitchCase * getSwitchCaseList()
Definition Stmt.h:2652
Exposes information about the current target.
Definition TargetInfo.h:228
Token - This structure provides full information about a lexed token.
Definition Token.h:36
bool isVoidType() const
Definition TypeBase.h:9068
const T * castAs() const
Member-template castAs<specific type>.
Definition TypeBase.h:9366
QualType getPointeeType() const
If this is a pointer, ObjC object pointer, or block pointer, this returns the respective pointee.
Definition Type.cpp:885
bool isNRVOVariable() const
Determine whether this local variable can be used with the named return value optimization (NRVO).
Definition Decl.h:1537
WhileStmt - This represents a 'while' stmt.
Definition Stmt.h:2709
Expr * getCond()
Definition Stmt.h:2761
SourceLocation getWhileLoc() const
Definition Stmt.h:2814
SourceLocation getRParenLoc() const
Definition Stmt.h:2819
VarDecl * getConditionVariable()
Retrieve the variable declared in this "while" statement, if any.
Definition Stmt.cpp:1247
Stmt * getBody()
Definition Stmt.h:2773
Defines the clang::TargetInfo interface.
bool checkIfLoopMustProgress(const LangOptions &LangOpts, const CodeGenOptions &CGOpts, ASTContext &Ctx, const Expr *ControllingExpression, bool HasEmptyBody, llvm::function_ref< void()> RemoveMustProgress)
Returns true if a loop must make progress, which means the mustprogress attribute can be added to it.
Definition StmtUtils.cpp:15
bool hasEmptyLoopBody(const LoopStmt &S)
Definition StmtUtils.h:39
std::pair< types::ID, const llvm::opt::Arg * > InputTy
A list of inputs and their types for the given arguments.
Definition Types.h:133
@ Address
A pointer to a ValueDecl.
Definition Primitives.h:28
Top level wrappers for InstallAPI frontend operations.
CanQual< Type > CanQualType
Represents a canonical, potentially-qualified type.
bool isa(CodeGen::Address addr)
Definition Address.h:330
@ CPlusPlus
CapturedRegionKind
The different kinds of captured statement.
@ Asm
Assembly: we accept this only so that we can preprocess it.
@ Result
The result type of a method or function.
Definition TypeBase.h:906
@ CC_SwiftAsync
Definition Specifiers.h:297
U cast(CodeGen::Address addr)
Definition Address.h:327
unsigned long uint64_t
A jump destination is an abstract label, branching to which may require a jump out through normal cle...
void setScopeDepth(EHScopeStack::stable_iterator depth)
EHScopeStack::stable_iterator getScopeDepth() const
APValue Val
Val - This is the value the expression can be folded to.
Definition Expr.h:668
bool hasMatchingInput() const
Return true if this output operand has a matching (tied) input operand.
std::optional< std::pair< unsigned, unsigned > > getOutputOperandBounds() const
bool hasTiedOperand() const
Return true if this input operand is a matching constraint that ties it to an output operand.