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