CodeGenFunction.h revision 55fc873017f10f6f566b182b70f6fc22aefa3464
1bd012ff1fa088181646a784f385b28867372d434Daniel Dunbar//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//                     The LLVM Compiler Infrastructure
45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source
60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details.
75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===//
95f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
100dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump// This is the internal per-function state used for llvm translation.
115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===//
135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
14ef52a2fb2ace36c92f88c6e125bd7defa17dafa5Chris Lattner#ifndef CLANG_CODEGEN_CODEGENFUNCTION_H
15ef52a2fb2ace36c92f88c6e125bd7defa17dafa5Chris Lattner#define CLANG_CODEGEN_CODEGENFUNCTION_H
165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
1755fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "CGBuilder.h"
1855fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "CGDebugInfo.h"
1955fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "CGValue.h"
2055fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "CodeGenModule.h"
2155fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/AST/CharUnits.h"
22e3a09e6ad09f8d1387ecaa008aaf85527909da0aArgyrios Kyrtzidis#include "clang/AST/ExprCXX.h"
235549976193e34417d4474a5f4a514268ef6666c7Ted Kremenek#include "clang/AST/ExprObjC.h"
2455fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/AST/Type.h"
2514110477887e3dc168ffc6c191e72d705051f99ePeter Collingbourne#include "clang/Basic/ABI.h"
26481769b5dc102b0256b35581e787909ad5edfab5Chris Lattner#include "clang/Basic/TargetInfo.h"
2755fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Frontend/CodeGenOptions.h"
284c7d9f1507d0f102bd4133bba63348636facd469Jay Foad#include "llvm/ADT/ArrayRef.h"
29481769b5dc102b0256b35581e787909ad5edfab5Chris Lattner#include "llvm/ADT/DenseMap.h"
30481769b5dc102b0256b35581e787909ad5edfab5Chris Lattner#include "llvm/ADT/SmallVector.h"
31c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher#include "llvm/Support/Debug.h"
3255fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "llvm/Support/ValueHandle.h"
338f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar
345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace llvm {
35c4a1dea2dc56bd1357ec91b829a0b9e68229a13eDaniel Dunbar  class BasicBlock;
36f21efe9088a0b3eda1209d1706529f6cb2073092Benjamin Kramer  class LLVMContext;
37dd5c98f709837e5dd3da08d44d1ce407975df2cfDavid Chisnall  class MDNode;
385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  class Module;
39898d508d4c9e9d45914952473e39196b20830a9fDaniel Dunbar  class SwitchInst;
40259e9ccf882d11491ad149aec5e6d7a061c9f938Daniel Dunbar  class Twine;
41ed3849b456d64d124bddc7ac044f3ce590bd9d69Daniel Dunbar  class Value;
42f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  class CallSite;
435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}
445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang {
465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  class ASTContext;
471a343ebbf413e8eae6b2737b2b2d79cbf5765571John McCall  class BlockDecl;
487267c1693abe7875b0c57268be05005ae013c6c9Anders Carlsson  class CXXDestructorDecl;
49ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith  class CXXForRangeStmt;
506815e941998659a55c20c147861b0f437928c3d8Anders Carlsson  class CXXTryStmt;
515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  class Decl;
52ad8dcf4a9df0e24051dc31bf9e6f3cd138a34298Chris Lattner  class LabelDecl;
53c4a1dea2dc56bd1357ec91b829a0b9e68229a13eDaniel Dunbar  class EnumConstantDecl;
545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  class FunctionDecl;
5572564e73277e29f6db3305d1f27ba408abb7ed88Douglas Gregor  class FunctionProtoType;
56c4a1dea2dc56bd1357ec91b829a0b9e68229a13eDaniel Dunbar  class LabelStmt;
57679a502d462ef819e6175b58e255ca3f3391e7cfFariborz Jahanian  class ObjCContainerDecl;
5829e0bccf2bcce22b877f8b2ed173f564c116b97eDaniel Dunbar  class ObjCInterfaceDecl;
5929e0bccf2bcce22b877f8b2ed173f564c116b97eDaniel Dunbar  class ObjCIvarDecl;
60391d77a26382dddf25da73e29fc1fa5aaaea4c6fChris Lattner  class ObjCMethodDecl;
61fef30b55230064d334a669a065a1c9acdb87cdfeFariborz Jahanian  class ObjCImplementationDecl;
62af05bb9073319d8381b71c4325188853fd4b8ed6Daniel Dunbar  class ObjCPropertyImplDecl;
635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  class TargetInfo;
64492c4f998d848673d3d6c9e6416115df4036a71dJohn McCall  class TargetCodeGenInfo;
65c4a1dea2dc56bd1357ec91b829a0b9e68229a13eDaniel Dunbar  class VarDecl;
6616f0049415ec596504891259e2a83e19871c0d52Chris Lattner  class ObjCForCollectionStmt;
6716f0049415ec596504891259e2a83e19871c0d52Chris Lattner  class ObjCAtTryStmt;
6816f0049415ec596504891259e2a83e19871c0d52Chris Lattner  class ObjCAtThrowStmt;
6916f0049415ec596504891259e2a83e19871c0d52Chris Lattner  class ObjCAtSynchronizedStmt;
70f85e193739c953358c865005855253af4f68a497John McCall  class ObjCAutoreleasePoolStmt;
715549976193e34417d4474a5f4a514268ef6666c7Ted Kremenek
725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace CodeGen {
73b84a06e68ffd71da22e3c75b6e4bbdba37816413Devang Patel  class CodeGenTypes;
74bb36d331f439f49859efcfb4435c61762fbba6f9Daniel Dunbar  class CGFunctionInfo;
750dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  class CGRecordLayout;
76ee5042903d53fa7b0fbc1902d0ea07d57c7775b1John McCall  class CGBlockInfo;
774c40d98ab7acf5f27fa89b17bd8fc0ef7683df37John McCall  class CGCXXABI;
78d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall  class BlockFlags;
79d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall  class BlockFieldFlags;
800dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
81f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall/// A branch fixup.  These are required when emitting a goto to a
82f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall/// label which hasn't been emitted yet.  The goto is optimistically
83f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall/// emitted as a branch to the basic block for the label, and (if it
84f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall/// occurs in a scope with non-trivial cleanups) a fixup is added to
85f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall/// the innermost cleanup.  When a (normal) cleanup is popped, any
86f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall/// unresolved fixups in that scope are threaded through the cleanup.
87f1549f66a8216a78112286e3978cea2c29d6334cJohn McCallstruct BranchFixup {
88ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  /// The block containing the terminator which needs to be modified
89ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  /// into a switch if this fixup is resolved into the current scope.
90ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  /// If null, LatestBranch points directly to the destination.
91ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  llvm::BasicBlock *OptimisticBranchBlock;
92f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
93ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  /// The ultimate destination of the branch.
94f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  ///
95f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// This can be set to null to indicate that this fixup was
96f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// successfully resolved.
97f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  llvm::BasicBlock *Destination;
98f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
99ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  /// The destination index value.
100ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  unsigned DestinationIndex;
101ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall
102ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  /// The initial branch of the fixup.
103ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  llvm::BranchInst *InitialBranch;
104f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall};
105f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
106804b807ea918184d6de63bd745e1ff75a9bfc679John McCalltemplate <class T> struct InvariantValue {
107150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  typedef T type;
108150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  typedef T saved_type;
109150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  static bool needsSaving(type value) { return false; }
110150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  static saved_type save(CodeGenFunction &CGF, type value) { return value; }
111150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  static type restore(CodeGenFunction &CGF, saved_type value) { return value; }
112150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall};
113804b807ea918184d6de63bd745e1ff75a9bfc679John McCall
114804b807ea918184d6de63bd745e1ff75a9bfc679John McCall/// A metaprogramming class for ensuring that a value will dominate an
115804b807ea918184d6de63bd745e1ff75a9bfc679John McCall/// arbitrary position in a function.
116804b807ea918184d6de63bd745e1ff75a9bfc679John McCalltemplate <class T> struct DominatingValue : InvariantValue<T> {};
117804b807ea918184d6de63bd745e1ff75a9bfc679John McCall
118804b807ea918184d6de63bd745e1ff75a9bfc679John McCalltemplate <class T, bool mightBeInstruction =
119804b807ea918184d6de63bd745e1ff75a9bfc679John McCall            llvm::is_base_of<llvm::Value, T>::value &&
120804b807ea918184d6de63bd745e1ff75a9bfc679John McCall            !llvm::is_base_of<llvm::Constant, T>::value &&
121804b807ea918184d6de63bd745e1ff75a9bfc679John McCall            !llvm::is_base_of<llvm::BasicBlock, T>::value>
122804b807ea918184d6de63bd745e1ff75a9bfc679John McCallstruct DominatingPointer;
123804b807ea918184d6de63bd745e1ff75a9bfc679John McCalltemplate <class T> struct DominatingPointer<T,false> : InvariantValue<T*> {};
124804b807ea918184d6de63bd745e1ff75a9bfc679John McCall// template <class T> struct DominatingPointer<T,true> at end of file
125804b807ea918184d6de63bd745e1ff75a9bfc679John McCall
126804b807ea918184d6de63bd745e1ff75a9bfc679John McCalltemplate <class T> struct DominatingValue<T*> : DominatingPointer<T> {};
127150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
128cd2d2b7814e0104ed41a8da159a06a8ca77b70d8John McCallenum CleanupKind {
129cd2d2b7814e0104ed41a8da159a06a8ca77b70d8John McCall  EHCleanup = 0x1,
130cd2d2b7814e0104ed41a8da159a06a8ca77b70d8John McCall  NormalCleanup = 0x2,
131cd2d2b7814e0104ed41a8da159a06a8ca77b70d8John McCall  NormalAndEHCleanup = EHCleanup | NormalCleanup,
132cd2d2b7814e0104ed41a8da159a06a8ca77b70d8John McCall
133cd2d2b7814e0104ed41a8da159a06a8ca77b70d8John McCall  InactiveCleanup = 0x4,
134cd2d2b7814e0104ed41a8da159a06a8ca77b70d8John McCall  InactiveEHCleanup = EHCleanup | InactiveCleanup,
135cd2d2b7814e0104ed41a8da159a06a8ca77b70d8John McCall  InactiveNormalCleanup = NormalCleanup | InactiveCleanup,
136cd2d2b7814e0104ed41a8da159a06a8ca77b70d8John McCall  InactiveNormalAndEHCleanup = NormalAndEHCleanup | InactiveCleanup
137cd2d2b7814e0104ed41a8da159a06a8ca77b70d8John McCall};
138da65ea86482bc116906edfb9ba1d7124f76cc867John McCall
139f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall/// A stack of scopes which respond to exceptions, including cleanups
140f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall/// and catch blocks.
141f1549f66a8216a78112286e3978cea2c29d6334cJohn McCallclass EHScopeStack {
142f1549f66a8216a78112286e3978cea2c29d6334cJohn McCallpublic:
143f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// A saved depth on the scope stack.  This is necessary because
144f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// pushing scopes onto the stack invalidates iterators.
145f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  class stable_iterator {
146f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    friend class EHScopeStack;
147f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
148f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    /// Offset from StartOfData to EndOfBuffer.
149f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    ptrdiff_t Size;
150f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
151f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    stable_iterator(ptrdiff_t Size) : Size(Size) {}
152f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
153f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  public:
154f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    static stable_iterator invalid() { return stable_iterator(-1); }
155f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    stable_iterator() : Size(-1) {}
156f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
157f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    bool isValid() const { return Size >= 0; }
158f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
159838d796d020f6a8cd2b2d1e2a0a85c83bbf29543John McCall    /// Returns true if this scope encloses I.
160838d796d020f6a8cd2b2d1e2a0a85c83bbf29543John McCall    /// Returns false if I is invalid.
161838d796d020f6a8cd2b2d1e2a0a85c83bbf29543John McCall    /// This scope must be valid.
162ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall    bool encloses(stable_iterator I) const { return Size <= I.Size; }
163838d796d020f6a8cd2b2d1e2a0a85c83bbf29543John McCall
164838d796d020f6a8cd2b2d1e2a0a85c83bbf29543John McCall    /// Returns true if this scope strictly encloses I: that is,
165838d796d020f6a8cd2b2d1e2a0a85c83bbf29543John McCall    /// if it encloses I and is not I.
166838d796d020f6a8cd2b2d1e2a0a85c83bbf29543John McCall    /// Returns false is I is invalid.
167838d796d020f6a8cd2b2d1e2a0a85c83bbf29543John McCall    /// This scope must be valid.
168ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall    bool strictlyEncloses(stable_iterator I) const { return Size < I.Size; }
1691bda662cb37d9fe24be4b3cf8ea0f4e550e1f889John McCall
170f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    friend bool operator==(stable_iterator A, stable_iterator B) {
171f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall      return A.Size == B.Size;
172f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    }
173f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    friend bool operator!=(stable_iterator A, stable_iterator B) {
174f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall      return A.Size != B.Size;
175f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    }
176f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  };
177f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
1781f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall  /// Information for lazily generating a cleanup.  Subclasses must be
1791f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall  /// POD-like: cleanups will not be destructed, and they will be
1801f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall  /// allocated on the cleanup stack and freely copied and moved
1811f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall  /// around.
182da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  ///
1831f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall  /// Cleanup implementations should generally be declared in an
184da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  /// anonymous namespace.
1851f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall  class Cleanup {
186c4a1a8450a3613ef256a71b9d8305b41f79eef50John McCall    // Anchor the construction vtable.
187c4a1a8450a3613ef256a71b9d8305b41f79eef50John McCall    virtual void anchor();
188da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  public:
189ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall    /// Generation flags.
190ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall    class Flags {
191ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      enum {
192ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall        F_IsForEH             = 0x1,
193ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall        F_IsNormalCleanupKind = 0x2,
194ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall        F_IsEHCleanupKind     = 0x4
195ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      };
196ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      unsigned flags;
197ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall
198ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall    public:
199ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      Flags() : flags(0) {}
200ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall
201ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      /// isForEH - true if the current emission is for an EH cleanup.
202ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      bool isForEHCleanup() const { return flags & F_IsForEH; }
203ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      bool isForNormalCleanup() const { return !isForEHCleanup(); }
204ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      void setIsForEHCleanup() { flags |= F_IsForEH; }
205ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall
206ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      bool isNormalCleanupKind() const { return flags & F_IsNormalCleanupKind; }
207ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      void setIsNormalCleanupKind() { flags |= F_IsNormalCleanupKind; }
208ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall
209ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      /// isEHCleanupKind - true if the cleanup was pushed as an EH
210ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      /// cleanup.
211ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      bool isEHCleanupKind() const { return flags & F_IsEHCleanupKind; }
212ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      void setIsEHCleanupKind() { flags |= F_IsEHCleanupKind; }
213ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall    };
214ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall
215c4a1a8450a3613ef256a71b9d8305b41f79eef50John McCall    // Provide a virtual destructor to suppress a very common warning
216c4a1a8450a3613ef256a71b9d8305b41f79eef50John McCall    // that unfortunately cannot be suppressed without this.  Cleanups
217c4a1a8450a3613ef256a71b9d8305b41f79eef50John McCall    // should not rely on this destructor ever being called.
218c4a1a8450a3613ef256a71b9d8305b41f79eef50John McCall    virtual ~Cleanup() {}
2193e29f96988b0438e42dba3790f61fb3df42d90cbJohn McCall
220da65ea86482bc116906edfb9ba1d7124f76cc867John McCall    /// Emit the cleanup.  For normal cleanups, this is run in the
221da65ea86482bc116906edfb9ba1d7124f76cc867John McCall    /// same EH context as when the cleanup was pushed, i.e. the
222da65ea86482bc116906edfb9ba1d7124f76cc867John McCall    /// immediately-enclosing context of the cleanup scope.  For
223da65ea86482bc116906edfb9ba1d7124f76cc867John McCall    /// EH cleanups, this is run in a terminate context.
224da65ea86482bc116906edfb9ba1d7124f76cc867John McCall    ///
22570517ca5c07c4b41ff8662b94ee22047b0299f8cDmitri Gribenko    // \param flags cleanup kind.
226ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall    virtual void Emit(CodeGenFunction &CGF, Flags flags) = 0;
227da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  };
228da65ea86482bc116906edfb9ba1d7124f76cc867John McCall
229150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  /// ConditionalCleanupN stores the saved form of its N parameters,
230150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  /// then restores them and performs the cleanup.
2313ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall  template <class T, class A0>
2323ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall  class ConditionalCleanup1 : public Cleanup {
233804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    typedef typename DominatingValue<A0>::saved_type A0_saved;
2343ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall    A0_saved a0_saved;
2353ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall
236ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall    void Emit(CodeGenFunction &CGF, Flags flags) {
237804b807ea918184d6de63bd745e1ff75a9bfc679John McCall      A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
238ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      T(a0).Emit(CGF, flags);
2393ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall    }
2403ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall
2413ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall  public:
2423ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall    ConditionalCleanup1(A0_saved a0)
2433ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall      : a0_saved(a0) {}
2443ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall  };
2453ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall
246150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  template <class T, class A0, class A1>
2473ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall  class ConditionalCleanup2 : public Cleanup {
248804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    typedef typename DominatingValue<A0>::saved_type A0_saved;
249804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    typedef typename DominatingValue<A1>::saved_type A1_saved;
2504bbcbda302cba8b1b0d88c20d735d09b483bd005John McCall    A0_saved a0_saved;
2514bbcbda302cba8b1b0d88c20d735d09b483bd005John McCall    A1_saved a1_saved;
252150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
253ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall    void Emit(CodeGenFunction &CGF, Flags flags) {
254804b807ea918184d6de63bd745e1ff75a9bfc679John McCall      A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
255804b807ea918184d6de63bd745e1ff75a9bfc679John McCall      A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
256ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      T(a0, a1).Emit(CGF, flags);
257150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    }
258150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
259150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  public:
2603ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall    ConditionalCleanup2(A0_saved a0, A1_saved a1)
2613ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall      : a0_saved(a0), a1_saved(a1) {}
262150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  };
263150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
264d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor  template <class T, class A0, class A1, class A2>
265d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor  class ConditionalCleanup3 : public Cleanup {
266d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    typedef typename DominatingValue<A0>::saved_type A0_saved;
267d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    typedef typename DominatingValue<A1>::saved_type A1_saved;
268d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    typedef typename DominatingValue<A2>::saved_type A2_saved;
269d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    A0_saved a0_saved;
270d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    A1_saved a1_saved;
271d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    A2_saved a2_saved;
272d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor
273ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall    void Emit(CodeGenFunction &CGF, Flags flags) {
274d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor      A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
275d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor      A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
276d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor      A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
277ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      T(a0, a1, a2).Emit(CGF, flags);
278d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    }
279d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor
280d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor  public:
281d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    ConditionalCleanup3(A0_saved a0, A1_saved a1, A2_saved a2)
282c4a1a8450a3613ef256a71b9d8305b41f79eef50John McCall      : a0_saved(a0), a1_saved(a1), a2_saved(a2) {}
283d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor  };
284d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor
2859928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall  template <class T, class A0, class A1, class A2, class A3>
2869928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall  class ConditionalCleanup4 : public Cleanup {
2879928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    typedef typename DominatingValue<A0>::saved_type A0_saved;
2889928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    typedef typename DominatingValue<A1>::saved_type A1_saved;
2899928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    typedef typename DominatingValue<A2>::saved_type A2_saved;
2909928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    typedef typename DominatingValue<A3>::saved_type A3_saved;
2919928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    A0_saved a0_saved;
2929928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    A1_saved a1_saved;
2939928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    A2_saved a2_saved;
2949928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    A3_saved a3_saved;
2959928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall
296ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall    void Emit(CodeGenFunction &CGF, Flags flags) {
2979928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall      A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
2989928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall      A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
2999928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall      A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
3009928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall      A3 a3 = DominatingValue<A3>::restore(CGF, a3_saved);
301ad346f4f678ab1c3222425641d851dc63e9dfa1aJohn McCall      T(a0, a1, a2, a3).Emit(CGF, flags);
3029928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    }
3039928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall
3049928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall  public:
3059928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    ConditionalCleanup4(A0_saved a0, A1_saved a1, A2_saved a2, A3_saved a3)
3069928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall      : a0_saved(a0), a1_saved(a1), a2_saved(a2), a3_saved(a3) {}
3079928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall  };
3089928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall
309f1549f66a8216a78112286e3978cea2c29d6334cJohn McCallprivate:
310f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  // The implementation for this class is in CGException.h and
311f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  // CGException.cpp; the definition is here because it's used as a
312f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  // member of CodeGenFunction.
313f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
314f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// The start of the scope-stack buffer, i.e. the allocated pointer
315f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// for the buffer.  All of these pointers are either simultaneously
316f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// null or simultaneously valid.
317f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  char *StartOfBuffer;
318f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
319f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// The end of the buffer.
320f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  char *EndOfBuffer;
321f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
322f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// The first valid entry in the buffer.
323f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  char *StartOfData;
324f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
325f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// The innermost normal cleanup on the stack.
326f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  stable_iterator InnermostNormalCleanup;
327f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
328777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  /// The innermost EH scope on the stack.
329777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  stable_iterator InnermostEHScope;
330ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall
331f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// The current set of branch fixups.  A branch fixup is a jump to
332f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// an as-yet unemitted label, i.e. a label for which we don't yet
333f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// know the EH stack depth.  Whenever we pop a cleanup, we have
334f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// to thread all the current branch fixups through it.
335f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  ///
336f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Fixups are recorded as the Use of the respective branch or
337f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// switch statement.  The use points to the final destination.
338f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// When popping out of a cleanup, these uses are threaded through
339f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// the cleanup and adjusted to point to the new cleanup.
340f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  ///
341f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Note that branches are allowed to jump into protected scopes
342f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// in certain situations;  e.g. the following code is legal:
343f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  ///     struct A { ~A(); }; // trivial ctor, non-trivial dtor
344f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  ///     goto foo;
345f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  ///     A a;
346f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  ///    foo:
347f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  ///     bar();
348686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  SmallVector<BranchFixup, 8> BranchFixups;
349f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
350f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  char *allocate(size_t Size);
351f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
3521f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall  void *pushCleanup(CleanupKind K, size_t DataSize);
353da65ea86482bc116906edfb9ba1d7124f76cc867John McCall
354f1549f66a8216a78112286e3978cea2c29d6334cJohn McCallpublic:
355f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  EHScopeStack() : StartOfBuffer(0), EndOfBuffer(0), StartOfData(0),
356f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall                   InnermostNormalCleanup(stable_end()),
357777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall                   InnermostEHScope(stable_end()) {}
358f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  ~EHScopeStack() { delete[] StartOfBuffer; }
359f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
360da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  // Variadic templates would make this not terrible.
361da65ea86482bc116906edfb9ba1d7124f76cc867John McCall
362da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  /// Push a lazily-created cleanup on the stack.
3638e3f86193995c47ee0d229e4336c3382410f09f5John McCall  template <class T>
3641f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall  void pushCleanup(CleanupKind Kind) {
3651f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall    void *Buffer = pushCleanup(Kind, sizeof(T));
3661f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall    Cleanup *Obj = new(Buffer) T();
3678e3f86193995c47ee0d229e4336c3382410f09f5John McCall    (void) Obj;
3688e3f86193995c47ee0d229e4336c3382410f09f5John McCall  }
3698e3f86193995c47ee0d229e4336c3382410f09f5John McCall
3708e3f86193995c47ee0d229e4336c3382410f09f5John McCall  /// Push a lazily-created cleanup on the stack.
3718e3f86193995c47ee0d229e4336c3382410f09f5John McCall  template <class T, class A0>
3721f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall  void pushCleanup(CleanupKind Kind, A0 a0) {
3731f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall    void *Buffer = pushCleanup(Kind, sizeof(T));
3741f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall    Cleanup *Obj = new(Buffer) T(a0);
3758e3f86193995c47ee0d229e4336c3382410f09f5John McCall    (void) Obj;
3768e3f86193995c47ee0d229e4336c3382410f09f5John McCall  }
3778e3f86193995c47ee0d229e4336c3382410f09f5John McCall
3788e3f86193995c47ee0d229e4336c3382410f09f5John McCall  /// Push a lazily-created cleanup on the stack.
379da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  template <class T, class A0, class A1>
3801f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall  void pushCleanup(CleanupKind Kind, A0 a0, A1 a1) {
3811f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall    void *Buffer = pushCleanup(Kind, sizeof(T));
3821f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall    Cleanup *Obj = new(Buffer) T(a0, a1);
383da65ea86482bc116906edfb9ba1d7124f76cc867John McCall    (void) Obj;
384da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  }
385da65ea86482bc116906edfb9ba1d7124f76cc867John McCall
386da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  /// Push a lazily-created cleanup on the stack.
387da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  template <class T, class A0, class A1, class A2>
3881f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall  void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2) {
3891f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall    void *Buffer = pushCleanup(Kind, sizeof(T));
3901f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall    Cleanup *Obj = new(Buffer) T(a0, a1, a2);
391da65ea86482bc116906edfb9ba1d7124f76cc867John McCall    (void) Obj;
392da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  }
393da65ea86482bc116906edfb9ba1d7124f76cc867John McCall
394da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  /// Push a lazily-created cleanup on the stack.
395da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  template <class T, class A0, class A1, class A2, class A3>
3961f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall  void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
3971f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall    void *Buffer = pushCleanup(Kind, sizeof(T));
3981f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall    Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3);
399da65ea86482bc116906edfb9ba1d7124f76cc867John McCall    (void) Obj;
400da65ea86482bc116906edfb9ba1d7124f76cc867John McCall  }
401da65ea86482bc116906edfb9ba1d7124f76cc867John McCall
40277199713ab56f87ffad9a535ff2a0877704eed87John McCall  /// Push a lazily-created cleanup on the stack.
40377199713ab56f87ffad9a535ff2a0877704eed87John McCall  template <class T, class A0, class A1, class A2, class A3, class A4>
4041f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall  void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3, A4 a4) {
4051f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall    void *Buffer = pushCleanup(Kind, sizeof(T));
4061f0fca54676cfa8616e7f3cd7a26788ab937e3cdJohn McCall    Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3, a4);
40777199713ab56f87ffad9a535ff2a0877704eed87John McCall    (void) Obj;
40877199713ab56f87ffad9a535ff2a0877704eed87John McCall  }
40977199713ab56f87ffad9a535ff2a0877704eed87John McCall
4107d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  // Feel free to add more variants of the following:
4117d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall
4127d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  /// Push a cleanup with non-constant storage requirements on the
4137d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  /// stack.  The cleanup type must provide an additional static method:
4147d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  ///   static size_t getExtraSize(size_t);
4157d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  /// The argument to this method will be the value N, which will also
4167d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  /// be passed as the first argument to the constructor.
4177d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  ///
4187d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  /// The data stored in the extra storage must obey the same
4197d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  /// restrictions as normal cleanup member data.
4207d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  ///
4217d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  /// The pointer returned from this method is valid until the cleanup
4227d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  /// stack is modified.
4237d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  template <class T, class A0, class A1, class A2>
4247d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  T *pushCleanupWithExtra(CleanupKind Kind, size_t N, A0 a0, A1 a1, A2 a2) {
4257d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall    void *Buffer = pushCleanup(Kind, sizeof(T) + T::getExtraSize(N));
4267d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall    return new (Buffer) T(N, a0, a1, a2);
4277d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  }
4287d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall
429777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  /// Pops a cleanup scope off the stack.  This is private to CGCleanup.cpp.
430f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  void popCleanup();
431f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
432f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Push a set of catch handlers on the stack.  The catch is
433f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// uninitialized and will need to have the given number of handlers
434f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// set on it.
435f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  class EHCatchScope *pushCatch(unsigned NumHandlers);
436f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
437777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  /// Pops a catch scope off the stack.  This is private to CGException.cpp.
438f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  void popCatch();
439f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
440f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Push an exceptions filter on the stack.
441f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  class EHFilterScope *pushFilter(unsigned NumFilters);
442f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
443f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Pops an exceptions filter off the stack.
444f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  void popFilter();
445f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
446f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Push a terminate handler on the stack.
447f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  void pushTerminate();
448f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
449f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Pops a terminate handler off the stack.
450f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  void popTerminate();
451f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
452f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Determines whether the exception-scopes stack is empty.
453f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  bool empty() const { return StartOfData == EndOfBuffer; }
454f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
455f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  bool requiresLandingPad() const {
456777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall    return InnermostEHScope != stable_end();
457f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  }
458f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
459f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Determines whether there are any normal cleanups on the stack.
460f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  bool hasNormalCleanups() const {
461f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    return InnermostNormalCleanup != stable_end();
462f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  }
463f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
464f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Returns the innermost normal cleanup on the stack, or
465f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// stable_end() if there are no normal cleanups.
466f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  stable_iterator getInnermostNormalCleanup() const {
467f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    return InnermostNormalCleanup;
468f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  }
469777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  stable_iterator getInnermostActiveNormalCleanup() const;
470f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
471777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  stable_iterator getInnermostEHScope() const {
472777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall    return InnermostEHScope;
473f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  }
474f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
475777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  stable_iterator getInnermostActiveEHScope() const;
476f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
477f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// An unstable reference to a scope-stack depth.  Invalidated by
478f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// pushes but not pops.
479f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  class iterator;
480f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
481f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Returns an iterator pointing to the innermost EH scope.
482f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  iterator begin() const;
483f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
484f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Returns an iterator pointing to the outermost EH scope.
485f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  iterator end() const;
486f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
487f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Create a stable reference to the top of the EH stack.  The
488f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// returned reference is valid until that scope is popped off the
489f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// stack.
490f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  stable_iterator stable_begin() const {
491f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    return stable_iterator(EndOfBuffer - StartOfData);
492f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  }
493f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
494f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Create a stable reference to the bottom of the EH stack.
495f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  static stable_iterator stable_end() {
496f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    return stable_iterator(0);
497f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  }
498f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
499f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Translates an iterator into a stable_iterator.
500f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  stable_iterator stabilize(iterator it) const;
501f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
502f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Turn a stable reference to a scope depth into a unstable pointer
503f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// to the EH stack.
504f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  iterator find(stable_iterator save) const;
505f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
506f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Removes the cleanup pointed to by the given stable_iterator.
507f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  void removeCleanup(stable_iterator save);
508f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
509f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Add a branch fixup to the current cleanup scope.
510f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  BranchFixup &addBranchFixup() {
511f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    assert(hasNormalCleanups() && "adding fixup in scope without cleanups");
512f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    BranchFixups.push_back(BranchFixup());
513f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    return BranchFixups.back();
514f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  }
515f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
516f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  unsigned getNumBranchFixups() const { return BranchFixups.size(); }
517f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  BranchFixup &getBranchFixup(unsigned I) {
518f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    assert(I < getNumBranchFixups());
519f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    return BranchFixups[I];
520f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  }
521f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
522ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  /// Pops lazily-removed fixups from the end of the list.  This
523ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  /// should only be called by procedures which have just popped a
524ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  /// cleanup or resolved one or more fixups.
525ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  void popNullFixups();
526ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall
527ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  /// Clears the branch-fixups list.  This should only be called by
5288abdbd8118e37e759d1ce3f5814ee0a24b1589e8John McCall  /// ResolveAllBranchFixups.
529ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  void clearFixups() { BranchFixups.clear(); }
530f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall};
531f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
5325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// CodeGenFunction - This class organizes the per-function state that is used
5335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// while generating LLVM code.
5345936e33bf74dd6bf126ceee0f6169a2593d03a69John McCallclass CodeGenFunction : public CodeGenTypeCache {
535f56faa01936b9cf909623d7f06e3c2569ca4a78eDmitri Gribenko  CodeGenFunction(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
536f56faa01936b9cf909623d7f06e3c2569ca4a78eDmitri Gribenko  void operator=(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
5374c40d98ab7acf5f27fa89b17bd8fc0ef7683df37John McCall
5384c40d98ab7acf5f27fa89b17bd8fc0ef7683df37John McCall  friend class CGCXXABI;
539bfc0c1ae4b505b52b36f572a9641f99e76879cabChris Lattnerpublic:
540ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  /// A jump destination is an abstract label, branching to which may
541ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  /// require a jump out through normal cleanups.
542f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  struct JumpDest {
543ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall    JumpDest() : Block(0), ScopeDepth(), Index(0) {}
544ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall    JumpDest(llvm::BasicBlock *Block,
545ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall             EHScopeStack::stable_iterator Depth,
546ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall             unsigned Index)
547ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall      : Block(Block), ScopeDepth(Depth), Index(Index) {}
548ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall
549ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall    bool isValid() const { return Block != 0; }
550ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall    llvm::BasicBlock *getBlock() const { return Block; }
551ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall    EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
552ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall    unsigned getDestIndex() const { return Index; }
5539cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
554ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  private:
555f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    llvm::BasicBlock *Block;
556f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    EHScopeStack::stable_iterator ScopeDepth;
557ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall    unsigned Index;
558ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  };
559ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall
5605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  CodeGenModule &CGM;  // Per-module state.
561444be7366d0a1e172c0290a1ea54c1cb16b5947cDaniel Dunbar  const TargetInfo &Target;
5620dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
56358dee10ed2eee34035f62d1c2d32b3639e9182f8Chris Lattner  typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
56445d196b8387dcefc4df26cda114fa34c6528e928Daniel Dunbar  CGBuilderTy Builder;
5650dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
566b5437d238752dc297e42410e98d38d5250fe0463Chris Lattner  /// CurFuncDecl - Holds the Decl for the current function or ObjC method.
567b5437d238752dc297e42410e98d38d5250fe0463Chris Lattner  /// This excludes BlockDecls.
5684111024be81e7c0525e42dadcc126d27e5bf2425Chris Lattner  const Decl *CurFuncDecl;
569b5437d238752dc297e42410e98d38d5250fe0463Chris Lattner  /// CurCodeDecl - This is the inner-most code context, which includes blocks.
570b5437d238752dc297e42410e98d38d5250fe0463Chris Lattner  const Decl *CurCodeDecl;
57188b5396b0897f28d22ae3debf4a0d97b33b6c362Daniel Dunbar  const CGFunctionInfo *CurFnInfo;
572391d77a26382dddf25da73e29fc1fa5aaaea4c6fChris Lattner  QualType FnRetTy;
5735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  llvm::Function *CurFn;
5745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
5756a1e0eb557d47e85185e09bdf8721f53f4bf9c9cMike Stump  /// CurGD - The GlobalDecl for the current function being compiled.
5766a1e0eb557d47e85185e09bdf8721f53f4bf9c9cMike Stump  GlobalDecl CurGD;
5776a1e0eb557d47e85185e09bdf8721f53f4bf9c9cMike Stump
578f85e193739c953358c865005855253af4f68a497John McCall  /// PrologueCleanupDepth - The cleanup depth enclosing all the
579f85e193739c953358c865005855253af4f68a497John McCall  /// cleanups associated with the parameters.
580f85e193739c953358c865005855253af4f68a497John McCall  EHScopeStack::stable_iterator PrologueCleanupDepth;
581f85e193739c953358c865005855253af4f68a497John McCall
5825ca2084cf9b529563209429857f01fdae9dcdfa5Daniel Dunbar  /// ReturnBlock - Unified return block.
583f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  JumpDest ReturnBlock;
584f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
5850dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// ReturnValue - The temporary alloca to hold the return value. This is null
586f3477c13eeaf11b32a41f181398fb5deffd0dd73Sylvestre Ledru  /// iff the function has no return value.
587b17daf9ab790ae71aacad2cc4aa11cd8d86c25d1Eli Friedman  llvm::Value *ReturnValue;
5880dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
5895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// AllocaInsertPoint - This is an instruction in the entry block before which
5905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// we prefer to insert allocas.
591481769b5dc102b0256b35581e787909ad5edfab5Chris Lattner  llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
5920ffb125996336fc7602b162c0a9e392f1a93060fDaniel Dunbar
593b3198a841e7f356f171f1e11faff014b2deb1eb8Nuno Lopes  /// BoundsChecking - Emit run-time bounds checks. Higher values mean
594b3198a841e7f356f171f1e11faff014b2deb1eb8Nuno Lopes  /// potentially higher performance penalties.
595b3198a841e7f356f171f1e11faff014b2deb1eb8Nuno Lopes  unsigned char BoundsChecking;
596b3198a841e7f356f171f1e11faff014b2deb1eb8Nuno Lopes
597d6396a681c9acbe56bc41bbc2bed2db45755bcd7Richard Smith  /// \brief Whether any type-checking sanitizers are enabled. If \c false,
598d6396a681c9acbe56bc41bbc2bed2db45755bcd7Richard Smith  /// calls to EmitTypeCheck can be skipped.
599d6396a681c9acbe56bc41bbc2bed2db45755bcd7Richard Smith  bool SanitizePerformTypeCheck;
6009cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
601f85e193739c953358c865005855253af4f68a497John McCall  /// In ARC, whether we should autorelease the return value.
602f85e193739c953358c865005855253af4f68a497John McCall  bool AutoreleaseResult;
603f85e193739c953358c865005855253af4f68a497John McCall
604d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall  const CodeGen::CGBlockInfo *BlockInfo;
605d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall  llvm::Value *BlockPointer;
606d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall
607cec5ebd4a6a89a7023d04cec728fd340b541ed61Eli Friedman  llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
608cec5ebd4a6a89a7023d04cec728fd340b541ed61Eli Friedman  FieldDecl *LambdaThisCaptureField;
609cec5ebd4a6a89a7023d04cec728fd340b541ed61Eli Friedman
6103d91bbcdab155181556969cad6ec97014405acedDouglas Gregor  /// \brief A mapping from NRVO variables to the flags used to indicate
6113d91bbcdab155181556969cad6ec97014405acedDouglas Gregor  /// when the NRVO has been applied to this variable.
6123d91bbcdab155181556969cad6ec97014405acedDouglas Gregor  llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
6139cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
614f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  EHScopeStack EHStack;
6150dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
616ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  /// i32s containing the indexes of the cleanup destinations.
617ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  llvm::AllocaInst *NormalCleanupDest;
618ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall
619ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  unsigned NextCleanupDestIndex;
620ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall
6211a343ebbf413e8eae6b2737b2b2d79cbf5765571John McCall  /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
6221a343ebbf413e8eae6b2737b2b2d79cbf5765571John McCall  CGBlockInfo *FirstBlockInfo;
6231a343ebbf413e8eae6b2737b2b2d79cbf5765571John McCall
624777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
625777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  llvm::BasicBlock *EHResumeBlock;
626777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall
627285cfd8953d4ca4da613a47a0d691f7234068f8cBill Wendling  /// The exception slot.  All landing pads write the current exception pointer
628285cfd8953d4ca4da613a47a0d691f7234068f8cBill Wendling  /// into this alloca.
629f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  llvm::Value *ExceptionSlot;
6300dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
631285cfd8953d4ca4da613a47a0d691f7234068f8cBill Wendling  /// The selector slot.  Under the MandatoryCleanup model, all landing pads
632285cfd8953d4ca4da613a47a0d691f7234068f8cBill Wendling  /// write the current selector value into this alloca.
63393c332a8ba2c193c435b293966d343dab15f555bJohn McCall  llvm::AllocaInst *EHSelectorSlot;
63493c332a8ba2c193c435b293966d343dab15f555bJohn McCall
635f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// Emits a landing pad for the current EH stack.
636f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  llvm::BasicBlock *EmitLandingPad();
6370dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
638f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  llvm::BasicBlock *getInvokeDestImpl();
63999533834ba8f3658559f334e68a518ebb6388ceaMike Stump
640150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  template <class T>
641804b807ea918184d6de63bd745e1ff75a9bfc679John McCall  typename DominatingValue<T>::saved_type saveValueInCond(T value) {
642804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    return DominatingValue<T>::save(*this, value);
643150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  }
644150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
645f1549f66a8216a78112286e3978cea2c29d6334cJohn McCallpublic:
646f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// ObjCEHValueStack - Stack of Objective-C exception values, used for
647f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// rethrows.
648686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  SmallVector<llvm::Value*, 8> ObjCEHValueStack;
649bb66f9f2e454135b86462d121629275b6ac38e96Anders Carlsson
650d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall  /// A class controlling the emission of a finally block.
651d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall  class FinallyInfo {
652d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall    /// Where the catchall's edge through the cleanup should go.
653d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall    JumpDest RethrowDest;
654d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall
655d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall    /// A function to call to enter the catch.
656d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall    llvm::Constant *BeginCatchFn;
657d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall
658d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall    /// An i1 variable indicating whether or not the @finally is
659d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall    /// running for an exception.
660d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall    llvm::AllocaInst *ForEHVar;
661d88ea5687968640ada2bc5a10211cbeb68a671ecMike Stump
662d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall    /// An i8* variable into which the exception pointer to rethrow
663d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall    /// has been saved.
664d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall    llvm::AllocaInst *SavedExnVar;
665d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall
666d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall  public:
667d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall    void enter(CodeGenFunction &CGF, const Stmt *Finally,
668d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall               llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
669d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall               llvm::Constant *rethrowFn);
670d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall    void exit(CodeGenFunction &CGF);
671d768e9d29abe1ac1ccc3ed63f2dce835d9bab342John McCall  };
672f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
673150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  /// pushFullExprCleanup - Push a cleanup to be run at the end of the
674150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  /// current full-expression.  Safe against the possibility that
675150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  /// we're currently inside a conditionally-evaluated expression.
6763ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall  template <class T, class A0>
6773ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall  void pushFullExprCleanup(CleanupKind kind, A0 a0) {
6783ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall    // If we're not in a conditional branch, or if none of the
6793ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall    // arguments requires saving, then use the unconditional cleanup.
680c4a1a8450a3613ef256a71b9d8305b41f79eef50John McCall    if (!isInConditionalBranch())
681c4a1a8450a3613ef256a71b9d8305b41f79eef50John McCall      return EHStack.pushCleanup<T>(kind, a0);
6823ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall
683804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
6843ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall
6853ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall    typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
6863ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall    EHStack.pushCleanup<CleanupType>(kind, a0_saved);
6873ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall    initFullExprCleanup();
6883ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall  }
6893ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall
6903ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall  /// pushFullExprCleanup - Push a cleanup to be run at the end of the
6913ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall  /// current full-expression.  Safe against the possibility that
6923ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall  /// we're currently inside a conditionally-evaluated expression.
693150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  template <class T, class A0, class A1>
694150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
695150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    // If we're not in a conditional branch, or if none of the
696150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    // arguments requires saving, then use the unconditional cleanup.
697c4a1a8450a3613ef256a71b9d8305b41f79eef50John McCall    if (!isInConditionalBranch())
698c4a1a8450a3613ef256a71b9d8305b41f79eef50John McCall      return EHStack.pushCleanup<T>(kind, a0, a1);
699150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
700804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
701804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
702150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
703150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
7043ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall    EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
7053ad32c8d93eb65d1d4943d7df567fc9b4f55d137John McCall    initFullExprCleanup();
706150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  }
707150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
708d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor  /// pushFullExprCleanup - Push a cleanup to be run at the end of the
709d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor  /// current full-expression.  Safe against the possibility that
710d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor  /// we're currently inside a conditionally-evaluated expression.
711d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor  template <class T, class A0, class A1, class A2>
712d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor  void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
713d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    // If we're not in a conditional branch, or if none of the
714d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    // arguments requires saving, then use the unconditional cleanup.
715d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    if (!isInConditionalBranch()) {
716c4a1a8450a3613ef256a71b9d8305b41f79eef50John McCall      return EHStack.pushCleanup<T>(kind, a0, a1, a2);
717d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    }
718d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor
719d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
720d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
721d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
722d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor
723d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
724d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
725d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor    initFullExprCleanup();
726d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor  }
727d7b23167763f43d3e76b0de26141b1e52613ee3cDouglas Gregor
7289928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall  /// pushFullExprCleanup - Push a cleanup to be run at the end of the
7299928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall  /// current full-expression.  Safe against the possibility that
7309928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall  /// we're currently inside a conditionally-evaluated expression.
7319928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall  template <class T, class A0, class A1, class A2, class A3>
7329928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall  void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
7339928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    // If we're not in a conditional branch, or if none of the
7349928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    // arguments requires saving, then use the unconditional cleanup.
7359928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    if (!isInConditionalBranch()) {
7369928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall      return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
7379928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    }
7389928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall
7399928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
7409928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
7419928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
7429928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
7439928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall
7449928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
7459928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
7469928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall                                     a2_saved, a3_saved);
7479928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    initFullExprCleanup();
7489928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall  }
7499928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall
7506f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  /// Set up the last cleaup that was pushed as a conditional
7516f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  /// full-expression cleanup.
7526f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  void initFullExprCleanup();
7536f103ba42cb69d50005a977c5ea583984ab63fc4John McCall
754f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// PushDestructorCleanup - Push a cleanup to call the
755f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// complete-object destructor of an object of the given type at the
756f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// given address.  Does nothing if T is not a C++ class type with a
757f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// non-trivial destructor.
758f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  void PushDestructorCleanup(QualType T, llvm::Value *Addr);
759f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
76081407d404a3fc8d24d0e2a052d85cae183033e2bJohn McCall  /// PushDestructorCleanup - Push a cleanup to call the
76181407d404a3fc8d24d0e2a052d85cae183033e2bJohn McCall  /// complete-object variant of the given destructor on the object at
76281407d404a3fc8d24d0e2a052d85cae183033e2bJohn McCall  /// the given address.
76381407d404a3fc8d24d0e2a052d85cae183033e2bJohn McCall  void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
76481407d404a3fc8d24d0e2a052d85cae183033e2bJohn McCall                             llvm::Value *Addr);
76581407d404a3fc8d24d0e2a052d85cae183033e2bJohn McCall
766f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// PopCleanupBlock - Will pop the cleanup entry on the stack and
767f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// process all branch fixups.
768ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
769f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
7707d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  /// DeactivateCleanupBlock - Deactivates the given cleanup block.
7717d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  /// The block cannot be reactivated.  Pops it if it's the top of the
7727d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  /// stack.
7736f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  ///
7746f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  /// \param DominatingIP - An instruction which is known to
7756f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  ///   dominate the current IP (if set) and which lies along
7766f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  ///   all paths of execution between the current IP and the
7776f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  ///   the point at which the cleanup comes into scope.
7786f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
7796f103ba42cb69d50005a977c5ea583984ab63fc4John McCall                              llvm::Instruction *DominatingIP);
7807d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall
7817d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
7827d8647f194ae4f2499e5bcd40dcfea34cd21ebc6John McCall  /// Cannot be used to resurrect a deactivated cleanup.
7836f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  ///
7846f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  /// \param DominatingIP - An instruction which is known to
7856f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  ///   dominate the current IP (if set) and which lies along
7866f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  ///   all paths of execution between the current IP and the
7876f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  ///   the point at which the cleanup comes into scope.
7886f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
7896f103ba42cb69d50005a977c5ea583984ab63fc4John McCall                            llvm::Instruction *DominatingIP);
790cd2d2b7814e0104ed41a8da159a06a8ca77b70d8John McCall
791f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// \brief Enters a new scope for capturing cleanups, all of which
792f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// will be executed once the scope is exited.
793f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  class RunCleanupsScope {
794f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    EHScopeStack::stable_iterator CleanupStackDepth;
79501234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor    bool OldDidCallStackSave;
7965656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor    bool PerformCleanup;
79701234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor
798f56faa01936b9cf909623d7f06e3c2569ca4a78eDmitri Gribenko    RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
799f56faa01936b9cf909623d7f06e3c2569ca4a78eDmitri Gribenko    void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
80001234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor
801c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher  protected:
802c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    CodeGenFunction& CGF;
803c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher
80401234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor  public:
80501234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor    /// \brief Enter a new cleanup scope.
8069cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer    explicit RunCleanupsScope(CodeGenFunction &CGF)
807c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher      : PerformCleanup(true), CGF(CGF)
8085656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor    {
809f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall      CleanupStackDepth = CGF.EHStack.stable_begin();
81001234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor      OldDidCallStackSave = CGF.DidCallStackSave;
8114ada2ca7d82dab68d3646f3eb6dcdfee072e8ea4Argyrios Kyrtzidis      CGF.DidCallStackSave = false;
81201234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor    }
81301234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor
81401234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor    /// \brief Exit this cleanup scope, emitting any accumulated
81501234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor    /// cleanups.
816f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    ~RunCleanupsScope() {
8175656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor      if (PerformCleanup) {
8185656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor        CGF.DidCallStackSave = OldDidCallStackSave;
819f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall        CGF.PopCleanupBlocks(CleanupStackDepth);
8205656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor      }
8215656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor    }
8225656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor
8235656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor    /// \brief Determine whether this scope requires any cleanups.
8245656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor    bool requiresCleanups() const {
825f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall      return CGF.EHStack.stable_begin() != CleanupStackDepth;
8265656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor    }
8275656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor
8285656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor    /// \brief Force the emission of cleanups now, instead of waiting
8295656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor    /// until this object is destroyed.
8305656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor    void ForceCleanup() {
8315656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor      assert(PerformCleanup && "Already forced cleanup");
83201234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor      CGF.DidCallStackSave = OldDidCallStackSave;
833f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall      CGF.PopCleanupBlocks(CleanupStackDepth);
8345656e14d91405417182171a705ed3e3d2d6d7aa3Douglas Gregor      PerformCleanup = false;
83501234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor    }
83601234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor  };
83701234bbc1cb94946df8046ad95e17537082b4f71Douglas Gregor
838c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher  class LexicalScope: protected RunCleanupsScope {
839c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    SourceRange Range;
840c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    bool PopDebugStack;
841c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher
842f56faa01936b9cf909623d7f06e3c2569ca4a78eDmitri Gribenko    LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
843f56faa01936b9cf909623d7f06e3c2569ca4a78eDmitri Gribenko    void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
844c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher
845c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher  public:
846c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    /// \brief Enter a new cleanup scope.
847c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
848c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher      : RunCleanupsScope(CGF), Range(Range), PopDebugStack(true) {
849c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher      if (CGDebugInfo *DI = CGF.getDebugInfo())
850c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher        DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
851c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    }
852c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher
853c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    /// \brief Exit this cleanup scope, emitting any accumulated
854c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    /// cleanups.
855c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    ~LexicalScope() {
856c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher      if (PopDebugStack) {
857c852e9ff06f7089405265c53af33cf06fdc36e52Eric Christopher        CGDebugInfo *DI = CGF.getDebugInfo();
858c852e9ff06f7089405265c53af33cf06fdc36e52Eric Christopher        if (DI) DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
859c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher      }
860c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    }
861c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher
862c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    /// \brief Force the emission of cleanups now, instead of waiting
863c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    /// until this object is destroyed.
864c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    void ForceCleanup() {
865c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher      RunCleanupsScope::ForceCleanup();
866c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher      if (CGDebugInfo *DI = CGF.getDebugInfo()) {
867c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher        DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
868c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher        PopDebugStack = false;
869c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher      }
870c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher    }
871c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher  };
872c3287793626a778178a4dbadcc7b64e392c6e26fEric Christopher
87344ec82b4a1597802f5bf17721481b8c265bc8dc5Anders Carlsson
874f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// PopCleanupBlocks - Takes the old cleanup stack size and emits
875f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// the cleanup blocks that have been added.
876f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
87744ec82b4a1597802f5bf17721481b8c265bc8dc5Anders Carlsson
878ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  void ResolveBranchFixups(llvm::BasicBlock *Target);
879ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall
880f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// The given basic block lies in the current EH scope, but may be a
881f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// target of a potentially scope-crossing jump; get a stable handle
882f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// to which we can perform this jump later.
883ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
884413e67778d593215d2f2161a4e712c8568f1ddd0John McCall    return JumpDest(Target,
885413e67778d593215d2f2161a4e712c8568f1ddd0John McCall                    EHStack.getInnermostNormalCleanup(),
886413e67778d593215d2f2161a4e712c8568f1ddd0John McCall                    NextCleanupDestIndex++);
887f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  }
888c71c845fe77ee1f891d60232ec320912d88557eeAnders Carlsson
889f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// The given basic block lies in the current EH scope, but may be a
890f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// target of a potentially scope-crossing jump; get a stable handle
891f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// to which we can perform this jump later.
892686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
893ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall    return getJumpDestInCurrentScope(createBasicBlock(Name));
894f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  }
895f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
896f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// EmitBranchThroughCleanup - Emit a branch from the current insert
897f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// block through the normal cleanup handling code (if any) and then
898f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// on to \arg Dest.
899f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  void EmitBranchThroughCleanup(JumpDest Dest);
900b11f9198111796ada02b57f62cdea92134fde9f7Chris Lattner
901b11f9198111796ada02b57f62cdea92134fde9f7Chris Lattner  /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
902b11f9198111796ada02b57f62cdea92134fde9f7Chris Lattner  /// specified destination obviously has no cleanups to run.  'false' is always
903b11f9198111796ada02b57f62cdea92134fde9f7Chris Lattner  /// a conservatively correct answer for this method.
904b11f9198111796ada02b57f62cdea92134fde9f7Chris Lattner  bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
905f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
906777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  /// popCatchScope - Pops the catch scope at the top of the EHScope
907777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  /// stack, emitting any required code (other than the catch handlers
908777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  /// themselves).
909777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  void popCatchScope();
910ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall
911c686004145b1f4dbeb38173a0886ba7040ae0089David Chisnall  llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
912777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
9130dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
914150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  /// An object to manage conditionally-evaluated expressions.
915150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  class ConditionalEvaluation {
916150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    llvm::BasicBlock *StartBB;
9171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
918150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  public:
919150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    ConditionalEvaluation(CodeGenFunction &CGF)
920150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall      : StartBB(CGF.Builder.GetInsertBlock()) {}
9219cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
922150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    void begin(CodeGenFunction &CGF) {
923150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall      assert(CGF.OutermostConditional != this);
924150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall      if (!CGF.OutermostConditional)
925150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall        CGF.OutermostConditional = this;
926150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    }
927150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
928150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    void end(CodeGenFunction &CGF) {
929150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall      assert(CGF.OutermostConditional != 0);
930150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall      if (CGF.OutermostConditional == this)
931150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall        CGF.OutermostConditional = 0;
932150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    }
933150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
934150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    /// Returns a block which will be executed prior to each
935150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    /// evaluation of the conditional code.
936150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    llvm::BasicBlock *getStartingBlock() const {
937150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall      return StartBB;
938150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    }
939150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  };
9401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
9413019c444c672938c57f5573840071ecd73425ee7John McCall  /// isInConditionalBranch - Return true if we're currently emitting
9423019c444c672938c57f5573840071ecd73425ee7John McCall  /// one branch or the other of a conditional expression.
943150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  bool isInConditionalBranch() const { return OutermostConditional != 0; }
944150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
9456f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
9466f103ba42cb69d50005a977c5ea583984ab63fc4John McCall    assert(isInConditionalBranch());
9476f103ba42cb69d50005a977c5ea583984ab63fc4John McCall    llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
9486f103ba42cb69d50005a977c5ea583984ab63fc4John McCall    new llvm::StoreInst(value, addr, &block->back());
9496f103ba42cb69d50005a977c5ea583984ab63fc4John McCall  }
9506f103ba42cb69d50005a977c5ea583984ab63fc4John McCall
951150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  /// An RAII object to record that we're evaluating a statement
952150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  /// expression.
953150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  class StmtExprEvaluation {
954150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    CodeGenFunction &CGF;
955150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
956150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    /// We have to save the outermost conditional: cleanups in a
957150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    /// statement expression aren't conditional just because the
958150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    /// StmtExpr is.
959150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    ConditionalEvaluation *SavedOutermostConditional;
960150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
961150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  public:
962150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    StmtExprEvaluation(CodeGenFunction &CGF)
963150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall      : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
964150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall      CGF.OutermostConditional = 0;
965150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    }
966150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
967150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    ~StmtExprEvaluation() {
968150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall      CGF.OutermostConditional = SavedOutermostConditional;
969150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall      CGF.EnsureInsertPoint();
970150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    }
971150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  };
972e996ffd240f20a1048179d7727a6ee3227261921John McCall
97356ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// An object which temporarily prevents a value from being
97456ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// destroyed by aggressive peephole optimizations that assume that
97556ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// all uses of a value have been realized in the IR.
97656ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  class PeepholeProtection {
97756ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    llvm::Instruction *Inst;
97856ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    friend class CodeGenFunction;
97956ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall
98056ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  public:
98156ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    PeepholeProtection() : Inst(0) {}
9824b9c2d235fb9449e249d74f48ecfec601650de93John McCall  };
98356ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall
9844b9c2d235fb9449e249d74f48ecfec601650de93John McCall  /// A non-RAII class containing all the information about a bound
9854b9c2d235fb9449e249d74f48ecfec601650de93John McCall  /// opaque value.  OpaqueValueMapping, below, is a RAII wrapper for
9864b9c2d235fb9449e249d74f48ecfec601650de93John McCall  /// this which makes individual mappings very simple; using this
9874b9c2d235fb9449e249d74f48ecfec601650de93John McCall  /// class directly is useful when you have a variable number of
9884b9c2d235fb9449e249d74f48ecfec601650de93John McCall  /// opaque values or don't want the RAII functionality for some
9894b9c2d235fb9449e249d74f48ecfec601650de93John McCall  /// reason.
9904b9c2d235fb9449e249d74f48ecfec601650de93John McCall  class OpaqueValueMappingData {
991e996ffd240f20a1048179d7727a6ee3227261921John McCall    const OpaqueValueExpr *OpaqueValue;
99256ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    bool BoundLValue;
99356ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    CodeGenFunction::PeepholeProtection Protection;
994e996ffd240f20a1048179d7727a6ee3227261921John McCall
9954b9c2d235fb9449e249d74f48ecfec601650de93John McCall    OpaqueValueMappingData(const OpaqueValueExpr *ov,
9964b9c2d235fb9449e249d74f48ecfec601650de93John McCall                           bool boundLValue)
9974b9c2d235fb9449e249d74f48ecfec601650de93John McCall      : OpaqueValue(ov), BoundLValue(boundLValue) {}
998e996ffd240f20a1048179d7727a6ee3227261921John McCall  public:
9994b9c2d235fb9449e249d74f48ecfec601650de93John McCall    OpaqueValueMappingData() : OpaqueValue(0) {}
10004b9c2d235fb9449e249d74f48ecfec601650de93John McCall
100156ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    static bool shouldBindAsLValue(const Expr *expr) {
1002a5493f885095bd63d525a7035ad1c224de3ae5f2John McCall      // gl-values should be bound as l-values for obvious reasons.
1003a5493f885095bd63d525a7035ad1c224de3ae5f2John McCall      // Records should be bound as l-values because IR generation
1004a5493f885095bd63d525a7035ad1c224de3ae5f2John McCall      // always keeps them in memory.  Expressions of function type
1005a5493f885095bd63d525a7035ad1c224de3ae5f2John McCall      // act exactly like l-values but are formally required to be
1006a5493f885095bd63d525a7035ad1c224de3ae5f2John McCall      // r-values in C.
1007a5493f885095bd63d525a7035ad1c224de3ae5f2John McCall      return expr->isGLValue() ||
1008a5493f885095bd63d525a7035ad1c224de3ae5f2John McCall             expr->getType()->isRecordType() ||
1009a5493f885095bd63d525a7035ad1c224de3ae5f2John McCall             expr->getType()->isFunctionType();
101056ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    }
101156ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall
10124b9c2d235fb9449e249d74f48ecfec601650de93John McCall    static OpaqueValueMappingData bind(CodeGenFunction &CGF,
10134b9c2d235fb9449e249d74f48ecfec601650de93John McCall                                       const OpaqueValueExpr *ov,
10144b9c2d235fb9449e249d74f48ecfec601650de93John McCall                                       const Expr *e) {
10154b9c2d235fb9449e249d74f48ecfec601650de93John McCall      if (shouldBindAsLValue(ov))
10164b9c2d235fb9449e249d74f48ecfec601650de93John McCall        return bind(CGF, ov, CGF.EmitLValue(e));
10174b9c2d235fb9449e249d74f48ecfec601650de93John McCall      return bind(CGF, ov, CGF.EmitAnyExpr(e));
10184b9c2d235fb9449e249d74f48ecfec601650de93John McCall    }
10194b9c2d235fb9449e249d74f48ecfec601650de93John McCall
10204b9c2d235fb9449e249d74f48ecfec601650de93John McCall    static OpaqueValueMappingData bind(CodeGenFunction &CGF,
10214b9c2d235fb9449e249d74f48ecfec601650de93John McCall                                       const OpaqueValueExpr *ov,
10224b9c2d235fb9449e249d74f48ecfec601650de93John McCall                                       const LValue &lv) {
10234b9c2d235fb9449e249d74f48ecfec601650de93John McCall      assert(shouldBindAsLValue(ov));
10244b9c2d235fb9449e249d74f48ecfec601650de93John McCall      CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
10254b9c2d235fb9449e249d74f48ecfec601650de93John McCall      return OpaqueValueMappingData(ov, true);
10264b9c2d235fb9449e249d74f48ecfec601650de93John McCall    }
10274b9c2d235fb9449e249d74f48ecfec601650de93John McCall
10284b9c2d235fb9449e249d74f48ecfec601650de93John McCall    static OpaqueValueMappingData bind(CodeGenFunction &CGF,
10294b9c2d235fb9449e249d74f48ecfec601650de93John McCall                                       const OpaqueValueExpr *ov,
10304b9c2d235fb9449e249d74f48ecfec601650de93John McCall                                       const RValue &rv) {
10314b9c2d235fb9449e249d74f48ecfec601650de93John McCall      assert(!shouldBindAsLValue(ov));
10324b9c2d235fb9449e249d74f48ecfec601650de93John McCall      CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
10334b9c2d235fb9449e249d74f48ecfec601650de93John McCall
10344b9c2d235fb9449e249d74f48ecfec601650de93John McCall      OpaqueValueMappingData data(ov, false);
10354b9c2d235fb9449e249d74f48ecfec601650de93John McCall
10364b9c2d235fb9449e249d74f48ecfec601650de93John McCall      // Work around an extremely aggressive peephole optimization in
10374b9c2d235fb9449e249d74f48ecfec601650de93John McCall      // EmitScalarConversion which assumes that all other uses of a
10384b9c2d235fb9449e249d74f48ecfec601650de93John McCall      // value are extant.
10394b9c2d235fb9449e249d74f48ecfec601650de93John McCall      data.Protection = CGF.protectFromPeepholes(rv);
10404b9c2d235fb9449e249d74f48ecfec601650de93John McCall
10414b9c2d235fb9449e249d74f48ecfec601650de93John McCall      return data;
10424b9c2d235fb9449e249d74f48ecfec601650de93John McCall    }
10434b9c2d235fb9449e249d74f48ecfec601650de93John McCall
10444b9c2d235fb9449e249d74f48ecfec601650de93John McCall    bool isValid() const { return OpaqueValue != 0; }
10454b9c2d235fb9449e249d74f48ecfec601650de93John McCall    void clear() { OpaqueValue = 0; }
10464b9c2d235fb9449e249d74f48ecfec601650de93John McCall
10474b9c2d235fb9449e249d74f48ecfec601650de93John McCall    void unbind(CodeGenFunction &CGF) {
10484b9c2d235fb9449e249d74f48ecfec601650de93John McCall      assert(OpaqueValue && "no data to unbind!");
10494b9c2d235fb9449e249d74f48ecfec601650de93John McCall
10504b9c2d235fb9449e249d74f48ecfec601650de93John McCall      if (BoundLValue) {
10514b9c2d235fb9449e249d74f48ecfec601650de93John McCall        CGF.OpaqueLValues.erase(OpaqueValue);
10524b9c2d235fb9449e249d74f48ecfec601650de93John McCall      } else {
10534b9c2d235fb9449e249d74f48ecfec601650de93John McCall        CGF.OpaqueRValues.erase(OpaqueValue);
10544b9c2d235fb9449e249d74f48ecfec601650de93John McCall        CGF.unprotectFromPeepholes(Protection);
10554b9c2d235fb9449e249d74f48ecfec601650de93John McCall      }
10564b9c2d235fb9449e249d74f48ecfec601650de93John McCall    }
10574b9c2d235fb9449e249d74f48ecfec601650de93John McCall  };
10584b9c2d235fb9449e249d74f48ecfec601650de93John McCall
10594b9c2d235fb9449e249d74f48ecfec601650de93John McCall  /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
10604b9c2d235fb9449e249d74f48ecfec601650de93John McCall  class OpaqueValueMapping {
10614b9c2d235fb9449e249d74f48ecfec601650de93John McCall    CodeGenFunction &CGF;
10624b9c2d235fb9449e249d74f48ecfec601650de93John McCall    OpaqueValueMappingData Data;
10634b9c2d235fb9449e249d74f48ecfec601650de93John McCall
10644b9c2d235fb9449e249d74f48ecfec601650de93John McCall  public:
10654b9c2d235fb9449e249d74f48ecfec601650de93John McCall    static bool shouldBindAsLValue(const Expr *expr) {
10664b9c2d235fb9449e249d74f48ecfec601650de93John McCall      return OpaqueValueMappingData::shouldBindAsLValue(expr);
10674b9c2d235fb9449e249d74f48ecfec601650de93John McCall    }
10684b9c2d235fb9449e249d74f48ecfec601650de93John McCall
106956ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    /// Build the opaque value mapping for the given conditional
107056ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    /// operator if it's the GNU ?: extension.  This is a common
107156ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    /// enough pattern that the convenience operator is really
107256ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    /// helpful.
107356ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    ///
107456ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    OpaqueValueMapping(CodeGenFunction &CGF,
107556ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall                       const AbstractConditionalOperator *op) : CGF(CGF) {
10764b9c2d235fb9449e249d74f48ecfec601650de93John McCall      if (isa<ConditionalOperator>(op))
10774b9c2d235fb9449e249d74f48ecfec601650de93John McCall        // Leave Data empty.
107856ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall        return;
107956ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall
108056ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall      const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
10814b9c2d235fb9449e249d74f48ecfec601650de93John McCall      Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
10824b9c2d235fb9449e249d74f48ecfec601650de93John McCall                                          e->getCommon());
108356ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    }
108456ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall
1085e996ffd240f20a1048179d7727a6ee3227261921John McCall    OpaqueValueMapping(CodeGenFunction &CGF,
1086e996ffd240f20a1048179d7727a6ee3227261921John McCall                       const OpaqueValueExpr *opaqueValue,
108756ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall                       LValue lvalue)
10884b9c2d235fb9449e249d74f48ecfec601650de93John McCall      : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
108956ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    }
109056ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall
109156ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    OpaqueValueMapping(CodeGenFunction &CGF,
109256ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall                       const OpaqueValueExpr *opaqueValue,
109356ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall                       RValue rvalue)
10944b9c2d235fb9449e249d74f48ecfec601650de93John McCall      : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
1095e996ffd240f20a1048179d7727a6ee3227261921John McCall    }
1096e996ffd240f20a1048179d7727a6ee3227261921John McCall
1097e996ffd240f20a1048179d7727a6ee3227261921John McCall    void pop() {
10984b9c2d235fb9449e249d74f48ecfec601650de93John McCall      Data.unbind(CGF);
10994b9c2d235fb9449e249d74f48ecfec601650de93John McCall      Data.clear();
1100e996ffd240f20a1048179d7727a6ee3227261921John McCall    }
1101e996ffd240f20a1048179d7727a6ee3227261921John McCall
1102e996ffd240f20a1048179d7727a6ee3227261921John McCall    ~OpaqueValueMapping() {
11034b9c2d235fb9449e249d74f48ecfec601650de93John McCall      if (Data.isValid()) Data.unbind(CGF);
1104e996ffd240f20a1048179d7727a6ee3227261921John McCall    }
1105e996ffd240f20a1048179d7727a6ee3227261921John McCall  };
1106e220455a059d926953befe72857b9525273717efFariborz Jahanian
1107e220455a059d926953befe72857b9525273717efFariborz Jahanian  /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
1108e220455a059d926953befe72857b9525273717efFariborz Jahanian  /// number that holds the value.
1109e220455a059d926953befe72857b9525273717efFariborz Jahanian  unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
111052a80e19ad688091723a52ad53337767bb0ac684Fariborz Jahanian
111152a80e19ad688091723a52ad53337767bb0ac684Fariborz Jahanian  /// BuildBlockByrefAddress - Computes address location of the
111252a80e19ad688091723a52ad53337767bb0ac684Fariborz Jahanian  /// variable which is declared as __block.
111352a80e19ad688091723a52ad53337767bb0ac684Fariborz Jahanian  llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
111452a80e19ad688091723a52ad53337767bb0ac684Fariborz Jahanian                                      const VarDecl *V);
11157f02f721d48772e4eee4fccd8af4f800be1bbc1eChris Lattnerprivate:
1116d9becd1846e2c72bf6ad283faa1b048f33dd3afeChris Lattner  CGDebugInfo *DebugInfo;
1117aa11289f754d220c9c155b68a4f84cdcfcefef6aDevang Patel  bool DisableDebugInfo;
111809429b962811f2c0a7a81a1b0a89f96f5878b20cMike Stump
111993c332a8ba2c193c435b293966d343dab15f555bJohn McCall  /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
112093c332a8ba2c193c435b293966d343dab15f555bJohn McCall  /// calling llvm.stacksave for multiple VLAs in the same scope.
112193c332a8ba2c193c435b293966d343dab15f555bJohn McCall  bool DidCallStackSave;
112293c332a8ba2c193c435b293966d343dab15f555bJohn McCall
1123f71d232ce5354bd2f0c94ded30fb936c2a3d968bMike Stump  /// IndirectBranch - The first time an indirect goto is seen we create a block
1124f71d232ce5354bd2f0c94ded30fb936c2a3d968bMike Stump  /// with an indirect branch.  Every time we see the address of a label taken,
1125f71d232ce5354bd2f0c94ded30fb936c2a3d968bMike Stump  /// we add the label to the indirect goto.  Every subsequent indirect goto is
1126f71d232ce5354bd2f0c94ded30fb936c2a3d968bMike Stump  /// codegen'd as a jump to the IndirectBranch's basic block.
1127d9becd1846e2c72bf6ad283faa1b048f33dd3afeChris Lattner  llvm::IndirectBrInst *IndirectBranch;
11280ffb125996336fc7602b162c0a9e392f1a93060fDaniel Dunbar
11290dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
11300dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// decls.
11316b5a61b6dc400027fd793dcadceeb9da944a37eaJohn McCall  typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
11326b5a61b6dc400027fd793dcadceeb9da944a37eaJohn McCall  DeclMapTy LocalDeclMap;
11335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
11345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// LabelMap - This keeps track of the LLVM basic block for each C label.
1135ad8dcf4a9df0e24051dc31bf9e6f3cd138a34298Chris Lattner  llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
11360dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
11370dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  // BreakContinueStack - This keeps track of where break and continue
1138e4b6d342c29d5cb9d311756100df1603810fa892Anders Carlsson  // statements should jump to.
1139da13870e99fe33934b2122f06528a5063f78ae4cChris Lattner  struct BreakContinue {
1140f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    BreakContinue(JumpDest Break, JumpDest Continue)
1141f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall      : BreakBlock(Break), ContinueBlock(Continue) {}
11420dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
1143f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    JumpDest BreakBlock;
1144f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    JumpDest ContinueBlock;
11450dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  };
1146686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  SmallVector<BreakContinue, 8> BreakContinueStack;
114718ccc7776ad6288c5f630dc7967fb99d099c9cd9Daniel Dunbar
1148170fd49294b85ab10f820721d99ff9d109c7230dZhongxing Xu  /// SwitchInsn - This is nearest current switch instruction. It is null if
11490dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// current context is not in a switch.
115051b09f2c528c8460b5465c676173324e44176d62Devang Patel  llvm::SwitchInst *SwitchInsn;
115151b09f2c528c8460b5465c676173324e44176d62Devang Patel
11520dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// CaseRangeBlock - This block holds if condition check for last case
115380fd5f96e6805ac43aab99faabd5b4c8b19551b7Devang Patel  /// statement range in current switch instruction.
1154c049e4f406a7f7179eba98659044a32508e53289Devang Patel  llvm::BasicBlock *CaseRangeBlock;
1155c049e4f406a7f7179eba98659044a32508e53289Devang Patel
115656ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// OpaqueLValues - Keeps track of the current set of opaque value
1157e996ffd240f20a1048179d7727a6ee3227261921John McCall  /// expressions.
115856ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
115956ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
1160e996ffd240f20a1048179d7727a6ee3227261921John McCall
11610dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  // VLASizeMap - This keeps track of the associated size for each VLA type.
1162bbed6b964414145b29e7b60b3e538093734ea3f8Eli Friedman  // We track this by the size expression rather than the type itself because
1163bbed6b964414145b29e7b60b3e538093734ea3f8Eli Friedman  // in certain situations, like a const qualifier applied to an VLA typedef,
1164bbed6b964414145b29e7b60b3e538093734ea3f8Eli Friedman  // multiple VLA types can share the same size expression.
11650dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
11660dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  // enter/leave scopes.
1167bbed6b964414145b29e7b60b3e538093734ea3f8Eli Friedman  llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
11680dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
1169f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// A block containing a single 'unreachable' instruction.  Created
1170f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// lazily by getUnreachableBlock().
1171f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  llvm::BasicBlock *UnreachableBlock;
11720dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
1173f6c56e2323c3f973253805a2f35629f3253ebed4Anders Carlsson  /// CXXThisDecl - When generating code for a C++ member function,
1174f6c56e2323c3f973253805a2f35629f3253ebed4Anders Carlsson  /// this will hold the implicit 'this' declaration.
1175cec5ebd4a6a89a7023d04cec728fd340b541ed61Eli Friedman  ImplicitParamDecl *CXXABIThisDecl;
1176cec5ebd4a6a89a7023d04cec728fd340b541ed61Eli Friedman  llvm::Value *CXXABIThisValue;
11772504941793b549323f9d29c62507cf21d865fadeJohn McCall  llvm::Value *CXXThisValue;
11781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1179f6c56e2323c3f973253805a2f35629f3253ebed4Anders Carlsson  /// CXXVTTDecl - When generating code for a base object constructor or
1180f6c56e2323c3f973253805a2f35629f3253ebed4Anders Carlsson  /// base object destructor with virtual bases, this will hold the implicit
1181f6c56e2323c3f973253805a2f35629f3253ebed4Anders Carlsson  /// VTT parameter.
1182f6c56e2323c3f973253805a2f35629f3253ebed4Anders Carlsson  ImplicitParamDecl *CXXVTTDecl;
11832504941793b549323f9d29c62507cf21d865fadeJohn McCall  llvm::Value *CXXVTTValue;
11849cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
1185150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  /// OutermostConditional - Points to the outermost active
1186150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  /// conditional control.  This is used so that we know if a
1187150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  /// temporary should be destroyed conditionally.
1188150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  ConditionalEvaluation *OutermostConditional;
11891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
11907dfa4079f4b37507048b19bfc693d3b015d9dd11Anders Carlsson
11917dfa4079f4b37507048b19bfc693d3b015d9dd11Anders Carlsson  /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
11927dfa4079f4b37507048b19bfc693d3b015d9dd11Anders Carlsson  /// type as well as the field number that contains the actual data.
11932acc6e3feda5e4f7d9009bdcf8b1cd777fecfe2dChris Lattner  llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
11947dfa4079f4b37507048b19bfc693d3b015d9dd11Anders Carlsson                                              unsigned> > ByRefValueInfo;
11959cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
1196f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  llvm::BasicBlock *TerminateLandingPad;
1197182f383db1782af752ecaf607fdff72a8542088bMike Stump  llvm::BasicBlock *TerminateHandler;
119883252dcfe61aaebcb6bc117e71dc12968729513fChris Lattner  llvm::BasicBlock *TrapBB;
1199940670512d7c3d93389bb38a426abcb7ef44271eEli Friedman
12000df579ec000ffe52e0cddf1e7ee5e50a55256835Tanya Lattner  /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
12010df579ec000ffe52e0cddf1e7ee5e50a55256835Tanya Lattner  /// In the kernel metadata node, reference the kernel function and metadata
12020df579ec000ffe52e0cddf1e7ee5e50a55256835Tanya Lattner  /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
12030df579ec000ffe52e0cddf1e7ee5e50a55256835Tanya Lattner  /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
12040df579ec000ffe52e0cddf1e7ee5e50a55256835Tanya Lattner  ///   "work_group_size_hint", and three 32-bit integers X, Y and Z.
12050df579ec000ffe52e0cddf1e7ee5e50a55256835Tanya Lattner  /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
12060df579ec000ffe52e0cddf1e7ee5e50a55256835Tanya Lattner  ///   "reqd_work_group_size", and three 32-bit integers X, Y and Z.
12070df579ec000ffe52e0cddf1e7ee5e50a55256835Tanya Lattner  void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
12080df579ec000ffe52e0cddf1e7ee5e50a55256835Tanya Lattner                                llvm::Function *Fn);
12090df579ec000ffe52e0cddf1e7ee5e50a55256835Tanya Lattner
12105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic:
12114904bf4e84cfb48080270ebaa9005327f18ab0e5Fariborz Jahanian  CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
12121a343ebbf413e8eae6b2737b2b2d79cbf5765571John McCall  ~CodeGenFunction();
12130dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
12141e7fe751466ea82665fd21e9162fd7cc9c5f412dJohn McCall  CodeGenTypes &getTypes() const { return CGM.getTypes(); }
1215f2aac84709c418189e476ad591848dad50291885John McCall  ASTContext &getContext() const { return CGM.getContext(); }
1216a240df2ec1b374b3e9e7f760875ffb17cd64506fAlexey Samsonov  /// Returns true if DebugInfo is actually initialized.
1217a240df2ec1b374b3e9e7f760875ffb17cd64506fAlexey Samsonov  bool maybeInitializeDebugInfo() {
1218a240df2ec1b374b3e9e7f760875ffb17cd64506fAlexey Samsonov    if (CGM.getModuleDebugInfo()) {
1219a240df2ec1b374b3e9e7f760875ffb17cd64506fAlexey Samsonov      DebugInfo = CGM.getModuleDebugInfo();
1220a240df2ec1b374b3e9e7f760875ffb17cd64506fAlexey Samsonov      return true;
1221a240df2ec1b374b3e9e7f760875ffb17cd64506fAlexey Samsonov    }
1222a240df2ec1b374b3e9e7f760875ffb17cd64506fAlexey Samsonov    return false;
1223a240df2ec1b374b3e9e7f760875ffb17cd64506fAlexey Samsonov  }
1224aa11289f754d220c9c155b68a4f84cdcfcefef6aDevang Patel  CGDebugInfo *getDebugInfo() {
1225aa11289f754d220c9c155b68a4f84cdcfcefef6aDevang Patel    if (DisableDebugInfo)
1226aa11289f754d220c9c155b68a4f84cdcfcefef6aDevang Patel      return NULL;
1227aa11289f754d220c9c155b68a4f84cdcfcefef6aDevang Patel    return DebugInfo;
1228aa11289f754d220c9c155b68a4f84cdcfcefef6aDevang Patel  }
1229aa11289f754d220c9c155b68a4f84cdcfcefef6aDevang Patel  void disableDebugInfo() { DisableDebugInfo = true; }
1230aa11289f754d220c9c155b68a4f84cdcfcefef6aDevang Patel  void enableDebugInfo() { DisableDebugInfo = false; }
1231aa11289f754d220c9c155b68a4f84cdcfcefef6aDevang Patel
1232f85e193739c953358c865005855253af4f68a497John McCall  bool shouldUseFusedARCCalls() {
1233f85e193739c953358c865005855253af4f68a497John McCall    return CGM.getCodeGenOpts().OptimizationLevel == 0;
1234f85e193739c953358c865005855253af4f68a497John McCall  }
12355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
12364e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie  const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
1237d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall
1238285cfd8953d4ca4da613a47a0d691f7234068f8cBill Wendling  /// Returns a pointer to the function's exception object and selector slot,
1239285cfd8953d4ca4da613a47a0d691f7234068f8cBill Wendling  /// which is assigned in every landing pad.
1240f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  llvm::Value *getExceptionSlot();
124193c332a8ba2c193c435b293966d343dab15f555bJohn McCall  llvm::Value *getEHSelectorSlot();
1242f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
1243ae270598d5c7a9a283d4b3ddce53b151c6e2b182Bill Wendling  /// Returns the contents of the function's exception object and selector
1244ae270598d5c7a9a283d4b3ddce53b151c6e2b182Bill Wendling  /// slots.
1245ae270598d5c7a9a283d4b3ddce53b151c6e2b182Bill Wendling  llvm::Value *getExceptionFromSlot();
1246ae270598d5c7a9a283d4b3ddce53b151c6e2b182Bill Wendling  llvm::Value *getSelectorFromSlot();
1247ae270598d5c7a9a283d4b3ddce53b151c6e2b182Bill Wendling
1248ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall  llvm::Value *getNormalCleanupDestSlot();
1249ff8e11579fc904aa4032d90d2be6ce1ac5fc9fe1John McCall
1250f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  llvm::BasicBlock *getUnreachableBlock() {
1251f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    if (!UnreachableBlock) {
1252f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall      UnreachableBlock = createBasicBlock("unreachable");
1253f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall      new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1254f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    }
1255f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    return UnreachableBlock;
1256f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  }
1257f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
1258f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  llvm::BasicBlock *getInvokeDest() {
1259f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    if (!EHStack.requiresLandingPad()) return 0;
1260f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall    return getInvokeDestImpl();
1261f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  }
12629834ffbe54788239c8361d3cfe5826fd277ddfb2Daniel Dunbar
1263d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall  llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
126469243825cb5c91ec7207256aa57ae327cfaf8cb2Owen Anderson
12659834ffbe54788239c8361d3cfe5826fd277ddfb2Daniel Dunbar  //===--------------------------------------------------------------------===//
1266bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  //                                  Cleanups
1267bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  //===--------------------------------------------------------------------===//
1268bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall
1269bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1270bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall
12712673c68aa58e277ebc755b71d81aca618cdedbf9John McCall  void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
12722673c68aa58e277ebc755b71d81aca618cdedbf9John McCall                                        llvm::Value *arrayEndPointer,
12732673c68aa58e277ebc755b71d81aca618cdedbf9John McCall                                        QualType elementType,
1274516bbd42e62d709013824d6fb8445a0cfda3129aPeter Collingbourne                                        Destroyer *destroyer);
12752673c68aa58e277ebc755b71d81aca618cdedbf9John McCall  void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
12762673c68aa58e277ebc755b71d81aca618cdedbf9John McCall                                      llvm::Value *arrayEnd,
12772673c68aa58e277ebc755b71d81aca618cdedbf9John McCall                                      QualType elementType,
1278516bbd42e62d709013824d6fb8445a0cfda3129aPeter Collingbourne                                      Destroyer *destroyer);
1279bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall
12809928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall  void pushDestroy(QualType::DestructionKind dtorKind,
12819928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall                   llvm::Value *addr, QualType type);
1282bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
1283516bbd42e62d709013824d6fb8445a0cfda3129aPeter Collingbourne                   Destroyer *destroyer, bool useEHCleanupForArray);
1284516bbd42e62d709013824d6fb8445a0cfda3129aPeter Collingbourne  void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
12852673c68aa58e277ebc755b71d81aca618cdedbf9John McCall                   bool useEHCleanupForArray);
1286a91f6661c4685fecee6dc09bdaef73254c1aaa06John McCall  llvm::Function *generateDestroyHelper(llvm::Constant *addr,
1287a91f6661c4685fecee6dc09bdaef73254c1aaa06John McCall                                        QualType type,
1288516bbd42e62d709013824d6fb8445a0cfda3129aPeter Collingbourne                                        Destroyer *destroyer,
1289a91f6661c4685fecee6dc09bdaef73254c1aaa06John McCall                                        bool useEHCleanupForArray);
1290bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
1291516bbd42e62d709013824d6fb8445a0cfda3129aPeter Collingbourne                        QualType type, Destroyer *destroyer,
1292fbf780a9d1dbb191fc40c8af967c590e08724b74John McCall                        bool checkZeroLength, bool useEHCleanup);
1293bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall
1294516bbd42e62d709013824d6fb8445a0cfda3129aPeter Collingbourne  Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
12959928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall
1296bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  /// Determines whether an EH cleanup is required to destroy a type
1297bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  /// with the given destruction kind.
1298bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  bool needsEHCleanup(QualType::DestructionKind kind) {
1299bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall    switch (kind) {
1300bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall    case QualType::DK_none:
1301bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall      return false;
1302bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall    case QualType::DK_cxx_destructor:
1303bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall    case QualType::DK_objc_weak_lifetime:
13044e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie      return getLangOpts().Exceptions;
1305bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall    case QualType::DK_objc_strong_lifetime:
13064e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie      return getLangOpts().Exceptions &&
1307bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall             CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1308bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall    }
1309bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall    llvm_unreachable("bad destruction kind");
1310bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  }
1311bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall
13129928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall  CleanupKind getCleanupKind(QualType::DestructionKind kind) {
13139928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall    return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
13149928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall  }
13159928c4805aa8d5fabd488d0d0c5aeb64fd50f0e3John McCall
1316bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  //===--------------------------------------------------------------------===//
13179834ffbe54788239c8361d3cfe5826fd277ddfb2Daniel Dunbar  //                                  Objective-C
13189834ffbe54788239c8361d3cfe5826fd277ddfb2Daniel Dunbar  //===--------------------------------------------------------------------===//
13199834ffbe54788239c8361d3cfe5826fd277ddfb2Daniel Dunbar
1320391d77a26382dddf25da73e29fc1fa5aaaea4c6fChris Lattner  void GenerateObjCMethod(const ObjCMethodDecl *OMD);
1321af05bb9073319d8381b71c4325188853fd4b8ed6Daniel Dunbar
13220dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  void StartObjCMethod(const ObjCMethodDecl *MD,
13238d3f8979e46f9d0b8735566eabe471db0e1e0e53Devang Patel                       const ObjCContainerDecl *CD,
13248d3f8979e46f9d0b8735566eabe471db0e1e0e53Devang Patel                       SourceLocation StartLoc);
1325af05bb9073319d8381b71c4325188853fd4b8ed6Daniel Dunbar
13260dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
1327fef30b55230064d334a669a065a1c9acdb87cdfeFariborz Jahanian  void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1328fef30b55230064d334a669a065a1c9acdb87cdfeFariborz Jahanian                          const ObjCPropertyImplDecl *PID);
13291e1f4871535f2cadcbf8c9af8cc48a2213192320John McCall  void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
1330b6e5fe3cae9bf456f084c555c3ecc256f4181cc5Fariborz Jahanian                              const ObjCPropertyImplDecl *propImpl,
1331490a52b4947381879a47b4251db5fb81cdf5d02bFariborz Jahanian                              const ObjCMethodDecl *GetterMothodDecl,
1332b6e5fe3cae9bf456f084c555c3ecc256f4181cc5Fariborz Jahanian                              llvm::Constant *AtomicHelperFn);
13332846b97965e980ad2e7c8d444b82cc21d733a699Fariborz Jahanian
1334109dfc6ca6652f60c55ed0f2631aebf323d0200dFariborz Jahanian  void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1335109dfc6ca6652f60c55ed0f2631aebf323d0200dFariborz Jahanian                                  ObjCMethodDecl *MD, bool ctor);
1336af05bb9073319d8381b71c4325188853fd4b8ed6Daniel Dunbar
13370dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// GenerateObjCSetter - Synthesize an Objective-C property setter function
13380dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// for the given property.
1339fef30b55230064d334a669a065a1c9acdb87cdfeFariborz Jahanian  void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1340fef30b55230064d334a669a065a1c9acdb87cdfeFariborz Jahanian                          const ObjCPropertyImplDecl *PID);
134171c758d3f4ecc8b511e6ae4a7210486aa994c182John McCall  void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
1342cd93b96bc51c255d104095bc6a6d8eac74a84b1eFariborz Jahanian                              const ObjCPropertyImplDecl *propImpl,
1343cd93b96bc51c255d104095bc6a6d8eac74a84b1eFariborz Jahanian                              llvm::Constant *AtomicHelperFn);
13440b2bd47151ee9205ad6c66d1ffb921918106088aFariborz Jahanian  bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
134515bd58842adaa4f8cca4e58047ed18e033858d9bFariborz Jahanian  bool IvarTypeWithAggrGCObjects(QualType Ty);
1346af05bb9073319d8381b71c4325188853fd4b8ed6Daniel Dunbar
13474e7a1f7682d94811bd41fca8aefccc38f686db23Mike Stump  //===--------------------------------------------------------------------===//
13484e7a1f7682d94811bd41fca8aefccc38f686db23Mike Stump  //                                  Block Bits
13494e7a1f7682d94811bd41fca8aefccc38f686db23Mike Stump  //===--------------------------------------------------------------------===//
13504e7a1f7682d94811bd41fca8aefccc38f686db23Mike Stump
13516b5a61b6dc400027fd793dcadceeb9da944a37eaJohn McCall  llvm::Value *EmitBlockLiteral(const BlockExpr *);
13521a343ebbf413e8eae6b2737b2b2d79cbf5765571John McCall  llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
13531a343ebbf413e8eae6b2737b2b2d79cbf5765571John McCall  static void destroyBlockInfos(CGBlockInfo *info);
13542a7eb28397148079cbc8e54e8a3871ef01c4f4bcBlaine Garst  llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
135589ecd41e0a6bfb3b0913dbe41c3c666340b308c7Fariborz Jahanian                                           const CGBlockInfo &Info,
13562acc6e3feda5e4f7d9009bdcf8b1cd777fecfe2dChris Lattner                                           llvm::StructType *,
1357d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall                                           llvm::Constant *BlockVarLayout);
13584e7a1f7682d94811bd41fca8aefccc38f686db23Mike Stump
1359564360be450b319aeafc26698be9811837bfb826Fariborz Jahanian  llvm::Function *GenerateBlockFunction(GlobalDecl GD,
13606b5a61b6dc400027fd793dcadceeb9da944a37eaJohn McCall                                        const CGBlockInfo &Info,
13616cc88f78fd36d3511b89412b193494b3e423cbffMike Stump                                        const Decl *OuterFuncDecl,
136264bee65a3436e3f0c352fcfe2130676f3502cffeEli Friedman                                        const DeclMapTy &ldm,
136364bee65a3436e3f0c352fcfe2130676f3502cffeEli Friedman                                        bool IsLambdaConversionToBlock);
13644e7a1f7682d94811bd41fca8aefccc38f686db23Mike Stump
1365d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall  llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1366d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall  llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
136720abee6b95c4f5a61e471b4b616439280ca4a81bFariborz Jahanian  llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
136820abee6b95c4f5a61e471b4b616439280ca4a81bFariborz Jahanian                                             const ObjCPropertyImplDecl *PID);
136920abee6b95c4f5a61e471b4b616439280ca4a81bFariborz Jahanian  llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
137020abee6b95c4f5a61e471b4b616439280ca4a81bFariborz Jahanian                                             const ObjCPropertyImplDecl *PID);
1371cae40c4d448529fe65de3d87bdbe97d3b54b4d98Eli Friedman  llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
1372d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall
1373d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall  void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1374d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall
13755af02db5a48476e0748f135369663080eae87c64John McCall  class AutoVarEmission;
13765af02db5a48476e0748f135369663080eae87c64John McCall
13775af02db5a48476e0748f135369663080eae87c64John McCall  void emitByrefStructureInit(const AutoVarEmission &emission);
13785af02db5a48476e0748f135369663080eae87c64John McCall  void enterByrefCleanup(const AutoVarEmission &emission);
13795af02db5a48476e0748f135369663080eae87c64John McCall
13806b5a61b6dc400027fd793dcadceeb9da944a37eaJohn McCall  llvm::Value *LoadBlockStruct() {
13816b5a61b6dc400027fd793dcadceeb9da944a37eaJohn McCall    assert(BlockPointer && "no block pointer set!");
13826b5a61b6dc400027fd793dcadceeb9da944a37eaJohn McCall    return BlockPointer;
13836b5a61b6dc400027fd793dcadceeb9da944a37eaJohn McCall  }
13844e7a1f7682d94811bd41fca8aefccc38f686db23Mike Stump
1385ea1471e0e967548c596a71469702f8846dbaf3c0John McCall  void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
1386f4b88a45902af1802a1cb42ba48b1c474474f228John McCall  void AllocateBlockDecl(const DeclRefExpr *E);
13876b5a61b6dc400027fd793dcadceeb9da944a37eaJohn McCall  llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
13882acc6e3feda5e4f7d9009bdcf8b1cd777fecfe2dChris Lattner  llvm::Type *BuildByRefType(const VarDecl *var);
1389dab514fc30242c7afd6c03956e46136c400fb0d3Mike Stump
1390d26bc76c98006609002d9930f8840490e88ac5b5John McCall  void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1391d26bc76c98006609002d9930f8840490e88ac5b5John McCall                    const CGFunctionInfo &FnInfo);
13920ff8bafde95f6fa51ccea70738c1b99db870bddcAnders Carlsson  void StartFunction(GlobalDecl GD, QualType RetTy,
13937c086516f3cc9fba2733b1919973206c6ba4b171Daniel Dunbar                     llvm::Function *Fn,
1394d26bc76c98006609002d9930f8840490e88ac5b5John McCall                     const CGFunctionInfo &FnInfo,
13952284ac9ec80299fcdefae9a2787cf85105a0f203Daniel Dunbar                     const FunctionArgList &Args,
13969c6082fe89c61af697f017aa80937581cc2128d8Tilmann Scheller                     SourceLocation StartLoc);
1397a448fb2da03ece39978784793eea68760e8205a1Daniel Dunbar
13989fc6a7774643a810c8501dae2323e863fefb623eJohn McCall  void EmitConstructorBody(FunctionArgList &Args);
13999fc6a7774643a810c8501dae2323e863fefb623eJohn McCall  void EmitDestructorBody(FunctionArgList &Args);
14009fc6a7774643a810c8501dae2323e863fefb623eJohn McCall  void EmitFunctionBody(FunctionArgList &Args);
1401a355e07454463b19829ac92ffd115a097faff0e0John McCall
140264bee65a3436e3f0c352fcfe2130676f3502cffeEli Friedman  void EmitForwardingCallToLambda(const CXXRecordDecl *Lambda,
140364bee65a3436e3f0c352fcfe2130676f3502cffeEli Friedman                                  CallArgList &CallArgs);
1404bd89f8c2caa9550e41daa1aa9bf30f0f1e0dfaf7Eli Friedman  void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
140564bee65a3436e3f0c352fcfe2130676f3502cffeEli Friedman  void EmitLambdaBlockInvokeBody();
140627dd7d962bbf774988bc5e59d04a7743ed503514Douglas Gregor  void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
140727dd7d962bbf774988bc5e59d04a7743ed503514Douglas Gregor  void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
1408bd89f8c2caa9550e41daa1aa9bf30f0f1e0dfaf7Eli Friedman
14090dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitReturnBlock - Emit the unified return block, trying to avoid its
14100dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// emission when possible.
14111c1d6074f5a0296dd273362655b1b8f9057289e3Daniel Dunbar  void EmitReturnBlock();
14121c1d6074f5a0296dd273362655b1b8f9057289e3Daniel Dunbar
14130dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// FinishFunction - Complete IR generation of the current function. It is
14140dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// legal to call this function even if there is no current insertion point.
1415af05bb9073319d8381b71c4325188853fd4b8ed6Daniel Dunbar  void FinishFunction(SourceLocation EndLoc=SourceLocation());
141617b708d61827cd86278e9580b041dd6cbadf07d3Daniel Dunbar
1417519c32880b99396034ecaedc0cd86db2e8485003Anders Carlsson  /// GenerateThunk - Generate a thunk for the given method.
1418d26bc76c98006609002d9930f8840490e88ac5b5John McCall  void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1419d26bc76c98006609002d9930f8840490e88ac5b5John McCall                     GlobalDecl GD, const ThunkInfo &Thunk);
14209cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
14217dcdf5ba9324a9577461eae302e88fdd52e310c5Eli Friedman  void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
14227dcdf5ba9324a9577461eae302e88fdd52e310c5Eli Friedman                            GlobalDecl GD, const ThunkInfo &Thunk);
14237dcdf5ba9324a9577461eae302e88fdd52e310c5Eli Friedman
1424fb8cc253420e93cee33d29df5a2bdae6aaf16e39Douglas Gregor  void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1425fb8cc253420e93cee33d29df5a2bdae6aaf16e39Douglas Gregor                        FunctionArgList &Args);
14261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1427b74ed087469db042325bad76fdf3ff6ed67dec09Eli Friedman  void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
1428b74ed087469db042325bad76fdf3ff6ed67dec09Eli Friedman                               ArrayRef<VarDecl *> ArrayIndexes);
1429b74ed087469db042325bad76fdf3ff6ed67dec09Eli Friedman
1430d103f9f9b401b419e756f8c1849683cd77586067Anders Carlsson  /// InitializeVTablePointer - Initialize the vtable pointer of the given
1431d103f9f9b401b419e756f8c1849683cd77586067Anders Carlsson  /// subobject.
1432d103f9f9b401b419e756f8c1849683cd77586067Anders Carlsson  ///
14339cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer  void InitializeVTablePointer(BaseSubobject Base,
1434b3b772ea15a4cd54879e244629aa685ead9548bbAnders Carlsson                               const CXXRecordDecl *NearestVBase,
1435d6fb21fa1053e5d616af55b181bb03c50d4b0d24Ken Dyck                               CharUnits OffsetFromNearestVBase,
1436d103f9f9b401b419e756f8c1849683cd77586067Anders Carlsson                               llvm::Constant *VTable,
1437d103f9f9b401b419e756f8c1849683cd77586067Anders Carlsson                               const CXXRecordDecl *VTableClass);
1438d103f9f9b401b419e756f8c1849683cd77586067Anders Carlsson
1439d103f9f9b401b419e756f8c1849683cd77586067Anders Carlsson  typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
14409cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer  void InitializeVTablePointers(BaseSubobject Base,
1441b3b772ea15a4cd54879e244629aa685ead9548bbAnders Carlsson                                const CXXRecordDecl *NearestVBase,
1442d6fb21fa1053e5d616af55b181bb03c50d4b0d24Ken Dyck                                CharUnits OffsetFromNearestVBase,
1443603d6d12cc4cba1ef219a3d55c698c7c87f87adfAnders Carlsson                                bool BaseIsNonVirtualPrimaryBase,
1444603d6d12cc4cba1ef219a3d55c698c7c87f87adfAnders Carlsson                                llvm::Constant *VTable,
1445603d6d12cc4cba1ef219a3d55c698c7c87f87adfAnders Carlsson                                const CXXRecordDecl *VTableClass,
1446603d6d12cc4cba1ef219a3d55c698c7c87f87adfAnders Carlsson                                VisitedVirtualBasesSetTy& VBases);
144777a259c6dbf582949af8a243b472c0c7faa373a6Eli Friedman
1448603d6d12cc4cba1ef219a3d55c698c7c87f87adfAnders Carlsson  void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
1449d103f9f9b401b419e756f8c1849683cd77586067Anders Carlsson
1450043fb9a1fc0609285f60f0f87e5a18195408f34cDan Gohman  /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1451043fb9a1fc0609285f60f0f87e5a18195408f34cDan Gohman  /// to by This.
14522acc6e3feda5e4f7d9009bdcf8b1cd777fecfe2dChris Lattner  llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
1453d103f9f9b401b419e756f8c1849683cd77586067Anders Carlsson
145450da2cadcc6da86abff6772de65280ace2cabc94John McCall  /// EnterDtorCleanups - Enter the cleanups necessary to complete the
145550da2cadcc6da86abff6772de65280ace2cabc94John McCall  /// given phase of destruction for a destructor.  The end result
145650da2cadcc6da86abff6772de65280ace2cabc94John McCall  /// should call destructors on members and base classes in reverse
145750da2cadcc6da86abff6772de65280ace2cabc94John McCall  /// order of their construction.
145850da2cadcc6da86abff6772de65280ace2cabc94John McCall  void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
14591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
14607255a2d997b15beae82e627052fdb1b2474495c2Chris Lattner  /// ShouldInstrumentFunction - Return true if the current function should be
14617255a2d997b15beae82e627052fdb1b2474495c2Chris Lattner  /// instrumented with __cyg_profile_func_* calls
14627255a2d997b15beae82e627052fdb1b2474495c2Chris Lattner  bool ShouldInstrumentFunction();
14637255a2d997b15beae82e627052fdb1b2474495c2Chris Lattner
14647255a2d997b15beae82e627052fdb1b2474495c2Chris Lattner  /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
14657255a2d997b15beae82e627052fdb1b2474495c2Chris Lattner  /// instrumentation function with the current function and the call site, if
14667255a2d997b15beae82e627052fdb1b2474495c2Chris Lattner  /// function instrumentation is enabled.
14677255a2d997b15beae82e627052fdb1b2474495c2Chris Lattner  void EmitFunctionInstrumentation(const char *Fn);
14687255a2d997b15beae82e627052fdb1b2474495c2Chris Lattner
1469be4c8705e499b55548467eb7adaa23cbc6edfef9Roman Divacky  /// EmitMCountInstrumentation - Emit call to .mcount.
1470be4c8705e499b55548467eb7adaa23cbc6edfef9Roman Divacky  void EmitMCountInstrumentation();
1471be4c8705e499b55548467eb7adaa23cbc6edfef9Roman Divacky
14720dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitFunctionProlog - Emit the target specific LLVM code to load the
14730dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// arguments for the given function. This is also responsible for naming the
14740dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// LLVM function arguments.
147588b5396b0897f28d22ae3debf4a0d97b33b6c362Daniel Dunbar  void EmitFunctionProlog(const CGFunctionInfo &FI,
147688b5396b0897f28d22ae3debf4a0d97b33b6c362Daniel Dunbar                          llvm::Function *Fn,
147717b708d61827cd86278e9580b041dd6cbadf07d3Daniel Dunbar                          const FunctionArgList &Args);
147817b708d61827cd86278e9580b041dd6cbadf07d3Daniel Dunbar
14790dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
14800dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// given temporary.
148135b21b884e5c3447a52a74d7ffaba966b07ac81fChris Lattner  void EmitFunctionEpilog(const CGFunctionInfo &FI);
148217b708d61827cd86278e9580b041dd6cbadf07d3Daniel Dunbar
1483cce3d4f9812182ed4e551b7cf0fc86576be8d9c5Mike Stump  /// EmitStartEHSpec - Emit the start of the exception spec.
1484cce3d4f9812182ed4e551b7cf0fc86576be8d9c5Mike Stump  void EmitStartEHSpec(const Decl *D);
1485cce3d4f9812182ed4e551b7cf0fc86576be8d9c5Mike Stump
1486cce3d4f9812182ed4e551b7cf0fc86576be8d9c5Mike Stump  /// EmitEndEHSpec - Emit the end of the exception spec.
1487cce3d4f9812182ed4e551b7cf0fc86576be8d9c5Mike Stump  void EmitEndEHSpec(const Decl *D);
1488cce3d4f9812182ed4e551b7cf0fc86576be8d9c5Mike Stump
1489f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1490f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  llvm::BasicBlock *getTerminateLandingPad();
1491f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
1492f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// getTerminateHandler - Return a handler (not a landing pad, just
1493f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// a catch handler) that just calls terminate.  This is used when
1494f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  /// a terminate scope encloses a try.
14959b39c51ae3c547568ac42325f94b4197618f6b18Mike Stump  llvm::BasicBlock *getTerminateHandler();
14969b39c51ae3c547568ac42325f94b4197618f6b18Mike Stump
14979cbe4f0ba01ec304e1e3d071c071f7bca33631c0Chris Lattner  llvm::Type *ConvertTypeForMem(QualType T);
14989cbe4f0ba01ec304e1e3d071c071f7bca33631c0Chris Lattner  llvm::Type *ConvertType(QualType T);
14999cbe4f0ba01ec304e1e3d071c071f7bca33631c0Chris Lattner  llvm::Type *ConvertType(const TypeDecl *T) {
1500bff225ecf77fb891596ecb1b27196310d268365eJohn McCall    return ConvertType(getContext().getTypeDeclType(T));
1501bff225ecf77fb891596ecb1b27196310d268365eJohn McCall  }
1502c8aa5f1f264fb230c38182adab944232bb160c2bChris Lattner
15030dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// LoadObjCSelf - Load the value of self. This function is only valid while
15040dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// generating code for an Objective-C method.
1505c8aa5f1f264fb230c38182adab944232bb160c2bChris Lattner  llvm::Value *LoadObjCSelf();
15060dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
15070dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// TypeOfSelfObject - Return type of object that this self represents.
150845012a7ef5abf1042c893f3f2fa5c23cb5485ea9Fariborz Jahanian  QualType TypeOfSelfObject();
15094111024be81e7c0525e42dadcc126d27e5bf2425Chris Lattner
15105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// hasAggregateLLVMType - Return true if the specified AST type will map into
15115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// an aggregate LLVM type or is void.
15125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  static bool hasAggregateLLVMType(QualType T);
151355e874299f2ad827646a4ca9ea38c402aaeb38c9Daniel Dunbar
151455e874299f2ad827646a4ca9ea38c402aaeb38c9Daniel Dunbar  /// createBasicBlock - Create an LLVM basic block.
15154def70d3040e73707c738f7c366737a986135edfRichard Smith  llvm::BasicBlock *createBasicBlock(const Twine &name = "",
1516d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall                                     llvm::Function *parent = 0,
1517d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall                                     llvm::BasicBlock *before = 0) {
151829ea6729155c759836be4b5453bee9ef8e1e97eeDaniel Dunbar#ifdef NDEBUG
1519d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall    return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
152029ea6729155c759836be4b5453bee9ef8e1e97eeDaniel Dunbar#else
1521d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall    return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
152229ea6729155c759836be4b5453bee9ef8e1e97eeDaniel Dunbar#endif
152355e874299f2ad827646a4ca9ea38c402aaeb38c9Daniel Dunbar  }
15240dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
15255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
15265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// label maps to.
1527ad8dcf4a9df0e24051dc31bf9e6f3cd138a34298Chris Lattner  JumpDest getJumpDestForLabel(const LabelDecl *S);
15280dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
1529f71d232ce5354bd2f0c94ded30fb936c2a3d968bMike Stump  /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1530f71d232ce5354bd2f0c94ded30fb936c2a3d968bMike Stump  /// another basic block, simplify it. This assumes that no other code could
1531f71d232ce5354bd2f0c94ded30fb936c2a3d968bMike Stump  /// potentially reference the basic block.
1532aa5bd87f1fd5f9ca47924248817c89325759b30eDaniel Dunbar  void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1533aa5bd87f1fd5f9ca47924248817c89325759b30eDaniel Dunbar
15340dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
15350dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// adding a fall-through branch from the current insert block if
15360dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// necessary. It is legal to call this function even if there is no current
15370dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// insertion point.
1538a0c21a8faa79e88ac432d116eca58f7a7217195dDaniel Dunbar  ///
15390dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// IsFinished - If true, indicates that the caller has finished emitting
15400dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// branches to the given block and does not expect to emit code into it. This
15410dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// means the block can be ignored if it is unreachable.
1542a0c21a8faa79e88ac432d116eca58f7a7217195dDaniel Dunbar  void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
1543824e3bd76b2e32db2ec6e4d2d113413e518d1c63Daniel Dunbar
1544777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1545777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  /// near its uses, and leave the insertion point in it.
1546777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall  void EmitBlockAfterUses(llvm::BasicBlock *BB);
1547777d6e56ad9b1fed9866daf3ee6486d85c5b7d32John McCall
15480dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitBranch - Emit a branch to the specified basic block from the current
15490dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// insert block, taking care to avoid creation of branches from dummy
15500dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// blocks. It is legal to call this function even if there is no current
15510dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// insertion point.
15525e08ad3cc62ab94649959ae227a9a411a729bf49Daniel Dunbar  ///
15530dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// This function clears the current insertion point. The caller should follow
15540dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// calls to this function with calls to Emit*Block prior to generation new
15550dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// code.
1556d57a871339c7c98d58d93108b806f59bdf4e13e2Daniel Dunbar  void EmitBranch(llvm::BasicBlock *Block);
1557d57a871339c7c98d58d93108b806f59bdf4e13e2Daniel Dunbar
15580dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// HaveInsertPoint - True if an insertion point is defined. If not, this
15590dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// indicates that the current code being emitted is unreachable.
15600dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  bool HaveInsertPoint() const {
1561a448fb2da03ece39978784793eea68760e8205a1Daniel Dunbar    return Builder.GetInsertBlock() != 0;
1562a448fb2da03ece39978784793eea68760e8205a1Daniel Dunbar  }
1563a448fb2da03ece39978784793eea68760e8205a1Daniel Dunbar
15640dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EnsureInsertPoint - Ensure that an insertion point is defined so that
15650dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// emitted IR has a place to go. Note that by definition, if this function
15660dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// creates a block then that block is unreachable; callers may do better to
15670dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// detect when no insertion point is defined and simply skip IR generation.
1568a448fb2da03ece39978784793eea68760e8205a1Daniel Dunbar  void EnsureInsertPoint() {
1569a448fb2da03ece39978784793eea68760e8205a1Daniel Dunbar    if (!HaveInsertPoint())
1570a448fb2da03ece39978784793eea68760e8205a1Daniel Dunbar      EmitBlock(createBasicBlock());
1571a448fb2da03ece39978784793eea68760e8205a1Daniel Dunbar  }
15720dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
1573488e993a135ce700b982bf099c3d6b856301d642Daniel Dunbar  /// ErrorUnsupported - Print out an error that codegen doesn't support the
1574dc5e8268292046114ffe02e48773572a91a310f1Chris Lattner  /// specified stmt yet.
157590df4b6661968a84bf64baee489bb2f6d948fcc1Daniel Dunbar  void ErrorUnsupported(const Stmt *S, const char *Type,
157690df4b6661968a84bf64baee489bb2f6d948fcc1Daniel Dunbar                        bool OmitOnError=false);
15775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
15785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //===--------------------------------------------------------------------===//
15795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //                                  Helpers
15805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //===--------------------------------------------------------------------===//
15810dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
15826da2c716017d5c8530ec99779524491ebc5dadb8Eli Friedman  LValue MakeAddrLValue(llvm::Value *V, QualType T,
15836da2c716017d5c8530ec99779524491ebc5dadb8Eli Friedman                        CharUnits Alignment = CharUnits()) {
15843d5aff5d3036b0ff09d114857cd2276134b3d8c9Dan Gohman    return LValue::MakeAddr(V, T, Alignment, getContext(),
15853d5aff5d3036b0ff09d114857cd2276134b3d8c9Dan Gohman                            CGM.getTBAAInfo(T));
15862f77b3d57031ded0de2b7b977fb63b4660f82624Eli Friedman  }
1587e0c1168ec7910a1a7ed08df4d4f0c58c2fa2ecd1John McCall
15882f77b3d57031ded0de2b7b977fb63b4660f82624Eli Friedman  LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
15896da2c716017d5c8530ec99779524491ebc5dadb8Eli Friedman    CharUnits Alignment;
15906da2c716017d5c8530ec99779524491ebc5dadb8Eli Friedman    if (!T->isIncompleteType())
15916da2c716017d5c8530ec99779524491ebc5dadb8Eli Friedman      Alignment = getContext().getTypeAlignInChars(T);
15922f77b3d57031ded0de2b7b977fb63b4660f82624Eli Friedman    return LValue::MakeAddr(V, T, Alignment, getContext(),
15932f77b3d57031ded0de2b7b977fb63b4660f82624Eli Friedman                            CGM.getTBAAInfo(T));
15945cf8bfec711116b3c4acc70a00717b2e119e7550Daniel Dunbar  }
15955cf8bfec711116b3c4acc70a00717b2e119e7550Daniel Dunbar
15965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// CreateTempAlloca - This creates a alloca and inserts it into the entry
1597195337d2e5d4625ae9dc1328c7cdbc7115b0261bDaniel Dunbar  /// block. The caller is responsible for setting an appropriate alignment on
1598195337d2e5d4625ae9dc1328c7cdbc7115b0261bDaniel Dunbar  /// the alloca.
15992acc6e3feda5e4f7d9009bdcf8b1cd777fecfe2dChris Lattner  llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
16008cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner                                     const Twine &Name = "tmp");
16010dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
1602ac418162692a951ca3796d6830496a85a2d12493John McCall  /// InitTempAlloca - Provide an initial value for the given alloca.
1603ac418162692a951ca3796d6830496a85a2d12493John McCall  void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1604ac418162692a951ca3796d6830496a85a2d12493John McCall
16059bd4da2cfa8b956b851200db8f9a37e175edbb15Daniel Dunbar  /// CreateIRTemp - Create a temporary IR object of the given type, with
16069bd4da2cfa8b956b851200db8f9a37e175edbb15Daniel Dunbar  /// appropriate alignment. This routine should only be used when an temporary
16079bd4da2cfa8b956b851200db8f9a37e175edbb15Daniel Dunbar  /// value needs to be stored into an alloca (for example, to avoid explicit
16089bd4da2cfa8b956b851200db8f9a37e175edbb15Daniel Dunbar  /// PHI construction), but the type is the IR type, not the type appropriate
16099bd4da2cfa8b956b851200db8f9a37e175edbb15Daniel Dunbar  /// for storing in memory.
16108cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner  llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
16119bd4da2cfa8b956b851200db8f9a37e175edbb15Daniel Dunbar
1612195337d2e5d4625ae9dc1328c7cdbc7115b0261bDaniel Dunbar  /// CreateMemTemp - Create a temporary memory object of the given type, with
1613195337d2e5d4625ae9dc1328c7cdbc7115b0261bDaniel Dunbar  /// appropriate alignment.
16148cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner  llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
1615195337d2e5d4625ae9dc1328c7cdbc7115b0261bDaniel Dunbar
1616558d2abc7f9fd6801cc7677200992313ae90b5d8John McCall  /// CreateAggTemp - Create a temporary memory object for the given
1617558d2abc7f9fd6801cc7677200992313ae90b5d8John McCall  /// aggregate type.
16188cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner  AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
1619d7722d9d76a851e7897f4127626616d3b1b8e530Eli Friedman    CharUnits Alignment = getContext().getTypeAlignInChars(T);
1620f394078fde147dcf27e9b6a7965517388d64dcb6Eli Friedman    return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1621f394078fde147dcf27e9b6a7965517388d64dcb6Eli Friedman                                 T.getQualifiers(),
16227c2349be2d11143a2e59a167fd43362a3bf4585eJohn McCall                                 AggValueSlot::IsNotDestructed,
1623410ffb2bc5f072d58a73c14560345bcf77dec1ccJohn McCall                                 AggValueSlot::DoesNotNeedGCBarriers,
1624649b4a1a9b5e6f768ca0cb84bd97b00f51083e15Chad Rosier                                 AggValueSlot::IsNotAliased);
1625558d2abc7f9fd6801cc7677200992313ae90b5d8John McCall  }
1626558d2abc7f9fd6801cc7677200992313ae90b5d8John McCall
1627d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall  /// Emit a cast to void* in the appropriate address space.
1628d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall  llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1629d16c2cf1cafa413709aa487cbbd5dc392f1ba1ffJohn McCall
16305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
16315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// expression and compare the result against zero, returning an Int1Ty value.
16325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  llvm::Value *EvaluateExprAsBool(const Expr *E);
16335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
16342a41637a995affa1563f4d82a8b026e326a2faa0John McCall  /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
16352a41637a995affa1563f4d82a8b026e326a2faa0John McCall  void EmitIgnoredExpr(const Expr *E);
16362a41637a995affa1563f4d82a8b026e326a2faa0John McCall
16379b65551d0b387a7597fb39356a4d8ef10046445eChris Lattner  /// EmitAnyExpr - Emit code to compute the specified expression which can have
16389b65551d0b387a7597fb39356a4d8ef10046445eChris Lattner  /// any type.  The result is returned as an RValue struct.  If this is an
16399b65551d0b387a7597fb39356a4d8ef10046445eChris Lattner  /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
16409b65551d0b387a7597fb39356a4d8ef10046445eChris Lattner  /// the result should be returned.
164149d1cd5a09ed3df353371fd7f206674a85e0fb45Mike Stump  ///
164270517ca5c07c4b41ff8662b94ee22047b0299f8cDmitri Gribenko  /// \param ignoreResult True if the resulting value isn't used.
1643558d2abc7f9fd6801cc7677200992313ae90b5d8John McCall  RValue EmitAnyExpr(const Expr *E,
1644e0c1168ec7910a1a7ed08df4d4f0c58c2fa2ecd1John McCall                     AggValueSlot aggSlot = AggValueSlot::ignored(),
1645e0c1168ec7910a1a7ed08df4d4f0c58c2fa2ecd1John McCall                     bool ignoreResult = false);
1646d9363c3a80168283b3da518b4e17f545a6246857Devang Patel
16470dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
16480dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  // or the value of the expression, depending on how va_list is defined.
16494fd0aa5803357d8c72eeac2cae15e12649ea08feEli Friedman  llvm::Value *EmitVAListRef(const Expr *E);
16504fd0aa5803357d8c72eeac2cae15e12649ea08feEli Friedman
16510dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
16520dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// always be accessible even if no aggregate location is provided.
1653558d2abc7f9fd6801cc7677200992313ae90b5d8John McCall  RValue EmitAnyExprToTemp(const Expr *E);
165446f45b9bec4a265ad8400a538e5ec3a5683617f1Daniel Dunbar
165560d3365b46eb826fba44483583c0051ac5c41fe3John McCall  /// EmitAnyExprToMem - Emits the code necessary to evaluate an
1656649b4a1a9b5e6f768ca0cb84bd97b00f51083e15Chad Rosier  /// arbitrary expression into the given memory location.
16573d3ec1c099ec8bfac3aa1fb0126fe515b7c7fa05John McCall  void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
1658649b4a1a9b5e6f768ca0cb84bd97b00f51083e15Chad Rosier                        Qualifiers Quals, bool IsInitializer);
16593d3ec1c099ec8bfac3aa1fb0126fe515b7c7fa05John McCall
166060d3365b46eb826fba44483583c0051ac5c41fe3John McCall  /// EmitExprAsInit - Emits the code necessary to initialize a
166160d3365b46eb826fba44483583c0051ac5c41fe3John McCall  /// location in memory with the given initializer.
1662f85e193739c953358c865005855253af4f68a497John McCall  void EmitExprAsInit(const Expr *init, const ValueDecl *D,
1663a07398ed98ea2b55ad7a505a3aab18aed93b149fJohn McCall                      LValue lvalue, bool capturedByInit);
166460d3365b46eb826fba44483583c0051ac5c41fe3John McCall
16656cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer  /// EmitAggregateCopy - Emit an aggrate assignment.
16666cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer  ///
16676cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer  /// The difference to EmitAggregateCopy is that tail padding is not copied.
16686cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer  /// This is required for correctness when assigning non-POD structures in C++.
16696cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer  void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
16706cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer                           QualType EltTy, bool isVolatile=false,
16716cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer                           CharUnits Alignment = CharUnits::Zero()) {
16726cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer    EmitAggregateCopy(DestPtr, SrcPtr, EltTy, isVolatile, Alignment, true);
16736cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer  }
16746cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer
167527fe2e6c97a3782a0639d87b460741e8ba5d076dMike Stump  /// EmitAggregateCopy - Emit an aggrate copy.
167627fe2e6c97a3782a0639d87b460741e8ba5d076dMike Stump  ///
1677f3477c13eeaf11b32a41f181398fb5deffd0dd73Sylvestre Ledru  /// \param isVolatile - True iff either the source or the destination is
167827fe2e6c97a3782a0639d87b460741e8ba5d076dMike Stump  /// volatile.
16796cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer  /// \param isAssignment - If false, allow padding to be copied.  This often
16806cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer  /// yields more efficient.
16817482d12c345c6391f8956850545e2d4aa7701ce6Daniel Dunbar  void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
1682bd7d82878c1588afccbee6c68fa6e17bbbab7f2cEli Friedman                         QualType EltTy, bool isVolatile=false,
16836cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer                         CharUnits Alignment = CharUnits::Zero(),
16846cacae8bf9597b8124cd40aedc189c04484e1990Benjamin Kramer                         bool isAssignment = false);
16857482d12c345c6391f8956850545e2d4aa7701ce6Daniel Dunbar
168651b09f2c528c8460b5465c676173324e44176d62Devang Patel  /// StartBlock - Start new block named N. If insert block is a dummy block
168751b09f2c528c8460b5465c676173324e44176d62Devang Patel  /// then reuse it.
168851b09f2c528c8460b5465c676173324e44176d62Devang Patel  void StartBlock(const char *N);
168951b09f2c528c8460b5465c676173324e44176d62Devang Patel
1690813733577d33ec56479667b49e1bff42dc6bba90Lauro Ramos Venancio  /// GetAddrOfStaticLocalVar - Return the address of a static local variable.
16914c40d98ab7acf5f27fa89b17bd8fc0ef7683df37John McCall  llvm::Constant *GetAddrOfStaticLocalVar(const VarDecl *BVD) {
16924c40d98ab7acf5f27fa89b17bd8fc0ef7683df37John McCall    return cast<llvm::Constant>(GetAddrOfLocalVar(BVD));
16934c40d98ab7acf5f27fa89b17bd8fc0ef7683df37John McCall  }
16944f8d123e3e2c260de3377208106ddba87cee28b4Dan Gohman
1695dde0a94120915fa925d1ffcdb997c7b44dc9fa21Anders Carlsson  /// GetAddrOfLocalVar - Return the address of a local variable.
16964c40d98ab7acf5f27fa89b17bd8fc0ef7683df37John McCall  llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
16974c40d98ab7acf5f27fa89b17bd8fc0ef7683df37John McCall    llvm::Value *Res = LocalDeclMap[VD];
16984c40d98ab7acf5f27fa89b17bd8fc0ef7683df37John McCall    assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
16994c40d98ab7acf5f27fa89b17bd8fc0ef7683df37John McCall    return Res;
17004c40d98ab7acf5f27fa89b17bd8fc0ef7683df37John McCall  }
17010dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
170256ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// getOpaqueLValueMapping - Given an opaque value expression (which
170356ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// must be mapped to an l-value), return its mapping.
170456ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
170556ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    assert(OpaqueValueMapping::shouldBindAsLValue(e));
170656ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall
170756ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
170856ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall      it = OpaqueLValues.find(e);
170956ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
171056ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    return it->second;
171156ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  }
171256ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall
171356ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// getOpaqueRValueMapping - Given an opaque value expression (which
171456ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// must be mapped to an r-value), return its mapping.
171556ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
171656ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    assert(!OpaqueValueMapping::shouldBindAsLValue(e));
171756ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall
171856ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
171956ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall      it = OpaqueRValues.find(e);
172056ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall    assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
1721e996ffd240f20a1048179d7727a6ee3227261921John McCall    return it->second;
1722e996ffd240f20a1048179d7727a6ee3227261921John McCall  }
1723e996ffd240f20a1048179d7727a6ee3227261921John McCall
17244f8d123e3e2c260de3377208106ddba87cee28b4Dan Gohman  /// getAccessedFieldNo - Given an encoded value and a result number, return
17254f8d123e3e2c260de3377208106ddba87cee28b4Dan Gohman  /// the input field number being accessed.
17264f8d123e3e2c260de3377208106ddba87cee28b4Dan Gohman  static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
17274f8d123e3e2c260de3377208106ddba87cee28b4Dan Gohman
1728ad8dcf4a9df0e24051dc31bf9e6f3cd138a34298Chris Lattner  llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
17293d00fdc82fd550ae4bfbb2e700a1fc85bbd6d6fdChris Lattner  llvm::BasicBlock *GetIndirectGotoBlock();
17300ffb125996336fc7602b162c0a9e392f1a93060fDaniel Dunbar
17311884eb0b5c55edda4893ddec45e7dbad79758782Anders Carlsson  /// EmitNullInitialization - Generate code to set a value of the given type to
17321884eb0b5c55edda4893ddec45e7dbad79758782Anders Carlsson  /// null, If the type contains data member pointers, they will be initialized
17331884eb0b5c55edda4893ddec45e7dbad79758782Anders Carlsson  /// to -1 in accordance with the Itanium C++ ABI.
17341884eb0b5c55edda4893ddec45e7dbad79758782Anders Carlsson  void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
1735ddf7cac45d85b73127adbbd91a2b28fc7291c57eAnders Carlsson
1736ddf7cac45d85b73127adbbd91a2b28fc7291c57eAnders Carlsson  // EmitVAArg - Generate code to get an argument from the passed in pointer
1737ddf7cac45d85b73127adbbd91a2b28fc7291c57eAnders Carlsson  // and update it accordingly. The return value is a pointer to the argument.
1738ddf7cac45d85b73127adbbd91a2b28fc7291c57eAnders Carlsson  // FIXME: We should be able to get rid of this method and use the va_arg
17390dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  // instruction in LLVM instead once it works well enough.
1740ddf7cac45d85b73127adbbd91a2b28fc7291c57eAnders Carlsson  llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
1741f666b7780d04186521adcaedb0e15dfa4d5e6933Anders Carlsson
1742bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  /// emitArrayLength - Compute the length of an array, even if it's a
1743bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  /// VLA, and drill down to the base element type.
1744bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  llvm::Value *emitArrayLength(const ArrayType *arrayType,
1745bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall                               QualType &baseType,
1746bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall                               llvm::Value *&addr);
1747bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall
1748bc8d40d85f3fa1e34569834916f18fecaa635152John McCall  /// EmitVLASize - Capture all the sizes for the VLA expressions in
1749bc8d40d85f3fa1e34569834916f18fecaa635152John McCall  /// the given variably-modified type and store them in the VLASizeMap.
1750d286f05f1234bac289173f0eed88d7ecbaea0099Daniel Dunbar  ///
1751d286f05f1234bac289173f0eed88d7ecbaea0099Daniel Dunbar  /// This function can be called with a null (unreachable) insert point.
1752bc8d40d85f3fa1e34569834916f18fecaa635152John McCall  void EmitVariablyModifiedType(QualType Ty);
1753bc8d40d85f3fa1e34569834916f18fecaa635152John McCall
1754bc8d40d85f3fa1e34569834916f18fecaa635152John McCall  /// getVLASize - Returns an LLVM value that corresponds to the size,
1755bc8d40d85f3fa1e34569834916f18fecaa635152John McCall  /// in non-variably-sized elements, of a variable length array type,
1756bc8d40d85f3fa1e34569834916f18fecaa635152John McCall  /// plus that largest non-variably-sized element type.  Assumes that
1757bc8d40d85f3fa1e34569834916f18fecaa635152John McCall  /// the type has already been emitted with EmitVariablyModifiedType.
1758bc8d40d85f3fa1e34569834916f18fecaa635152John McCall  std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1759bc8d40d85f3fa1e34569834916f18fecaa635152John McCall  std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
1760dcc90d87e6430c643b4311ae5b0089535bca41f7Anders Carlsson
17615f4307b7ba164b03c853c8d3eb4674d33f8967a6Anders Carlsson  /// LoadCXXThis - Load the value of 'this'. This function is only valid while
17625f4307b7ba164b03c853c8d3eb4674d33f8967a6Anders Carlsson  /// generating code for an C++ member function.
17632504941793b549323f9d29c62507cf21d865fadeJohn McCall  llvm::Value *LoadCXXThis() {
17642504941793b549323f9d29c62507cf21d865fadeJohn McCall    assert(CXXThisValue && "no 'this' value for this function");
17652504941793b549323f9d29c62507cf21d865fadeJohn McCall    return CXXThisValue;
17662504941793b549323f9d29c62507cf21d865fadeJohn McCall  }
17671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1768c997d4278d329e18891aac9698fb991b2d4622ebAnders Carlsson  /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1769c997d4278d329e18891aac9698fb991b2d4622ebAnders Carlsson  /// virtual bases.
17702504941793b549323f9d29c62507cf21d865fadeJohn McCall  llvm::Value *LoadCXXVTT() {
17712504941793b549323f9d29c62507cf21d865fadeJohn McCall    assert(CXXVTTValue && "no VTT value for this function");
17722504941793b549323f9d29c62507cf21d865fadeJohn McCall    return CXXVTTValue;
17732504941793b549323f9d29c62507cf21d865fadeJohn McCall  }
1774bff225ecf77fb891596ecb1b27196310d268365eJohn McCall
1775bff225ecf77fb891596ecb1b27196310d268365eJohn McCall  /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
17768561a8666c70f924c8f0209c41b9b77bbbf90607Anders Carlsson  /// complete class to the given direct base.
17778561a8666c70f924c8f0209c41b9b77bbbf90607Anders Carlsson  llvm::Value *
17788561a8666c70f924c8f0209c41b9b77bbbf90607Anders Carlsson  GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
17798561a8666c70f924c8f0209c41b9b77bbbf90607Anders Carlsson                                        const CXXRecordDecl *Derived,
17808561a8666c70f924c8f0209c41b9b77bbbf90607Anders Carlsson                                        const CXXRecordDecl *Base,
17818561a8666c70f924c8f0209c41b9b77bbbf90607Anders Carlsson                                        bool BaseIsVirtual);
1782a88ad5618fcb07c5374c79d6781a33234984b039Anders Carlsson
1783f71d232ce5354bd2f0c94ded30fb936c2a3d968bMike Stump  /// GetAddressOfBaseClass - This function will add the necessary delta to the
1784f71d232ce5354bd2f0c94ded30fb936c2a3d968bMike Stump  /// load of 'this' and returns address of the base class.
17859cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer  llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
17868561a8666c70f924c8f0209c41b9b77bbbf90607Anders Carlsson                                     const CXXRecordDecl *Derived,
1787f871d0cc377a1367b519a6cce26be74607566ebaJohn McCall                                     CastExpr::path_const_iterator PathBegin,
1788f871d0cc377a1367b519a6cce26be74607566ebaJohn McCall                                     CastExpr::path_const_iterator PathEnd,
178934a2d384c745ebc39cae45dc1c0c4a6a7012e09bAnders Carlsson                                     bool NullCheckValue);
179034a2d384c745ebc39cae45dc1c0c4a6a7012e09bAnders Carlsson
1791a3697c9c155bda93fd2802f37084b620f4738822Anders Carlsson  llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
17928561a8666c70f924c8f0209c41b9b77bbbf90607Anders Carlsson                                        const CXXRecordDecl *Derived,
1793f871d0cc377a1367b519a6cce26be74607566ebaJohn McCall                                        CastExpr::path_const_iterator PathBegin,
1794f871d0cc377a1367b519a6cce26be74607566ebaJohn McCall                                        CastExpr::path_const_iterator PathEnd,
17955a0f49ebc83e7fe0da07b9964c44b0a7fae270cbAnders Carlsson                                        bool NullCheckValue);
1796a3697c9c155bda93fd2802f37084b620f4738822Anders Carlsson
1797bb7e17b52ffaa4097b4c4d7935746d23539ffe2aAnders Carlsson  llvm::Value *GetVirtualBaseClassOffset(llvm::Value *This,
1798bb7e17b52ffaa4097b4c4d7935746d23539ffe2aAnders Carlsson                                         const CXXRecordDecl *ClassDecl,
1799bb7e17b52ffaa4097b4c4d7935746d23539ffe2aAnders Carlsson                                         const CXXRecordDecl *BaseClassDecl);
18009cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
1801c0bf462cf35fe050bddbd8bff967298e4a67e79dJohn McCall  void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1802c0bf462cf35fe050bddbd8bff967298e4a67e79dJohn McCall                                      CXXCtorType CtorType,
1803c0bf462cf35fe050bddbd8bff967298e4a67e79dJohn McCall                                      const FunctionArgList &Args);
1804059ce0d92eb5a7da900ae735dc0a2ea3d64f4b0bSean Hunt  // It's important not to confuse this and the previous function. Delegating
1805059ce0d92eb5a7da900ae735dc0a2ea3d64f4b0bSean Hunt  // constructors are the C++0x feature. The constructor delegate optimization
1806059ce0d92eb5a7da900ae735dc0a2ea3d64f4b0bSean Hunt  // is used to reduce duplication in the base and complete consturctors where
1807059ce0d92eb5a7da900ae735dc0a2ea3d64f4b0bSean Hunt  // they are substantially the same.
1808059ce0d92eb5a7da900ae735dc0a2ea3d64f4b0bSean Hunt  void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1809059ce0d92eb5a7da900ae735dc0a2ea3d64f4b0bSean Hunt                                        const FunctionArgList &Args);
1810155ed4a23366f4514befb1c9f5f89d16f8b8b6dbAnders Carlsson  void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
1811155ed4a23366f4514befb1c9f5f89d16f8b8b6dbAnders Carlsson                              bool ForVirtualBase, llvm::Value *This,
1812b14095aa98c6fedd3625920c4ce834bcaf24d9f7Anders Carlsson                              CallExpr::const_arg_iterator ArgBeg,
1813b14095aa98c6fedd3625920c4ce834bcaf24d9f7Anders Carlsson                              CallExpr::const_arg_iterator ArgEnd);
181434999876e215b22febc240b1a6dc054215d12f9cFariborz Jahanian
181534999876e215b22febc240b1a6dc054215d12f9cFariborz Jahanian  void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
181634999876e215b22febc240b1a6dc054215d12f9cFariborz Jahanian                              llvm::Value *This, llvm::Value *Src,
181734999876e215b22febc240b1a6dc054215d12f9cFariborz Jahanian                              CallExpr::const_arg_iterator ArgBeg,
181834999876e215b22febc240b1a6dc054215d12f9cFariborz Jahanian                              CallExpr::const_arg_iterator ArgEnd);
18191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1820288dcaf329c49b01dacd5c1dd9f35609555feecdFariborz Jahanian  void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1821569c1f4a6c703eaa8b963bed7d5c2fd5d4569e93Anders Carlsson                                  const ConstantArrayType *ArrayTy,
18225d4d946ec2d88696fd8422aeb64dc29688e6a2c1Anders Carlsson                                  llvm::Value *ArrayPtr,
18235d4d946ec2d88696fd8422aeb64dc29688e6a2c1Anders Carlsson                                  CallExpr::const_arg_iterator ArgBeg,
182459174c0633fb5cde41735cfbff5744bdf837e8d9Douglas Gregor                                  CallExpr::const_arg_iterator ArgEnd,
182559174c0633fb5cde41735cfbff5744bdf837e8d9Douglas Gregor                                  bool ZeroInitialization = false);
18269cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
1827569c1f4a6c703eaa8b963bed7d5c2fd5d4569e93Anders Carlsson  void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1828569c1f4a6c703eaa8b963bed7d5c2fd5d4569e93Anders Carlsson                                  llvm::Value *NumElements,
18295d4d946ec2d88696fd8422aeb64dc29688e6a2c1Anders Carlsson                                  llvm::Value *ArrayPtr,
18305d4d946ec2d88696fd8422aeb64dc29688e6a2c1Anders Carlsson                                  CallExpr::const_arg_iterator ArgBeg,
183159174c0633fb5cde41735cfbff5744bdf837e8d9Douglas Gregor                                  CallExpr::const_arg_iterator ArgEnd,
183259174c0633fb5cde41735cfbff5744bdf837e8d9Douglas Gregor                                  bool ZeroInitialization = false);
1833b14095aa98c6fedd3625920c4ce834bcaf24d9f7Anders Carlsson
1834bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  static Destroyer destroyCXXObject;
1835bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall
18367267c1693abe7875b0c57268be05005ae013c6c9Anders Carlsson  void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
18378e6404ca28d6bbb76e97ea2a53a74816c2a74665Anders Carlsson                             bool ForVirtualBase, llvm::Value *This);
18389cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
1839197056726ed6412501130c2ef2ff69009772aa65John McCall  void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
1840197056726ed6412501130c2ef2ff69009772aa65John McCall                               llvm::Value *NewPtr, llvm::Value *NumElements);
18411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
184286811609d9353e3aed198045d56e790eb3b6118cPeter Collingbourne  void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
184386811609d9353e3aed198045d56e790eb3b6118cPeter Collingbourne                        llvm::Value *Ptr);
18441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1845a00703dccbdc6cc4a293db38477dea7db5538c7eAnders Carlsson  llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
184660e282cc1e508be327b0481cecedc206873cb86aAnders Carlsson  void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
18471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
18484bf8152799ec41796f989ea1b94f6f1bac349117Eli Friedman  void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
18494bf8152799ec41796f989ea1b94f6f1bac349117Eli Friedman                      QualType DeleteTy);
18504bf8152799ec41796f989ea1b94f6f1bac349117Eli Friedman
1851c2e84ae9a6d25cea3e583c768e576b4c981ec028Mike Stump  llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
1852c849c052d6b4b70f2651c1969531861a5f230053Mike Stump  llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
1853c5f804636e367ef744fd24cf88f7c956a5af0434Nico Weber  llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
1854c2e84ae9a6d25cea3e583c768e576b4c981ec028Mike Stump
1855972edf0534d8a50f87fac1d0ff34eb22f593df11Sebastian Redl  void MaybeEmitStdInitializerListCleanup(llvm::Value *loc, const Expr *init);
1856af130fd78267ee9e2395b758a7d827b07ce317a0Sebastian Redl  void EmitStdInitializerListCleanup(llvm::Value *loc,
1857af130fd78267ee9e2395b758a7d827b07ce317a0Sebastian Redl                                     const InitListExpr *init);
185832cf1f27ae8620e7b79bb4e81a067187c0aab7aeSebastian Redl
18592c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith  /// \brief Situations in which we might emit a check for the suitability of a
18602c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith  ///        pointer or glvalue.
18617ac9ef1c82c779a5348ed11b3d10e01c58803b35Richard Smith  enum TypeCheckKind {
18622c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith    /// Checking the operand of a load. Must be suitably sized and aligned.
18637ac9ef1c82c779a5348ed11b3d10e01c58803b35Richard Smith    TCK_Load,
18642c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith    /// Checking the destination of a store. Must be suitably sized and aligned.
18657ac9ef1c82c779a5348ed11b3d10e01c58803b35Richard Smith    TCK_Store,
18662c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith    /// Checking the bound value in a reference binding. Must be suitably sized
18672c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith    /// and aligned, but is not required to refer to an object (until the
18682c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith    /// reference is used), per core issue 453.
18697ac9ef1c82c779a5348ed11b3d10e01c58803b35Richard Smith    TCK_ReferenceBinding,
18702c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith    /// Checking the object expression in a non-static data member access. Must
18712c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith    /// be an object within its lifetime.
18727ac9ef1c82c779a5348ed11b3d10e01c58803b35Richard Smith    TCK_MemberAccess,
18732c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith    /// Checking the 'this' pointer for a call to a non-static member function.
18742c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith    /// Must be an object within its lifetime.
18758e1cee6f23e2552b96b81e5ef419ab3f69c5b5c2Richard Smith    TCK_MemberCall,
18768e1cee6f23e2552b96b81e5ef419ab3f69c5b5c2Richard Smith    /// Checking the 'this' pointer for a constructor call.
18778e1cee6f23e2552b96b81e5ef419ab3f69c5b5c2Richard Smith    TCK_ConstructorCall
18782c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith  };
18792c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith
18807ac9ef1c82c779a5348ed11b3d10e01c58803b35Richard Smith  /// \brief Emit a check that \p V is the address of storage of the
18812c9f87ca5cccbfdaad82762368af5b2323320653Richard Smith  /// appropriate size and alignment for an object of type \p Type.
18824def70d3040e73707c738f7c366737a986135edfRichard Smith  void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
18837ac9ef1c82c779a5348ed11b3d10e01c58803b35Richard Smith                     QualType Type, CharUnits Alignment = CharUnits::Zero());
1884b14e62d5aee7522b98c410ee65bd750c2cfe6f01Mike Stump
1885dd36d328730d8c02915d0884541b45ec6ca0049dChris Lattner  llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1886dd36d328730d8c02915d0884541b45ec6ca0049dChris Lattner                                       bool isInc, bool isPre);
1887dd36d328730d8c02915d0884541b45ec6ca0049dChris Lattner  ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1888dd36d328730d8c02915d0884541b45ec6ca0049dChris Lattner                                         bool isInc, bool isPre);
18895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //===--------------------------------------------------------------------===//
18905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //                            Declaration Emission
18915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //===--------------------------------------------------------------------===//
18920dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
1893d286f05f1234bac289173f0eed88d7ecbaea0099Daniel Dunbar  /// EmitDecl - Emit a declaration.
1894d286f05f1234bac289173f0eed88d7ecbaea0099Daniel Dunbar  ///
1895d286f05f1234bac289173f0eed88d7ecbaea0099Daniel Dunbar  /// This function can be called with a null (unreachable) insert point.
18965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void EmitDecl(const Decl &D);
1897d286f05f1234bac289173f0eed88d7ecbaea0099Daniel Dunbar
1898b6bbcc9995186799a60ce17d0c1acff31601653aJohn McCall  /// EmitVarDecl - Emit a local variable declaration.
1899d286f05f1234bac289173f0eed88d7ecbaea0099Daniel Dunbar  ///
1900d286f05f1234bac289173f0eed88d7ecbaea0099Daniel Dunbar  /// This function can be called with a null (unreachable) insert point.
1901b6bbcc9995186799a60ce17d0c1acff31601653aJohn McCall  void EmitVarDecl(const VarDecl &D);
1902d286f05f1234bac289173f0eed88d7ecbaea0099Daniel Dunbar
1903f85e193739c953358c865005855253af4f68a497John McCall  void EmitScalarInit(const Expr *init, const ValueDecl *D,
1904a07398ed98ea2b55ad7a505a3aab18aed93b149fJohn McCall                      LValue lvalue, bool capturedByInit);
19057acddacc921cd0b3f813443a8641eeddb82dfbd4John McCall  void EmitScalarInit(llvm::Value *init, LValue lvalue);
1906f85e193739c953358c865005855253af4f68a497John McCall
1907f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1908f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall                             llvm::Value *Address);
1909f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
1910b6bbcc9995186799a60ce17d0c1acff31601653aJohn McCall  /// EmitAutoVarDecl - Emit an auto variable declaration.
1911d286f05f1234bac289173f0eed88d7ecbaea0099Daniel Dunbar  ///
1912d286f05f1234bac289173f0eed88d7ecbaea0099Daniel Dunbar  /// This function can be called with a null (unreachable) insert point.
191334695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall  void EmitAutoVarDecl(const VarDecl &D);
191434695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall
191534695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall  class AutoVarEmission {
191634695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    friend class CodeGenFunction;
191734695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall
191857b3b6a60856eaec30fd876a8a3face8f7e3ad7bJohn McCall    const VarDecl *Variable;
191934695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall
192034695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    /// The alignment of the variable.
192134695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    CharUnits Alignment;
192234695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall
192334695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    /// The address of the alloca.  Null if the variable was emitted
192434695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    /// as a global constant.
192534695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    llvm::Value *Address;
192634695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall
192734695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    llvm::Value *NRVOFlag;
192834695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall
192934695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    /// True if the variable is a __block variable.
193034695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    bool IsByRef;
193134695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall
193234695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    /// True if the variable is of aggregate type and has a constant
193334695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    /// initializer.
193434695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    bool IsConstantAggregate;
193534695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall
193657b3b6a60856eaec30fd876a8a3face8f7e3ad7bJohn McCall    struct Invalid {};
193757b3b6a60856eaec30fd876a8a3face8f7e3ad7bJohn McCall    AutoVarEmission(Invalid) : Variable(0) {}
193857b3b6a60856eaec30fd876a8a3face8f7e3ad7bJohn McCall
193934695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    AutoVarEmission(const VarDecl &variable)
194057b3b6a60856eaec30fd876a8a3face8f7e3ad7bJohn McCall      : Variable(&variable), Address(0), NRVOFlag(0),
194134695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall        IsByRef(false), IsConstantAggregate(false) {}
194234695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall
194334695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    bool wasEmittedAsGlobal() const { return Address == 0; }
194434695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall
194534695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall  public:
194657b3b6a60856eaec30fd876a8a3face8f7e3ad7bJohn McCall    static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
194757b3b6a60856eaec30fd876a8a3face8f7e3ad7bJohn McCall
194834695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    /// Returns the address of the object within this declaration.
194934695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    /// Note that this does not chase the forwarding pointer for
195034695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    /// __block decls.
195134695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
195234695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall      if (!IsByRef) return Address;
195334695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall
195434695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall      return CGF.Builder.CreateStructGEP(Address,
195557b3b6a60856eaec30fd876a8a3face8f7e3ad7bJohn McCall                                         CGF.getByRefValueLLVMField(Variable),
195657b3b6a60856eaec30fd876a8a3face8f7e3ad7bJohn McCall                                         Variable->getNameAsString());
195734695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall    }
195834695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall  };
195934695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall  AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
196034695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall  void EmitAutoVarInit(const AutoVarEmission &emission);
196134695856c0e67b3765b46304cc71b5d2cd5b71c7John McCall  void EmitAutoVarCleanups(const AutoVarEmission &emission);
1962bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1963bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall                              QualType::DestructionKind dtorKind);
1964d286f05f1234bac289173f0eed88d7ecbaea0099Daniel Dunbar
1965b6bbcc9995186799a60ce17d0c1acff31601653aJohn McCall  void EmitStaticVarDecl(const VarDecl &D,
1966b6bbcc9995186799a60ce17d0c1acff31601653aJohn McCall                         llvm::GlobalValue::LinkageTypes Linkage);
1967b7ec246872b412f0e7bb9e93eacfd78cfa6adfb3Daniel Dunbar
1968b7ec246872b412f0e7bb9e93eacfd78cfa6adfb3Daniel Dunbar  /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
1969093ac461b37a573dcf226fa55faed96f318169b9Devang Patel  void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, unsigned ArgNo);
19700dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
197156ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// protectFromPeepholes - Protect a value that we're intending to
197256ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// store to the side, but which will probably be used later, from
197356ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// aggressive peepholing optimizations that might delete it.
197456ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  ///
197556ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// Pass the result to unprotectFromPeepholes to declare that
197656ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// protection is no longer required.
197756ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  ///
197856ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// There's no particular reason why this shouldn't apply to
197956ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  /// l-values, it's just that no existing peepholes work on pointers.
198056ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  PeepholeProtection protectFromPeepholes(RValue rvalue);
198156ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  void unprotectFromPeepholes(PeepholeProtection protection);
198256ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall
19835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //===--------------------------------------------------------------------===//
19845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //                             Statement Emission
19855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //===--------------------------------------------------------------------===//
19865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
19870dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
19880912425f79418a215c2fbd2d8fc9511244a4aa46Daniel Dunbar  void EmitStopPoint(const Stmt *S);
19890912425f79418a215c2fbd2d8fc9511244a4aa46Daniel Dunbar
19900dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
19910dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// this function even if there is no current insertion point.
19920dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  ///
19930dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// This function may clear the current insertion point; callers should use
19940dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EnsureInsertPoint if they wish to subsequently generate code without first
19950dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// calling EmitBlock, EmitBranch, or EmitStmt.
19965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void EmitStmt(const Stmt *S);
1997a448fb2da03ece39978784793eea68760e8205a1Daniel Dunbar
19980912425f79418a215c2fbd2d8fc9511244a4aa46Daniel Dunbar  /// EmitSimpleStmt - Try to emit a "simple" statement which does not
19990dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// necessarily require an insertion point or debug information; typically
20000dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// because the statement amounts to a jump or a container of other
20010dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// statements.
20020912425f79418a215c2fbd2d8fc9511244a4aa46Daniel Dunbar  ///
20030912425f79418a215c2fbd2d8fc9511244a4aa46Daniel Dunbar  /// \return True if the statement was handled.
20040912425f79418a215c2fbd2d8fc9511244a4aa46Daniel Dunbar  bool EmitSimpleStmt(const Stmt *S);
20050912425f79418a215c2fbd2d8fc9511244a4aa46Daniel Dunbar
20069b65551d0b387a7597fb39356a4d8ef10046445eChris Lattner  RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2007558d2abc7f9fd6801cc7677200992313ae90b5d8John McCall                          AggValueSlot AVS = AggValueSlot::ignored());
2008a448fb2da03ece39978784793eea68760e8205a1Daniel Dunbar
20090dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitLabel - Emit the block for the given label. It is legal to call this
20100dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// function even if there is no current insertion point.
2011ad8dcf4a9df0e24051dc31bf9e6f3cd138a34298Chris Lattner  void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
2012a448fb2da03ece39978784793eea68760e8205a1Daniel Dunbar
20135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void EmitLabelStmt(const LabelStmt &S);
2014534986f2b21e6050bf00163cd6423fd92155a6edRichard Smith  void EmitAttributedStmt(const AttributedStmt &S);
20155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void EmitGotoStmt(const GotoStmt &S);
20160ffb125996336fc7602b162c0a9e392f1a93060fDaniel Dunbar  void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
20175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void EmitIfStmt(const IfStmt &S);
20185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void EmitWhileStmt(const WhileStmt &S);
20195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void EmitDoStmt(const DoStmt &S);
20205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void EmitForStmt(const ForStmt &S);
20215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void EmitReturnStmt(const ReturnStmt &S);
20225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void EmitDeclStmt(const DeclStmt &S);
20230912425f79418a215c2fbd2d8fc9511244a4aa46Daniel Dunbar  void EmitBreakStmt(const BreakStmt &S);
20240912425f79418a215c2fbd2d8fc9511244a4aa46Daniel Dunbar  void EmitContinueStmt(const ContinueStmt &S);
202551b09f2c528c8460b5465c676173324e44176d62Devang Patel  void EmitSwitchStmt(const SwitchStmt &S);
202651b09f2c528c8460b5465c676173324e44176d62Devang Patel  void EmitDefaultStmt(const DefaultStmt &S);
202751b09f2c528c8460b5465c676173324e44176d62Devang Patel  void EmitCaseStmt(const CaseStmt &S);
2028c049e4f406a7f7179eba98659044a32508e53289Devang Patel  void EmitCaseStmtRange(const CaseStmt &S);
2029a23b91d542e336be5051ac54f394e860fb756911Chad Rosier  void EmitAsmStmt(const AsmStmt &S);
20300dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
20313d8400d9a61aa4b63ff35e5cede405b32a41425eAnders Carlsson  void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
203264d5d6c5903157c521af496479d06dc26032d718Anders Carlsson  void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
203364d5d6c5903157c521af496479d06dc26032d718Anders Carlsson  void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
203410cac6f7115b59a466bb8d2d51cdddeb38aadc37Chris Lattner  void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
2035f85e193739c953358c865005855253af4f68a497John McCall  void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
20360dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
203793c332a8ba2c193c435b293966d343dab15f555bJohn McCall  llvm::Constant *getUnwindResumeFn();
203886a3a03667bdb0dcab7e6a2877dfd234b07a6d43Douglas Gregor  llvm::Constant *getUnwindResumeOrRethrowFn();
203959a7000a79118e4c140885ccbb2ac6a686a73092John McCall  void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
204059a7000a79118e4c140885ccbb2ac6a686a73092John McCall  void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
20419fc6a7774643a810c8501dae2323e863fefb623eJohn McCall
20426815e941998659a55c20c147861b0f437928c3d8Anders Carlsson  void EmitCXXTryStmt(const CXXTryStmt &S);
2043ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith  void EmitCXXForRangeStmt(const CXXForRangeStmt &S);
20449cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
20455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //===--------------------------------------------------------------------===//
20465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //                         LValue Expression Emission
20475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //===--------------------------------------------------------------------===//
20485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
204913e81737a433b23f8c662d10d1d57356122a8caaDaniel Dunbar  /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
205013e81737a433b23f8c662d10d1d57356122a8caaDaniel Dunbar  RValue GetUndefRValue(QualType Ty);
205113e81737a433b23f8c662d10d1d57356122a8caaDaniel Dunbar
2052ce1d38b8163650e473d7084e0686ed5a7956057bDaniel Dunbar  /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2053ce1d38b8163650e473d7084e0686ed5a7956057bDaniel Dunbar  /// and issue an ErrorUnsupported style diagnostic (using the
2054ce1d38b8163650e473d7084e0686ed5a7956057bDaniel Dunbar  /// provided Name).
2055ce1d38b8163650e473d7084e0686ed5a7956057bDaniel Dunbar  RValue EmitUnsupportedRValue(const Expr *E,
2056ce1d38b8163650e473d7084e0686ed5a7956057bDaniel Dunbar                               const char *Name);
2057ce1d38b8163650e473d7084e0686ed5a7956057bDaniel Dunbar
20580dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
20590dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// an ErrorUnsupported style diagnostic (using the provided Name).
20606ba82a4a4b295e54cf192c3e98b28f39990c6194Daniel Dunbar  LValue EmitUnsupportedLValue(const Expr *E,
20616ba82a4a4b295e54cf192c3e98b28f39990c6194Daniel Dunbar                               const char *Name);
20626ba82a4a4b295e54cf192c3e98b28f39990c6194Daniel Dunbar
20635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// EmitLValue - Emit code to compute a designator that specifies the location
20645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// of the expression.
20655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  ///
20665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// This can return one of two things: a simple address or a bitfield
20675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// reference.  In either case, the LLVM Value* in the LValue structure is
20685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// guaranteed to be an LLVM pointer type.
20695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  ///
20705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// If this returns a bitfield reference, nothing about the pointee type of
20715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// the LLVM value is known: For example, it may not be a pointer to an
20725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// integer.
20735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  ///
20745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// If this returns a normal address, and if the lvalue's C type is fixed
20755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// size, this method guarantees that the returned pointer type will point to
20765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// an LLVM type of the same size of the lvalue's type.  If the lvalue has a
20775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// variable length type, this is not possible.
20785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  ///
20795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  LValue EmitLValue(const Expr *E);
20800dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
20817ac9ef1c82c779a5348ed11b3d10e01c58803b35Richard Smith  /// \brief Same as EmitLValue but additionally we generate checking code to
20827ac9ef1c82c779a5348ed11b3d10e01c58803b35Richard Smith  /// guard against undefined behavior.  This is only suitable when we know
20837ac9ef1c82c779a5348ed11b3d10e01c58803b35Richard Smith  /// that the address will be used to access the object.
20847ac9ef1c82c779a5348ed11b3d10e01c58803b35Richard Smith  LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
2085b14e62d5aee7522b98c410ee65bd750c2cfe6f01Mike Stump
208626815d97c5743481e317f17a8d53a6819d061862John McCall  /// EmitToMemory - Change a scalar value from its value
208726815d97c5743481e317f17a8d53a6819d061862John McCall  /// representation to its in-memory representation.
208826815d97c5743481e317f17a8d53a6819d061862John McCall  llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
208926815d97c5743481e317f17a8d53a6819d061862John McCall
209026815d97c5743481e317f17a8d53a6819d061862John McCall  /// EmitFromMemory - Change a scalar value from its memory
209126815d97c5743481e317f17a8d53a6819d061862John McCall  /// representation to its value representation.
209226815d97c5743481e317f17a8d53a6819d061862John McCall  llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
209326815d97c5743481e317f17a8d53a6819d061862John McCall
20949d9cc874bcc168474757a8f90476684b4a93ed76Daniel Dunbar  /// EmitLoadOfScalar - Load a scalar value from an address, taking
20959d9cc874bcc168474757a8f90476684b4a93ed76Daniel Dunbar  /// care to appropriately convert from the memory representation to
20969d9cc874bcc168474757a8f90476684b4a93ed76Daniel Dunbar  /// the LLVM value representation.
209709429b962811f2c0a7a81a1b0a89f96f5878b20cMike Stump  llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
20983d5aff5d3036b0ff09d114857cd2276134b3d8c9Dan Gohman                                unsigned Alignment, QualType Ty,
20993d5aff5d3036b0ff09d114857cd2276134b3d8c9Dan Gohman                                llvm::MDNode *TBAAInfo = 0);
2100545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall
2101545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall  /// EmitLoadOfScalar - Load a scalar value from an address, taking
2102545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall  /// care to appropriately convert from the memory representation to
2103545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall  /// the LLVM value representation.  The l-value must be a simple
2104545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall  /// l-value.
2105a07398ed98ea2b55ad7a505a3aab18aed93b149fJohn McCall  llvm::Value *EmitLoadOfScalar(LValue lvalue);
21069d9cc874bcc168474757a8f90476684b4a93ed76Daniel Dunbar
21079d9cc874bcc168474757a8f90476684b4a93ed76Daniel Dunbar  /// EmitStoreOfScalar - Store a scalar value to an address, taking
21089d9cc874bcc168474757a8f90476684b4a93ed76Daniel Dunbar  /// care to appropriately convert from the memory representation to
21099d9cc874bcc168474757a8f90476684b4a93ed76Daniel Dunbar  /// the LLVM value representation.
211009429b962811f2c0a7a81a1b0a89f96f5878b20cMike Stump  void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
21113d5aff5d3036b0ff09d114857cd2276134b3d8c9Dan Gohman                         bool Volatile, unsigned Alignment, QualType Ty,
21127a7ee3033e44b45630981355460ef89efa0bdcc4David Chisnall                         llvm::MDNode *TBAAInfo = 0, bool isInit=false);
2113545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall
2114545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall  /// EmitStoreOfScalar - Store a scalar value to an address, taking
2115545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall  /// care to appropriately convert from the memory representation to
2116545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall  /// the LLVM value representation.  The l-value must be a simple
21177a7ee3033e44b45630981355460ef89efa0bdcc4David Chisnall  /// l-value.  The isInit flag indicates whether this is an initialization.
21187a7ee3033e44b45630981355460ef89efa0bdcc4David Chisnall  /// If so, atomic qualifiers are ignored and the store is always non-atomic.
21197a7ee3033e44b45630981355460ef89efa0bdcc4David Chisnall  void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
21209d9cc874bcc168474757a8f90476684b4a93ed76Daniel Dunbar
21215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
21225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// this method emits the address of the lvalue, then loads the result as an
21235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// rvalue, returning the rvalue.
2124545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall  RValue EmitLoadOfLValue(LValue V);
2125545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall  RValue EmitLoadOfExtVectorElementLValue(LValue V);
2126545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall  RValue EmitLoadOfBitfieldLValue(LValue LV);
21270dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
21285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// EmitStoreThroughLValue - Store the specified rvalue into the specified
21295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// lvalue, where both are guaranteed to the have the same type, and that type
21305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// is 'Ty'.
21317a7ee3033e44b45630981355460ef89efa0bdcc4David Chisnall  void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false);
2132545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall  void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
2133ed3849b456d64d124bddc7ac044f3ce590bd9d69Daniel Dunbar
21340dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitStoreThroughLValue - Store Src into Dst with same constraints as
21350dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitStoreThroughLValue.
2136ed3849b456d64d124bddc7ac044f3ce590bd9d69Daniel Dunbar  ///
21370dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// \param Result [out] - If non-null, this will be set to a Value* for the
21380dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// bit-field contents after the store, appropriate for use as the result of
21390dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// an assignment to the bit-field.
2140545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall  void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
2141ed3849b456d64d124bddc7ac044f3ce590bd9d69Daniel Dunbar                                      llvm::Value **Result=0);
21420dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
214383ce9d4a552987d34cbd500e983db8d770232379John McCall  /// Emit an l-value for an assignment (simple or compound) of complex type.
214483ce9d4a552987d34cbd500e983db8d770232379John McCall  LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
21452a41637a995affa1563f4d82a8b026e326a2faa0John McCall  LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
214683ce9d4a552987d34cbd500e983db8d770232379John McCall
2147fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner  // Note: only available for agg return types
214880e62c29fe21cd06c93eba6e72b7e32dca06fcf9Daniel Dunbar  LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
21492a41637a995affa1563f4d82a8b026e326a2faa0John McCall  LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
21505b5c9ef865607e179413462dcd71bcebb5b7daaeDaniel Dunbar  // Note: only available for agg return types
215122c940ee588a420cd2e6c8f68be2ac3cc80061ffChristopher Lamb  LValue EmitCallExprLValue(const CallExpr *E);
21525b5c9ef865607e179413462dcd71bcebb5b7daaeDaniel Dunbar  // Note: only available for agg return types
21535b5c9ef865607e179413462dcd71bcebb5b7daaeDaniel Dunbar  LValue EmitVAArgExprLValue(const VAArgExpr *E);
21545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  LValue EmitDeclRefLValue(const DeclRefExpr *E);
21555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  LValue EmitStringLiteralLValue(const StringLiteral *E);
2156eaf2bb89eb2aad3b80673de30febe52df43c10ecChris Lattner  LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
2157d9f6910f4ef37c0e8eeee2a01287d9572c3176efChris Lattner  LValue EmitPredefinedLValue(const PredefinedExpr *E);
21585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  LValue EmitUnaryOpLValue(const UnaryOperator *E);
21595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E);
2160213541a68a3e137d11d2cefb612c6cdb410d7e8eNate Begeman  LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
2161b84a06e68ffd71da22e3c75b6e4bbdba37816413Devang Patel  LValue EmitMemberExpr(const MemberExpr *E);
2162820bca41c3899374775d2a1dfc2ef2e22aaf1c7bFariborz Jahanian  LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
216306e863f2902b8ba55b056308875c19f7ba3dab25Eli Friedman  LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
216413ec9100ca6bc03b5ce8832e4a0fcb724d47bcb1Richard Smith  LValue EmitInitListLValue(const InitListExpr *E);
216556ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall  LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
216675dfedaf702822c9e51a4f3c5d3ecf2d2ad99272Chris Lattner  LValue EmitCastLValue(const CastExpr *E);
2167ed8abf18329df67b0abcbb3a10458bd8c1d2a595Douglas Gregor  LValue EmitNullInitializationLValue(const CXXScalarValueInitExpr *E);
216803e80030515c800d1ab44125b9052dfffd1bd04cDouglas Gregor  LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
2169e996ffd240f20a1048179d7727a6ee3227261921John McCall  LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
21709cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
2171377ecc7996dce6803f7b7b6208cab5e197c9c5b8Eli Friedman  RValue EmitRValueForField(LValue LV, const FieldDecl *FD);
2172eaf856db5d1a272dc7188937206ef4572836f82aAnton Korobeynikov
2173dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall  class ConstantEmission {
2174dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall    llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2175dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall    ConstantEmission(llvm::Constant *C, bool isReference)
2176dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall      : ValueAndIsReference(C, isReference) {}
2177dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall  public:
2178dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall    ConstantEmission() {}
2179dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall    static ConstantEmission forReference(llvm::Constant *C) {
2180dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall      return ConstantEmission(C, true);
2181dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall    }
2182dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall    static ConstantEmission forValue(llvm::Constant *C) {
2183dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall      return ConstantEmission(C, false);
2184dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall    }
2185dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall
2186dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall    operator bool() const { return ValueAndIsReference.getOpaqueValue() != 0; }
2187dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall
2188dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall    bool isReference() const { return ValueAndIsReference.getInt(); }
2189dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall    LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2190dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall      assert(isReference());
2191dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall      return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2192dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall                                            refExpr->getType());
2193dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall    }
2194dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall
2195dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall    llvm::Constant *getValue() const {
2196dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall      assert(!isReference());
2197dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall      return ValueAndIsReference.getPointer();
2198dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall    }
2199dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall  };
2200dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall
2201f4b88a45902af1802a1cb42ba48b1c474474f228John McCall  ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
2202dd2ecee313b558a9b621ec003b45e0fbc83508d7John McCall
22034b9c2d235fb9449e249d74f48ecfec601650de93John McCall  RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
22044b9c2d235fb9449e249d74f48ecfec601650de93John McCall                                AggValueSlot slot = AggValueSlot::ignored());
22054b9c2d235fb9449e249d74f48ecfec601650de93John McCall  LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
22064b9c2d235fb9449e249d74f48ecfec601650de93John McCall
22072a03192a02dbf4fdff438d1e658356bde871aba4Daniel Dunbar  llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
220829e0bccf2bcce22b877f8b2ed173f564c116b97eDaniel Dunbar                              const ObjCIvarDecl *Ivar);
2209377ecc7996dce6803f7b7b6208cab5e197c9c5b8Eli Friedman  LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
22109cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
221106a2970e9480c6d02b367b2f970baff29b9f9721Anders Carlsson  /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
221206a2970e9480c6d02b367b2f970baff29b9f9721Anders Carlsson  /// if the Field is a reference, this will return the address of the reference
221306a2970e9480c6d02b367b2f970baff29b9f9721Anders Carlsson  /// and not the address of the value stored in the reference.
2214377ecc7996dce6803f7b7b6208cab5e197c9c5b8Eli Friedman  LValue EmitLValueForFieldInitialization(LValue Base,
2215377ecc7996dce6803f7b7b6208cab5e197c9c5b8Eli Friedman                                          const FieldDecl* Field);
22169cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
221745012a7ef5abf1042c893f3f2fa5c23cb5485ea9Fariborz Jahanian  LValue EmitLValueForIvar(QualType ObjectTy,
221845012a7ef5abf1042c893f3f2fa5c23cb5485ea9Fariborz Jahanian                           llvm::Value* Base, const ObjCIvarDecl *Ivar,
221929e0bccf2bcce22b877f8b2ed173f564c116b97eDaniel Dunbar                           unsigned CVRQualifiers);
2220fd64bb635dc221baa19f81d5d2a084f7eb269f7fFariborz Jahanian
2221b58d017f2b9eeed33f2ab3ede968b89cf5296bf2Anders Carlsson  LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
2222e61c9e80a108b5db7e5f0e702f0e455d737c6390Anders Carlsson  LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
222331a3702618ab49578542cffee20ba0c8859b9d1eEli Friedman  LValue EmitLambdaLValue(const LambdaExpr *E);
2224c2e84ae9a6d25cea3e583c768e576b4c981ec028Mike Stump  LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
2225c5f804636e367ef744fd24cf88f7c956a5af0434Nico Weber  LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
22269cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
22270a04d77bde7e3a661c2b41b60630d125d09ed6efDaniel Dunbar  LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
2228391d77a26382dddf25da73e29fc1fa5aaaea4c6fChris Lattner  LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
2229654599454c8e6cc83b1b9b3af43c49c2f66a26cbChris Lattner  LValue EmitStmtExprLValue(const StmtExpr *E);
22308bfd31f9dad09cd52225d868bbd92a9bebe87775Fariborz Jahanian  LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
223103b2960c14aede6ac82bdef32247094ebb72fa69Fariborz Jahanian  LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
2232189d6ef40eff11b83b2cda941d5ed89a5cef09b2John McCall  void   EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
223356ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall
22345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //===--------------------------------------------------------------------===//
2235883f6a7cc7dccb1d675e27121a82614d63492a8dChris Lattner  //                         Scalar Expression Emission
22365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //===--------------------------------------------------------------------===//
22375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
22380dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitCall - Generate a call of the given function, expecting the given
22390dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// result type, and using the given argument list which specifies both the
22400dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// LLVM arguments and the types they were derived from.
2241c0ef9f59937c3971c48b6fed37cf5bd8985c024bDaniel Dunbar  ///
2242f71d232ce5354bd2f0c94ded30fb936c2a3d968bMike Stump  /// \param TargetDecl - If given, the decl of the function in a direct call;
2243f71d232ce5354bd2f0c94ded30fb936c2a3d968bMike Stump  /// used to set attributes on the call (noreturn, etc.).
224488b5396b0897f28d22ae3debf4a0d97b33b6c362Daniel Dunbar  RValue EmitCall(const CGFunctionInfo &FnInfo,
224588b5396b0897f28d22ae3debf4a0d97b33b6c362Daniel Dunbar                  llvm::Value *Callee,
2246f3c47c9525153aea2de0ec4bd615b9cf2d81c103Anders Carlsson                  ReturnValueSlot ReturnValue,
2247c0ef9f59937c3971c48b6fed37cf5bd8985c024bDaniel Dunbar                  const CallArgList &Args,
2248dd5c98f709837e5dd3da08d44d1ce407975df2cfDavid Chisnall                  const Decl *TargetDecl = 0,
22494b02afcb45cd1a384de7d45f440a8be091dd500bDavid Chisnall                  llvm::Instruction **callOrInvoke = 0);
22501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
225131777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson  RValue EmitCall(QualType FnType, llvm::Value *Callee,
2252d2490a91341b57df7a7e54f8a707e7ecde2eeb4eAnders Carlsson                  ReturnValueSlot ReturnValue,
2253986477149db76e6d9f8d3c9859c9880c11b680aeAnders Carlsson                  CallExpr::const_arg_iterator ArgBeg,
2254986477149db76e6d9f8d3c9859c9880c11b680aeAnders Carlsson                  CallExpr::const_arg_iterator ArgEnd,
2255986477149db76e6d9f8d3c9859c9880c11b680aeAnders Carlsson                  const Decl *TargetDecl = 0);
22569cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer  RValue EmitCallExpr(const CallExpr *E,
2257d2490a91341b57df7a7e54f8a707e7ecde2eeb4eAnders Carlsson                      ReturnValueSlot ReturnValue = ReturnValueSlot());
22581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
2259f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall  llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
22602d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner                                  ArrayRef<llvm::Value *> Args,
22618cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner                                  const Twine &Name = "");
22624c7d9f1507d0f102bd4133bba63348636facd469Jay Foad  llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
22638cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner                                  const Twine &Name = "");
2264f1549f66a8216a78112286e3978cea2c29d6334cJohn McCall
2265566abee1e9828a7700b51e4d17ea08234fde3bb4Anders Carlsson  llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This,
22662acc6e3feda5e4f7d9009bdcf8b1cd777fecfe2dChris Lattner                                llvm::Type *Ty);
22679cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer  llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type,
22682acc6e3feda5e4f7d9009bdcf8b1cd777fecfe2dChris Lattner                                llvm::Value *This, llvm::Type *Ty);
22692726267f094a0c1f5ac5b501ec5a9898c58876bfFariborz Jahanian  llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
22702726267f094a0c1f5ac5b501ec5a9898c58876bfFariborz Jahanian                                         NestedNameSpecifier *Qual,
22712acc6e3feda5e4f7d9009bdcf8b1cd777fecfe2dChris Lattner                                         llvm::Type *Ty);
2272ccd5259d33cbbdd6f5fbf7ccab4cb4a2702309eaFariborz Jahanian
2273ccd5259d33cbbdd6f5fbf7ccab4cb4a2702309eaFariborz Jahanian  llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2274ccd5259d33cbbdd6f5fbf7ccab4cb4a2702309eaFariborz Jahanian                                                   CXXDtorType Type,
2275771c678c04f5f685b4f188ec6c2fd88ad0f7457fFariborz Jahanian                                                   const CXXRecordDecl *RD);
2276566abee1e9828a7700b51e4d17ea08234fde3bb4Anders Carlsson
2277b9de2c55b2a33776e2bee8ee57df7599b374c8a5Anders Carlsson  RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
22784def70d3040e73707c738f7c366737a986135edfRichard Smith                           SourceLocation CallLoc,
2279b9de2c55b2a33776e2bee8ee57df7599b374c8a5Anders Carlsson                           llvm::Value *Callee,
2280a1736c0c750d4514a5d8fda36670addf1e4de54aAnders Carlsson                           ReturnValueSlot ReturnValue,
2281b9de2c55b2a33776e2bee8ee57df7599b374c8a5Anders Carlsson                           llvm::Value *This,
2282c997d4278d329e18891aac9698fb991b2d4622ebAnders Carlsson                           llvm::Value *VTT,
2283b9de2c55b2a33776e2bee8ee57df7599b374c8a5Anders Carlsson                           CallExpr::const_arg_iterator ArgBeg,
2284b9de2c55b2a33776e2bee8ee57df7599b374c8a5Anders Carlsson                           CallExpr::const_arg_iterator ArgEnd);
2285a1736c0c750d4514a5d8fda36670addf1e4de54aAnders Carlsson  RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2286a1736c0c750d4514a5d8fda36670addf1e4de54aAnders Carlsson                               ReturnValueSlot ReturnValue);
2287a1736c0c750d4514a5d8fda36670addf1e4de54aAnders Carlsson  RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2288a1736c0c750d4514a5d8fda36670addf1e4de54aAnders Carlsson                                      ReturnValueSlot ReturnValue);
22895549976193e34417d4474a5f4a514268ef6666c7Ted Kremenek
2290a2447e0d1e28669cd637204a871f15b1215277fdAnders Carlsson  llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2291a2447e0d1e28669cd637204a871f15b1215277fdAnders Carlsson                                           const CXXMethodDecl *MD,
2292a2447e0d1e28669cd637204a871f15b1215277fdAnders Carlsson                                           llvm::Value *This);
22930f294632f36459174199b77699e339715244b5abAnders Carlsson  RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
2294a1736c0c750d4514a5d8fda36670addf1e4de54aAnders Carlsson                                       const CXXMethodDecl *MD,
2295a1736c0c750d4514a5d8fda36670addf1e4de54aAnders Carlsson                                       ReturnValueSlot ReturnValue);
22961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
22976c0aa5ff6e6253db0f993053599e2a52b5b93b2dPeter Collingbourne  RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
22986c0aa5ff6e6253db0f993053599e2a52b5b93b2dPeter Collingbourne                                ReturnValueSlot ReturnValue);
22996c0aa5ff6e6253db0f993053599e2a52b5b93b2dPeter Collingbourne
23009cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
23011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  RValue EmitBuiltinExpr(const FunctionDecl *FD,
2302ef2abfee3ea16ec74942dc09e9e425f46aeb2582Daniel Dunbar                         unsigned BuiltinID, const CallExpr *E);
23035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
2304a1736c0c750d4514a5d8fda36670addf1e4de54aAnders Carlsson  RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
230509429b962811f2c0a7a81a1b0a89f96f5878b20cMike Stump
23060dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
23070dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// is unhandled by the current target.
2308f02e9ddf5efc75917af712b3c7f909581205f0a5Daniel Dunbar  llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2309f02e9ddf5efc75917af712b3c7f909581205f0a5Daniel Dunbar
23102752c0137d95aa2f4ee1cdff4b564bac842e041bChris Lattner  llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
23119cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer  llvm::Value *EmitNeonCall(llvm::Function *F,
2312686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                            SmallVectorImpl<llvm::Value*> &O,
2313db3d4d036037f379f12643e067b229862d61e932Bob Wilson                            const char *name,
231461eecf5aea018ea65c9ab0bccacd2996b15c632dNate Begeman                            unsigned shift = 0, bool rightshift = false);
2315cf55652cf668c1402eee0b12edd2e5a1bc34d7a1Bob Wilson  llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
23162acc6e3feda5e4f7d9009bdcf8b1cd777fecfe2dChris Lattner  llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
231761eecf5aea018ea65c9ab0bccacd2996b15c632dNate Begeman                                   bool negateForRightShift);
23189cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
2319795b10062c2eaffae9e04241fb1a73cdbcb24a37Bill Wendling  llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
2320564f1de67d7ba43646b8740db86d6269e3dfbe0bAnders Carlsson  llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2321564f1de67d7ba43646b8740db86d6269e3dfbe0bAnders Carlsson  llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
23220dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
2323ed7c618f849e2541b1d0288c43154937652c5b15Daniel Dunbar  llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
23247f02f721d48772e4eee4fccd8af4f800be1bbc1eChris Lattner  llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
2325eb382ec1507cf2c8c12d7443d0b67c076223aec6Patrick Beard  llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
2326ebcb57a8d298862c65043e88b2429591ab3c58d3Ted Kremenek  llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2327ebcb57a8d298862c65043e88b2429591ab3c58d3Ted Kremenek  llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2328ebcb57a8d298862c65043e88b2429591ab3c58d3Ted Kremenek  llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
2329ebcb57a8d298862c65043e88b2429591ab3c58d3Ted Kremenek                                const ObjCMethodDecl *MethodWithObjects);
23308fdf32822be2238aa7db62d40e75b168b637ab7dChris Lattner  llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
2331ef072fd2f3347cfd857d6eb787b245b950771430John McCall  RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2332ef072fd2f3347cfd857d6eb787b245b950771430John McCall                             ReturnValueSlot Return = ReturnValueSlot());
23338fdf32822be2238aa7db62d40e75b168b637ab7dChris Lattner
2334f85e193739c953358c865005855253af4f68a497John McCall  /// Retrieves the default cleanup kind for an ARC cleanup.
2335f85e193739c953358c865005855253af4f68a497John McCall  /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2336f85e193739c953358c865005855253af4f68a497John McCall  CleanupKind getARCCleanupKind() {
2337f85e193739c953358c865005855253af4f68a497John McCall    return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2338f85e193739c953358c865005855253af4f68a497John McCall             ? NormalAndEHCleanup : NormalCleanup;
2339f85e193739c953358c865005855253af4f68a497John McCall  }
2340f85e193739c953358c865005855253af4f68a497John McCall
2341f85e193739c953358c865005855253af4f68a497John McCall  // ARC primitives.
2342f85e193739c953358c865005855253af4f68a497John McCall  void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2343f85e193739c953358c865005855253af4f68a497John McCall  void EmitARCDestroyWeak(llvm::Value *addr);
2344f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2345f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2346f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2347f85e193739c953358c865005855253af4f68a497John McCall                                bool ignored);
2348f85e193739c953358c865005855253af4f68a497John McCall  void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2349f85e193739c953358c865005855253af4f68a497John McCall  void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2350f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2351f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
2352545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall  llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
2353545d996ec5a3113f046944f11b27cc2d6cb055b4John McCall                                  bool ignored);
2354f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
2355f85e193739c953358c865005855253af4f68a497John McCall                                      bool ignored);
2356f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2357f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
2358348f16fc7c71f0d9b651cb79fd1012843073493fJohn McCall  llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
2359015f33b6741ffceba3a71ee2d71d46418a7dc34cJohn McCall  void EmitARCDestroyStrong(llvm::Value *addr, bool precise);
2360f85e193739c953358c865005855253af4f68a497John McCall  void EmitARCRelease(llvm::Value *value, bool precise);
2361f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCAutorelease(llvm::Value *value);
2362f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2363f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2364f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2365f85e193739c953358c865005855253af4f68a497John McCall
2366f85e193739c953358c865005855253af4f68a497John McCall  std::pair<LValue,llvm::Value*>
2367f85e193739c953358c865005855253af4f68a497John McCall  EmitARCStoreAutoreleasing(const BinaryOperator *e);
2368f85e193739c953358c865005855253af4f68a497John McCall  std::pair<LValue,llvm::Value*>
2369f85e193739c953358c865005855253af4f68a497John McCall  EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2370f85e193739c953358c865005855253af4f68a497John McCall
23712b014d6c0c6b8ac94b416ac37dfc7931f20777a7John McCall  llvm::Value *EmitObjCThrowOperand(const Expr *expr);
23722b014d6c0c6b8ac94b416ac37dfc7931f20777a7John McCall
2373f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2374f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2375f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2376f85e193739c953358c865005855253af4f68a497John McCall
2377348f16fc7c71f0d9b651cb79fd1012843073493fJohn McCall  llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
2378f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2379f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2380f85e193739c953358c865005855253af4f68a497John McCall
2381bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  static Destroyer destroyARCStrongImprecise;
2382bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  static Destroyer destroyARCStrongPrecise;
2383bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall  static Destroyer destroyARCWeak;
2384bdc4d80956c83a486e58d3df6bb524a1f66ff574John McCall
2385f85e193739c953358c865005855253af4f68a497John McCall  void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2386f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitObjCAutoreleasePoolPush();
2387f85e193739c953358c865005855253af4f68a497John McCall  llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2388f85e193739c953358c865005855253af4f68a497John McCall  void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2389f85e193739c953358c865005855253af4f68a497John McCall  void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2390f85e193739c953358c865005855253af4f68a497John McCall
23914029ca7ae9d3ffd7738fe2ed8782bebc30f36fd6Anders Carlsson  /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in
23924029ca7ae9d3ffd7738fe2ed8782bebc30f36fd6Anders Carlsson  /// expression. Will emit a temporary variable if E is not an LValue.
23939cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer  RValue EmitReferenceBindingToExpr(const Expr* E,
239432f36baa6c8d491c374af622b4e3ac28d597453cAnders Carlsson                                    const NamedDecl *InitializedDecl);
23953aba09376c5f49c4c8d176109ea4835bc2c528eeAnders Carlsson
2396883f6a7cc7dccb1d675e27121a82614d63492a8dChris Lattner  //===--------------------------------------------------------------------===//
2397bfc0c1ae4b505b52b36f572a9641f99e76879cabChris Lattner  //                           Expression Emission
2398883f6a7cc7dccb1d675e27121a82614d63492a8dChris Lattner  //===--------------------------------------------------------------------===//
2399bfc0c1ae4b505b52b36f572a9641f99e76879cabChris Lattner
2400bfc0c1ae4b505b52b36f572a9641f99e76879cabChris Lattner  // Expressions are broken into three classes: scalar, complex, aggregate.
24010dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
24020dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
24030dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// scalar type, returning the result.
240414c5cbf59cffee52275230922283a247de407712Anders Carlsson  llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
24050dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
24063707b255f8993fb362904c9cff87b0e9bc6ca317Chris Lattner  /// EmitScalarConversion - Emit a conversion from the specified type to the
24073707b255f8993fb362904c9cff87b0e9bc6ca317Chris Lattner  /// specified destination type, both of which are LLVM scalar types.
24083707b255f8993fb362904c9cff87b0e9bc6ca317Chris Lattner  llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
24093707b255f8993fb362904c9cff87b0e9bc6ca317Chris Lattner                                    QualType DstTy);
24100dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
24114f1a7b380809b4ca19ad2daff61bc11cd1e979d8Chris Lattner  /// EmitComplexToScalarConversion - Emit a conversion from the specified
24120dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// complex type to the specified destination type, where the destination type
24130dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// is an LLVM scalar type.
24144f1a7b380809b4ca19ad2daff61bc11cd1e979d8Chris Lattner  llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
24154f1a7b380809b4ca19ad2daff61bc11cd1e979d8Chris Lattner                                             QualType DstTy);
24160dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
24170dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
2418558d2abc7f9fd6801cc7677200992313ae90b5d8John McCall  /// EmitAggExpr - Emit the computation of the specified expression
2419558d2abc7f9fd6801cc7677200992313ae90b5d8John McCall  /// of aggregate type.  The result is computed into the given slot,
2420558d2abc7f9fd6801cc7677200992313ae90b5d8John McCall  /// which may be null to indicate that the value is not needed.
2421e0c1168ec7910a1a7ed08df4d4f0c58c2fa2ecd1John McCall  void EmitAggExpr(const Expr *E, AggValueSlot AS);
24220dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
242318aba0dd518e486d8b50523e7dafb4b5657135d2Daniel Dunbar  /// EmitAggExprToLValue - Emit the computation of the specified expression of
242418aba0dd518e486d8b50523e7dafb4b5657135d2Daniel Dunbar  /// aggregate type into a temporary LValue.
242518aba0dd518e486d8b50523e7dafb4b5657135d2Daniel Dunbar  LValue EmitAggExprToLValue(const Expr *E);
242618aba0dd518e486d8b50523e7dafb4b5657135d2Daniel Dunbar
2427082b02e8403d3ee9d2ded969fbe0e5d472f04cd8Fariborz Jahanian  /// EmitGCMemmoveCollectable - Emit special API for structs with object
2428082b02e8403d3ee9d2ded969fbe0e5d472f04cd8Fariborz Jahanian  /// pointers.
2429082b02e8403d3ee9d2ded969fbe0e5d472f04cd8Fariborz Jahanian  void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
243008c321380fff07d476a19daab6d29522c046cd49Fariborz Jahanian                                QualType Ty);
2431082b02e8403d3ee9d2ded969fbe0e5d472f04cd8Fariborz Jahanian
24320c24c808e4dce43e88abf2d5f98546b901bd4315John McCall  /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
24330c24c808e4dce43e88abf2d5f98546b901bd4315John McCall  /// make sure it survives garbage collection until this point.
24340c24c808e4dce43e88abf2d5f98546b901bd4315John McCall  void EmitExtendGCLifetime(llvm::Value *object);
24350c24c808e4dce43e88abf2d5f98546b901bd4315John McCall
2436b6ef18a2b06d6760459e1756a61f79ff496cee19Chris Lattner  /// EmitComplexExpr - Emit the computation of the specified expression of
243723b1cdb0b5e089468bb8475b8ec9287af67b4b59Chris Lattner  /// complex type, returning the result.
2438b418d74c11498b7e1044103131e2e3be4d63512eJohn McCall  ComplexPairTy EmitComplexExpr(const Expr *E,
2439b418d74c11498b7e1044103131e2e3be4d63512eJohn McCall                                bool IgnoreReal = false,
2440b418d74c11498b7e1044103131e2e3be4d63512eJohn McCall                                bool IgnoreImag = false);
24410dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
244223b1cdb0b5e089468bb8475b8ec9287af67b4b59Chris Lattner  /// EmitComplexExprIntoAddr - Emit the computation of the specified expression
244323b1cdb0b5e089468bb8475b8ec9287af67b4b59Chris Lattner  /// of complex type, storing into the specified Value*.
2444190dbe203c2e892ac40f1786035c6c9be3f44a4cChris Lattner  void EmitComplexExprIntoAddr(const Expr *E, llvm::Value *DestAddr,
2445190dbe203c2e892ac40f1786035c6c9be3f44a4cChris Lattner                               bool DestIsVolatile);
24467f8ea5c5b3a6a4332a841eefdd86b0726722ea7bDaniel Dunbar
24477f8ea5c5b3a6a4332a841eefdd86b0726722ea7bDaniel Dunbar  /// StoreComplexToAddr - Store a complex number into the specified address.
24487f8ea5c5b3a6a4332a841eefdd86b0726722ea7bDaniel Dunbar  void StoreComplexToAddr(ComplexPairTy V, llvm::Value *DestAddr,
24497f8ea5c5b3a6a4332a841eefdd86b0726722ea7bDaniel Dunbar                          bool DestIsVolatile);
24509b65551d0b387a7597fb39356a4d8ef10046445eChris Lattner  /// LoadComplexFromAddr - Load a complex number from the specified address.
24519b65551d0b387a7597fb39356a4d8ef10046445eChris Lattner  ComplexPairTy LoadComplexFromAddr(llvm::Value *SrcAddr, bool SrcIsVolatile);
24522621fd1d6d3c5eadcae246859f62738645df7540Chris Lattner
2453b6bbcc9995186799a60ce17d0c1acff31601653aJohn McCall  /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
2454b6bbcc9995186799a60ce17d0c1acff31601653aJohn McCall  /// a static local variable.
24550f30a12ce7b3d4d86c9ca9072f587da77c8eef34Chandler Carruth  llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D,
24560f30a12ce7b3d4d86c9ca9072f587da77c8eef34Chandler Carruth                                            const char *Separator,
24570f30a12ce7b3d4d86c9ca9072f587da77c8eef34Chandler Carruth                                       llvm::GlobalValue::LinkageTypes Linkage);
24589cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
24590f30a12ce7b3d4d86c9ca9072f587da77c8eef34Chandler Carruth  /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
24600f30a12ce7b3d4d86c9ca9072f587da77c8eef34Chandler Carruth  /// global variable that has already been created for it.  If the initializer
24610f30a12ce7b3d4d86c9ca9072f587da77c8eef34Chandler Carruth  /// has a different type than GV does, this may free GV and return a different
24620f30a12ce7b3d4d86c9ca9072f587da77c8eef34Chandler Carruth  /// one.  Otherwise it just returns GV.
24630f30a12ce7b3d4d86c9ca9072f587da77c8eef34Chandler Carruth  llvm::GlobalVariable *
24640f30a12ce7b3d4d86c9ca9072f587da77c8eef34Chandler Carruth  AddInitializerToStaticVarDecl(const VarDecl &D,
24650f30a12ce7b3d4d86c9ca9072f587da77c8eef34Chandler Carruth                                llvm::GlobalVariable *GV);
24669cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
24670096acf421c4609ce7f43e8b05f8c5ca866d4611Daniel Dunbar
24683b2e16b3d25f6b311dba2871e2a566c96238c3d2Anders Carlsson  /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
24693b2e16b3d25f6b311dba2871e2a566c96238c3d2Anders Carlsson  /// variable with global storage.
24707ca4850a3e3530fa6c93b64b740446e32c97f992Richard Smith  void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
24717ca4850a3e3530fa6c93b64b740446e32c97f992Richard Smith                                bool PerformInit);
24723b2e16b3d25f6b311dba2871e2a566c96238c3d2Anders Carlsson
247320bb175cb8ae5844034828db094fb948c0e3454aJohn McCall  /// Call atexit() with a function that passes the given argument to
247420bb175cb8ae5844034828db094fb948c0e3454aJohn McCall  /// the given function.
247520bb175cb8ae5844034828db094fb948c0e3454aJohn McCall  void registerGlobalDtorWithAtExit(llvm::Constant *fn, llvm::Constant *addr);
24761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
24773030eb82593097502469a8b3fc26112c79c75605John McCall  /// Emit code in this function to perform a guarded variable
24783030eb82593097502469a8b3fc26112c79c75605John McCall  /// initialization.  Guarded initializations are used when it's not
24793030eb82593097502469a8b3fc26112c79c75605John McCall  /// possible to prove that an initialization will be done exactly
24803030eb82593097502469a8b3fc26112c79c75605John McCall  /// once, e.g. with a static local variable or a static data member
24813030eb82593097502469a8b3fc26112c79c75605John McCall  /// of a class template.
24820f30a12ce7b3d4d86c9ca9072f587da77c8eef34Chandler Carruth  void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
24837ca4850a3e3530fa6c93b64b740446e32c97f992Richard Smith                          bool PerformInit);
24845cd91b513455fd7753e8815b54f0a49bbca6602dJohn McCall
2485efb0fa9e11f75af51744a6159530ef7cc8efa24aDaniel Dunbar  /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2486efb0fa9e11f75af51744a6159530ef7cc8efa24aDaniel Dunbar  /// variables.
2487efb0fa9e11f75af51744a6159530ef7cc8efa24aDaniel Dunbar  void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
2488efb0fa9e11f75af51744a6159530ef7cc8efa24aDaniel Dunbar                                 llvm::Constant **Decls,
2489efb0fa9e11f75af51744a6159530ef7cc8efa24aDaniel Dunbar                                 unsigned NumDecls);
2490efb0fa9e11f75af51744a6159530ef7cc8efa24aDaniel Dunbar
24913f88f686e32949ffe02ccb551f482f9cf810358bJohn McCall  /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
2492efb0fa9e11f75af51744a6159530ef7cc8efa24aDaniel Dunbar  /// variables.
24933f88f686e32949ffe02ccb551f482f9cf810358bJohn McCall  void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
24943f88f686e32949ffe02ccb551f482f9cf810358bJohn McCall                                  const std::vector<std::pair<llvm::WeakVH,
24953f88f686e32949ffe02ccb551f482f9cf810358bJohn McCall                                  llvm::Constant*> > &DtorsAndObjects);
2496efb0fa9e11f75af51744a6159530ef7cc8efa24aDaniel Dunbar
2497d26bc76c98006609002d9930f8840490e88ac5b5John McCall  void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2498d26bc76c98006609002d9930f8840490e88ac5b5John McCall                                        const VarDecl *D,
24997ca4850a3e3530fa6c93b64b740446e32c97f992Richard Smith                                        llvm::GlobalVariable *Addr,
25007ca4850a3e3530fa6c93b64b740446e32c97f992Richard Smith                                        bool PerformInit);
2501efb0fa9e11f75af51744a6159530ef7cc8efa24aDaniel Dunbar
2502558d2abc7f9fd6801cc7677200992313ae90b5d8John McCall  void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
250334999876e215b22febc240b1a6dc054215d12f9cFariborz Jahanian
250434999876e215b22febc240b1a6dc054215d12f9cFariborz Jahanian  void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
2505830937bc1100fba7682f7c32c40512085870f50cFariborz Jahanian                                  const Expr *Exp);
25061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
25071a343ebbf413e8eae6b2737b2b2d79cbf5765571John McCall  void enterFullExpression(const ExprWithCleanups *E) {
25081a343ebbf413e8eae6b2737b2b2d79cbf5765571John McCall    if (E->getNumObjects() == 0) return;
25091a343ebbf413e8eae6b2737b2b2d79cbf5765571John McCall    enterNonTrivialFullExpression(E);
25101a343ebbf413e8eae6b2737b2b2d79cbf5765571John McCall  }
25111a343ebbf413e8eae6b2737b2b2d79cbf5765571John McCall  void enterNonTrivialFullExpression(const ExprWithCleanups *E);
25121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
2513756b5c4f9d52642d87d1948bee58f97a4f795b24Anders Carlsson  void EmitCXXThrowExpr(const CXXThrowExpr *E);
25141eb2e59338c4b9c0429fc39ca98662adc9e7a3f2Douglas Gregor
25154c5d8afd100189b6cce4fd89bfb8aec5700acb50Eli Friedman  void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
25164c5d8afd100189b6cce4fd89bfb8aec5700acb50Eli Friedman
2517276b061970939293f1abaf694bd3ef05b2cbda79Eli Friedman  RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = 0);
2518276b061970939293f1abaf694bd3ef05b2cbda79Eli Friedman
25190ffb125996336fc7602b162c0a9e392f1a93060fDaniel Dunbar  //===--------------------------------------------------------------------===//
252077f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge  //                         Annotations Emission
252177f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge  //===--------------------------------------------------------------------===//
252277f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge
252377f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge  /// Emit an annotation call (intrinsic or builtin).
252477f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge  llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
252577f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge                                  llvm::Value *AnnotatedVal,
252677f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge                                  llvm::StringRef AnnotationStr,
252777f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge                                  SourceLocation Location);
252877f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge
252977f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge  /// Emit local annotations for the local variable V, declared by D.
253077f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge  void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
253177f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge
253277f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge  /// Emit field annotations for the given field & value. Returns the
253377f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge  /// annotation result.
253477f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge  llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
253577f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge
253677f68bb90af93b95045fb994e7cd68137adcc132Julien Lerouge  //===--------------------------------------------------------------------===//
25370ffb125996336fc7602b162c0a9e392f1a93060fDaniel Dunbar  //                             Internal Helpers
25380ffb125996336fc7602b162c0a9e392f1a93060fDaniel Dunbar  //===--------------------------------------------------------------------===//
25390dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
25400946ccd1e58c1f1da31ddbca67c5b6301ac8b255Chris Lattner  /// ContainsLabel - Return true if the statement contains a label in it.  If
25410946ccd1e58c1f1da31ddbca67c5b6301ac8b255Chris Lattner  /// this statement is not executed normally, it not containing a label means
25420946ccd1e58c1f1da31ddbca67c5b6301ac8b255Chris Lattner  /// that we can just remove the code.
25430946ccd1e58c1f1da31ddbca67c5b6301ac8b255Chris Lattner  static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
25440dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
2545ef425a69006afaa87751ee41ccf8ff405d9ede70Chris Lattner  /// containsBreak - Return true if the statement contains a break out of it.
2546ef425a69006afaa87751ee41ccf8ff405d9ede70Chris Lattner  /// If the statement (recursively) contains a switch or loop with a break
2547ef425a69006afaa87751ee41ccf8ff405d9ede70Chris Lattner  /// inside of it, this is fine.
2548ef425a69006afaa87751ee41ccf8ff405d9ede70Chris Lattner  static bool containsBreak(const Stmt *S);
2549ef425a69006afaa87751ee41ccf8ff405d9ede70Chris Lattner
25504bc0455d826e9634b7a68c0d06146edd633c9453Daniel Dunbar  /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2551c2c90011a688c04a4e980282f08c267e081c4b00Chris Lattner  /// to a constant, or if it does but contains a label, return false.  If it
2552c2c90011a688c04a4e980282f08c267e081c4b00Chris Lattner  /// constant folds return true and set the boolean result in Result.
2553c2c90011a688c04a4e980282f08c267e081c4b00Chris Lattner  bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
25540dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
2555ef425a69006afaa87751ee41ccf8ff405d9ede70Chris Lattner  /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2556ef425a69006afaa87751ee41ccf8ff405d9ede70Chris Lattner  /// to a constant, or if it does but contains a label, return false.  If it
2557ef425a69006afaa87751ee41ccf8ff405d9ede70Chris Lattner  /// constant folds return true and set the folded value.
2558e1ecdc168175719d74e112bcacd4aae5e12d4631Richard Trieu  bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
2559ef425a69006afaa87751ee41ccf8ff405d9ede70Chris Lattner
256031a0984b5cb4af99d2407c0f25bf5af68df681c6Chris Lattner  /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
256131a0984b5cb4af99d2407c0f25bf5af68df681c6Chris Lattner  /// if statement) to the specified blocks.  Based on the condition, this might
256231a0984b5cb4af99d2407c0f25bf5af68df681c6Chris Lattner  /// try to simplify the codegen of the conditional based on the branch.
25639bc47e29dce8f095be7a6d07dbb02a5a7a112949Chris Lattner  void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
25644bc0455d826e9634b7a68c0d06146edd633c9453Daniel Dunbar                            llvm::BasicBlock *FalseBlock);
2565be07f60131bc6f8d6696f4644df1ef667a1730d5Mike Stump
25664def70d3040e73707c738f7c366737a986135edfRichard Smith  /// \brief Emit a description of a type in a format suitable for passing to
25674def70d3040e73707c738f7c366737a986135edfRichard Smith  /// a runtime sanitizer handler.
25684def70d3040e73707c738f7c366737a986135edfRichard Smith  llvm::Constant *EmitCheckTypeDescriptor(QualType T);
25694def70d3040e73707c738f7c366737a986135edfRichard Smith
25704def70d3040e73707c738f7c366737a986135edfRichard Smith  /// \brief Convert a value into a format suitable for passing to a runtime
25714def70d3040e73707c738f7c366737a986135edfRichard Smith  /// sanitizer handler.
25724def70d3040e73707c738f7c366737a986135edfRichard Smith  llvm::Value *EmitCheckValue(llvm::Value *V);
25734def70d3040e73707c738f7c366737a986135edfRichard Smith
25744def70d3040e73707c738f7c366737a986135edfRichard Smith  /// \brief Emit a description of a source location in a format suitable for
25754def70d3040e73707c738f7c366737a986135edfRichard Smith  /// passing to a runtime sanitizer handler.
25764def70d3040e73707c738f7c366737a986135edfRichard Smith  llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
25774def70d3040e73707c738f7c366737a986135edfRichard Smith
2578ad95481b2769ad61f23afc5e2c31f11c66090657Will Dietz  /// \brief Specify under what conditions this check can be recovered
2579ad95481b2769ad61f23afc5e2c31f11c66090657Will Dietz  enum CheckRecoverableKind {
2580ad95481b2769ad61f23afc5e2c31f11c66090657Will Dietz    /// Always terminate program execution if this check fails
2581ad95481b2769ad61f23afc5e2c31f11c66090657Will Dietz    CRK_Unrecoverable,
2582ad95481b2769ad61f23afc5e2c31f11c66090657Will Dietz    /// Check supports recovering, allows user to specify which
2583ad95481b2769ad61f23afc5e2c31f11c66090657Will Dietz    CRK_Recoverable,
2584ad95481b2769ad61f23afc5e2c31f11c66090657Will Dietz    /// Runtime conditionally aborts, always need to support recovery.
2585ad95481b2769ad61f23afc5e2c31f11c66090657Will Dietz    CRK_AlwaysRecoverable
2586ad95481b2769ad61f23afc5e2c31f11c66090657Will Dietz  };
2587ad95481b2769ad61f23afc5e2c31f11c66090657Will Dietz
2588cc305617e952f8c3a06b63d9225d0dd7769341b7Richard Smith  /// \brief Create a basic block that will call a handler function in a
2589cc305617e952f8c3a06b63d9225d0dd7769341b7Richard Smith  /// sanitizer runtime with the provided arguments, and create a conditional
2590cc305617e952f8c3a06b63d9225d0dd7769341b7Richard Smith  /// branch to it.
25914def70d3040e73707c738f7c366737a986135edfRichard Smith  void EmitCheck(llvm::Value *Checked, StringRef CheckName,
25924def70d3040e73707c738f7c366737a986135edfRichard Smith                 llvm::ArrayRef<llvm::Constant *> StaticArgs,
25938e1cee6f23e2552b96b81e5ef419ab3f69c5b5c2Richard Smith                 llvm::ArrayRef<llvm::Value *> DynamicArgs,
2594ad95481b2769ad61f23afc5e2c31f11c66090657Will Dietz                 CheckRecoverableKind Recoverable);
25959cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer
2596cc305617e952f8c3a06b63d9225d0dd7769341b7Richard Smith  /// \brief Create a basic block that will call the trap intrinsic, and emit a
2597cc305617e952f8c3a06b63d9225d0dd7769341b7Richard Smith  /// conditional branch to it, for the -ftrapv checks.
2598cc305617e952f8c3a06b63d9225d0dd7769341b7Richard Smith  void EmitTrapvCheck(llvm::Value *Checked);
2599cc305617e952f8c3a06b63d9225d0dd7769341b7Richard Smith
260021c9ad9d29d08a287292c670e7c52bc522c7f8bbAnders Carlsson  /// EmitCallArg - Emit a single call argument.
2601413ebdb1af6fb0d81845b61254daf02ba0449afdJohn McCall  void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
260221c9ad9d29d08a287292c670e7c52bc522c7f8bbAnders Carlsson
26032736071ea3a46f90e65c93418961611d96c10ab9John McCall  /// EmitDelegateCallArg - We are performing a delegate call; that
26042736071ea3a46f90e65c93418961611d96c10ab9John McCall  /// is, the current function is delegating to another one.  Produce
26052736071ea3a46f90e65c93418961611d96c10ab9John McCall  /// a r-value suitable for passing the given parameter.
2606413ebdb1af6fb0d81845b61254daf02ba0449afdJohn McCall  void EmitDelegateCallArg(CallArgList &args, const VarDecl *param);
26072736071ea3a46f90e65c93418961611d96c10ab9John McCall
2608c5096cbf7a42e0f9012945b00d9037a5b5a88d72Peter Collingbourne  /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2609c5096cbf7a42e0f9012945b00d9037a5b5a88d72Peter Collingbourne  /// point operation, expressed as the maximum relative error in ulp.
26108250016fb9491fcfde7fce05230d66e267944484Duncan Sands  void SetFPAccuracy(llvm::Value *Val, float Accuracy);
2611c5096cbf7a42e0f9012945b00d9037a5b5a88d72Peter Collingbourne
261231a0984b5cb4af99d2407c0f25bf5af68df681c6Chris Lattnerprivate:
2613c3f8955d7da1019dbe16b0bdf3e49d2e08d988e9Rafael Espindola  llvm::MDNode *getRangeForLoadFromType(QualType Ty);
261429e0bccf2bcce22b877f8b2ed173f564c116b97eDaniel Dunbar  void EmitReturnOfRValue(RValue RV, QualType Ty);
261529e0bccf2bcce22b877f8b2ed173f564c116b97eDaniel Dunbar
26165627377df5439a1d3d46a4e4cef4ae44f84a322bDaniel Dunbar  /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
26175627377df5439a1d3d46a4e4cef4ae44f84a322bDaniel Dunbar  /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
26185627377df5439a1d3d46a4e4cef4ae44f84a322bDaniel Dunbar  ///
26195627377df5439a1d3d46a4e4cef4ae44f84a322bDaniel Dunbar  /// \param AI - The first function argument of the expansion.
26205627377df5439a1d3d46a4e4cef4ae44f84a322bDaniel Dunbar  /// \return The argument following the last expanded function
26215627377df5439a1d3d46a4e4cef4ae44f84a322bDaniel Dunbar  /// argument.
26220dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  llvm::Function::arg_iterator
26235627377df5439a1d3d46a4e4cef4ae44f84a322bDaniel Dunbar  ExpandTypeFromArgs(QualType Ty, LValue Dst,
26245627377df5439a1d3d46a4e4cef4ae44f84a322bDaniel Dunbar                     llvm::Function::arg_iterator AI);
26255627377df5439a1d3d46a4e4cef4ae44f84a322bDaniel Dunbar
26260dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
26270dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// Ty, into individual arguments on the provided vector \arg Args. See
26280dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  /// ABIArgInfo::Expand.
26290dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump  void ExpandTypeToArgs(QualType Ty, RValue Src,
2630686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                        SmallVector<llvm::Value*, 16> &Args,
2631811bf3669f4d82c57fe3cd3c49050fdbc95d0affChris Lattner                        llvm::FunctionType *IRFuncTy);
2632c8c7b187adcd989e01a9fba1ebead6c2abd770c9Anders Carlsson
263342b60551eff3a424e191b293bfd606559dc96bffChad Rosier  llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
2634c8c7b187adcd989e01a9fba1ebead6c2abd770c9Anders Carlsson                            const Expr *InputExpr, std::string &ConstraintStr);
26350dd9e88aa972d80025c66fb3d7df0266b44cad1aMike Stump
263642b60551eff3a424e191b293bfd606559dc96bffChad Rosier  llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
26376d7cfd7ef82e42ff30ee1dafd2883fd94e9f8294Eli Friedman                                  LValue InputValue, QualType InputType,
26386d7cfd7ef82e42ff30ee1dafd2883fd94e9f8294Eli Friedman                                  std::string &ConstraintStr);
26396d7cfd7ef82e42ff30ee1dafd2883fd94e9f8294Eli Friedman
26400139bb96494b4c4ba0824617d5d2495dc7e44c76Anders Carlsson  /// EmitCallArgs - Emit call arguments for a function.
26411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  /// The CallArgTypeInfo parameter is used for iterating over the known
2642af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson  /// argument types of the function being called.
2643af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson  template<typename T>
2644af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson  void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo,
26450139bb96494b4c4ba0824617d5d2495dc7e44c76Anders Carlsson                    CallExpr::const_arg_iterator ArgBeg,
2646af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson                    CallExpr::const_arg_iterator ArgEnd) {
2647af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson      CallExpr::const_arg_iterator Arg = ArgBeg;
2648af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson
2649af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson    // First, use the argument types that the type info knows about
2650af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson    if (CallArgTypeInfo) {
2651af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson      for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(),
2652af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson           E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) {
265344b0a3e858af7b19f489619e52cd58970611cd15Eli Friedman        assert(Arg != ArgEnd && "Running over edge of argument list!");
2654af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson        QualType ArgType = *I;
2655745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian#ifndef NDEBUG
2656745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian        QualType ActualArgType = Arg->getType();
2657745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian        if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
26589cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer          QualType ActualBaseType =
2659745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian            ActualArgType->getAs<PointerType>()->getPointeeType();
26609cac4942b920d4c5514e71949e3062ed626bfbdfMichael J. Spencer          QualType ArgBaseType =
2661745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian            ArgType->getAs<PointerType>()->getPointeeType();
2662745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian          if (ArgBaseType->isVariableArrayType()) {
2663745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian            if (const VariableArrayType *VAT =
2664745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian                getContext().getAsVariableArrayType(ActualBaseType)) {
2665745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian              if (!VAT->getSizeExpr())
2666745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian                ActualArgType = ArgType;
2667745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian            }
2668745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian          }
2669745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian        }
2670af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson        assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
26711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump               getTypePtr() ==
2672745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian               getContext().getCanonicalType(ActualArgType).getTypePtr() &&
2673af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson               "type mismatch in call argument!");
2674745da3a5bb4ea35f93f50301e7fbbb7d78d3b6bbFariborz Jahanian#endif
2675413ebdb1af6fb0d81845b61254daf02ba0449afdJohn McCall        EmitCallArg(Args, *Arg, ArgType);
2676af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson      }
26771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
26781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump      // Either we've emitted all the call args, or we have a call to a
2679af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson      // variadic function.
26801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump      assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) &&
2681af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson             "Extra arguments in non-variadic function!");
26821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
2683af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson    }
26841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
2685af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson    // If we still have any arguments, emit them using the type of the argument.
2686413ebdb1af6fb0d81845b61254daf02ba0449afdJohn McCall    for (; Arg != ArgEnd; ++Arg)
2687413ebdb1af6fb0d81845b61254daf02ba0449afdJohn McCall      EmitCallArg(Args, *Arg, Arg->getType());
2688af23f69aa6247e6bd20a66b2e16babb91f192535Anders Carlsson  }
2689492c4f998d848673d3d6c9e6416115df4036a71dJohn McCall
2690492c4f998d848673d3d6c9e6416115df4036a71dJohn McCall  const TargetCodeGenInfo &getTargetHooks() const {
2691492c4f998d848673d3d6c9e6416115df4036a71dJohn McCall    return CGM.getTargetCodeGenInfo();
2692492c4f998d848673d3d6c9e6416115df4036a71dJohn McCall  }
2693744016dde06fcffd50931e94a98c850f8b12cd87John McCall
2694744016dde06fcffd50931e94a98c850f8b12cd87John McCall  void EmitDeclMetadata();
2695f0c11f7e6848f023ced6a5b51399ba787c7d4d0bJohn McCall
2696f0c11f7e6848f023ced6a5b51399ba787c7d4d0bJohn McCall  CodeGenModule::ByrefHelpers *
26972acc6e3feda5e4f7d9009bdcf8b1cd777fecfe2dChris Lattner  buildByrefHelpers(llvm::StructType &byrefType,
2698f0c11f7e6848f023ced6a5b51399ba787c7d4d0bJohn McCall                    const AutoVarEmission &emission);
2699b49bd27b334a6c4e3bf9d810a7d5b022578f1194Dan Gohman
2700b49bd27b334a6c4e3bf9d810a7d5b022578f1194Dan Gohman  void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
2701f4c3db175101cbf94dad59419c3ed7aed51bf606Jay Foad
2702ea93e40785ffeadfac66b948c95f9490ec26207aEli Friedman  /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2703ea93e40785ffeadfac66b948c95f9490ec26207aEli Friedman  /// value and compute our best estimate of the alignment of the pointee.
2704ea93e40785ffeadfac66b948c95f9490ec26207aEli Friedman  std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
27055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer};
27061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
2707150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall/// Helper class with most of the code for saving a value for a
2708150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall/// conditional expression cleanup.
2709804b807ea918184d6de63bd745e1ff75a9bfc679John McCallstruct DominatingLLVMValue {
2710150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2711150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
2712150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  /// Answer whether the given value needs extra work to be saved.
2713150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  static bool needsSaving(llvm::Value *value) {
2714150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    // If it's not an instruction, we don't need to save.
2715150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    if (!isa<llvm::Instruction>(value)) return false;
2716150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
2717150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    // If it's an instruction in the entry block, we don't need to save.
2718150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2719150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    return (block != &block->getParent()->getEntryBlock());
2720150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  }
2721150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
2722150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  /// Try to save the given value.
2723150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2724150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    if (!needsSaving(value)) return saved_type(value, false);
2725150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
2726150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    // Otherwise we need an alloca.
2727150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    llvm::Value *alloca =
2728150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall      CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2729150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    CGF.Builder.CreateStore(value, alloca);
2730150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
2731150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    return saved_type(alloca, true);
2732150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  }
2733150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
2734150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2735150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    if (!value.getInt()) return value.getPointer();
2736150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall    return CGF.Builder.CreateLoad(value.getPointer());
2737150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  }
2738150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall};
2739150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
2740804b807ea918184d6de63bd745e1ff75a9bfc679John McCall/// A partial specialization of DominatingValue for llvm::Values that
2741804b807ea918184d6de63bd745e1ff75a9bfc679John McCall/// might be llvm::Instructions.
2742804b807ea918184d6de63bd745e1ff75a9bfc679John McCalltemplate <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2743804b807ea918184d6de63bd745e1ff75a9bfc679John McCall  typedef T *type;
2744804b807ea918184d6de63bd745e1ff75a9bfc679John McCall  static type restore(CodeGenFunction &CGF, saved_type value) {
2745804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2746804b807ea918184d6de63bd745e1ff75a9bfc679John McCall  }
2747804b807ea918184d6de63bd745e1ff75a9bfc679John McCall};
2748804b807ea918184d6de63bd745e1ff75a9bfc679John McCall
2749804b807ea918184d6de63bd745e1ff75a9bfc679John McCall/// A specialization of DominatingValue for RValue.
2750804b807ea918184d6de63bd745e1ff75a9bfc679John McCalltemplate <> struct DominatingValue<RValue> {
2751804b807ea918184d6de63bd745e1ff75a9bfc679John McCall  typedef RValue type;
2752804b807ea918184d6de63bd745e1ff75a9bfc679John McCall  class saved_type {
2753804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2754804b807ea918184d6de63bd745e1ff75a9bfc679John McCall                AggregateAddress, ComplexAddress };
2755804b807ea918184d6de63bd745e1ff75a9bfc679John McCall
2756804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    llvm::Value *Value;
2757804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    Kind K;
2758804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2759804b807ea918184d6de63bd745e1ff75a9bfc679John McCall
2760804b807ea918184d6de63bd745e1ff75a9bfc679John McCall  public:
2761804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    static bool needsSaving(RValue value);
2762804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    static saved_type save(CodeGenFunction &CGF, RValue value);
2763804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    RValue restore(CodeGenFunction &CGF);
2764804b807ea918184d6de63bd745e1ff75a9bfc679John McCall
2765804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    // implementations in CGExprCXX.cpp
2766804b807ea918184d6de63bd745e1ff75a9bfc679John McCall  };
2767804b807ea918184d6de63bd745e1ff75a9bfc679John McCall
2768804b807ea918184d6de63bd745e1ff75a9bfc679John McCall  static bool needsSaving(type value) {
2769804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    return saved_type::needsSaving(value);
2770804b807ea918184d6de63bd745e1ff75a9bfc679John McCall  }
2771804b807ea918184d6de63bd745e1ff75a9bfc679John McCall  static saved_type save(CodeGenFunction &CGF, type value) {
2772804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    return saved_type::save(CGF, value);
2773804b807ea918184d6de63bd745e1ff75a9bfc679John McCall  }
2774150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  static type restore(CodeGenFunction &CGF, saved_type value) {
2775804b807ea918184d6de63bd745e1ff75a9bfc679John McCall    return value.restore(CGF);
2776150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall  }
2777150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall};
2778150b462afc7a713edd19bcbbbb22381fe060d4f5John McCall
27795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}  // end namespace CodeGen
27805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}  // end namespace clang
27814e1524babb095e70de1da882573eb6fbee98a857Fariborz Jahanian
27825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif
2783