blob: 7bbf788eb528bc60d0ddee174c3f7ff9655d9753 [file] [log] [blame]
Daniel Dunbarbd012ff2008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Reid Spencer5f016e22007-07-11 17:01:13 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Reid Spencer5f016e22007-07-11 17:01:13 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stump0dd9e882009-02-08 23:14:22 +000010// This is the internal per-function state used for llvm translation.
Reid Spencer5f016e22007-07-11 17:01:13 +000011//
12//===----------------------------------------------------------------------===//
13
Chris Lattneref52a2f2008-02-29 17:10:38 +000014#ifndef CLANG_CODEGEN_CODEGENFUNCTION_H
15#define CLANG_CODEGEN_CODEGENFUNCTION_H
Reid Spencer5f016e22007-07-11 17:01:13 +000016
Daniel Dunbar45d196b2008-11-01 01:53:16 +000017#include "CGBuilder.h"
Reid Kleckner6fe91e42013-06-09 16:45:02 +000018#include "CGCleanup.h"
Eric Christopherc3287792011-10-19 00:43:52 +000019#include "CGDebugInfo.h"
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000020#include "CGValue.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000021#include "CodeGenModule.h"
22#include "clang/AST/CharUnits.h"
23#include "clang/AST/ExprCXX.h"
24#include "clang/AST/ExprObjC.h"
25#include "clang/AST/Type.h"
26#include "clang/Basic/ABI.h"
Ben Langmuir524387a2013-05-09 19:17:11 +000027#include "clang/Basic/CapturedStmt.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000028#include "clang/Basic/TargetInfo.h"
29#include "clang/Frontend/CodeGenOptions.h"
30#include "llvm/ADT/ArrayRef.h"
31#include "llvm/ADT/DenseMap.h"
32#include "llvm/ADT/SmallVector.h"
33#include "llvm/Support/Debug.h"
34#include "llvm/Support/ValueHandle.h"
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000035
Reid Spencer5f016e22007-07-11 17:01:13 +000036namespace llvm {
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000037 class BasicBlock;
Benjamin Kramerf21efe92009-08-11 17:46:57 +000038 class LLVMContext;
David Chisnalldd5c98f2010-05-01 11:15:56 +000039 class MDNode;
Reid Spencer5f016e22007-07-11 17:01:13 +000040 class Module;
Daniel Dunbar898d5082008-09-30 01:06:03 +000041 class SwitchInst;
Daniel Dunbar259e9cc2009-10-19 01:21:05 +000042 class Twine;
Daniel Dunbared3849b2008-11-19 09:36:46 +000043 class Value;
John McCallf1549f62010-07-06 01:34:17 +000044 class CallSite;
Reid Spencer5f016e22007-07-11 17:01:13 +000045}
46
47namespace clang {
48 class ASTContext;
John McCall1a343eb2011-11-10 08:15:53 +000049 class BlockDecl;
Anders Carlsson7267c162009-05-29 21:03:38 +000050 class CXXDestructorDecl;
Richard Smithad762fc2011-04-14 22:09:26 +000051 class CXXForRangeStmt;
Anders Carlsson6815e942009-09-27 18:58:34 +000052 class CXXTryStmt;
Reid Spencer5f016e22007-07-11 17:01:13 +000053 class Decl;
Chris Lattnerad8dcf42011-02-17 07:39:24 +000054 class LabelDecl;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000055 class EnumConstantDecl;
Reid Spencer5f016e22007-07-11 17:01:13 +000056 class FunctionDecl;
Douglas Gregor72564e72009-02-26 23:50:07 +000057 class FunctionProtoType;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000058 class LabelStmt;
Fariborz Jahanian679a5022009-01-10 21:06:09 +000059 class ObjCContainerDecl;
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +000060 class ObjCInterfaceDecl;
61 class ObjCIvarDecl;
Chris Lattner391d77a2008-03-30 23:03:07 +000062 class ObjCMethodDecl;
Fariborz Jahanianfef30b52008-12-09 20:23:04 +000063 class ObjCImplementationDecl;
Daniel Dunbaraf05bb92008-08-26 08:29:31 +000064 class ObjCPropertyImplDecl;
Reid Spencer5f016e22007-07-11 17:01:13 +000065 class TargetInfo;
John McCall492c4f92010-03-03 04:15:11 +000066 class TargetCodeGenInfo;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000067 class VarDecl;
Chris Lattner16f00492009-04-26 01:32:48 +000068 class ObjCForCollectionStmt;
69 class ObjCAtTryStmt;
70 class ObjCAtThrowStmt;
71 class ObjCAtSynchronizedStmt;
John McCallf85e1932011-06-15 23:02:42 +000072 class ObjCAutoreleasePoolStmt;
Devang Patelb84a06e2007-10-23 02:10:49 +000073
Reid Spencer5f016e22007-07-11 17:01:13 +000074namespace CodeGen {
Devang Patelb84a06e2007-10-23 02:10:49 +000075 class CodeGenTypes;
Daniel Dunbarbb36d332009-02-02 21:43:58 +000076 class CGFunctionInfo;
Mike Stump0dd9e882009-02-08 23:14:22 +000077 class CGRecordLayout;
John McCallee504292010-05-21 04:11:14 +000078 class CGBlockInfo;
John McCall4c40d982010-08-31 07:33:07 +000079 class CGCXXABI;
John McCalld16c2cf2011-02-08 08:22:06 +000080 class BlockFlags;
81 class BlockFieldFlags;
Mike Stump0dd9e882009-02-08 23:14:22 +000082
John McCall9d232c82013-03-07 21:37:08 +000083/// The kind of evaluation to perform on values of a particular
84/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
85/// CGExprAgg?
86///
87/// TODO: should vectors maybe be split out into their own thing?
88enum TypeEvaluationKind {
89 TEK_Scalar,
90 TEK_Complex,
91 TEK_Aggregate
92};
93
Reid Spencer5f016e22007-07-11 17:01:13 +000094/// CodeGenFunction - This class organizes the per-function state that is used
95/// while generating LLVM code.
John McCall5936e332011-02-15 09:22:45 +000096class CodeGenFunction : public CodeGenTypeCache {
Dmitri Gribenkof56faa02012-09-15 20:20:27 +000097 CodeGenFunction(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
98 void operator=(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
John McCall4c40d982010-08-31 07:33:07 +000099
100 friend class CGCXXABI;
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +0000101public:
John McCallff8e1152010-07-23 21:56:41 +0000102 /// A jump destination is an abstract label, branching to which may
103 /// require a jump out through normal cleanups.
John McCallf1549f62010-07-06 01:34:17 +0000104 struct JumpDest {
John McCallff8e1152010-07-23 21:56:41 +0000105 JumpDest() : Block(0), ScopeDepth(), Index(0) {}
106 JumpDest(llvm::BasicBlock *Block,
107 EHScopeStack::stable_iterator Depth,
108 unsigned Index)
109 : Block(Block), ScopeDepth(Depth), Index(Index) {}
110
111 bool isValid() const { return Block != 0; }
112 llvm::BasicBlock *getBlock() const { return Block; }
113 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
114 unsigned getDestIndex() const { return Index; }
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000115
Nadav Rotem495cfa42013-03-23 06:43:35 +0000116 // This should be used cautiously.
117 void setScopeDepth(EHScopeStack::stable_iterator depth) {
118 ScopeDepth = depth;
119 }
120
John McCallff8e1152010-07-23 21:56:41 +0000121 private:
John McCallf1549f62010-07-06 01:34:17 +0000122 llvm::BasicBlock *Block;
123 EHScopeStack::stable_iterator ScopeDepth;
John McCallff8e1152010-07-23 21:56:41 +0000124 unsigned Index;
125 };
126
Reid Spencer5f016e22007-07-11 17:01:13 +0000127 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar444be732009-11-13 05:51:54 +0000128 const TargetInfo &Target;
Mike Stump0dd9e882009-02-08 23:14:22 +0000129
Chris Lattner58dee102007-08-21 16:57:55 +0000130 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Daniel Dunbar45d196b2008-11-01 01:53:16 +0000131 CGBuilderTy Builder;
Mike Stump0dd9e882009-02-08 23:14:22 +0000132
John McCallf5ebf9b2013-05-03 07:33:41 +0000133 /// CurFuncDecl - Holds the Decl for the current outermost
134 /// non-closure context.
Chris Lattner41110242008-06-17 18:05:57 +0000135 const Decl *CurFuncDecl;
Chris Lattnerb5437d22009-04-23 05:30:27 +0000136 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
137 const Decl *CurCodeDecl;
Daniel Dunbar88b53962009-02-02 22:03:45 +0000138 const CGFunctionInfo *CurFnInfo;
Chris Lattner391d77a2008-03-30 23:03:07 +0000139 QualType FnRetTy;
Reid Spencer5f016e22007-07-11 17:01:13 +0000140 llvm::Function *CurFn;
141
Mike Stump6a1e0eb2009-12-04 23:26:17 +0000142 /// CurGD - The GlobalDecl for the current function being compiled.
143 GlobalDecl CurGD;
Mike Stump6a1e0eb2009-12-04 23:26:17 +0000144
John McCallf85e1932011-06-15 23:02:42 +0000145 /// PrologueCleanupDepth - The cleanup depth enclosing all the
146 /// cleanups associated with the parameters.
147 EHScopeStack::stable_iterator PrologueCleanupDepth;
148
Daniel Dunbar5ca20842008-09-09 21:00:17 +0000149 /// ReturnBlock - Unified return block.
John McCallf1549f62010-07-06 01:34:17 +0000150 JumpDest ReturnBlock;
151
Mike Stump0dd9e882009-02-08 23:14:22 +0000152 /// ReturnValue - The temporary alloca to hold the return value. This is null
Sylvestre Ledruf3477c12012-09-27 10:16:10 +0000153 /// iff the function has no return value.
Eli Friedmanb17daf92009-12-04 02:43:40 +0000154 llvm::Value *ReturnValue;
Mike Stump0dd9e882009-02-08 23:14:22 +0000155
Reid Spencer5f016e22007-07-11 17:01:13 +0000156 /// AllocaInsertPoint - This is an instruction in the entry block before which
157 /// we prefer to insert allocas.
Chris Lattner481769b2009-03-31 22:17:44 +0000158 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +0000159
Ben Langmuir524387a2013-05-09 19:17:11 +0000160 /// \brief API for captured statement code generation.
161 class CGCapturedStmtInfo {
162 public:
163 explicit CGCapturedStmtInfo(const CapturedStmt &S,
164 CapturedRegionKind K = CR_Default)
165 : Kind(K), ThisValue(0), CXXThisFieldDecl(0) {
166
167 RecordDecl::field_iterator Field =
168 S.getCapturedRecordDecl()->field_begin();
169 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
170 E = S.capture_end();
171 I != E; ++I, ++Field) {
172 if (I->capturesThis())
173 CXXThisFieldDecl = *Field;
174 else
175 CaptureFields[I->getCapturedVar()] = *Field;
176 }
177 }
178
179 virtual ~CGCapturedStmtInfo();
180
181 CapturedRegionKind getKind() const { return Kind; }
182
183 void setContextValue(llvm::Value *V) { ThisValue = V; }
184 // \brief Retrieve the value of the context parameter.
185 llvm::Value *getContextValue() const { return ThisValue; }
186
187 /// \brief Lookup the captured field decl for a variable.
188 const FieldDecl *lookup(const VarDecl *VD) const {
189 return CaptureFields.lookup(VD);
190 }
191
192 bool isCXXThisExprCaptured() const { return CXXThisFieldDecl != 0; }
193 FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
194
195 /// \brief Emit the captured statement body.
196 virtual void EmitBody(CodeGenFunction &CGF, Stmt *S) {
197 CGF.EmitStmt(S);
198 }
199
200 /// \brief Get the name of the capture helper.
201 virtual StringRef getHelperName() const { return "__captured_stmt"; }
202
203 private:
204 /// \brief The kind of captured statement being generated.
205 CapturedRegionKind Kind;
206
207 /// \brief Keep the map between VarDecl and FieldDecl.
208 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
209
210 /// \brief The base address of the captured record, passed in as the first
211 /// argument of the parallel region function.
212 llvm::Value *ThisValue;
213
214 /// \brief Captured 'this' type.
215 FieldDecl *CXXThisFieldDecl;
216 };
217 CGCapturedStmtInfo *CapturedStmtInfo;
218
Nuno Lopesb3198a82012-05-08 22:10:46 +0000219 /// BoundsChecking - Emit run-time bounds checks. Higher values mean
220 /// potentially higher performance penalties.
221 unsigned char BoundsChecking;
222
Richard Smithd6396a62012-11-05 22:21:05 +0000223 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
224 /// calls to EmitTypeCheck can be skipped.
225 bool SanitizePerformTypeCheck;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000226
Will Dietz4f45bc02013-01-18 11:30:38 +0000227 /// \brief Sanitizer options to use for this function.
228 const SanitizerOptions *SanOpts;
229
John McCallf85e1932011-06-15 23:02:42 +0000230 /// In ARC, whether we should autorelease the return value.
231 bool AutoreleaseResult;
232
John McCalld16c2cf2011-02-08 08:22:06 +0000233 const CodeGen::CGBlockInfo *BlockInfo;
234 llvm::Value *BlockPointer;
235
Eli Friedmancec5ebd2012-02-11 02:57:39 +0000236 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
237 FieldDecl *LambdaThisCaptureField;
238
Douglas Gregor3d91bbc2010-05-17 15:52:46 +0000239 /// \brief A mapping from NRVO variables to the flags used to indicate
240 /// when the NRVO has been applied to this variable.
241 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000242
John McCallf1549f62010-07-06 01:34:17 +0000243 EHScopeStack EHStack;
Richard Smith8a07cd32013-06-12 20:42:33 +0000244 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
245
246 /// Header for data within LifetimeExtendedCleanupStack.
247 struct LifetimeExtendedCleanupHeader {
248 /// The size of the following cleanup object.
249 size_t Size : 29;
250 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
251 unsigned Kind : 3;
252
253 size_t getSize() const { return Size; }
254 CleanupKind getKind() const { return static_cast<CleanupKind>(Kind); }
255 };
John McCallf1549f62010-07-06 01:34:17 +0000256
John McCallff8e1152010-07-23 21:56:41 +0000257 /// i32s containing the indexes of the cleanup destinations.
258 llvm::AllocaInst *NormalCleanupDest;
John McCallff8e1152010-07-23 21:56:41 +0000259
260 unsigned NextCleanupDestIndex;
261
John McCall1a343eb2011-11-10 08:15:53 +0000262 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
263 CGBlockInfo *FirstBlockInfo;
264
John McCall777d6e52011-08-11 02:22:43 +0000265 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
266 llvm::BasicBlock *EHResumeBlock;
267
Bill Wendling285cfd82011-09-19 20:31:14 +0000268 /// The exception slot. All landing pads write the current exception pointer
269 /// into this alloca.
John McCallf1549f62010-07-06 01:34:17 +0000270 llvm::Value *ExceptionSlot;
271
Bill Wendling285cfd82011-09-19 20:31:14 +0000272 /// The selector slot. Under the MandatoryCleanup model, all landing pads
273 /// write the current selector value into this alloca.
John McCall93c332a2011-05-28 21:13:02 +0000274 llvm::AllocaInst *EHSelectorSlot;
275
John McCallf1549f62010-07-06 01:34:17 +0000276 /// Emits a landing pad for the current EH stack.
277 llvm::BasicBlock *EmitLandingPad();
278
279 llvm::BasicBlock *getInvokeDestImpl();
280
John McCall150b4622011-01-26 04:00:11 +0000281 template <class T>
John McCall804b8072011-01-28 10:53:53 +0000282 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
283 return DominatingValue<T>::save(*this, value);
John McCall150b4622011-01-26 04:00:11 +0000284 }
285
Daniel Dunbar18ccc772008-09-28 01:03:14 +0000286public:
Anders Carlssonfa1f7562009-02-10 06:07:49 +0000287 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
288 /// rethrows.
Chris Lattner686775d2011-07-20 06:58:45 +0000289 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stump0dd9e882009-02-08 23:14:22 +0000290
John McCalld768e9d2011-06-22 02:32:12 +0000291 /// A class controlling the emission of a finally block.
292 class FinallyInfo {
293 /// Where the catchall's edge through the cleanup should go.
294 JumpDest RethrowDest;
Anders Carlssonbb66f9f2009-02-08 07:46:24 +0000295
John McCalld768e9d2011-06-22 02:32:12 +0000296 /// A function to call to enter the catch.
297 llvm::Constant *BeginCatchFn;
298
299 /// An i1 variable indicating whether or not the @finally is
300 /// running for an exception.
301 llvm::AllocaInst *ForEHVar;
302
303 /// An i8* variable into which the exception pointer to rethrow
304 /// has been saved.
305 llvm::AllocaInst *SavedExnVar;
306
307 public:
308 void enter(CodeGenFunction &CGF, const Stmt *Finally,
309 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
310 llvm::Constant *rethrowFn);
311 void exit(CodeGenFunction &CGF);
312 };
Mike Stumpd88ea562009-12-09 03:35:49 +0000313
John McCall150b4622011-01-26 04:00:11 +0000314 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
315 /// current full-expression. Safe against the possibility that
316 /// we're currently inside a conditionally-evaluated expression.
John McCall3ad32c82011-01-28 08:37:24 +0000317 template <class T, class A0>
318 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
319 // If we're not in a conditional branch, or if none of the
320 // arguments requires saving, then use the unconditional cleanup.
John McCallc4a1a842011-07-12 00:15:30 +0000321 if (!isInConditionalBranch())
322 return EHStack.pushCleanup<T>(kind, a0);
John McCall3ad32c82011-01-28 08:37:24 +0000323
John McCall804b8072011-01-28 10:53:53 +0000324 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCall3ad32c82011-01-28 08:37:24 +0000325
326 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
327 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
328 initFullExprCleanup();
329 }
330
331 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
332 /// current full-expression. Safe against the possibility that
333 /// we're currently inside a conditionally-evaluated expression.
John McCall150b4622011-01-26 04:00:11 +0000334 template <class T, class A0, class A1>
335 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
336 // If we're not in a conditional branch, or if none of the
337 // arguments requires saving, then use the unconditional cleanup.
John McCallc4a1a842011-07-12 00:15:30 +0000338 if (!isInConditionalBranch())
339 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCall150b4622011-01-26 04:00:11 +0000340
John McCall804b8072011-01-28 10:53:53 +0000341 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
342 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCall150b4622011-01-26 04:00:11 +0000343
344 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCall3ad32c82011-01-28 08:37:24 +0000345 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
346 initFullExprCleanup();
John McCall150b4622011-01-26 04:00:11 +0000347 }
348
Douglas Gregord7b23162011-06-22 16:12:01 +0000349 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
350 /// current full-expression. Safe against the possibility that
351 /// we're currently inside a conditionally-evaluated expression.
352 template <class T, class A0, class A1, class A2>
353 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
354 // If we're not in a conditional branch, or if none of the
355 // arguments requires saving, then use the unconditional cleanup.
356 if (!isInConditionalBranch()) {
John McCallc4a1a842011-07-12 00:15:30 +0000357 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregord7b23162011-06-22 16:12:01 +0000358 }
359
360 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
361 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
362 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
363
364 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
365 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
366 initFullExprCleanup();
367 }
368
John McCall9928c482011-07-12 16:41:08 +0000369 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
370 /// current full-expression. Safe against the possibility that
371 /// we're currently inside a conditionally-evaluated expression.
372 template <class T, class A0, class A1, class A2, class A3>
373 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
374 // If we're not in a conditional branch, or if none of the
375 // arguments requires saving, then use the unconditional cleanup.
376 if (!isInConditionalBranch()) {
377 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
378 }
379
380 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
381 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
382 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
383 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
384
385 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
386 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
387 a2_saved, a3_saved);
388 initFullExprCleanup();
389 }
390
Richard Smith8a07cd32013-06-12 20:42:33 +0000391 /// \brief Queue a cleanup to be pushed after finishing the current
392 /// full-expression.
393 template <class T, class A0, class A1, class A2, class A3>
394 void pushCleanupAfterFullExpr(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
395 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
396
397 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
398
399 size_t OldSize = LifetimeExtendedCleanupStack.size();
400 LifetimeExtendedCleanupStack.resize(
401 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
402
403 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
404 new (Buffer) LifetimeExtendedCleanupHeader(Header);
405 new (Buffer + sizeof(Header)) T(a0, a1, a2, a3);
406 }
407
John McCall6f103ba2011-11-10 10:43:54 +0000408 /// Set up the last cleaup that was pushed as a conditional
409 /// full-expression cleanup.
410 void initFullExprCleanup();
411
John McCallf1549f62010-07-06 01:34:17 +0000412 /// PushDestructorCleanup - Push a cleanup to call the
413 /// complete-object destructor of an object of the given type at the
414 /// given address. Does nothing if T is not a C++ class type with a
415 /// non-trivial destructor.
416 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
417
John McCall81407d42010-07-21 06:29:51 +0000418 /// PushDestructorCleanup - Push a cleanup to call the
419 /// complete-object variant of the given destructor on the object at
420 /// the given address.
421 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
422 llvm::Value *Addr);
423
John McCallf1549f62010-07-06 01:34:17 +0000424 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
425 /// process all branch fixups.
Adrian Prantl1c3db762013-05-16 00:41:26 +0000426 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallf1549f62010-07-06 01:34:17 +0000427
John McCall7d8647f2010-09-14 07:57:04 +0000428 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
429 /// The block cannot be reactivated. Pops it if it's the top of the
430 /// stack.
John McCall6f103ba2011-11-10 10:43:54 +0000431 ///
432 /// \param DominatingIP - An instruction which is known to
433 /// dominate the current IP (if set) and which lies along
434 /// all paths of execution between the current IP and the
435 /// the point at which the cleanup comes into scope.
436 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
437 llvm::Instruction *DominatingIP);
John McCall7d8647f2010-09-14 07:57:04 +0000438
439 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
440 /// Cannot be used to resurrect a deactivated cleanup.
John McCall6f103ba2011-11-10 10:43:54 +0000441 ///
442 /// \param DominatingIP - An instruction which is known to
443 /// dominate the current IP (if set) and which lies along
444 /// all paths of execution between the current IP and the
445 /// the point at which the cleanup comes into scope.
446 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
447 llvm::Instruction *DominatingIP);
John McCallcd2d2b72010-08-13 21:20:51 +0000448
John McCallf1549f62010-07-06 01:34:17 +0000449 /// \brief Enters a new scope for capturing cleanups, all of which
450 /// will be executed once the scope is exited.
451 class RunCleanupsScope {
John McCallf1549f62010-07-06 01:34:17 +0000452 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith8a07cd32013-06-12 20:42:33 +0000453 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000454 bool OldDidCallStackSave;
John McCalled383132013-03-01 01:24:35 +0000455 protected:
Douglas Gregor5656e142009-11-24 21:15:44 +0000456 bool PerformCleanup;
John McCalled383132013-03-01 01:24:35 +0000457 private:
Douglas Gregor01234bb2009-11-24 16:43:22 +0000458
Dmitri Gribenkof56faa02012-09-15 20:20:27 +0000459 RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
460 void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000461
Eric Christopherc3287792011-10-19 00:43:52 +0000462 protected:
463 CodeGenFunction& CGF;
Will Dietz4f45bc02013-01-18 11:30:38 +0000464
Douglas Gregor01234bb2009-11-24 16:43:22 +0000465 public:
466 /// \brief Enter a new cleanup scope.
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000467 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christopherc3287792011-10-19 00:43:52 +0000468 : PerformCleanup(true), CGF(CGF)
Douglas Gregor5656e142009-11-24 21:15:44 +0000469 {
John McCallf1549f62010-07-06 01:34:17 +0000470 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith8a07cd32013-06-12 20:42:33 +0000471 LifetimeExtendedCleanupStackSize =
472 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor01234bb2009-11-24 16:43:22 +0000473 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis4ada2ca2010-09-14 00:42:34 +0000474 CGF.DidCallStackSave = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000475 }
476
477 /// \brief Exit this cleanup scope, emitting any accumulated
478 /// cleanups.
John McCallf1549f62010-07-06 01:34:17 +0000479 ~RunCleanupsScope() {
Douglas Gregor5656e142009-11-24 21:15:44 +0000480 if (PerformCleanup) {
481 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith8a07cd32013-06-12 20:42:33 +0000482 CGF.PopCleanupBlocks(CleanupStackDepth,
483 LifetimeExtendedCleanupStackSize);
Douglas Gregor5656e142009-11-24 21:15:44 +0000484 }
485 }
486
487 /// \brief Determine whether this scope requires any cleanups.
488 bool requiresCleanups() const {
John McCallf1549f62010-07-06 01:34:17 +0000489 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor5656e142009-11-24 21:15:44 +0000490 }
491
492 /// \brief Force the emission of cleanups now, instead of waiting
493 /// until this object is destroyed.
494 void ForceCleanup() {
495 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor01234bb2009-11-24 16:43:22 +0000496 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith8a07cd32013-06-12 20:42:33 +0000497 CGF.PopCleanupBlocks(CleanupStackDepth,
498 LifetimeExtendedCleanupStackSize);
Douglas Gregor5656e142009-11-24 21:15:44 +0000499 PerformCleanup = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000500 }
501 };
502
Eric Christopherc3287792011-10-19 00:43:52 +0000503 class LexicalScope: protected RunCleanupsScope {
504 SourceRange Range;
Nadav Rotem495cfa42013-03-23 06:43:35 +0000505 SmallVector<const LabelDecl*, 4> Labels;
506 LexicalScope *ParentScope;
Eric Christopherc3287792011-10-19 00:43:52 +0000507
Dmitri Gribenkof56faa02012-09-15 20:20:27 +0000508 LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
509 void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
Eric Christopherc3287792011-10-19 00:43:52 +0000510
511 public:
512 /// \brief Enter a new cleanup scope.
513 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem495cfa42013-03-23 06:43:35 +0000514 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
515 CGF.CurLexicalScope = this;
Eric Christopherc3287792011-10-19 00:43:52 +0000516 if (CGDebugInfo *DI = CGF.getDebugInfo())
517 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
518 }
519
Nadav Rotem495cfa42013-03-23 06:43:35 +0000520 void addLabel(const LabelDecl *label) {
521 assert(PerformCleanup && "adding label to dead scope?");
522 Labels.push_back(label);
523 }
524
Eric Christopherc3287792011-10-19 00:43:52 +0000525 /// \brief Exit this cleanup scope, emitting any accumulated
526 /// cleanups.
527 ~LexicalScope() {
Adrian Prantlefb72ad2013-04-01 19:02:06 +0000528 if (CGDebugInfo *DI = CGF.getDebugInfo())
529 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
530
Nadav Rotem495cfa42013-03-23 06:43:35 +0000531 // If we should perform a cleanup, force them now. Note that
532 // this ends the cleanup scope before rescoping any labels.
533 if (PerformCleanup) ForceCleanup();
Eric Christopherc3287792011-10-19 00:43:52 +0000534 }
535
536 /// \brief Force the emission of cleanups now, instead of waiting
537 /// until this object is destroyed.
538 void ForceCleanup() {
Nadav Rotem495cfa42013-03-23 06:43:35 +0000539 CGF.CurLexicalScope = ParentScope;
Adrian Prantlefb72ad2013-04-01 19:02:06 +0000540 RunCleanupsScope::ForceCleanup();
541
Nadav Rotem495cfa42013-03-23 06:43:35 +0000542 if (!Labels.empty())
543 rescopeLabels();
Eric Christopherc3287792011-10-19 00:43:52 +0000544 }
Nadav Rotem495cfa42013-03-23 06:43:35 +0000545
546 void rescopeLabels();
Eric Christopherc3287792011-10-19 00:43:52 +0000547 };
548
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000549
Richard Smith8a07cd32013-06-12 20:42:33 +0000550 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
551 /// that have been added.
Adrian Prantl1c3db762013-05-16 00:41:26 +0000552 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000553
Richard Smith8a07cd32013-06-12 20:42:33 +0000554 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
555 /// that have been added, then adds all lifetime-extended cleanups from
556 /// the given position to the stack.
557 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
558 size_t OldLifetimeExtendedStackSize);
559
John McCallff8e1152010-07-23 21:56:41 +0000560 void ResolveBranchFixups(llvm::BasicBlock *Target);
561
John McCallf1549f62010-07-06 01:34:17 +0000562 /// The given basic block lies in the current EH scope, but may be a
563 /// target of a potentially scope-crossing jump; get a stable handle
564 /// to which we can perform this jump later.
John McCallff8e1152010-07-23 21:56:41 +0000565 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCall413e6772010-07-28 01:07:35 +0000566 return JumpDest(Target,
567 EHStack.getInnermostNormalCleanup(),
568 NextCleanupDestIndex++);
John McCallf1549f62010-07-06 01:34:17 +0000569 }
Anders Carlssonc71c8452009-02-07 23:50:39 +0000570
John McCallf1549f62010-07-06 01:34:17 +0000571 /// The given basic block lies in the current EH scope, but may be a
572 /// target of a potentially scope-crossing jump; get a stable handle
573 /// to which we can perform this jump later.
Chris Lattner686775d2011-07-20 06:58:45 +0000574 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallff8e1152010-07-23 21:56:41 +0000575 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallf1549f62010-07-06 01:34:17 +0000576 }
577
578 /// EmitBranchThroughCleanup - Emit a branch from the current insert
579 /// block through the normal cleanup handling code (if any) and then
580 /// on to \arg Dest.
581 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerb11f9192011-04-17 00:54:30 +0000582
583 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
584 /// specified destination obviously has no cleanups to run. 'false' is always
585 /// a conservatively correct answer for this method.
586 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
John McCallf1549f62010-07-06 01:34:17 +0000587
John McCall777d6e52011-08-11 02:22:43 +0000588 /// popCatchScope - Pops the catch scope at the top of the EHScope
589 /// stack, emitting any required code (other than the catch handlers
590 /// themselves).
591 void popCatchScope();
John McCallff8e1152010-07-23 21:56:41 +0000592
David Chisnallc6860042012-11-07 16:50:40 +0000593 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall777d6e52011-08-11 02:22:43 +0000594 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stump0dd9e882009-02-08 23:14:22 +0000595
John McCall150b4622011-01-26 04:00:11 +0000596 /// An object to manage conditionally-evaluated expressions.
597 class ConditionalEvaluation {
598 llvm::BasicBlock *StartBB;
Mike Stump1eb44332009-09-09 15:08:12 +0000599
John McCall150b4622011-01-26 04:00:11 +0000600 public:
601 ConditionalEvaluation(CodeGenFunction &CGF)
602 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000603
John McCall150b4622011-01-26 04:00:11 +0000604 void begin(CodeGenFunction &CGF) {
605 assert(CGF.OutermostConditional != this);
606 if (!CGF.OutermostConditional)
607 CGF.OutermostConditional = this;
608 }
609
610 void end(CodeGenFunction &CGF) {
611 assert(CGF.OutermostConditional != 0);
612 if (CGF.OutermostConditional == this)
613 CGF.OutermostConditional = 0;
614 }
615
616 /// Returns a block which will be executed prior to each
617 /// evaluation of the conditional code.
618 llvm::BasicBlock *getStartingBlock() const {
619 return StartBB;
620 }
621 };
Mike Stump1eb44332009-09-09 15:08:12 +0000622
John McCall3019c442010-09-17 00:50:28 +0000623 /// isInConditionalBranch - Return true if we're currently emitting
624 /// one branch or the other of a conditional expression.
John McCall150b4622011-01-26 04:00:11 +0000625 bool isInConditionalBranch() const { return OutermostConditional != 0; }
626
John McCall6f103ba2011-11-10 10:43:54 +0000627 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
628 assert(isInConditionalBranch());
629 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
630 new llvm::StoreInst(value, addr, &block->back());
631 }
632
John McCall150b4622011-01-26 04:00:11 +0000633 /// An RAII object to record that we're evaluating a statement
634 /// expression.
635 class StmtExprEvaluation {
636 CodeGenFunction &CGF;
637
638 /// We have to save the outermost conditional: cleanups in a
639 /// statement expression aren't conditional just because the
640 /// StmtExpr is.
641 ConditionalEvaluation *SavedOutermostConditional;
642
643 public:
644 StmtExprEvaluation(CodeGenFunction &CGF)
645 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
646 CGF.OutermostConditional = 0;
647 }
648
649 ~StmtExprEvaluation() {
650 CGF.OutermostConditional = SavedOutermostConditional;
651 CGF.EnsureInsertPoint();
652 }
653 };
John McCalle996ffd2011-02-16 08:02:54 +0000654
John McCall56ca35d2011-02-17 10:25:35 +0000655 /// An object which temporarily prevents a value from being
656 /// destroyed by aggressive peephole optimizations that assume that
657 /// all uses of a value have been realized in the IR.
658 class PeepholeProtection {
659 llvm::Instruction *Inst;
660 friend class CodeGenFunction;
661
662 public:
663 PeepholeProtection() : Inst(0) {}
John McCall4b9c2d22011-11-06 09:01:30 +0000664 };
John McCall56ca35d2011-02-17 10:25:35 +0000665
John McCall4b9c2d22011-11-06 09:01:30 +0000666 /// A non-RAII class containing all the information about a bound
667 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
668 /// this which makes individual mappings very simple; using this
669 /// class directly is useful when you have a variable number of
670 /// opaque values or don't want the RAII functionality for some
671 /// reason.
672 class OpaqueValueMappingData {
John McCalle996ffd2011-02-16 08:02:54 +0000673 const OpaqueValueExpr *OpaqueValue;
John McCall56ca35d2011-02-17 10:25:35 +0000674 bool BoundLValue;
675 CodeGenFunction::PeepholeProtection Protection;
John McCalle996ffd2011-02-16 08:02:54 +0000676
John McCall4b9c2d22011-11-06 09:01:30 +0000677 OpaqueValueMappingData(const OpaqueValueExpr *ov,
678 bool boundLValue)
679 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCalle996ffd2011-02-16 08:02:54 +0000680 public:
John McCall4b9c2d22011-11-06 09:01:30 +0000681 OpaqueValueMappingData() : OpaqueValue(0) {}
682
John McCall56ca35d2011-02-17 10:25:35 +0000683 static bool shouldBindAsLValue(const Expr *expr) {
John McCalla5493f82011-11-08 22:54:08 +0000684 // gl-values should be bound as l-values for obvious reasons.
685 // Records should be bound as l-values because IR generation
686 // always keeps them in memory. Expressions of function type
687 // act exactly like l-values but are formally required to be
688 // r-values in C.
689 return expr->isGLValue() ||
690 expr->getType()->isRecordType() ||
691 expr->getType()->isFunctionType();
John McCall56ca35d2011-02-17 10:25:35 +0000692 }
693
John McCall4b9c2d22011-11-06 09:01:30 +0000694 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
695 const OpaqueValueExpr *ov,
696 const Expr *e) {
697 if (shouldBindAsLValue(ov))
698 return bind(CGF, ov, CGF.EmitLValue(e));
699 return bind(CGF, ov, CGF.EmitAnyExpr(e));
700 }
701
702 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
703 const OpaqueValueExpr *ov,
704 const LValue &lv) {
705 assert(shouldBindAsLValue(ov));
706 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
707 return OpaqueValueMappingData(ov, true);
708 }
709
710 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
711 const OpaqueValueExpr *ov,
712 const RValue &rv) {
713 assert(!shouldBindAsLValue(ov));
714 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
715
716 OpaqueValueMappingData data(ov, false);
717
718 // Work around an extremely aggressive peephole optimization in
719 // EmitScalarConversion which assumes that all other uses of a
720 // value are extant.
721 data.Protection = CGF.protectFromPeepholes(rv);
722
723 return data;
724 }
725
726 bool isValid() const { return OpaqueValue != 0; }
727 void clear() { OpaqueValue = 0; }
728
729 void unbind(CodeGenFunction &CGF) {
730 assert(OpaqueValue && "no data to unbind!");
731
732 if (BoundLValue) {
733 CGF.OpaqueLValues.erase(OpaqueValue);
734 } else {
735 CGF.OpaqueRValues.erase(OpaqueValue);
736 CGF.unprotectFromPeepholes(Protection);
737 }
738 }
739 };
740
741 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
742 class OpaqueValueMapping {
743 CodeGenFunction &CGF;
744 OpaqueValueMappingData Data;
745
746 public:
747 static bool shouldBindAsLValue(const Expr *expr) {
748 return OpaqueValueMappingData::shouldBindAsLValue(expr);
749 }
750
John McCall56ca35d2011-02-17 10:25:35 +0000751 /// Build the opaque value mapping for the given conditional
752 /// operator if it's the GNU ?: extension. This is a common
753 /// enough pattern that the convenience operator is really
754 /// helpful.
755 ///
756 OpaqueValueMapping(CodeGenFunction &CGF,
757 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCall4b9c2d22011-11-06 09:01:30 +0000758 if (isa<ConditionalOperator>(op))
759 // Leave Data empty.
John McCall56ca35d2011-02-17 10:25:35 +0000760 return;
John McCall56ca35d2011-02-17 10:25:35 +0000761
762 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCall4b9c2d22011-11-06 09:01:30 +0000763 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
764 e->getCommon());
John McCall56ca35d2011-02-17 10:25:35 +0000765 }
766
John McCalle996ffd2011-02-16 08:02:54 +0000767 OpaqueValueMapping(CodeGenFunction &CGF,
768 const OpaqueValueExpr *opaqueValue,
John McCall56ca35d2011-02-17 10:25:35 +0000769 LValue lvalue)
John McCall4b9c2d22011-11-06 09:01:30 +0000770 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCall56ca35d2011-02-17 10:25:35 +0000771 }
772
773 OpaqueValueMapping(CodeGenFunction &CGF,
774 const OpaqueValueExpr *opaqueValue,
775 RValue rvalue)
John McCall4b9c2d22011-11-06 09:01:30 +0000776 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCalle996ffd2011-02-16 08:02:54 +0000777 }
778
779 void pop() {
John McCall4b9c2d22011-11-06 09:01:30 +0000780 Data.unbind(CGF);
781 Data.clear();
John McCalle996ffd2011-02-16 08:02:54 +0000782 }
783
784 ~OpaqueValueMapping() {
John McCall4b9c2d22011-11-06 09:01:30 +0000785 if (Data.isValid()) Data.unbind(CGF);
John McCalle996ffd2011-02-16 08:02:54 +0000786 }
787 };
Fariborz Jahaniane2204552010-11-16 19:29:39 +0000788
789 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
790 /// number that holds the value.
791 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian52a80e12011-01-26 23:08:27 +0000792
793 /// BuildBlockByrefAddress - Computes address location of the
794 /// variable which is declared as __block.
795 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
796 const VarDecl *V);
Chris Lattner7f02f722007-08-24 05:35:26 +0000797private:
Chris Lattnerd9becd12009-10-28 23:59:40 +0000798 CGDebugInfo *DebugInfo;
Devang Patelaa112892011-03-07 18:45:56 +0000799 bool DisableDebugInfo;
Mike Stump09429b92009-02-17 17:00:02 +0000800
Manman Ren63fd4082013-03-20 16:59:38 +0000801 /// If the current function returns 'this', use the field to keep track of
802 /// the callee that returns 'this'.
803 llvm::Value *CalleeWithThisReturn;
804
John McCall93c332a2011-05-28 21:13:02 +0000805 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
806 /// calling llvm.stacksave for multiple VLAs in the same scope.
807 bool DidCallStackSave;
808
Mike Stumpf71d2322009-11-30 20:08:49 +0000809 /// IndirectBranch - The first time an indirect goto is seen we create a block
810 /// with an indirect branch. Every time we see the address of a label taken,
811 /// we add the label to the indirect goto. Every subsequent indirect goto is
812 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattnerd9becd12009-10-28 23:59:40 +0000813 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +0000814
Mike Stump0dd9e882009-02-08 23:14:22 +0000815 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
816 /// decls.
John McCall6b5a61b2011-02-07 10:33:21 +0000817 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
818 DeclMapTy LocalDeclMap;
Reid Spencer5f016e22007-07-11 17:01:13 +0000819
820 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerad8dcf42011-02-17 07:39:24 +0000821 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stump0dd9e882009-02-08 23:14:22 +0000822
Mike Stump0dd9e882009-02-08 23:14:22 +0000823 // BreakContinueStack - This keeps track of where break and continue
Anders Carlssone4b6d342009-02-10 05:52:02 +0000824 // statements should jump to.
Chris Lattnerda138702007-07-16 21:28:45 +0000825 struct BreakContinue {
John McCallf1549f62010-07-06 01:34:17 +0000826 BreakContinue(JumpDest Break, JumpDest Continue)
827 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stump0dd9e882009-02-08 23:14:22 +0000828
John McCallf1549f62010-07-06 01:34:17 +0000829 JumpDest BreakBlock;
830 JumpDest ContinueBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +0000831 };
Chris Lattner686775d2011-07-20 06:58:45 +0000832 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbar18ccc772008-09-28 01:03:14 +0000833
Zhongxing Xu170fd492012-01-14 09:08:15 +0000834 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stump0dd9e882009-02-08 23:14:22 +0000835 /// current context is not in a switch.
Devang Patel51b09f22007-10-04 23:45:31 +0000836 llvm::SwitchInst *SwitchInsn;
837
Mike Stump0dd9e882009-02-08 23:14:22 +0000838 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel80fd5f92007-10-09 17:08:50 +0000839 /// statement range in current switch instruction.
Devang Patelc049e4f2007-10-08 20:57:48 +0000840 llvm::BasicBlock *CaseRangeBlock;
841
John McCall56ca35d2011-02-17 10:25:35 +0000842 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCalle996ffd2011-02-16 08:02:54 +0000843 /// expressions.
John McCall56ca35d2011-02-17 10:25:35 +0000844 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
845 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCalle996ffd2011-02-16 08:02:54 +0000846
Mike Stump0dd9e882009-02-08 23:14:22 +0000847 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedmanbbed6b92009-08-15 02:50:32 +0000848 // We track this by the size expression rather than the type itself because
849 // in certain situations, like a const qualifier applied to an VLA typedef,
850 // multiple VLA types can share the same size expression.
Mike Stump0dd9e882009-02-08 23:14:22 +0000851 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
852 // enter/leave scopes.
Eli Friedmanbbed6b92009-08-15 02:50:32 +0000853 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stump0dd9e882009-02-08 23:14:22 +0000854
John McCallf1549f62010-07-06 01:34:17 +0000855 /// A block containing a single 'unreachable' instruction. Created
856 /// lazily by getUnreachableBlock().
857 llvm::BasicBlock *UnreachableBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +0000858
Adrian Prantld072e592013-05-03 20:11:48 +0000859 /// Counts of the number return expressions in the function.
860 unsigned NumReturnExprs;
Adrian Prantlfa6b0792013-05-02 17:30:20 +0000861
862 /// Count the number of simple (constant) return expressions in the function.
863 unsigned NumSimpleReturnExprs;
864
Adrian Prantld072e592013-05-03 20:11:48 +0000865 /// The last regular (non-return) debug location (breakpoint) in the function.
866 SourceLocation LastStopPoint;
Adrian Prantlfa6b0792013-05-02 17:30:20 +0000867
Richard Smithc3bf52c2013-04-20 22:23:05 +0000868public:
869 /// A scope within which we are constructing the fields of an object which
870 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
871 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
872 class FieldConstructionScope {
873 public:
874 FieldConstructionScope(CodeGenFunction &CGF, llvm::Value *This)
875 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
876 CGF.CXXDefaultInitExprThis = This;
877 }
878 ~FieldConstructionScope() {
879 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
880 }
881
882 private:
883 CodeGenFunction &CGF;
884 llvm::Value *OldCXXDefaultInitExprThis;
885 };
886
887 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
888 /// is overridden to be the object under construction.
889 class CXXDefaultInitExprScope {
890 public:
891 CXXDefaultInitExprScope(CodeGenFunction &CGF)
892 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue) {
893 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis;
894 }
895 ~CXXDefaultInitExprScope() {
896 CGF.CXXThisValue = OldCXXThisValue;
897 }
898
899 public:
900 CodeGenFunction &CGF;
901 llvm::Value *OldCXXThisValue;
902 };
903
904private:
Anders Carlssonf6c56e22009-11-25 03:15:49 +0000905 /// CXXThisDecl - When generating code for a C++ member function,
906 /// this will hold the implicit 'this' declaration.
Eli Friedmancec5ebd2012-02-11 02:57:39 +0000907 ImplicitParamDecl *CXXABIThisDecl;
908 llvm::Value *CXXABIThisValue;
John McCall25049412010-02-16 22:04:33 +0000909 llvm::Value *CXXThisValue;
Mike Stump1eb44332009-09-09 15:08:12 +0000910
Richard Smithc3bf52c2013-04-20 22:23:05 +0000911 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
912 /// this expression.
913 llvm::Value *CXXDefaultInitExprThis;
914
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +0000915 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
916 /// destructor, this will hold the implicit argument (e.g. VTT).
917 ImplicitParamDecl *CXXStructorImplicitParamDecl;
918 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000919
John McCall150b4622011-01-26 04:00:11 +0000920 /// OutermostConditional - Points to the outermost active
921 /// conditional control. This is used so that we know if a
922 /// temporary should be destroyed conditionally.
923 ConditionalEvaluation *OutermostConditional;
Mike Stump1eb44332009-09-09 15:08:12 +0000924
Nadav Rotem495cfa42013-03-23 06:43:35 +0000925 /// The current lexical scope.
926 LexicalScope *CurLexicalScope;
Anders Carlsson7dfa4072009-09-12 02:14:24 +0000927
Adrian Prantl1c3db762013-05-16 00:41:26 +0000928 /// The current source location that should be used for exception
929 /// handling code.
930 SourceLocation CurEHLocation;
931
Anders Carlsson7dfa4072009-09-12 02:14:24 +0000932 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
933 /// type as well as the field number that contains the actual data.
Chris Lattner2acc6e32011-07-18 04:24:23 +0000934 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson7dfa4072009-09-12 02:14:24 +0000935 unsigned> > ByRefValueInfo;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000936
John McCallf1549f62010-07-06 01:34:17 +0000937 llvm::BasicBlock *TerminateLandingPad;
Mike Stump182f3832009-12-10 00:02:42 +0000938 llvm::BasicBlock *TerminateHandler;
Chris Lattner83252dc2010-07-20 21:07:09 +0000939 llvm::BasicBlock *TrapBB;
Eli Friedman94067052009-12-10 02:21:21 +0000940
Tanya Lattner0df579e2012-07-09 22:06:01 +0000941 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
942 /// In the kernel metadata node, reference the kernel function and metadata
943 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Gouly37453b92013-03-08 09:42:32 +0000944 /// - A node for the vec_type_hint(<type>) qualifier contains string
945 /// "vec_type_hint", an undefined value of the <type> data type,
946 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattner0df579e2012-07-09 22:06:01 +0000947 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
948 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
949 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
950 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
951 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
952 llvm::Function *Fn);
953
Reid Spencer5f016e22007-07-11 17:01:13 +0000954public:
Fariborz Jahanian4904bf42012-06-26 16:06:38 +0000955 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall1a343eb2011-11-10 08:15:53 +0000956 ~CodeGenFunction();
Mike Stump0dd9e882009-02-08 23:14:22 +0000957
John McCall1e7fe752010-09-02 09:58:18 +0000958 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCallf2aac842011-05-15 02:34:36 +0000959 ASTContext &getContext() const { return CGM.getContext(); }
Alexey Samsonova240df22012-10-16 07:22:28 +0000960 /// Returns true if DebugInfo is actually initialized.
961 bool maybeInitializeDebugInfo() {
962 if (CGM.getModuleDebugInfo()) {
963 DebugInfo = CGM.getModuleDebugInfo();
964 return true;
965 }
966 return false;
967 }
Devang Patelaa112892011-03-07 18:45:56 +0000968 CGDebugInfo *getDebugInfo() {
969 if (DisableDebugInfo)
970 return NULL;
971 return DebugInfo;
972 }
973 void disableDebugInfo() { DisableDebugInfo = true; }
974 void enableDebugInfo() { DisableDebugInfo = false; }
975
John McCallf85e1932011-06-15 23:02:42 +0000976 bool shouldUseFusedARCCalls() {
977 return CGM.getCodeGenOpts().OptimizationLevel == 0;
978 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000979
David Blaikie4e4d0842012-03-11 07:00:24 +0000980 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCalld16c2cf2011-02-08 08:22:06 +0000981
Bill Wendling285cfd82011-09-19 20:31:14 +0000982 /// Returns a pointer to the function's exception object and selector slot,
983 /// which is assigned in every landing pad.
John McCallf1549f62010-07-06 01:34:17 +0000984 llvm::Value *getExceptionSlot();
John McCall93c332a2011-05-28 21:13:02 +0000985 llvm::Value *getEHSelectorSlot();
John McCallf1549f62010-07-06 01:34:17 +0000986
Bill Wendlingae270592011-09-15 18:57:19 +0000987 /// Returns the contents of the function's exception object and selector
988 /// slots.
989 llvm::Value *getExceptionFromSlot();
990 llvm::Value *getSelectorFromSlot();
991
John McCallff8e1152010-07-23 21:56:41 +0000992 llvm::Value *getNormalCleanupDestSlot();
John McCallff8e1152010-07-23 21:56:41 +0000993
John McCallf1549f62010-07-06 01:34:17 +0000994 llvm::BasicBlock *getUnreachableBlock() {
995 if (!UnreachableBlock) {
996 UnreachableBlock = createBasicBlock("unreachable");
997 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
998 }
999 return UnreachableBlock;
1000 }
1001
1002 llvm::BasicBlock *getInvokeDest() {
1003 if (!EHStack.requiresLandingPad()) return 0;
1004 return getInvokeDestImpl();
1005 }
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001006
John McCall64aa4b32013-04-16 22:48:15 +00001007 const TargetInfo &getTarget() const { return Target; }
John McCalld16c2cf2011-02-08 08:22:06 +00001008 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Anderson69243822009-07-13 04:10:07 +00001009
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001010 //===--------------------------------------------------------------------===//
John McCallbdc4d802011-07-09 01:37:26 +00001011 // Cleanups
1012 //===--------------------------------------------------------------------===//
1013
1014 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1015
John McCall2673c682011-07-11 08:38:19 +00001016 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1017 llvm::Value *arrayEndPointer,
1018 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001019 Destroyer *destroyer);
John McCall2673c682011-07-11 08:38:19 +00001020 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1021 llvm::Value *arrayEnd,
1022 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001023 Destroyer *destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001024
John McCall9928c482011-07-12 16:41:08 +00001025 void pushDestroy(QualType::DestructionKind dtorKind,
1026 llvm::Value *addr, QualType type);
John McCall074cae02013-02-01 05:11:40 +00001027 void pushEHDestroy(QualType::DestructionKind dtorKind,
1028 llvm::Value *addr, QualType type);
John McCallbdc4d802011-07-09 01:37:26 +00001029 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001030 Destroyer *destroyer, bool useEHCleanupForArray);
Richard Smith8a07cd32013-06-12 20:42:33 +00001031 void pushLifetimeExtendedDestroy(CleanupKind kind, llvm::Value *addr,
1032 QualType type, Destroyer *destroyer,
1033 bool useEHCleanupForArray);
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001034 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall2673c682011-07-11 08:38:19 +00001035 bool useEHCleanupForArray);
John McCalla91f6662011-07-13 03:01:35 +00001036 llvm::Function *generateDestroyHelper(llvm::Constant *addr,
1037 QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001038 Destroyer *destroyer,
John McCalla91f6662011-07-13 03:01:35 +00001039 bool useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001040 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001041 QualType type, Destroyer *destroyer,
John McCallfbf780a2011-07-13 08:09:46 +00001042 bool checkZeroLength, bool useEHCleanup);
John McCallbdc4d802011-07-09 01:37:26 +00001043
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001044 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall9928c482011-07-12 16:41:08 +00001045
John McCallbdc4d802011-07-09 01:37:26 +00001046 /// Determines whether an EH cleanup is required to destroy a type
1047 /// with the given destruction kind.
1048 bool needsEHCleanup(QualType::DestructionKind kind) {
1049 switch (kind) {
1050 case QualType::DK_none:
1051 return false;
1052 case QualType::DK_cxx_destructor:
1053 case QualType::DK_objc_weak_lifetime:
David Blaikie4e4d0842012-03-11 07:00:24 +00001054 return getLangOpts().Exceptions;
John McCallbdc4d802011-07-09 01:37:26 +00001055 case QualType::DK_objc_strong_lifetime:
David Blaikie4e4d0842012-03-11 07:00:24 +00001056 return getLangOpts().Exceptions &&
John McCallbdc4d802011-07-09 01:37:26 +00001057 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1058 }
1059 llvm_unreachable("bad destruction kind");
1060 }
1061
John McCall9928c482011-07-12 16:41:08 +00001062 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1063 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1064 }
1065
John McCallbdc4d802011-07-09 01:37:26 +00001066 //===--------------------------------------------------------------------===//
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001067 // Objective-C
1068 //===--------------------------------------------------------------------===//
1069
Chris Lattner391d77a2008-03-30 23:03:07 +00001070 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001071
Mike Stump0dd9e882009-02-08 23:14:22 +00001072 void StartObjCMethod(const ObjCMethodDecl *MD,
Devang Patel8d3f8972011-05-19 23:37:41 +00001073 const ObjCContainerDecl *CD,
1074 SourceLocation StartLoc);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001075
Mike Stump0dd9e882009-02-08 23:14:22 +00001076 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001077 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1078 const ObjCPropertyImplDecl *PID);
John McCall1e1f4872011-09-13 03:34:09 +00001079 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanianb6e5fe32012-01-07 18:56:22 +00001080 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanian490a52b2012-05-29 19:56:01 +00001081 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanianb6e5fe32012-01-07 18:56:22 +00001082 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian2846b972011-02-18 19:15:13 +00001083
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001084 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1085 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001086
Mike Stump0dd9e882009-02-08 23:14:22 +00001087 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1088 /// for the given property.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001089 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1090 const ObjCPropertyImplDecl *PID);
John McCall71c758d2011-09-10 09:17:20 +00001091 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahaniancd93b962012-01-06 22:33:54 +00001092 const ObjCPropertyImplDecl *propImpl,
1093 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian0b2bd472010-04-13 00:38:05 +00001094 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian15bd5882010-04-13 18:32:24 +00001095 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001096
Mike Stump4e7a1f72009-02-21 20:00:35 +00001097 //===--------------------------------------------------------------------===//
1098 // Block Bits
1099 //===--------------------------------------------------------------------===//
1100
John McCall6b5a61b2011-02-07 10:33:21 +00001101 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall1a343eb2011-11-10 08:15:53 +00001102 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1103 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garst2a7eb282010-02-23 21:51:17 +00001104 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanian89ecd412010-08-04 16:57:49 +00001105 const CGBlockInfo &Info,
Chris Lattner2acc6e32011-07-18 04:24:23 +00001106 llvm::StructType *,
John McCalld16c2cf2011-02-08 08:22:06 +00001107 llvm::Constant *BlockVarLayout);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001108
Fariborz Jahanian564360b2010-06-24 00:08:06 +00001109 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall6b5a61b2011-02-07 10:33:21 +00001110 const CGBlockInfo &Info,
Eli Friedman64bee652012-02-25 02:48:22 +00001111 const DeclMapTy &ldm,
1112 bool IsLambdaConversionToBlock);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001113
John McCalld16c2cf2011-02-08 08:22:06 +00001114 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1115 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahanian20abee62012-01-10 00:37:01 +00001116 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1117 const ObjCPropertyImplDecl *PID);
1118 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1119 const ObjCPropertyImplDecl *PID);
Eli Friedmancae40c42012-02-28 01:08:45 +00001120 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCalld16c2cf2011-02-08 08:22:06 +00001121
John McCalld16c2cf2011-02-08 08:22:06 +00001122 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1123
John McCall5af02db2011-03-31 01:59:53 +00001124 class AutoVarEmission;
1125
1126 void emitByrefStructureInit(const AutoVarEmission &emission);
1127 void enterByrefCleanup(const AutoVarEmission &emission);
1128
John McCall6b5a61b2011-02-07 10:33:21 +00001129 llvm::Value *LoadBlockStruct() {
1130 assert(BlockPointer && "no block pointer set!");
1131 return BlockPointer;
1132 }
Mike Stump4e7a1f72009-02-21 20:00:35 +00001133
John McCallea1471e2010-05-20 01:18:31 +00001134 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCallf4b88a42012-03-10 09:33:50 +00001135 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall6b5a61b2011-02-07 10:33:21 +00001136 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001137 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stumpdab514f2009-03-04 03:23:46 +00001138
John McCalld26bc762011-03-09 04:27:21 +00001139 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1140 const CGFunctionInfo &FnInfo);
John McCallf5ebf9b2013-05-03 07:33:41 +00001141 void StartFunction(GlobalDecl GD,
1142 QualType RetTy,
Daniel Dunbar7c086512008-09-09 23:14:03 +00001143 llvm::Function *Fn,
John McCalld26bc762011-03-09 04:27:21 +00001144 const CGFunctionInfo &FnInfo,
Daniel Dunbar2284ac92008-10-18 18:22:23 +00001145 const FunctionArgList &Args,
Tilmann Scheller9c6082f2011-03-02 21:36:49 +00001146 SourceLocation StartLoc);
Daniel Dunbara448fb22008-11-11 23:11:34 +00001147
John McCall9fc6a772010-02-19 09:25:03 +00001148 void EmitConstructorBody(FunctionArgList &Args);
1149 void EmitDestructorBody(FunctionArgList &Args);
Lang Hames56c00c42013-02-17 07:22:09 +00001150 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
John McCall9fc6a772010-02-19 09:25:03 +00001151 void EmitFunctionBody(FunctionArgList &Args);
John McCalla355e072010-02-18 03:17:58 +00001152
Eli Friedman64bee652012-02-25 02:48:22 +00001153 void EmitForwardingCallToLambda(const CXXRecordDecl *Lambda,
1154 CallArgList &CallArgs);
Eli Friedmanbd89f8c2012-02-16 01:37:33 +00001155 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman64bee652012-02-25 02:48:22 +00001156 void EmitLambdaBlockInvokeBody();
Douglas Gregor27dd7d92012-02-17 03:02:34 +00001157 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1158 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Eli Friedmanbd89f8c2012-02-16 01:37:33 +00001159
Mike Stump0dd9e882009-02-08 23:14:22 +00001160 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1161 /// emission when possible.
David Blaikie0a0f93c2013-02-01 19:09:49 +00001162 void EmitReturnBlock();
Daniel Dunbar1c1d6072009-01-26 23:27:52 +00001163
Mike Stump0dd9e882009-02-08 23:14:22 +00001164 /// FinishFunction - Complete IR generation of the current function. It is
1165 /// legal to call this function even if there is no current insertion point.
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001166 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001167
Anders Carlsson519c3282010-03-24 00:39:18 +00001168 /// GenerateThunk - Generate a thunk for the given method.
John McCalld26bc762011-03-09 04:27:21 +00001169 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1170 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001171
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00001172 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1173 GlobalDecl GD, const ThunkInfo &Thunk);
1174
Douglas Gregorfb8cc252010-05-05 05:51:00 +00001175 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1176 FunctionArgList &Args);
Mike Stump1eb44332009-09-09 15:08:12 +00001177
Eli Friedmanb74ed082012-02-14 02:31:03 +00001178 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
1179 ArrayRef<VarDecl *> ArrayIndexes);
1180
Anders Carlssond103f9f2010-03-28 19:40:00 +00001181 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1182 /// subobject.
1183 ///
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001184 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001185 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001186 CharUnits OffsetFromNearestVBase,
Anders Carlssond103f9f2010-03-28 19:40:00 +00001187 llvm::Constant *VTable,
1188 const CXXRecordDecl *VTableClass);
1189
1190 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001191 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001192 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001193 CharUnits OffsetFromNearestVBase,
Anders Carlsson603d6d12010-03-28 21:07:49 +00001194 bool BaseIsNonVirtualPrimaryBase,
1195 llvm::Constant *VTable,
1196 const CXXRecordDecl *VTableClass,
1197 VisitedVirtualBasesSetTy& VBases);
Eli Friedman77a259c2009-12-08 06:46:18 +00001198
Anders Carlsson603d6d12010-03-28 21:07:49 +00001199 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001200
Dan Gohman043fb9a2010-10-26 18:44:08 +00001201 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1202 /// to by This.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001203 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001204
John McCall50da2ca2010-07-21 05:30:47 +00001205 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1206 /// given phase of destruction for a destructor. The end result
1207 /// should call destructors on members and base classes in reverse
1208 /// order of their construction.
1209 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump1eb44332009-09-09 15:08:12 +00001210
Chris Lattner7255a2d2010-06-22 00:03:40 +00001211 /// ShouldInstrumentFunction - Return true if the current function should be
1212 /// instrumented with __cyg_profile_func_* calls
1213 bool ShouldInstrumentFunction();
1214
1215 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1216 /// instrumentation function with the current function and the call site, if
1217 /// function instrumentation is enabled.
1218 void EmitFunctionInstrumentation(const char *Fn);
1219
Roman Divackybe4c8702011-02-10 16:52:03 +00001220 /// EmitMCountInstrumentation - Emit call to .mcount.
1221 void EmitMCountInstrumentation();
1222
Mike Stump0dd9e882009-02-08 23:14:22 +00001223 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1224 /// arguments for the given function. This is also responsible for naming the
1225 /// LLVM function arguments.
Daniel Dunbar88b53962009-02-02 22:03:45 +00001226 void EmitFunctionProlog(const CGFunctionInfo &FI,
1227 llvm::Function *Fn,
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001228 const FunctionArgList &Args);
1229
Mike Stump0dd9e882009-02-08 23:14:22 +00001230 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1231 /// given temporary.
Adrian Prantlfa6b0792013-05-02 17:30:20 +00001232 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc);
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001233
Mike Stumpcce3d4f2009-12-07 23:38:24 +00001234 /// EmitStartEHSpec - Emit the start of the exception spec.
1235 void EmitStartEHSpec(const Decl *D);
1236
1237 /// EmitEndEHSpec - Emit the end of the exception spec.
1238 void EmitEndEHSpec(const Decl *D);
1239
John McCallf1549f62010-07-06 01:34:17 +00001240 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1241 llvm::BasicBlock *getTerminateLandingPad();
1242
1243 /// getTerminateHandler - Return a handler (not a landing pad, just
1244 /// a catch handler) that just calls terminate. This is used when
1245 /// a terminate scope encloses a try.
Mike Stump9b39c512009-12-09 22:59:31 +00001246 llvm::BasicBlock *getTerminateHandler();
1247
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001248 llvm::Type *ConvertTypeForMem(QualType T);
1249 llvm::Type *ConvertType(QualType T);
1250 llvm::Type *ConvertType(const TypeDecl *T) {
John McCallbff225e2010-02-16 04:15:37 +00001251 return ConvertType(getContext().getTypeDeclType(T));
1252 }
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001253
Mike Stump0dd9e882009-02-08 23:14:22 +00001254 /// LoadObjCSelf - Load the value of self. This function is only valid while
1255 /// generating code for an Objective-C method.
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001256 llvm::Value *LoadObjCSelf();
Mike Stump0dd9e882009-02-08 23:14:22 +00001257
1258 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanian45012a72009-02-03 00:09:52 +00001259 QualType TypeOfSelfObject();
Chris Lattner41110242008-06-17 18:05:57 +00001260
Reid Spencer5f016e22007-07-11 17:01:13 +00001261 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1262 /// an aggregate LLVM type or is void.
John McCall9d232c82013-03-07 21:37:08 +00001263 static TypeEvaluationKind getEvaluationKind(QualType T);
1264
1265 static bool hasScalarEvaluationKind(QualType T) {
1266 return getEvaluationKind(T) == TEK_Scalar;
1267 }
1268
1269 static bool hasAggregateEvaluationKind(QualType T) {
1270 return getEvaluationKind(T) == TEK_Aggregate;
1271 }
Daniel Dunbar55e87422008-11-11 02:29:29 +00001272
1273 /// createBasicBlock - Create an LLVM basic block.
Richard Smith4def70d2012-10-09 19:52:38 +00001274 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
John McCalld16c2cf2011-02-08 08:22:06 +00001275 llvm::Function *parent = 0,
1276 llvm::BasicBlock *before = 0) {
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001277#ifdef NDEBUG
John McCalld16c2cf2011-02-08 08:22:06 +00001278 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001279#else
John McCalld16c2cf2011-02-08 08:22:06 +00001280 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001281#endif
Daniel Dunbar55e87422008-11-11 02:29:29 +00001282 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001283
Reid Spencer5f016e22007-07-11 17:01:13 +00001284 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1285 /// label maps to.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001286 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001287
Mike Stumpf71d2322009-11-30 20:08:49 +00001288 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1289 /// another basic block, simplify it. This assumes that no other code could
1290 /// potentially reference the basic block.
Daniel Dunbaraa5bd872009-04-01 04:37:47 +00001291 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1292
Mike Stump0dd9e882009-02-08 23:14:22 +00001293 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1294 /// adding a fall-through branch from the current insert block if
1295 /// necessary. It is legal to call this function even if there is no current
1296 /// insertion point.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001297 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001298 /// IsFinished - If true, indicates that the caller has finished emitting
1299 /// branches to the given block and does not expect to emit code into it. This
1300 /// means the block can be ignored if it is unreachable.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001301 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar824e3bd2008-11-11 04:34:23 +00001302
John McCall777d6e52011-08-11 02:22:43 +00001303 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1304 /// near its uses, and leave the insertion point in it.
1305 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1306
Mike Stump0dd9e882009-02-08 23:14:22 +00001307 /// EmitBranch - Emit a branch to the specified basic block from the current
1308 /// insert block, taking care to avoid creation of branches from dummy
1309 /// blocks. It is legal to call this function even if there is no current
1310 /// insertion point.
Daniel Dunbar5e08ad32008-11-11 22:06:59 +00001311 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001312 /// This function clears the current insertion point. The caller should follow
1313 /// calls to this function with calls to Emit*Block prior to generation new
1314 /// code.
Daniel Dunbard57a8712008-11-11 09:41:28 +00001315 void EmitBranch(llvm::BasicBlock *Block);
1316
Mike Stump0dd9e882009-02-08 23:14:22 +00001317 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1318 /// indicates that the current code being emitted is unreachable.
1319 bool HaveInsertPoint() const {
Daniel Dunbara448fb22008-11-11 23:11:34 +00001320 return Builder.GetInsertBlock() != 0;
1321 }
1322
Mike Stump0dd9e882009-02-08 23:14:22 +00001323 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1324 /// emitted IR has a place to go. Note that by definition, if this function
1325 /// creates a block then that block is unreachable; callers may do better to
1326 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbara448fb22008-11-11 23:11:34 +00001327 void EnsureInsertPoint() {
1328 if (!HaveInsertPoint())
1329 EmitBlock(createBasicBlock());
1330 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001331
Daniel Dunbar488e9932008-08-16 00:56:44 +00001332 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerdc5e8262007-12-02 01:43:38 +00001333 /// specified stmt yet.
Daniel Dunbar90df4b62008-09-04 03:43:08 +00001334 void ErrorUnsupported(const Stmt *S, const char *Type,
1335 bool OmitOnError=false);
Reid Spencer5f016e22007-07-11 17:01:13 +00001336
1337 //===--------------------------------------------------------------------===//
1338 // Helpers
1339 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00001340
Eli Friedman6da2c712011-12-03 04:14:32 +00001341 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1342 CharUnits Alignment = CharUnits()) {
Dan Gohman3d5aff52010-10-14 23:06:10 +00001343 return LValue::MakeAddr(V, T, Alignment, getContext(),
1344 CGM.getTBAAInfo(T));
Daniel Dunbar5cf8bfe2010-08-21 02:53:44 +00001345 }
John McCalle0c11682012-07-02 23:58:38 +00001346
Eli Friedman2f77b3d2011-11-16 00:42:57 +00001347 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
Eli Friedman6da2c712011-12-03 04:14:32 +00001348 CharUnits Alignment;
1349 if (!T->isIncompleteType())
1350 Alignment = getContext().getTypeAlignInChars(T);
Eli Friedman2f77b3d2011-11-16 00:42:57 +00001351 return LValue::MakeAddr(V, T, Alignment, getContext(),
1352 CGM.getTBAAInfo(T));
1353 }
Daniel Dunbar5cf8bfe2010-08-21 02:53:44 +00001354
Reid Spencer5f016e22007-07-11 17:01:13 +00001355 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbar195337d2010-02-09 02:48:28 +00001356 /// block. The caller is responsible for setting an appropriate alignment on
1357 /// the alloca.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001358 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner8cc488f2011-07-20 07:06:53 +00001359 const Twine &Name = "tmp");
Mike Stump0dd9e882009-02-08 23:14:22 +00001360
John McCallac418162010-04-22 01:10:34 +00001361 /// InitTempAlloca - Provide an initial value for the given alloca.
1362 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1363
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001364 /// CreateIRTemp - Create a temporary IR object of the given type, with
1365 /// appropriate alignment. This routine should only be used when an temporary
1366 /// value needs to be stored into an alloca (for example, to avoid explicit
1367 /// PHI construction), but the type is the IR type, not the type appropriate
1368 /// for storing in memory.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001369 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001370
Daniel Dunbar195337d2010-02-09 02:48:28 +00001371 /// CreateMemTemp - Create a temporary memory object of the given type, with
1372 /// appropriate alignment.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001373 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbar195337d2010-02-09 02:48:28 +00001374
John McCall558d2ab2010-09-15 10:14:12 +00001375 /// CreateAggTemp - Create a temporary memory object for the given
1376 /// aggregate type.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001377 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedmand7722d92011-12-03 02:13:40 +00001378 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanf3940782011-12-03 00:54:26 +00001379 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1380 T.getQualifiers(),
John McCall7c2349b2011-08-25 20:40:09 +00001381 AggValueSlot::IsNotDestructed,
John McCall410ffb22011-08-25 23:04:34 +00001382 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier649b4a12012-03-29 17:37:10 +00001383 AggValueSlot::IsNotAliased);
John McCall558d2ab2010-09-15 10:14:12 +00001384 }
1385
John McCalld16c2cf2011-02-08 08:22:06 +00001386 /// Emit a cast to void* in the appropriate address space.
1387 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1388
Reid Spencer5f016e22007-07-11 17:01:13 +00001389 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1390 /// expression and compare the result against zero, returning an Int1Ty value.
1391 llvm::Value *EvaluateExprAsBool(const Expr *E);
1392
John McCall2a416372010-12-05 02:00:02 +00001393 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1394 void EmitIgnoredExpr(const Expr *E);
1395
Chris Lattner9b655512007-08-31 22:49:20 +00001396 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1397 /// any type. The result is returned as an RValue struct. If this is an
1398 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1399 /// the result should be returned.
Mike Stump49d1cd52009-05-26 22:03:21 +00001400 ///
Dmitri Gribenko70517ca2012-08-23 17:58:28 +00001401 /// \param ignoreResult True if the resulting value isn't used.
John McCall558d2ab2010-09-15 10:14:12 +00001402 RValue EmitAnyExpr(const Expr *E,
John McCalle0c11682012-07-02 23:58:38 +00001403 AggValueSlot aggSlot = AggValueSlot::ignored(),
1404 bool ignoreResult = false);
Devang Pateld9363c32007-09-28 21:49:18 +00001405
Mike Stump0dd9e882009-02-08 23:14:22 +00001406 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1407 // or the value of the expression, depending on how va_list is defined.
Eli Friedman4fd0aa52009-01-20 17:46:04 +00001408 llvm::Value *EmitVAListRef(const Expr *E);
1409
Mike Stump0dd9e882009-02-08 23:14:22 +00001410 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1411 /// always be accessible even if no aggregate location is provided.
John McCall558d2ab2010-09-15 10:14:12 +00001412 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar46f45b92008-09-09 01:06:48 +00001413
John McCall60d33652011-03-08 09:11:50 +00001414 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier649b4a12012-03-29 17:37:10 +00001415 /// arbitrary expression into the given memory location.
John McCall3d3ec1c2010-04-21 10:05:39 +00001416 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
Chad Rosier649b4a12012-03-29 17:37:10 +00001417 Qualifiers Quals, bool IsInitializer);
John McCall3d3ec1c2010-04-21 10:05:39 +00001418
John McCall60d33652011-03-08 09:11:50 +00001419 /// EmitExprAsInit - Emits the code necessary to initialize a
1420 /// location in memory with the given initializer.
John McCallf85e1932011-06-15 23:02:42 +00001421 void EmitExprAsInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001422 LValue lvalue, bool capturedByInit);
John McCall60d33652011-03-08 09:11:50 +00001423
Fariborz Jahanian3ac83d62013-01-25 23:57:05 +00001424 /// hasVolatileMember - returns true if aggregate type has a volatile
1425 /// member.
1426 bool hasVolatileMember(QualType T) {
1427 if (const RecordType *RT = T->getAs<RecordType>()) {
1428 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1429 return RD->hasVolatileMember();
1430 }
1431 return false;
1432 }
Arnaud A. de Grandmaison8fcbb8d2013-02-05 09:06:17 +00001433 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001434 ///
1435 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1436 /// This is required for correctness when assigning non-POD structures in C++.
1437 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian3ac83d62013-01-25 23:57:05 +00001438 QualType EltTy) {
1439 bool IsVolatile = hasVolatileMember(EltTy);
1440 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1441 true);
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001442 }
1443
Arnaud A. de Grandmaison8fcbb8d2013-02-05 09:06:17 +00001444 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump27fe2e62009-05-23 22:29:41 +00001445 ///
Sylvestre Ledruf3477c12012-09-27 10:16:10 +00001446 /// \param isVolatile - True iff either the source or the destination is
Mike Stump27fe2e62009-05-23 22:29:41 +00001447 /// volatile.
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001448 /// \param isAssignment - If false, allow padding to be copied. This often
1449 /// yields more efficient.
Daniel Dunbar7482d122008-09-09 20:49:46 +00001450 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedmanbd7d8282011-12-05 22:23:28 +00001451 QualType EltTy, bool isVolatile=false,
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001452 CharUnits Alignment = CharUnits::Zero(),
1453 bool isAssignment = false);
Daniel Dunbar7482d122008-09-09 20:49:46 +00001454
Devang Patel51b09f22007-10-04 23:45:31 +00001455 /// StartBlock - Start new block named N. If insert block is a dummy block
1456 /// then reuse it.
1457 void StartBlock(const char *N);
1458
Anders Carlssondde0a942008-09-11 09:15:33 +00001459 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall4c40d982010-08-31 07:33:07 +00001460 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1461 llvm::Value *Res = LocalDeclMap[VD];
1462 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1463 return Res;
1464 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001465
John McCall56ca35d2011-02-17 10:25:35 +00001466 /// getOpaqueLValueMapping - Given an opaque value expression (which
1467 /// must be mapped to an l-value), return its mapping.
1468 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1469 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1470
1471 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1472 it = OpaqueLValues.find(e);
1473 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1474 return it->second;
1475 }
1476
1477 /// getOpaqueRValueMapping - Given an opaque value expression (which
1478 /// must be mapped to an r-value), return its mapping.
1479 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1480 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1481
1482 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1483 it = OpaqueRValues.find(e);
1484 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCalle996ffd2011-02-16 08:02:54 +00001485 return it->second;
1486 }
1487
Dan Gohman4f8d1232008-05-22 00:50:06 +00001488 /// getAccessedFieldNo - Given an encoded value and a result number, return
1489 /// the input field number being accessed.
1490 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1491
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001492 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner3d00fdc2009-10-13 06:55:33 +00001493 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001494
Anders Carlsson1884eb02010-05-22 17:35:42 +00001495 /// EmitNullInitialization - Generate code to set a value of the given type to
1496 /// null, If the type contains data member pointers, they will be initialized
1497 /// to -1 in accordance with the Itanium C++ ABI.
1498 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001499
1500 // EmitVAArg - Generate code to get an argument from the passed in pointer
1501 // and update it accordingly. The return value is a pointer to the argument.
1502 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stump0dd9e882009-02-08 23:14:22 +00001503 // instruction in LLVM instead once it works well enough.
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001504 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssonf666b772008-12-20 20:27:15 +00001505
John McCallbdc4d802011-07-09 01:37:26 +00001506 /// emitArrayLength - Compute the length of an array, even if it's a
1507 /// VLA, and drill down to the base element type.
1508 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1509 QualType &baseType,
1510 llvm::Value *&addr);
1511
John McCallbc8d40d2011-06-24 21:55:10 +00001512 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1513 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbard286f052009-07-19 06:58:07 +00001514 ///
1515 /// This function can be called with a null (unreachable) insert point.
John McCallbc8d40d2011-06-24 21:55:10 +00001516 void EmitVariablyModifiedType(QualType Ty);
Mike Stump0dd9e882009-02-08 23:14:22 +00001517
John McCallbc8d40d2011-06-24 21:55:10 +00001518 /// getVLASize - Returns an LLVM value that corresponds to the size,
1519 /// in non-variably-sized elements, of a variable length array type,
1520 /// plus that largest non-variably-sized element type. Assumes that
1521 /// the type has already been emitted with EmitVariablyModifiedType.
1522 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1523 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssondcc90d82008-12-12 07:19:02 +00001524
Anders Carlsson5f4307b2009-04-14 16:58:56 +00001525 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1526 /// generating code for an C++ member function.
John McCall25049412010-02-16 22:04:33 +00001527 llvm::Value *LoadCXXThis() {
1528 assert(CXXThisValue && "no 'this' value for this function");
1529 return CXXThisValue;
1530 }
Mike Stump1eb44332009-09-09 15:08:12 +00001531
Anders Carlssonc997d422010-01-02 01:01:18 +00001532 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1533 /// virtual bases.
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00001534 // FIXME: Every place that calls LoadCXXVTT is something
1535 // that needs to be abstracted properly.
John McCall25049412010-02-16 22:04:33 +00001536 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00001537 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1538 return CXXStructorImplicitParamValue;
1539 }
1540
1541 /// LoadCXXStructorImplicitParam - Load the implicit parameter
1542 /// for a constructor/destructor.
1543 llvm::Value *LoadCXXStructorImplicitParam() {
1544 assert(CXXStructorImplicitParamValue &&
1545 "no implicit argument value for this function");
1546 return CXXStructorImplicitParamValue;
John McCall25049412010-02-16 22:04:33 +00001547 }
John McCallbff225e2010-02-16 04:15:37 +00001548
1549 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlsson8561a862010-04-24 23:01:49 +00001550 /// complete class to the given direct base.
1551 llvm::Value *
1552 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1553 const CXXRecordDecl *Derived,
1554 const CXXRecordDecl *Base,
1555 bool BaseIsVirtual);
Anders Carlssona88ad562010-04-24 21:51:08 +00001556
Mike Stumpf71d2322009-11-30 20:08:49 +00001557 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1558 /// load of 'this' and returns address of the base class.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001559 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001560 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001561 CastExpr::path_const_iterator PathBegin,
1562 CastExpr::path_const_iterator PathEnd,
Anders Carlsson34a2d382010-04-24 21:06:20 +00001563 bool NullCheckValue);
1564
Anders Carlssona3697c92009-11-23 17:57:54 +00001565 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001566 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001567 CastExpr::path_const_iterator PathBegin,
1568 CastExpr::path_const_iterator PathEnd,
Anders Carlssona3697c92009-11-23 17:57:54 +00001569 bool NullCheckValue);
1570
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +00001571 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1572 /// base constructor/destructor with virtual bases.
1573 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1574 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1575 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1576 bool Delegating);
1577
John McCallc0bf4622010-02-23 00:48:20 +00001578 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1579 CXXCtorType CtorType,
1580 const FunctionArgList &Args);
Sean Hunt059ce0d2011-05-01 07:04:31 +00001581 // It's important not to confuse this and the previous function. Delegating
1582 // constructors are the C++0x feature. The constructor delegate optimization
1583 // is used to reduce duplication in the base and complete consturctors where
1584 // they are substantially the same.
1585 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1586 const FunctionArgList &Args);
Anders Carlsson155ed4a2010-05-02 23:20:53 +00001587 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor378e1e72013-01-31 05:50:40 +00001588 bool ForVirtualBase, bool Delegating,
1589 llvm::Value *This,
Anders Carlssonb14095a2009-04-17 00:06:03 +00001590 CallExpr::const_arg_iterator ArgBeg,
1591 CallExpr::const_arg_iterator ArgEnd);
Fariborz Jahanian34999872010-11-13 21:53:34 +00001592
1593 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1594 llvm::Value *This, llvm::Value *Src,
1595 CallExpr::const_arg_iterator ArgBeg,
1596 CallExpr::const_arg_iterator ArgEnd);
Mike Stump1eb44332009-09-09 15:08:12 +00001597
Fariborz Jahanian288dcaf2009-08-19 20:55:16 +00001598 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlsson569c1f42009-09-23 02:45:36 +00001599 const ConstantArrayType *ArrayTy,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00001600 llvm::Value *ArrayPtr,
1601 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00001602 CallExpr::const_arg_iterator ArgEnd,
1603 bool ZeroInitialization = false);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001604
Anders Carlsson569c1f42009-09-23 02:45:36 +00001605 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1606 llvm::Value *NumElements,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00001607 llvm::Value *ArrayPtr,
1608 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00001609 CallExpr::const_arg_iterator ArgEnd,
1610 bool ZeroInitialization = false);
Anders Carlssonb14095a2009-04-17 00:06:03 +00001611
John McCallbdc4d802011-07-09 01:37:26 +00001612 static Destroyer destroyCXXObject;
1613
Anders Carlsson7267c162009-05-29 21:03:38 +00001614 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor378e1e72013-01-31 05:50:40 +00001615 bool ForVirtualBase, bool Delegating,
1616 llvm::Value *This);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001617
John McCall19705672011-09-15 06:49:18 +00001618 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
1619 llvm::Value *NewPtr, llvm::Value *NumElements);
Mike Stump1eb44332009-09-09 15:08:12 +00001620
Peter Collingbourne86811602011-11-27 22:09:22 +00001621 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1622 llvm::Value *Ptr);
Mike Stump1eb44332009-09-09 15:08:12 +00001623
Anders Carlssona00703d2009-05-31 01:40:14 +00001624 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson60e282c2009-08-16 21:13:42 +00001625 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump1eb44332009-09-09 15:08:12 +00001626
Eli Friedman4bf81522009-11-18 00:57:03 +00001627 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1628 QualType DeleteTy);
1629
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001630 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stumpc849c052009-11-16 06:50:58 +00001631 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Nico Weberc5f80462012-10-11 10:13:44 +00001632 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001633
Sebastian Redl972edf02012-02-19 16:03:09 +00001634 void MaybeEmitStdInitializerListCleanup(llvm::Value *loc, const Expr *init);
Sebastian Redlaf130fd2012-02-19 12:28:02 +00001635 void EmitStdInitializerListCleanup(llvm::Value *loc,
1636 const InitListExpr *init);
Sebastian Redl32cf1f22012-02-17 08:42:25 +00001637
Richard Smith2c9f87c2012-08-24 00:54:33 +00001638 /// \brief Situations in which we might emit a check for the suitability of a
1639 /// pointer or glvalue.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001640 enum TypeCheckKind {
Richard Smith2c9f87c2012-08-24 00:54:33 +00001641 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001642 TCK_Load,
Richard Smith2c9f87c2012-08-24 00:54:33 +00001643 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001644 TCK_Store,
Richard Smith2c9f87c2012-08-24 00:54:33 +00001645 /// Checking the bound value in a reference binding. Must be suitably sized
1646 /// and aligned, but is not required to refer to an object (until the
1647 /// reference is used), per core issue 453.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001648 TCK_ReferenceBinding,
Richard Smith2c9f87c2012-08-24 00:54:33 +00001649 /// Checking the object expression in a non-static data member access. Must
1650 /// be an object within its lifetime.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001651 TCK_MemberAccess,
Richard Smith2c9f87c2012-08-24 00:54:33 +00001652 /// Checking the 'this' pointer for a call to a non-static member function.
1653 /// Must be an object within its lifetime.
Richard Smith8e1cee62012-10-25 02:14:12 +00001654 TCK_MemberCall,
1655 /// Checking the 'this' pointer for a constructor call.
Richard Smithc7648302013-02-13 21:18:23 +00001656 TCK_ConstructorCall,
1657 /// Checking the operand of a static_cast to a derived pointer type. Must be
1658 /// null or an object within its lifetime.
1659 TCK_DowncastPointer,
1660 /// Checking the operand of a static_cast to a derived reference type. Must
1661 /// be an object within its lifetime.
1662 TCK_DowncastReference
Richard Smith2c9f87c2012-08-24 00:54:33 +00001663 };
1664
Richard Smith7ac9ef12012-09-08 02:08:36 +00001665 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith2c9f87c2012-08-24 00:54:33 +00001666 /// appropriate size and alignment for an object of type \p Type.
Richard Smith4def70d2012-10-09 19:52:38 +00001667 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Richard Smith7ac9ef12012-09-08 02:08:36 +00001668 QualType Type, CharUnits Alignment = CharUnits::Zero());
Mike Stumpb14e62d2009-12-16 02:57:00 +00001669
Richard Smitha0a628f2013-02-23 02:53:19 +00001670 /// \brief Emit a check that \p Base points into an array object, which
1671 /// we can access at index \p Index. \p Accessed should be \c false if we
1672 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1673 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1674 QualType IndexType, bool Accessed);
1675
Chris Lattnerdd36d322010-01-09 21:40:03 +00001676 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1677 bool isInc, bool isPre);
1678 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1679 bool isInc, bool isPre);
Reid Spencer5f016e22007-07-11 17:01:13 +00001680 //===--------------------------------------------------------------------===//
Reid Spencer5f016e22007-07-11 17:01:13 +00001681 // Declaration Emission
1682 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00001683
Daniel Dunbard286f052009-07-19 06:58:07 +00001684 /// EmitDecl - Emit a declaration.
1685 ///
1686 /// This function can be called with a null (unreachable) insert point.
Reid Spencer5f016e22007-07-11 17:01:13 +00001687 void EmitDecl(const Decl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00001688
John McCallb6bbcc92010-10-15 04:57:14 +00001689 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00001690 ///
1691 /// This function can be called with a null (unreachable) insert point.
John McCallb6bbcc92010-10-15 04:57:14 +00001692 void EmitVarDecl(const VarDecl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00001693
John McCallf85e1932011-06-15 23:02:42 +00001694 void EmitScalarInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001695 LValue lvalue, bool capturedByInit);
John McCall7acddac2011-06-17 06:42:21 +00001696 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCallf85e1932011-06-15 23:02:42 +00001697
John McCallf1549f62010-07-06 01:34:17 +00001698 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1699 llvm::Value *Address);
1700
John McCallb6bbcc92010-10-15 04:57:14 +00001701 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00001702 ///
1703 /// This function can be called with a null (unreachable) insert point.
John McCall34695852011-02-22 06:44:22 +00001704 void EmitAutoVarDecl(const VarDecl &D);
1705
1706 class AutoVarEmission {
1707 friend class CodeGenFunction;
1708
John McCall57b3b6a2011-02-22 07:16:58 +00001709 const VarDecl *Variable;
John McCall34695852011-02-22 06:44:22 +00001710
1711 /// The alignment of the variable.
1712 CharUnits Alignment;
1713
1714 /// The address of the alloca. Null if the variable was emitted
1715 /// as a global constant.
1716 llvm::Value *Address;
1717
1718 llvm::Value *NRVOFlag;
1719
1720 /// True if the variable is a __block variable.
1721 bool IsByRef;
1722
1723 /// True if the variable is of aggregate type and has a constant
1724 /// initializer.
1725 bool IsConstantAggregate;
1726
Nadav Rotem495cfa42013-03-23 06:43:35 +00001727 /// Non-null if we should use lifetime annotations.
1728 llvm::Value *SizeForLifetimeMarkers;
1729
John McCall57b3b6a2011-02-22 07:16:58 +00001730 struct Invalid {};
1731 AutoVarEmission(Invalid) : Variable(0) {}
1732
John McCall34695852011-02-22 06:44:22 +00001733 AutoVarEmission(const VarDecl &variable)
John McCall57b3b6a2011-02-22 07:16:58 +00001734 : Variable(&variable), Address(0), NRVOFlag(0),
Nadav Rotem495cfa42013-03-23 06:43:35 +00001735 IsByRef(false), IsConstantAggregate(false),
1736 SizeForLifetimeMarkers(0) {}
John McCall34695852011-02-22 06:44:22 +00001737
1738 bool wasEmittedAsGlobal() const { return Address == 0; }
1739
1740 public:
John McCall57b3b6a2011-02-22 07:16:58 +00001741 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1742
Nadav Rotem495cfa42013-03-23 06:43:35 +00001743 bool useLifetimeMarkers() const { return SizeForLifetimeMarkers != 0; }
1744 llvm::Value *getSizeForLifetimeMarkers() const {
1745 assert(useLifetimeMarkers());
1746 return SizeForLifetimeMarkers;
1747 }
1748
1749 /// Returns the raw, allocated address, which is not necessarily
1750 /// the address of the object itself.
1751 llvm::Value *getAllocatedAddress() const {
1752 return Address;
1753 }
1754
John McCall34695852011-02-22 06:44:22 +00001755 /// Returns the address of the object within this declaration.
1756 /// Note that this does not chase the forwarding pointer for
1757 /// __block decls.
1758 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1759 if (!IsByRef) return Address;
1760
1761 return CGF.Builder.CreateStructGEP(Address,
John McCall57b3b6a2011-02-22 07:16:58 +00001762 CGF.getByRefValueLLVMField(Variable),
1763 Variable->getNameAsString());
John McCall34695852011-02-22 06:44:22 +00001764 }
1765 };
1766 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1767 void EmitAutoVarInit(const AutoVarEmission &emission);
1768 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCallbdc4d802011-07-09 01:37:26 +00001769 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1770 QualType::DestructionKind dtorKind);
Daniel Dunbard286f052009-07-19 06:58:07 +00001771
John McCallb6bbcc92010-10-15 04:57:14 +00001772 void EmitStaticVarDecl(const VarDecl &D,
1773 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001774
1775 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Devang Patel093ac462011-03-03 20:13:15 +00001776 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, unsigned ArgNo);
Mike Stump0dd9e882009-02-08 23:14:22 +00001777
John McCall56ca35d2011-02-17 10:25:35 +00001778 /// protectFromPeepholes - Protect a value that we're intending to
1779 /// store to the side, but which will probably be used later, from
1780 /// aggressive peepholing optimizations that might delete it.
1781 ///
1782 /// Pass the result to unprotectFromPeepholes to declare that
1783 /// protection is no longer required.
1784 ///
1785 /// There's no particular reason why this shouldn't apply to
1786 /// l-values, it's just that no existing peepholes work on pointers.
1787 PeepholeProtection protectFromPeepholes(RValue rvalue);
1788 void unprotectFromPeepholes(PeepholeProtection protection);
1789
Reid Spencer5f016e22007-07-11 17:01:13 +00001790 //===--------------------------------------------------------------------===//
1791 // Statement Emission
1792 //===--------------------------------------------------------------------===//
1793
Mike Stump0dd9e882009-02-08 23:14:22 +00001794 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar09124252008-11-12 08:21:33 +00001795 void EmitStopPoint(const Stmt *S);
1796
Mike Stump0dd9e882009-02-08 23:14:22 +00001797 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1798 /// this function even if there is no current insertion point.
1799 ///
1800 /// This function may clear the current insertion point; callers should use
1801 /// EnsureInsertPoint if they wish to subsequently generate code without first
1802 /// calling EmitBlock, EmitBranch, or EmitStmt.
Reid Spencer5f016e22007-07-11 17:01:13 +00001803 void EmitStmt(const Stmt *S);
Daniel Dunbara448fb22008-11-11 23:11:34 +00001804
Daniel Dunbar09124252008-11-12 08:21:33 +00001805 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stump0dd9e882009-02-08 23:14:22 +00001806 /// necessarily require an insertion point or debug information; typically
1807 /// because the statement amounts to a jump or a container of other
1808 /// statements.
Daniel Dunbar09124252008-11-12 08:21:33 +00001809 ///
1810 /// \return True if the statement was handled.
1811 bool EmitSimpleStmt(const Stmt *S);
1812
Eli Friedman2ac2fa72013-06-10 22:04:49 +00001813 llvm::Value *EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
1814 AggValueSlot AVS = AggValueSlot::ignored());
1815 llvm::Value *EmitCompoundStmtWithoutScope(const CompoundStmt &S,
1816 bool GetLast = false,
1817 AggValueSlot AVS =
1818 AggValueSlot::ignored());
Daniel Dunbara448fb22008-11-11 23:11:34 +00001819
Mike Stump0dd9e882009-02-08 23:14:22 +00001820 /// EmitLabel - Emit the block for the given label. It is legal to call this
1821 /// function even if there is no current insertion point.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001822 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbara448fb22008-11-11 23:11:34 +00001823
Reid Spencer5f016e22007-07-11 17:01:13 +00001824 void EmitLabelStmt(const LabelStmt &S);
Richard Smith534986f2012-04-14 00:33:13 +00001825 void EmitAttributedStmt(const AttributedStmt &S);
Reid Spencer5f016e22007-07-11 17:01:13 +00001826 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001827 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Reid Spencer5f016e22007-07-11 17:01:13 +00001828 void EmitIfStmt(const IfStmt &S);
1829 void EmitWhileStmt(const WhileStmt &S);
1830 void EmitDoStmt(const DoStmt &S);
1831 void EmitForStmt(const ForStmt &S);
1832 void EmitReturnStmt(const ReturnStmt &S);
1833 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar09124252008-11-12 08:21:33 +00001834 void EmitBreakStmt(const BreakStmt &S);
1835 void EmitContinueStmt(const ContinueStmt &S);
Devang Patel51b09f22007-10-04 23:45:31 +00001836 void EmitSwitchStmt(const SwitchStmt &S);
1837 void EmitDefaultStmt(const DefaultStmt &S);
1838 void EmitCaseStmt(const CaseStmt &S);
Devang Patelc049e4f2007-10-08 20:57:48 +00001839 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosiera23b91d2012-08-28 18:54:39 +00001840 void EmitAsmStmt(const AsmStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001841
Anders Carlsson3d8400d2008-08-30 19:51:14 +00001842 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson64d5d6c2008-09-09 10:04:29 +00001843 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
1844 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattner10cac6f2008-11-15 21:26:17 +00001845 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCallf85e1932011-06-15 23:02:42 +00001846 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001847
John McCall93c332a2011-05-28 21:13:02 +00001848 llvm::Constant *getUnwindResumeFn();
Douglas Gregor86a3a032010-05-16 01:24:12 +00001849 llvm::Constant *getUnwindResumeOrRethrowFn();
John McCall59a70002010-07-07 06:56:46 +00001850 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
1851 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCall9fc6a772010-02-19 09:25:03 +00001852
Anders Carlsson6815e942009-09-27 18:58:34 +00001853 void EmitCXXTryStmt(const CXXTryStmt &S);
Richard Smithad762fc2011-04-14 22:09:26 +00001854 void EmitCXXForRangeStmt(const CXXForRangeStmt &S);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001855
Ben Langmuir524387a2013-05-09 19:17:11 +00001856 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
1857 llvm::Function *GenerateCapturedStmtFunction(const CapturedDecl *CD,
1858 const RecordDecl *RD);
1859
Reid Spencer5f016e22007-07-11 17:01:13 +00001860 //===--------------------------------------------------------------------===//
1861 // LValue Expression Emission
1862 //===--------------------------------------------------------------------===//
1863
Daniel Dunbar13e81732009-02-05 07:09:07 +00001864 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
1865 RValue GetUndefRValue(QualType Ty);
1866
Daniel Dunbarce1d38b2009-01-09 16:50:52 +00001867 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
1868 /// and issue an ErrorUnsupported style diagnostic (using the
1869 /// provided Name).
1870 RValue EmitUnsupportedRValue(const Expr *E,
1871 const char *Name);
1872
Mike Stump0dd9e882009-02-08 23:14:22 +00001873 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
1874 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbar6ba82a42008-08-25 20:45:57 +00001875 LValue EmitUnsupportedLValue(const Expr *E,
1876 const char *Name);
1877
Reid Spencer5f016e22007-07-11 17:01:13 +00001878 /// EmitLValue - Emit code to compute a designator that specifies the location
1879 /// of the expression.
1880 ///
1881 /// This can return one of two things: a simple address or a bitfield
1882 /// reference. In either case, the LLVM Value* in the LValue structure is
1883 /// guaranteed to be an LLVM pointer type.
1884 ///
1885 /// If this returns a bitfield reference, nothing about the pointee type of
1886 /// the LLVM value is known: For example, it may not be a pointer to an
1887 /// integer.
1888 ///
1889 /// If this returns a normal address, and if the lvalue's C type is fixed
1890 /// size, this method guarantees that the returned pointer type will point to
1891 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
1892 /// variable length type, this is not possible.
1893 ///
1894 LValue EmitLValue(const Expr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00001895
Richard Smith7ac9ef12012-09-08 02:08:36 +00001896 /// \brief Same as EmitLValue but additionally we generate checking code to
1897 /// guard against undefined behavior. This is only suitable when we know
1898 /// that the address will be used to access the object.
1899 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stumpb14e62d2009-12-16 02:57:00 +00001900
John McCall9d232c82013-03-07 21:37:08 +00001901 RValue convertTempToRValue(llvm::Value *addr, QualType type);
1902
John McCall9eda3ab2013-03-07 21:37:17 +00001903 void EmitAtomicInit(Expr *E, LValue lvalue);
1904
1905 RValue EmitAtomicLoad(LValue lvalue,
1906 AggValueSlot slot = AggValueSlot::ignored());
1907
1908 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
1909
John McCall26815d92010-10-27 20:58:56 +00001910 /// EmitToMemory - Change a scalar value from its value
1911 /// representation to its in-memory representation.
1912 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
1913
1914 /// EmitFromMemory - Change a scalar value from its memory
1915 /// representation to its value representation.
1916 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
1917
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00001918 /// EmitLoadOfScalar - Load a scalar value from an address, taking
1919 /// care to appropriately convert from the memory representation to
1920 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00001921 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman3d5aff52010-10-14 23:06:10 +00001922 unsigned Alignment, QualType Ty,
Manman Renb37a73d2013-04-04 21:53:22 +00001923 llvm::MDNode *TBAAInfo = 0,
1924 QualType TBAABaseTy = QualType(),
1925 uint64_t TBAAOffset = 0);
John McCall545d9962011-06-25 02:11:03 +00001926
1927 /// EmitLoadOfScalar - Load a scalar value from an address, taking
1928 /// care to appropriately convert from the memory representation to
1929 /// the LLVM value representation. The l-value must be a simple
1930 /// l-value.
John McCalla07398e2011-06-16 04:16:24 +00001931 llvm::Value *EmitLoadOfScalar(LValue lvalue);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00001932
1933 /// EmitStoreOfScalar - Store a scalar value to an address, taking
1934 /// care to appropriately convert from the memory representation to
1935 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00001936 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman3d5aff52010-10-14 23:06:10 +00001937 bool Volatile, unsigned Alignment, QualType Ty,
Manman Renb37a73d2013-04-04 21:53:22 +00001938 llvm::MDNode *TBAAInfo = 0, bool isInit = false,
1939 QualType TBAABaseTy = QualType(),
1940 uint64_t TBAAOffset = 0);
John McCall545d9962011-06-25 02:11:03 +00001941
1942 /// EmitStoreOfScalar - Store a scalar value to an address, taking
1943 /// care to appropriately convert from the memory representation to
1944 /// the LLVM value representation. The l-value must be a simple
David Chisnall7a7ee302012-01-16 17:27:18 +00001945 /// l-value. The isInit flag indicates whether this is an initialization.
1946 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
1947 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00001948
Reid Spencer5f016e22007-07-11 17:01:13 +00001949 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
1950 /// this method emits the address of the lvalue, then loads the result as an
1951 /// rvalue, returning the rvalue.
John McCall545d9962011-06-25 02:11:03 +00001952 RValue EmitLoadOfLValue(LValue V);
1953 RValue EmitLoadOfExtVectorElementLValue(LValue V);
1954 RValue EmitLoadOfBitfieldLValue(LValue LV);
Mike Stump0dd9e882009-02-08 23:14:22 +00001955
Reid Spencer5f016e22007-07-11 17:01:13 +00001956 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
1957 /// lvalue, where both are guaranteed to the have the same type, and that type
1958 /// is 'Ty'.
David Chisnall7a7ee302012-01-16 17:27:18 +00001959 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false);
John McCall545d9962011-06-25 02:11:03 +00001960 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Daniel Dunbared3849b2008-11-19 09:36:46 +00001961
Mike Stump0dd9e882009-02-08 23:14:22 +00001962 /// EmitStoreThroughLValue - Store Src into Dst with same constraints as
1963 /// EmitStoreThroughLValue.
Daniel Dunbared3849b2008-11-19 09:36:46 +00001964 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001965 /// \param Result [out] - If non-null, this will be set to a Value* for the
1966 /// bit-field contents after the store, appropriate for use as the result of
1967 /// an assignment to the bit-field.
John McCall545d9962011-06-25 02:11:03 +00001968 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Daniel Dunbared3849b2008-11-19 09:36:46 +00001969 llvm::Value **Result=0);
Mike Stump0dd9e882009-02-08 23:14:22 +00001970
John McCall83ce9d42010-11-16 23:07:28 +00001971 /// Emit an l-value for an assignment (simple or compound) of complex type.
1972 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00001973 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Eli Friedman0934e182013-06-12 01:40:06 +00001974 LValue EmitScalarCompooundAssignWithComplex(const CompoundAssignOperator *E,
1975 llvm::Value *&Result);
John McCall83ce9d42010-11-16 23:07:28 +00001976
Chris Lattnerfc8f0e12011-04-15 05:22:18 +00001977 // Note: only available for agg return types
Daniel Dunbar80e62c22008-09-04 03:20:13 +00001978 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00001979 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00001980 // Note: only available for agg return types
Christopher Lamb22c940e2007-12-29 05:02:41 +00001981 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00001982 // Note: only available for agg return types
1983 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00001984 LValue EmitDeclRefLValue(const DeclRefExpr *E);
1985 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnereaf2bb82009-02-24 22:18:39 +00001986 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattnerd9f69102008-08-10 01:53:14 +00001987 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00001988 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smitha0a628f2013-02-23 02:53:19 +00001989 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
1990 bool Accessed = false);
Nate Begeman213541a2008-04-18 23:10:10 +00001991 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patelb84a06e2007-10-23 02:10:49 +00001992 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian820bca42009-12-09 23:35:29 +00001993 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman06e863f2008-05-13 23:18:27 +00001994 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smith13ec9102012-05-14 21:57:21 +00001995 LValue EmitInitListLValue(const InitListExpr *E);
John McCall56ca35d2011-02-17 10:25:35 +00001996 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner75dfeda2009-03-18 18:28:57 +00001997 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregored8abf12010-07-08 06:14:04 +00001998 LValue EmitNullInitializationLValue(const CXXScalarValueInitExpr *E);
Douglas Gregor03e80032011-06-21 17:03:29 +00001999 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCalle996ffd2011-02-16 08:02:54 +00002000 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002001
Eli Friedman377ecc72012-04-16 03:54:45 +00002002 RValue EmitRValueForField(LValue LV, const FieldDecl *FD);
Anton Korobeynikoveaf856d2012-04-13 11:22:00 +00002003
John McCalldd2ecee2012-03-10 03:05:10 +00002004 class ConstantEmission {
2005 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2006 ConstantEmission(llvm::Constant *C, bool isReference)
2007 : ValueAndIsReference(C, isReference) {}
2008 public:
2009 ConstantEmission() {}
2010 static ConstantEmission forReference(llvm::Constant *C) {
2011 return ConstantEmission(C, true);
2012 }
2013 static ConstantEmission forValue(llvm::Constant *C) {
2014 return ConstantEmission(C, false);
2015 }
2016
David Blaikie7247c882013-05-15 07:37:26 +00002017 LLVM_EXPLICIT operator bool() const { return ValueAndIsReference.getOpaqueValue() != 0; }
John McCalldd2ecee2012-03-10 03:05:10 +00002018
2019 bool isReference() const { return ValueAndIsReference.getInt(); }
2020 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2021 assert(isReference());
2022 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2023 refExpr->getType());
2024 }
2025
2026 llvm::Constant *getValue() const {
2027 assert(!isReference());
2028 return ValueAndIsReference.getPointer();
2029 }
2030 };
2031
John McCallf4b88a42012-03-10 09:33:50 +00002032 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCalldd2ecee2012-03-10 03:05:10 +00002033
John McCall4b9c2d22011-11-06 09:01:30 +00002034 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2035 AggValueSlot slot = AggValueSlot::ignored());
2036 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2037
Daniel Dunbar2a031922009-04-22 05:08:15 +00002038 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002039 const ObjCIvarDecl *Ivar);
Eli Friedman377ecc72012-04-16 03:54:45 +00002040 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCallf5ebf9b2013-05-03 07:33:41 +00002041 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002042
Anders Carlsson06a29702010-01-29 05:24:29 +00002043 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2044 /// if the Field is a reference, this will return the address of the reference
2045 /// and not the address of the value stored in the reference.
Eli Friedman377ecc72012-04-16 03:54:45 +00002046 LValue EmitLValueForFieldInitialization(LValue Base,
2047 const FieldDecl* Field);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002048
Fariborz Jahanian45012a72009-02-03 00:09:52 +00002049 LValue EmitLValueForIvar(QualType ObjectTy,
2050 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002051 unsigned CVRQualifiers);
2052
Anders Carlssonb58d0172009-05-30 23:23:33 +00002053 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssone61c9e82009-05-30 23:30:54 +00002054 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman31a37022012-02-08 05:34:55 +00002055 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00002056 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Weberc5f80462012-10-11 10:13:44 +00002057 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002058
Daniel Dunbar0a04d772008-08-23 10:51:21 +00002059 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner391d77a2008-03-30 23:03:07 +00002060 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattner65459942009-04-25 19:35:26 +00002061 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanian8bfd31f2009-10-22 22:57:31 +00002062 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian03b29602010-06-17 19:56:20 +00002063 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
John McCall189d6ef2010-10-09 01:34:31 +00002064 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCall56ca35d2011-02-17 10:25:35 +00002065
Reid Spencer5f016e22007-07-11 17:01:13 +00002066 //===--------------------------------------------------------------------===//
Chris Lattner883f6a72007-08-11 00:04:45 +00002067 // Scalar Expression Emission
Reid Spencer5f016e22007-07-11 17:01:13 +00002068 //===--------------------------------------------------------------------===//
2069
Mike Stump0dd9e882009-02-08 23:14:22 +00002070 /// EmitCall - Generate a call of the given function, expecting the given
2071 /// result type, and using the given argument list which specifies both the
2072 /// LLVM arguments and the types they were derived from.
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00002073 ///
Mike Stumpf71d2322009-11-30 20:08:49 +00002074 /// \param TargetDecl - If given, the decl of the function in a direct call;
2075 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbar88b53962009-02-02 22:03:45 +00002076 RValue EmitCall(const CGFunctionInfo &FnInfo,
2077 llvm::Value *Callee,
Anders Carlssonf3c47c92009-12-24 19:25:24 +00002078 ReturnValueSlot ReturnValue,
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00002079 const CallArgList &Args,
David Chisnalldd5c98f2010-05-01 11:15:56 +00002080 const Decl *TargetDecl = 0,
David Chisnall4b02afc2010-05-02 13:41:58 +00002081 llvm::Instruction **callOrInvoke = 0);
Mike Stump1eb44332009-09-09 15:08:12 +00002082
Anders Carlsson31777a22009-12-24 19:08:58 +00002083 RValue EmitCall(QualType FnType, llvm::Value *Callee,
Anders Carlssond2490a92009-12-24 20:40:36 +00002084 ReturnValueSlot ReturnValue,
Anders Carlsson98647712009-05-27 01:22:39 +00002085 CallExpr::const_arg_iterator ArgBeg,
2086 CallExpr::const_arg_iterator ArgEnd,
2087 const Decl *TargetDecl = 0);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002088 RValue EmitCallExpr(const CallExpr *E,
Anders Carlssond2490a92009-12-24 20:40:36 +00002089 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump1eb44332009-09-09 15:08:12 +00002090
John McCallbd7370a2013-02-28 19:01:20 +00002091 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2092 const Twine &name = "");
2093 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2094 ArrayRef<llvm::Value*> args,
2095 const Twine &name = "");
2096 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2097 const Twine &name = "");
2098 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2099 ArrayRef<llvm::Value*> args,
2100 const Twine &name = "");
2101
John McCallf1549f62010-07-06 01:34:17 +00002102 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner2d3ba4f2011-07-23 17:14:25 +00002103 ArrayRef<llvm::Value *> Args,
Chris Lattner8cc488f2011-07-20 07:06:53 +00002104 const Twine &Name = "");
Jay Foad4c7d9f12011-07-15 08:37:34 +00002105 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner8cc488f2011-07-20 07:06:53 +00002106 const Twine &Name = "");
John McCallbd7370a2013-02-28 19:01:20 +00002107 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2108 ArrayRef<llvm::Value*> args,
2109 const Twine &name = "");
2110 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2111 const Twine &name = "");
2112 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2113 ArrayRef<llvm::Value*> args);
John McCallf1549f62010-07-06 01:34:17 +00002114
Anders Carlsson566abee2009-11-13 04:45:41 +00002115 llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002116 llvm::Type *Ty);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002117 llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002118 llvm::Value *This, llvm::Type *Ty);
Fariborz Jahanian27262672011-01-20 17:19:02 +00002119 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2120 NestedNameSpecifier *Qual,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002121 llvm::Type *Ty);
Fariborz Jahanianccd52592011-02-01 23:22:34 +00002122
2123 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2124 CXXDtorType Type,
Fariborz Jahanian771c6782011-02-03 19:27:17 +00002125 const CXXRecordDecl *RD);
Anders Carlsson566abee2009-11-13 04:45:41 +00002126
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002127 RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
Richard Smith4def70d2012-10-09 19:52:38 +00002128 SourceLocation CallLoc,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002129 llvm::Value *Callee,
Anders Carlssona1736c02009-12-24 21:13:40 +00002130 ReturnValueSlot ReturnValue,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002131 llvm::Value *This,
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00002132 llvm::Value *ImplicitParam,
2133 QualType ImplicitParamTy,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002134 CallExpr::const_arg_iterator ArgBeg,
2135 CallExpr::const_arg_iterator ArgEnd);
Anders Carlssona1736c02009-12-24 21:13:40 +00002136 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2137 ReturnValueSlot ReturnValue);
2138 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2139 ReturnValueSlot ReturnValue);
Ted Kremenek55499762008-06-17 02:43:46 +00002140
Anders Carlssona2447e02011-05-08 20:32:23 +00002141 llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2142 const CXXMethodDecl *MD,
2143 llvm::Value *This);
Anders Carlsson0f294632009-05-27 04:18:27 +00002144 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssona1736c02009-12-24 21:13:40 +00002145 const CXXMethodDecl *MD,
2146 ReturnValueSlot ReturnValue);
Mike Stump1eb44332009-09-09 15:08:12 +00002147
Peter Collingbourne6c0aa5f2011-10-06 18:29:37 +00002148 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2149 ReturnValueSlot ReturnValue);
2150
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002151
Mike Stump1eb44332009-09-09 15:08:12 +00002152 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Daniel Dunbaref2abfe2009-02-16 22:43:43 +00002153 unsigned BuiltinID, const CallExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002154
Anders Carlssona1736c02009-12-24 21:13:40 +00002155 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stump09429b92009-02-17 17:00:02 +00002156
Mike Stump0dd9e882009-02-08 23:14:22 +00002157 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2158 /// is unhandled by the current target.
Daniel Dunbarf02e9dd2008-10-10 00:24:54 +00002159 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2160
Tim Northoverff920ee2013-05-04 07:15:13 +00002161 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Chris Lattner2752c012010-03-03 19:03:45 +00002162 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002163 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner686775d2011-07-20 06:58:45 +00002164 SmallVectorImpl<llvm::Value*> &O,
Bob Wilsondb3d4d02010-12-08 22:37:56 +00002165 const char *name,
Nate Begeman61eecf52010-06-14 05:21:25 +00002166 unsigned shift = 0, bool rightshift = false);
Bob Wilsoncf556522010-12-07 22:40:02 +00002167 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2acc6e32011-07-18 04:24:23 +00002168 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman61eecf52010-06-14 05:21:25 +00002169 bool negateForRightShift);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002170
Bill Wendling795b1002012-02-22 09:30:11 +00002171 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson564f1de2007-12-09 23:17:02 +00002172 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2173 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00002174
Daniel Dunbared7c6182008-08-20 00:28:19 +00002175 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner7f02f722007-08-24 05:35:26 +00002176 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beardeb382ec2012-04-19 00:25:12 +00002177 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremenekebcb57a2012-03-06 20:05:56 +00002178 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2179 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2180 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
2181 const ObjCMethodDecl *MethodWithObjects);
Chris Lattner8fdf3282008-06-24 17:04:18 +00002182 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCallef072fd2010-05-22 01:48:05 +00002183 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2184 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattner8fdf3282008-06-24 17:04:18 +00002185
John McCallf85e1932011-06-15 23:02:42 +00002186 /// Retrieves the default cleanup kind for an ARC cleanup.
2187 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2188 CleanupKind getARCCleanupKind() {
2189 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2190 ? NormalAndEHCleanup : NormalCleanup;
2191 }
2192
2193 // ARC primitives.
2194 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2195 void EmitARCDestroyWeak(llvm::Value *addr);
2196 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2197 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2198 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2199 bool ignored);
2200 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2201 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2202 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2203 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall545d9962011-06-25 02:11:03 +00002204 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCall5b07e802013-03-13 03:10:54 +00002205 bool resultIgnored);
John McCallf85e1932011-06-15 23:02:42 +00002206 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
John McCall5b07e802013-03-13 03:10:54 +00002207 bool resultIgnored);
John McCallf85e1932011-06-15 23:02:42 +00002208 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2209 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCall348f16f2011-10-04 06:23:45 +00002210 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall5b07e802013-03-13 03:10:54 +00002211 void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise);
2212 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCallf85e1932011-06-15 23:02:42 +00002213 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2214 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2215 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2216 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2217
2218 std::pair<LValue,llvm::Value*>
2219 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2220 std::pair<LValue,llvm::Value*>
2221 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2222
John McCall2b014d62011-10-01 10:32:24 +00002223 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2224
John McCallf85e1932011-06-15 23:02:42 +00002225 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2226 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2227 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2228
John McCall348f16f2011-10-04 06:23:45 +00002229 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCallf85e1932011-06-15 23:02:42 +00002230 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2231 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2232
John McCallb6a60792013-03-23 02:35:54 +00002233 void EmitARCIntrinsicUse(llvm::ArrayRef<llvm::Value*> values);
2234
John McCallbdc4d802011-07-09 01:37:26 +00002235 static Destroyer destroyARCStrongImprecise;
2236 static Destroyer destroyARCStrongPrecise;
2237 static Destroyer destroyARCWeak;
2238
John McCallf85e1932011-06-15 23:02:42 +00002239 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2240 llvm::Value *EmitObjCAutoreleasePoolPush();
2241 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2242 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2243 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2244
Anders Carlsson4029ca72009-05-20 00:24:07 +00002245 /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in
2246 /// expression. Will emit a temporary variable if E is not an LValue.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002247 RValue EmitReferenceBindingToExpr(const Expr* E,
Anders Carlsson32f36ba2010-06-26 16:35:32 +00002248 const NamedDecl *InitializedDecl);
Anders Carlsson3aba0932010-01-31 18:34:51 +00002249
Chris Lattner883f6a72007-08-11 00:04:45 +00002250 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002251 // Expression Emission
Chris Lattner883f6a72007-08-11 00:04:45 +00002252 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002253
2254 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stump0dd9e882009-02-08 23:14:22 +00002255
2256 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2257 /// scalar type, returning the result.
Anders Carlsson14c5cbf2009-08-16 07:36:22 +00002258 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002259
Chris Lattner3707b252007-08-26 06:48:56 +00002260 /// EmitScalarConversion - Emit a conversion from the specified type to the
2261 /// specified destination type, both of which are LLVM scalar types.
2262 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2263 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002264
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002265 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stump0dd9e882009-02-08 23:14:22 +00002266 /// complex type to the specified destination type, where the destination type
2267 /// is an LLVM scalar type.
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002268 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2269 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002270
2271
John McCall558d2ab2010-09-15 10:14:12 +00002272 /// EmitAggExpr - Emit the computation of the specified expression
2273 /// of aggregate type. The result is computed into the given slot,
2274 /// which may be null to indicate that the value is not needed.
John McCalle0c11682012-07-02 23:58:38 +00002275 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stump0dd9e882009-02-08 23:14:22 +00002276
Daniel Dunbar18aba0d2010-02-05 19:38:31 +00002277 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2278 /// aggregate type into a temporary LValue.
2279 LValue EmitAggExprToLValue(const Expr *E);
2280
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002281 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2282 /// pointers.
2283 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian08c32132009-08-31 19:33:16 +00002284 QualType Ty);
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002285
John McCall0c24c802011-06-24 23:21:27 +00002286 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2287 /// make sure it survives garbage collection until this point.
2288 void EmitExtendGCLifetime(llvm::Value *object);
2289
Chris Lattnerb6ef18a2007-08-21 05:54:00 +00002290 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner23b1cdb2007-08-23 23:43:33 +00002291 /// complex type, returning the result.
John McCallb418d742010-11-16 10:08:07 +00002292 ComplexPairTy EmitComplexExpr(const Expr *E,
2293 bool IgnoreReal = false,
2294 bool IgnoreImag = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002295
John McCall9d232c82013-03-07 21:37:08 +00002296 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2297 /// type and place its result into the specified l-value.
2298 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar7f8ea5c2008-08-30 05:35:15 +00002299
John McCall9d232c82013-03-07 21:37:08 +00002300 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
2301 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
2302
2303 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
2304 ComplexPairTy EmitLoadOfComplex(LValue src);
Chris Lattner2621fd12008-05-08 05:58:21 +00002305
John McCallb6bbcc92010-10-15 04:57:14 +00002306 /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
2307 /// a static local variable.
Chandler Carruth0f30a122012-03-30 19:44:53 +00002308 llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D,
2309 const char *Separator,
2310 llvm::GlobalValue::LinkageTypes Linkage);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002311
Chandler Carruth0f30a122012-03-30 19:44:53 +00002312 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2313 /// global variable that has already been created for it. If the initializer
2314 /// has a different type than GV does, this may free GV and return a different
2315 /// one. Otherwise it just returns GV.
2316 llvm::GlobalVariable *
2317 AddInitializerToStaticVarDecl(const VarDecl &D,
2318 llvm::GlobalVariable *GV);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002319
Daniel Dunbar0096acf2009-02-25 19:24:29 +00002320
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002321 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2322 /// variable with global storage.
Richard Smith7ca48502012-02-13 22:16:19 +00002323 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2324 bool PerformInit);
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002325
John McCall20bb1752012-05-01 06:13:13 +00002326 /// Call atexit() with a function that passes the given argument to
2327 /// the given function.
2328 void registerGlobalDtorWithAtExit(llvm::Constant *fn, llvm::Constant *addr);
Mike Stump1eb44332009-09-09 15:08:12 +00002329
John McCall3030eb82010-11-06 09:44:32 +00002330 /// Emit code in this function to perform a guarded variable
2331 /// initialization. Guarded initializations are used when it's not
2332 /// possible to prove that an initialization will be done exactly
2333 /// once, e.g. with a static local variable or a static data member
2334 /// of a class template.
Chandler Carruth0f30a122012-03-30 19:44:53 +00002335 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith7ca48502012-02-13 22:16:19 +00002336 bool PerformInit);
John McCall5cd91b52010-09-08 01:44:27 +00002337
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002338 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2339 /// variables.
2340 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
Benjamin Kramerc7b5f382013-04-26 21:32:52 +00002341 ArrayRef<llvm::Constant *> Decls,
Richard Smithb80a16e2013-04-19 16:42:07 +00002342 llvm::GlobalVariable *Guard = 0);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002343
John McCall3f88f682012-04-06 18:21:03 +00002344 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002345 /// variables.
John McCall3f88f682012-04-06 18:21:03 +00002346 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2347 const std::vector<std::pair<llvm::WeakVH,
2348 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002349
John McCalld26bc762011-03-09 04:27:21 +00002350 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2351 const VarDecl *D,
Richard Smith7ca48502012-02-13 22:16:19 +00002352 llvm::GlobalVariable *Addr,
2353 bool PerformInit);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002354
John McCall558d2ab2010-09-15 10:14:12 +00002355 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahanian34999872010-11-13 21:53:34 +00002356
2357 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian830937b2010-12-02 17:02:11 +00002358 const Expr *Exp);
Mike Stump1eb44332009-09-09 15:08:12 +00002359
John McCall1a343eb2011-11-10 08:15:53 +00002360 void enterFullExpression(const ExprWithCleanups *E) {
2361 if (E->getNumObjects() == 0) return;
2362 enterNonTrivialFullExpression(E);
2363 }
2364 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump1eb44332009-09-09 15:08:12 +00002365
Richard Smith4c71b8c2013-05-07 21:53:22 +00002366 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregor1eb2e592010-05-16 00:44:00 +00002367
Eli Friedman4c5d8af2012-02-09 03:32:31 +00002368 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2369
Eli Friedman276b0612011-10-11 02:20:01 +00002370 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = 0);
2371
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002372 //===--------------------------------------------------------------------===//
Julien Lerouge77f68bb2011-09-09 22:41:49 +00002373 // Annotations Emission
2374 //===--------------------------------------------------------------------===//
2375
2376 /// Emit an annotation call (intrinsic or builtin).
2377 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2378 llvm::Value *AnnotatedVal,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00002379 StringRef AnnotationStr,
Julien Lerouge77f68bb2011-09-09 22:41:49 +00002380 SourceLocation Location);
2381
2382 /// Emit local annotations for the local variable V, declared by D.
2383 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2384
2385 /// Emit field annotations for the given field & value. Returns the
2386 /// annotation result.
2387 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2388
2389 //===--------------------------------------------------------------------===//
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002390 // Internal Helpers
2391 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00002392
Chris Lattner0946ccd2008-11-11 07:41:27 +00002393 /// ContainsLabel - Return true if the statement contains a label in it. If
2394 /// this statement is not executed normally, it not containing a label means
2395 /// that we can just remove the code.
2396 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002397
Chris Lattneref425a62011-02-28 00:18:40 +00002398 /// containsBreak - Return true if the statement contains a break out of it.
2399 /// If the statement (recursively) contains a switch or loop with a break
2400 /// inside of it, this is fine.
2401 static bool containsBreak(const Stmt *S);
2402
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002403 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattnerc2c90012011-02-27 23:02:32 +00002404 /// to a constant, or if it does but contains a label, return false. If it
2405 /// constant folds return true and set the boolean result in Result.
2406 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stump0dd9e882009-02-08 23:14:22 +00002407
Chris Lattneref425a62011-02-28 00:18:40 +00002408 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2409 /// to a constant, or if it does but contains a label, return false. If it
2410 /// constant folds return true and set the folded value.
Richard Trieue1ecdc12012-07-23 20:21:35 +00002411 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattneref425a62011-02-28 00:18:40 +00002412
Chris Lattner31a09842008-11-12 08:04:58 +00002413 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2414 /// if statement) to the specified blocks. Based on the condition, this might
2415 /// try to simplify the codegen of the conditional based on the branch.
Chris Lattner9bc47e22008-11-12 07:46:33 +00002416 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002417 llvm::BasicBlock *FalseBlock);
Mike Stumpbe07f602009-12-14 21:58:14 +00002418
Richard Smith4def70d2012-10-09 19:52:38 +00002419 /// \brief Emit a description of a type in a format suitable for passing to
2420 /// a runtime sanitizer handler.
2421 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2422
2423 /// \brief Convert a value into a format suitable for passing to a runtime
2424 /// sanitizer handler.
2425 llvm::Value *EmitCheckValue(llvm::Value *V);
2426
2427 /// \brief Emit a description of a source location in a format suitable for
2428 /// passing to a runtime sanitizer handler.
2429 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2430
Will Dietzad954812012-12-02 19:50:33 +00002431 /// \brief Specify under what conditions this check can be recovered
2432 enum CheckRecoverableKind {
2433 /// Always terminate program execution if this check fails
2434 CRK_Unrecoverable,
2435 /// Check supports recovering, allows user to specify which
2436 CRK_Recoverable,
2437 /// Runtime conditionally aborts, always need to support recovery.
2438 CRK_AlwaysRecoverable
2439 };
2440
Richard Smithcc305612012-11-01 22:15:34 +00002441 /// \brief Create a basic block that will call a handler function in a
2442 /// sanitizer runtime with the provided arguments, and create a conditional
2443 /// branch to it.
Richard Smith4def70d2012-10-09 19:52:38 +00002444 void EmitCheck(llvm::Value *Checked, StringRef CheckName,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00002445 ArrayRef<llvm::Constant *> StaticArgs,
2446 ArrayRef<llvm::Value *> DynamicArgs,
Will Dietzad954812012-12-02 19:50:33 +00002447 CheckRecoverableKind Recoverable);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002448
Richard Smithcc305612012-11-01 22:15:34 +00002449 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2450 /// conditional branch to it, for the -ftrapv checks.
Chad Rosier78d85b12013-01-29 23:31:22 +00002451 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithcc305612012-11-01 22:15:34 +00002452
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002453 /// EmitCallArg - Emit a single call argument.
John McCall413ebdb2011-03-11 20:59:21 +00002454 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002455
John McCall27360712010-05-26 22:34:26 +00002456 /// EmitDelegateCallArg - We are performing a delegate call; that
2457 /// is, the current function is delegating to another one. Produce
2458 /// a r-value suitable for passing the given parameter.
John McCall413ebdb2011-03-11 20:59:21 +00002459 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param);
John McCall27360712010-05-26 22:34:26 +00002460
Peter Collingbournec5096cb2011-10-27 19:19:51 +00002461 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2462 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sands82500162012-04-10 08:23:07 +00002463 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbournec5096cb2011-10-27 19:19:51 +00002464
Chris Lattner31a09842008-11-12 08:04:58 +00002465private:
Rafael Espindolac3f89552012-03-24 16:50:34 +00002466 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002467 void EmitReturnOfRValue(RValue RV, QualType Ty);
2468
Daniel Dunbar56273772008-09-17 00:51:38 +00002469 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2470 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2471 ///
2472 /// \param AI - The first function argument of the expansion.
2473 /// \return The argument following the last expanded function
2474 /// argument.
Mike Stump0dd9e882009-02-08 23:14:22 +00002475 llvm::Function::arg_iterator
Daniel Dunbar56273772008-09-17 00:51:38 +00002476 ExpandTypeFromArgs(QualType Ty, LValue Dst,
2477 llvm::Function::arg_iterator AI);
2478
Mike Stump0dd9e882009-02-08 23:14:22 +00002479 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
2480 /// Ty, into individual arguments on the provided vector \arg Args. See
2481 /// ABIArgInfo::Expand.
2482 void ExpandTypeToArgs(QualType Ty, RValue Src,
Chris Lattner686775d2011-07-20 06:58:45 +00002483 SmallVector<llvm::Value*, 16> &Args,
Chris Lattner811bf362011-07-12 06:29:11 +00002484 llvm::FunctionType *IRFuncTy);
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002485
Chad Rosier42b60552012-08-23 20:00:18 +00002486 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002487 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stump0dd9e882009-02-08 23:14:22 +00002488
Chad Rosier42b60552012-08-23 20:00:18 +00002489 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedman6d7cfd72010-07-16 00:55:21 +00002490 LValue InputValue, QualType InputType,
2491 std::string &ConstraintStr);
2492
Anders Carlsson0139bb92009-04-08 20:47:54 +00002493 /// EmitCallArgs - Emit call arguments for a function.
Mike Stump1eb44332009-09-09 15:08:12 +00002494 /// The CallArgTypeInfo parameter is used for iterating over the known
Anders Carlssonaf23f692009-04-18 20:20:22 +00002495 /// argument types of the function being called.
2496 template<typename T>
2497 void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo,
Anders Carlsson0139bb92009-04-08 20:47:54 +00002498 CallExpr::const_arg_iterator ArgBeg,
Anders Carlssonaf23f692009-04-18 20:20:22 +00002499 CallExpr::const_arg_iterator ArgEnd) {
2500 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson0139bb92009-04-08 20:47:54 +00002501
Anders Carlssonaf23f692009-04-18 20:20:22 +00002502 // First, use the argument types that the type info knows about
2503 if (CallArgTypeInfo) {
2504 for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(),
2505 E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) {
Eli Friedman44b0a3e2009-11-18 03:42:04 +00002506 assert(Arg != ArgEnd && "Running over edge of argument list!");
Anders Carlssonaf23f692009-04-18 20:20:22 +00002507 QualType ArgType = *I;
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002508#ifndef NDEBUG
2509 QualType ActualArgType = Arg->getType();
2510 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002511 QualType ActualBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002512 ActualArgType->getAs<PointerType>()->getPointeeType();
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002513 QualType ArgBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002514 ArgType->getAs<PointerType>()->getPointeeType();
2515 if (ArgBaseType->isVariableArrayType()) {
2516 if (const VariableArrayType *VAT =
2517 getContext().getAsVariableArrayType(ActualBaseType)) {
2518 if (!VAT->getSizeExpr())
2519 ActualArgType = ArgType;
2520 }
2521 }
2522 }
Anders Carlssonaf23f692009-04-18 20:20:22 +00002523 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
Mike Stump1eb44332009-09-09 15:08:12 +00002524 getTypePtr() ==
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002525 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002526 "type mismatch in call argument!");
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002527#endif
John McCall413ebdb2011-03-11 20:59:21 +00002528 EmitCallArg(Args, *Arg, ArgType);
Anders Carlssonaf23f692009-04-18 20:20:22 +00002529 }
Mike Stump1eb44332009-09-09 15:08:12 +00002530
2531 // Either we've emitted all the call args, or we have a call to a
Anders Carlssonaf23f692009-04-18 20:20:22 +00002532 // variadic function.
Mike Stump1eb44332009-09-09 15:08:12 +00002533 assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002534 "Extra arguments in non-variadic function!");
Mike Stump1eb44332009-09-09 15:08:12 +00002535
Anders Carlssonaf23f692009-04-18 20:20:22 +00002536 }
Mike Stump1eb44332009-09-09 15:08:12 +00002537
Anders Carlssonaf23f692009-04-18 20:20:22 +00002538 // If we still have any arguments, emit them using the type of the argument.
John McCall413ebdb2011-03-11 20:59:21 +00002539 for (; Arg != ArgEnd; ++Arg)
2540 EmitCallArg(Args, *Arg, Arg->getType());
Anders Carlssonaf23f692009-04-18 20:20:22 +00002541 }
John McCall492c4f92010-03-03 04:15:11 +00002542
2543 const TargetCodeGenInfo &getTargetHooks() const {
2544 return CGM.getTargetCodeGenInfo();
2545 }
John McCall744016d2010-07-06 23:57:41 +00002546
2547 void EmitDeclMetadata();
John McCallf0c11f72011-03-31 08:03:29 +00002548
2549 CodeGenModule::ByrefHelpers *
Chris Lattner2acc6e32011-07-18 04:24:23 +00002550 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf0c11f72011-03-31 08:03:29 +00002551 const AutoVarEmission &emission);
Dan Gohmanb49bd272012-02-16 00:57:37 +00002552
2553 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadf4c3db12012-03-02 18:34:30 +00002554
Eli Friedmanea93e402012-08-23 03:10:17 +00002555 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2556 /// value and compute our best estimate of the alignment of the pointee.
2557 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
Reid Spencer5f016e22007-07-11 17:01:13 +00002558};
Mike Stump1eb44332009-09-09 15:08:12 +00002559
John McCall150b4622011-01-26 04:00:11 +00002560/// Helper class with most of the code for saving a value for a
2561/// conditional expression cleanup.
John McCall804b8072011-01-28 10:53:53 +00002562struct DominatingLLVMValue {
John McCall150b4622011-01-26 04:00:11 +00002563 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2564
2565 /// Answer whether the given value needs extra work to be saved.
2566 static bool needsSaving(llvm::Value *value) {
2567 // If it's not an instruction, we don't need to save.
2568 if (!isa<llvm::Instruction>(value)) return false;
2569
2570 // If it's an instruction in the entry block, we don't need to save.
2571 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2572 return (block != &block->getParent()->getEntryBlock());
2573 }
2574
2575 /// Try to save the given value.
2576 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2577 if (!needsSaving(value)) return saved_type(value, false);
2578
2579 // Otherwise we need an alloca.
2580 llvm::Value *alloca =
2581 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2582 CGF.Builder.CreateStore(value, alloca);
2583
2584 return saved_type(alloca, true);
2585 }
2586
2587 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2588 if (!value.getInt()) return value.getPointer();
2589 return CGF.Builder.CreateLoad(value.getPointer());
2590 }
2591};
2592
John McCall804b8072011-01-28 10:53:53 +00002593/// A partial specialization of DominatingValue for llvm::Values that
2594/// might be llvm::Instructions.
2595template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2596 typedef T *type;
John McCall150b4622011-01-26 04:00:11 +00002597 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCall804b8072011-01-28 10:53:53 +00002598 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2599 }
2600};
2601
2602/// A specialization of DominatingValue for RValue.
2603template <> struct DominatingValue<RValue> {
2604 typedef RValue type;
2605 class saved_type {
2606 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2607 AggregateAddress, ComplexAddress };
2608
2609 llvm::Value *Value;
2610 Kind K;
2611 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2612
2613 public:
2614 static bool needsSaving(RValue value);
2615 static saved_type save(CodeGenFunction &CGF, RValue value);
2616 RValue restore(CodeGenFunction &CGF);
2617
2618 // implementations in CGExprCXX.cpp
2619 };
2620
2621 static bool needsSaving(type value) {
2622 return saved_type::needsSaving(value);
2623 }
2624 static saved_type save(CodeGenFunction &CGF, type value) {
2625 return saved_type::save(CGF, value);
2626 }
2627 static type restore(CodeGenFunction &CGF, saved_type value) {
2628 return value.restore(CGF);
John McCall150b4622011-01-26 04:00:11 +00002629 }
2630};
2631
Reid Spencer5f016e22007-07-11 17:01:13 +00002632} // end namespace CodeGen
2633} // end namespace clang
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00002634
Reid Spencer5f016e22007-07-11 17:01:13 +00002635#endif