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