1 //===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This is the internal per-function state used for llvm translation.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
15 #define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
16 
17 #include "CGBuilder.h"
18 #include "CGDebugInfo.h"
19 #include "CGLoopInfo.h"
20 #include "CGValue.h"
21 #include "CodeGenModule.h"
22 #include "CodeGenPGO.h"
23 #include "EHScopeStack.h"
24 #include "VarBypassDetector.h"
25 #include "clang/AST/CharUnits.h"
26 #include "clang/AST/ExprCXX.h"
27 #include "clang/AST/ExprObjC.h"
28 #include "clang/AST/ExprOpenMP.h"
29 #include "clang/AST/Type.h"
30 #include "clang/Basic/ABI.h"
31 #include "clang/Basic/CapturedStmt.h"
32 #include "clang/Basic/OpenMPKinds.h"
33 #include "clang/Basic/TargetInfo.h"
34 #include "clang/Frontend/CodeGenOptions.h"
35 #include "llvm/ADT/ArrayRef.h"
36 #include "llvm/ADT/DenseMap.h"
37 #include "llvm/ADT/MapVector.h"
38 #include "llvm/ADT/SmallVector.h"
39 #include "llvm/IR/ValueHandle.h"
40 #include "llvm/Support/Debug.h"
41 #include "llvm/Transforms/Utils/SanitizerStats.h"
42 
43 namespace llvm {
44 class BasicBlock;
45 class LLVMContext;
46 class MDNode;
47 class Module;
48 class SwitchInst;
49 class Twine;
50 class Value;
51 class CallSite;
52 }
53 
54 namespace clang {
55 class ASTContext;
56 class BlockDecl;
57 class CXXDestructorDecl;
58 class CXXForRangeStmt;
59 class CXXTryStmt;
60 class Decl;
61 class LabelDecl;
62 class EnumConstantDecl;
63 class FunctionDecl;
64 class FunctionProtoType;
65 class LabelStmt;
66 class ObjCContainerDecl;
67 class ObjCInterfaceDecl;
68 class ObjCIvarDecl;
69 class ObjCMethodDecl;
70 class ObjCImplementationDecl;
71 class ObjCPropertyImplDecl;
72 class TargetInfo;
73 class VarDecl;
74 class ObjCForCollectionStmt;
75 class ObjCAtTryStmt;
76 class ObjCAtThrowStmt;
77 class ObjCAtSynchronizedStmt;
78 class ObjCAutoreleasePoolStmt;
79 
80 namespace analyze_os_log {
81 class OSLogBufferLayout;
82 }
83 
84 namespace CodeGen {
85 class CodeGenTypes;
86 class CGCallee;
87 class CGFunctionInfo;
88 class CGRecordLayout;
89 class CGBlockInfo;
90 class CGCXXABI;
91 class BlockByrefHelpers;
92 class BlockByrefInfo;
93 class BlockFlags;
94 class BlockFieldFlags;
95 class RegionCodeGenTy;
96 class TargetCodeGenInfo;
97 struct OMPTaskDataTy;
98 struct CGCoroData;
99 
100 /// The kind of evaluation to perform on values of a particular
101 /// type.  Basically, is the code in CGExprScalar, CGExprComplex, or
102 /// CGExprAgg?
103 ///
104 /// TODO: should vectors maybe be split out into their own thing?
105 enum TypeEvaluationKind {
106   TEK_Scalar,
107   TEK_Complex,
108   TEK_Aggregate
109 };
110 
111 #define LIST_SANITIZER_CHECKS                                                  \
112   SANITIZER_CHECK(AddOverflow, add_overflow, 0)                                \
113   SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0)                  \
114   SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0)                             \
115   SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0)                          \
116   SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0)            \
117   SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0)                   \
118   SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0)             \
119   SANITIZER_CHECK(InvalidBuiltin, invalid_builtin, 0)                          \
120   SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0)                     \
121   SANITIZER_CHECK(MissingReturn, missing_return, 0)                            \
122   SANITIZER_CHECK(MulOverflow, mul_overflow, 0)                                \
123   SANITIZER_CHECK(NegateOverflow, negate_overflow, 0)                          \
124   SANITIZER_CHECK(NullabilityArg, nullability_arg, 0)                          \
125   SANITIZER_CHECK(NullabilityReturn, nullability_return, 1)                    \
126   SANITIZER_CHECK(NonnullArg, nonnull_arg, 0)                                  \
127   SANITIZER_CHECK(NonnullReturn, nonnull_return, 1)                            \
128   SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0)                               \
129   SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0)                        \
130   SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0)                    \
131   SANITIZER_CHECK(SubOverflow, sub_overflow, 0)                                \
132   SANITIZER_CHECK(TypeMismatch, type_mismatch, 1)                              \
133   SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
134 
135 enum SanitizerHandler {
136 #define SANITIZER_CHECK(Enum, Name, Version) Enum,
137   LIST_SANITIZER_CHECKS
138 #undef SANITIZER_CHECK
139 };
140 
141 /// CodeGenFunction - This class organizes the per-function state that is used
142 /// while generating LLVM code.
143 class CodeGenFunction : public CodeGenTypeCache {
144   CodeGenFunction(const CodeGenFunction &) = delete;
145   void operator=(const CodeGenFunction &) = delete;
146 
147   friend class CGCXXABI;
148 public:
149   /// A jump destination is an abstract label, branching to which may
150   /// require a jump out through normal cleanups.
151   struct JumpDest {
152     JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
153     JumpDest(llvm::BasicBlock *Block,
154              EHScopeStack::stable_iterator Depth,
155              unsigned Index)
156       : Block(Block), ScopeDepth(Depth), Index(Index) {}
157 
158     bool isValid() const { return Block != nullptr; }
159     llvm::BasicBlock *getBlock() const { return Block; }
160     EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
161     unsigned getDestIndex() const { return Index; }
162 
163     // This should be used cautiously.
164     void setScopeDepth(EHScopeStack::stable_iterator depth) {
165       ScopeDepth = depth;
166     }
167 
168   private:
169     llvm::BasicBlock *Block;
170     EHScopeStack::stable_iterator ScopeDepth;
171     unsigned Index;
172   };
173 
174   CodeGenModule &CGM;  // Per-module state.
175   const TargetInfo &Target;
176 
177   typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
178   LoopInfoStack LoopStack;
179   CGBuilderTy Builder;
180 
181   // Stores variables for which we can't generate correct lifetime markers
182   // because of jumps.
183   VarBypassDetector Bypasses;
184 
185   // CodeGen lambda for loops and support for ordered clause
186   typedef llvm::function_ref<void(CodeGenFunction &, const OMPLoopDirective &,
187                                   JumpDest)>
188       CodeGenLoopTy;
189   typedef llvm::function_ref<void(CodeGenFunction &, SourceLocation,
190                                   const unsigned, const bool)>
191       CodeGenOrderedTy;
192 
193   // Codegen lambda for loop bounds in worksharing loop constructs
194   typedef llvm::function_ref<std::pair<LValue, LValue>(
195       CodeGenFunction &, const OMPExecutableDirective &S)>
196       CodeGenLoopBoundsTy;
197 
198   // Codegen lambda for loop bounds in dispatch-based loop implementation
199   typedef llvm::function_ref<std::pair<llvm::Value *, llvm::Value *>(
200       CodeGenFunction &, const OMPExecutableDirective &S, Address LB,
201       Address UB)>
202       CodeGenDispatchBoundsTy;
203 
204   /// \brief CGBuilder insert helper. This function is called after an
205   /// instruction is created using Builder.
206   void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
207                     llvm::BasicBlock *BB,
208                     llvm::BasicBlock::iterator InsertPt) const;
209 
210   /// CurFuncDecl - Holds the Decl for the current outermost
211   /// non-closure context.
212   const Decl *CurFuncDecl;
213   /// CurCodeDecl - This is the inner-most code context, which includes blocks.
214   const Decl *CurCodeDecl;
215   const CGFunctionInfo *CurFnInfo;
216   QualType FnRetTy;
217   llvm::Function *CurFn;
218 
219   // Holds coroutine data if the current function is a coroutine. We use a
220   // wrapper to manage its lifetime, so that we don't have to define CGCoroData
221   // in this header.
222   struct CGCoroInfo {
223     std::unique_ptr<CGCoroData> Data;
224     CGCoroInfo();
225     ~CGCoroInfo();
226   };
227   CGCoroInfo CurCoro;
228 
229   bool isCoroutine() const {
230     return CurCoro.Data != nullptr;
231   }
232 
233   /// CurGD - The GlobalDecl for the current function being compiled.
234   GlobalDecl CurGD;
235 
236   /// PrologueCleanupDepth - The cleanup depth enclosing all the
237   /// cleanups associated with the parameters.
238   EHScopeStack::stable_iterator PrologueCleanupDepth;
239 
240   /// ReturnBlock - Unified return block.
241   JumpDest ReturnBlock;
242 
243   /// ReturnValue - The temporary alloca to hold the return
244   /// value. This is invalid iff the function has no return value.
245   Address ReturnValue;
246 
247   /// Return true if a label was seen in the current scope.
248   bool hasLabelBeenSeenInCurrentScope() const {
249     if (CurLexicalScope)
250       return CurLexicalScope->hasLabels();
251     return !LabelMap.empty();
252   }
253 
254   /// AllocaInsertPoint - This is an instruction in the entry block before which
255   /// we prefer to insert allocas.
256   llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
257 
258   /// \brief API for captured statement code generation.
259   class CGCapturedStmtInfo {
260   public:
261     explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
262         : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
263     explicit CGCapturedStmtInfo(const CapturedStmt &S,
264                                 CapturedRegionKind K = CR_Default)
265       : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
266 
267       RecordDecl::field_iterator Field =
268         S.getCapturedRecordDecl()->field_begin();
269       for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
270                                                 E = S.capture_end();
271            I != E; ++I, ++Field) {
272         if (I->capturesThis())
273           CXXThisFieldDecl = *Field;
274         else if (I->capturesVariable())
275           CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
276         else if (I->capturesVariableByCopy())
277           CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
278       }
279     }
280 
281     virtual ~CGCapturedStmtInfo();
282 
283     CapturedRegionKind getKind() const { return Kind; }
284 
285     virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
286     // \brief Retrieve the value of the context parameter.
287     virtual llvm::Value *getContextValue() const { return ThisValue; }
288 
289     /// \brief Lookup the captured field decl for a variable.
290     virtual const FieldDecl *lookup(const VarDecl *VD) const {
291       return CaptureFields.lookup(VD->getCanonicalDecl());
292     }
293 
294     bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
295     virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
296 
297     static bool classof(const CGCapturedStmtInfo *) {
298       return true;
299     }
300 
301     /// \brief Emit the captured statement body.
302     virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
303       CGF.incrementProfileCounter(S);
304       CGF.EmitStmt(S);
305     }
306 
307     /// \brief Get the name of the capture helper.
308     virtual StringRef getHelperName() const { return "__captured_stmt"; }
309 
310   private:
311     /// \brief The kind of captured statement being generated.
312     CapturedRegionKind Kind;
313 
314     /// \brief Keep the map between VarDecl and FieldDecl.
315     llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
316 
317     /// \brief The base address of the captured record, passed in as the first
318     /// argument of the parallel region function.
319     llvm::Value *ThisValue;
320 
321     /// \brief Captured 'this' type.
322     FieldDecl *CXXThisFieldDecl;
323   };
324   CGCapturedStmtInfo *CapturedStmtInfo;
325 
326   /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
327   class CGCapturedStmtRAII {
328   private:
329     CodeGenFunction &CGF;
330     CGCapturedStmtInfo *PrevCapturedStmtInfo;
331   public:
332     CGCapturedStmtRAII(CodeGenFunction &CGF,
333                        CGCapturedStmtInfo *NewCapturedStmtInfo)
334         : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
335       CGF.CapturedStmtInfo = NewCapturedStmtInfo;
336     }
337     ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
338   };
339 
340   /// An abstract representation of regular/ObjC call/message targets.
341   class AbstractCallee {
342     /// The function declaration of the callee.
343     const Decl *CalleeDecl;
344 
345   public:
346     AbstractCallee() : CalleeDecl(nullptr) {}
347     AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
348     AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
349     bool hasFunctionDecl() const {
350       return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
351     }
352     const Decl *getDecl() const { return CalleeDecl; }
353     unsigned getNumParams() const {
354       if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
355         return FD->getNumParams();
356       return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
357     }
358     const ParmVarDecl *getParamDecl(unsigned I) const {
359       if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
360         return FD->getParamDecl(I);
361       return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
362     }
363   };
364 
365   /// \brief Sanitizers enabled for this function.
366   SanitizerSet SanOpts;
367 
368   /// \brief True if CodeGen currently emits code implementing sanitizer checks.
369   bool IsSanitizerScope;
370 
371   /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
372   class SanitizerScope {
373     CodeGenFunction *CGF;
374   public:
375     SanitizerScope(CodeGenFunction *CGF);
376     ~SanitizerScope();
377   };
378 
379   /// In C++, whether we are code generating a thunk.  This controls whether we
380   /// should emit cleanups.
381   bool CurFuncIsThunk;
382 
383   /// In ARC, whether we should autorelease the return value.
384   bool AutoreleaseResult;
385 
386   /// Whether we processed a Microsoft-style asm block during CodeGen. These can
387   /// potentially set the return value.
388   bool SawAsmBlock;
389 
390   const FunctionDecl *CurSEHParent = nullptr;
391 
392   /// True if the current function is an outlined SEH helper. This can be a
393   /// finally block or filter expression.
394   bool IsOutlinedSEHHelper;
395 
396   const CodeGen::CGBlockInfo *BlockInfo;
397   llvm::Value *BlockPointer;
398 
399   llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
400   FieldDecl *LambdaThisCaptureField;
401 
402   /// \brief A mapping from NRVO variables to the flags used to indicate
403   /// when the NRVO has been applied to this variable.
404   llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
405 
406   EHScopeStack EHStack;
407   llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
408   llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
409 
410   llvm::Instruction *CurrentFuncletPad = nullptr;
411 
412   class CallLifetimeEnd final : public EHScopeStack::Cleanup {
413     llvm::Value *Addr;
414     llvm::Value *Size;
415 
416   public:
417     CallLifetimeEnd(Address addr, llvm::Value *size)
418         : Addr(addr.getPointer()), Size(size) {}
419 
420     void Emit(CodeGenFunction &CGF, Flags flags) override {
421       CGF.EmitLifetimeEnd(Size, Addr);
422     }
423   };
424 
425   /// Header for data within LifetimeExtendedCleanupStack.
426   struct LifetimeExtendedCleanupHeader {
427     /// The size of the following cleanup object.
428     unsigned Size;
429     /// The kind of cleanup to push: a value from the CleanupKind enumeration.
430     CleanupKind Kind;
431 
432     size_t getSize() const { return Size; }
433     CleanupKind getKind() const { return Kind; }
434   };
435 
436   /// i32s containing the indexes of the cleanup destinations.
437   Address NormalCleanupDest;
438 
439   unsigned NextCleanupDestIndex;
440 
441   /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
442   CGBlockInfo *FirstBlockInfo;
443 
444   /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
445   llvm::BasicBlock *EHResumeBlock;
446 
447   /// The exception slot.  All landing pads write the current exception pointer
448   /// into this alloca.
449   llvm::Value *ExceptionSlot;
450 
451   /// The selector slot.  Under the MandatoryCleanup model, all landing pads
452   /// write the current selector value into this alloca.
453   llvm::AllocaInst *EHSelectorSlot;
454 
455   /// A stack of exception code slots. Entering an __except block pushes a slot
456   /// on the stack and leaving pops one. The __exception_code() intrinsic loads
457   /// a value from the top of the stack.
458   SmallVector<Address, 1> SEHCodeSlotStack;
459 
460   /// Value returned by __exception_info intrinsic.
461   llvm::Value *SEHInfo = nullptr;
462 
463   /// Emits a landing pad for the current EH stack.
464   llvm::BasicBlock *EmitLandingPad();
465 
466   llvm::BasicBlock *getInvokeDestImpl();
467 
468   template <class T>
469   typename DominatingValue<T>::saved_type saveValueInCond(T value) {
470     return DominatingValue<T>::save(*this, value);
471   }
472 
473 public:
474   /// ObjCEHValueStack - Stack of Objective-C exception values, used for
475   /// rethrows.
476   SmallVector<llvm::Value*, 8> ObjCEHValueStack;
477 
478   /// A class controlling the emission of a finally block.
479   class FinallyInfo {
480     /// Where the catchall's edge through the cleanup should go.
481     JumpDest RethrowDest;
482 
483     /// A function to call to enter the catch.
484     llvm::Constant *BeginCatchFn;
485 
486     /// An i1 variable indicating whether or not the @finally is
487     /// running for an exception.
488     llvm::AllocaInst *ForEHVar;
489 
490     /// An i8* variable into which the exception pointer to rethrow
491     /// has been saved.
492     llvm::AllocaInst *SavedExnVar;
493 
494   public:
495     void enter(CodeGenFunction &CGF, const Stmt *Finally,
496                llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
497                llvm::Constant *rethrowFn);
498     void exit(CodeGenFunction &CGF);
499   };
500 
501   /// Returns true inside SEH __try blocks.
502   bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
503 
504   /// Returns true while emitting a cleanuppad.
505   bool isCleanupPadScope() const {
506     return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
507   }
508 
509   /// pushFullExprCleanup - Push a cleanup to be run at the end of the
510   /// current full-expression.  Safe against the possibility that
511   /// we're currently inside a conditionally-evaluated expression.
512   template <class T, class... As>
513   void pushFullExprCleanup(CleanupKind kind, As... A) {
514     // If we're not in a conditional branch, or if none of the
515     // arguments requires saving, then use the unconditional cleanup.
516     if (!isInConditionalBranch())
517       return EHStack.pushCleanup<T>(kind, A...);
518 
519     // Stash values in a tuple so we can guarantee the order of saves.
520     typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
521     SavedTuple Saved{saveValueInCond(A)...};
522 
523     typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
524     EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
525     initFullExprCleanup();
526   }
527 
528   /// \brief Queue a cleanup to be pushed after finishing the current
529   /// full-expression.
530   template <class T, class... As>
531   void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
532     assert(!isInConditionalBranch() && "can't defer conditional cleanup");
533 
534     LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
535 
536     size_t OldSize = LifetimeExtendedCleanupStack.size();
537     LifetimeExtendedCleanupStack.resize(
538         LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
539 
540     static_assert(sizeof(Header) % alignof(T) == 0,
541                   "Cleanup will be allocated on misaligned address");
542     char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
543     new (Buffer) LifetimeExtendedCleanupHeader(Header);
544     new (Buffer + sizeof(Header)) T(A...);
545   }
546 
547   /// Set up the last cleaup that was pushed as a conditional
548   /// full-expression cleanup.
549   void initFullExprCleanup();
550 
551   /// PushDestructorCleanup - Push a cleanup to call the
552   /// complete-object destructor of an object of the given type at the
553   /// given address.  Does nothing if T is not a C++ class type with a
554   /// non-trivial destructor.
555   void PushDestructorCleanup(QualType T, Address Addr);
556 
557   /// PushDestructorCleanup - Push a cleanup to call the
558   /// complete-object variant of the given destructor on the object at
559   /// the given address.
560   void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
561 
562   /// PopCleanupBlock - Will pop the cleanup entry on the stack and
563   /// process all branch fixups.
564   void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
565 
566   /// DeactivateCleanupBlock - Deactivates the given cleanup block.
567   /// The block cannot be reactivated.  Pops it if it's the top of the
568   /// stack.
569   ///
570   /// \param DominatingIP - An instruction which is known to
571   ///   dominate the current IP (if set) and which lies along
572   ///   all paths of execution between the current IP and the
573   ///   the point at which the cleanup comes into scope.
574   void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
575                               llvm::Instruction *DominatingIP);
576 
577   /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
578   /// Cannot be used to resurrect a deactivated cleanup.
579   ///
580   /// \param DominatingIP - An instruction which is known to
581   ///   dominate the current IP (if set) and which lies along
582   ///   all paths of execution between the current IP and the
583   ///   the point at which the cleanup comes into scope.
584   void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
585                             llvm::Instruction *DominatingIP);
586 
587   /// \brief Enters a new scope for capturing cleanups, all of which
588   /// will be executed once the scope is exited.
589   class RunCleanupsScope {
590     EHScopeStack::stable_iterator CleanupStackDepth, OldCleanupScopeDepth;
591     size_t LifetimeExtendedCleanupStackSize;
592     bool OldDidCallStackSave;
593   protected:
594     bool PerformCleanup;
595   private:
596 
597     RunCleanupsScope(const RunCleanupsScope &) = delete;
598     void operator=(const RunCleanupsScope &) = delete;
599 
600   protected:
601     CodeGenFunction& CGF;
602 
603   public:
604     /// \brief Enter a new cleanup scope.
605     explicit RunCleanupsScope(CodeGenFunction &CGF)
606       : PerformCleanup(true), CGF(CGF)
607     {
608       CleanupStackDepth = CGF.EHStack.stable_begin();
609       LifetimeExtendedCleanupStackSize =
610           CGF.LifetimeExtendedCleanupStack.size();
611       OldDidCallStackSave = CGF.DidCallStackSave;
612       CGF.DidCallStackSave = false;
613       OldCleanupScopeDepth = CGF.CurrentCleanupScopeDepth;
614       CGF.CurrentCleanupScopeDepth = CleanupStackDepth;
615     }
616 
617     /// \brief Exit this cleanup scope, emitting any accumulated cleanups.
618     ~RunCleanupsScope() {
619       if (PerformCleanup)
620         ForceCleanup();
621     }
622 
623     /// \brief Determine whether this scope requires any cleanups.
624     bool requiresCleanups() const {
625       return CGF.EHStack.stable_begin() != CleanupStackDepth;
626     }
627 
628     /// \brief Force the emission of cleanups now, instead of waiting
629     /// until this object is destroyed.
630     /// \param ValuesToReload - A list of values that need to be available at
631     /// the insertion point after cleanup emission. If cleanup emission created
632     /// a shared cleanup block, these value pointers will be rewritten.
633     /// Otherwise, they not will be modified.
634     void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
635       assert(PerformCleanup && "Already forced cleanup");
636       CGF.DidCallStackSave = OldDidCallStackSave;
637       CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
638                            ValuesToReload);
639       PerformCleanup = false;
640       CGF.CurrentCleanupScopeDepth = OldCleanupScopeDepth;
641     }
642   };
643 
644   // Cleanup stack depth of the RunCleanupsScope that was pushed most recently.
645   EHScopeStack::stable_iterator CurrentCleanupScopeDepth =
646       EHScopeStack::stable_end();
647 
648   class LexicalScope : public RunCleanupsScope {
649     SourceRange Range;
650     SmallVector<const LabelDecl*, 4> Labels;
651     LexicalScope *ParentScope;
652 
653     LexicalScope(const LexicalScope &) = delete;
654     void operator=(const LexicalScope &) = delete;
655 
656   public:
657     /// \brief Enter a new cleanup scope.
658     explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
659       : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
660       CGF.CurLexicalScope = this;
661       if (CGDebugInfo *DI = CGF.getDebugInfo())
662         DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
663     }
664 
665     void addLabel(const LabelDecl *label) {
666       assert(PerformCleanup && "adding label to dead scope?");
667       Labels.push_back(label);
668     }
669 
670     /// \brief Exit this cleanup scope, emitting any accumulated
671     /// cleanups.
672     ~LexicalScope() {
673       if (CGDebugInfo *DI = CGF.getDebugInfo())
674         DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
675 
676       // If we should perform a cleanup, force them now.  Note that
677       // this ends the cleanup scope before rescoping any labels.
678       if (PerformCleanup) {
679         ApplyDebugLocation DL(CGF, Range.getEnd());
680         ForceCleanup();
681       }
682     }
683 
684     /// \brief Force the emission of cleanups now, instead of waiting
685     /// until this object is destroyed.
686     void ForceCleanup() {
687       CGF.CurLexicalScope = ParentScope;
688       RunCleanupsScope::ForceCleanup();
689 
690       if (!Labels.empty())
691         rescopeLabels();
692     }
693 
694     bool hasLabels() const {
695       return !Labels.empty();
696     }
697 
698     void rescopeLabels();
699   };
700 
701   typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
702 
703   /// The class used to assign some variables some temporarily addresses.
704   class OMPMapVars {
705     DeclMapTy SavedLocals;
706     DeclMapTy SavedTempAddresses;
707     OMPMapVars(const OMPMapVars &) = delete;
708     void operator=(const OMPMapVars &) = delete;
709 
710   public:
711     explicit OMPMapVars() = default;
712     ~OMPMapVars() {
713       assert(SavedLocals.empty() && "Did not restored original addresses.");
714     };
715 
716     /// Sets the address of the variable \p LocalVD to be \p TempAddr in
717     /// function \p CGF.
718     /// \return true if at least one variable was set already, false otherwise.
719     bool setVarAddr(CodeGenFunction &CGF, const VarDecl *LocalVD,
720                     Address TempAddr) {
721       LocalVD = LocalVD->getCanonicalDecl();
722       // Only save it once.
723       if (SavedLocals.count(LocalVD)) return false;
724 
725       // Copy the existing local entry to SavedLocals.
726       auto it = CGF.LocalDeclMap.find(LocalVD);
727       if (it != CGF.LocalDeclMap.end())
728         SavedLocals.try_emplace(LocalVD, it->second);
729       else
730         SavedLocals.try_emplace(LocalVD, Address::invalid());
731 
732       // Generate the private entry.
733       QualType VarTy = LocalVD->getType();
734       if (VarTy->isReferenceType()) {
735         Address Temp = CGF.CreateMemTemp(VarTy);
736         CGF.Builder.CreateStore(TempAddr.getPointer(), Temp);
737         TempAddr = Temp;
738       }
739       SavedTempAddresses.try_emplace(LocalVD, TempAddr);
740 
741       return true;
742     }
743 
744     /// Applies new addresses to the list of the variables.
745     /// \return true if at least one variable is using new address, false
746     /// otherwise.
747     bool apply(CodeGenFunction &CGF) {
748       copyInto(SavedTempAddresses, CGF.LocalDeclMap);
749       SavedTempAddresses.clear();
750       return !SavedLocals.empty();
751     }
752 
753     /// Restores original addresses of the variables.
754     void restore(CodeGenFunction &CGF) {
755       if (!SavedLocals.empty()) {
756         copyInto(SavedLocals, CGF.LocalDeclMap);
757         SavedLocals.clear();
758       }
759     }
760 
761   private:
762     /// Copy all the entries in the source map over the corresponding
763     /// entries in the destination, which must exist.
764     static void copyInto(const DeclMapTy &Src, DeclMapTy &Dest) {
765       for (auto &Pair : Src) {
766         if (!Pair.second.isValid()) {
767           Dest.erase(Pair.first);
768           continue;
769         }
770 
771         auto I = Dest.find(Pair.first);
772         if (I != Dest.end())
773           I->second = Pair.second;
774         else
775           Dest.insert(Pair);
776       }
777     }
778   };
779 
780   /// The scope used to remap some variables as private in the OpenMP loop body
781   /// (or other captured region emitted without outlining), and to restore old
782   /// vars back on exit.
783   class OMPPrivateScope : public RunCleanupsScope {
784     OMPMapVars MappedVars;
785     OMPPrivateScope(const OMPPrivateScope &) = delete;
786     void operator=(const OMPPrivateScope &) = delete;
787 
788   public:
789     /// Enter a new OpenMP private scope.
790     explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
791 
792     /// Registers \p LocalVD variable as a private and apply \p PrivateGen
793     /// function for it to generate corresponding private variable. \p
794     /// PrivateGen returns an address of the generated private variable.
795     /// \return true if the variable is registered as private, false if it has
796     /// been privatized already.
797     bool addPrivate(const VarDecl *LocalVD,
798                     const llvm::function_ref<Address()> PrivateGen) {
799       assert(PerformCleanup && "adding private to dead scope");
800       return MappedVars.setVarAddr(CGF, LocalVD, PrivateGen());
801     }
802 
803     /// Privatizes local variables previously registered as private.
804     /// Registration is separate from the actual privatization to allow
805     /// initializers use values of the original variables, not the private one.
806     /// This is important, for example, if the private variable is a class
807     /// variable initialized by a constructor that references other private
808     /// variables. But at initialization original variables must be used, not
809     /// private copies.
810     /// \return true if at least one variable was privatized, false otherwise.
811     bool Privatize() { return MappedVars.apply(CGF); }
812 
813     void ForceCleanup() {
814       RunCleanupsScope::ForceCleanup();
815       MappedVars.restore(CGF);
816     }
817 
818     /// Exit scope - all the mapped variables are restored.
819     ~OMPPrivateScope() {
820       if (PerformCleanup)
821         ForceCleanup();
822     }
823 
824     /// Checks if the global variable is captured in current function.
825     bool isGlobalVarCaptured(const VarDecl *VD) const {
826       VD = VD->getCanonicalDecl();
827       return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
828     }
829   };
830 
831   /// \brief Takes the old cleanup stack size and emits the cleanup blocks
832   /// that have been added.
833   void
834   PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
835                    std::initializer_list<llvm::Value **> ValuesToReload = {});
836 
837   /// \brief Takes the old cleanup stack size and emits the cleanup blocks
838   /// that have been added, then adds all lifetime-extended cleanups from
839   /// the given position to the stack.
840   void
841   PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
842                    size_t OldLifetimeExtendedStackSize,
843                    std::initializer_list<llvm::Value **> ValuesToReload = {});
844 
845   void ResolveBranchFixups(llvm::BasicBlock *Target);
846 
847   /// The given basic block lies in the current EH scope, but may be a
848   /// target of a potentially scope-crossing jump; get a stable handle
849   /// to which we can perform this jump later.
850   JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
851     return JumpDest(Target,
852                     EHStack.getInnermostNormalCleanup(),
853                     NextCleanupDestIndex++);
854   }
855 
856   /// The given basic block lies in the current EH scope, but may be a
857   /// target of a potentially scope-crossing jump; get a stable handle
858   /// to which we can perform this jump later.
859   JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
860     return getJumpDestInCurrentScope(createBasicBlock(Name));
861   }
862 
863   /// EmitBranchThroughCleanup - Emit a branch from the current insert
864   /// block through the normal cleanup handling code (if any) and then
865   /// on to \arg Dest.
866   void EmitBranchThroughCleanup(JumpDest Dest);
867 
868   /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
869   /// specified destination obviously has no cleanups to run.  'false' is always
870   /// a conservatively correct answer for this method.
871   bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
872 
873   /// popCatchScope - Pops the catch scope at the top of the EHScope
874   /// stack, emitting any required code (other than the catch handlers
875   /// themselves).
876   void popCatchScope();
877 
878   llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
879   llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
880   llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
881 
882   /// An object to manage conditionally-evaluated expressions.
883   class ConditionalEvaluation {
884     llvm::BasicBlock *StartBB;
885 
886   public:
887     ConditionalEvaluation(CodeGenFunction &CGF)
888       : StartBB(CGF.Builder.GetInsertBlock()) {}
889 
890     void begin(CodeGenFunction &CGF) {
891       assert(CGF.OutermostConditional != this);
892       if (!CGF.OutermostConditional)
893         CGF.OutermostConditional = this;
894     }
895 
896     void end(CodeGenFunction &CGF) {
897       assert(CGF.OutermostConditional != nullptr);
898       if (CGF.OutermostConditional == this)
899         CGF.OutermostConditional = nullptr;
900     }
901 
902     /// Returns a block which will be executed prior to each
903     /// evaluation of the conditional code.
904     llvm::BasicBlock *getStartingBlock() const {
905       return StartBB;
906     }
907   };
908 
909   /// isInConditionalBranch - Return true if we're currently emitting
910   /// one branch or the other of a conditional expression.
911   bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
912 
913   void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
914     assert(isInConditionalBranch());
915     llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
916     auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
917     store->setAlignment(addr.getAlignment().getQuantity());
918   }
919 
920   /// An RAII object to record that we're evaluating a statement
921   /// expression.
922   class StmtExprEvaluation {
923     CodeGenFunction &CGF;
924 
925     /// We have to save the outermost conditional: cleanups in a
926     /// statement expression aren't conditional just because the
927     /// StmtExpr is.
928     ConditionalEvaluation *SavedOutermostConditional;
929 
930   public:
931     StmtExprEvaluation(CodeGenFunction &CGF)
932       : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
933       CGF.OutermostConditional = nullptr;
934     }
935 
936     ~StmtExprEvaluation() {
937       CGF.OutermostConditional = SavedOutermostConditional;
938       CGF.EnsureInsertPoint();
939     }
940   };
941 
942   /// An object which temporarily prevents a value from being
943   /// destroyed by aggressive peephole optimizations that assume that
944   /// all uses of a value have been realized in the IR.
945   class PeepholeProtection {
946     llvm::Instruction *Inst;
947     friend class CodeGenFunction;
948 
949   public:
950     PeepholeProtection() : Inst(nullptr) {}
951   };
952 
953   /// A non-RAII class containing all the information about a bound
954   /// opaque value.  OpaqueValueMapping, below, is a RAII wrapper for
955   /// this which makes individual mappings very simple; using this
956   /// class directly is useful when you have a variable number of
957   /// opaque values or don't want the RAII functionality for some
958   /// reason.
959   class OpaqueValueMappingData {
960     const OpaqueValueExpr *OpaqueValue;
961     bool BoundLValue;
962     CodeGenFunction::PeepholeProtection Protection;
963 
964     OpaqueValueMappingData(const OpaqueValueExpr *ov,
965                            bool boundLValue)
966       : OpaqueValue(ov), BoundLValue(boundLValue) {}
967   public:
968     OpaqueValueMappingData() : OpaqueValue(nullptr) {}
969 
970     static bool shouldBindAsLValue(const Expr *expr) {
971       // gl-values should be bound as l-values for obvious reasons.
972       // Records should be bound as l-values because IR generation
973       // always keeps them in memory.  Expressions of function type
974       // act exactly like l-values but are formally required to be
975       // r-values in C.
976       return expr->isGLValue() ||
977              expr->getType()->isFunctionType() ||
978              hasAggregateEvaluationKind(expr->getType());
979     }
980 
981     static OpaqueValueMappingData bind(CodeGenFunction &CGF,
982                                        const OpaqueValueExpr *ov,
983                                        const Expr *e) {
984       if (shouldBindAsLValue(ov))
985         return bind(CGF, ov, CGF.EmitLValue(e));
986       return bind(CGF, ov, CGF.EmitAnyExpr(e));
987     }
988 
989     static OpaqueValueMappingData bind(CodeGenFunction &CGF,
990                                        const OpaqueValueExpr *ov,
991                                        const LValue &lv) {
992       assert(shouldBindAsLValue(ov));
993       CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
994       return OpaqueValueMappingData(ov, true);
995     }
996 
997     static OpaqueValueMappingData bind(CodeGenFunction &CGF,
998                                        const OpaqueValueExpr *ov,
999                                        const RValue &rv) {
1000       assert(!shouldBindAsLValue(ov));
1001       CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1002 
1003       OpaqueValueMappingData data(ov, false);
1004 
1005       // Work around an extremely aggressive peephole optimization in
1006       // EmitScalarConversion which assumes that all other uses of a
1007       // value are extant.
1008       data.Protection = CGF.protectFromPeepholes(rv);
1009 
1010       return data;
1011     }
1012 
1013     bool isValid() const { return OpaqueValue != nullptr; }
1014     void clear() { OpaqueValue = nullptr; }
1015 
1016     void unbind(CodeGenFunction &CGF) {
1017       assert(OpaqueValue && "no data to unbind!");
1018 
1019       if (BoundLValue) {
1020         CGF.OpaqueLValues.erase(OpaqueValue);
1021       } else {
1022         CGF.OpaqueRValues.erase(OpaqueValue);
1023         CGF.unprotectFromPeepholes(Protection);
1024       }
1025     }
1026   };
1027 
1028   /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1029   class OpaqueValueMapping {
1030     CodeGenFunction &CGF;
1031     OpaqueValueMappingData Data;
1032 
1033   public:
1034     static bool shouldBindAsLValue(const Expr *expr) {
1035       return OpaqueValueMappingData::shouldBindAsLValue(expr);
1036     }
1037 
1038     /// Build the opaque value mapping for the given conditional
1039     /// operator if it's the GNU ?: extension.  This is a common
1040     /// enough pattern that the convenience operator is really
1041     /// helpful.
1042     ///
1043     OpaqueValueMapping(CodeGenFunction &CGF,
1044                        const AbstractConditionalOperator *op) : CGF(CGF) {
1045       if (isa<ConditionalOperator>(op))
1046         // Leave Data empty.
1047         return;
1048 
1049       const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
1050       Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1051                                           e->getCommon());
1052     }
1053 
1054     /// Build the opaque value mapping for an OpaqueValueExpr whose source
1055     /// expression is set to the expression the OVE represents.
1056     OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1057         : CGF(CGF) {
1058       if (OV) {
1059         assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1060                                       "for OVE with no source expression");
1061         Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1062       }
1063     }
1064 
1065     OpaqueValueMapping(CodeGenFunction &CGF,
1066                        const OpaqueValueExpr *opaqueValue,
1067                        LValue lvalue)
1068       : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
1069     }
1070 
1071     OpaqueValueMapping(CodeGenFunction &CGF,
1072                        const OpaqueValueExpr *opaqueValue,
1073                        RValue rvalue)
1074       : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
1075     }
1076 
1077     void pop() {
1078       Data.unbind(CGF);
1079       Data.clear();
1080     }
1081 
1082     ~OpaqueValueMapping() {
1083       if (Data.isValid()) Data.unbind(CGF);
1084     }
1085   };
1086 
1087 private:
1088   CGDebugInfo *DebugInfo;
1089   bool DisableDebugInfo;
1090 
1091   /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1092   /// calling llvm.stacksave for multiple VLAs in the same scope.
1093   bool DidCallStackSave;
1094 
1095   /// IndirectBranch - The first time an indirect goto is seen we create a block
1096   /// with an indirect branch.  Every time we see the address of a label taken,
1097   /// we add the label to the indirect goto.  Every subsequent indirect goto is
1098   /// codegen'd as a jump to the IndirectBranch's basic block.
1099   llvm::IndirectBrInst *IndirectBranch;
1100 
1101   /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1102   /// decls.
1103   DeclMapTy LocalDeclMap;
1104 
1105   // Keep track of the cleanups for callee-destructed parameters pushed to the
1106   // cleanup stack so that they can be deactivated later.
1107   llvm::DenseMap<const ParmVarDecl *, EHScopeStack::stable_iterator>
1108       CalleeDestructedParamCleanups;
1109 
1110   /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1111   /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1112   /// parameter.
1113   llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1114       SizeArguments;
1115 
1116   /// Track escaped local variables with auto storage. Used during SEH
1117   /// outlining to produce a call to llvm.localescape.
1118   llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1119 
1120   /// LabelMap - This keeps track of the LLVM basic block for each C label.
1121   llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
1122 
1123   // BreakContinueStack - This keeps track of where break and continue
1124   // statements should jump to.
1125   struct BreakContinue {
1126     BreakContinue(JumpDest Break, JumpDest Continue)
1127       : BreakBlock(Break), ContinueBlock(Continue) {}
1128 
1129     JumpDest BreakBlock;
1130     JumpDest ContinueBlock;
1131   };
1132   SmallVector<BreakContinue, 8> BreakContinueStack;
1133 
1134   /// Handles cancellation exit points in OpenMP-related constructs.
1135   class OpenMPCancelExitStack {
1136     /// Tracks cancellation exit point and join point for cancel-related exit
1137     /// and normal exit.
1138     struct CancelExit {
1139       CancelExit() = default;
1140       CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1141                  JumpDest ContBlock)
1142           : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1143       OpenMPDirectiveKind Kind = OMPD_unknown;
1144       /// true if the exit block has been emitted already by the special
1145       /// emitExit() call, false if the default codegen is used.
1146       bool HasBeenEmitted = false;
1147       JumpDest ExitBlock;
1148       JumpDest ContBlock;
1149     };
1150 
1151     SmallVector<CancelExit, 8> Stack;
1152 
1153   public:
1154     OpenMPCancelExitStack() : Stack(1) {}
1155     ~OpenMPCancelExitStack() = default;
1156     /// Fetches the exit block for the current OpenMP construct.
1157     JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1158     /// Emits exit block with special codegen procedure specific for the related
1159     /// OpenMP construct + emits code for normal construct cleanup.
1160     void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1161                   const llvm::function_ref<void(CodeGenFunction &)> CodeGen) {
1162       if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1163         assert(CGF.getOMPCancelDestination(Kind).isValid());
1164         assert(CGF.HaveInsertPoint());
1165         assert(!Stack.back().HasBeenEmitted);
1166         auto IP = CGF.Builder.saveAndClearIP();
1167         CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1168         CodeGen(CGF);
1169         CGF.EmitBranch(Stack.back().ContBlock.getBlock());
1170         CGF.Builder.restoreIP(IP);
1171         Stack.back().HasBeenEmitted = true;
1172       }
1173       CodeGen(CGF);
1174     }
1175     /// Enter the cancel supporting \a Kind construct.
1176     /// \param Kind OpenMP directive that supports cancel constructs.
1177     /// \param HasCancel true, if the construct has inner cancel directive,
1178     /// false otherwise.
1179     void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1180       Stack.push_back({Kind,
1181                        HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1182                                  : JumpDest(),
1183                        HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1184                                  : JumpDest()});
1185     }
1186     /// Emits default exit point for the cancel construct (if the special one
1187     /// has not be used) + join point for cancel/normal exits.
1188     void exit(CodeGenFunction &CGF) {
1189       if (getExitBlock().isValid()) {
1190         assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1191         bool HaveIP = CGF.HaveInsertPoint();
1192         if (!Stack.back().HasBeenEmitted) {
1193           if (HaveIP)
1194             CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1195           CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1196           CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1197         }
1198         CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1199         if (!HaveIP) {
1200           CGF.Builder.CreateUnreachable();
1201           CGF.Builder.ClearInsertionPoint();
1202         }
1203       }
1204       Stack.pop_back();
1205     }
1206   };
1207   OpenMPCancelExitStack OMPCancelStack;
1208 
1209   CodeGenPGO PGO;
1210 
1211   /// Calculate branch weights appropriate for PGO data
1212   llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1213   llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1214   llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1215                                             uint64_t LoopCount);
1216 
1217 public:
1218   /// Increment the profiler's counter for the given statement by \p StepV.
1219   /// If \p StepV is null, the default increment is 1.
1220   void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
1221     if (CGM.getCodeGenOpts().hasProfileClangInstr())
1222       PGO.emitCounterIncrement(Builder, S, StepV);
1223     PGO.setCurrentStmt(S);
1224   }
1225 
1226   /// Get the profiler's count for the given statement.
1227   uint64_t getProfileCount(const Stmt *S) {
1228     Optional<uint64_t> Count = PGO.getStmtCount(S);
1229     if (!Count.hasValue())
1230       return 0;
1231     return *Count;
1232   }
1233 
1234   /// Set the profiler's current count.
1235   void setCurrentProfileCount(uint64_t Count) {
1236     PGO.setCurrentRegionCount(Count);
1237   }
1238 
1239   /// Get the profiler's current count. This is generally the count for the most
1240   /// recently incremented counter.
1241   uint64_t getCurrentProfileCount() {
1242     return PGO.getCurrentRegionCount();
1243   }
1244 
1245 private:
1246 
1247   /// SwitchInsn - This is nearest current switch instruction. It is null if
1248   /// current context is not in a switch.
1249   llvm::SwitchInst *SwitchInsn;
1250   /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1251   SmallVector<uint64_t, 16> *SwitchWeights;
1252 
1253   /// CaseRangeBlock - This block holds if condition check for last case
1254   /// statement range in current switch instruction.
1255   llvm::BasicBlock *CaseRangeBlock;
1256 
1257   /// OpaqueLValues - Keeps track of the current set of opaque value
1258   /// expressions.
1259   llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1260   llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
1261 
1262   // VLASizeMap - This keeps track of the associated size for each VLA type.
1263   // We track this by the size expression rather than the type itself because
1264   // in certain situations, like a const qualifier applied to an VLA typedef,
1265   // multiple VLA types can share the same size expression.
1266   // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1267   // enter/leave scopes.
1268   llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
1269 
1270   /// A block containing a single 'unreachable' instruction.  Created
1271   /// lazily by getUnreachableBlock().
1272   llvm::BasicBlock *UnreachableBlock;
1273 
1274   /// Counts of the number return expressions in the function.
1275   unsigned NumReturnExprs;
1276 
1277   /// Count the number of simple (constant) return expressions in the function.
1278   unsigned NumSimpleReturnExprs;
1279 
1280   /// The last regular (non-return) debug location (breakpoint) in the function.
1281   SourceLocation LastStopPoint;
1282 
1283 public:
1284   /// A scope within which we are constructing the fields of an object which
1285   /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1286   /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1287   class FieldConstructionScope {
1288   public:
1289     FieldConstructionScope(CodeGenFunction &CGF, Address This)
1290         : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1291       CGF.CXXDefaultInitExprThis = This;
1292     }
1293     ~FieldConstructionScope() {
1294       CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1295     }
1296 
1297   private:
1298     CodeGenFunction &CGF;
1299     Address OldCXXDefaultInitExprThis;
1300   };
1301 
1302   /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1303   /// is overridden to be the object under construction.
1304   class CXXDefaultInitExprScope {
1305   public:
1306     CXXDefaultInitExprScope(CodeGenFunction &CGF)
1307       : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1308         OldCXXThisAlignment(CGF.CXXThisAlignment) {
1309       CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1310       CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
1311     }
1312     ~CXXDefaultInitExprScope() {
1313       CGF.CXXThisValue = OldCXXThisValue;
1314       CGF.CXXThisAlignment = OldCXXThisAlignment;
1315     }
1316 
1317   public:
1318     CodeGenFunction &CGF;
1319     llvm::Value *OldCXXThisValue;
1320     CharUnits OldCXXThisAlignment;
1321   };
1322 
1323   /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1324   /// current loop index is overridden.
1325   class ArrayInitLoopExprScope {
1326   public:
1327     ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1328       : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1329       CGF.ArrayInitIndex = Index;
1330     }
1331     ~ArrayInitLoopExprScope() {
1332       CGF.ArrayInitIndex = OldArrayInitIndex;
1333     }
1334 
1335   private:
1336     CodeGenFunction &CGF;
1337     llvm::Value *OldArrayInitIndex;
1338   };
1339 
1340   class InlinedInheritingConstructorScope {
1341   public:
1342     InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1343         : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1344           OldCurCodeDecl(CGF.CurCodeDecl),
1345           OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1346           OldCXXABIThisValue(CGF.CXXABIThisValue),
1347           OldCXXThisValue(CGF.CXXThisValue),
1348           OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1349           OldCXXThisAlignment(CGF.CXXThisAlignment),
1350           OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1351           OldCXXInheritedCtorInitExprArgs(
1352               std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1353       CGF.CurGD = GD;
1354       CGF.CurFuncDecl = CGF.CurCodeDecl =
1355           cast<CXXConstructorDecl>(GD.getDecl());
1356       CGF.CXXABIThisDecl = nullptr;
1357       CGF.CXXABIThisValue = nullptr;
1358       CGF.CXXThisValue = nullptr;
1359       CGF.CXXABIThisAlignment = CharUnits();
1360       CGF.CXXThisAlignment = CharUnits();
1361       CGF.ReturnValue = Address::invalid();
1362       CGF.FnRetTy = QualType();
1363       CGF.CXXInheritedCtorInitExprArgs.clear();
1364     }
1365     ~InlinedInheritingConstructorScope() {
1366       CGF.CurGD = OldCurGD;
1367       CGF.CurFuncDecl = OldCurFuncDecl;
1368       CGF.CurCodeDecl = OldCurCodeDecl;
1369       CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1370       CGF.CXXABIThisValue = OldCXXABIThisValue;
1371       CGF.CXXThisValue = OldCXXThisValue;
1372       CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1373       CGF.CXXThisAlignment = OldCXXThisAlignment;
1374       CGF.ReturnValue = OldReturnValue;
1375       CGF.FnRetTy = OldFnRetTy;
1376       CGF.CXXInheritedCtorInitExprArgs =
1377           std::move(OldCXXInheritedCtorInitExprArgs);
1378     }
1379 
1380   private:
1381     CodeGenFunction &CGF;
1382     GlobalDecl OldCurGD;
1383     const Decl *OldCurFuncDecl;
1384     const Decl *OldCurCodeDecl;
1385     ImplicitParamDecl *OldCXXABIThisDecl;
1386     llvm::Value *OldCXXABIThisValue;
1387     llvm::Value *OldCXXThisValue;
1388     CharUnits OldCXXABIThisAlignment;
1389     CharUnits OldCXXThisAlignment;
1390     Address OldReturnValue;
1391     QualType OldFnRetTy;
1392     CallArgList OldCXXInheritedCtorInitExprArgs;
1393   };
1394 
1395 private:
1396   /// CXXThisDecl - When generating code for a C++ member function,
1397   /// this will hold the implicit 'this' declaration.
1398   ImplicitParamDecl *CXXABIThisDecl;
1399   llvm::Value *CXXABIThisValue;
1400   llvm::Value *CXXThisValue;
1401   CharUnits CXXABIThisAlignment;
1402   CharUnits CXXThisAlignment;
1403 
1404   /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1405   /// this expression.
1406   Address CXXDefaultInitExprThis = Address::invalid();
1407 
1408   /// The current array initialization index when evaluating an
1409   /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1410   llvm::Value *ArrayInitIndex = nullptr;
1411 
1412   /// The values of function arguments to use when evaluating
1413   /// CXXInheritedCtorInitExprs within this context.
1414   CallArgList CXXInheritedCtorInitExprArgs;
1415 
1416   /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1417   /// destructor, this will hold the implicit argument (e.g. VTT).
1418   ImplicitParamDecl *CXXStructorImplicitParamDecl;
1419   llvm::Value *CXXStructorImplicitParamValue;
1420 
1421   /// OutermostConditional - Points to the outermost active
1422   /// conditional control.  This is used so that we know if a
1423   /// temporary should be destroyed conditionally.
1424   ConditionalEvaluation *OutermostConditional;
1425 
1426   /// The current lexical scope.
1427   LexicalScope *CurLexicalScope;
1428 
1429   /// The current source location that should be used for exception
1430   /// handling code.
1431   SourceLocation CurEHLocation;
1432 
1433   /// BlockByrefInfos - For each __block variable, contains
1434   /// information about the layout of the variable.
1435   llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
1436 
1437   /// Used by -fsanitize=nullability-return to determine whether the return
1438   /// value can be checked.
1439   llvm::Value *RetValNullabilityPrecondition = nullptr;
1440 
1441   /// Check if -fsanitize=nullability-return instrumentation is required for
1442   /// this function.
1443   bool requiresReturnValueNullabilityCheck() const {
1444     return RetValNullabilityPrecondition;
1445   }
1446 
1447   /// Used to store precise source locations for return statements by the
1448   /// runtime return value checks.
1449   Address ReturnLocation = Address::invalid();
1450 
1451   /// Check if the return value of this function requires sanitization.
1452   bool requiresReturnValueCheck() const {
1453     return requiresReturnValueNullabilityCheck() ||
1454            (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
1455             CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
1456   }
1457 
1458   llvm::BasicBlock *TerminateLandingPad;
1459   llvm::BasicBlock *TerminateHandler;
1460   llvm::BasicBlock *TrapBB;
1461 
1462   /// Terminate funclets keyed by parent funclet pad.
1463   llvm::MapVector<llvm::Value *, llvm::BasicBlock *> TerminateFunclets;
1464 
1465   /// True if we need emit the life-time markers.
1466   const bool ShouldEmitLifetimeMarkers;
1467 
1468   /// Add OpenCL kernel arg metadata and the kernel attribute metadata to
1469   /// the function metadata.
1470   void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1471                                 llvm::Function *Fn);
1472 
1473 public:
1474   CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
1475   ~CodeGenFunction();
1476 
1477   CodeGenTypes &getTypes() const { return CGM.getTypes(); }
1478   ASTContext &getContext() const { return CGM.getContext(); }
1479   CGDebugInfo *getDebugInfo() {
1480     if (DisableDebugInfo)
1481       return nullptr;
1482     return DebugInfo;
1483   }
1484   void disableDebugInfo() { DisableDebugInfo = true; }
1485   void enableDebugInfo() { DisableDebugInfo = false; }
1486 
1487   bool shouldUseFusedARCCalls() {
1488     return CGM.getCodeGenOpts().OptimizationLevel == 0;
1489   }
1490 
1491   const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
1492 
1493   /// Returns a pointer to the function's exception object and selector slot,
1494   /// which is assigned in every landing pad.
1495   Address getExceptionSlot();
1496   Address getEHSelectorSlot();
1497 
1498   /// Returns the contents of the function's exception object and selector
1499   /// slots.
1500   llvm::Value *getExceptionFromSlot();
1501   llvm::Value *getSelectorFromSlot();
1502 
1503   Address getNormalCleanupDestSlot();
1504 
1505   llvm::BasicBlock *getUnreachableBlock() {
1506     if (!UnreachableBlock) {
1507       UnreachableBlock = createBasicBlock("unreachable");
1508       new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1509     }
1510     return UnreachableBlock;
1511   }
1512 
1513   llvm::BasicBlock *getInvokeDest() {
1514     if (!EHStack.requiresLandingPad()) return nullptr;
1515     return getInvokeDestImpl();
1516   }
1517 
1518   bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
1519 
1520   const TargetInfo &getTarget() const { return Target; }
1521   llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
1522   const TargetCodeGenInfo &getTargetHooks() const {
1523     return CGM.getTargetCodeGenInfo();
1524   }
1525 
1526   //===--------------------------------------------------------------------===//
1527   //                                  Cleanups
1528   //===--------------------------------------------------------------------===//
1529 
1530   typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
1531 
1532   void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1533                                         Address arrayEndPointer,
1534                                         QualType elementType,
1535                                         CharUnits elementAlignment,
1536                                         Destroyer *destroyer);
1537   void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1538                                       llvm::Value *arrayEnd,
1539                                       QualType elementType,
1540                                       CharUnits elementAlignment,
1541                                       Destroyer *destroyer);
1542 
1543   void pushDestroy(QualType::DestructionKind dtorKind,
1544                    Address addr, QualType type);
1545   void pushEHDestroy(QualType::DestructionKind dtorKind,
1546                      Address addr, QualType type);
1547   void pushDestroy(CleanupKind kind, Address addr, QualType type,
1548                    Destroyer *destroyer, bool useEHCleanupForArray);
1549   void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
1550                                    QualType type, Destroyer *destroyer,
1551                                    bool useEHCleanupForArray);
1552   void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1553                                    llvm::Value *CompletePtr,
1554                                    QualType ElementType);
1555   void pushStackRestore(CleanupKind kind, Address SPMem);
1556   void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
1557                    bool useEHCleanupForArray);
1558   llvm::Function *generateDestroyHelper(Address addr, QualType type,
1559                                         Destroyer *destroyer,
1560                                         bool useEHCleanupForArray,
1561                                         const VarDecl *VD);
1562   void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
1563                         QualType elementType, CharUnits elementAlign,
1564                         Destroyer *destroyer,
1565                         bool checkZeroLength, bool useEHCleanup);
1566 
1567   Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
1568 
1569   /// Determines whether an EH cleanup is required to destroy a type
1570   /// with the given destruction kind.
1571   bool needsEHCleanup(QualType::DestructionKind kind) {
1572     switch (kind) {
1573     case QualType::DK_none:
1574       return false;
1575     case QualType::DK_cxx_destructor:
1576     case QualType::DK_objc_weak_lifetime:
1577     case QualType::DK_nontrivial_c_struct:
1578       return getLangOpts().Exceptions;
1579     case QualType::DK_objc_strong_lifetime:
1580       return getLangOpts().Exceptions &&
1581              CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1582     }
1583     llvm_unreachable("bad destruction kind");
1584   }
1585 
1586   CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1587     return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1588   }
1589 
1590   //===--------------------------------------------------------------------===//
1591   //                                  Objective-C
1592   //===--------------------------------------------------------------------===//
1593 
1594   void GenerateObjCMethod(const ObjCMethodDecl *OMD);
1595 
1596   void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
1597 
1598   /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
1599   void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1600                           const ObjCPropertyImplDecl *PID);
1601   void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
1602                               const ObjCPropertyImplDecl *propImpl,
1603                               const ObjCMethodDecl *GetterMothodDecl,
1604                               llvm::Constant *AtomicHelperFn);
1605 
1606   void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1607                                   ObjCMethodDecl *MD, bool ctor);
1608 
1609   /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1610   /// for the given property.
1611   void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1612                           const ObjCPropertyImplDecl *PID);
1613   void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
1614                               const ObjCPropertyImplDecl *propImpl,
1615                               llvm::Constant *AtomicHelperFn);
1616 
1617   //===--------------------------------------------------------------------===//
1618   //                                  Block Bits
1619   //===--------------------------------------------------------------------===//
1620 
1621   /// Emit block literal.
1622   /// \return an LLVM value which is a pointer to a struct which contains
1623   /// information about the block, including the block invoke function, the
1624   /// captured variables, etc.
1625   llvm::Value *EmitBlockLiteral(const BlockExpr *);
1626   static void destroyBlockInfos(CGBlockInfo *info);
1627 
1628   llvm::Function *GenerateBlockFunction(GlobalDecl GD,
1629                                         const CGBlockInfo &Info,
1630                                         const DeclMapTy &ldm,
1631                                         bool IsLambdaConversionToBlock,
1632                                         bool BuildGlobalBlock);
1633 
1634   llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1635   llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
1636   llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1637                                              const ObjCPropertyImplDecl *PID);
1638   llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1639                                              const ObjCPropertyImplDecl *PID);
1640   llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
1641 
1642   void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1643 
1644   class AutoVarEmission;
1645 
1646   void emitByrefStructureInit(const AutoVarEmission &emission);
1647   void enterByrefCleanup(const AutoVarEmission &emission);
1648 
1649   void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1650                                 llvm::Value *ptr);
1651 
1652   Address LoadBlockStruct();
1653   Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1654 
1655   /// BuildBlockByrefAddress - Computes the location of the
1656   /// data in a variable which is declared as __block.
1657   Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1658                                 bool followForward = true);
1659   Address emitBlockByrefAddress(Address baseAddr,
1660                                 const BlockByrefInfo &info,
1661                                 bool followForward,
1662                                 const llvm::Twine &name);
1663 
1664   const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
1665 
1666   QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1667 
1668   void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1669                     const CGFunctionInfo &FnInfo);
1670   /// \brief Emit code for the start of a function.
1671   /// \param Loc       The location to be associated with the function.
1672   /// \param StartLoc  The location of the function body.
1673   void StartFunction(GlobalDecl GD,
1674                      QualType RetTy,
1675                      llvm::Function *Fn,
1676                      const CGFunctionInfo &FnInfo,
1677                      const FunctionArgList &Args,
1678                      SourceLocation Loc = SourceLocation(),
1679                      SourceLocation StartLoc = SourceLocation());
1680 
1681   static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1682 
1683   void EmitConstructorBody(FunctionArgList &Args);
1684   void EmitDestructorBody(FunctionArgList &Args);
1685   void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
1686   void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
1687   void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
1688 
1689   void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
1690                                   CallArgList &CallArgs);
1691   void EmitLambdaBlockInvokeBody();
1692   void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1693   void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
1694   void EmitAsanPrologueOrEpilogue(bool Prologue);
1695 
1696   /// \brief Emit the unified return block, trying to avoid its emission when
1697   /// possible.
1698   /// \return The debug location of the user written return statement if the
1699   /// return block is is avoided.
1700   llvm::DebugLoc EmitReturnBlock();
1701 
1702   /// FinishFunction - Complete IR generation of the current function. It is
1703   /// legal to call this function even if there is no current insertion point.
1704   void FinishFunction(SourceLocation EndLoc=SourceLocation());
1705 
1706   void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1707                   const CGFunctionInfo &FnInfo, bool IsUnprototyped);
1708 
1709   void EmitCallAndReturnForThunk(llvm::Constant *Callee, const ThunkInfo *Thunk,
1710                                  bool IsUnprototyped);
1711 
1712   void FinishThunk();
1713 
1714   /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1715   void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1716                          llvm::Value *Callee);
1717 
1718   /// Generate a thunk for the given method.
1719   void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1720                      GlobalDecl GD, const ThunkInfo &Thunk,
1721                      bool IsUnprototyped);
1722 
1723   llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1724                                        const CGFunctionInfo &FnInfo,
1725                                        GlobalDecl GD, const ThunkInfo &Thunk);
1726 
1727   void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1728                         FunctionArgList &Args);
1729 
1730   void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
1731 
1732   /// Struct with all information about dynamic [sub]class needed to set vptr.
1733   struct VPtr {
1734     BaseSubobject Base;
1735     const CXXRecordDecl *NearestVBase;
1736     CharUnits OffsetFromNearestVBase;
1737     const CXXRecordDecl *VTableClass;
1738   };
1739 
1740   /// Initialize the vtable pointer of the given subobject.
1741   void InitializeVTablePointer(const VPtr &vptr);
1742 
1743   typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
1744 
1745   typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1746   VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1747 
1748   void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1749                          CharUnits OffsetFromNearestVBase,
1750                          bool BaseIsNonVirtualPrimaryBase,
1751                          const CXXRecordDecl *VTableClass,
1752                          VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
1753 
1754   void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
1755 
1756   /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1757   /// to by This.
1758   llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1759                             const CXXRecordDecl *VTableClass);
1760 
1761   enum CFITypeCheckKind {
1762     CFITCK_VCall,
1763     CFITCK_NVCall,
1764     CFITCK_DerivedCast,
1765     CFITCK_UnrelatedCast,
1766     CFITCK_ICall,
1767   };
1768 
1769   /// \brief Derived is the presumed address of an object of type T after a
1770   /// cast. If T is a polymorphic class type, emit a check that the virtual
1771   /// table for Derived belongs to a class derived from T.
1772   void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
1773                                  bool MayBeNull, CFITypeCheckKind TCK,
1774                                  SourceLocation Loc);
1775 
1776   /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1777   /// If vptr CFI is enabled, emit a check that VTable is valid.
1778   void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
1779                                  CFITypeCheckKind TCK, SourceLocation Loc);
1780 
1781   /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
1782   /// RD using llvm.type.test.
1783   void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1784                           CFITypeCheckKind TCK, SourceLocation Loc);
1785 
1786   /// If whole-program virtual table optimization is enabled, emit an assumption
1787   /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1788   /// enabled, emit a check that VTable is a member of RD's type identifier.
1789   void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1790                                     llvm::Value *VTable, SourceLocation Loc);
1791 
1792   /// Returns whether we should perform a type checked load when loading a
1793   /// virtual function for virtual calls to members of RD. This is generally
1794   /// true when both vcall CFI and whole-program-vtables are enabled.
1795   bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1796 
1797   /// Emit a type checked load from the given vtable.
1798   llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1799                                          uint64_t VTableByteOffset);
1800 
1801   /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1802   /// given phase of destruction for a destructor.  The end result
1803   /// should call destructors on members and base classes in reverse
1804   /// order of their construction.
1805   void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
1806 
1807   /// ShouldInstrumentFunction - Return true if the current function should be
1808   /// instrumented with __cyg_profile_func_* calls
1809   bool ShouldInstrumentFunction();
1810 
1811   /// ShouldXRayInstrument - Return true if the current function should be
1812   /// instrumented with XRay nop sleds.
1813   bool ShouldXRayInstrumentFunction() const;
1814 
1815   /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
1816   /// XRay custom event handling calls.
1817   bool AlwaysEmitXRayCustomEvents() const;
1818 
1819   /// AlwaysEmitXRayTypedEvents - Return true if clang must unconditionally emit
1820   /// XRay typed event handling calls.
1821   bool AlwaysEmitXRayTypedEvents() const;
1822 
1823   /// Encode an address into a form suitable for use in a function prologue.
1824   llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
1825                                              llvm::Constant *Addr);
1826 
1827   /// Decode an address used in a function prologue, encoded by \c
1828   /// EncodeAddrForUseInPrologue.
1829   llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
1830                                         llvm::Value *EncodedAddr);
1831 
1832   /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1833   /// arguments for the given function. This is also responsible for naming the
1834   /// LLVM function arguments.
1835   void EmitFunctionProlog(const CGFunctionInfo &FI,
1836                           llvm::Function *Fn,
1837                           const FunctionArgList &Args);
1838 
1839   /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1840   /// given temporary.
1841   void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1842                           SourceLocation EndLoc);
1843 
1844   /// Emit a test that checks if the return value \p RV is nonnull.
1845   void EmitReturnValueCheck(llvm::Value *RV);
1846 
1847   /// EmitStartEHSpec - Emit the start of the exception spec.
1848   void EmitStartEHSpec(const Decl *D);
1849 
1850   /// EmitEndEHSpec - Emit the end of the exception spec.
1851   void EmitEndEHSpec(const Decl *D);
1852 
1853   /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1854   llvm::BasicBlock *getTerminateLandingPad();
1855 
1856   /// getTerminateLandingPad - Return a cleanup funclet that just calls
1857   /// terminate.
1858   llvm::BasicBlock *getTerminateFunclet();
1859 
1860   /// getTerminateHandler - Return a handler (not a landing pad, just
1861   /// a catch handler) that just calls terminate.  This is used when
1862   /// a terminate scope encloses a try.
1863   llvm::BasicBlock *getTerminateHandler();
1864 
1865   llvm::Type *ConvertTypeForMem(QualType T);
1866   llvm::Type *ConvertType(QualType T);
1867   llvm::Type *ConvertType(const TypeDecl *T) {
1868     return ConvertType(getContext().getTypeDeclType(T));
1869   }
1870 
1871   /// LoadObjCSelf - Load the value of self. This function is only valid while
1872   /// generating code for an Objective-C method.
1873   llvm::Value *LoadObjCSelf();
1874 
1875   /// TypeOfSelfObject - Return type of object that this self represents.
1876   QualType TypeOfSelfObject();
1877 
1878   /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
1879   static TypeEvaluationKind getEvaluationKind(QualType T);
1880 
1881   static bool hasScalarEvaluationKind(QualType T) {
1882     return getEvaluationKind(T) == TEK_Scalar;
1883   }
1884 
1885   static bool hasAggregateEvaluationKind(QualType T) {
1886     return getEvaluationKind(T) == TEK_Aggregate;
1887   }
1888 
1889   /// createBasicBlock - Create an LLVM basic block.
1890   llvm::BasicBlock *createBasicBlock(const Twine &name = "",
1891                                      llvm::Function *parent = nullptr,
1892                                      llvm::BasicBlock *before = nullptr) {
1893     return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
1894   }
1895 
1896   /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1897   /// label maps to.
1898   JumpDest getJumpDestForLabel(const LabelDecl *S);
1899 
1900   /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1901   /// another basic block, simplify it. This assumes that no other code could
1902   /// potentially reference the basic block.
1903   void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1904 
1905   /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1906   /// adding a fall-through branch from the current insert block if
1907   /// necessary. It is legal to call this function even if there is no current
1908   /// insertion point.
1909   ///
1910   /// IsFinished - If true, indicates that the caller has finished emitting
1911   /// branches to the given block and does not expect to emit code into it. This
1912   /// means the block can be ignored if it is unreachable.
1913   void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
1914 
1915   /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1916   /// near its uses, and leave the insertion point in it.
1917   void EmitBlockAfterUses(llvm::BasicBlock *BB);
1918 
1919   /// EmitBranch - Emit a branch to the specified basic block from the current
1920   /// insert block, taking care to avoid creation of branches from dummy
1921   /// blocks. It is legal to call this function even if there is no current
1922   /// insertion point.
1923   ///
1924   /// This function clears the current insertion point. The caller should follow
1925   /// calls to this function with calls to Emit*Block prior to generation new
1926   /// code.
1927   void EmitBranch(llvm::BasicBlock *Block);
1928 
1929   /// HaveInsertPoint - True if an insertion point is defined. If not, this
1930   /// indicates that the current code being emitted is unreachable.
1931   bool HaveInsertPoint() const {
1932     return Builder.GetInsertBlock() != nullptr;
1933   }
1934 
1935   /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1936   /// emitted IR has a place to go. Note that by definition, if this function
1937   /// creates a block then that block is unreachable; callers may do better to
1938   /// detect when no insertion point is defined and simply skip IR generation.
1939   void EnsureInsertPoint() {
1940     if (!HaveInsertPoint())
1941       EmitBlock(createBasicBlock());
1942   }
1943 
1944   /// ErrorUnsupported - Print out an error that codegen doesn't support the
1945   /// specified stmt yet.
1946   void ErrorUnsupported(const Stmt *S, const char *Type);
1947 
1948   //===--------------------------------------------------------------------===//
1949   //                                  Helpers
1950   //===--------------------------------------------------------------------===//
1951 
1952   LValue MakeAddrLValue(Address Addr, QualType T,
1953                         AlignmentSource Source = AlignmentSource::Type) {
1954     return LValue::MakeAddr(Addr, T, getContext(), LValueBaseInfo(Source),
1955                             CGM.getTBAAAccessInfo(T));
1956   }
1957 
1958   LValue MakeAddrLValue(Address Addr, QualType T, LValueBaseInfo BaseInfo,
1959                         TBAAAccessInfo TBAAInfo) {
1960     return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
1961   }
1962 
1963   LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1964                         AlignmentSource Source = AlignmentSource::Type) {
1965     return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1966                             LValueBaseInfo(Source), CGM.getTBAAAccessInfo(T));
1967   }
1968 
1969   LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1970                         LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo) {
1971     return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1972                             BaseInfo, TBAAInfo);
1973   }
1974 
1975   LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
1976   LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
1977   CharUnits getNaturalTypeAlignment(QualType T,
1978                                     LValueBaseInfo *BaseInfo = nullptr,
1979                                     TBAAAccessInfo *TBAAInfo = nullptr,
1980                                     bool forPointeeType = false);
1981   CharUnits getNaturalPointeeTypeAlignment(QualType T,
1982                                            LValueBaseInfo *BaseInfo = nullptr,
1983                                            TBAAAccessInfo *TBAAInfo = nullptr);
1984 
1985   Address EmitLoadOfReference(LValue RefLVal,
1986                               LValueBaseInfo *PointeeBaseInfo = nullptr,
1987                               TBAAAccessInfo *PointeeTBAAInfo = nullptr);
1988   LValue EmitLoadOfReferenceLValue(LValue RefLVal);
1989   LValue EmitLoadOfReferenceLValue(Address RefAddr, QualType RefTy,
1990                                    AlignmentSource Source =
1991                                        AlignmentSource::Type) {
1992     LValue RefLVal = MakeAddrLValue(RefAddr, RefTy, LValueBaseInfo(Source),
1993                                     CGM.getTBAAAccessInfo(RefTy));
1994     return EmitLoadOfReferenceLValue(RefLVal);
1995   }
1996 
1997   Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
1998                             LValueBaseInfo *BaseInfo = nullptr,
1999                             TBAAAccessInfo *TBAAInfo = nullptr);
2000   LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
2001 
2002   /// CreateTempAlloca - This creates an alloca and inserts it into the entry
2003   /// block if \p ArraySize is nullptr, otherwise inserts it at the current
2004   /// insertion point of the builder. The caller is responsible for setting an
2005   /// appropriate alignment on
2006   /// the alloca.
2007   ///
2008   /// \p ArraySize is the number of array elements to be allocated if it
2009   ///    is not nullptr.
2010   ///
2011   /// LangAS::Default is the address space of pointers to local variables and
2012   /// temporaries, as exposed in the source language. In certain
2013   /// configurations, this is not the same as the alloca address space, and a
2014   /// cast is needed to lift the pointer from the alloca AS into
2015   /// LangAS::Default. This can happen when the target uses a restricted
2016   /// address space for the stack but the source language requires
2017   /// LangAS::Default to be a generic address space. The latter condition is
2018   /// common for most programming languages; OpenCL is an exception in that
2019   /// LangAS::Default is the private address space, which naturally maps
2020   /// to the stack.
2021   ///
2022   /// Because the address of a temporary is often exposed to the program in
2023   /// various ways, this function will perform the cast by default. The cast
2024   /// may be avoided by passing false as \p CastToDefaultAddrSpace; this is
2025   /// more efficient if the caller knows that the address will not be exposed.
2026   llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
2027                                      llvm::Value *ArraySize = nullptr);
2028   Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
2029                            const Twine &Name = "tmp",
2030                            llvm::Value *ArraySize = nullptr,
2031                            bool CastToDefaultAddrSpace = true);
2032 
2033   /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
2034   /// default ABI alignment of the given LLVM type.
2035   ///
2036   /// IMPORTANT NOTE: This is *not* generally the right alignment for
2037   /// any given AST type that happens to have been lowered to the
2038   /// given IR type.  This should only ever be used for function-local,
2039   /// IR-driven manipulations like saving and restoring a value.  Do
2040   /// not hand this address off to arbitrary IRGen routines, and especially
2041   /// do not pass it as an argument to a function that might expect a
2042   /// properly ABI-aligned value.
2043   Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
2044                                        const Twine &Name = "tmp");
2045 
2046   /// InitTempAlloca - Provide an initial value for the given alloca which
2047   /// will be observable at all locations in the function.
2048   ///
2049   /// The address should be something that was returned from one of
2050   /// the CreateTempAlloca or CreateMemTemp routines, and the
2051   /// initializer must be valid in the entry block (i.e. it must
2052   /// either be a constant or an argument value).
2053   void InitTempAlloca(Address Alloca, llvm::Value *Value);
2054 
2055   /// CreateIRTemp - Create a temporary IR object of the given type, with
2056   /// appropriate alignment. This routine should only be used when an temporary
2057   /// value needs to be stored into an alloca (for example, to avoid explicit
2058   /// PHI construction), but the type is the IR type, not the type appropriate
2059   /// for storing in memory.
2060   ///
2061   /// That is, this is exactly equivalent to CreateMemTemp, but calling
2062   /// ConvertType instead of ConvertTypeForMem.
2063   Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
2064 
2065   /// CreateMemTemp - Create a temporary memory object of the given type, with
2066   /// appropriate alignment. Cast it to the default address space if
2067   /// \p CastToDefaultAddrSpace is true.
2068   Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
2069                         bool CastToDefaultAddrSpace = true);
2070   Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
2071                         bool CastToDefaultAddrSpace = true);
2072 
2073   /// CreateAggTemp - Create a temporary memory object for the given
2074   /// aggregate type.
2075   AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
2076     return AggValueSlot::forAddr(CreateMemTemp(T, Name),
2077                                  T.getQualifiers(),
2078                                  AggValueSlot::IsNotDestructed,
2079                                  AggValueSlot::DoesNotNeedGCBarriers,
2080                                  AggValueSlot::IsNotAliased,
2081                                  AggValueSlot::DoesNotOverlap);
2082   }
2083 
2084   /// Emit a cast to void* in the appropriate address space.
2085   llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2086 
2087   /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2088   /// expression and compare the result against zero, returning an Int1Ty value.
2089   llvm::Value *EvaluateExprAsBool(const Expr *E);
2090 
2091   /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2092   void EmitIgnoredExpr(const Expr *E);
2093 
2094   /// EmitAnyExpr - Emit code to compute the specified expression which can have
2095   /// any type.  The result is returned as an RValue struct.  If this is an
2096   /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2097   /// the result should be returned.
2098   ///
2099   /// \param ignoreResult True if the resulting value isn't used.
2100   RValue EmitAnyExpr(const Expr *E,
2101                      AggValueSlot aggSlot = AggValueSlot::ignored(),
2102                      bool ignoreResult = false);
2103 
2104   // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2105   // or the value of the expression, depending on how va_list is defined.
2106   Address EmitVAListRef(const Expr *E);
2107 
2108   /// Emit a "reference" to a __builtin_ms_va_list; this is
2109   /// always the value of the expression, because a __builtin_ms_va_list is a
2110   /// pointer to a char.
2111   Address EmitMSVAListRef(const Expr *E);
2112 
2113   /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
2114   /// always be accessible even if no aggregate location is provided.
2115   RValue EmitAnyExprToTemp(const Expr *E);
2116 
2117   /// EmitAnyExprToMem - Emits the code necessary to evaluate an
2118   /// arbitrary expression into the given memory location.
2119   void EmitAnyExprToMem(const Expr *E, Address Location,
2120                         Qualifiers Quals, bool IsInitializer);
2121 
2122   void EmitAnyExprToExn(const Expr *E, Address Addr);
2123 
2124   /// EmitExprAsInit - Emits the code necessary to initialize a
2125   /// location in memory with the given initializer.
2126   void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
2127                       bool capturedByInit);
2128 
2129   /// hasVolatileMember - returns true if aggregate type has a volatile
2130   /// member.
2131   bool hasVolatileMember(QualType T) {
2132     if (const RecordType *RT = T->getAs<RecordType>()) {
2133       const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2134       return RD->hasVolatileMember();
2135     }
2136     return false;
2137   }
2138 
2139   /// Determine whether a return value slot may overlap some other object.
2140   AggValueSlot::Overlap_t overlapForReturnValue() {
2141     // FIXME: Assuming no overlap here breaks guaranteed copy elision for base
2142     // class subobjects. These cases may need to be revisited depending on the
2143     // resolution of the relevant core issue.
2144     return AggValueSlot::DoesNotOverlap;
2145   }
2146 
2147   /// Determine whether a field initialization may overlap some other object.
2148   AggValueSlot::Overlap_t overlapForFieldInit(const FieldDecl *FD) {
2149     // FIXME: These cases can result in overlap as a result of P0840R0's
2150     // [[no_unique_address]] attribute. We can still infer NoOverlap in the
2151     // presence of that attribute if the field is within the nvsize of its
2152     // containing class, because non-virtual subobjects are initialized in
2153     // address order.
2154     return AggValueSlot::DoesNotOverlap;
2155   }
2156 
2157   /// Determine whether a base class initialization may overlap some other
2158   /// object.
2159   AggValueSlot::Overlap_t overlapForBaseInit(const CXXRecordDecl *RD,
2160                                              const CXXRecordDecl *BaseRD,
2161                                              bool IsVirtual);
2162 
2163   /// Emit an aggregate assignment.
2164   void EmitAggregateAssign(LValue Dest, LValue Src, QualType EltTy) {
2165     bool IsVolatile = hasVolatileMember(EltTy);
2166     EmitAggregateCopy(Dest, Src, EltTy, AggValueSlot::MayOverlap, IsVolatile);
2167   }
2168 
2169   void EmitAggregateCopyCtor(LValue Dest, LValue Src,
2170                              AggValueSlot::Overlap_t MayOverlap) {
2171     EmitAggregateCopy(Dest, Src, Src.getType(), MayOverlap);
2172   }
2173 
2174   /// EmitAggregateCopy - Emit an aggregate copy.
2175   ///
2176   /// \param isVolatile \c true iff either the source or the destination is
2177   ///        volatile.
2178   /// \param MayOverlap Whether the tail padding of the destination might be
2179   ///        occupied by some other object. More efficient code can often be
2180   ///        generated if not.
2181   void EmitAggregateCopy(LValue Dest, LValue Src, QualType EltTy,
2182                          AggValueSlot::Overlap_t MayOverlap,
2183                          bool isVolatile = false);
2184 
2185   /// GetAddrOfLocalVar - Return the address of a local variable.
2186   Address GetAddrOfLocalVar(const VarDecl *VD) {
2187     auto it = LocalDeclMap.find(VD);
2188     assert(it != LocalDeclMap.end() &&
2189            "Invalid argument to GetAddrOfLocalVar(), no decl!");
2190     return it->second;
2191   }
2192 
2193   /// Given an opaque value expression, return its LValue mapping if it exists,
2194   /// otherwise create one.
2195   LValue getOrCreateOpaqueLValueMapping(const OpaqueValueExpr *e);
2196 
2197   /// Given an opaque value expression, return its RValue mapping if it exists,
2198   /// otherwise create one.
2199   RValue getOrCreateOpaqueRValueMapping(const OpaqueValueExpr *e);
2200 
2201   /// Get the index of the current ArrayInitLoopExpr, if any.
2202   llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2203 
2204   /// getAccessedFieldNo - Given an encoded value and a result number, return
2205   /// the input field number being accessed.
2206   static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2207 
2208   llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
2209   llvm::BasicBlock *GetIndirectGotoBlock();
2210 
2211   /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2212   static bool IsWrappedCXXThis(const Expr *E);
2213 
2214   /// EmitNullInitialization - Generate code to set a value of the given type to
2215   /// null, If the type contains data member pointers, they will be initialized
2216   /// to -1 in accordance with the Itanium C++ ABI.
2217   void EmitNullInitialization(Address DestPtr, QualType Ty);
2218 
2219   /// Emits a call to an LLVM variable-argument intrinsic, either
2220   /// \c llvm.va_start or \c llvm.va_end.
2221   /// \param ArgValue A reference to the \c va_list as emitted by either
2222   /// \c EmitVAListRef or \c EmitMSVAListRef.
2223   /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2224   /// calls \c llvm.va_end.
2225   llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2226 
2227   /// Generate code to get an argument from the passed in pointer
2228   /// and update it accordingly.
2229   /// \param VE The \c VAArgExpr for which to generate code.
2230   /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2231   /// either \c EmitVAListRef or \c EmitMSVAListRef.
2232   /// \returns A pointer to the argument.
2233   // FIXME: We should be able to get rid of this method and use the va_arg
2234   // instruction in LLVM instead once it works well enough.
2235   Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
2236 
2237   /// emitArrayLength - Compute the length of an array, even if it's a
2238   /// VLA, and drill down to the base element type.
2239   llvm::Value *emitArrayLength(const ArrayType *arrayType,
2240                                QualType &baseType,
2241                                Address &addr);
2242 
2243   /// EmitVLASize - Capture all the sizes for the VLA expressions in
2244   /// the given variably-modified type and store them in the VLASizeMap.
2245   ///
2246   /// This function can be called with a null (unreachable) insert point.
2247   void EmitVariablyModifiedType(QualType Ty);
2248 
2249   struct VlaSizePair {
2250     llvm::Value *NumElts;
2251     QualType Type;
2252 
2253     VlaSizePair(llvm::Value *NE, QualType T) : NumElts(NE), Type(T) {}
2254   };
2255 
2256   /// Return the number of elements for a single dimension
2257   /// for the given array type.
2258   VlaSizePair getVLAElements1D(const VariableArrayType *vla);
2259   VlaSizePair getVLAElements1D(QualType vla);
2260 
2261   /// Returns an LLVM value that corresponds to the size,
2262   /// in non-variably-sized elements, of a variable length array type,
2263   /// plus that largest non-variably-sized element type.  Assumes that
2264   /// the type has already been emitted with EmitVariablyModifiedType.
2265   VlaSizePair getVLASize(const VariableArrayType *vla);
2266   VlaSizePair getVLASize(QualType vla);
2267 
2268   /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2269   /// generating code for an C++ member function.
2270   llvm::Value *LoadCXXThis() {
2271     assert(CXXThisValue && "no 'this' value for this function");
2272     return CXXThisValue;
2273   }
2274   Address LoadCXXThisAddress();
2275 
2276   /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2277   /// virtual bases.
2278   // FIXME: Every place that calls LoadCXXVTT is something
2279   // that needs to be abstracted properly.
2280   llvm::Value *LoadCXXVTT() {
2281     assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2282     return CXXStructorImplicitParamValue;
2283   }
2284 
2285   /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
2286   /// complete class to the given direct base.
2287   Address
2288   GetAddressOfDirectBaseInCompleteClass(Address Value,
2289                                         const CXXRecordDecl *Derived,
2290                                         const CXXRecordDecl *Base,
2291                                         bool BaseIsVirtual);
2292 
2293   static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2294 
2295   /// GetAddressOfBaseClass - This function will add the necessary delta to the
2296   /// load of 'this' and returns address of the base class.
2297   Address GetAddressOfBaseClass(Address Value,
2298                                 const CXXRecordDecl *Derived,
2299                                 CastExpr::path_const_iterator PathBegin,
2300                                 CastExpr::path_const_iterator PathEnd,
2301                                 bool NullCheckValue, SourceLocation Loc);
2302 
2303   Address GetAddressOfDerivedClass(Address Value,
2304                                    const CXXRecordDecl *Derived,
2305                                    CastExpr::path_const_iterator PathBegin,
2306                                    CastExpr::path_const_iterator PathEnd,
2307                                    bool NullCheckValue);
2308 
2309   /// GetVTTParameter - Return the VTT parameter that should be passed to a
2310   /// base constructor/destructor with virtual bases.
2311   /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2312   /// to ItaniumCXXABI.cpp together with all the references to VTT.
2313   llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2314                                bool Delegating);
2315 
2316   void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2317                                       CXXCtorType CtorType,
2318                                       const FunctionArgList &Args,
2319                                       SourceLocation Loc);
2320   // It's important not to confuse this and the previous function. Delegating
2321   // constructors are the C++0x feature. The constructor delegate optimization
2322   // is used to reduce duplication in the base and complete consturctors where
2323   // they are substantially the same.
2324   void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2325                                         const FunctionArgList &Args);
2326 
2327   /// Emit a call to an inheriting constructor (that is, one that invokes a
2328   /// constructor inherited from a base class) by inlining its definition. This
2329   /// is necessary if the ABI does not support forwarding the arguments to the
2330   /// base class constructor (because they're variadic or similar).
2331   void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2332                                                CXXCtorType CtorType,
2333                                                bool ForVirtualBase,
2334                                                bool Delegating,
2335                                                CallArgList &Args);
2336 
2337   /// Emit a call to a constructor inherited from a base class, passing the
2338   /// current constructor's arguments along unmodified (without even making
2339   /// a copy).
2340   void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2341                                        bool ForVirtualBase, Address This,
2342                                        bool InheritedFromVBase,
2343                                        const CXXInheritedCtorInitExpr *E);
2344 
2345   void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2346                               bool ForVirtualBase, bool Delegating,
2347                               Address This, const CXXConstructExpr *E,
2348                               AggValueSlot::Overlap_t Overlap);
2349 
2350   void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2351                               bool ForVirtualBase, bool Delegating,
2352                               Address This, CallArgList &Args,
2353                               AggValueSlot::Overlap_t Overlap);
2354 
2355   /// Emit assumption load for all bases. Requires to be be called only on
2356   /// most-derived class and not under construction of the object.
2357   void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2358 
2359   /// Emit assumption that vptr load == global vtable.
2360   void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2361 
2362   void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
2363                                       Address This, Address Src,
2364                                       const CXXConstructExpr *E);
2365 
2366   void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2367                                   const ArrayType *ArrayTy,
2368                                   Address ArrayPtr,
2369                                   const CXXConstructExpr *E,
2370                                   bool ZeroInitialization = false);
2371 
2372   void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2373                                   llvm::Value *NumElements,
2374                                   Address ArrayPtr,
2375                                   const CXXConstructExpr *E,
2376                                   bool ZeroInitialization = false);
2377 
2378   static Destroyer destroyCXXObject;
2379 
2380   void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
2381                              bool ForVirtualBase, bool Delegating,
2382                              Address This);
2383 
2384   void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
2385                                llvm::Type *ElementTy, Address NewPtr,
2386                                llvm::Value *NumElements,
2387                                llvm::Value *AllocSizeWithoutCookie);
2388 
2389   void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
2390                         Address Ptr);
2391 
2392   llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2393   void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2394 
2395   llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
2396   void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
2397 
2398   void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
2399                       QualType DeleteTy, llvm::Value *NumElements = nullptr,
2400                       CharUnits CookieSize = CharUnits());
2401 
2402   RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2403                                   const CallExpr *TheCallExpr, bool IsDelete);
2404 
2405   llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2406   llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2407   Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
2408 
2409   /// \brief Situations in which we might emit a check for the suitability of a
2410   ///        pointer or glvalue.
2411   enum TypeCheckKind {
2412     /// Checking the operand of a load. Must be suitably sized and aligned.
2413     TCK_Load,
2414     /// Checking the destination of a store. Must be suitably sized and aligned.
2415     TCK_Store,
2416     /// Checking the bound value in a reference binding. Must be suitably sized
2417     /// and aligned, but is not required to refer to an object (until the
2418     /// reference is used), per core issue 453.
2419     TCK_ReferenceBinding,
2420     /// Checking the object expression in a non-static data member access. Must
2421     /// be an object within its lifetime.
2422     TCK_MemberAccess,
2423     /// Checking the 'this' pointer for a call to a non-static member function.
2424     /// Must be an object within its lifetime.
2425     TCK_MemberCall,
2426     /// Checking the 'this' pointer for a constructor call.
2427     TCK_ConstructorCall,
2428     /// Checking the operand of a static_cast to a derived pointer type. Must be
2429     /// null or an object within its lifetime.
2430     TCK_DowncastPointer,
2431     /// Checking the operand of a static_cast to a derived reference type. Must
2432     /// be an object within its lifetime.
2433     TCK_DowncastReference,
2434     /// Checking the operand of a cast to a base object. Must be suitably sized
2435     /// and aligned.
2436     TCK_Upcast,
2437     /// Checking the operand of a cast to a virtual base object. Must be an
2438     /// object within its lifetime.
2439     TCK_UpcastToVirtualBase,
2440     /// Checking the value assigned to a _Nonnull pointer. Must not be null.
2441     TCK_NonnullAssign,
2442     /// Checking the operand of a dynamic_cast or a typeid expression.  Must be
2443     /// null or an object within its lifetime.
2444     TCK_DynamicOperation
2445   };
2446 
2447   /// Determine whether the pointer type check \p TCK permits null pointers.
2448   static bool isNullPointerAllowed(TypeCheckKind TCK);
2449 
2450   /// Determine whether the pointer type check \p TCK requires a vptr check.
2451   static bool isVptrCheckRequired(TypeCheckKind TCK, QualType Ty);
2452 
2453   /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2454   /// calls to EmitTypeCheck can be skipped.
2455   bool sanitizePerformTypeCheck() const;
2456 
2457   /// \brief Emit a check that \p V is the address of storage of the
2458   /// appropriate size and alignment for an object of type \p Type.
2459   void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
2460                      QualType Type, CharUnits Alignment = CharUnits::Zero(),
2461                      SanitizerSet SkippedChecks = SanitizerSet());
2462 
2463   /// \brief Emit a check that \p Base points into an array object, which
2464   /// we can access at index \p Index. \p Accessed should be \c false if we
2465   /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2466   void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2467                        QualType IndexType, bool Accessed);
2468 
2469   llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2470                                        bool isInc, bool isPre);
2471   ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2472                                          bool isInc, bool isPre);
2473 
2474   void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
2475                                llvm::Value *OffsetValue = nullptr) {
2476     Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2477                                       OffsetValue);
2478   }
2479 
2480   /// Converts Location to a DebugLoc, if debug information is enabled.
2481   llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2482 
2483 
2484   //===--------------------------------------------------------------------===//
2485   //                            Declaration Emission
2486   //===--------------------------------------------------------------------===//
2487 
2488   /// EmitDecl - Emit a declaration.
2489   ///
2490   /// This function can be called with a null (unreachable) insert point.
2491   void EmitDecl(const Decl &D);
2492 
2493   /// EmitVarDecl - Emit a local variable declaration.
2494   ///
2495   /// This function can be called with a null (unreachable) insert point.
2496   void EmitVarDecl(const VarDecl &D);
2497 
2498   void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
2499                       bool capturedByInit);
2500 
2501   typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2502                              llvm::Value *Address);
2503 
2504   /// \brief Determine whether the given initializer is trivial in the sense
2505   /// that it requires no code to be generated.
2506   bool isTrivialInitializer(const Expr *Init);
2507 
2508   /// EmitAutoVarDecl - Emit an auto variable declaration.
2509   ///
2510   /// This function can be called with a null (unreachable) insert point.
2511   void EmitAutoVarDecl(const VarDecl &D);
2512 
2513   class AutoVarEmission {
2514     friend class CodeGenFunction;
2515 
2516     const VarDecl *Variable;
2517 
2518     /// The address of the alloca.  Invalid if the variable was emitted
2519     /// as a global constant.
2520     Address Addr;
2521 
2522     llvm::Value *NRVOFlag;
2523 
2524     /// True if the variable is a __block variable.
2525     bool IsByRef;
2526 
2527     /// True if the variable is of aggregate type and has a constant
2528     /// initializer.
2529     bool IsConstantAggregate;
2530 
2531     /// Non-null if we should use lifetime annotations.
2532     llvm::Value *SizeForLifetimeMarkers;
2533 
2534     struct Invalid {};
2535     AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
2536 
2537     AutoVarEmission(const VarDecl &variable)
2538       : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
2539         IsByRef(false), IsConstantAggregate(false),
2540         SizeForLifetimeMarkers(nullptr) {}
2541 
2542     bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
2543 
2544   public:
2545     static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2546 
2547     bool useLifetimeMarkers() const {
2548       return SizeForLifetimeMarkers != nullptr;
2549     }
2550     llvm::Value *getSizeForLifetimeMarkers() const {
2551       assert(useLifetimeMarkers());
2552       return SizeForLifetimeMarkers;
2553     }
2554 
2555     /// Returns the raw, allocated address, which is not necessarily
2556     /// the address of the object itself.
2557     Address getAllocatedAddress() const {
2558       return Addr;
2559     }
2560 
2561     /// Returns the address of the object within this declaration.
2562     /// Note that this does not chase the forwarding pointer for
2563     /// __block decls.
2564     Address getObjectAddress(CodeGenFunction &CGF) const {
2565       if (!IsByRef) return Addr;
2566 
2567       return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
2568     }
2569   };
2570   AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2571   void EmitAutoVarInit(const AutoVarEmission &emission);
2572   void EmitAutoVarCleanups(const AutoVarEmission &emission);
2573   void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2574                               QualType::DestructionKind dtorKind);
2575 
2576   /// Emits the alloca and debug information for the size expressions for each
2577   /// dimension of an array. It registers the association of its (1-dimensional)
2578   /// QualTypes and size expression's debug node, so that CGDebugInfo can
2579   /// reference this node when creating the DISubrange object to describe the
2580   /// array types.
2581   void EmitAndRegisterVariableArrayDimensions(CGDebugInfo *DI,
2582                                               const VarDecl &D,
2583                                               bool EmitDebugInfo);
2584 
2585   void EmitStaticVarDecl(const VarDecl &D,
2586                          llvm::GlobalValue::LinkageTypes Linkage);
2587 
2588   class ParamValue {
2589     llvm::Value *Value;
2590     unsigned Alignment;
2591     ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2592   public:
2593     static ParamValue forDirect(llvm::Value *value) {
2594       return ParamValue(value, 0);
2595     }
2596     static ParamValue forIndirect(Address addr) {
2597       assert(!addr.getAlignment().isZero());
2598       return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2599     }
2600 
2601     bool isIndirect() const { return Alignment != 0; }
2602     llvm::Value *getAnyValue() const { return Value; }
2603 
2604     llvm::Value *getDirectValue() const {
2605       assert(!isIndirect());
2606       return Value;
2607     }
2608 
2609     Address getIndirectAddress() const {
2610       assert(isIndirect());
2611       return Address(Value, CharUnits::fromQuantity(Alignment));
2612     }
2613   };
2614 
2615   /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
2616   void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
2617 
2618   /// protectFromPeepholes - Protect a value that we're intending to
2619   /// store to the side, but which will probably be used later, from
2620   /// aggressive peepholing optimizations that might delete it.
2621   ///
2622   /// Pass the result to unprotectFromPeepholes to declare that
2623   /// protection is no longer required.
2624   ///
2625   /// There's no particular reason why this shouldn't apply to
2626   /// l-values, it's just that no existing peepholes work on pointers.
2627   PeepholeProtection protectFromPeepholes(RValue rvalue);
2628   void unprotectFromPeepholes(PeepholeProtection protection);
2629 
2630   void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment,
2631                                llvm::Value *OffsetValue = nullptr) {
2632     Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2633                                       OffsetValue);
2634   }
2635 
2636   //===--------------------------------------------------------------------===//
2637   //                             Statement Emission
2638   //===--------------------------------------------------------------------===//
2639 
2640   /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
2641   void EmitStopPoint(const Stmt *S);
2642 
2643   /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2644   /// this function even if there is no current insertion point.
2645   ///
2646   /// This function may clear the current insertion point; callers should use
2647   /// EnsureInsertPoint if they wish to subsequently generate code without first
2648   /// calling EmitBlock, EmitBranch, or EmitStmt.
2649   void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
2650 
2651   /// EmitSimpleStmt - Try to emit a "simple" statement which does not
2652   /// necessarily require an insertion point or debug information; typically
2653   /// because the statement amounts to a jump or a container of other
2654   /// statements.
2655   ///
2656   /// \return True if the statement was handled.
2657   bool EmitSimpleStmt(const Stmt *S);
2658 
2659   Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2660                            AggValueSlot AVS = AggValueSlot::ignored());
2661   Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2662                                        bool GetLast = false,
2663                                        AggValueSlot AVS =
2664                                                 AggValueSlot::ignored());
2665 
2666   /// EmitLabel - Emit the block for the given label. It is legal to call this
2667   /// function even if there is no current insertion point.
2668   void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
2669 
2670   void EmitLabelStmt(const LabelStmt &S);
2671   void EmitAttributedStmt(const AttributedStmt &S);
2672   void EmitGotoStmt(const GotoStmt &S);
2673   void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
2674   void EmitIfStmt(const IfStmt &S);
2675 
2676   void EmitWhileStmt(const WhileStmt &S,
2677                      ArrayRef<const Attr *> Attrs = None);
2678   void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
2679   void EmitForStmt(const ForStmt &S,
2680                    ArrayRef<const Attr *> Attrs = None);
2681   void EmitReturnStmt(const ReturnStmt &S);
2682   void EmitDeclStmt(const DeclStmt &S);
2683   void EmitBreakStmt(const BreakStmt &S);
2684   void EmitContinueStmt(const ContinueStmt &S);
2685   void EmitSwitchStmt(const SwitchStmt &S);
2686   void EmitDefaultStmt(const DefaultStmt &S);
2687   void EmitCaseStmt(const CaseStmt &S);
2688   void EmitCaseStmtRange(const CaseStmt &S);
2689   void EmitAsmStmt(const AsmStmt &S);
2690 
2691   void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
2692   void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2693   void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
2694   void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
2695   void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
2696 
2697   void EmitCoroutineBody(const CoroutineBodyStmt &S);
2698   void EmitCoreturnStmt(const CoreturnStmt &S);
2699   RValue EmitCoawaitExpr(const CoawaitExpr &E,
2700                          AggValueSlot aggSlot = AggValueSlot::ignored(),
2701                          bool ignoreResult = false);
2702   LValue EmitCoawaitLValue(const CoawaitExpr *E);
2703   RValue EmitCoyieldExpr(const CoyieldExpr &E,
2704                          AggValueSlot aggSlot = AggValueSlot::ignored(),
2705                          bool ignoreResult = false);
2706   LValue EmitCoyieldLValue(const CoyieldExpr *E);
2707   RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2708 
2709   void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2710   void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2711 
2712   void EmitCXXTryStmt(const CXXTryStmt &S);
2713   void EmitSEHTryStmt(const SEHTryStmt &S);
2714   void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
2715   void EnterSEHTryStmt(const SEHTryStmt &S);
2716   void ExitSEHTryStmt(const SEHTryStmt &S);
2717 
2718   void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
2719                               const Stmt *OutlinedStmt);
2720 
2721   llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2722                                             const SEHExceptStmt &Except);
2723 
2724   llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2725                                              const SEHFinallyStmt &Finally);
2726 
2727   void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2728                                 llvm::Value *ParentFP,
2729                                 llvm::Value *EntryEBP);
2730   llvm::Value *EmitSEHExceptionCode();
2731   llvm::Value *EmitSEHExceptionInfo();
2732   llvm::Value *EmitSEHAbnormalTermination();
2733 
2734   /// Emit simple code for OpenMP directives in Simd-only mode.
2735   void EmitSimpleOMPExecutableDirective(const OMPExecutableDirective &D);
2736 
2737   /// Scan the outlined statement for captures from the parent function. For
2738   /// each capture, mark the capture as escaped and emit a call to
2739   /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
2740   void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
2741                           bool IsFilter);
2742 
2743   /// Recovers the address of a local in a parent function. ParentVar is the
2744   /// address of the variable used in the immediate parent function. It can
2745   /// either be an alloca or a call to llvm.localrecover if there are nested
2746   /// outlined functions. ParentFP is the frame pointer of the outermost parent
2747   /// frame.
2748   Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2749                                     Address ParentVar,
2750                                     llvm::Value *ParentFP);
2751 
2752   void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
2753                            ArrayRef<const Attr *> Attrs = None);
2754 
2755   /// Controls insertion of cancellation exit blocks in worksharing constructs.
2756   class OMPCancelStackRAII {
2757     CodeGenFunction &CGF;
2758 
2759   public:
2760     OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
2761                        bool HasCancel)
2762         : CGF(CGF) {
2763       CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
2764     }
2765     ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
2766   };
2767 
2768   /// Returns calculated size of the specified type.
2769   llvm::Value *getTypeSize(QualType Ty);
2770   LValue InitCapturedStruct(const CapturedStmt &S);
2771   llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
2772   llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
2773   Address GenerateCapturedStmtArgument(const CapturedStmt &S);
2774   llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
2775   void GenerateOpenMPCapturedVars(const CapturedStmt &S,
2776                                   SmallVectorImpl<llvm::Value *> &CapturedVars);
2777   void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2778                           SourceLocation Loc);
2779   /// \brief Perform element by element copying of arrays with type \a
2780   /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2781   /// generated by \a CopyGen.
2782   ///
2783   /// \param DestAddr Address of the destination array.
2784   /// \param SrcAddr Address of the source array.
2785   /// \param OriginalType Type of destination and source arrays.
2786   /// \param CopyGen Copying procedure that copies value of single array element
2787   /// to another single array element.
2788   void EmitOMPAggregateAssign(
2789       Address DestAddr, Address SrcAddr, QualType OriginalType,
2790       const llvm::function_ref<void(Address, Address)> CopyGen);
2791   /// \brief Emit proper copying of data from one variable to another.
2792   ///
2793   /// \param OriginalType Original type of the copied variables.
2794   /// \param DestAddr Destination address.
2795   /// \param SrcAddr Source address.
2796   /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2797   /// type of the base array element).
2798   /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2799   /// the base array element).
2800   /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2801   /// DestVD.
2802   void EmitOMPCopy(QualType OriginalType,
2803                    Address DestAddr, Address SrcAddr,
2804                    const VarDecl *DestVD, const VarDecl *SrcVD,
2805                    const Expr *Copy);
2806   /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2807   /// \a X = \a E \a BO \a E.
2808   ///
2809   /// \param X Value to be updated.
2810   /// \param E Update value.
2811   /// \param BO Binary operation for update operation.
2812   /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2813   /// expression, false otherwise.
2814   /// \param AO Atomic ordering of the generated atomic instructions.
2815   /// \param CommonGen Code generator for complex expressions that cannot be
2816   /// expressed through atomicrmw instruction.
2817   /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2818   /// generated, <false, RValue::get(nullptr)> otherwise.
2819   std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
2820       LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2821       llvm::AtomicOrdering AO, SourceLocation Loc,
2822       const llvm::function_ref<RValue(RValue)> CommonGen);
2823   bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
2824                                  OMPPrivateScope &PrivateScope);
2825   void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2826                             OMPPrivateScope &PrivateScope);
2827   void EmitOMPUseDevicePtrClause(
2828       const OMPClause &C, OMPPrivateScope &PrivateScope,
2829       const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
2830   /// \brief Emit code for copyin clause in \a D directive. The next code is
2831   /// generated at the start of outlined functions for directives:
2832   /// \code
2833   /// threadprivate_var1 = master_threadprivate_var1;
2834   /// operator=(threadprivate_var2, master_threadprivate_var2);
2835   /// ...
2836   /// __kmpc_barrier(&loc, global_tid);
2837   /// \endcode
2838   ///
2839   /// \param D OpenMP directive possibly with 'copyin' clause(s).
2840   /// \returns true if at least one copyin variable is found, false otherwise.
2841   bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
2842   /// \brief Emit initial code for lastprivate variables. If some variable is
2843   /// not also firstprivate, then the default initialization is used. Otherwise
2844   /// initialization of this variable is performed by EmitOMPFirstprivateClause
2845   /// method.
2846   ///
2847   /// \param D Directive that may have 'lastprivate' directives.
2848   /// \param PrivateScope Private scope for capturing lastprivate variables for
2849   /// proper codegen in internal captured statement.
2850   ///
2851   /// \returns true if there is at least one lastprivate variable, false
2852   /// otherwise.
2853   bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2854                                     OMPPrivateScope &PrivateScope);
2855   /// \brief Emit final copying of lastprivate values to original variables at
2856   /// the end of the worksharing or simd directive.
2857   ///
2858   /// \param D Directive that has at least one 'lastprivate' directives.
2859   /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2860   /// it is the last iteration of the loop code in associated directive, or to
2861   /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
2862   void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
2863                                      bool NoFinals,
2864                                      llvm::Value *IsLastIterCond = nullptr);
2865   /// Emit initial code for linear clauses.
2866   void EmitOMPLinearClause(const OMPLoopDirective &D,
2867                            CodeGenFunction::OMPPrivateScope &PrivateScope);
2868   /// Emit final code for linear clauses.
2869   /// \param CondGen Optional conditional code for final part of codegen for
2870   /// linear clause.
2871   void EmitOMPLinearClauseFinal(
2872       const OMPLoopDirective &D,
2873       const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
2874   /// \brief Emit initial code for reduction variables. Creates reduction copies
2875   /// and initializes them with the values according to OpenMP standard.
2876   ///
2877   /// \param D Directive (possibly) with the 'reduction' clause.
2878   /// \param PrivateScope Private scope for capturing reduction variables for
2879   /// proper codegen in internal captured statement.
2880   ///
2881   void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2882                                   OMPPrivateScope &PrivateScope);
2883   /// \brief Emit final update of reduction values to original variables at
2884   /// the end of the directive.
2885   ///
2886   /// \param D Directive that has at least one 'reduction' directives.
2887   /// \param ReductionKind The kind of reduction to perform.
2888   void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
2889                                    const OpenMPDirectiveKind ReductionKind);
2890   /// \brief Emit initial code for linear variables. Creates private copies
2891   /// and initializes them with the values according to OpenMP standard.
2892   ///
2893   /// \param D Directive (possibly) with the 'linear' clause.
2894   /// \return true if at least one linear variable is found that should be
2895   /// initialized with the value of the original variable, false otherwise.
2896   bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
2897 
2898   typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2899                                         llvm::Value * /*OutlinedFn*/,
2900                                         const OMPTaskDataTy & /*Data*/)>
2901       TaskGenTy;
2902   void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2903                                  const OpenMPDirectiveKind CapturedRegion,
2904                                  const RegionCodeGenTy &BodyGen,
2905                                  const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
2906   struct OMPTargetDataInfo {
2907     Address BasePointersArray = Address::invalid();
2908     Address PointersArray = Address::invalid();
2909     Address SizesArray = Address::invalid();
2910     unsigned NumberOfTargetItems = 0;
2911     explicit OMPTargetDataInfo() = default;
2912     OMPTargetDataInfo(Address BasePointersArray, Address PointersArray,
2913                       Address SizesArray, unsigned NumberOfTargetItems)
2914         : BasePointersArray(BasePointersArray), PointersArray(PointersArray),
2915           SizesArray(SizesArray), NumberOfTargetItems(NumberOfTargetItems) {}
2916   };
2917   void EmitOMPTargetTaskBasedDirective(const OMPExecutableDirective &S,
2918                                        const RegionCodeGenTy &BodyGen,
2919                                        OMPTargetDataInfo &InputInfo);
2920 
2921   void EmitOMPParallelDirective(const OMPParallelDirective &S);
2922   void EmitOMPSimdDirective(const OMPSimdDirective &S);
2923   void EmitOMPForDirective(const OMPForDirective &S);
2924   void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
2925   void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
2926   void EmitOMPSectionDirective(const OMPSectionDirective &S);
2927   void EmitOMPSingleDirective(const OMPSingleDirective &S);
2928   void EmitOMPMasterDirective(const OMPMasterDirective &S);
2929   void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
2930   void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
2931   void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
2932   void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
2933   void EmitOMPTaskDirective(const OMPTaskDirective &S);
2934   void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
2935   void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
2936   void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
2937   void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
2938   void EmitOMPFlushDirective(const OMPFlushDirective &S);
2939   void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
2940   void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
2941   void EmitOMPTargetDirective(const OMPTargetDirective &S);
2942   void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
2943   void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
2944   void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
2945   void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
2946   void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
2947   void
2948   EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
2949   void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
2950   void
2951   EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
2952   void EmitOMPCancelDirective(const OMPCancelDirective &S);
2953   void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
2954   void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
2955   void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
2956   void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
2957   void EmitOMPDistributeParallelForDirective(
2958       const OMPDistributeParallelForDirective &S);
2959   void EmitOMPDistributeParallelForSimdDirective(
2960       const OMPDistributeParallelForSimdDirective &S);
2961   void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
2962   void EmitOMPTargetParallelForSimdDirective(
2963       const OMPTargetParallelForSimdDirective &S);
2964   void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
2965   void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
2966   void
2967   EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
2968   void EmitOMPTeamsDistributeParallelForSimdDirective(
2969       const OMPTeamsDistributeParallelForSimdDirective &S);
2970   void EmitOMPTeamsDistributeParallelForDirective(
2971       const OMPTeamsDistributeParallelForDirective &S);
2972   void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
2973   void EmitOMPTargetTeamsDistributeDirective(
2974       const OMPTargetTeamsDistributeDirective &S);
2975   void EmitOMPTargetTeamsDistributeParallelForDirective(
2976       const OMPTargetTeamsDistributeParallelForDirective &S);
2977   void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
2978       const OMPTargetTeamsDistributeParallelForSimdDirective &S);
2979   void EmitOMPTargetTeamsDistributeSimdDirective(
2980       const OMPTargetTeamsDistributeSimdDirective &S);
2981 
2982   /// Emit device code for the target directive.
2983   static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
2984                                           StringRef ParentName,
2985                                           const OMPTargetDirective &S);
2986   static void
2987   EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2988                                       const OMPTargetParallelDirective &S);
2989   /// Emit device code for the target parallel for directive.
2990   static void EmitOMPTargetParallelForDeviceFunction(
2991       CodeGenModule &CGM, StringRef ParentName,
2992       const OMPTargetParallelForDirective &S);
2993   /// Emit device code for the target parallel for simd directive.
2994   static void EmitOMPTargetParallelForSimdDeviceFunction(
2995       CodeGenModule &CGM, StringRef ParentName,
2996       const OMPTargetParallelForSimdDirective &S);
2997   /// Emit device code for the target teams directive.
2998   static void
2999   EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3000                                    const OMPTargetTeamsDirective &S);
3001   /// Emit device code for the target teams distribute directive.
3002   static void EmitOMPTargetTeamsDistributeDeviceFunction(
3003       CodeGenModule &CGM, StringRef ParentName,
3004       const OMPTargetTeamsDistributeDirective &S);
3005   /// Emit device code for the target teams distribute simd directive.
3006   static void EmitOMPTargetTeamsDistributeSimdDeviceFunction(
3007       CodeGenModule &CGM, StringRef ParentName,
3008       const OMPTargetTeamsDistributeSimdDirective &S);
3009   /// Emit device code for the target simd directive.
3010   static void EmitOMPTargetSimdDeviceFunction(CodeGenModule &CGM,
3011                                               StringRef ParentName,
3012                                               const OMPTargetSimdDirective &S);
3013   /// Emit device code for the target teams distribute parallel for simd
3014   /// directive.
3015   static void EmitOMPTargetTeamsDistributeParallelForSimdDeviceFunction(
3016       CodeGenModule &CGM, StringRef ParentName,
3017       const OMPTargetTeamsDistributeParallelForSimdDirective &S);
3018 
3019   static void EmitOMPTargetTeamsDistributeParallelForDeviceFunction(
3020       CodeGenModule &CGM, StringRef ParentName,
3021       const OMPTargetTeamsDistributeParallelForDirective &S);
3022   /// \brief Emit inner loop of the worksharing/simd construct.
3023   ///
3024   /// \param S Directive, for which the inner loop must be emitted.
3025   /// \param RequiresCleanup true, if directive has some associated private
3026   /// variables.
3027   /// \param LoopCond Bollean condition for loop continuation.
3028   /// \param IncExpr Increment expression for loop control variable.
3029   /// \param BodyGen Generator for the inner body of the inner loop.
3030   /// \param PostIncGen Genrator for post-increment code (required for ordered
3031   /// loop directvies).
3032   void EmitOMPInnerLoop(
3033       const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
3034       const Expr *IncExpr,
3035       const llvm::function_ref<void(CodeGenFunction &)> BodyGen,
3036       const llvm::function_ref<void(CodeGenFunction &)> PostIncGen);
3037 
3038   JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
3039   /// Emit initial code for loop counters of loop-based directives.
3040   void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
3041                                   OMPPrivateScope &LoopScope);
3042 
3043   /// Helper for the OpenMP loop directives.
3044   void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
3045 
3046   /// \brief Emit code for the worksharing loop-based directive.
3047   /// \return true, if this construct has any lastprivate clause, false -
3048   /// otherwise.
3049   bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
3050                               const CodeGenLoopBoundsTy &CodeGenLoopBounds,
3051                               const CodeGenDispatchBoundsTy &CGDispatchBounds);
3052 
3053   /// Emit code for the distribute loop-based directive.
3054   void EmitOMPDistributeLoop(const OMPLoopDirective &S,
3055                              const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
3056 
3057   /// Helpers for the OpenMP loop directives.
3058   void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
3059   void EmitOMPSimdFinal(
3060       const OMPLoopDirective &D,
3061       const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
3062 
3063   /// Emits the lvalue for the expression with possibly captured variable.
3064   LValue EmitOMPSharedLValue(const Expr *E);
3065 
3066 private:
3067   /// Helpers for blocks.
3068   llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
3069 
3070   /// struct with the values to be passed to the OpenMP loop-related functions
3071   struct OMPLoopArguments {
3072     /// loop lower bound
3073     Address LB = Address::invalid();
3074     /// loop upper bound
3075     Address UB = Address::invalid();
3076     /// loop stride
3077     Address ST = Address::invalid();
3078     /// isLastIteration argument for runtime functions
3079     Address IL = Address::invalid();
3080     /// Chunk value generated by sema
3081     llvm::Value *Chunk = nullptr;
3082     /// EnsureUpperBound
3083     Expr *EUB = nullptr;
3084     /// IncrementExpression
3085     Expr *IncExpr = nullptr;
3086     /// Loop initialization
3087     Expr *Init = nullptr;
3088     /// Loop exit condition
3089     Expr *Cond = nullptr;
3090     /// Update of LB after a whole chunk has been executed
3091     Expr *NextLB = nullptr;
3092     /// Update of UB after a whole chunk has been executed
3093     Expr *NextUB = nullptr;
3094     OMPLoopArguments() = default;
3095     OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
3096                      llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
3097                      Expr *IncExpr = nullptr, Expr *Init = nullptr,
3098                      Expr *Cond = nullptr, Expr *NextLB = nullptr,
3099                      Expr *NextUB = nullptr)
3100         : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
3101           IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
3102           NextUB(NextUB) {}
3103   };
3104   void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
3105                         const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
3106                         const OMPLoopArguments &LoopArgs,
3107                         const CodeGenLoopTy &CodeGenLoop,
3108                         const CodeGenOrderedTy &CodeGenOrdered);
3109   void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
3110                            bool IsMonotonic, const OMPLoopDirective &S,
3111                            OMPPrivateScope &LoopScope, bool Ordered,
3112                            const OMPLoopArguments &LoopArgs,
3113                            const CodeGenDispatchBoundsTy &CGDispatchBounds);
3114   void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
3115                                   const OMPLoopDirective &S,
3116                                   OMPPrivateScope &LoopScope,
3117                                   const OMPLoopArguments &LoopArgs,
3118                                   const CodeGenLoopTy &CodeGenLoopContent);
3119   /// \brief Emit code for sections directive.
3120   void EmitSections(const OMPExecutableDirective &S);
3121 
3122 public:
3123 
3124   //===--------------------------------------------------------------------===//
3125   //                         LValue Expression Emission
3126   //===--------------------------------------------------------------------===//
3127 
3128   /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
3129   RValue GetUndefRValue(QualType Ty);
3130 
3131   /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
3132   /// and issue an ErrorUnsupported style diagnostic (using the
3133   /// provided Name).
3134   RValue EmitUnsupportedRValue(const Expr *E,
3135                                const char *Name);
3136 
3137   /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
3138   /// an ErrorUnsupported style diagnostic (using the provided Name).
3139   LValue EmitUnsupportedLValue(const Expr *E,
3140                                const char *Name);
3141 
3142   /// EmitLValue - Emit code to compute a designator that specifies the location
3143   /// of the expression.
3144   ///
3145   /// This can return one of two things: a simple address or a bitfield
3146   /// reference.  In either case, the LLVM Value* in the LValue structure is
3147   /// guaranteed to be an LLVM pointer type.
3148   ///
3149   /// If this returns a bitfield reference, nothing about the pointee type of
3150   /// the LLVM value is known: For example, it may not be a pointer to an
3151   /// integer.
3152   ///
3153   /// If this returns a normal address, and if the lvalue's C type is fixed
3154   /// size, this method guarantees that the returned pointer type will point to
3155   /// an LLVM type of the same size of the lvalue's type.  If the lvalue has a
3156   /// variable length type, this is not possible.
3157   ///
3158   LValue EmitLValue(const Expr *E);
3159 
3160   /// \brief Same as EmitLValue but additionally we generate checking code to
3161   /// guard against undefined behavior.  This is only suitable when we know
3162   /// that the address will be used to access the object.
3163   LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
3164 
3165   RValue convertTempToRValue(Address addr, QualType type,
3166                              SourceLocation Loc);
3167 
3168   void EmitAtomicInit(Expr *E, LValue lvalue);
3169 
3170   bool LValueIsSuitableForInlineAtomic(LValue Src);
3171 
3172   RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
3173                         AggValueSlot Slot = AggValueSlot::ignored());
3174 
3175   RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
3176                         llvm::AtomicOrdering AO, bool IsVolatile = false,
3177                         AggValueSlot slot = AggValueSlot::ignored());
3178 
3179   void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3180 
3181   void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3182                        bool IsVolatile, bool isInit);
3183 
3184   std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
3185       LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
3186       llvm::AtomicOrdering Success =
3187           llvm::AtomicOrdering::SequentiallyConsistent,
3188       llvm::AtomicOrdering Failure =
3189           llvm::AtomicOrdering::SequentiallyConsistent,
3190       bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3191 
3192   void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
3193                         const llvm::function_ref<RValue(RValue)> &UpdateOp,
3194                         bool IsVolatile);
3195 
3196   /// EmitToMemory - Change a scalar value from its value
3197   /// representation to its in-memory representation.
3198   llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3199 
3200   /// EmitFromMemory - Change a scalar value from its memory
3201   /// representation to its value representation.
3202   llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3203 
3204   /// Check if the scalar \p Value is within the valid range for the given
3205   /// type \p Ty.
3206   ///
3207   /// Returns true if a check is needed (even if the range is unknown).
3208   bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3209                             SourceLocation Loc);
3210 
3211   /// EmitLoadOfScalar - Load a scalar value from an address, taking
3212   /// care to appropriately convert from the memory representation to
3213   /// the LLVM value representation.
3214   llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3215                                 SourceLocation Loc,
3216                                 AlignmentSource Source = AlignmentSource::Type,
3217                                 bool isNontemporal = false) {
3218     return EmitLoadOfScalar(Addr, Volatile, Ty, Loc, LValueBaseInfo(Source),
3219                             CGM.getTBAAAccessInfo(Ty), isNontemporal);
3220   }
3221 
3222   llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3223                                 SourceLocation Loc, LValueBaseInfo BaseInfo,
3224                                 TBAAAccessInfo TBAAInfo,
3225                                 bool isNontemporal = false);
3226 
3227   /// EmitLoadOfScalar - Load a scalar value from an address, taking
3228   /// care to appropriately convert from the memory representation to
3229   /// the LLVM value representation.  The l-value must be a simple
3230   /// l-value.
3231   llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
3232 
3233   /// EmitStoreOfScalar - Store a scalar value to an address, taking
3234   /// care to appropriately convert from the memory representation to
3235   /// the LLVM value representation.
3236   void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3237                          bool Volatile, QualType Ty,
3238                          AlignmentSource Source = AlignmentSource::Type,
3239                          bool isInit = false, bool isNontemporal = false) {
3240     EmitStoreOfScalar(Value, Addr, Volatile, Ty, LValueBaseInfo(Source),
3241                       CGM.getTBAAAccessInfo(Ty), isInit, isNontemporal);
3242   }
3243 
3244   void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3245                          bool Volatile, QualType Ty,
3246                          LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo,
3247                          bool isInit = false, bool isNontemporal = false);
3248 
3249   /// EmitStoreOfScalar - Store a scalar value to an address, taking
3250   /// care to appropriately convert from the memory representation to
3251   /// the LLVM value representation.  The l-value must be a simple
3252   /// l-value.  The isInit flag indicates whether this is an initialization.
3253   /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3254   void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
3255 
3256   /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3257   /// this method emits the address of the lvalue, then loads the result as an
3258   /// rvalue, returning the rvalue.
3259   RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
3260   RValue EmitLoadOfExtVectorElementLValue(LValue V);
3261   RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
3262   RValue EmitLoadOfGlobalRegLValue(LValue LV);
3263 
3264   /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3265   /// lvalue, where both are guaranteed to the have the same type, and that type
3266   /// is 'Ty'.
3267   void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
3268   void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
3269   void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
3270 
3271   /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3272   /// as EmitStoreThroughLValue.
3273   ///
3274   /// \param Result [out] - If non-null, this will be set to a Value* for the
3275   /// bit-field contents after the store, appropriate for use as the result of
3276   /// an assignment to the bit-field.
3277   void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
3278                                       llvm::Value **Result=nullptr);
3279 
3280   /// Emit an l-value for an assignment (simple or compound) of complex type.
3281   LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
3282   LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
3283   LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3284                                              llvm::Value *&Result);
3285 
3286   // Note: only available for agg return types
3287   LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
3288   LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
3289   // Note: only available for agg return types
3290   LValue EmitCallExprLValue(const CallExpr *E);
3291   // Note: only available for agg return types
3292   LValue EmitVAArgExprLValue(const VAArgExpr *E);
3293   LValue EmitDeclRefLValue(const DeclRefExpr *E);
3294   LValue EmitStringLiteralLValue(const StringLiteral *E);
3295   LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
3296   LValue EmitPredefinedLValue(const PredefinedExpr *E);
3297   LValue EmitUnaryOpLValue(const UnaryOperator *E);
3298   LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3299                                 bool Accessed = false);
3300   LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3301                                  bool IsLowerBound = true);
3302   LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
3303   LValue EmitMemberExpr(const MemberExpr *E);
3304   LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
3305   LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
3306   LValue EmitInitListLValue(const InitListExpr *E);
3307   LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
3308   LValue EmitCastLValue(const CastExpr *E);
3309   LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
3310   LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
3311 
3312   Address EmitExtVectorElementLValue(LValue V);
3313 
3314   RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
3315 
3316   Address EmitArrayToPointerDecay(const Expr *Array,
3317                                   LValueBaseInfo *BaseInfo = nullptr,
3318                                   TBAAAccessInfo *TBAAInfo = nullptr);
3319 
3320   class ConstantEmission {
3321     llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3322     ConstantEmission(llvm::Constant *C, bool isReference)
3323       : ValueAndIsReference(C, isReference) {}
3324   public:
3325     ConstantEmission() {}
3326     static ConstantEmission forReference(llvm::Constant *C) {
3327       return ConstantEmission(C, true);
3328     }
3329     static ConstantEmission forValue(llvm::Constant *C) {
3330       return ConstantEmission(C, false);
3331     }
3332 
3333     explicit operator bool() const {
3334       return ValueAndIsReference.getOpaqueValue() != nullptr;
3335     }
3336 
3337     bool isReference() const { return ValueAndIsReference.getInt(); }
3338     LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3339       assert(isReference());
3340       return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3341                                             refExpr->getType());
3342     }
3343 
3344     llvm::Constant *getValue() const {
3345       assert(!isReference());
3346       return ValueAndIsReference.getPointer();
3347     }
3348   };
3349 
3350   ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
3351   ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
3352 
3353   RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3354                                 AggValueSlot slot = AggValueSlot::ignored());
3355   LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3356 
3357   llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
3358                               const ObjCIvarDecl *Ivar);
3359   LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
3360   LValue EmitLValueForLambdaField(const FieldDecl *Field);
3361 
3362   /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3363   /// if the Field is a reference, this will return the address of the reference
3364   /// and not the address of the value stored in the reference.
3365   LValue EmitLValueForFieldInitialization(LValue Base,
3366                                           const FieldDecl* Field);
3367 
3368   LValue EmitLValueForIvar(QualType ObjectTy,
3369                            llvm::Value* Base, const ObjCIvarDecl *Ivar,
3370                            unsigned CVRQualifiers);
3371 
3372   LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
3373   LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
3374   LValue EmitLambdaLValue(const LambdaExpr *E);
3375   LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
3376   LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
3377 
3378   LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
3379   LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
3380   LValue EmitStmtExprLValue(const StmtExpr *E);
3381   LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
3382   LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
3383   void   EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
3384 
3385   //===--------------------------------------------------------------------===//
3386   //                         Scalar Expression Emission
3387   //===--------------------------------------------------------------------===//
3388 
3389   /// EmitCall - Generate a call of the given function, expecting the given
3390   /// result type, and using the given argument list which specifies both the
3391   /// LLVM arguments and the types they were derived from.
3392   RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
3393                   ReturnValueSlot ReturnValue, const CallArgList &Args,
3394                   llvm::Instruction **callOrInvoke, SourceLocation Loc);
3395   RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
3396                   ReturnValueSlot ReturnValue, const CallArgList &Args,
3397                   llvm::Instruction **callOrInvoke = nullptr) {
3398     return EmitCall(CallInfo, Callee, ReturnValue, Args, callOrInvoke,
3399                     SourceLocation());
3400   }
3401   RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
3402                   ReturnValueSlot ReturnValue, llvm::Value *Chain = nullptr);
3403   RValue EmitCallExpr(const CallExpr *E,
3404                       ReturnValueSlot ReturnValue = ReturnValueSlot());
3405   RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3406   CGCallee EmitCallee(const Expr *E);
3407 
3408   void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
3409 
3410   llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3411                                   const Twine &name = "");
3412   llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3413                                   ArrayRef<llvm::Value*> args,
3414                                   const Twine &name = "");
3415   llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3416                                           const Twine &name = "");
3417   llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3418                                           ArrayRef<llvm::Value*> args,
3419                                           const Twine &name = "");
3420 
3421   SmallVector<llvm::OperandBundleDef, 1>
3422   getBundlesForFunclet(llvm::Value *Callee);
3423 
3424   llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
3425                                   ArrayRef<llvm::Value *> Args,
3426                                   const Twine &Name = "");
3427   llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3428                                          ArrayRef<llvm::Value*> args,
3429                                          const Twine &name = "");
3430   llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3431                                          const Twine &name = "");
3432   void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3433                                        ArrayRef<llvm::Value*> args);
3434 
3435   CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
3436                                      NestedNameSpecifier *Qual,
3437                                      llvm::Type *Ty);
3438 
3439   CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
3440                                                CXXDtorType Type,
3441                                                const CXXRecordDecl *RD);
3442 
3443   // These functions emit calls to the special functions of non-trivial C
3444   // structs.
3445   void defaultInitNonTrivialCStructVar(LValue Dst);
3446   void callCStructDefaultConstructor(LValue Dst);
3447   void callCStructDestructor(LValue Dst);
3448   void callCStructCopyConstructor(LValue Dst, LValue Src);
3449   void callCStructMoveConstructor(LValue Dst, LValue Src);
3450   void callCStructCopyAssignmentOperator(LValue Dst, LValue Src);
3451   void callCStructMoveAssignmentOperator(LValue Dst, LValue Src);
3452 
3453   RValue
3454   EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3455                               const CGCallee &Callee,
3456                               ReturnValueSlot ReturnValue, llvm::Value *This,
3457                               llvm::Value *ImplicitParam,
3458                               QualType ImplicitParamTy, const CallExpr *E,
3459                               CallArgList *RtlArgs);
3460   RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3461                                const CGCallee &Callee,
3462                                llvm::Value *This, llvm::Value *ImplicitParam,
3463                                QualType ImplicitParamTy, const CallExpr *E,
3464                                StructorType Type);
3465   RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3466                                ReturnValueSlot ReturnValue);
3467   RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3468                                                const CXXMethodDecl *MD,
3469                                                ReturnValueSlot ReturnValue,
3470                                                bool HasQualifier,
3471                                                NestedNameSpecifier *Qualifier,
3472                                                bool IsArrow, const Expr *Base);
3473   // Compute the object pointer.
3474   Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3475                                           llvm::Value *memberPtr,
3476                                           const MemberPointerType *memberPtrType,
3477                                           LValueBaseInfo *BaseInfo = nullptr,
3478                                           TBAAAccessInfo *TBAAInfo = nullptr);
3479   RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3480                                       ReturnValueSlot ReturnValue);
3481 
3482   RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
3483                                        const CXXMethodDecl *MD,
3484                                        ReturnValueSlot ReturnValue);
3485   RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
3486 
3487   RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3488                                 ReturnValueSlot ReturnValue);
3489 
3490   RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3491                                        ReturnValueSlot ReturnValue);
3492 
3493   RValue EmitBuiltinExpr(const FunctionDecl *FD,
3494                          unsigned BuiltinID, const CallExpr *E,
3495                          ReturnValueSlot ReturnValue);
3496 
3497   /// Emit IR for __builtin_os_log_format.
3498   RValue emitBuiltinOSLogFormat(const CallExpr &E);
3499 
3500   llvm::Function *generateBuiltinOSLogHelperFunction(
3501       const analyze_os_log::OSLogBufferLayout &Layout,
3502       CharUnits BufferAlignment);
3503 
3504   RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3505 
3506   /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3507   /// is unhandled by the current target.
3508   llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3509 
3510   llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3511                                              const llvm::CmpInst::Predicate Fp,
3512                                              const llvm::CmpInst::Predicate Ip,
3513                                              const llvm::Twine &Name = "");
3514   llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3515                                   llvm::Triple::ArchType Arch);
3516 
3517   llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3518                                          unsigned LLVMIntrinsic,
3519                                          unsigned AltLLVMIntrinsic,
3520                                          const char *NameHint,
3521                                          unsigned Modifier,
3522                                          const CallExpr *E,
3523                                          SmallVectorImpl<llvm::Value *> &Ops,
3524                                          Address PtrOp0, Address PtrOp1,
3525                                          llvm::Triple::ArchType Arch);
3526   llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3527                                           unsigned Modifier, llvm::Type *ArgTy,
3528                                           const CallExpr *E);
3529   llvm::Value *EmitNeonCall(llvm::Function *F,
3530                             SmallVectorImpl<llvm::Value*> &O,
3531                             const char *name,
3532                             unsigned shift = 0, bool rightshift = false);
3533   llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
3534   llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
3535                                    bool negateForRightShift);
3536   llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3537                                  llvm::Type *Ty, bool usgn, const char *name);
3538   llvm::Value *vectorWrapScalar16(llvm::Value *Op);
3539   llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3540                                       llvm::Triple::ArchType Arch);
3541 
3542   llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
3543   llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3544   llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3545   llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3546   llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3547   llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3548   llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3549                                           const CallExpr *E);
3550   llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3551 
3552 private:
3553   enum class MSVCIntrin;
3554 
3555 public:
3556   llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3557 
3558   llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3559 
3560   llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
3561   llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
3562   llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
3563   llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3564   llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3565   llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
3566                                 const ObjCMethodDecl *MethodWithObjects);
3567   llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
3568   RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3569                              ReturnValueSlot Return = ReturnValueSlot());
3570 
3571   /// Retrieves the default cleanup kind for an ARC cleanup.
3572   /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3573   CleanupKind getARCCleanupKind() {
3574     return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3575              ? NormalAndEHCleanup : NormalCleanup;
3576   }
3577 
3578   // ARC primitives.
3579   void EmitARCInitWeak(Address addr, llvm::Value *value);
3580   void EmitARCDestroyWeak(Address addr);
3581   llvm::Value *EmitARCLoadWeak(Address addr);
3582   llvm::Value *EmitARCLoadWeakRetained(Address addr);
3583   llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3584   void emitARCCopyAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
3585   void emitARCMoveAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
3586   void EmitARCCopyWeak(Address dst, Address src);
3587   void EmitARCMoveWeak(Address dst, Address src);
3588   llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3589   llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
3590   llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
3591                                   bool resultIgnored);
3592   llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
3593                                       bool resultIgnored);
3594   llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
3595   llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
3596   llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
3597   void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
3598   void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
3599   llvm::Value *EmitARCAutorelease(llvm::Value *value);
3600   llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3601   llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3602   llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
3603   llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
3604 
3605   std::pair<LValue,llvm::Value*>
3606   EmitARCStoreAutoreleasing(const BinaryOperator *e);
3607   std::pair<LValue,llvm::Value*>
3608   EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
3609   std::pair<LValue,llvm::Value*>
3610   EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
3611 
3612   llvm::Value *EmitObjCThrowOperand(const Expr *expr);
3613   llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3614   llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3615 
3616   llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
3617   llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3618                                             bool allowUnsafeClaim);
3619   llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3620   llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
3621   llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
3622 
3623   void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
3624 
3625   static Destroyer destroyARCStrongImprecise;
3626   static Destroyer destroyARCStrongPrecise;
3627   static Destroyer destroyARCWeak;
3628   static Destroyer emitARCIntrinsicUse;
3629   static Destroyer destroyNonTrivialCStruct;
3630 
3631   void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3632   llvm::Value *EmitObjCAutoreleasePoolPush();
3633   llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3634   void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3635   void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3636 
3637   /// \brief Emits a reference binding to the passed in expression.
3638   RValue EmitReferenceBindingToExpr(const Expr *E);
3639 
3640   //===--------------------------------------------------------------------===//
3641   //                           Expression Emission
3642   //===--------------------------------------------------------------------===//
3643 
3644   // Expressions are broken into three classes: scalar, complex, aggregate.
3645 
3646   /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3647   /// scalar type, returning the result.
3648   llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
3649 
3650   /// Emit a conversion from the specified type to the specified destination
3651   /// type, both of which are LLVM scalar types.
3652   llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
3653                                     QualType DstTy, SourceLocation Loc);
3654 
3655   /// Emit a conversion from the specified complex type to the specified
3656   /// destination type, where the destination type is an LLVM scalar type.
3657   llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
3658                                              QualType DstTy,
3659                                              SourceLocation Loc);
3660 
3661   /// EmitAggExpr - Emit the computation of the specified expression
3662   /// of aggregate type.  The result is computed into the given slot,
3663   /// which may be null to indicate that the value is not needed.
3664   void EmitAggExpr(const Expr *E, AggValueSlot AS);
3665 
3666   /// EmitAggExprToLValue - Emit the computation of the specified expression of
3667   /// aggregate type into a temporary LValue.
3668   LValue EmitAggExprToLValue(const Expr *E);
3669 
3670   /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3671   /// make sure it survives garbage collection until this point.
3672   void EmitExtendGCLifetime(llvm::Value *object);
3673 
3674   /// EmitComplexExpr - Emit the computation of the specified expression of
3675   /// complex type, returning the result.
3676   ComplexPairTy EmitComplexExpr(const Expr *E,
3677                                 bool IgnoreReal = false,
3678                                 bool IgnoreImag = false);
3679 
3680   /// EmitComplexExprIntoLValue - Emit the given expression of complex
3681   /// type and place its result into the specified l-value.
3682   void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
3683 
3684   /// EmitStoreOfComplex - Store a complex number into the specified l-value.
3685   void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
3686 
3687   /// EmitLoadOfComplex - Load a complex number from the specified l-value.
3688   ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
3689 
3690   Address emitAddrOfRealComponent(Address complex, QualType complexType);
3691   Address emitAddrOfImagComponent(Address complex, QualType complexType);
3692 
3693   /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3694   /// global variable that has already been created for it.  If the initializer
3695   /// has a different type than GV does, this may free GV and return a different
3696   /// one.  Otherwise it just returns GV.
3697   llvm::GlobalVariable *
3698   AddInitializerToStaticVarDecl(const VarDecl &D,
3699                                 llvm::GlobalVariable *GV);
3700 
3701 
3702   /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3703   /// variable with global storage.
3704   void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3705                                 bool PerformInit);
3706 
3707   llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3708                                    llvm::Constant *Addr);
3709 
3710   /// Call atexit() with a function that passes the given argument to
3711   /// the given function.
3712   void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3713                                     llvm::Constant *addr);
3714 
3715   /// Call atexit() with function dtorStub.
3716   void registerGlobalDtorWithAtExit(llvm::Constant *dtorStub);
3717 
3718   /// Emit code in this function to perform a guarded variable
3719   /// initialization.  Guarded initializations are used when it's not
3720   /// possible to prove that an initialization will be done exactly
3721   /// once, e.g. with a static local variable or a static data member
3722   /// of a class template.
3723   void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
3724                           bool PerformInit);
3725 
3726   enum class GuardKind { VariableGuard, TlsGuard };
3727 
3728   /// Emit a branch to select whether or not to perform guarded initialization.
3729   void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
3730                                 llvm::BasicBlock *InitBlock,
3731                                 llvm::BasicBlock *NoInitBlock,
3732                                 GuardKind Kind, const VarDecl *D);
3733 
3734   /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3735   /// variables.
3736   void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
3737                                  ArrayRef<llvm::Function *> CXXThreadLocals,
3738                                  Address Guard = Address::invalid());
3739 
3740   /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
3741   /// variables.
3742   void GenerateCXXGlobalDtorsFunc(
3743       llvm::Function *Fn,
3744       const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
3745           &DtorsAndObjects);
3746 
3747   void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3748                                         const VarDecl *D,
3749                                         llvm::GlobalVariable *Addr,
3750                                         bool PerformInit);
3751 
3752   void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
3753 
3754   void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
3755 
3756   void enterFullExpression(const ExprWithCleanups *E) {
3757     if (E->getNumObjects() == 0) return;
3758     enterNonTrivialFullExpression(E);
3759   }
3760   void enterNonTrivialFullExpression(const ExprWithCleanups *E);
3761 
3762   void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
3763 
3764   void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3765 
3766   RValue EmitAtomicExpr(AtomicExpr *E);
3767 
3768   //===--------------------------------------------------------------------===//
3769   //                         Annotations Emission
3770   //===--------------------------------------------------------------------===//
3771 
3772   /// Emit an annotation call (intrinsic or builtin).
3773   llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3774                                   llvm::Value *AnnotatedVal,
3775                                   StringRef AnnotationStr,
3776                                   SourceLocation Location);
3777 
3778   /// Emit local annotations for the local variable V, declared by D.
3779   void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3780 
3781   /// Emit field annotations for the given field & value. Returns the
3782   /// annotation result.
3783   Address EmitFieldAnnotations(const FieldDecl *D, Address V);
3784 
3785   //===--------------------------------------------------------------------===//
3786   //                             Internal Helpers
3787   //===--------------------------------------------------------------------===//
3788 
3789   /// ContainsLabel - Return true if the statement contains a label in it.  If
3790   /// this statement is not executed normally, it not containing a label means
3791   /// that we can just remove the code.
3792   static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
3793 
3794   /// containsBreak - Return true if the statement contains a break out of it.
3795   /// If the statement (recursively) contains a switch or loop with a break
3796   /// inside of it, this is fine.
3797   static bool containsBreak(const Stmt *S);
3798 
3799   /// Determine if the given statement might introduce a declaration into the
3800   /// current scope, by being a (possibly-labelled) DeclStmt.
3801   static bool mightAddDeclToScope(const Stmt *S);
3802 
3803   /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3804   /// to a constant, or if it does but contains a label, return false.  If it
3805   /// constant folds return true and set the boolean result in Result.
3806   bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3807                                     bool AllowLabels = false);
3808 
3809   /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3810   /// to a constant, or if it does but contains a label, return false.  If it
3811   /// constant folds return true and set the folded value.
3812   bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3813                                     bool AllowLabels = false);
3814 
3815   /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3816   /// if statement) to the specified blocks.  Based on the condition, this might
3817   /// try to simplify the codegen of the conditional based on the branch.
3818   /// TrueCount should be the number of times we expect the condition to
3819   /// evaluate to true based on PGO data.
3820   void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
3821                             llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
3822 
3823   /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
3824   /// nonnull, if \p LHS is marked _Nonnull.
3825   void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
3826 
3827   /// An enumeration which makes it easier to specify whether or not an
3828   /// operation is a subtraction.
3829   enum { NotSubtraction = false, IsSubtraction = true };
3830 
3831   /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
3832   /// detect undefined behavior when the pointer overflow sanitizer is enabled.
3833   /// \p SignedIndices indicates whether any of the GEP indices are signed.
3834   /// \p IsSubtraction indicates whether the expression used to form the GEP
3835   /// is a subtraction.
3836   llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
3837                                       ArrayRef<llvm::Value *> IdxList,
3838                                       bool SignedIndices,
3839                                       bool IsSubtraction,
3840                                       SourceLocation Loc,
3841                                       const Twine &Name = "");
3842 
3843   /// Specifies which type of sanitizer check to apply when handling a
3844   /// particular builtin.
3845   enum BuiltinCheckKind {
3846     BCK_CTZPassedZero,
3847     BCK_CLZPassedZero,
3848   };
3849 
3850   /// Emits an argument for a call to a builtin. If the builtin sanitizer is
3851   /// enabled, a runtime check specified by \p Kind is also emitted.
3852   llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
3853 
3854   /// \brief Emit a description of a type in a format suitable for passing to
3855   /// a runtime sanitizer handler.
3856   llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3857 
3858   /// \brief Convert a value into a format suitable for passing to a runtime
3859   /// sanitizer handler.
3860   llvm::Value *EmitCheckValue(llvm::Value *V);
3861 
3862   /// \brief Emit a description of a source location in a format suitable for
3863   /// passing to a runtime sanitizer handler.
3864   llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3865 
3866   /// \brief Create a basic block that will call a handler function in a
3867   /// sanitizer runtime with the provided arguments, and create a conditional
3868   /// branch to it.
3869   void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
3870                  SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
3871                  ArrayRef<llvm::Value *> DynamicArgs);
3872 
3873   /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3874   /// if Cond if false.
3875   void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3876                             llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3877                             ArrayRef<llvm::Constant *> StaticArgs);
3878 
3879   /// Emit a reached-unreachable diagnostic if \p Loc is valid and runtime
3880   /// checking is enabled. Otherwise, just emit an unreachable instruction.
3881   void EmitUnreachable(SourceLocation Loc);
3882 
3883   /// \brief Create a basic block that will call the trap intrinsic, and emit a
3884   /// conditional branch to it, for the -ftrapv checks.
3885   void EmitTrapCheck(llvm::Value *Checked);
3886 
3887   /// \brief Emit a call to trap or debugtrap and attach function attribute
3888   /// "trap-func-name" if specified.
3889   llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3890 
3891   /// \brief Emit a stub for the cross-DSO CFI check function.
3892   void EmitCfiCheckStub();
3893 
3894   /// \brief Emit a cross-DSO CFI failure handling function.
3895   void EmitCfiCheckFail();
3896 
3897   /// \brief Create a check for a function parameter that may potentially be
3898   /// declared as non-null.
3899   void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
3900                            AbstractCallee AC, unsigned ParmNum);
3901 
3902   /// EmitCallArg - Emit a single call argument.
3903   void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
3904 
3905   /// EmitDelegateCallArg - We are performing a delegate call; that
3906   /// is, the current function is delegating to another one.  Produce
3907   /// a r-value suitable for passing the given parameter.
3908   void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3909                            SourceLocation loc);
3910 
3911   /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3912   /// point operation, expressed as the maximum relative error in ulp.
3913   void SetFPAccuracy(llvm::Value *Val, float Accuracy);
3914 
3915 private:
3916   llvm::MDNode *getRangeForLoadFromType(QualType Ty);
3917   void EmitReturnOfRValue(RValue RV, QualType Ty);
3918 
3919   void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3920 
3921   llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3922   DeferredReplacements;
3923 
3924   /// Set the address of a local variable.
3925   void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3926     assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3927     LocalDeclMap.insert({VD, Addr});
3928   }
3929 
3930   /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3931   /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3932   ///
3933   /// \param AI - The first function argument of the expansion.
3934   void ExpandTypeFromArgs(QualType Ty, LValue Dst,
3935                           SmallVectorImpl<llvm::Value *>::iterator &AI);
3936 
3937   /// ExpandTypeToArgs - Expand an CallArg \arg Arg, with the LLVM type for \arg
3938   /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3939   /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3940   void ExpandTypeToArgs(QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
3941                         SmallVectorImpl<llvm::Value *> &IRCallArgs,
3942                         unsigned &IRCallArgPos);
3943 
3944   llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
3945                             const Expr *InputExpr, std::string &ConstraintStr);
3946 
3947   llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
3948                                   LValue InputValue, QualType InputType,
3949                                   std::string &ConstraintStr,
3950                                   SourceLocation Loc);
3951 
3952   /// \brief Attempts to statically evaluate the object size of E. If that
3953   /// fails, emits code to figure the size of E out for us. This is
3954   /// pass_object_size aware.
3955   ///
3956   /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
3957   llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
3958                                                llvm::IntegerType *ResType,
3959                                                llvm::Value *EmittedE);
3960 
3961   /// \brief Emits the size of E, as required by __builtin_object_size. This
3962   /// function is aware of pass_object_size parameters, and will act accordingly
3963   /// if E is a parameter with the pass_object_size attribute.
3964   llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
3965                                      llvm::IntegerType *ResType,
3966                                      llvm::Value *EmittedE);
3967 
3968 public:
3969 #ifndef NDEBUG
3970   // Determine whether the given argument is an Objective-C method
3971   // that may have type parameters in its signature.
3972   static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3973     const DeclContext *dc = method->getDeclContext();
3974     if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3975       return classDecl->getTypeParamListAsWritten();
3976     }
3977 
3978     if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3979       return catDecl->getTypeParamList();
3980     }
3981 
3982     return false;
3983   }
3984 
3985   template<typename T>
3986   static bool isObjCMethodWithTypeParams(const T *) { return false; }
3987 #endif
3988 
3989   enum class EvaluationOrder {
3990     ///! No language constraints on evaluation order.
3991     Default,
3992     ///! Language semantics require left-to-right evaluation.
3993     ForceLeftToRight,
3994     ///! Language semantics require right-to-left evaluation.
3995     ForceRightToLeft
3996   };
3997 
3998   /// EmitCallArgs - Emit call arguments for a function.
3999   template <typename T>
4000   void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
4001                     llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
4002                     AbstractCallee AC = AbstractCallee(),
4003                     unsigned ParamsToSkip = 0,
4004                     EvaluationOrder Order = EvaluationOrder::Default) {
4005     SmallVector<QualType, 16> ArgTypes;
4006     CallExpr::const_arg_iterator Arg = ArgRange.begin();
4007 
4008     assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
4009            "Can't skip parameters if type info is not provided");
4010     if (CallArgTypeInfo) {
4011 #ifndef NDEBUG
4012       bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
4013 #endif
4014 
4015       // First, use the argument types that the type info knows about
4016       for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
4017                 E = CallArgTypeInfo->param_type_end();
4018            I != E; ++I, ++Arg) {
4019         assert(Arg != ArgRange.end() && "Running over edge of argument list!");
4020         assert((isGenericMethod ||
4021                 ((*I)->isVariablyModifiedType() ||
4022                  (*I).getNonReferenceType()->isObjCRetainableType() ||
4023                  getContext()
4024                          .getCanonicalType((*I).getNonReferenceType())
4025                          .getTypePtr() ==
4026                      getContext()
4027                          .getCanonicalType((*Arg)->getType())
4028                          .getTypePtr())) &&
4029                "type mismatch in call argument!");
4030         ArgTypes.push_back(*I);
4031       }
4032     }
4033 
4034     // Either we've emitted all the call args, or we have a call to variadic
4035     // function.
4036     assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
4037             CallArgTypeInfo->isVariadic()) &&
4038            "Extra arguments in non-variadic function!");
4039 
4040     // If we still have any arguments, emit them using the type of the argument.
4041     for (auto *A : llvm::make_range(Arg, ArgRange.end()))
4042       ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
4043 
4044     EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
4045   }
4046 
4047   void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
4048                     llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
4049                     AbstractCallee AC = AbstractCallee(),
4050                     unsigned ParamsToSkip = 0,
4051                     EvaluationOrder Order = EvaluationOrder::Default);
4052 
4053   /// EmitPointerWithAlignment - Given an expression with a pointer type,
4054   /// emit the value and compute our best estimate of the alignment of the
4055   /// pointee.
4056   ///
4057   /// \param BaseInfo - If non-null, this will be initialized with
4058   /// information about the source of the alignment and the may-alias
4059   /// attribute.  Note that this function will conservatively fall back on
4060   /// the type when it doesn't recognize the expression and may-alias will
4061   /// be set to false.
4062   ///
4063   /// One reasonable way to use this information is when there's a language
4064   /// guarantee that the pointer must be aligned to some stricter value, and
4065   /// we're simply trying to ensure that sufficiently obvious uses of under-
4066   /// aligned objects don't get miscompiled; for example, a placement new
4067   /// into the address of a local variable.  In such a case, it's quite
4068   /// reasonable to just ignore the returned alignment when it isn't from an
4069   /// explicit source.
4070   Address EmitPointerWithAlignment(const Expr *Addr,
4071                                    LValueBaseInfo *BaseInfo = nullptr,
4072                                    TBAAAccessInfo *TBAAInfo = nullptr);
4073 
4074   /// If \p E references a parameter with pass_object_size info or a constant
4075   /// array size modifier, emit the object size divided by the size of \p EltTy.
4076   /// Otherwise return null.
4077   llvm::Value *LoadPassedObjectSize(const Expr *E, QualType EltTy);
4078 
4079   void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
4080 
4081   struct MultiVersionResolverOption {
4082     llvm::Function *Function;
4083     TargetAttr::ParsedTargetAttr ParsedAttribute;
4084     unsigned Priority;
4085     MultiVersionResolverOption(const TargetInfo &TargInfo, llvm::Function *F,
4086                                const clang::TargetAttr::ParsedTargetAttr &PT)
4087         : Function(F), ParsedAttribute(PT), Priority(0u) {
4088       for (StringRef Feat : PT.Features)
4089         Priority = std::max(Priority,
4090                             TargInfo.multiVersionSortPriority(Feat.substr(1)));
4091 
4092       if (!PT.Architecture.empty())
4093         Priority = std::max(Priority,
4094                             TargInfo.multiVersionSortPriority(PT.Architecture));
4095     }
4096 
4097     bool operator>(const MultiVersionResolverOption &Other) const {
4098       return Priority > Other.Priority;
4099     }
4100   };
4101   void EmitMultiVersionResolver(llvm::Function *Resolver,
4102                                 ArrayRef<MultiVersionResolverOption> Options);
4103 
4104 private:
4105   QualType getVarArgType(const Expr *Arg);
4106 
4107   void EmitDeclMetadata();
4108 
4109   BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
4110                                   const AutoVarEmission &emission);
4111 
4112   void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
4113 
4114   llvm::Value *GetValueForARMHint(unsigned BuiltinID);
4115   llvm::Value *EmitX86CpuIs(const CallExpr *E);
4116   llvm::Value *EmitX86CpuIs(StringRef CPUStr);
4117   llvm::Value *EmitX86CpuSupports(const CallExpr *E);
4118   llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
4119   llvm::Value *EmitX86CpuInit();
4120   llvm::Value *FormResolverCondition(const MultiVersionResolverOption &RO);
4121 };
4122 
4123 /// Helper class with most of the code for saving a value for a
4124 /// conditional expression cleanup.
4125 struct DominatingLLVMValue {
4126   typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
4127 
4128   /// Answer whether the given value needs extra work to be saved.
4129   static bool needsSaving(llvm::Value *value) {
4130     // If it's not an instruction, we don't need to save.
4131     if (!isa<llvm::Instruction>(value)) return false;
4132 
4133     // If it's an instruction in the entry block, we don't need to save.
4134     llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
4135     return (block != &block->getParent()->getEntryBlock());
4136   }
4137 
4138   /// Try to save the given value.
4139   static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
4140     if (!needsSaving(value)) return saved_type(value, false);
4141 
4142     // Otherwise, we need an alloca.
4143     auto align = CharUnits::fromQuantity(
4144               CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
4145     Address alloca =
4146       CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
4147     CGF.Builder.CreateStore(value, alloca);
4148 
4149     return saved_type(alloca.getPointer(), true);
4150   }
4151 
4152   static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
4153     // If the value says it wasn't saved, trust that it's still dominating.
4154     if (!value.getInt()) return value.getPointer();
4155 
4156     // Otherwise, it should be an alloca instruction, as set up in save().
4157     auto alloca = cast<llvm::AllocaInst>(value.getPointer());
4158     return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
4159   }
4160 };
4161 
4162 /// A partial specialization of DominatingValue for llvm::Values that
4163 /// might be llvm::Instructions.
4164 template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
4165   typedef T *type;
4166   static type restore(CodeGenFunction &CGF, saved_type value) {
4167     return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
4168   }
4169 };
4170 
4171 /// A specialization of DominatingValue for Address.
4172 template <> struct DominatingValue<Address> {
4173   typedef Address type;
4174 
4175   struct saved_type {
4176     DominatingLLVMValue::saved_type SavedValue;
4177     CharUnits Alignment;
4178   };
4179 
4180   static bool needsSaving(type value) {
4181     return DominatingLLVMValue::needsSaving(value.getPointer());
4182   }
4183   static saved_type save(CodeGenFunction &CGF, type value) {
4184     return { DominatingLLVMValue::save(CGF, value.getPointer()),
4185              value.getAlignment() };
4186   }
4187   static type restore(CodeGenFunction &CGF, saved_type value) {
4188     return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
4189                    value.Alignment);
4190   }
4191 };
4192 
4193 /// A specialization of DominatingValue for RValue.
4194 template <> struct DominatingValue<RValue> {
4195   typedef RValue type;
4196   class saved_type {
4197     enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
4198                 AggregateAddress, ComplexAddress };
4199 
4200     llvm::Value *Value;
4201     unsigned K : 3;
4202     unsigned Align : 29;
4203     saved_type(llvm::Value *v, Kind k, unsigned a = 0)
4204       : Value(v), K(k), Align(a) {}
4205 
4206   public:
4207     static bool needsSaving(RValue value);
4208     static saved_type save(CodeGenFunction &CGF, RValue value);
4209     RValue restore(CodeGenFunction &CGF);
4210 
4211     // implementations in CGCleanup.cpp
4212   };
4213 
4214   static bool needsSaving(type value) {
4215     return saved_type::needsSaving(value);
4216   }
4217   static saved_type save(CodeGenFunction &CGF, type value) {
4218     return saved_type::save(CGF, value);
4219   }
4220   static type restore(CodeGenFunction &CGF, saved_type value) {
4221     return value.restore(CGF);
4222   }
4223 };
4224 
4225 }  // end namespace CodeGen
4226 }  // end namespace clang
4227 
4228 #endif
4229