1 //===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This is the internal per-function state used for llvm translation.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef CLANG_CODEGEN_CODEGENFUNCTION_H
15 #define CLANG_CODEGEN_CODEGENFUNCTION_H
16 
17 #include "CGBuilder.h"
18 #include "CGDebugInfo.h"
19 #include "CGValue.h"
20 #include "EHScopeStack.h"
21 #include "CodeGenModule.h"
22 #include "clang/AST/CharUnits.h"
23 #include "clang/AST/ExprCXX.h"
24 #include "clang/AST/ExprObjC.h"
25 #include "clang/AST/Type.h"
26 #include "clang/Basic/ABI.h"
27 #include "clang/Basic/CapturedStmt.h"
28 #include "clang/Basic/TargetInfo.h"
29 #include "clang/Frontend/CodeGenOptions.h"
30 #include "llvm/ADT/ArrayRef.h"
31 #include "llvm/ADT/DenseMap.h"
32 #include "llvm/ADT/SmallVector.h"
33 #include "llvm/Support/Debug.h"
34 #include "llvm/Support/ValueHandle.h"
35 
36 namespace llvm {
37   class BasicBlock;
38   class LLVMContext;
39   class MDNode;
40   class Module;
41   class SwitchInst;
42   class Twine;
43   class Value;
44   class CallSite;
45 }
46 
47 namespace clang {
48   class ASTContext;
49   class BlockDecl;
50   class CXXDestructorDecl;
51   class CXXForRangeStmt;
52   class CXXTryStmt;
53   class Decl;
54   class LabelDecl;
55   class EnumConstantDecl;
56   class FunctionDecl;
57   class FunctionProtoType;
58   class LabelStmt;
59   class ObjCContainerDecl;
60   class ObjCInterfaceDecl;
61   class ObjCIvarDecl;
62   class ObjCMethodDecl;
63   class ObjCImplementationDecl;
64   class ObjCPropertyImplDecl;
65   class TargetInfo;
66   class TargetCodeGenInfo;
67   class VarDecl;
68   class ObjCForCollectionStmt;
69   class ObjCAtTryStmt;
70   class ObjCAtThrowStmt;
71   class ObjCAtSynchronizedStmt;
72   class ObjCAutoreleasePoolStmt;
73 
74 namespace CodeGen {
75   class CodeGenTypes;
76   class CGFunctionInfo;
77   class CGRecordLayout;
78   class CGBlockInfo;
79   class CGCXXABI;
80   class BlockFlags;
81   class BlockFieldFlags;
82 
83 /// The kind of evaluation to perform on values of a particular
84 /// type.  Basically, is the code in CGExprScalar, CGExprComplex, or
85 /// CGExprAgg?
86 ///
87 /// TODO: should vectors maybe be split out into their own thing?
88 enum TypeEvaluationKind {
89   TEK_Scalar,
90   TEK_Complex,
91   TEK_Aggregate
92 };
93 
94 /// CodeGenFunction - This class organizes the per-function state that is used
95 /// while generating LLVM code.
96 class CodeGenFunction : public CodeGenTypeCache {
97   CodeGenFunction(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
98   void operator=(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
99 
100   friend class CGCXXABI;
101 public:
102   /// A jump destination is an abstract label, branching to which may
103   /// require a jump out through normal cleanups.
104   struct JumpDest {
105     JumpDest() : Block(0), ScopeDepth(), Index(0) {}
106     JumpDest(llvm::BasicBlock *Block,
107              EHScopeStack::stable_iterator Depth,
108              unsigned Index)
109       : Block(Block), ScopeDepth(Depth), Index(Index) {}
110 
111     bool isValid() const { return Block != 0; }
112     llvm::BasicBlock *getBlock() const { return Block; }
113     EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
114     unsigned getDestIndex() const { return Index; }
115 
116     // This should be used cautiously.
117     void setScopeDepth(EHScopeStack::stable_iterator depth) {
118       ScopeDepth = depth;
119     }
120 
121   private:
122     llvm::BasicBlock *Block;
123     EHScopeStack::stable_iterator ScopeDepth;
124     unsigned Index;
125   };
126 
127   CodeGenModule &CGM;  // Per-module state.
128   const TargetInfo &Target;
129 
130   typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
131   CGBuilderTy Builder;
132 
133   /// CurFuncDecl - Holds the Decl for the current outermost
134   /// non-closure context.
135   const Decl *CurFuncDecl;
136   /// CurCodeDecl - This is the inner-most code context, which includes blocks.
137   const Decl *CurCodeDecl;
138   const CGFunctionInfo *CurFnInfo;
139   QualType FnRetTy;
140   llvm::Function *CurFn;
141 
142   /// CurGD - The GlobalDecl for the current function being compiled.
143   GlobalDecl CurGD;
144 
145   /// PrologueCleanupDepth - The cleanup depth enclosing all the
146   /// cleanups associated with the parameters.
147   EHScopeStack::stable_iterator PrologueCleanupDepth;
148 
149   /// ReturnBlock - Unified return block.
150   JumpDest ReturnBlock;
151 
152   /// ReturnValue - The temporary alloca to hold the return value. This is null
153   /// iff the function has no return value.
154   llvm::Value *ReturnValue;
155 
156   /// AllocaInsertPoint - This is an instruction in the entry block before which
157   /// we prefer to insert allocas.
158   llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
159 
160   /// \brief API for captured statement code generation.
161   class CGCapturedStmtInfo {
162   public:
163     explicit CGCapturedStmtInfo(const CapturedStmt &S,
164                                 CapturedRegionKind K = CR_Default)
165       : Kind(K), ThisValue(0), CXXThisFieldDecl(0) {
166 
167       RecordDecl::field_iterator Field =
168         S.getCapturedRecordDecl()->field_begin();
169       for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
170                                                 E = S.capture_end();
171            I != E; ++I, ++Field) {
172         if (I->capturesThis())
173           CXXThisFieldDecl = *Field;
174         else
175           CaptureFields[I->getCapturedVar()] = *Field;
176       }
177     }
178 
179     virtual ~CGCapturedStmtInfo();
180 
181     CapturedRegionKind getKind() const { return Kind; }
182 
183     void setContextValue(llvm::Value *V) { ThisValue = V; }
184     // \brief Retrieve the value of the context parameter.
185     llvm::Value *getContextValue() const { return ThisValue; }
186 
187     /// \brief Lookup the captured field decl for a variable.
188     const FieldDecl *lookup(const VarDecl *VD) const {
189       return CaptureFields.lookup(VD);
190     }
191 
192     bool isCXXThisExprCaptured() const { return CXXThisFieldDecl != 0; }
193     FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
194 
195     /// \brief Emit the captured statement body.
196     virtual void EmitBody(CodeGenFunction &CGF, Stmt *S) {
197       CGF.EmitStmt(S);
198     }
199 
200     /// \brief Get the name of the capture helper.
201     virtual StringRef getHelperName() const { return "__captured_stmt"; }
202 
203   private:
204     /// \brief The kind of captured statement being generated.
205     CapturedRegionKind Kind;
206 
207     /// \brief Keep the map between VarDecl and FieldDecl.
208     llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
209 
210     /// \brief The base address of the captured record, passed in as the first
211     /// argument of the parallel region function.
212     llvm::Value *ThisValue;
213 
214     /// \brief Captured 'this' type.
215     FieldDecl *CXXThisFieldDecl;
216   };
217   CGCapturedStmtInfo *CapturedStmtInfo;
218 
219   /// BoundsChecking - Emit run-time bounds checks. Higher values mean
220   /// potentially higher performance penalties.
221   unsigned char BoundsChecking;
222 
223   /// \brief Whether any type-checking sanitizers are enabled. If \c false,
224   /// calls to EmitTypeCheck can be skipped.
225   bool SanitizePerformTypeCheck;
226 
227   /// \brief Sanitizer options to use for this function.
228   const SanitizerOptions *SanOpts;
229 
230   /// In ARC, whether we should autorelease the return value.
231   bool AutoreleaseResult;
232 
233   const CodeGen::CGBlockInfo *BlockInfo;
234   llvm::Value *BlockPointer;
235 
236   llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
237   FieldDecl *LambdaThisCaptureField;
238 
239   /// \brief A mapping from NRVO variables to the flags used to indicate
240   /// when the NRVO has been applied to this variable.
241   llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
242 
243   EHScopeStack EHStack;
244   llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
245 
246   /// Header for data within LifetimeExtendedCleanupStack.
247   struct LifetimeExtendedCleanupHeader {
248     /// The size of the following cleanup object.
249     size_t Size : 29;
250     /// The kind of cleanup to push: a value from the CleanupKind enumeration.
251     unsigned Kind : 3;
252 
253     size_t getSize() const { return Size; }
254     CleanupKind getKind() const { return static_cast<CleanupKind>(Kind); }
255   };
256 
257   /// i32s containing the indexes of the cleanup destinations.
258   llvm::AllocaInst *NormalCleanupDest;
259 
260   unsigned NextCleanupDestIndex;
261 
262   /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
263   CGBlockInfo *FirstBlockInfo;
264 
265   /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
266   llvm::BasicBlock *EHResumeBlock;
267 
268   /// The exception slot.  All landing pads write the current exception pointer
269   /// into this alloca.
270   llvm::Value *ExceptionSlot;
271 
272   /// The selector slot.  Under the MandatoryCleanup model, all landing pads
273   /// write the current selector value into this alloca.
274   llvm::AllocaInst *EHSelectorSlot;
275 
276   /// Emits a landing pad for the current EH stack.
277   llvm::BasicBlock *EmitLandingPad();
278 
279   llvm::BasicBlock *getInvokeDestImpl();
280 
281   template <class T>
282   typename DominatingValue<T>::saved_type saveValueInCond(T value) {
283     return DominatingValue<T>::save(*this, value);
284   }
285 
286 public:
287   /// ObjCEHValueStack - Stack of Objective-C exception values, used for
288   /// rethrows.
289   SmallVector<llvm::Value*, 8> ObjCEHValueStack;
290 
291   /// A class controlling the emission of a finally block.
292   class FinallyInfo {
293     /// Where the catchall's edge through the cleanup should go.
294     JumpDest RethrowDest;
295 
296     /// A function to call to enter the catch.
297     llvm::Constant *BeginCatchFn;
298 
299     /// An i1 variable indicating whether or not the @finally is
300     /// running for an exception.
301     llvm::AllocaInst *ForEHVar;
302 
303     /// An i8* variable into which the exception pointer to rethrow
304     /// has been saved.
305     llvm::AllocaInst *SavedExnVar;
306 
307   public:
308     void enter(CodeGenFunction &CGF, const Stmt *Finally,
309                llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
310                llvm::Constant *rethrowFn);
311     void exit(CodeGenFunction &CGF);
312   };
313 
314   /// pushFullExprCleanup - Push a cleanup to be run at the end of the
315   /// current full-expression.  Safe against the possibility that
316   /// we're currently inside a conditionally-evaluated expression.
317   template <class T, class A0>
318   void pushFullExprCleanup(CleanupKind kind, A0 a0) {
319     // If we're not in a conditional branch, or if none of the
320     // arguments requires saving, then use the unconditional cleanup.
321     if (!isInConditionalBranch())
322       return EHStack.pushCleanup<T>(kind, a0);
323 
324     typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
325 
326     typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
327     EHStack.pushCleanup<CleanupType>(kind, a0_saved);
328     initFullExprCleanup();
329   }
330 
331   /// pushFullExprCleanup - Push a cleanup to be run at the end of the
332   /// current full-expression.  Safe against the possibility that
333   /// we're currently inside a conditionally-evaluated expression.
334   template <class T, class A0, class A1>
335   void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
336     // If we're not in a conditional branch, or if none of the
337     // arguments requires saving, then use the unconditional cleanup.
338     if (!isInConditionalBranch())
339       return EHStack.pushCleanup<T>(kind, a0, a1);
340 
341     typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
342     typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
343 
344     typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
345     EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
346     initFullExprCleanup();
347   }
348 
349   /// pushFullExprCleanup - Push a cleanup to be run at the end of the
350   /// current full-expression.  Safe against the possibility that
351   /// we're currently inside a conditionally-evaluated expression.
352   template <class T, class A0, class A1, class A2>
353   void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
354     // If we're not in a conditional branch, or if none of the
355     // arguments requires saving, then use the unconditional cleanup.
356     if (!isInConditionalBranch()) {
357       return EHStack.pushCleanup<T>(kind, a0, a1, a2);
358     }
359 
360     typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
361     typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
362     typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
363 
364     typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
365     EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
366     initFullExprCleanup();
367   }
368 
369   /// pushFullExprCleanup - Push a cleanup to be run at the end of the
370   /// current full-expression.  Safe against the possibility that
371   /// we're currently inside a conditionally-evaluated expression.
372   template <class T, class A0, class A1, class A2, class A3>
373   void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
374     // If we're not in a conditional branch, or if none of the
375     // arguments requires saving, then use the unconditional cleanup.
376     if (!isInConditionalBranch()) {
377       return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
378     }
379 
380     typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
381     typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
382     typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
383     typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
384 
385     typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
386     EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
387                                      a2_saved, a3_saved);
388     initFullExprCleanup();
389   }
390 
391   /// \brief Queue a cleanup to be pushed after finishing the current
392   /// full-expression.
393   template <class T, class A0, class A1, class A2, class A3>
394   void pushCleanupAfterFullExpr(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
395     assert(!isInConditionalBranch() && "can't defer conditional cleanup");
396 
397     LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
398 
399     size_t OldSize = LifetimeExtendedCleanupStack.size();
400     LifetimeExtendedCleanupStack.resize(
401         LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
402 
403     char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
404     new (Buffer) LifetimeExtendedCleanupHeader(Header);
405     new (Buffer + sizeof(Header)) T(a0, a1, a2, a3);
406   }
407 
408   /// Set up the last cleaup that was pushed as a conditional
409   /// full-expression cleanup.
410   void initFullExprCleanup();
411 
412   /// PushDestructorCleanup - Push a cleanup to call the
413   /// complete-object destructor of an object of the given type at the
414   /// given address.  Does nothing if T is not a C++ class type with a
415   /// non-trivial destructor.
416   void PushDestructorCleanup(QualType T, llvm::Value *Addr);
417 
418   /// PushDestructorCleanup - Push a cleanup to call the
419   /// complete-object variant of the given destructor on the object at
420   /// the given address.
421   void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
422                              llvm::Value *Addr);
423 
424   /// PopCleanupBlock - Will pop the cleanup entry on the stack and
425   /// process all branch fixups.
426   void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
427 
428   /// DeactivateCleanupBlock - Deactivates the given cleanup block.
429   /// The block cannot be reactivated.  Pops it if it's the top of the
430   /// stack.
431   ///
432   /// \param DominatingIP - An instruction which is known to
433   ///   dominate the current IP (if set) and which lies along
434   ///   all paths of execution between the current IP and the
435   ///   the point at which the cleanup comes into scope.
436   void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
437                               llvm::Instruction *DominatingIP);
438 
439   /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
440   /// Cannot be used to resurrect a deactivated cleanup.
441   ///
442   /// \param DominatingIP - An instruction which is known to
443   ///   dominate the current IP (if set) and which lies along
444   ///   all paths of execution between the current IP and the
445   ///   the point at which the cleanup comes into scope.
446   void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
447                             llvm::Instruction *DominatingIP);
448 
449   /// \brief Enters a new scope for capturing cleanups, all of which
450   /// will be executed once the scope is exited.
451   class RunCleanupsScope {
452     EHScopeStack::stable_iterator CleanupStackDepth;
453     size_t LifetimeExtendedCleanupStackSize;
454     bool OldDidCallStackSave;
455   protected:
456     bool PerformCleanup;
457   private:
458 
459     RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
460     void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
461 
462   protected:
463     CodeGenFunction& CGF;
464 
465   public:
466     /// \brief Enter a new cleanup scope.
467     explicit RunCleanupsScope(CodeGenFunction &CGF)
468       : PerformCleanup(true), CGF(CGF)
469     {
470       CleanupStackDepth = CGF.EHStack.stable_begin();
471       LifetimeExtendedCleanupStackSize =
472           CGF.LifetimeExtendedCleanupStack.size();
473       OldDidCallStackSave = CGF.DidCallStackSave;
474       CGF.DidCallStackSave = false;
475     }
476 
477     /// \brief Exit this cleanup scope, emitting any accumulated
478     /// cleanups.
479     ~RunCleanupsScope() {
480       if (PerformCleanup) {
481         CGF.DidCallStackSave = OldDidCallStackSave;
482         CGF.PopCleanupBlocks(CleanupStackDepth,
483                              LifetimeExtendedCleanupStackSize);
484       }
485     }
486 
487     /// \brief Determine whether this scope requires any cleanups.
488     bool requiresCleanups() const {
489       return CGF.EHStack.stable_begin() != CleanupStackDepth;
490     }
491 
492     /// \brief Force the emission of cleanups now, instead of waiting
493     /// until this object is destroyed.
494     void ForceCleanup() {
495       assert(PerformCleanup && "Already forced cleanup");
496       CGF.DidCallStackSave = OldDidCallStackSave;
497       CGF.PopCleanupBlocks(CleanupStackDepth,
498                            LifetimeExtendedCleanupStackSize);
499       PerformCleanup = false;
500     }
501   };
502 
503   class LexicalScope: protected RunCleanupsScope {
504     SourceRange Range;
505     SmallVector<const LabelDecl*, 4> Labels;
506     LexicalScope *ParentScope;
507 
508     LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
509     void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
510 
511   public:
512     /// \brief Enter a new cleanup scope.
513     explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
514       : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
515       CGF.CurLexicalScope = this;
516       if (CGDebugInfo *DI = CGF.getDebugInfo())
517         DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
518     }
519 
520     void addLabel(const LabelDecl *label) {
521       assert(PerformCleanup && "adding label to dead scope?");
522       Labels.push_back(label);
523     }
524 
525     /// \brief Exit this cleanup scope, emitting any accumulated
526     /// cleanups.
527     ~LexicalScope() {
528       if (CGDebugInfo *DI = CGF.getDebugInfo())
529         DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
530 
531       // If we should perform a cleanup, force them now.  Note that
532       // this ends the cleanup scope before rescoping any labels.
533       if (PerformCleanup) ForceCleanup();
534     }
535 
536     /// \brief Force the emission of cleanups now, instead of waiting
537     /// until this object is destroyed.
538     void ForceCleanup() {
539       CGF.CurLexicalScope = ParentScope;
540       RunCleanupsScope::ForceCleanup();
541 
542       if (!Labels.empty())
543         rescopeLabels();
544     }
545 
546     void rescopeLabels();
547   };
548 
549 
550   /// \brief Takes the old cleanup stack size and emits the cleanup blocks
551   /// that have been added.
552   void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
553 
554   /// \brief Takes the old cleanup stack size and emits the cleanup blocks
555   /// that have been added, then adds all lifetime-extended cleanups from
556   /// the given position to the stack.
557   void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
558                         size_t OldLifetimeExtendedStackSize);
559 
560   void ResolveBranchFixups(llvm::BasicBlock *Target);
561 
562   /// The given basic block lies in the current EH scope, but may be a
563   /// target of a potentially scope-crossing jump; get a stable handle
564   /// to which we can perform this jump later.
565   JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
566     return JumpDest(Target,
567                     EHStack.getInnermostNormalCleanup(),
568                     NextCleanupDestIndex++);
569   }
570 
571   /// The given basic block lies in the current EH scope, but may be a
572   /// target of a potentially scope-crossing jump; get a stable handle
573   /// to which we can perform this jump later.
574   JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
575     return getJumpDestInCurrentScope(createBasicBlock(Name));
576   }
577 
578   /// EmitBranchThroughCleanup - Emit a branch from the current insert
579   /// block through the normal cleanup handling code (if any) and then
580   /// on to \arg Dest.
581   void EmitBranchThroughCleanup(JumpDest Dest);
582 
583   /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
584   /// specified destination obviously has no cleanups to run.  'false' is always
585   /// a conservatively correct answer for this method.
586   bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
587 
588   /// popCatchScope - Pops the catch scope at the top of the EHScope
589   /// stack, emitting any required code (other than the catch handlers
590   /// themselves).
591   void popCatchScope();
592 
593   llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
594   llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
595 
596   /// An object to manage conditionally-evaluated expressions.
597   class ConditionalEvaluation {
598     llvm::BasicBlock *StartBB;
599 
600   public:
601     ConditionalEvaluation(CodeGenFunction &CGF)
602       : StartBB(CGF.Builder.GetInsertBlock()) {}
603 
604     void begin(CodeGenFunction &CGF) {
605       assert(CGF.OutermostConditional != this);
606       if (!CGF.OutermostConditional)
607         CGF.OutermostConditional = this;
608     }
609 
610     void end(CodeGenFunction &CGF) {
611       assert(CGF.OutermostConditional != 0);
612       if (CGF.OutermostConditional == this)
613         CGF.OutermostConditional = 0;
614     }
615 
616     /// Returns a block which will be executed prior to each
617     /// evaluation of the conditional code.
618     llvm::BasicBlock *getStartingBlock() const {
619       return StartBB;
620     }
621   };
622 
623   /// isInConditionalBranch - Return true if we're currently emitting
624   /// one branch or the other of a conditional expression.
625   bool isInConditionalBranch() const { return OutermostConditional != 0; }
626 
627   void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
628     assert(isInConditionalBranch());
629     llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
630     new llvm::StoreInst(value, addr, &block->back());
631   }
632 
633   /// An RAII object to record that we're evaluating a statement
634   /// expression.
635   class StmtExprEvaluation {
636     CodeGenFunction &CGF;
637 
638     /// We have to save the outermost conditional: cleanups in a
639     /// statement expression aren't conditional just because the
640     /// StmtExpr is.
641     ConditionalEvaluation *SavedOutermostConditional;
642 
643   public:
644     StmtExprEvaluation(CodeGenFunction &CGF)
645       : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
646       CGF.OutermostConditional = 0;
647     }
648 
649     ~StmtExprEvaluation() {
650       CGF.OutermostConditional = SavedOutermostConditional;
651       CGF.EnsureInsertPoint();
652     }
653   };
654 
655   /// An object which temporarily prevents a value from being
656   /// destroyed by aggressive peephole optimizations that assume that
657   /// all uses of a value have been realized in the IR.
658   class PeepholeProtection {
659     llvm::Instruction *Inst;
660     friend class CodeGenFunction;
661 
662   public:
663     PeepholeProtection() : Inst(0) {}
664   };
665 
666   /// A non-RAII class containing all the information about a bound
667   /// opaque value.  OpaqueValueMapping, below, is a RAII wrapper for
668   /// this which makes individual mappings very simple; using this
669   /// class directly is useful when you have a variable number of
670   /// opaque values or don't want the RAII functionality for some
671   /// reason.
672   class OpaqueValueMappingData {
673     const OpaqueValueExpr *OpaqueValue;
674     bool BoundLValue;
675     CodeGenFunction::PeepholeProtection Protection;
676 
677     OpaqueValueMappingData(const OpaqueValueExpr *ov,
678                            bool boundLValue)
679       : OpaqueValue(ov), BoundLValue(boundLValue) {}
680   public:
681     OpaqueValueMappingData() : OpaqueValue(0) {}
682 
683     static bool shouldBindAsLValue(const Expr *expr) {
684       // gl-values should be bound as l-values for obvious reasons.
685       // Records should be bound as l-values because IR generation
686       // always keeps them in memory.  Expressions of function type
687       // act exactly like l-values but are formally required to be
688       // r-values in C.
689       return expr->isGLValue() ||
690              expr->getType()->isRecordType() ||
691              expr->getType()->isFunctionType();
692     }
693 
694     static OpaqueValueMappingData bind(CodeGenFunction &CGF,
695                                        const OpaqueValueExpr *ov,
696                                        const Expr *e) {
697       if (shouldBindAsLValue(ov))
698         return bind(CGF, ov, CGF.EmitLValue(e));
699       return bind(CGF, ov, CGF.EmitAnyExpr(e));
700     }
701 
702     static OpaqueValueMappingData bind(CodeGenFunction &CGF,
703                                        const OpaqueValueExpr *ov,
704                                        const LValue &lv) {
705       assert(shouldBindAsLValue(ov));
706       CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
707       return OpaqueValueMappingData(ov, true);
708     }
709 
710     static OpaqueValueMappingData bind(CodeGenFunction &CGF,
711                                        const OpaqueValueExpr *ov,
712                                        const RValue &rv) {
713       assert(!shouldBindAsLValue(ov));
714       CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
715 
716       OpaqueValueMappingData data(ov, false);
717 
718       // Work around an extremely aggressive peephole optimization in
719       // EmitScalarConversion which assumes that all other uses of a
720       // value are extant.
721       data.Protection = CGF.protectFromPeepholes(rv);
722 
723       return data;
724     }
725 
726     bool isValid() const { return OpaqueValue != 0; }
727     void clear() { OpaqueValue = 0; }
728 
729     void unbind(CodeGenFunction &CGF) {
730       assert(OpaqueValue && "no data to unbind!");
731 
732       if (BoundLValue) {
733         CGF.OpaqueLValues.erase(OpaqueValue);
734       } else {
735         CGF.OpaqueRValues.erase(OpaqueValue);
736         CGF.unprotectFromPeepholes(Protection);
737       }
738     }
739   };
740 
741   /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
742   class OpaqueValueMapping {
743     CodeGenFunction &CGF;
744     OpaqueValueMappingData Data;
745 
746   public:
747     static bool shouldBindAsLValue(const Expr *expr) {
748       return OpaqueValueMappingData::shouldBindAsLValue(expr);
749     }
750 
751     /// Build the opaque value mapping for the given conditional
752     /// operator if it's the GNU ?: extension.  This is a common
753     /// enough pattern that the convenience operator is really
754     /// helpful.
755     ///
756     OpaqueValueMapping(CodeGenFunction &CGF,
757                        const AbstractConditionalOperator *op) : CGF(CGF) {
758       if (isa<ConditionalOperator>(op))
759         // Leave Data empty.
760         return;
761 
762       const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
763       Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
764                                           e->getCommon());
765     }
766 
767     OpaqueValueMapping(CodeGenFunction &CGF,
768                        const OpaqueValueExpr *opaqueValue,
769                        LValue lvalue)
770       : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
771     }
772 
773     OpaqueValueMapping(CodeGenFunction &CGF,
774                        const OpaqueValueExpr *opaqueValue,
775                        RValue rvalue)
776       : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
777     }
778 
779     void pop() {
780       Data.unbind(CGF);
781       Data.clear();
782     }
783 
784     ~OpaqueValueMapping() {
785       if (Data.isValid()) Data.unbind(CGF);
786     }
787   };
788 
789   /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
790   /// number that holds the value.
791   unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
792 
793   /// BuildBlockByrefAddress - Computes address location of the
794   /// variable which is declared as __block.
795   llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
796                                       const VarDecl *V);
797 private:
798   CGDebugInfo *DebugInfo;
799   bool DisableDebugInfo;
800 
801   /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
802   /// calling llvm.stacksave for multiple VLAs in the same scope.
803   bool DidCallStackSave;
804 
805   /// IndirectBranch - The first time an indirect goto is seen we create a block
806   /// with an indirect branch.  Every time we see the address of a label taken,
807   /// we add the label to the indirect goto.  Every subsequent indirect goto is
808   /// codegen'd as a jump to the IndirectBranch's basic block.
809   llvm::IndirectBrInst *IndirectBranch;
810 
811   /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
812   /// decls.
813   typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
814   DeclMapTy LocalDeclMap;
815 
816   /// LabelMap - This keeps track of the LLVM basic block for each C label.
817   llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
818 
819   // BreakContinueStack - This keeps track of where break and continue
820   // statements should jump to.
821   struct BreakContinue {
822     BreakContinue(JumpDest Break, JumpDest Continue)
823       : BreakBlock(Break), ContinueBlock(Continue) {}
824 
825     JumpDest BreakBlock;
826     JumpDest ContinueBlock;
827   };
828   SmallVector<BreakContinue, 8> BreakContinueStack;
829 
830   /// SwitchInsn - This is nearest current switch instruction. It is null if
831   /// current context is not in a switch.
832   llvm::SwitchInst *SwitchInsn;
833 
834   /// CaseRangeBlock - This block holds if condition check for last case
835   /// statement range in current switch instruction.
836   llvm::BasicBlock *CaseRangeBlock;
837 
838   /// OpaqueLValues - Keeps track of the current set of opaque value
839   /// expressions.
840   llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
841   llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
842 
843   // VLASizeMap - This keeps track of the associated size for each VLA type.
844   // We track this by the size expression rather than the type itself because
845   // in certain situations, like a const qualifier applied to an VLA typedef,
846   // multiple VLA types can share the same size expression.
847   // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
848   // enter/leave scopes.
849   llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
850 
851   /// A block containing a single 'unreachable' instruction.  Created
852   /// lazily by getUnreachableBlock().
853   llvm::BasicBlock *UnreachableBlock;
854 
855   /// Counts of the number return expressions in the function.
856   unsigned NumReturnExprs;
857 
858   /// Count the number of simple (constant) return expressions in the function.
859   unsigned NumSimpleReturnExprs;
860 
861   /// The last regular (non-return) debug location (breakpoint) in the function.
862   SourceLocation LastStopPoint;
863 
864 public:
865   /// A scope within which we are constructing the fields of an object which
866   /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
867   /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
868   class FieldConstructionScope {
869   public:
870     FieldConstructionScope(CodeGenFunction &CGF, llvm::Value *This)
871         : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
872       CGF.CXXDefaultInitExprThis = This;
873     }
874     ~FieldConstructionScope() {
875       CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
876     }
877 
878   private:
879     CodeGenFunction &CGF;
880     llvm::Value *OldCXXDefaultInitExprThis;
881   };
882 
883   /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
884   /// is overridden to be the object under construction.
885   class CXXDefaultInitExprScope {
886   public:
887     CXXDefaultInitExprScope(CodeGenFunction &CGF)
888         : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue) {
889       CGF.CXXThisValue = CGF.CXXDefaultInitExprThis;
890     }
891     ~CXXDefaultInitExprScope() {
892       CGF.CXXThisValue = OldCXXThisValue;
893     }
894 
895   public:
896     CodeGenFunction &CGF;
897     llvm::Value *OldCXXThisValue;
898   };
899 
900 private:
901   /// CXXThisDecl - When generating code for a C++ member function,
902   /// this will hold the implicit 'this' declaration.
903   ImplicitParamDecl *CXXABIThisDecl;
904   llvm::Value *CXXABIThisValue;
905   llvm::Value *CXXThisValue;
906 
907   /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
908   /// this expression.
909   llvm::Value *CXXDefaultInitExprThis;
910 
911   /// CXXStructorImplicitParamDecl - When generating code for a constructor or
912   /// destructor, this will hold the implicit argument (e.g. VTT).
913   ImplicitParamDecl *CXXStructorImplicitParamDecl;
914   llvm::Value *CXXStructorImplicitParamValue;
915 
916   /// OutermostConditional - Points to the outermost active
917   /// conditional control.  This is used so that we know if a
918   /// temporary should be destroyed conditionally.
919   ConditionalEvaluation *OutermostConditional;
920 
921   /// The current lexical scope.
922   LexicalScope *CurLexicalScope;
923 
924   /// The current source location that should be used for exception
925   /// handling code.
926   SourceLocation CurEHLocation;
927 
928   /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
929   /// type as well as the field number that contains the actual data.
930   llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
931                                               unsigned> > ByRefValueInfo;
932 
933   llvm::BasicBlock *TerminateLandingPad;
934   llvm::BasicBlock *TerminateHandler;
935   llvm::BasicBlock *TrapBB;
936 
937   /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
938   /// In the kernel metadata node, reference the kernel function and metadata
939   /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
940   /// - A node for the vec_type_hint(<type>) qualifier contains string
941   ///   "vec_type_hint", an undefined value of the <type> data type,
942   ///   and a Boolean that is true if the <type> is integer and signed.
943   /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
944   ///   "work_group_size_hint", and three 32-bit integers X, Y and Z.
945   /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
946   ///   "reqd_work_group_size", and three 32-bit integers X, Y and Z.
947   void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
948                                 llvm::Function *Fn);
949 
950 public:
951   CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
952   ~CodeGenFunction();
953 
954   CodeGenTypes &getTypes() const { return CGM.getTypes(); }
955   ASTContext &getContext() const { return CGM.getContext(); }
956   CGDebugInfo *getDebugInfo() {
957     if (DisableDebugInfo)
958       return NULL;
959     return DebugInfo;
960   }
961   void disableDebugInfo() { DisableDebugInfo = true; }
962   void enableDebugInfo() { DisableDebugInfo = false; }
963 
964   bool shouldUseFusedARCCalls() {
965     return CGM.getCodeGenOpts().OptimizationLevel == 0;
966   }
967 
968   const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
969 
970   /// Returns a pointer to the function's exception object and selector slot,
971   /// which is assigned in every landing pad.
972   llvm::Value *getExceptionSlot();
973   llvm::Value *getEHSelectorSlot();
974 
975   /// Returns the contents of the function's exception object and selector
976   /// slots.
977   llvm::Value *getExceptionFromSlot();
978   llvm::Value *getSelectorFromSlot();
979 
980   llvm::Value *getNormalCleanupDestSlot();
981 
982   llvm::BasicBlock *getUnreachableBlock() {
983     if (!UnreachableBlock) {
984       UnreachableBlock = createBasicBlock("unreachable");
985       new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
986     }
987     return UnreachableBlock;
988   }
989 
990   llvm::BasicBlock *getInvokeDest() {
991     if (!EHStack.requiresLandingPad()) return 0;
992     return getInvokeDestImpl();
993   }
994 
995   const TargetInfo &getTarget() const { return Target; }
996   llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
997 
998   //===--------------------------------------------------------------------===//
999   //                                  Cleanups
1000   //===--------------------------------------------------------------------===//
1001 
1002   typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1003 
1004   void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1005                                         llvm::Value *arrayEndPointer,
1006                                         QualType elementType,
1007                                         Destroyer *destroyer);
1008   void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1009                                       llvm::Value *arrayEnd,
1010                                       QualType elementType,
1011                                       Destroyer *destroyer);
1012 
1013   void pushDestroy(QualType::DestructionKind dtorKind,
1014                    llvm::Value *addr, QualType type);
1015   void pushEHDestroy(QualType::DestructionKind dtorKind,
1016                      llvm::Value *addr, QualType type);
1017   void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
1018                    Destroyer *destroyer, bool useEHCleanupForArray);
1019   void pushLifetimeExtendedDestroy(CleanupKind kind, llvm::Value *addr,
1020                                    QualType type, Destroyer *destroyer,
1021                                    bool useEHCleanupForArray);
1022   void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
1023                    bool useEHCleanupForArray);
1024   llvm::Function *generateDestroyHelper(llvm::Constant *addr, QualType type,
1025                                         Destroyer *destroyer,
1026                                         bool useEHCleanupForArray,
1027                                         const VarDecl *VD);
1028   void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
1029                         QualType type, Destroyer *destroyer,
1030                         bool checkZeroLength, bool useEHCleanup);
1031 
1032   Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
1033 
1034   /// Determines whether an EH cleanup is required to destroy a type
1035   /// with the given destruction kind.
1036   bool needsEHCleanup(QualType::DestructionKind kind) {
1037     switch (kind) {
1038     case QualType::DK_none:
1039       return false;
1040     case QualType::DK_cxx_destructor:
1041     case QualType::DK_objc_weak_lifetime:
1042       return getLangOpts().Exceptions;
1043     case QualType::DK_objc_strong_lifetime:
1044       return getLangOpts().Exceptions &&
1045              CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1046     }
1047     llvm_unreachable("bad destruction kind");
1048   }
1049 
1050   CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1051     return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1052   }
1053 
1054   //===--------------------------------------------------------------------===//
1055   //                                  Objective-C
1056   //===--------------------------------------------------------------------===//
1057 
1058   void GenerateObjCMethod(const ObjCMethodDecl *OMD);
1059 
1060   void StartObjCMethod(const ObjCMethodDecl *MD,
1061                        const ObjCContainerDecl *CD,
1062                        SourceLocation StartLoc);
1063 
1064   /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
1065   void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1066                           const ObjCPropertyImplDecl *PID);
1067   void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
1068                               const ObjCPropertyImplDecl *propImpl,
1069                               const ObjCMethodDecl *GetterMothodDecl,
1070                               llvm::Constant *AtomicHelperFn);
1071 
1072   void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1073                                   ObjCMethodDecl *MD, bool ctor);
1074 
1075   /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1076   /// for the given property.
1077   void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1078                           const ObjCPropertyImplDecl *PID);
1079   void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
1080                               const ObjCPropertyImplDecl *propImpl,
1081                               llvm::Constant *AtomicHelperFn);
1082   bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
1083   bool IvarTypeWithAggrGCObjects(QualType Ty);
1084 
1085   //===--------------------------------------------------------------------===//
1086   //                                  Block Bits
1087   //===--------------------------------------------------------------------===//
1088 
1089   llvm::Value *EmitBlockLiteral(const BlockExpr *);
1090   llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1091   static void destroyBlockInfos(CGBlockInfo *info);
1092   llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
1093                                            const CGBlockInfo &Info,
1094                                            llvm::StructType *,
1095                                            llvm::Constant *BlockVarLayout);
1096 
1097   llvm::Function *GenerateBlockFunction(GlobalDecl GD,
1098                                         const CGBlockInfo &Info,
1099                                         const DeclMapTy &ldm,
1100                                         bool IsLambdaConversionToBlock);
1101 
1102   llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1103   llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
1104   llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1105                                              const ObjCPropertyImplDecl *PID);
1106   llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1107                                              const ObjCPropertyImplDecl *PID);
1108   llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
1109 
1110   void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1111 
1112   class AutoVarEmission;
1113 
1114   void emitByrefStructureInit(const AutoVarEmission &emission);
1115   void enterByrefCleanup(const AutoVarEmission &emission);
1116 
1117   llvm::Value *LoadBlockStruct() {
1118     assert(BlockPointer && "no block pointer set!");
1119     return BlockPointer;
1120   }
1121 
1122   void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
1123   void AllocateBlockDecl(const DeclRefExpr *E);
1124   llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1125   llvm::Type *BuildByRefType(const VarDecl *var);
1126 
1127   void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1128                     const CGFunctionInfo &FnInfo);
1129   void StartFunction(GlobalDecl GD,
1130                      QualType RetTy,
1131                      llvm::Function *Fn,
1132                      const CGFunctionInfo &FnInfo,
1133                      const FunctionArgList &Args,
1134                      SourceLocation StartLoc);
1135 
1136   void EmitConstructorBody(FunctionArgList &Args);
1137   void EmitDestructorBody(FunctionArgList &Args);
1138   void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
1139   void EmitFunctionBody(FunctionArgList &Args);
1140 
1141   void EmitForwardingCallToLambda(const CXXRecordDecl *Lambda,
1142                                   CallArgList &CallArgs);
1143   void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
1144   void EmitLambdaBlockInvokeBody();
1145   void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1146   void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
1147 
1148   /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1149   /// emission when possible.
1150   void EmitReturnBlock();
1151 
1152   /// FinishFunction - Complete IR generation of the current function. It is
1153   /// legal to call this function even if there is no current insertion point.
1154   void FinishFunction(SourceLocation EndLoc=SourceLocation());
1155 
1156   /// GenerateThunk - Generate a thunk for the given method.
1157   void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1158                      GlobalDecl GD, const ThunkInfo &Thunk);
1159 
1160   void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1161                             GlobalDecl GD, const ThunkInfo &Thunk);
1162 
1163   void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1164                         FunctionArgList &Args);
1165 
1166   void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
1167                                ArrayRef<VarDecl *> ArrayIndexes);
1168 
1169   /// InitializeVTablePointer - Initialize the vtable pointer of the given
1170   /// subobject.
1171   ///
1172   void InitializeVTablePointer(BaseSubobject Base,
1173                                const CXXRecordDecl *NearestVBase,
1174                                CharUnits OffsetFromNearestVBase,
1175                                const CXXRecordDecl *VTableClass);
1176 
1177   typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1178   void InitializeVTablePointers(BaseSubobject Base,
1179                                 const CXXRecordDecl *NearestVBase,
1180                                 CharUnits OffsetFromNearestVBase,
1181                                 bool BaseIsNonVirtualPrimaryBase,
1182                                 const CXXRecordDecl *VTableClass,
1183                                 VisitedVirtualBasesSetTy& VBases);
1184 
1185   void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
1186 
1187   /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1188   /// to by This.
1189   llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
1190 
1191 
1192   /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1193   /// expr can be devirtualized.
1194   bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1195                                          const CXXMethodDecl *MD);
1196 
1197   /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1198   /// given phase of destruction for a destructor.  The end result
1199   /// should call destructors on members and base classes in reverse
1200   /// order of their construction.
1201   void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
1202 
1203   /// ShouldInstrumentFunction - Return true if the current function should be
1204   /// instrumented with __cyg_profile_func_* calls
1205   bool ShouldInstrumentFunction();
1206 
1207   /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1208   /// instrumentation function with the current function and the call site, if
1209   /// function instrumentation is enabled.
1210   void EmitFunctionInstrumentation(const char *Fn);
1211 
1212   /// EmitMCountInstrumentation - Emit call to .mcount.
1213   void EmitMCountInstrumentation();
1214 
1215   /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1216   /// arguments for the given function. This is also responsible for naming the
1217   /// LLVM function arguments.
1218   void EmitFunctionProlog(const CGFunctionInfo &FI,
1219                           llvm::Function *Fn,
1220                           const FunctionArgList &Args);
1221 
1222   /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1223   /// given temporary.
1224   void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc);
1225 
1226   /// EmitStartEHSpec - Emit the start of the exception spec.
1227   void EmitStartEHSpec(const Decl *D);
1228 
1229   /// EmitEndEHSpec - Emit the end of the exception spec.
1230   void EmitEndEHSpec(const Decl *D);
1231 
1232   /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1233   llvm::BasicBlock *getTerminateLandingPad();
1234 
1235   /// getTerminateHandler - Return a handler (not a landing pad, just
1236   /// a catch handler) that just calls terminate.  This is used when
1237   /// a terminate scope encloses a try.
1238   llvm::BasicBlock *getTerminateHandler();
1239 
1240   llvm::Type *ConvertTypeForMem(QualType T);
1241   llvm::Type *ConvertType(QualType T);
1242   llvm::Type *ConvertType(const TypeDecl *T) {
1243     return ConvertType(getContext().getTypeDeclType(T));
1244   }
1245 
1246   /// LoadObjCSelf - Load the value of self. This function is only valid while
1247   /// generating code for an Objective-C method.
1248   llvm::Value *LoadObjCSelf();
1249 
1250   /// TypeOfSelfObject - Return type of object that this self represents.
1251   QualType TypeOfSelfObject();
1252 
1253   /// hasAggregateLLVMType - Return true if the specified AST type will map into
1254   /// an aggregate LLVM type or is void.
1255   static TypeEvaluationKind getEvaluationKind(QualType T);
1256 
1257   static bool hasScalarEvaluationKind(QualType T) {
1258     return getEvaluationKind(T) == TEK_Scalar;
1259   }
1260 
1261   static bool hasAggregateEvaluationKind(QualType T) {
1262     return getEvaluationKind(T) == TEK_Aggregate;
1263   }
1264 
1265   /// createBasicBlock - Create an LLVM basic block.
1266   llvm::BasicBlock *createBasicBlock(const Twine &name = "",
1267                                      llvm::Function *parent = 0,
1268                                      llvm::BasicBlock *before = 0) {
1269 #ifdef NDEBUG
1270     return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
1271 #else
1272     return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
1273 #endif
1274   }
1275 
1276   /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1277   /// label maps to.
1278   JumpDest getJumpDestForLabel(const LabelDecl *S);
1279 
1280   /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1281   /// another basic block, simplify it. This assumes that no other code could
1282   /// potentially reference the basic block.
1283   void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1284 
1285   /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1286   /// adding a fall-through branch from the current insert block if
1287   /// necessary. It is legal to call this function even if there is no current
1288   /// insertion point.
1289   ///
1290   /// IsFinished - If true, indicates that the caller has finished emitting
1291   /// branches to the given block and does not expect to emit code into it. This
1292   /// means the block can be ignored if it is unreachable.
1293   void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
1294 
1295   /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1296   /// near its uses, and leave the insertion point in it.
1297   void EmitBlockAfterUses(llvm::BasicBlock *BB);
1298 
1299   /// EmitBranch - Emit a branch to the specified basic block from the current
1300   /// insert block, taking care to avoid creation of branches from dummy
1301   /// blocks. It is legal to call this function even if there is no current
1302   /// insertion point.
1303   ///
1304   /// This function clears the current insertion point. The caller should follow
1305   /// calls to this function with calls to Emit*Block prior to generation new
1306   /// code.
1307   void EmitBranch(llvm::BasicBlock *Block);
1308 
1309   /// HaveInsertPoint - True if an insertion point is defined. If not, this
1310   /// indicates that the current code being emitted is unreachable.
1311   bool HaveInsertPoint() const {
1312     return Builder.GetInsertBlock() != 0;
1313   }
1314 
1315   /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1316   /// emitted IR has a place to go. Note that by definition, if this function
1317   /// creates a block then that block is unreachable; callers may do better to
1318   /// detect when no insertion point is defined and simply skip IR generation.
1319   void EnsureInsertPoint() {
1320     if (!HaveInsertPoint())
1321       EmitBlock(createBasicBlock());
1322   }
1323 
1324   /// ErrorUnsupported - Print out an error that codegen doesn't support the
1325   /// specified stmt yet.
1326   void ErrorUnsupported(const Stmt *S, const char *Type);
1327 
1328   //===--------------------------------------------------------------------===//
1329   //                                  Helpers
1330   //===--------------------------------------------------------------------===//
1331 
1332   LValue MakeAddrLValue(llvm::Value *V, QualType T,
1333                         CharUnits Alignment = CharUnits()) {
1334     return LValue::MakeAddr(V, T, Alignment, getContext(),
1335                             CGM.getTBAAInfo(T));
1336   }
1337 
1338   LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
1339     CharUnits Alignment;
1340     if (!T->isIncompleteType())
1341       Alignment = getContext().getTypeAlignInChars(T);
1342     return LValue::MakeAddr(V, T, Alignment, getContext(),
1343                             CGM.getTBAAInfo(T));
1344   }
1345 
1346   /// CreateTempAlloca - This creates a alloca and inserts it into the entry
1347   /// block. The caller is responsible for setting an appropriate alignment on
1348   /// the alloca.
1349   llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
1350                                      const Twine &Name = "tmp");
1351 
1352   /// InitTempAlloca - Provide an initial value for the given alloca.
1353   void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1354 
1355   /// CreateIRTemp - Create a temporary IR object of the given type, with
1356   /// appropriate alignment. This routine should only be used when an temporary
1357   /// value needs to be stored into an alloca (for example, to avoid explicit
1358   /// PHI construction), but the type is the IR type, not the type appropriate
1359   /// for storing in memory.
1360   llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
1361 
1362   /// CreateMemTemp - Create a temporary memory object of the given type, with
1363   /// appropriate alignment.
1364   llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
1365 
1366   /// CreateAggTemp - Create a temporary memory object for the given
1367   /// aggregate type.
1368   AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
1369     CharUnits Alignment = getContext().getTypeAlignInChars(T);
1370     return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1371                                  T.getQualifiers(),
1372                                  AggValueSlot::IsNotDestructed,
1373                                  AggValueSlot::DoesNotNeedGCBarriers,
1374                                  AggValueSlot::IsNotAliased);
1375   }
1376 
1377   /// Emit a cast to void* in the appropriate address space.
1378   llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1379 
1380   /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1381   /// expression and compare the result against zero, returning an Int1Ty value.
1382   llvm::Value *EvaluateExprAsBool(const Expr *E);
1383 
1384   /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1385   void EmitIgnoredExpr(const Expr *E);
1386 
1387   /// EmitAnyExpr - Emit code to compute the specified expression which can have
1388   /// any type.  The result is returned as an RValue struct.  If this is an
1389   /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1390   /// the result should be returned.
1391   ///
1392   /// \param ignoreResult True if the resulting value isn't used.
1393   RValue EmitAnyExpr(const Expr *E,
1394                      AggValueSlot aggSlot = AggValueSlot::ignored(),
1395                      bool ignoreResult = false);
1396 
1397   // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1398   // or the value of the expression, depending on how va_list is defined.
1399   llvm::Value *EmitVAListRef(const Expr *E);
1400 
1401   /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1402   /// always be accessible even if no aggregate location is provided.
1403   RValue EmitAnyExprToTemp(const Expr *E);
1404 
1405   /// EmitAnyExprToMem - Emits the code necessary to evaluate an
1406   /// arbitrary expression into the given memory location.
1407   void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
1408                         Qualifiers Quals, bool IsInitializer);
1409 
1410   /// EmitExprAsInit - Emits the code necessary to initialize a
1411   /// location in memory with the given initializer.
1412   void EmitExprAsInit(const Expr *init, const ValueDecl *D,
1413                       LValue lvalue, bool capturedByInit);
1414 
1415   /// hasVolatileMember - returns true if aggregate type has a volatile
1416   /// member.
1417   bool hasVolatileMember(QualType T) {
1418     if (const RecordType *RT = T->getAs<RecordType>()) {
1419       const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1420       return RD->hasVolatileMember();
1421     }
1422     return false;
1423   }
1424   /// EmitAggregateCopy - Emit an aggregate assignment.
1425   ///
1426   /// The difference to EmitAggregateCopy is that tail padding is not copied.
1427   /// This is required for correctness when assigning non-POD structures in C++.
1428   void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
1429                            QualType EltTy) {
1430     bool IsVolatile = hasVolatileMember(EltTy);
1431     EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1432                       true);
1433   }
1434 
1435   /// EmitAggregateCopy - Emit an aggregate copy.
1436   ///
1437   /// \param isVolatile - True iff either the source or the destination is
1438   /// volatile.
1439   /// \param isAssignment - If false, allow padding to be copied.  This often
1440   /// yields more efficient.
1441   void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
1442                          QualType EltTy, bool isVolatile=false,
1443                          CharUnits Alignment = CharUnits::Zero(),
1444                          bool isAssignment = false);
1445 
1446   /// StartBlock - Start new block named N. If insert block is a dummy block
1447   /// then reuse it.
1448   void StartBlock(const char *N);
1449 
1450   /// GetAddrOfLocalVar - Return the address of a local variable.
1451   llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1452     llvm::Value *Res = LocalDeclMap[VD];
1453     assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1454     return Res;
1455   }
1456 
1457   /// getOpaqueLValueMapping - Given an opaque value expression (which
1458   /// must be mapped to an l-value), return its mapping.
1459   const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1460     assert(OpaqueValueMapping::shouldBindAsLValue(e));
1461 
1462     llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1463       it = OpaqueLValues.find(e);
1464     assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1465     return it->second;
1466   }
1467 
1468   /// getOpaqueRValueMapping - Given an opaque value expression (which
1469   /// must be mapped to an r-value), return its mapping.
1470   const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1471     assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1472 
1473     llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1474       it = OpaqueRValues.find(e);
1475     assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
1476     return it->second;
1477   }
1478 
1479   /// getAccessedFieldNo - Given an encoded value and a result number, return
1480   /// the input field number being accessed.
1481   static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1482 
1483   llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
1484   llvm::BasicBlock *GetIndirectGotoBlock();
1485 
1486   /// EmitNullInitialization - Generate code to set a value of the given type to
1487   /// null, If the type contains data member pointers, they will be initialized
1488   /// to -1 in accordance with the Itanium C++ ABI.
1489   void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
1490 
1491   // EmitVAArg - Generate code to get an argument from the passed in pointer
1492   // and update it accordingly. The return value is a pointer to the argument.
1493   // FIXME: We should be able to get rid of this method and use the va_arg
1494   // instruction in LLVM instead once it works well enough.
1495   llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
1496 
1497   /// emitArrayLength - Compute the length of an array, even if it's a
1498   /// VLA, and drill down to the base element type.
1499   llvm::Value *emitArrayLength(const ArrayType *arrayType,
1500                                QualType &baseType,
1501                                llvm::Value *&addr);
1502 
1503   /// EmitVLASize - Capture all the sizes for the VLA expressions in
1504   /// the given variably-modified type and store them in the VLASizeMap.
1505   ///
1506   /// This function can be called with a null (unreachable) insert point.
1507   void EmitVariablyModifiedType(QualType Ty);
1508 
1509   /// getVLASize - Returns an LLVM value that corresponds to the size,
1510   /// in non-variably-sized elements, of a variable length array type,
1511   /// plus that largest non-variably-sized element type.  Assumes that
1512   /// the type has already been emitted with EmitVariablyModifiedType.
1513   std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1514   std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
1515 
1516   /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1517   /// generating code for an C++ member function.
1518   llvm::Value *LoadCXXThis() {
1519     assert(CXXThisValue && "no 'this' value for this function");
1520     return CXXThisValue;
1521   }
1522 
1523   /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1524   /// virtual bases.
1525   // FIXME: Every place that calls LoadCXXVTT is something
1526   // that needs to be abstracted properly.
1527   llvm::Value *LoadCXXVTT() {
1528     assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1529     return CXXStructorImplicitParamValue;
1530   }
1531 
1532   /// LoadCXXStructorImplicitParam - Load the implicit parameter
1533   /// for a constructor/destructor.
1534   llvm::Value *LoadCXXStructorImplicitParam() {
1535     assert(CXXStructorImplicitParamValue &&
1536            "no implicit argument value for this function");
1537     return CXXStructorImplicitParamValue;
1538   }
1539 
1540   /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
1541   /// complete class to the given direct base.
1542   llvm::Value *
1543   GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1544                                         const CXXRecordDecl *Derived,
1545                                         const CXXRecordDecl *Base,
1546                                         bool BaseIsVirtual);
1547 
1548   /// GetAddressOfBaseClass - This function will add the necessary delta to the
1549   /// load of 'this' and returns address of the base class.
1550   llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
1551                                      const CXXRecordDecl *Derived,
1552                                      CastExpr::path_const_iterator PathBegin,
1553                                      CastExpr::path_const_iterator PathEnd,
1554                                      bool NullCheckValue);
1555 
1556   llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
1557                                         const CXXRecordDecl *Derived,
1558                                         CastExpr::path_const_iterator PathBegin,
1559                                         CastExpr::path_const_iterator PathEnd,
1560                                         bool NullCheckValue);
1561 
1562   /// GetVTTParameter - Return the VTT parameter that should be passed to a
1563   /// base constructor/destructor with virtual bases.
1564   /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1565   /// to ItaniumCXXABI.cpp together with all the references to VTT.
1566   llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1567                                bool Delegating);
1568 
1569   void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1570                                       CXXCtorType CtorType,
1571                                       const FunctionArgList &Args);
1572   // It's important not to confuse this and the previous function. Delegating
1573   // constructors are the C++0x feature. The constructor delegate optimization
1574   // is used to reduce duplication in the base and complete consturctors where
1575   // they are substantially the same.
1576   void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1577                                         const FunctionArgList &Args);
1578   void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
1579                               bool ForVirtualBase, bool Delegating,
1580                               llvm::Value *This,
1581                               CallExpr::const_arg_iterator ArgBeg,
1582                               CallExpr::const_arg_iterator ArgEnd);
1583 
1584   void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1585                               llvm::Value *This, llvm::Value *Src,
1586                               CallExpr::const_arg_iterator ArgBeg,
1587                               CallExpr::const_arg_iterator ArgEnd);
1588 
1589   void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1590                                   const ConstantArrayType *ArrayTy,
1591                                   llvm::Value *ArrayPtr,
1592                                   CallExpr::const_arg_iterator ArgBeg,
1593                                   CallExpr::const_arg_iterator ArgEnd,
1594                                   bool ZeroInitialization = false);
1595 
1596   void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1597                                   llvm::Value *NumElements,
1598                                   llvm::Value *ArrayPtr,
1599                                   CallExpr::const_arg_iterator ArgBeg,
1600                                   CallExpr::const_arg_iterator ArgEnd,
1601                                   bool ZeroInitialization = false);
1602 
1603   static Destroyer destroyCXXObject;
1604 
1605   void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
1606                              bool ForVirtualBase, bool Delegating,
1607                              llvm::Value *This);
1608 
1609   void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
1610                                llvm::Value *NewPtr, llvm::Value *NumElements);
1611 
1612   void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1613                         llvm::Value *Ptr);
1614 
1615   llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
1616   void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
1617 
1618   void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1619                       QualType DeleteTy);
1620 
1621   llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
1622   llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
1623   llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
1624 
1625   /// \brief Situations in which we might emit a check for the suitability of a
1626   ///        pointer or glvalue.
1627   enum TypeCheckKind {
1628     /// Checking the operand of a load. Must be suitably sized and aligned.
1629     TCK_Load,
1630     /// Checking the destination of a store. Must be suitably sized and aligned.
1631     TCK_Store,
1632     /// Checking the bound value in a reference binding. Must be suitably sized
1633     /// and aligned, but is not required to refer to an object (until the
1634     /// reference is used), per core issue 453.
1635     TCK_ReferenceBinding,
1636     /// Checking the object expression in a non-static data member access. Must
1637     /// be an object within its lifetime.
1638     TCK_MemberAccess,
1639     /// Checking the 'this' pointer for a call to a non-static member function.
1640     /// Must be an object within its lifetime.
1641     TCK_MemberCall,
1642     /// Checking the 'this' pointer for a constructor call.
1643     TCK_ConstructorCall,
1644     /// Checking the operand of a static_cast to a derived pointer type. Must be
1645     /// null or an object within its lifetime.
1646     TCK_DowncastPointer,
1647     /// Checking the operand of a static_cast to a derived reference type. Must
1648     /// be an object within its lifetime.
1649     TCK_DowncastReference
1650   };
1651 
1652   /// \brief Emit a check that \p V is the address of storage of the
1653   /// appropriate size and alignment for an object of type \p Type.
1654   void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
1655                      QualType Type, CharUnits Alignment = CharUnits::Zero());
1656 
1657   /// \brief Emit a check that \p Base points into an array object, which
1658   /// we can access at index \p Index. \p Accessed should be \c false if we
1659   /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1660   void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1661                        QualType IndexType, bool Accessed);
1662 
1663   llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1664                                        bool isInc, bool isPre);
1665   ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1666                                          bool isInc, bool isPre);
1667   //===--------------------------------------------------------------------===//
1668   //                            Declaration Emission
1669   //===--------------------------------------------------------------------===//
1670 
1671   /// EmitDecl - Emit a declaration.
1672   ///
1673   /// This function can be called with a null (unreachable) insert point.
1674   void EmitDecl(const Decl &D);
1675 
1676   /// EmitVarDecl - Emit a local variable declaration.
1677   ///
1678   /// This function can be called with a null (unreachable) insert point.
1679   void EmitVarDecl(const VarDecl &D);
1680 
1681   void EmitScalarInit(const Expr *init, const ValueDecl *D,
1682                       LValue lvalue, bool capturedByInit);
1683   void EmitScalarInit(llvm::Value *init, LValue lvalue);
1684 
1685   typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1686                              llvm::Value *Address);
1687 
1688   /// EmitAutoVarDecl - Emit an auto variable declaration.
1689   ///
1690   /// This function can be called with a null (unreachable) insert point.
1691   void EmitAutoVarDecl(const VarDecl &D);
1692 
1693   class AutoVarEmission {
1694     friend class CodeGenFunction;
1695 
1696     const VarDecl *Variable;
1697 
1698     /// The alignment of the variable.
1699     CharUnits Alignment;
1700 
1701     /// The address of the alloca.  Null if the variable was emitted
1702     /// as a global constant.
1703     llvm::Value *Address;
1704 
1705     llvm::Value *NRVOFlag;
1706 
1707     /// True if the variable is a __block variable.
1708     bool IsByRef;
1709 
1710     /// True if the variable is of aggregate type and has a constant
1711     /// initializer.
1712     bool IsConstantAggregate;
1713 
1714     /// Non-null if we should use lifetime annotations.
1715     llvm::Value *SizeForLifetimeMarkers;
1716 
1717     struct Invalid {};
1718     AutoVarEmission(Invalid) : Variable(0) {}
1719 
1720     AutoVarEmission(const VarDecl &variable)
1721       : Variable(&variable), Address(0), NRVOFlag(0),
1722         IsByRef(false), IsConstantAggregate(false),
1723         SizeForLifetimeMarkers(0) {}
1724 
1725     bool wasEmittedAsGlobal() const { return Address == 0; }
1726 
1727   public:
1728     static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1729 
1730     bool useLifetimeMarkers() const { return SizeForLifetimeMarkers != 0; }
1731     llvm::Value *getSizeForLifetimeMarkers() const {
1732       assert(useLifetimeMarkers());
1733       return SizeForLifetimeMarkers;
1734     }
1735 
1736     /// Returns the raw, allocated address, which is not necessarily
1737     /// the address of the object itself.
1738     llvm::Value *getAllocatedAddress() const {
1739       return Address;
1740     }
1741 
1742     /// Returns the address of the object within this declaration.
1743     /// Note that this does not chase the forwarding pointer for
1744     /// __block decls.
1745     llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1746       if (!IsByRef) return Address;
1747 
1748       return CGF.Builder.CreateStructGEP(Address,
1749                                          CGF.getByRefValueLLVMField(Variable),
1750                                          Variable->getNameAsString());
1751     }
1752   };
1753   AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1754   void EmitAutoVarInit(const AutoVarEmission &emission);
1755   void EmitAutoVarCleanups(const AutoVarEmission &emission);
1756   void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1757                               QualType::DestructionKind dtorKind);
1758 
1759   void EmitStaticVarDecl(const VarDecl &D,
1760                          llvm::GlobalValue::LinkageTypes Linkage);
1761 
1762   /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
1763   void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, unsigned ArgNo);
1764 
1765   /// protectFromPeepholes - Protect a value that we're intending to
1766   /// store to the side, but which will probably be used later, from
1767   /// aggressive peepholing optimizations that might delete it.
1768   ///
1769   /// Pass the result to unprotectFromPeepholes to declare that
1770   /// protection is no longer required.
1771   ///
1772   /// There's no particular reason why this shouldn't apply to
1773   /// l-values, it's just that no existing peepholes work on pointers.
1774   PeepholeProtection protectFromPeepholes(RValue rvalue);
1775   void unprotectFromPeepholes(PeepholeProtection protection);
1776 
1777   //===--------------------------------------------------------------------===//
1778   //                             Statement Emission
1779   //===--------------------------------------------------------------------===//
1780 
1781   /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
1782   void EmitStopPoint(const Stmt *S);
1783 
1784   /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1785   /// this function even if there is no current insertion point.
1786   ///
1787   /// This function may clear the current insertion point; callers should use
1788   /// EnsureInsertPoint if they wish to subsequently generate code without first
1789   /// calling EmitBlock, EmitBranch, or EmitStmt.
1790   void EmitStmt(const Stmt *S);
1791 
1792   /// EmitSimpleStmt - Try to emit a "simple" statement which does not
1793   /// necessarily require an insertion point or debug information; typically
1794   /// because the statement amounts to a jump or a container of other
1795   /// statements.
1796   ///
1797   /// \return True if the statement was handled.
1798   bool EmitSimpleStmt(const Stmt *S);
1799 
1800   llvm::Value *EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
1801                                 AggValueSlot AVS = AggValueSlot::ignored());
1802   llvm::Value *EmitCompoundStmtWithoutScope(const CompoundStmt &S,
1803                                             bool GetLast = false,
1804                                             AggValueSlot AVS =
1805                                                 AggValueSlot::ignored());
1806 
1807   /// EmitLabel - Emit the block for the given label. It is legal to call this
1808   /// function even if there is no current insertion point.
1809   void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
1810 
1811   void EmitLabelStmt(const LabelStmt &S);
1812   void EmitAttributedStmt(const AttributedStmt &S);
1813   void EmitGotoStmt(const GotoStmt &S);
1814   void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
1815   void EmitIfStmt(const IfStmt &S);
1816   void EmitWhileStmt(const WhileStmt &S);
1817   void EmitDoStmt(const DoStmt &S);
1818   void EmitForStmt(const ForStmt &S);
1819   void EmitReturnStmt(const ReturnStmt &S);
1820   void EmitDeclStmt(const DeclStmt &S);
1821   void EmitBreakStmt(const BreakStmt &S);
1822   void EmitContinueStmt(const ContinueStmt &S);
1823   void EmitSwitchStmt(const SwitchStmt &S);
1824   void EmitDefaultStmt(const DefaultStmt &S);
1825   void EmitCaseStmt(const CaseStmt &S);
1826   void EmitCaseStmtRange(const CaseStmt &S);
1827   void EmitAsmStmt(const AsmStmt &S);
1828 
1829   void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
1830   void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
1831   void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
1832   void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
1833   void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
1834 
1835   llvm::Constant *getUnwindResumeFn();
1836   llvm::Constant *getUnwindResumeOrRethrowFn();
1837   void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
1838   void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
1839 
1840   void EmitCXXTryStmt(const CXXTryStmt &S);
1841   void EmitCXXForRangeStmt(const CXXForRangeStmt &S);
1842 
1843   llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
1844   llvm::Function *GenerateCapturedStmtFunction(const CapturedDecl *CD,
1845                                                const RecordDecl *RD);
1846 
1847   //===--------------------------------------------------------------------===//
1848   //                         LValue Expression Emission
1849   //===--------------------------------------------------------------------===//
1850 
1851   /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
1852   RValue GetUndefRValue(QualType Ty);
1853 
1854   /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
1855   /// and issue an ErrorUnsupported style diagnostic (using the
1856   /// provided Name).
1857   RValue EmitUnsupportedRValue(const Expr *E,
1858                                const char *Name);
1859 
1860   /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
1861   /// an ErrorUnsupported style diagnostic (using the provided Name).
1862   LValue EmitUnsupportedLValue(const Expr *E,
1863                                const char *Name);
1864 
1865   /// EmitLValue - Emit code to compute a designator that specifies the location
1866   /// of the expression.
1867   ///
1868   /// This can return one of two things: a simple address or a bitfield
1869   /// reference.  In either case, the LLVM Value* in the LValue structure is
1870   /// guaranteed to be an LLVM pointer type.
1871   ///
1872   /// If this returns a bitfield reference, nothing about the pointee type of
1873   /// the LLVM value is known: For example, it may not be a pointer to an
1874   /// integer.
1875   ///
1876   /// If this returns a normal address, and if the lvalue's C type is fixed
1877   /// size, this method guarantees that the returned pointer type will point to
1878   /// an LLVM type of the same size of the lvalue's type.  If the lvalue has a
1879   /// variable length type, this is not possible.
1880   ///
1881   LValue EmitLValue(const Expr *E);
1882 
1883   /// \brief Same as EmitLValue but additionally we generate checking code to
1884   /// guard against undefined behavior.  This is only suitable when we know
1885   /// that the address will be used to access the object.
1886   LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
1887 
1888   RValue convertTempToRValue(llvm::Value *addr, QualType type);
1889 
1890   void EmitAtomicInit(Expr *E, LValue lvalue);
1891 
1892   RValue EmitAtomicLoad(LValue lvalue,
1893                         AggValueSlot slot = AggValueSlot::ignored());
1894 
1895   void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
1896 
1897   /// EmitToMemory - Change a scalar value from its value
1898   /// representation to its in-memory representation.
1899   llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
1900 
1901   /// EmitFromMemory - Change a scalar value from its memory
1902   /// representation to its value representation.
1903   llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
1904 
1905   /// EmitLoadOfScalar - Load a scalar value from an address, taking
1906   /// care to appropriately convert from the memory representation to
1907   /// the LLVM value representation.
1908   llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
1909                                 unsigned Alignment, QualType Ty,
1910                                 llvm::MDNode *TBAAInfo = 0,
1911                                 QualType TBAABaseTy = QualType(),
1912                                 uint64_t TBAAOffset = 0);
1913 
1914   /// EmitLoadOfScalar - Load a scalar value from an address, taking
1915   /// care to appropriately convert from the memory representation to
1916   /// the LLVM value representation.  The l-value must be a simple
1917   /// l-value.
1918   llvm::Value *EmitLoadOfScalar(LValue lvalue);
1919 
1920   /// EmitStoreOfScalar - Store a scalar value to an address, taking
1921   /// care to appropriately convert from the memory representation to
1922   /// the LLVM value representation.
1923   void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
1924                          bool Volatile, unsigned Alignment, QualType Ty,
1925                          llvm::MDNode *TBAAInfo = 0, bool isInit = false,
1926                          QualType TBAABaseTy = QualType(),
1927                          uint64_t TBAAOffset = 0);
1928 
1929   /// EmitStoreOfScalar - Store a scalar value to an address, taking
1930   /// care to appropriately convert from the memory representation to
1931   /// the LLVM value representation.  The l-value must be a simple
1932   /// l-value.  The isInit flag indicates whether this is an initialization.
1933   /// If so, atomic qualifiers are ignored and the store is always non-atomic.
1934   void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
1935 
1936   /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
1937   /// this method emits the address of the lvalue, then loads the result as an
1938   /// rvalue, returning the rvalue.
1939   RValue EmitLoadOfLValue(LValue V);
1940   RValue EmitLoadOfExtVectorElementLValue(LValue V);
1941   RValue EmitLoadOfBitfieldLValue(LValue LV);
1942 
1943   /// EmitStoreThroughLValue - Store the specified rvalue into the specified
1944   /// lvalue, where both are guaranteed to the have the same type, and that type
1945   /// is 'Ty'.
1946   void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false);
1947   void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
1948 
1949   /// EmitStoreThroughLValue - Store Src into Dst with same constraints as
1950   /// EmitStoreThroughLValue.
1951   ///
1952   /// \param Result [out] - If non-null, this will be set to a Value* for the
1953   /// bit-field contents after the store, appropriate for use as the result of
1954   /// an assignment to the bit-field.
1955   void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
1956                                       llvm::Value **Result=0);
1957 
1958   /// Emit an l-value for an assignment (simple or compound) of complex type.
1959   LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
1960   LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
1961   LValue EmitScalarCompooundAssignWithComplex(const CompoundAssignOperator *E,
1962                                               llvm::Value *&Result);
1963 
1964   // Note: only available for agg return types
1965   LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
1966   LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
1967   // Note: only available for agg return types
1968   LValue EmitCallExprLValue(const CallExpr *E);
1969   // Note: only available for agg return types
1970   LValue EmitVAArgExprLValue(const VAArgExpr *E);
1971   LValue EmitDeclRefLValue(const DeclRefExpr *E);
1972   LValue EmitStringLiteralLValue(const StringLiteral *E);
1973   LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
1974   LValue EmitPredefinedLValue(const PredefinedExpr *E);
1975   LValue EmitUnaryOpLValue(const UnaryOperator *E);
1976   LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
1977                                 bool Accessed = false);
1978   LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
1979   LValue EmitMemberExpr(const MemberExpr *E);
1980   LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
1981   LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
1982   LValue EmitInitListLValue(const InitListExpr *E);
1983   LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
1984   LValue EmitCastLValue(const CastExpr *E);
1985   LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
1986   LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
1987 
1988   RValue EmitRValueForField(LValue LV, const FieldDecl *FD);
1989 
1990   class ConstantEmission {
1991     llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
1992     ConstantEmission(llvm::Constant *C, bool isReference)
1993       : ValueAndIsReference(C, isReference) {}
1994   public:
1995     ConstantEmission() {}
1996     static ConstantEmission forReference(llvm::Constant *C) {
1997       return ConstantEmission(C, true);
1998     }
1999     static ConstantEmission forValue(llvm::Constant *C) {
2000       return ConstantEmission(C, false);
2001     }
2002 
2003     LLVM_EXPLICIT operator bool() const { return ValueAndIsReference.getOpaqueValue() != 0; }
2004 
2005     bool isReference() const { return ValueAndIsReference.getInt(); }
2006     LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2007       assert(isReference());
2008       return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2009                                             refExpr->getType());
2010     }
2011 
2012     llvm::Constant *getValue() const {
2013       assert(!isReference());
2014       return ValueAndIsReference.getPointer();
2015     }
2016   };
2017 
2018   ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
2019 
2020   RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2021                                 AggValueSlot slot = AggValueSlot::ignored());
2022   LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2023 
2024   llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
2025                               const ObjCIvarDecl *Ivar);
2026   LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
2027   LValue EmitLValueForLambdaField(const FieldDecl *Field);
2028 
2029   /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2030   /// if the Field is a reference, this will return the address of the reference
2031   /// and not the address of the value stored in the reference.
2032   LValue EmitLValueForFieldInitialization(LValue Base,
2033                                           const FieldDecl* Field);
2034 
2035   LValue EmitLValueForIvar(QualType ObjectTy,
2036                            llvm::Value* Base, const ObjCIvarDecl *Ivar,
2037                            unsigned CVRQualifiers);
2038 
2039   LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
2040   LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
2041   LValue EmitLambdaLValue(const LambdaExpr *E);
2042   LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
2043   LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
2044 
2045   LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
2046   LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
2047   LValue EmitStmtExprLValue(const StmtExpr *E);
2048   LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
2049   LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
2050   void   EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
2051 
2052   //===--------------------------------------------------------------------===//
2053   //                         Scalar Expression Emission
2054   //===--------------------------------------------------------------------===//
2055 
2056   /// EmitCall - Generate a call of the given function, expecting the given
2057   /// result type, and using the given argument list which specifies both the
2058   /// LLVM arguments and the types they were derived from.
2059   ///
2060   /// \param TargetDecl - If given, the decl of the function in a direct call;
2061   /// used to set attributes on the call (noreturn, etc.).
2062   RValue EmitCall(const CGFunctionInfo &FnInfo,
2063                   llvm::Value *Callee,
2064                   ReturnValueSlot ReturnValue,
2065                   const CallArgList &Args,
2066                   const Decl *TargetDecl = 0,
2067                   llvm::Instruction **callOrInvoke = 0);
2068 
2069   RValue EmitCall(QualType FnType, llvm::Value *Callee,
2070                   ReturnValueSlot ReturnValue,
2071                   CallExpr::const_arg_iterator ArgBeg,
2072                   CallExpr::const_arg_iterator ArgEnd,
2073                   const Decl *TargetDecl = 0);
2074   RValue EmitCallExpr(const CallExpr *E,
2075                       ReturnValueSlot ReturnValue = ReturnValueSlot());
2076 
2077   llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2078                                   const Twine &name = "");
2079   llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2080                                   ArrayRef<llvm::Value*> args,
2081                                   const Twine &name = "");
2082   llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2083                                           const Twine &name = "");
2084   llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2085                                           ArrayRef<llvm::Value*> args,
2086                                           const Twine &name = "");
2087 
2088   llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
2089                                   ArrayRef<llvm::Value *> Args,
2090                                   const Twine &Name = "");
2091   llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
2092                                   const Twine &Name = "");
2093   llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2094                                          ArrayRef<llvm::Value*> args,
2095                                          const Twine &name = "");
2096   llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2097                                          const Twine &name = "");
2098   void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2099                                        ArrayRef<llvm::Value*> args);
2100 
2101   llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2102                                          NestedNameSpecifier *Qual,
2103                                          llvm::Type *Ty);
2104 
2105   llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2106                                                    CXXDtorType Type,
2107                                                    const CXXRecordDecl *RD);
2108 
2109   RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
2110                            SourceLocation CallLoc,
2111                            llvm::Value *Callee,
2112                            ReturnValueSlot ReturnValue,
2113                            llvm::Value *This,
2114                            llvm::Value *ImplicitParam,
2115                            QualType ImplicitParamTy,
2116                            CallExpr::const_arg_iterator ArgBeg,
2117                            CallExpr::const_arg_iterator ArgEnd);
2118   RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2119                                ReturnValueSlot ReturnValue);
2120   RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2121                                       ReturnValueSlot ReturnValue);
2122 
2123   llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2124                                            const CXXMethodDecl *MD,
2125                                            llvm::Value *This);
2126   RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
2127                                        const CXXMethodDecl *MD,
2128                                        ReturnValueSlot ReturnValue);
2129 
2130   RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2131                                 ReturnValueSlot ReturnValue);
2132 
2133 
2134   RValue EmitBuiltinExpr(const FunctionDecl *FD,
2135                          unsigned BuiltinID, const CallExpr *E);
2136 
2137   RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
2138 
2139   /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2140   /// is unhandled by the current target.
2141   llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2142 
2143   llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2144   llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2145   llvm::Value *EmitNeonCall(llvm::Function *F,
2146                             SmallVectorImpl<llvm::Value*> &O,
2147                             const char *name,
2148                             unsigned shift = 0, bool rightshift = false);
2149   llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
2150   llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
2151                                    bool negateForRightShift);
2152 
2153   llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
2154   llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2155   llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2156 
2157   llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
2158   llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
2159   llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
2160   llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2161   llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2162   llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
2163                                 const ObjCMethodDecl *MethodWithObjects);
2164   llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
2165   RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2166                              ReturnValueSlot Return = ReturnValueSlot());
2167 
2168   /// Retrieves the default cleanup kind for an ARC cleanup.
2169   /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2170   CleanupKind getARCCleanupKind() {
2171     return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2172              ? NormalAndEHCleanup : NormalCleanup;
2173   }
2174 
2175   // ARC primitives.
2176   void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2177   void EmitARCDestroyWeak(llvm::Value *addr);
2178   llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2179   llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2180   llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2181                                 bool ignored);
2182   void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2183   void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2184   llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2185   llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
2186   llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
2187                                   bool resultIgnored);
2188   llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
2189                                       bool resultIgnored);
2190   llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2191   llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
2192   llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
2193   void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise);
2194   void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
2195   llvm::Value *EmitARCAutorelease(llvm::Value *value);
2196   llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2197   llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2198   llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2199 
2200   std::pair<LValue,llvm::Value*>
2201   EmitARCStoreAutoreleasing(const BinaryOperator *e);
2202   std::pair<LValue,llvm::Value*>
2203   EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2204 
2205   llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2206 
2207   llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2208   llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2209   llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2210 
2211   llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
2212   llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2213   llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2214 
2215   void EmitARCIntrinsicUse(llvm::ArrayRef<llvm::Value*> values);
2216 
2217   static Destroyer destroyARCStrongImprecise;
2218   static Destroyer destroyARCStrongPrecise;
2219   static Destroyer destroyARCWeak;
2220 
2221   void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2222   llvm::Value *EmitObjCAutoreleasePoolPush();
2223   llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2224   void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2225   void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2226 
2227   /// \brief Emits a reference binding to the passed in expression.
2228   RValue EmitReferenceBindingToExpr(const Expr *E);
2229 
2230   //===--------------------------------------------------------------------===//
2231   //                           Expression Emission
2232   //===--------------------------------------------------------------------===//
2233 
2234   // Expressions are broken into three classes: scalar, complex, aggregate.
2235 
2236   /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2237   /// scalar type, returning the result.
2238   llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
2239 
2240   /// EmitScalarConversion - Emit a conversion from the specified type to the
2241   /// specified destination type, both of which are LLVM scalar types.
2242   llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2243                                     QualType DstTy);
2244 
2245   /// EmitComplexToScalarConversion - Emit a conversion from the specified
2246   /// complex type to the specified destination type, where the destination type
2247   /// is an LLVM scalar type.
2248   llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2249                                              QualType DstTy);
2250 
2251 
2252   /// EmitAggExpr - Emit the computation of the specified expression
2253   /// of aggregate type.  The result is computed into the given slot,
2254   /// which may be null to indicate that the value is not needed.
2255   void EmitAggExpr(const Expr *E, AggValueSlot AS);
2256 
2257   /// EmitAggExprToLValue - Emit the computation of the specified expression of
2258   /// aggregate type into a temporary LValue.
2259   LValue EmitAggExprToLValue(const Expr *E);
2260 
2261   /// EmitGCMemmoveCollectable - Emit special API for structs with object
2262   /// pointers.
2263   void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
2264                                 QualType Ty);
2265 
2266   /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2267   /// make sure it survives garbage collection until this point.
2268   void EmitExtendGCLifetime(llvm::Value *object);
2269 
2270   /// EmitComplexExpr - Emit the computation of the specified expression of
2271   /// complex type, returning the result.
2272   ComplexPairTy EmitComplexExpr(const Expr *E,
2273                                 bool IgnoreReal = false,
2274                                 bool IgnoreImag = false);
2275 
2276   /// EmitComplexExprIntoLValue - Emit the given expression of complex
2277   /// type and place its result into the specified l-value.
2278   void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
2279 
2280   /// EmitStoreOfComplex - Store a complex number into the specified l-value.
2281   void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
2282 
2283   /// EmitLoadOfComplex - Load a complex number from the specified l-value.
2284   ComplexPairTy EmitLoadOfComplex(LValue src);
2285 
2286   /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
2287   /// a static local variable.
2288   llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D,
2289                                             const char *Separator,
2290                                        llvm::GlobalValue::LinkageTypes Linkage);
2291 
2292   /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2293   /// global variable that has already been created for it.  If the initializer
2294   /// has a different type than GV does, this may free GV and return a different
2295   /// one.  Otherwise it just returns GV.
2296   llvm::GlobalVariable *
2297   AddInitializerToStaticVarDecl(const VarDecl &D,
2298                                 llvm::GlobalVariable *GV);
2299 
2300 
2301   /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2302   /// variable with global storage.
2303   void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2304                                 bool PerformInit);
2305 
2306   /// Call atexit() with a function that passes the given argument to
2307   /// the given function.
2308   void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2309                                     llvm::Constant *addr);
2310 
2311   /// Emit code in this function to perform a guarded variable
2312   /// initialization.  Guarded initializations are used when it's not
2313   /// possible to prove that an initialization will be done exactly
2314   /// once, e.g. with a static local variable or a static data member
2315   /// of a class template.
2316   void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
2317                           bool PerformInit);
2318 
2319   /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2320   /// variables.
2321   void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
2322                                  ArrayRef<llvm::Constant *> Decls,
2323                                  llvm::GlobalVariable *Guard = 0);
2324 
2325   /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
2326   /// variables.
2327   void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2328                                   const std::vector<std::pair<llvm::WeakVH,
2329                                   llvm::Constant*> > &DtorsAndObjects);
2330 
2331   void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2332                                         const VarDecl *D,
2333                                         llvm::GlobalVariable *Addr,
2334                                         bool PerformInit);
2335 
2336   void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
2337 
2338   void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
2339                                   const Expr *Exp);
2340 
2341   void enterFullExpression(const ExprWithCleanups *E) {
2342     if (E->getNumObjects() == 0) return;
2343     enterNonTrivialFullExpression(E);
2344   }
2345   void enterNonTrivialFullExpression(const ExprWithCleanups *E);
2346 
2347   void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
2348 
2349   void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2350 
2351   RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = 0);
2352 
2353   //===--------------------------------------------------------------------===//
2354   //                         Annotations Emission
2355   //===--------------------------------------------------------------------===//
2356 
2357   /// Emit an annotation call (intrinsic or builtin).
2358   llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2359                                   llvm::Value *AnnotatedVal,
2360                                   StringRef AnnotationStr,
2361                                   SourceLocation Location);
2362 
2363   /// Emit local annotations for the local variable V, declared by D.
2364   void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2365 
2366   /// Emit field annotations for the given field & value. Returns the
2367   /// annotation result.
2368   llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2369 
2370   //===--------------------------------------------------------------------===//
2371   //                             Internal Helpers
2372   //===--------------------------------------------------------------------===//
2373 
2374   /// ContainsLabel - Return true if the statement contains a label in it.  If
2375   /// this statement is not executed normally, it not containing a label means
2376   /// that we can just remove the code.
2377   static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
2378 
2379   /// containsBreak - Return true if the statement contains a break out of it.
2380   /// If the statement (recursively) contains a switch or loop with a break
2381   /// inside of it, this is fine.
2382   static bool containsBreak(const Stmt *S);
2383 
2384   /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2385   /// to a constant, or if it does but contains a label, return false.  If it
2386   /// constant folds return true and set the boolean result in Result.
2387   bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
2388 
2389   /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2390   /// to a constant, or if it does but contains a label, return false.  If it
2391   /// constant folds return true and set the folded value.
2392   bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
2393 
2394   /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2395   /// if statement) to the specified blocks.  Based on the condition, this might
2396   /// try to simplify the codegen of the conditional based on the branch.
2397   void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
2398                             llvm::BasicBlock *FalseBlock);
2399 
2400   /// \brief Emit a description of a type in a format suitable for passing to
2401   /// a runtime sanitizer handler.
2402   llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2403 
2404   /// \brief Convert a value into a format suitable for passing to a runtime
2405   /// sanitizer handler.
2406   llvm::Value *EmitCheckValue(llvm::Value *V);
2407 
2408   /// \brief Emit a description of a source location in a format suitable for
2409   /// passing to a runtime sanitizer handler.
2410   llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2411 
2412   /// \brief Specify under what conditions this check can be recovered
2413   enum CheckRecoverableKind {
2414     /// Always terminate program execution if this check fails
2415     CRK_Unrecoverable,
2416     /// Check supports recovering, allows user to specify which
2417     CRK_Recoverable,
2418     /// Runtime conditionally aborts, always need to support recovery.
2419     CRK_AlwaysRecoverable
2420   };
2421 
2422   /// \brief Create a basic block that will call a handler function in a
2423   /// sanitizer runtime with the provided arguments, and create a conditional
2424   /// branch to it.
2425   void EmitCheck(llvm::Value *Checked, StringRef CheckName,
2426                  ArrayRef<llvm::Constant *> StaticArgs,
2427                  ArrayRef<llvm::Value *> DynamicArgs,
2428                  CheckRecoverableKind Recoverable);
2429 
2430   /// \brief Create a basic block that will call the trap intrinsic, and emit a
2431   /// conditional branch to it, for the -ftrapv checks.
2432   void EmitTrapCheck(llvm::Value *Checked);
2433 
2434   /// EmitCallArg - Emit a single call argument.
2435   void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
2436 
2437   /// EmitDelegateCallArg - We are performing a delegate call; that
2438   /// is, the current function is delegating to another one.  Produce
2439   /// a r-value suitable for passing the given parameter.
2440   void EmitDelegateCallArg(CallArgList &args, const VarDecl *param);
2441 
2442   /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2443   /// point operation, expressed as the maximum relative error in ulp.
2444   void SetFPAccuracy(llvm::Value *Val, float Accuracy);
2445 
2446 private:
2447   llvm::MDNode *getRangeForLoadFromType(QualType Ty);
2448   void EmitReturnOfRValue(RValue RV, QualType Ty);
2449 
2450   /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2451   /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2452   ///
2453   /// \param AI - The first function argument of the expansion.
2454   /// \return The argument following the last expanded function
2455   /// argument.
2456   llvm::Function::arg_iterator
2457   ExpandTypeFromArgs(QualType Ty, LValue Dst,
2458                      llvm::Function::arg_iterator AI);
2459 
2460   /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
2461   /// Ty, into individual arguments on the provided vector \arg Args. See
2462   /// ABIArgInfo::Expand.
2463   void ExpandTypeToArgs(QualType Ty, RValue Src,
2464                         SmallVectorImpl<llvm::Value *> &Args,
2465                         llvm::FunctionType *IRFuncTy);
2466 
2467   llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
2468                             const Expr *InputExpr, std::string &ConstraintStr);
2469 
2470   llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
2471                                   LValue InputValue, QualType InputType,
2472                                   std::string &ConstraintStr);
2473 
2474   /// EmitCallArgs - Emit call arguments for a function.
2475   /// The CallArgTypeInfo parameter is used for iterating over the known
2476   /// argument types of the function being called.
2477   template<typename T>
2478   void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo,
2479                     CallExpr::const_arg_iterator ArgBeg,
2480                     CallExpr::const_arg_iterator ArgEnd,
2481                     bool ForceColumnInfo = false) {
2482     CGDebugInfo *DI = getDebugInfo();
2483     SourceLocation CallLoc;
2484     if (DI) CallLoc = DI->getLocation();
2485 
2486     CallExpr::const_arg_iterator Arg = ArgBeg;
2487 
2488     // First, use the argument types that the type info knows about
2489     if (CallArgTypeInfo) {
2490       for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(),
2491            E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) {
2492         assert(Arg != ArgEnd && "Running over edge of argument list!");
2493         QualType ArgType = *I;
2494 #ifndef NDEBUG
2495         QualType ActualArgType = Arg->getType();
2496         if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
2497           QualType ActualBaseType =
2498             ActualArgType->getAs<PointerType>()->getPointeeType();
2499           QualType ArgBaseType =
2500             ArgType->getAs<PointerType>()->getPointeeType();
2501           if (ArgBaseType->isVariableArrayType()) {
2502             if (const VariableArrayType *VAT =
2503                 getContext().getAsVariableArrayType(ActualBaseType)) {
2504               if (!VAT->getSizeExpr())
2505                 ActualArgType = ArgType;
2506             }
2507           }
2508         }
2509         assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
2510                getTypePtr() ==
2511                getContext().getCanonicalType(ActualArgType).getTypePtr() &&
2512                "type mismatch in call argument!");
2513 #endif
2514         EmitCallArg(Args, *Arg, ArgType);
2515 
2516         // Each argument expression could modify the debug
2517         // location. Restore it.
2518         if (DI) DI->EmitLocation(Builder, CallLoc, ForceColumnInfo);
2519       }
2520 
2521       // Either we've emitted all the call args, or we have a call to a
2522       // variadic function.
2523       assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) &&
2524              "Extra arguments in non-variadic function!");
2525 
2526     }
2527 
2528     // If we still have any arguments, emit them using the type of the argument.
2529     for (; Arg != ArgEnd; ++Arg) {
2530       EmitCallArg(Args, *Arg, Arg->getType());
2531 
2532       // Restore the debug location.
2533       if (DI) DI->EmitLocation(Builder, CallLoc, ForceColumnInfo);
2534     }
2535   }
2536 
2537   const TargetCodeGenInfo &getTargetHooks() const {
2538     return CGM.getTargetCodeGenInfo();
2539   }
2540 
2541   void EmitDeclMetadata();
2542 
2543   CodeGenModule::ByrefHelpers *
2544   buildByrefHelpers(llvm::StructType &byrefType,
2545                     const AutoVarEmission &emission);
2546 
2547   void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
2548 
2549   /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2550   /// value and compute our best estimate of the alignment of the pointee.
2551   std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
2552 };
2553 
2554 /// Helper class with most of the code for saving a value for a
2555 /// conditional expression cleanup.
2556 struct DominatingLLVMValue {
2557   typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2558 
2559   /// Answer whether the given value needs extra work to be saved.
2560   static bool needsSaving(llvm::Value *value) {
2561     // If it's not an instruction, we don't need to save.
2562     if (!isa<llvm::Instruction>(value)) return false;
2563 
2564     // If it's an instruction in the entry block, we don't need to save.
2565     llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2566     return (block != &block->getParent()->getEntryBlock());
2567   }
2568 
2569   /// Try to save the given value.
2570   static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2571     if (!needsSaving(value)) return saved_type(value, false);
2572 
2573     // Otherwise we need an alloca.
2574     llvm::Value *alloca =
2575       CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2576     CGF.Builder.CreateStore(value, alloca);
2577 
2578     return saved_type(alloca, true);
2579   }
2580 
2581   static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2582     if (!value.getInt()) return value.getPointer();
2583     return CGF.Builder.CreateLoad(value.getPointer());
2584   }
2585 };
2586 
2587 /// A partial specialization of DominatingValue for llvm::Values that
2588 /// might be llvm::Instructions.
2589 template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2590   typedef T *type;
2591   static type restore(CodeGenFunction &CGF, saved_type value) {
2592     return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2593   }
2594 };
2595 
2596 /// A specialization of DominatingValue for RValue.
2597 template <> struct DominatingValue<RValue> {
2598   typedef RValue type;
2599   class saved_type {
2600     enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2601                 AggregateAddress, ComplexAddress };
2602 
2603     llvm::Value *Value;
2604     Kind K;
2605     saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2606 
2607   public:
2608     static bool needsSaving(RValue value);
2609     static saved_type save(CodeGenFunction &CGF, RValue value);
2610     RValue restore(CodeGenFunction &CGF);
2611 
2612     // implementations in CGExprCXX.cpp
2613   };
2614 
2615   static bool needsSaving(type value) {
2616     return saved_type::needsSaving(value);
2617   }
2618   static saved_type save(CodeGenFunction &CGF, type value) {
2619     return saved_type::save(CGF, value);
2620   }
2621   static type restore(CodeGenFunction &CGF, saved_type value) {
2622     return value.restore(CGF);
2623   }
2624 };
2625 
2626 }  // end namespace CodeGen
2627 }  // end namespace clang
2628 
2629 #endif
2630