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