blob: 8009e78d2ad65c6ed7483b17d1f30bdd5066eee2 [file] [log] [blame]
Daniel Dunbar9c426522008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Chris Lattnerbed31442007-05-28 01:07:47 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattnerbed31442007-05-28 01:07:47 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stumpfc496822009-02-08 23:14:22 +000010// This is the internal per-function state used for llvm translation.
Chris Lattnerbed31442007-05-28 01:07:47 +000011//
12//===----------------------------------------------------------------------===//
13
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000014#ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
15#define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
Chris Lattnerbed31442007-05-28 01:07:47 +000016
Daniel Dunbarcb463852008-11-01 01:53:16 +000017#include "CGBuilder.h"
Eric Christophera9d34972011-10-19 00:43:52 +000018#include "CGDebugInfo.h"
Alexander Musman515ad8c2014-05-22 08:54:05 +000019#include "CGLoopInfo.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000020#include "CGValue.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "CodeGenModule.h"
Justin Bogneref512b92014-01-06 22:27:43 +000022#include "CodeGenPGO.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000023#include "EHScopeStack.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000024#include "clang/AST/CharUnits.h"
25#include "clang/AST/ExprCXX.h"
26#include "clang/AST/ExprObjC.h"
27#include "clang/AST/Type.h"
28#include "clang/Basic/ABI.h"
Ben Langmuir3b4c30b2013-05-09 19:17:11 +000029#include "clang/Basic/CapturedStmt.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000030#include "clang/Basic/TargetInfo.h"
31#include "clang/Frontend/CodeGenOptions.h"
32#include "llvm/ADT/ArrayRef.h"
33#include "llvm/ADT/DenseMap.h"
34#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000035#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000036#include "llvm/Support/Debug.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000037
Chris Lattnerbed31442007-05-28 01:07:47 +000038namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000039class BasicBlock;
40class LLVMContext;
41class MDNode;
42class Module;
43class SwitchInst;
44class Twine;
45class Value;
46class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000047}
48
Chris Lattnerbed31442007-05-28 01:07:47 +000049namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000050class ASTContext;
51class BlockDecl;
52class CXXDestructorDecl;
53class CXXForRangeStmt;
54class CXXTryStmt;
55class Decl;
56class LabelDecl;
57class EnumConstantDecl;
58class FunctionDecl;
59class FunctionProtoType;
60class LabelStmt;
61class ObjCContainerDecl;
62class ObjCInterfaceDecl;
63class ObjCIvarDecl;
64class ObjCMethodDecl;
65class ObjCImplementationDecl;
66class ObjCPropertyImplDecl;
67class TargetInfo;
68class TargetCodeGenInfo;
69class VarDecl;
70class ObjCForCollectionStmt;
71class ObjCAtTryStmt;
72class ObjCAtThrowStmt;
73class ObjCAtSynchronizedStmt;
74class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000075
Chris Lattnerbed31442007-05-28 01:07:47 +000076namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000077class CodeGenTypes;
78class CGFunctionInfo;
79class CGRecordLayout;
80class CGBlockInfo;
81class CGCXXABI;
82class BlockFlags;
83class BlockFieldFlags;
Mike Stumpfc496822009-02-08 23:14:22 +000084
John McCall47fb9502013-03-07 21:37:08 +000085/// The kind of evaluation to perform on values of a particular
86/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
87/// CGExprAgg?
88///
89/// TODO: should vectors maybe be split out into their own thing?
90enum TypeEvaluationKind {
91 TEK_Scalar,
92 TEK_Complex,
93 TEK_Aggregate
94};
95
Chris Lattnerbed31442007-05-28 01:07:47 +000096/// CodeGenFunction - This class organizes the per-function state that is used
97/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +000098class CodeGenFunction : public CodeGenTypeCache {
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +000099 CodeGenFunction(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
100 void operator=(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
John McCall5d865c322010-08-31 07:33:07 +0000101
102 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000103public:
John McCallad5d61e2010-07-23 21:56:41 +0000104 /// A jump destination is an abstract label, branching to which may
105 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000106 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000107 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000108 JumpDest(llvm::BasicBlock *Block,
109 EHScopeStack::stable_iterator Depth,
110 unsigned Index)
111 : Block(Block), ScopeDepth(Depth), Index(Index) {}
112
Craig Topper8a13c412014-05-21 05:09:00 +0000113 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000114 llvm::BasicBlock *getBlock() const { return Block; }
115 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
116 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000117
Nadav Rotem1da30942013-03-23 06:43:35 +0000118 // This should be used cautiously.
119 void setScopeDepth(EHScopeStack::stable_iterator depth) {
120 ScopeDepth = depth;
121 }
122
John McCallad5d61e2010-07-23 21:56:41 +0000123 private:
John McCallbd309292010-07-06 01:34:17 +0000124 llvm::BasicBlock *Block;
125 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000126 unsigned Index;
127 };
128
Chris Lattnerbed31442007-05-28 01:07:47 +0000129 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000130 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000131
Chris Lattner96d72562007-08-21 16:57:55 +0000132 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000133 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000134 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000135
Alexander Musman515ad8c2014-05-22 08:54:05 +0000136 /// \brief CGBuilder insert helper. This function is called after an
137 /// instruction is created using Builder.
138 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
139 llvm::BasicBlock *BB,
140 llvm::BasicBlock::iterator InsertPt) const;
141
John McCalldec348f72013-05-03 07:33:41 +0000142 /// CurFuncDecl - Holds the Decl for the current outermost
143 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000144 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000145 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
146 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000147 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000148 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000149 llvm::Function *CurFn;
150
Mike Stumpbee78dd2009-12-04 23:26:17 +0000151 /// CurGD - The GlobalDecl for the current function being compiled.
152 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000153
John McCall31168b02011-06-15 23:02:42 +0000154 /// PrologueCleanupDepth - The cleanup depth enclosing all the
155 /// cleanups associated with the parameters.
156 EHScopeStack::stable_iterator PrologueCleanupDepth;
157
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000158 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000159 JumpDest ReturnBlock;
160
Mike Stumpfc496822009-02-08 23:14:22 +0000161 /// ReturnValue - The temporary alloca to hold the return value. This is null
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +0000162 /// iff the function has no return value.
Eli Friedman4b1942c2009-12-04 02:43:40 +0000163 llvm::Value *ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000164
Chris Lattner03df1222007-06-02 04:53:11 +0000165 /// AllocaInsertPoint - This is an instruction in the entry block before which
166 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000167 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000168
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000169 /// \brief API for captured statement code generation.
170 class CGCapturedStmtInfo {
171 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000172 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
173 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000174 explicit CGCapturedStmtInfo(const CapturedStmt &S,
175 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000176 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000177
178 RecordDecl::field_iterator Field =
179 S.getCapturedRecordDecl()->field_begin();
180 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
181 E = S.capture_end();
182 I != E; ++I, ++Field) {
183 if (I->capturesThis())
184 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000185 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000186 CaptureFields[I->getCapturedVar()] = *Field;
187 }
188 }
189
190 virtual ~CGCapturedStmtInfo();
191
192 CapturedRegionKind getKind() const { return Kind; }
193
194 void setContextValue(llvm::Value *V) { ThisValue = V; }
195 // \brief Retrieve the value of the context parameter.
196 llvm::Value *getContextValue() const { return ThisValue; }
197
198 /// \brief Lookup the captured field decl for a variable.
199 const FieldDecl *lookup(const VarDecl *VD) const {
200 return CaptureFields.lookup(VD);
201 }
202
Craig Topper8a13c412014-05-21 05:09:00 +0000203 bool isCXXThisExprCaptured() const { return CXXThisFieldDecl != nullptr; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000204 FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
205
Alexey Bataev18095712014-10-10 12:19:54 +0000206 static bool classof(const CGCapturedStmtInfo *) {
207 return true;
208 }
209
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000210 /// \brief Emit the captured statement body.
211 virtual void EmitBody(CodeGenFunction &CGF, Stmt *S) {
Justin Bogner81ab90f2014-04-15 00:50:54 +0000212 RegionCounter Cnt = CGF.getPGORegionCounter(S);
213 Cnt.beginRegion(CGF.Builder);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000214 CGF.EmitStmt(S);
215 }
216
217 /// \brief Get the name of the capture helper.
218 virtual StringRef getHelperName() const { return "__captured_stmt"; }
219
220 private:
221 /// \brief The kind of captured statement being generated.
222 CapturedRegionKind Kind;
223
224 /// \brief Keep the map between VarDecl and FieldDecl.
225 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
226
227 /// \brief The base address of the captured record, passed in as the first
228 /// argument of the parallel region function.
229 llvm::Value *ThisValue;
230
231 /// \brief Captured 'this' type.
232 FieldDecl *CXXThisFieldDecl;
233 };
234 CGCapturedStmtInfo *CapturedStmtInfo;
235
Nuno Lopes3d6311d2012-05-08 22:10:46 +0000236 /// BoundsChecking - Emit run-time bounds checks. Higher values mean
237 /// potentially higher performance penalties.
238 unsigned char BoundsChecking;
239
Alexey Samsonova0416102014-11-11 01:26:14 +0000240 /// \brief Sanitizers enabled for this function.
241 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000242
Alexey Samsonov24cad992014-07-17 18:46:27 +0000243 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
244 bool IsSanitizerScope;
245
246 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
247 class SanitizerScope {
248 CodeGenFunction *CGF;
249 public:
250 SanitizerScope(CodeGenFunction *CGF);
251 ~SanitizerScope();
252 };
253
Reid Kleckner19819442014-07-25 21:39:46 +0000254 /// In C++, whether we are code generating a thunk. This controls whether we
255 /// should emit cleanups.
256 bool CurFuncIsThunk;
257
John McCall31168b02011-06-15 23:02:42 +0000258 /// In ARC, whether we should autorelease the return value.
259 bool AutoreleaseResult;
260
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000261 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
262 /// potentially set the return value.
263 bool SawAsmBlock;
264
John McCallad7c5c12011-02-08 08:22:06 +0000265 const CodeGen::CGBlockInfo *BlockInfo;
266 llvm::Value *BlockPointer;
267
Eli Friedman9fbeba02012-02-11 02:57:39 +0000268 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
269 FieldDecl *LambdaThisCaptureField;
270
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000271 /// \brief A mapping from NRVO variables to the flags used to indicate
272 /// when the NRVO has been applied to this variable.
273 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000274
John McCallbd309292010-07-06 01:34:17 +0000275 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000276 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
277
278 /// Header for data within LifetimeExtendedCleanupStack.
279 struct LifetimeExtendedCleanupHeader {
280 /// The size of the following cleanup object.
Reid Klecknerc311aba2014-10-31 23:33:56 +0000281 unsigned Size : 29;
Richard Smith736a9472013-06-12 20:42:33 +0000282 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
283 unsigned Kind : 3;
284
Reid Klecknerc311aba2014-10-31 23:33:56 +0000285 size_t getSize() const { return size_t(Size); }
Richard Smith736a9472013-06-12 20:42:33 +0000286 CleanupKind getKind() const { return static_cast<CleanupKind>(Kind); }
287 };
John McCallbd309292010-07-06 01:34:17 +0000288
John McCallad5d61e2010-07-23 21:56:41 +0000289 /// i32s containing the indexes of the cleanup destinations.
290 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000291
292 unsigned NextCleanupDestIndex;
293
John McCall08ef4662011-11-10 08:15:53 +0000294 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
295 CGBlockInfo *FirstBlockInfo;
296
John McCall8e4c74b2011-08-11 02:22:43 +0000297 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
298 llvm::BasicBlock *EHResumeBlock;
299
Bill Wendlingf0724e82011-09-19 20:31:14 +0000300 /// The exception slot. All landing pads write the current exception pointer
301 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000302 llvm::Value *ExceptionSlot;
303
Bill Wendlingf0724e82011-09-19 20:31:14 +0000304 /// The selector slot. Under the MandatoryCleanup model, all landing pads
305 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000306 llvm::AllocaInst *EHSelectorSlot;
307
John McCallbd309292010-07-06 01:34:17 +0000308 /// Emits a landing pad for the current EH stack.
309 llvm::BasicBlock *EmitLandingPad();
310
311 llvm::BasicBlock *getInvokeDestImpl();
312
John McCallce1de612011-01-26 04:00:11 +0000313 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000314 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
315 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000316 }
317
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000318public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000319 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
320 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000321 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000322
John McCall6b0feb72011-06-22 02:32:12 +0000323 /// A class controlling the emission of a finally block.
324 class FinallyInfo {
325 /// Where the catchall's edge through the cleanup should go.
326 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000327
John McCall6b0feb72011-06-22 02:32:12 +0000328 /// A function to call to enter the catch.
329 llvm::Constant *BeginCatchFn;
330
331 /// An i1 variable indicating whether or not the @finally is
332 /// running for an exception.
333 llvm::AllocaInst *ForEHVar;
334
335 /// An i8* variable into which the exception pointer to rethrow
336 /// has been saved.
337 llvm::AllocaInst *SavedExnVar;
338
339 public:
340 void enter(CodeGenFunction &CGF, const Stmt *Finally,
341 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
342 llvm::Constant *rethrowFn);
343 void exit(CodeGenFunction &CGF);
344 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000345
John McCallce1de612011-01-26 04:00:11 +0000346 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
347 /// current full-expression. Safe against the possibility that
348 /// we're currently inside a conditionally-evaluated expression.
John McCalle4df6c82011-01-28 08:37:24 +0000349 template <class T, class A0>
350 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
351 // If we're not in a conditional branch, or if none of the
352 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000353 if (!isInConditionalBranch())
354 return EHStack.pushCleanup<T>(kind, a0);
John McCalle4df6c82011-01-28 08:37:24 +0000355
John McCallcb5f77f2011-01-28 10:53:53 +0000356 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCalle4df6c82011-01-28 08:37:24 +0000357
358 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
359 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
360 initFullExprCleanup();
361 }
362
363 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
364 /// current full-expression. Safe against the possibility that
365 /// we're currently inside a conditionally-evaluated expression.
John McCallce1de612011-01-26 04:00:11 +0000366 template <class T, class A0, class A1>
367 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
368 // If we're not in a conditional branch, or if none of the
369 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000370 if (!isInConditionalBranch())
371 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCallce1de612011-01-26 04:00:11 +0000372
John McCallcb5f77f2011-01-28 10:53:53 +0000373 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
374 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCallce1de612011-01-26 04:00:11 +0000375
376 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCalle4df6c82011-01-28 08:37:24 +0000377 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
378 initFullExprCleanup();
John McCallce1de612011-01-26 04:00:11 +0000379 }
380
Douglas Gregor58df5092011-06-22 16:12:01 +0000381 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
382 /// current full-expression. Safe against the possibility that
383 /// we're currently inside a conditionally-evaluated expression.
384 template <class T, class A0, class A1, class A2>
385 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
386 // If we're not in a conditional branch, or if none of the
387 // arguments requires saving, then use the unconditional cleanup.
388 if (!isInConditionalBranch()) {
John McCall5fcf8da2011-07-12 00:15:30 +0000389 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregor58df5092011-06-22 16:12:01 +0000390 }
391
392 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
393 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
394 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
395
396 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
397 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
398 initFullExprCleanup();
399 }
400
John McCall4bd0fb12011-07-12 16:41:08 +0000401 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
402 /// current full-expression. Safe against the possibility that
403 /// we're currently inside a conditionally-evaluated expression.
404 template <class T, class A0, class A1, class A2, class A3>
405 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
406 // If we're not in a conditional branch, or if none of the
407 // arguments requires saving, then use the unconditional cleanup.
408 if (!isInConditionalBranch()) {
409 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
410 }
411
412 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
413 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
414 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
415 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
416
417 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
418 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
419 a2_saved, a3_saved);
420 initFullExprCleanup();
421 }
422
Richard Smith736a9472013-06-12 20:42:33 +0000423 /// \brief Queue a cleanup to be pushed after finishing the current
424 /// full-expression.
425 template <class T, class A0, class A1, class A2, class A3>
426 void pushCleanupAfterFullExpr(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
427 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
428
429 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
430
431 size_t OldSize = LifetimeExtendedCleanupStack.size();
432 LifetimeExtendedCleanupStack.resize(
433 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
434
435 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
436 new (Buffer) LifetimeExtendedCleanupHeader(Header);
437 new (Buffer + sizeof(Header)) T(a0, a1, a2, a3);
438 }
439
John McCallf4beacd2011-11-10 10:43:54 +0000440 /// Set up the last cleaup that was pushed as a conditional
441 /// full-expression cleanup.
442 void initFullExprCleanup();
443
John McCallbd309292010-07-06 01:34:17 +0000444 /// PushDestructorCleanup - Push a cleanup to call the
445 /// complete-object destructor of an object of the given type at the
446 /// given address. Does nothing if T is not a C++ class type with a
447 /// non-trivial destructor.
448 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
449
John McCall8680f872010-07-21 06:29:51 +0000450 /// PushDestructorCleanup - Push a cleanup to call the
451 /// complete-object variant of the given destructor on the object at
452 /// the given address.
453 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
454 llvm::Value *Addr);
455
John McCallbd309292010-07-06 01:34:17 +0000456 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
457 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000458 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000459
John McCall824c2f52010-09-14 07:57:04 +0000460 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
461 /// The block cannot be reactivated. Pops it if it's the top of the
462 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000463 ///
464 /// \param DominatingIP - An instruction which is known to
465 /// dominate the current IP (if set) and which lies along
466 /// all paths of execution between the current IP and the
467 /// the point at which the cleanup comes into scope.
468 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
469 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000470
471 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
472 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000473 ///
474 /// \param DominatingIP - An instruction which is known to
475 /// dominate the current IP (if set) and which lies along
476 /// all paths of execution between the current IP and the
477 /// the point at which the cleanup comes into scope.
478 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
479 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000480
John McCallbd309292010-07-06 01:34:17 +0000481 /// \brief Enters a new scope for capturing cleanups, all of which
482 /// will be executed once the scope is exited.
483 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000484 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000485 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000486 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000487 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000488 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000489 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000490
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000491 RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
492 void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
Douglas Gregor965f4502009-11-24 16:43:22 +0000493
Eric Christophera9d34972011-10-19 00:43:52 +0000494 protected:
495 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000496
Douglas Gregor965f4502009-11-24 16:43:22 +0000497 public:
498 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000499 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000500 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000501 {
John McCallbd309292010-07-06 01:34:17 +0000502 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000503 LifetimeExtendedCleanupStackSize =
504 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000505 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000506 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000507 }
508
509 /// \brief Exit this cleanup scope, emitting any accumulated
510 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000511 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000512 if (PerformCleanup) {
513 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000514 CGF.PopCleanupBlocks(CleanupStackDepth,
515 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000516 }
517 }
518
519 /// \brief Determine whether this scope requires any cleanups.
520 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000521 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000522 }
523
524 /// \brief Force the emission of cleanups now, instead of waiting
525 /// until this object is destroyed.
526 void ForceCleanup() {
527 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000528 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000529 CGF.PopCleanupBlocks(CleanupStackDepth,
530 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000531 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000532 }
533 };
534
David Blaikie93be0b22014-08-22 21:37:04 +0000535 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000536 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000537 SmallVector<const LabelDecl*, 4> Labels;
538 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000539
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000540 LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
541 void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
Eric Christophera9d34972011-10-19 00:43:52 +0000542
543 public:
544 /// \brief Enter a new cleanup scope.
545 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000546 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
547 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000548 if (CGDebugInfo *DI = CGF.getDebugInfo())
549 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
550 }
551
Nadav Rotem1da30942013-03-23 06:43:35 +0000552 void addLabel(const LabelDecl *label) {
553 assert(PerformCleanup && "adding label to dead scope?");
554 Labels.push_back(label);
555 }
556
Eric Christophera9d34972011-10-19 00:43:52 +0000557 /// \brief Exit this cleanup scope, emitting any accumulated
558 /// cleanups.
559 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000560 if (CGDebugInfo *DI = CGF.getDebugInfo())
561 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
562
Nadav Rotem1da30942013-03-23 06:43:35 +0000563 // If we should perform a cleanup, force them now. Note that
564 // this ends the cleanup scope before rescoping any labels.
565 if (PerformCleanup) ForceCleanup();
Eric Christophera9d34972011-10-19 00:43:52 +0000566 }
567
568 /// \brief Force the emission of cleanups now, instead of waiting
569 /// until this object is destroyed.
570 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000571 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000572 RunCleanupsScope::ForceCleanup();
573
Nadav Rotem1da30942013-03-23 06:43:35 +0000574 if (!Labels.empty())
575 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000576 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000577
578 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000579 };
580
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000581 /// \brief The scope used to remap some variables as private in the OpenMP
582 /// loop body (or other captured region emitted without outlining), and to
583 /// restore old vars back on exit.
584 class OMPPrivateScope : public RunCleanupsScope {
585 typedef llvm::DenseMap<const VarDecl *, llvm::Value *> VarDeclMapTy;
586 VarDeclMapTy SavedLocals;
587 VarDeclMapTy SavedPrivates;
588
589 private:
590 OMPPrivateScope(const OMPPrivateScope &) LLVM_DELETED_FUNCTION;
591 void operator=(const OMPPrivateScope &) LLVM_DELETED_FUNCTION;
592
593 public:
594 /// \brief Enter a new OpenMP private scope.
595 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
596
597 /// \brief Registers \a LocalVD variable as a private and apply \a
598 /// PrivateGen function for it to generate corresponding private variable.
599 /// \a PrivateGen returns an address of the generated private variable.
600 /// \return true if the variable is registered as private, false if it has
601 /// been privatized already.
602 bool
603 addPrivate(const VarDecl *LocalVD,
604 const std::function<llvm::Value *()> &PrivateGen) {
605 assert(PerformCleanup && "adding private to dead scope");
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000606 if (SavedLocals.count(LocalVD) > 0) return false;
607 SavedLocals[LocalVD] = CGF.LocalDeclMap.lookup(LocalVD);
608 CGF.LocalDeclMap.erase(LocalVD);
609 SavedPrivates[LocalVD] = PrivateGen();
610 CGF.LocalDeclMap[LocalVD] = SavedLocals[LocalVD];
611 return true;
612 }
613
614 /// \brief Privatizes local variables previously registered as private.
615 /// Registration is separate from the actual privatization to allow
616 /// initializers use values of the original variables, not the private one.
617 /// This is important, for example, if the private variable is a class
618 /// variable initialized by a constructor that references other private
619 /// variables. But at initialization original variables must be used, not
620 /// private copies.
621 /// \return true if at least one variable was privatized, false otherwise.
622 bool Privatize() {
623 for (auto VDPair : SavedPrivates) {
624 CGF.LocalDeclMap[VDPair.first] = VDPair.second;
625 }
626 SavedPrivates.clear();
627 return !SavedLocals.empty();
628 }
629
630 void ForceCleanup() {
631 RunCleanupsScope::ForceCleanup();
632 // Remap vars back to the original values.
633 for (auto I : SavedLocals) {
634 CGF.LocalDeclMap[I.first] = I.second;
635 }
636 SavedLocals.clear();
637 }
638
639 /// \brief Exit scope - all the mapped variables are restored.
640 ~OMPPrivateScope() { ForceCleanup(); }
641 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000642
Richard Smith736a9472013-06-12 20:42:33 +0000643 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
644 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000645 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000646
Richard Smith736a9472013-06-12 20:42:33 +0000647 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
648 /// that have been added, then adds all lifetime-extended cleanups from
649 /// the given position to the stack.
650 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
651 size_t OldLifetimeExtendedStackSize);
652
John McCallad5d61e2010-07-23 21:56:41 +0000653 void ResolveBranchFixups(llvm::BasicBlock *Target);
654
John McCallbd309292010-07-06 01:34:17 +0000655 /// The given basic block lies in the current EH scope, but may be a
656 /// target of a potentially scope-crossing jump; get a stable handle
657 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000658 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000659 return JumpDest(Target,
660 EHStack.getInnermostNormalCleanup(),
661 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000662 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000663
John McCallbd309292010-07-06 01:34:17 +0000664 /// The given basic block lies in the current EH scope, but may be a
665 /// target of a potentially scope-crossing jump; get a stable handle
666 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000667 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000668 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000669 }
670
671 /// EmitBranchThroughCleanup - Emit a branch from the current insert
672 /// block through the normal cleanup handling code (if any) and then
673 /// on to \arg Dest.
674 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000675
Justin Bognere25ffdf2014-01-21 00:35:11 +0000676 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
677 /// specified destination obviously has no cleanups to run. 'false' is always
678 /// a conservatively correct answer for this method.
679 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
680
John McCall8e4c74b2011-08-11 02:22:43 +0000681 /// popCatchScope - Pops the catch scope at the top of the EHScope
682 /// stack, emitting any required code (other than the catch handlers
683 /// themselves).
684 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000685
David Chisnall9a837be2012-11-07 16:50:40 +0000686 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000687 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000688
John McCallce1de612011-01-26 04:00:11 +0000689 /// An object to manage conditionally-evaluated expressions.
690 class ConditionalEvaluation {
691 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000692
John McCallce1de612011-01-26 04:00:11 +0000693 public:
694 ConditionalEvaluation(CodeGenFunction &CGF)
695 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000696
John McCallce1de612011-01-26 04:00:11 +0000697 void begin(CodeGenFunction &CGF) {
698 assert(CGF.OutermostConditional != this);
699 if (!CGF.OutermostConditional)
700 CGF.OutermostConditional = this;
701 }
702
703 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000704 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000705 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000706 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000707 }
708
709 /// Returns a block which will be executed prior to each
710 /// evaluation of the conditional code.
711 llvm::BasicBlock *getStartingBlock() const {
712 return StartBB;
713 }
714 };
Mike Stump11289f42009-09-09 15:08:12 +0000715
John McCall7f9c92a2010-09-17 00:50:28 +0000716 /// isInConditionalBranch - Return true if we're currently emitting
717 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000718 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000719
John McCallf4beacd2011-11-10 10:43:54 +0000720 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
721 assert(isInConditionalBranch());
722 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
723 new llvm::StoreInst(value, addr, &block->back());
724 }
725
John McCallce1de612011-01-26 04:00:11 +0000726 /// An RAII object to record that we're evaluating a statement
727 /// expression.
728 class StmtExprEvaluation {
729 CodeGenFunction &CGF;
730
731 /// We have to save the outermost conditional: cleanups in a
732 /// statement expression aren't conditional just because the
733 /// StmtExpr is.
734 ConditionalEvaluation *SavedOutermostConditional;
735
736 public:
737 StmtExprEvaluation(CodeGenFunction &CGF)
738 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000739 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000740 }
741
742 ~StmtExprEvaluation() {
743 CGF.OutermostConditional = SavedOutermostConditional;
744 CGF.EnsureInsertPoint();
745 }
746 };
John McCall1bf58462011-02-16 08:02:54 +0000747
John McCallc07a0c72011-02-17 10:25:35 +0000748 /// An object which temporarily prevents a value from being
749 /// destroyed by aggressive peephole optimizations that assume that
750 /// all uses of a value have been realized in the IR.
751 class PeepholeProtection {
752 llvm::Instruction *Inst;
753 friend class CodeGenFunction;
754
755 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000756 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000757 };
John McCallc07a0c72011-02-17 10:25:35 +0000758
John McCallfe96e0b2011-11-06 09:01:30 +0000759 /// A non-RAII class containing all the information about a bound
760 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
761 /// this which makes individual mappings very simple; using this
762 /// class directly is useful when you have a variable number of
763 /// opaque values or don't want the RAII functionality for some
764 /// reason.
765 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000766 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000767 bool BoundLValue;
768 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000769
John McCallfe96e0b2011-11-06 09:01:30 +0000770 OpaqueValueMappingData(const OpaqueValueExpr *ov,
771 bool boundLValue)
772 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000773 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000774 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000775
John McCallc07a0c72011-02-17 10:25:35 +0000776 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000777 // gl-values should be bound as l-values for obvious reasons.
778 // Records should be bound as l-values because IR generation
779 // always keeps them in memory. Expressions of function type
780 // act exactly like l-values but are formally required to be
781 // r-values in C.
782 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000783 expr->getType()->isFunctionType() ||
784 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000785 }
786
John McCallfe96e0b2011-11-06 09:01:30 +0000787 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
788 const OpaqueValueExpr *ov,
789 const Expr *e) {
790 if (shouldBindAsLValue(ov))
791 return bind(CGF, ov, CGF.EmitLValue(e));
792 return bind(CGF, ov, CGF.EmitAnyExpr(e));
793 }
794
795 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
796 const OpaqueValueExpr *ov,
797 const LValue &lv) {
798 assert(shouldBindAsLValue(ov));
799 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
800 return OpaqueValueMappingData(ov, true);
801 }
802
803 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
804 const OpaqueValueExpr *ov,
805 const RValue &rv) {
806 assert(!shouldBindAsLValue(ov));
807 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
808
809 OpaqueValueMappingData data(ov, false);
810
811 // Work around an extremely aggressive peephole optimization in
812 // EmitScalarConversion which assumes that all other uses of a
813 // value are extant.
814 data.Protection = CGF.protectFromPeepholes(rv);
815
816 return data;
817 }
818
Craig Topper8a13c412014-05-21 05:09:00 +0000819 bool isValid() const { return OpaqueValue != nullptr; }
820 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000821
822 void unbind(CodeGenFunction &CGF) {
823 assert(OpaqueValue && "no data to unbind!");
824
825 if (BoundLValue) {
826 CGF.OpaqueLValues.erase(OpaqueValue);
827 } else {
828 CGF.OpaqueRValues.erase(OpaqueValue);
829 CGF.unprotectFromPeepholes(Protection);
830 }
831 }
832 };
833
834 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
835 class OpaqueValueMapping {
836 CodeGenFunction &CGF;
837 OpaqueValueMappingData Data;
838
839 public:
840 static bool shouldBindAsLValue(const Expr *expr) {
841 return OpaqueValueMappingData::shouldBindAsLValue(expr);
842 }
843
John McCallc07a0c72011-02-17 10:25:35 +0000844 /// Build the opaque value mapping for the given conditional
845 /// operator if it's the GNU ?: extension. This is a common
846 /// enough pattern that the convenience operator is really
847 /// helpful.
848 ///
849 OpaqueValueMapping(CodeGenFunction &CGF,
850 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000851 if (isa<ConditionalOperator>(op))
852 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000853 return;
John McCallc07a0c72011-02-17 10:25:35 +0000854
855 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000856 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
857 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000858 }
859
John McCall1bf58462011-02-16 08:02:54 +0000860 OpaqueValueMapping(CodeGenFunction &CGF,
861 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000862 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000863 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000864 }
865
866 OpaqueValueMapping(CodeGenFunction &CGF,
867 const OpaqueValueExpr *opaqueValue,
868 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000869 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000870 }
871
872 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000873 Data.unbind(CGF);
874 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000875 }
876
877 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000878 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000879 }
880 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000881
882 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
883 /// number that holds the value.
884 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian2f2fa722011-01-26 23:08:27 +0000885
886 /// BuildBlockByrefAddress - Computes address location of the
887 /// variable which is declared as __block.
888 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
889 const VarDecl *V);
Chris Lattner2da04b32007-08-24 05:35:26 +0000890private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000891 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000892 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000893
John McCall9b382dd2011-05-28 21:13:02 +0000894 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
895 /// calling llvm.stacksave for multiple VLAs in the same scope.
896 bool DidCallStackSave;
897
Mike Stumpe5311b02009-11-30 20:08:49 +0000898 /// IndirectBranch - The first time an indirect goto is seen we create a block
899 /// with an indirect branch. Every time we see the address of a label taken,
900 /// we add the label to the indirect goto. Every subsequent indirect goto is
901 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000902 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000903
Mike Stumpfc496822009-02-08 23:14:22 +0000904 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
905 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000906 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
907 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000908
Chris Lattnerac248202007-05-30 00:13:02 +0000909 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000910 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000911
Mike Stumpfc496822009-02-08 23:14:22 +0000912 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000913 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000914 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000915 BreakContinue(JumpDest Break, JumpDest Continue)
916 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000917
John McCallbd309292010-07-06 01:34:17 +0000918 JumpDest BreakBlock;
919 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000920 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000921 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000922
Justin Bogneref512b92014-01-06 22:27:43 +0000923 CodeGenPGO PGO;
924
925public:
926 /// Get a counter for instrumentation of the region associated with the given
927 /// statement.
928 RegionCounter getPGORegionCounter(const Stmt *S) {
929 return RegionCounter(PGO, S);
930 }
931private:
932
Zhongxing Xu82846ea2012-01-14 09:08:15 +0000933 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +0000934 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000935 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +0000936 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
937 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +0000938
Mike Stumpfc496822009-02-08 23:14:22 +0000939 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000940 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000941 llvm::BasicBlock *CaseRangeBlock;
942
John McCallc07a0c72011-02-17 10:25:35 +0000943 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +0000944 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +0000945 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
946 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +0000947
Mike Stumpfc496822009-02-08 23:14:22 +0000948 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +0000949 // We track this by the size expression rather than the type itself because
950 // in certain situations, like a const qualifier applied to an VLA typedef,
951 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +0000952 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
953 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +0000954 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000955
John McCallbd309292010-07-06 01:34:17 +0000956 /// A block containing a single 'unreachable' instruction. Created
957 /// lazily by getUnreachableBlock().
958 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000959
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000960 /// Counts of the number return expressions in the function.
961 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +0000962
963 /// Count the number of simple (constant) return expressions in the function.
964 unsigned NumSimpleReturnExprs;
965
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000966 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +0000967 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +0000968
Richard Smith852c9db2013-04-20 22:23:05 +0000969public:
970 /// A scope within which we are constructing the fields of an object which
971 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
972 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
973 class FieldConstructionScope {
974 public:
975 FieldConstructionScope(CodeGenFunction &CGF, llvm::Value *This)
976 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
977 CGF.CXXDefaultInitExprThis = This;
978 }
979 ~FieldConstructionScope() {
980 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
981 }
982
983 private:
984 CodeGenFunction &CGF;
985 llvm::Value *OldCXXDefaultInitExprThis;
986 };
987
988 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
989 /// is overridden to be the object under construction.
990 class CXXDefaultInitExprScope {
991 public:
992 CXXDefaultInitExprScope(CodeGenFunction &CGF)
993 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue) {
994 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis;
995 }
996 ~CXXDefaultInitExprScope() {
997 CGF.CXXThisValue = OldCXXThisValue;
998 }
999
1000 public:
1001 CodeGenFunction &CGF;
1002 llvm::Value *OldCXXThisValue;
1003 };
1004
1005private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001006 /// CXXThisDecl - When generating code for a C++ member function,
1007 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001008 ImplicitParamDecl *CXXABIThisDecl;
1009 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001010 llvm::Value *CXXThisValue;
Mike Stump11289f42009-09-09 15:08:12 +00001011
Richard Smith852c9db2013-04-20 22:23:05 +00001012 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1013 /// this expression.
1014 llvm::Value *CXXDefaultInitExprThis;
1015
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001016 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1017 /// destructor, this will hold the implicit argument (e.g. VTT).
1018 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1019 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001020
John McCallce1de612011-01-26 04:00:11 +00001021 /// OutermostConditional - Points to the outermost active
1022 /// conditional control. This is used so that we know if a
1023 /// temporary should be destroyed conditionally.
1024 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001025
Nadav Rotem1da30942013-03-23 06:43:35 +00001026 /// The current lexical scope.
1027 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001028
Adrian Prantldc237b52013-05-16 00:41:26 +00001029 /// The current source location that should be used for exception
1030 /// handling code.
1031 SourceLocation CurEHLocation;
1032
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001033 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1034 /// type as well as the field number that contains the actual data.
Chris Lattner2192fe52011-07-18 04:24:23 +00001035 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001036 unsigned> > ByRefValueInfo;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001037
John McCallbd309292010-07-06 01:34:17 +00001038 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001039 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001040 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001041
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001042 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1043 /// In the kernel metadata node, reference the kernel function and metadata
1044 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001045 /// - A node for the vec_type_hint(<type>) qualifier contains string
1046 /// "vec_type_hint", an undefined value of the <type> data type,
1047 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001048 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1049 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1050 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1051 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1052 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1053 llvm::Function *Fn);
1054
Chris Lattnerbed31442007-05-28 01:07:47 +00001055public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001056 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001057 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001058
John McCall8ed55a52010-09-02 09:58:18 +00001059 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001060 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001061 CGDebugInfo *getDebugInfo() {
1062 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001063 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001064 return DebugInfo;
1065 }
1066 void disableDebugInfo() { DisableDebugInfo = true; }
1067 void enableDebugInfo() { DisableDebugInfo = false; }
1068
John McCall31168b02011-06-15 23:02:42 +00001069 bool shouldUseFusedARCCalls() {
1070 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1071 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001072
David Blaikiebbafb8a2012-03-11 07:00:24 +00001073 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001074
Bill Wendlingf0724e82011-09-19 20:31:14 +00001075 /// Returns a pointer to the function's exception object and selector slot,
1076 /// which is assigned in every landing pad.
John McCallbd309292010-07-06 01:34:17 +00001077 llvm::Value *getExceptionSlot();
John McCall9b382dd2011-05-28 21:13:02 +00001078 llvm::Value *getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001079
Bill Wendling79a70e42011-09-15 18:57:19 +00001080 /// Returns the contents of the function's exception object and selector
1081 /// slots.
1082 llvm::Value *getExceptionFromSlot();
1083 llvm::Value *getSelectorFromSlot();
1084
John McCallad5d61e2010-07-23 21:56:41 +00001085 llvm::Value *getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001086
John McCallbd309292010-07-06 01:34:17 +00001087 llvm::BasicBlock *getUnreachableBlock() {
1088 if (!UnreachableBlock) {
1089 UnreachableBlock = createBasicBlock("unreachable");
1090 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1091 }
1092 return UnreachableBlock;
1093 }
1094
1095 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001096 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001097 return getInvokeDestImpl();
1098 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001099
John McCallc8e01702013-04-16 22:48:15 +00001100 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001101 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001102
Daniel Dunbar12347492009-02-23 17:26:39 +00001103 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001104 // Cleanups
1105 //===--------------------------------------------------------------------===//
1106
1107 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1108
John McCall178360e2011-07-11 08:38:19 +00001109 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1110 llvm::Value *arrayEndPointer,
1111 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001112 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001113 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1114 llvm::Value *arrayEnd,
1115 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001116 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001117
John McCall4bd0fb12011-07-12 16:41:08 +00001118 void pushDestroy(QualType::DestructionKind dtorKind,
1119 llvm::Value *addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001120 void pushEHDestroy(QualType::DestructionKind dtorKind,
1121 llvm::Value *addr, QualType type);
John McCall82fe67b2011-07-09 01:37:26 +00001122 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001123 Destroyer *destroyer, bool useEHCleanupForArray);
Richard Smith736a9472013-06-12 20:42:33 +00001124 void pushLifetimeExtendedDestroy(CleanupKind kind, llvm::Value *addr,
1125 QualType type, Destroyer *destroyer,
1126 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001127 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1128 llvm::Value *CompletePtr,
1129 QualType ElementType);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001130 void pushStackRestore(CleanupKind kind, llvm::Value *SPMem);
Peter Collingbourne1425b452012-01-26 03:33:36 +00001131 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001132 bool useEHCleanupForArray);
David Blaikieebe87e12013-08-27 23:57:18 +00001133 llvm::Function *generateDestroyHelper(llvm::Constant *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001134 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001135 bool useEHCleanupForArray,
1136 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001137 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001138 QualType type, Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001139 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001140
Peter Collingbourne1425b452012-01-26 03:33:36 +00001141 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001142
John McCall82fe67b2011-07-09 01:37:26 +00001143 /// Determines whether an EH cleanup is required to destroy a type
1144 /// with the given destruction kind.
1145 bool needsEHCleanup(QualType::DestructionKind kind) {
1146 switch (kind) {
1147 case QualType::DK_none:
1148 return false;
1149 case QualType::DK_cxx_destructor:
1150 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001151 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001152 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001153 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001154 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1155 }
1156 llvm_unreachable("bad destruction kind");
1157 }
1158
John McCall4bd0fb12011-07-12 16:41:08 +00001159 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1160 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1161 }
1162
John McCall82fe67b2011-07-09 01:37:26 +00001163 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001164 // Objective-C
1165 //===--------------------------------------------------------------------===//
1166
Chris Lattner4bd55962008-03-30 23:03:07 +00001167 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001168
David Blaikief1425802015-01-14 00:04:42 +00001169 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001170
Mike Stumpfc496822009-02-08 23:14:22 +00001171 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001172 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1173 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001174 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001175 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001176 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001177 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001178
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001179 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1180 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001181
Mike Stumpfc496822009-02-08 23:14:22 +00001182 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1183 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001184 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1185 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001186 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001187 const ObjCPropertyImplDecl *propImpl,
1188 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian08b0f662010-04-13 00:38:05 +00001189 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001190 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001191
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001192 //===--------------------------------------------------------------------===//
1193 // Block Bits
1194 //===--------------------------------------------------------------------===//
1195
John McCall351762c2011-02-07 10:33:21 +00001196 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001197 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1198 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garstfc83aa02010-02-23 21:51:17 +00001199 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001200 const CGBlockInfo &Info,
Chris Lattner2192fe52011-07-18 04:24:23 +00001201 llvm::StructType *,
John McCallad7c5c12011-02-08 08:22:06 +00001202 llvm::Constant *BlockVarLayout);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001203
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001204 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001205 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001206 const DeclMapTy &ldm,
1207 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001208
John McCallad7c5c12011-02-08 08:22:06 +00001209 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1210 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001211 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1212 const ObjCPropertyImplDecl *PID);
1213 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1214 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001215 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001216
John McCallad7c5c12011-02-08 08:22:06 +00001217 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1218
John McCall73064872011-03-31 01:59:53 +00001219 class AutoVarEmission;
1220
1221 void emitByrefStructureInit(const AutoVarEmission &emission);
1222 void enterByrefCleanup(const AutoVarEmission &emission);
1223
John McCall351762c2011-02-07 10:33:21 +00001224 llvm::Value *LoadBlockStruct() {
1225 assert(BlockPointer && "no block pointer set!");
1226 return BlockPointer;
1227 }
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001228
John McCall87fe5d52010-05-20 01:18:31 +00001229 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCall113bee02012-03-10 09:33:50 +00001230 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall351762c2011-02-07 10:33:21 +00001231 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2192fe52011-07-18 04:24:23 +00001232 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001233
John McCalla738c252011-03-09 04:27:21 +00001234 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1235 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001236 /// \brief Emit code for the start of a function.
1237 /// \param Loc The location to be associated with the function.
1238 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001239 void StartFunction(GlobalDecl GD,
1240 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001241 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001242 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001243 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001244 SourceLocation Loc = SourceLocation(),
1245 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001246
John McCallb81884d2010-02-19 09:25:03 +00001247 void EmitConstructorBody(FunctionArgList &Args);
1248 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001249 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001250 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Bob Wilsonbf854f02014-02-17 19:21:09 +00001251 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, RegionCounter &Cnt);
John McCall89b12b32010-02-18 03:17:58 +00001252
Faisal Vali571df122013-09-29 08:45:24 +00001253 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001254 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001255 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001256 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001257 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1258 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001259 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001260
David Blaikiea0a1a872015-01-18 02:48:07 +00001261 /// \brief Emit the unified return block, trying to avoid its emission when
1262 /// possible.
1263 /// \return The debug location of the user written return statement if the
1264 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001265 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001266
Mike Stumpfc496822009-02-08 23:14:22 +00001267 /// FinishFunction - Complete IR generation of the current function. It is
1268 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001269 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001270
Hans Wennborg88497d62013-11-15 17:24:45 +00001271 void StartThunk(llvm::Function *Fn, GlobalDecl GD, const CGFunctionInfo &FnInfo);
1272
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001273 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001274
Reid Klecknerab2090d2014-07-26 01:34:32 +00001275 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1276 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1277 llvm::Value *Callee);
1278
Anders Carlssonbad991d2010-03-24 00:39:18 +00001279 /// GenerateThunk - Generate a thunk for the given method.
John McCalla738c252011-03-09 04:27:21 +00001280 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1281 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001282
Eli Friedman49a94b12011-05-06 17:27:27 +00001283 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1284 GlobalDecl GD, const ThunkInfo &Thunk);
1285
Douglas Gregor94f9a482010-05-05 05:51:00 +00001286 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1287 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001288
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001289 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001290 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001291
Anders Carlssone87fae92010-03-28 19:40:00 +00001292 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1293 /// subobject.
1294 ///
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001295 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001296 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001297 CharUnits OffsetFromNearestVBase,
Anders Carlssone87fae92010-03-28 19:40:00 +00001298 const CXXRecordDecl *VTableClass);
1299
1300 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001301 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001302 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001303 CharUnits OffsetFromNearestVBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001304 bool BaseIsNonVirtualPrimaryBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001305 const CXXRecordDecl *VTableClass,
1306 VisitedVirtualBasesSetTy& VBases);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001307
Anders Carlssond5895932010-03-28 21:07:49 +00001308 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001309
Dan Gohman8fc50c22010-10-26 18:44:08 +00001310 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1311 /// to by This.
Chris Lattner2192fe52011-07-18 04:24:23 +00001312 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssone87fae92010-03-28 19:40:00 +00001313
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001314
1315 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1316 /// expr can be devirtualized.
1317 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1318 const CXXMethodDecl *MD);
1319
John McCallf99a6312010-07-21 05:30:47 +00001320 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1321 /// given phase of destruction for a destructor. The end result
1322 /// should call destructors on members and base classes in reverse
1323 /// order of their construction.
1324 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001325
Chris Lattner3c77a352010-06-22 00:03:40 +00001326 /// ShouldInstrumentFunction - Return true if the current function should be
1327 /// instrumented with __cyg_profile_func_* calls
1328 bool ShouldInstrumentFunction();
1329
1330 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1331 /// instrumentation function with the current function and the call site, if
1332 /// function instrumentation is enabled.
1333 void EmitFunctionInstrumentation(const char *Fn);
1334
Roman Divacky178e01602011-02-10 16:52:03 +00001335 /// EmitMCountInstrumentation - Emit call to .mcount.
1336 void EmitMCountInstrumentation();
1337
Mike Stumpfc496822009-02-08 23:14:22 +00001338 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1339 /// arguments for the given function. This is also responsible for naming the
1340 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001341 void EmitFunctionProlog(const CGFunctionInfo &FI,
1342 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001343 const FunctionArgList &Args);
1344
Mike Stumpfc496822009-02-08 23:14:22 +00001345 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1346 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001347 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1348 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001349
Mike Stump1d849212009-12-07 23:38:24 +00001350 /// EmitStartEHSpec - Emit the start of the exception spec.
1351 void EmitStartEHSpec(const Decl *D);
1352
1353 /// EmitEndEHSpec - Emit the end of the exception spec.
1354 void EmitEndEHSpec(const Decl *D);
1355
John McCallbd309292010-07-06 01:34:17 +00001356 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1357 llvm::BasicBlock *getTerminateLandingPad();
1358
1359 /// getTerminateHandler - Return a handler (not a landing pad, just
1360 /// a catch handler) that just calls terminate. This is used when
1361 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001362 llvm::BasicBlock *getTerminateHandler();
1363
Chris Lattnera5f58b02011-07-09 17:41:47 +00001364 llvm::Type *ConvertTypeForMem(QualType T);
1365 llvm::Type *ConvertType(QualType T);
1366 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001367 return ConvertType(getContext().getTypeDeclType(T));
1368 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001369
Mike Stumpfc496822009-02-08 23:14:22 +00001370 /// LoadObjCSelf - Load the value of self. This function is only valid while
1371 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001372 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001373
1374 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001375 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001376
Chris Lattner54fb19e2007-06-22 22:02:34 +00001377 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1378 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001379 static TypeEvaluationKind getEvaluationKind(QualType T);
1380
1381 static bool hasScalarEvaluationKind(QualType T) {
1382 return getEvaluationKind(T) == TEK_Scalar;
1383 }
1384
1385 static bool hasAggregateEvaluationKind(QualType T) {
1386 return getEvaluationKind(T) == TEK_Aggregate;
1387 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001388
1389 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001390 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001391 llvm::Function *parent = nullptr,
1392 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001393#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001394 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001395#else
John McCallad7c5c12011-02-08 08:22:06 +00001396 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001397#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001398 }
Mike Stumpfc496822009-02-08 23:14:22 +00001399
Chris Lattnerac248202007-05-30 00:13:02 +00001400 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1401 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001402 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001403
Mike Stumpe5311b02009-11-30 20:08:49 +00001404 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1405 /// another basic block, simplify it. This assumes that no other code could
1406 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001407 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1408
Mike Stumpfc496822009-02-08 23:14:22 +00001409 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1410 /// adding a fall-through branch from the current insert block if
1411 /// necessary. It is legal to call this function even if there is no current
1412 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001413 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001414 /// IsFinished - If true, indicates that the caller has finished emitting
1415 /// branches to the given block and does not expect to emit code into it. This
1416 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001417 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001418
John McCall8e4c74b2011-08-11 02:22:43 +00001419 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1420 /// near its uses, and leave the insertion point in it.
1421 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1422
Mike Stumpfc496822009-02-08 23:14:22 +00001423 /// EmitBranch - Emit a branch to the specified basic block from the current
1424 /// insert block, taking care to avoid creation of branches from dummy
1425 /// blocks. It is legal to call this function even if there is no current
1426 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001427 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001428 /// This function clears the current insertion point. The caller should follow
1429 /// calls to this function with calls to Emit*Block prior to generation new
1430 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001431 void EmitBranch(llvm::BasicBlock *Block);
1432
Mike Stumpfc496822009-02-08 23:14:22 +00001433 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1434 /// indicates that the current code being emitted is unreachable.
1435 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001436 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001437 }
1438
Mike Stumpfc496822009-02-08 23:14:22 +00001439 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1440 /// emitted IR has a place to go. Note that by definition, if this function
1441 /// creates a block then that block is unreachable; callers may do better to
1442 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001443 void EnsureInsertPoint() {
1444 if (!HaveInsertPoint())
1445 EmitBlock(createBasicBlock());
1446 }
Mike Stumpfc496822009-02-08 23:14:22 +00001447
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001448 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001449 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001450 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001451
Chris Lattnere9a64532007-06-22 21:44:33 +00001452 //===--------------------------------------------------------------------===//
1453 // Helpers
1454 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001455
Eli Friedmana0544d62011-12-03 04:14:32 +00001456 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1457 CharUnits Alignment = CharUnits()) {
Dan Gohman947c9af2010-10-14 23:06:10 +00001458 return LValue::MakeAddr(V, T, Alignment, getContext(),
1459 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001460 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001461
David Majnemer99281062014-09-18 22:05:54 +00001462 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001463
Chris Lattnere9a64532007-06-22 21:44:33 +00001464 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001465 /// block. The caller is responsible for setting an appropriate alignment on
1466 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001467 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001468 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001469
John McCall2e6567a2010-04-22 01:10:34 +00001470 /// InitTempAlloca - Provide an initial value for the given alloca.
1471 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1472
Daniel Dunbard0049182010-02-16 19:44:13 +00001473 /// CreateIRTemp - Create a temporary IR object of the given type, with
1474 /// appropriate alignment. This routine should only be used when an temporary
1475 /// value needs to be stored into an alloca (for example, to avoid explicit
1476 /// PHI construction), but the type is the IR type, not the type appropriate
1477 /// for storing in memory.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001478 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001479
Daniel Dunbara7566f12010-02-09 02:48:28 +00001480 /// CreateMemTemp - Create a temporary memory object of the given type, with
1481 /// appropriate alignment.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001482 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001483
John McCall7a626f62010-09-15 10:14:12 +00001484 /// CreateAggTemp - Create a temporary memory object for the given
1485 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001486 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedman38cd36d2011-12-03 02:13:40 +00001487 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001488 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1489 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001490 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001491 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001492 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001493 }
1494
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001495 /// CreateInAllocaTmp - Create a temporary memory object for the given
1496 /// aggregate type.
1497 AggValueSlot CreateInAllocaTmp(QualType T, const Twine &Name = "inalloca");
1498
John McCallad7c5c12011-02-08 08:22:06 +00001499 /// Emit a cast to void* in the appropriate address space.
1500 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1501
Chris Lattner8394d792007-06-05 20:53:16 +00001502 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1503 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001504 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001505
John McCalla2342eb2010-12-05 02:00:02 +00001506 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1507 void EmitIgnoredExpr(const Expr *E);
1508
Chris Lattner4647a212007-08-31 22:49:20 +00001509 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1510 /// any type. The result is returned as an RValue struct. If this is an
1511 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1512 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001513 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001514 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001515 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001516 AggValueSlot aggSlot = AggValueSlot::ignored(),
1517 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001518
Mike Stumpfc496822009-02-08 23:14:22 +00001519 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1520 // or the value of the expression, depending on how va_list is defined.
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001521 llvm::Value *EmitVAListRef(const Expr *E);
1522
Mike Stumpfc496822009-02-08 23:14:22 +00001523 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1524 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001525 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001526
John McCall91ca10f2011-03-08 09:11:50 +00001527 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001528 /// arbitrary expression into the given memory location.
John McCall21886962010-04-21 10:05:39 +00001529 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001530 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001531
John McCall91ca10f2011-03-08 09:11:50 +00001532 /// EmitExprAsInit - Emits the code necessary to initialize a
1533 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001534 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001535 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001536
Fariborz Jahanian78652202013-01-25 23:57:05 +00001537 /// hasVolatileMember - returns true if aggregate type has a volatile
1538 /// member.
1539 bool hasVolatileMember(QualType T) {
1540 if (const RecordType *RT = T->getAs<RecordType>()) {
1541 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1542 return RD->hasVolatileMember();
1543 }
1544 return false;
1545 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001546 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001547 ///
1548 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1549 /// This is required for correctness when assigning non-POD structures in C++.
1550 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001551 QualType EltTy) {
1552 bool IsVolatile = hasVolatileMember(EltTy);
1553 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1554 true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001555 }
1556
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001557 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001558 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001559 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001560 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001561 /// \param isAssignment - If false, allow padding to be copied. This often
1562 /// yields more efficient.
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001563 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001564 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001565 CharUnits Alignment = CharUnits::Zero(),
1566 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001567
Devang Patelda5d6bb2007-10-04 23:45:31 +00001568 /// StartBlock - Start new block named N. If insert block is a dummy block
1569 /// then reuse it.
1570 void StartBlock(const char *N);
1571
Anders Carlsson9396a892008-09-11 09:15:33 +00001572 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall5d865c322010-08-31 07:33:07 +00001573 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1574 llvm::Value *Res = LocalDeclMap[VD];
1575 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1576 return Res;
1577 }
Mike Stumpfc496822009-02-08 23:14:22 +00001578
John McCallc07a0c72011-02-17 10:25:35 +00001579 /// getOpaqueLValueMapping - Given an opaque value expression (which
1580 /// must be mapped to an l-value), return its mapping.
1581 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1582 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1583
1584 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1585 it = OpaqueLValues.find(e);
1586 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1587 return it->second;
1588 }
1589
1590 /// getOpaqueRValueMapping - Given an opaque value expression (which
1591 /// must be mapped to an r-value), return its mapping.
1592 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1593 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1594
1595 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1596 it = OpaqueRValues.find(e);
1597 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001598 return it->second;
1599 }
1600
Dan Gohman75d69da2008-05-22 00:50:06 +00001601 /// getAccessedFieldNo - Given an encoded value and a result number, return
1602 /// the input field number being accessed.
1603 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1604
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001605 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001606 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001607
Anders Carlssonc0964b62010-05-22 17:35:42 +00001608 /// EmitNullInitialization - Generate code to set a value of the given type to
1609 /// null, If the type contains data member pointers, they will be initialized
1610 /// to -1 in accordance with the Itanium C++ ABI.
1611 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001612
1613 // EmitVAArg - Generate code to get an argument from the passed in pointer
1614 // and update it accordingly. The return value is a pointer to the argument.
1615 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001616 // instruction in LLVM instead once it works well enough.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001617 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001618
John McCall82fe67b2011-07-09 01:37:26 +00001619 /// emitArrayLength - Compute the length of an array, even if it's a
1620 /// VLA, and drill down to the base element type.
1621 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1622 QualType &baseType,
1623 llvm::Value *&addr);
1624
John McCall23c29fe2011-06-24 21:55:10 +00001625 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1626 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001627 ///
1628 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001629 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001630
John McCall23c29fe2011-06-24 21:55:10 +00001631 /// getVLASize - Returns an LLVM value that corresponds to the size,
1632 /// in non-variably-sized elements, of a variable length array type,
1633 /// plus that largest non-variably-sized element type. Assumes that
1634 /// the type has already been emitted with EmitVariablyModifiedType.
1635 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1636 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001637
Anders Carlssona5d077d2009-04-14 16:58:56 +00001638 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1639 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001640 llvm::Value *LoadCXXThis() {
1641 assert(CXXThisValue && "no 'this' value for this function");
1642 return CXXThisValue;
1643 }
Mike Stump11289f42009-09-09 15:08:12 +00001644
Anders Carlssone36a6b32010-01-02 01:01:18 +00001645 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1646 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001647 // FIXME: Every place that calls LoadCXXVTT is something
1648 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001649 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001650 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1651 return CXXStructorImplicitParamValue;
1652 }
1653
1654 /// LoadCXXStructorImplicitParam - Load the implicit parameter
1655 /// for a constructor/destructor.
1656 llvm::Value *LoadCXXStructorImplicitParam() {
1657 assert(CXXStructorImplicitParamValue &&
1658 "no implicit argument value for this function");
1659 return CXXStructorImplicitParamValue;
John McCall347132b2010-02-16 22:04:33 +00001660 }
John McCall6ce74722010-02-16 04:15:37 +00001661
1662 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001663 /// complete class to the given direct base.
1664 llvm::Value *
1665 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1666 const CXXRecordDecl *Derived,
1667 const CXXRecordDecl *Base,
1668 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001669
Mike Stumpe5311b02009-11-30 20:08:49 +00001670 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1671 /// load of 'this' and returns address of the base class.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001672 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001673 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001674 CastExpr::path_const_iterator PathBegin,
1675 CastExpr::path_const_iterator PathEnd,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001676 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001677
Anders Carlsson8c793172009-11-23 17:57:54 +00001678 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001679 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001680 CastExpr::path_const_iterator PathBegin,
1681 CastExpr::path_const_iterator PathEnd,
Anders Carlsson8c793172009-11-23 17:57:54 +00001682 bool NullCheckValue);
1683
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001684 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1685 /// base constructor/destructor with virtual bases.
1686 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1687 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1688 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1689 bool Delegating);
1690
John McCallf8ff7b92010-02-23 00:48:20 +00001691 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1692 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001693 const FunctionArgList &Args,
1694 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001695 // It's important not to confuse this and the previous function. Delegating
1696 // constructors are the C++0x feature. The constructor delegate optimization
1697 // is used to reduce duplication in the base and complete consturctors where
1698 // they are substantially the same.
1699 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1700 const FunctionArgList &Args);
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001701 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001702 bool ForVirtualBase, bool Delegating,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001703 llvm::Value *This, const CXXConstructExpr *E);
1704
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001705 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1706 llvm::Value *This, llvm::Value *Src,
Alexey Samsonov525bf652014-08-25 21:58:56 +00001707 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001708
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001709 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001710 const ConstantArrayType *ArrayTy,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001711 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001712 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001713 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001714
Anders Carlssond49844b2009-09-23 02:45:36 +00001715 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1716 llvm::Value *NumElements,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001717 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001718 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001719 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001720
John McCall82fe67b2011-07-09 01:37:26 +00001721 static Destroyer destroyCXXObject;
1722
Anders Carlsson0a637412009-05-29 21:03:38 +00001723 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001724 bool ForVirtualBase, bool Delegating,
1725 llvm::Value *This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001726
John McCall99210dc2011-09-15 06:49:18 +00001727 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
Richard Smith06a67e22014-06-03 06:58:52 +00001728 llvm::Value *NewPtr, llvm::Value *NumElements,
1729 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00001730
Peter Collingbourne702b2842011-11-27 22:09:22 +00001731 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1732 llvm::Value *Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001733
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001734 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001735 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001736
Eli Friedman24f55432009-11-18 00:57:03 +00001737 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1738 QualType DeleteTy);
1739
Richard Smith760520b2014-06-03 23:27:44 +00001740 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1741 const Expr *Arg, bool IsDelete);
1742
Mike Stumpc9b231c2009-11-15 08:09:41 +00001743 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stump65511702009-11-16 06:50:58 +00001744 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Nico Webercf4ff5862012-10-11 10:13:44 +00001745 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001746
Richard Smith69d0d262012-08-24 00:54:33 +00001747 /// \brief Situations in which we might emit a check for the suitability of a
1748 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001749 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001750 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001751 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001752 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001753 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001754 /// Checking the bound value in a reference binding. Must be suitably sized
1755 /// and aligned, but is not required to refer to an object (until the
1756 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001757 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001758 /// Checking the object expression in a non-static data member access. Must
1759 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001760 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001761 /// Checking the 'this' pointer for a call to a non-static member function.
1762 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001763 TCK_MemberCall,
1764 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001765 TCK_ConstructorCall,
1766 /// Checking the operand of a static_cast to a derived pointer type. Must be
1767 /// null or an object within its lifetime.
1768 TCK_DowncastPointer,
1769 /// Checking the operand of a static_cast to a derived reference type. Must
1770 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001771 TCK_DowncastReference,
1772 /// Checking the operand of a cast to a base object. Must be suitably sized
1773 /// and aligned.
1774 TCK_Upcast,
1775 /// Checking the operand of a cast to a virtual base object. Must be an
1776 /// object within its lifetime.
1777 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00001778 };
1779
Alexey Samsonovac4afe42014-07-07 23:59:57 +00001780 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
1781 /// calls to EmitTypeCheck can be skipped.
1782 bool sanitizePerformTypeCheck() const;
1783
Richard Smith4d1458e2012-09-08 02:08:36 +00001784 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001785 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001786 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001787 QualType Type, CharUnits Alignment = CharUnits::Zero(),
1788 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001789
Richard Smith539e4a72013-02-23 02:53:19 +00001790 /// \brief Emit a check that \p Base points into an array object, which
1791 /// we can access at index \p Index. \p Accessed should be \c false if we
1792 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1793 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1794 QualType IndexType, bool Accessed);
1795
Chris Lattner116ce8f2010-01-09 21:40:03 +00001796 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1797 bool isInc, bool isPre);
1798 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1799 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00001800
1801 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00001802 llvm::Value *OffsetValue = nullptr) {
1803 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
1804 OffsetValue);
1805 }
Hal Finkelbcc06082014-09-07 22:58:14 +00001806
Chris Lattner8394d792007-06-05 20:53:16 +00001807 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001808 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001809 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001810
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001811 /// EmitDecl - Emit a declaration.
1812 ///
1813 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001814 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001815
John McCall1c9c3fd2010-10-15 04:57:14 +00001816 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001817 ///
1818 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001819 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001820
David Blaikie73ca5692014-12-09 00:32:22 +00001821 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001822 bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00001823 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001824
John McCallbd309292010-07-06 01:34:17 +00001825 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1826 llvm::Value *Address);
1827
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001828 /// \brief Determine whether the given initializer is trivial in the sense
1829 /// that it requires no code to be generated.
1830 bool isTrivialInitializer(const Expr *Init);
1831
John McCall1c9c3fd2010-10-15 04:57:14 +00001832 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001833 ///
1834 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00001835 void EmitAutoVarDecl(const VarDecl &D);
1836
1837 class AutoVarEmission {
1838 friend class CodeGenFunction;
1839
John McCall9e2e22f2011-02-22 07:16:58 +00001840 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00001841
1842 /// The alignment of the variable.
1843 CharUnits Alignment;
1844
1845 /// The address of the alloca. Null if the variable was emitted
1846 /// as a global constant.
1847 llvm::Value *Address;
1848
1849 llvm::Value *NRVOFlag;
1850
1851 /// True if the variable is a __block variable.
1852 bool IsByRef;
1853
1854 /// True if the variable is of aggregate type and has a constant
1855 /// initializer.
1856 bool IsConstantAggregate;
1857
Nadav Rotem1da30942013-03-23 06:43:35 +00001858 /// Non-null if we should use lifetime annotations.
1859 llvm::Value *SizeForLifetimeMarkers;
1860
John McCall9e2e22f2011-02-22 07:16:58 +00001861 struct Invalid {};
Craig Topper8a13c412014-05-21 05:09:00 +00001862 AutoVarEmission(Invalid) : Variable(nullptr) {}
John McCall9e2e22f2011-02-22 07:16:58 +00001863
John McCallc533cb72011-02-22 06:44:22 +00001864 AutoVarEmission(const VarDecl &variable)
Craig Topper8a13c412014-05-21 05:09:00 +00001865 : Variable(&variable), Address(nullptr), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00001866 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00001867 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00001868
Craig Topper8a13c412014-05-21 05:09:00 +00001869 bool wasEmittedAsGlobal() const { return Address == nullptr; }
John McCallc533cb72011-02-22 06:44:22 +00001870
1871 public:
John McCall9e2e22f2011-02-22 07:16:58 +00001872 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1873
Craig Topper8a13c412014-05-21 05:09:00 +00001874 bool useLifetimeMarkers() const {
1875 return SizeForLifetimeMarkers != nullptr;
1876 }
Nadav Rotem1da30942013-03-23 06:43:35 +00001877 llvm::Value *getSizeForLifetimeMarkers() const {
1878 assert(useLifetimeMarkers());
1879 return SizeForLifetimeMarkers;
1880 }
1881
1882 /// Returns the raw, allocated address, which is not necessarily
1883 /// the address of the object itself.
1884 llvm::Value *getAllocatedAddress() const {
1885 return Address;
1886 }
1887
John McCallc533cb72011-02-22 06:44:22 +00001888 /// Returns the address of the object within this declaration.
1889 /// Note that this does not chase the forwarding pointer for
1890 /// __block decls.
1891 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1892 if (!IsByRef) return Address;
1893
1894 return CGF.Builder.CreateStructGEP(Address,
John McCall9e2e22f2011-02-22 07:16:58 +00001895 CGF.getByRefValueLLVMField(Variable),
1896 Variable->getNameAsString());
John McCallc533cb72011-02-22 06:44:22 +00001897 }
1898 };
1899 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1900 void EmitAutoVarInit(const AutoVarEmission &emission);
1901 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00001902 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1903 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001904
John McCall1c9c3fd2010-10-15 04:57:14 +00001905 void EmitStaticVarDecl(const VarDecl &D,
1906 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001907
1908 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001909 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, bool ArgIsPointer,
1910 unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00001911
John McCallc07a0c72011-02-17 10:25:35 +00001912 /// protectFromPeepholes - Protect a value that we're intending to
1913 /// store to the side, but which will probably be used later, from
1914 /// aggressive peepholing optimizations that might delete it.
1915 ///
1916 /// Pass the result to unprotectFromPeepholes to declare that
1917 /// protection is no longer required.
1918 ///
1919 /// There's no particular reason why this shouldn't apply to
1920 /// l-values, it's just that no existing peepholes work on pointers.
1921 PeepholeProtection protectFromPeepholes(RValue rvalue);
1922 void unprotectFromPeepholes(PeepholeProtection protection);
1923
Chris Lattner84915fa2007-06-02 04:16:21 +00001924 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00001925 // Statement Emission
1926 //===--------------------------------------------------------------------===//
1927
Mike Stumpfc496822009-02-08 23:14:22 +00001928 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001929 void EmitStopPoint(const Stmt *S);
1930
Mike Stumpfc496822009-02-08 23:14:22 +00001931 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1932 /// this function even if there is no current insertion point.
1933 ///
1934 /// This function may clear the current insertion point; callers should use
1935 /// EnsureInsertPoint if they wish to subsequently generate code without first
1936 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00001937 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001938
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001939 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00001940 /// necessarily require an insertion point or debug information; typically
1941 /// because the statement amounts to a jump or a container of other
1942 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001943 ///
1944 /// \return True if the statement was handled.
1945 bool EmitSimpleStmt(const Stmt *S);
1946
Eli Friedman4871a462013-06-10 22:04:49 +00001947 llvm::Value *EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
1948 AggValueSlot AVS = AggValueSlot::ignored());
1949 llvm::Value *EmitCompoundStmtWithoutScope(const CompoundStmt &S,
1950 bool GetLast = false,
1951 AggValueSlot AVS =
1952 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001953
Mike Stumpfc496822009-02-08 23:14:22 +00001954 /// EmitLabel - Emit the block for the given label. It is legal to call this
1955 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001956 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001957
Chris Lattnerac248202007-05-30 00:13:02 +00001958 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00001959 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00001960 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001961 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00001962 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001963
1964 void EmitCondBrHints(llvm::LLVMContext &Context, llvm::BranchInst *CondBr,
Craig Topper3cb91b22014-08-27 06:28:16 +00001965 ArrayRef<const Attr *> Attrs);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001966 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00001967 ArrayRef<const Attr *> Attrs = None);
1968 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001969 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00001970 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00001971 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00001972 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001973 void EmitBreakStmt(const BreakStmt &S);
1974 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00001975 void EmitSwitchStmt(const SwitchStmt &S);
1976 void EmitDefaultStmt(const DefaultStmt &S);
1977 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00001978 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00001979 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00001980
Anders Carlsson2e744e82008-08-30 19:51:14 +00001981 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001982 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
1983 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00001984 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00001985 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00001986
John McCallb609d3f2010-07-07 06:56:46 +00001987 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
1988 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00001989
Anders Carlsson52d78a52009-09-27 18:58:34 +00001990 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00001991 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00001992 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001993 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00001994 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001995
Alexey Bataev330de032014-10-29 12:21:55 +00001996 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00001997 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001998 void GenerateCapturedStmtFunctionProlog(const CapturedStmt &S);
1999 llvm::Function *GenerateCapturedStmtFunctionEpilog(const CapturedStmt &S);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002000 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev9959db52014-05-06 10:08:46 +00002001 llvm::Value *GenerateCapturedStmtArgument(const CapturedStmt &S);
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002002 void EmitOMPAggregateAssign(LValue OriginalAddr, llvm::Value *PrivateAddr,
2003 const Expr *AssignExpr, QualType Type,
2004 const VarDecl *VDInit);
2005 void EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002006 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002007 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2008 OMPPrivateScope &PrivateScope);
Alexey Bataev9959db52014-05-06 10:08:46 +00002009
2010 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002011 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002012 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002013 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002014 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002015 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002016 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002017 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002018 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002019 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002020 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002021 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002022 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002023 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002024 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002025 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002026 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002027 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002028 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002029 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002030 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002031
Alexander Musmanc6388682014-12-15 07:07:06 +00002032private:
2033
2034 /// Helpers for the OpenMP loop directives.
Alexander Musmand196ef22014-10-07 08:57:09 +00002035 void EmitOMPLoopBody(const OMPLoopDirective &Directive,
2036 bool SeparateIter = false);
2037 void EmitOMPInnerLoop(const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
2038 bool SeparateIter = false);
Alexander Musmana5f070a2014-10-01 06:03:56 +00002039 void EmitOMPSimdFinal(const OMPLoopDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002040 void EmitOMPWorksharingLoop(const OMPLoopDirective &S);
2041
2042public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002043
Chris Lattner208ae962007-05-30 17:57:17 +00002044 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002045 // LValue Expression Emission
2046 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002047
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002048 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2049 RValue GetUndefRValue(QualType Ty);
2050
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002051 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2052 /// and issue an ErrorUnsupported style diagnostic (using the
2053 /// provided Name).
2054 RValue EmitUnsupportedRValue(const Expr *E,
2055 const char *Name);
2056
Mike Stumpfc496822009-02-08 23:14:22 +00002057 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2058 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002059 LValue EmitUnsupportedLValue(const Expr *E,
2060 const char *Name);
2061
Chris Lattner8394d792007-06-05 20:53:16 +00002062 /// EmitLValue - Emit code to compute a designator that specifies the location
2063 /// of the expression.
2064 ///
2065 /// This can return one of two things: a simple address or a bitfield
2066 /// reference. In either case, the LLVM Value* in the LValue structure is
2067 /// guaranteed to be an LLVM pointer type.
2068 ///
2069 /// If this returns a bitfield reference, nothing about the pointee type of
2070 /// the LLVM value is known: For example, it may not be a pointer to an
2071 /// integer.
2072 ///
2073 /// If this returns a normal address, and if the lvalue's C type is fixed
2074 /// size, this method guarantees that the returned pointer type will point to
2075 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2076 /// variable length type, this is not possible.
2077 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002078 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002079
Richard Smith4d1458e2012-09-08 02:08:36 +00002080 /// \brief Same as EmitLValue but additionally we generate checking code to
2081 /// guard against undefined behavior. This is only suitable when we know
2082 /// that the address will be used to access the object.
2083 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002084
Nick Lewycky2d84e842013-10-02 02:29:49 +00002085 RValue convertTempToRValue(llvm::Value *addr, QualType type,
2086 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002087
John McCalla8ec7eb2013-03-07 21:37:17 +00002088 void EmitAtomicInit(Expr *E, LValue lvalue);
2089
Nick Lewycky2d84e842013-10-02 02:29:49 +00002090 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
John McCalla8ec7eb2013-03-07 21:37:17 +00002091 AggValueSlot slot = AggValueSlot::ignored());
2092
2093 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2094
Alexey Bataev452d8e12014-12-15 05:25:25 +00002095 std::pair<RValue, RValue> EmitAtomicCompareExchange(
2096 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
2097 llvm::AtomicOrdering Success = llvm::SequentiallyConsistent,
2098 llvm::AtomicOrdering Failure = llvm::SequentiallyConsistent,
2099 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2100
John McCall3a7f6922010-10-27 20:58:56 +00002101 /// EmitToMemory - Change a scalar value from its value
2102 /// representation to its in-memory representation.
2103 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2104
2105 /// EmitFromMemory - Change a scalar value from its memory
2106 /// representation to its value representation.
2107 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2108
Daniel Dunbar1d425462009-02-10 00:57:50 +00002109 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2110 /// care to appropriately convert from the memory representation to
2111 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002112 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman947c9af2010-10-14 23:06:10 +00002113 unsigned Alignment, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002114 SourceLocation Loc,
Craig Topper8a13c412014-05-21 05:09:00 +00002115 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002116 QualType TBAABaseTy = QualType(),
2117 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002118
2119 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2120 /// care to appropriately convert from the memory representation to
2121 /// the LLVM value representation. The l-value must be a simple
2122 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002123 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002124
2125 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2126 /// care to appropriately convert from the memory representation to
2127 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002128 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman947c9af2010-10-14 23:06:10 +00002129 bool Volatile, unsigned Alignment, QualType Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00002130 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002131 QualType TBAABaseTy = QualType(),
2132 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002133
2134 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2135 /// care to appropriately convert from the memory representation to
2136 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002137 /// l-value. The isInit flag indicates whether this is an initialization.
2138 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2139 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002140
Chris Lattner8394d792007-06-05 20:53:16 +00002141 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2142 /// this method emits the address of the lvalue, then loads the result as an
2143 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002144 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002145 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2146 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002147 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002148
Chris Lattner8394d792007-06-05 20:53:16 +00002149 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2150 /// lvalue, where both are guaranteed to the have the same type, and that type
2151 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002152 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002153 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002154 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002155
Nick Lewycky2d84e842013-10-02 02:29:49 +00002156 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2157 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002158 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002159 /// \param Result [out] - If non-null, this will be set to a Value* for the
2160 /// bit-field contents after the store, appropriate for use as the result of
2161 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002162 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002163 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002164
John McCall4f29b492010-11-16 23:07:28 +00002165 /// Emit an l-value for an assignment (simple or compound) of complex type.
2166 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002167 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Eli Friedmanf0450072013-06-12 01:40:06 +00002168 LValue EmitScalarCompooundAssignWithComplex(const CompoundAssignOperator *E,
2169 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002170
Chris Lattner57540c52011-04-15 05:22:18 +00002171 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002172 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002173 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002174 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002175 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002176 // Note: only available for agg return types
2177 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002178 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Renato Golin230c5eb2014-05-19 18:15:42 +00002179 LValue EmitReadRegister(const VarDecl *VD);
Chris Lattner4347e3692007-06-06 04:54:52 +00002180 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002181 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002182 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002183 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002184 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2185 bool Accessed = false);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002186 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002187 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002188 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002189 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002190 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002191 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002192 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002193 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002194 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002195
2196 llvm::Value *EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002197
Nick Lewycky2d84e842013-10-02 02:29:49 +00002198 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002199
John McCall71335052012-03-10 03:05:10 +00002200 class ConstantEmission {
2201 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2202 ConstantEmission(llvm::Constant *C, bool isReference)
2203 : ValueAndIsReference(C, isReference) {}
2204 public:
2205 ConstantEmission() {}
2206 static ConstantEmission forReference(llvm::Constant *C) {
2207 return ConstantEmission(C, true);
2208 }
2209 static ConstantEmission forValue(llvm::Constant *C) {
2210 return ConstantEmission(C, false);
2211 }
2212
Craig Topper8a13c412014-05-21 05:09:00 +00002213 LLVM_EXPLICIT operator bool() const {
2214 return ValueAndIsReference.getOpaqueValue() != nullptr;
2215 }
John McCall71335052012-03-10 03:05:10 +00002216
2217 bool isReference() const { return ValueAndIsReference.getInt(); }
2218 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2219 assert(isReference());
2220 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2221 refExpr->getType());
2222 }
2223
2224 llvm::Constant *getValue() const {
2225 assert(!isReference());
2226 return ValueAndIsReference.getPointer();
2227 }
2228 };
2229
John McCall113bee02012-03-10 09:33:50 +00002230 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002231
John McCallfe96e0b2011-11-06 09:01:30 +00002232 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2233 AggValueSlot slot = AggValueSlot::ignored());
2234 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2235
Daniel Dunbar722f4242009-04-22 05:08:15 +00002236 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002237 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002238 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002239 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002240
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002241 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2242 /// if the Field is a reference, this will return the address of the reference
2243 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002244 LValue EmitLValueForFieldInitialization(LValue Base,
2245 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002246
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002247 LValue EmitLValueForIvar(QualType ObjectTy,
2248 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002249 unsigned CVRQualifiers);
2250
Anders Carlsson3be22e22009-05-30 23:23:33 +00002251 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002252 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002253 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002254 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002255 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002256
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002257 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002258 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002259 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002260 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002261 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002262 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002263
Chris Lattnerd7f58862007-06-02 05:24:33 +00002264 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002265 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002266 //===--------------------------------------------------------------------===//
2267
Mike Stumpfc496822009-02-08 23:14:22 +00002268 /// EmitCall - Generate a call of the given function, expecting the given
2269 /// result type, and using the given argument list which specifies both the
2270 /// LLVM arguments and the types they were derived from.
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002271 ///
Mike Stumpe5311b02009-11-30 20:08:49 +00002272 /// \param TargetDecl - If given, the decl of the function in a direct call;
2273 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbard931a872009-02-02 22:03:45 +00002274 RValue EmitCall(const CGFunctionInfo &FnInfo,
2275 llvm::Value *Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00002276 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002277 const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00002278 const Decl *TargetDecl = nullptr,
2279 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002280
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002281 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002282 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00002283 const Decl *TargetDecl = nullptr,
2284 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002285 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002286 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002287
John McCall882987f2013-02-28 19:01:20 +00002288 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2289 const Twine &name = "");
2290 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2291 ArrayRef<llvm::Value*> args,
2292 const Twine &name = "");
2293 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2294 const Twine &name = "");
2295 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2296 ArrayRef<llvm::Value*> args,
2297 const Twine &name = "");
2298
John McCallbd309292010-07-06 01:34:17 +00002299 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002300 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002301 const Twine &Name = "");
Jay Foad5bd375a2011-07-15 08:37:34 +00002302 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002303 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002304 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2305 ArrayRef<llvm::Value*> args,
2306 const Twine &name = "");
2307 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2308 const Twine &name = "");
2309 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2310 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002311
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002312 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2313 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002314 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002315
2316 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2317 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002318 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002319
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002320 RValue
2321 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2322 ReturnValueSlot ReturnValue, llvm::Value *This,
2323 llvm::Value *ImplicitParam,
2324 QualType ImplicitParamTy, const CallExpr *E);
David Majnemer0c0b6d92014-10-31 20:09:12 +00002325 RValue EmitCXXStructorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2326 ReturnValueSlot ReturnValue, llvm::Value *This,
2327 llvm::Value *ImplicitParam,
2328 QualType ImplicitParamTy, const CallExpr *E,
2329 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002330 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2331 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002332 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2333 const CXXMethodDecl *MD,
2334 ReturnValueSlot ReturnValue,
2335 bool HasQualifier,
2336 NestedNameSpecifier *Qualifier,
2337 bool IsArrow, const Expr *Base);
2338 // Compute the object pointer.
Anders Carlssonbfb36712009-12-24 21:13:40 +00002339 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2340 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002341
Anders Carlsson4034a952009-05-27 04:18:27 +00002342 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002343 const CXXMethodDecl *MD,
2344 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002345
Peter Collingbournefe883422011-10-06 18:29:37 +00002346 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2347 ReturnValueSlot ReturnValue);
2348
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002349
Mike Stump11289f42009-09-09 15:08:12 +00002350 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002351 unsigned BuiltinID, const CallExpr *E,
2352 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002353
Anders Carlssonbfb36712009-12-24 21:13:40 +00002354 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002355
Mike Stumpfc496822009-02-08 23:14:22 +00002356 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2357 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002358 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2359
Kevin Qin1718af62013-11-14 02:45:18 +00002360 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2361 const llvm::CmpInst::Predicate Fp,
2362 const llvm::CmpInst::Predicate Ip,
2363 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002364 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002365
2366 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2367 unsigned LLVMIntrinsic,
2368 unsigned AltLLVMIntrinsic,
2369 const char *NameHint,
2370 unsigned Modifier,
2371 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002372 SmallVectorImpl<llvm::Value *> &Ops,
Craig Topper8a13c412014-05-21 05:09:00 +00002373 llvm::Value *Align = nullptr);
Tim Northover8fe03d62014-02-21 11:57:24 +00002374 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2375 unsigned Modifier, llvm::Type *ArgTy,
2376 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002377 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002378 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002379 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002380 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002381 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002382 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002383 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002384 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2385 llvm::Type *Ty, bool usgn, const char *name);
Tim Northover573cbee2014-05-24 12:52:07 +00002386 // Helper functions for EmitAArch64BuiltinExpr.
Tim Northovera2ee4332014-03-29 15:09:45 +00002387 llvm::Value *vectorWrapScalar8(llvm::Value *Op);
2388 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
2389 llvm::Value *emitVectorWrappedScalar8Intrinsic(
2390 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
2391 llvm::Value *emitVectorWrappedScalar16Intrinsic(
2392 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
Tim Northover573cbee2014-05-24 12:52:07 +00002393 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northovera2ee4332014-03-29 15:09:45 +00002394 llvm::Value *EmitNeon64Call(llvm::Function *F,
2395 llvm::SmallVectorImpl<llvm::Value *> &O,
2396 const char *name);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002397
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002398 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002399 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2400 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault56f008d2014-06-24 20:45:01 +00002401 llvm::Value *EmitR600BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002402
Daniel Dunbar66912a12008-08-20 00:28:19 +00002403 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002404 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002405 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002406 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2407 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2408 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002409 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002410 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002411 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2412 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002413
John McCall31168b02011-06-15 23:02:42 +00002414 /// Retrieves the default cleanup kind for an ARC cleanup.
2415 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2416 CleanupKind getARCCleanupKind() {
2417 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2418 ? NormalAndEHCleanup : NormalCleanup;
2419 }
2420
2421 // ARC primitives.
2422 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2423 void EmitARCDestroyWeak(llvm::Value *addr);
2424 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2425 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2426 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2427 bool ignored);
2428 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2429 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2430 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2431 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002432 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002433 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002434 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002435 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002436 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2437 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002438 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCallcdda29c2013-03-13 03:10:54 +00002439 void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise);
2440 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCall31168b02011-06-15 23:02:42 +00002441 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2442 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2443 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2444 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2445
2446 std::pair<LValue,llvm::Value*>
2447 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2448 std::pair<LValue,llvm::Value*>
2449 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2450
John McCall248512a2011-10-01 10:32:24 +00002451 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2452
John McCall31168b02011-06-15 23:02:42 +00002453 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2454 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2455 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2456
John McCallff613032011-10-04 06:23:45 +00002457 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002458 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2459 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2460
Craig Topper00bbdcf2014-06-28 23:22:23 +00002461 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002462
John McCall82fe67b2011-07-09 01:37:26 +00002463 static Destroyer destroyARCStrongImprecise;
2464 static Destroyer destroyARCStrongPrecise;
2465 static Destroyer destroyARCWeak;
2466
John McCall31168b02011-06-15 23:02:42 +00002467 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2468 llvm::Value *EmitObjCAutoreleasePoolPush();
2469 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2470 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2471 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2472
Richard Smitha1c9d4d2013-06-12 23:38:09 +00002473 /// \brief Emits a reference binding to the passed in expression.
2474 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002475
Chris Lattner6278e6a2007-08-11 00:04:45 +00002476 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002477 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002478 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002479
2480 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002481
2482 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2483 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002484 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002485
Chris Lattner3474c202007-08-26 06:48:56 +00002486 /// EmitScalarConversion - Emit a conversion from the specified type to the
2487 /// specified destination type, both of which are LLVM scalar types.
2488 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2489 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002490
Chris Lattner42e6b812007-08-26 16:34:22 +00002491 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stumpfc496822009-02-08 23:14:22 +00002492 /// complex type to the specified destination type, where the destination type
2493 /// is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002494 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2495 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002496
2497
John McCall7a626f62010-09-15 10:14:12 +00002498 /// EmitAggExpr - Emit the computation of the specified expression
2499 /// of aggregate type. The result is computed into the given slot,
2500 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002501 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002502
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002503 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2504 /// aggregate type into a temporary LValue.
2505 LValue EmitAggExprToLValue(const Expr *E);
2506
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002507 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2508 /// pointers.
2509 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian879d7262009-08-31 19:33:16 +00002510 QualType Ty);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002511
John McCall1bd25562011-06-24 23:21:27 +00002512 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2513 /// make sure it survives garbage collection until this point.
2514 void EmitExtendGCLifetime(llvm::Value *object);
2515
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002516 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002517 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002518 ComplexPairTy EmitComplexExpr(const Expr *E,
2519 bool IgnoreReal = false,
2520 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002521
John McCall47fb9502013-03-07 21:37:08 +00002522 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2523 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002524 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002525
John McCall47fb9502013-03-07 21:37:08 +00002526 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002527 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00002528
2529 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002530 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002531
Chandler Carruth84537952012-03-30 19:44:53 +00002532 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2533 /// global variable that has already been created for it. If the initializer
2534 /// has a different type than GV does, this may free GV and return a different
2535 /// one. Otherwise it just returns GV.
2536 llvm::GlobalVariable *
2537 AddInitializerToStaticVarDecl(const VarDecl &D,
2538 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002539
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002540
Anders Carlssonf40886a2009-08-08 21:45:14 +00002541 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2542 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002543 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2544 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002545
David Majnemerb3341ea2014-10-05 05:05:40 +00002546 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
2547 llvm::Constant *Addr);
2548
John McCallc84ed6a2012-05-01 06:13:13 +00002549 /// Call atexit() with a function that passes the given argument to
2550 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00002551 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2552 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002553
John McCallcdf7ef52010-11-06 09:44:32 +00002554 /// Emit code in this function to perform a guarded variable
2555 /// initialization. Guarded initializations are used when it's not
2556 /// possible to prove that an initialization will be done exactly
2557 /// once, e.g. with a static local variable or a static data member
2558 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002559 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002560 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002561
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002562 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2563 /// variables.
2564 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00002565 ArrayRef<llvm::Function *> CXXThreadLocals,
Craig Topper8a13c412014-05-21 05:09:00 +00002566 llvm::GlobalVariable *Guard = nullptr);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002567
John McCallee08c532012-04-06 18:21:03 +00002568 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002569 /// variables.
John McCallee08c532012-04-06 18:21:03 +00002570 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2571 const std::vector<std::pair<llvm::WeakVH,
2572 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002573
John McCalla738c252011-03-09 04:27:21 +00002574 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2575 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00002576 llvm::GlobalVariable *Addr,
2577 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002578
John McCall7a626f62010-09-15 10:14:12 +00002579 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002580
2581 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian50198092010-12-02 17:02:11 +00002582 const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00002583
John McCall08ef4662011-11-10 08:15:53 +00002584 void enterFullExpression(const ExprWithCleanups *E) {
2585 if (E->getNumObjects() == 0) return;
2586 enterNonTrivialFullExpression(E);
2587 }
2588 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00002589
Richard Smithea852322013-05-07 21:53:22 +00002590 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00002591
Eli Friedmanc370a7e2012-02-09 03:32:31 +00002592 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2593
Craig Topper8a13c412014-05-21 05:09:00 +00002594 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = nullptr);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00002595
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002596 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002597 // Annotations Emission
2598 //===--------------------------------------------------------------------===//
2599
2600 /// Emit an annotation call (intrinsic or builtin).
2601 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2602 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002603 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002604 SourceLocation Location);
2605
2606 /// Emit local annotations for the local variable V, declared by D.
2607 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2608
2609 /// Emit field annotations for the given field & value. Returns the
2610 /// annotation result.
2611 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2612
2613 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002614 // Internal Helpers
2615 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002616
Chris Lattner5b1964b2008-11-11 07:41:27 +00002617 /// ContainsLabel - Return true if the statement contains a label in it. If
2618 /// this statement is not executed normally, it not containing a label means
2619 /// that we can just remove the code.
2620 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002621
Chris Lattner29911cc2011-02-28 00:18:40 +00002622 /// containsBreak - Return true if the statement contains a break out of it.
2623 /// If the statement (recursively) contains a switch or loop with a break
2624 /// inside of it, this is fine.
2625 static bool containsBreak(const Stmt *S);
2626
Daniel Dunbar682712c2008-11-12 10:12:14 +00002627 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00002628 /// to a constant, or if it does but contains a label, return false. If it
2629 /// constant folds return true and set the boolean result in Result.
2630 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00002631
Chris Lattner29911cc2011-02-28 00:18:40 +00002632 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2633 /// to a constant, or if it does but contains a label, return false. If it
2634 /// constant folds return true and set the folded value.
Richard Trieuc320c742012-07-23 20:21:35 +00002635 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattner29911cc2011-02-28 00:18:40 +00002636
Chris Lattnercd439292008-11-12 08:04:58 +00002637 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2638 /// if statement) to the specified blocks. Based on the condition, this might
2639 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00002640 /// TrueCount should be the number of times we expect the condition to
2641 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00002642 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00002643 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00002644
Richard Smithe30752c2012-10-09 19:52:38 +00002645 /// \brief Emit a description of a type in a format suitable for passing to
2646 /// a runtime sanitizer handler.
2647 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2648
2649 /// \brief Convert a value into a format suitable for passing to a runtime
2650 /// sanitizer handler.
2651 llvm::Value *EmitCheckValue(llvm::Value *V);
2652
2653 /// \brief Emit a description of a source location in a format suitable for
2654 /// passing to a runtime sanitizer handler.
2655 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2656
Richard Smithde670682012-11-01 22:15:34 +00002657 /// \brief Create a basic block that will call a handler function in a
2658 /// sanitizer runtime with the provided arguments, and create a conditional
2659 /// branch to it.
Alexey Samsonove396bfc2014-11-11 22:03:54 +00002660 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerKind>> Checked,
2661 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
2662 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002663
Richard Smithde670682012-11-01 22:15:34 +00002664 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2665 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00002666 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00002667
Anders Carlsson093bdff2010-03-30 03:27:09 +00002668 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00002669 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00002670
John McCall23f66262010-05-26 22:34:26 +00002671 /// EmitDelegateCallArg - We are performing a delegate call; that
2672 /// is, the current function is delegating to another one. Produce
2673 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002674 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
2675 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00002676
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002677 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2678 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00002679 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002680
Chris Lattnercd439292008-11-12 08:04:58 +00002681private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00002682 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002683 void EmitReturnOfRValue(RValue RV, QualType Ty);
2684
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002685 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
2686
2687 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
2688 DeferredReplacements;
2689
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002690 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2691 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2692 ///
2693 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002694 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
2695 SmallVectorImpl<llvm::Argument *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002696
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002697 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
2698 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
2699 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
2700 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
2701 SmallVectorImpl<llvm::Value *> &IRCallArgs,
2702 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00002703
Chad Rosier59df25b2012-08-23 20:00:18 +00002704 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00002705 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00002706
Chad Rosier59df25b2012-08-23 20:00:18 +00002707 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00002708 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002709 std::string &ConstraintStr,
2710 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00002711
Reid Kleckner89077a12013-12-17 19:46:40 +00002712public:
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002713 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00002714 template <typename T>
2715 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002716 CallExpr::const_arg_iterator ArgBeg,
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002717 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002718 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00002719 unsigned ParamsToSkip = 0) {
Reid Kleckner739756c2013-12-04 19:23:12 +00002720 SmallVector<QualType, 16> ArgTypes;
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002721 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002722
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002723 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
2724 "Can't skip parameters if type info is not provided");
2725 if (CallArgTypeInfo) {
2726 // First, use the argument types that the type info knows about
2727 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
2728 E = CallArgTypeInfo->param_type_end();
2729 I != E; ++I, ++Arg) {
2730 assert(Arg != ArgEnd && "Running over edge of argument list!");
Alexey Bataev7cb17892014-12-18 06:54:53 +00002731 assert(
2732 ((*I)->isVariablyModifiedType() ||
2733 getContext()
2734 .getCanonicalType((*I).getNonReferenceType())
2735 .getTypePtr() ==
2736 getContext().getCanonicalType(Arg->getType()).getTypePtr()) &&
2737 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002738 ArgTypes.push_back(*I);
2739 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00002740 }
Mike Stump11289f42009-09-09 15:08:12 +00002741
Reid Kleckner739756c2013-12-04 19:23:12 +00002742 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002743 // function.
2744 assert(
2745 (Arg == ArgEnd || !CallArgTypeInfo || CallArgTypeInfo->isVariadic()) &&
2746 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00002747
Anders Carlsson603d6af2009-04-18 20:20:22 +00002748 // If we still have any arguments, emit them using the type of the argument.
Reid Kleckner739756c2013-12-04 19:23:12 +00002749 for (; Arg != ArgEnd; ++Arg)
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002750 ArgTypes.push_back(getVarArgType(*Arg));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002751
David Blaikie835afb22015-01-21 23:08:17 +00002752 EmitCallArgs(Args, ArgTypes, ArgBeg, ArgEnd, CalleeDecl, ParamsToSkip);
Anders Carlsson603d6af2009-04-18 20:20:22 +00002753 }
John McCalld4f4b7f2010-03-03 04:15:11 +00002754
Reid Kleckner739756c2013-12-04 19:23:12 +00002755 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
2756 CallExpr::const_arg_iterator ArgBeg,
Richard Smith760520b2014-06-03 23:27:44 +00002757 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002758 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00002759 unsigned ParamsToSkip = 0);
Reid Kleckner739756c2013-12-04 19:23:12 +00002760
Reid Kleckner89077a12013-12-17 19:46:40 +00002761private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002762 QualType getVarArgType(const Expr *Arg);
2763
John McCalld4f4b7f2010-03-03 04:15:11 +00002764 const TargetCodeGenInfo &getTargetHooks() const {
2765 return CGM.getTargetCodeGenInfo();
2766 }
John McCall09ae0322010-07-06 23:57:41 +00002767
2768 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00002769
2770 CodeGenModule::ByrefHelpers *
Chris Lattner2192fe52011-07-18 04:24:23 +00002771 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf9b056b2011-03-31 08:03:29 +00002772 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00002773
2774 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00002775
Eli Friedmana5dd5682012-08-23 03:10:17 +00002776 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2777 /// value and compute our best estimate of the alignment of the pointee.
2778 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00002779
2780 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00002781};
Mike Stump11289f42009-09-09 15:08:12 +00002782
John McCallce1de612011-01-26 04:00:11 +00002783/// Helper class with most of the code for saving a value for a
2784/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00002785struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00002786 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2787
2788 /// Answer whether the given value needs extra work to be saved.
2789 static bool needsSaving(llvm::Value *value) {
2790 // If it's not an instruction, we don't need to save.
2791 if (!isa<llvm::Instruction>(value)) return false;
2792
2793 // If it's an instruction in the entry block, we don't need to save.
2794 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2795 return (block != &block->getParent()->getEntryBlock());
2796 }
2797
2798 /// Try to save the given value.
2799 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2800 if (!needsSaving(value)) return saved_type(value, false);
2801
2802 // Otherwise we need an alloca.
2803 llvm::Value *alloca =
2804 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2805 CGF.Builder.CreateStore(value, alloca);
2806
2807 return saved_type(alloca, true);
2808 }
2809
2810 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2811 if (!value.getInt()) return value.getPointer();
2812 return CGF.Builder.CreateLoad(value.getPointer());
2813 }
2814};
2815
John McCallcb5f77f2011-01-28 10:53:53 +00002816/// A partial specialization of DominatingValue for llvm::Values that
2817/// might be llvm::Instructions.
2818template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2819 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00002820 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00002821 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2822 }
2823};
2824
2825/// A specialization of DominatingValue for RValue.
2826template <> struct DominatingValue<RValue> {
2827 typedef RValue type;
2828 class saved_type {
2829 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2830 AggregateAddress, ComplexAddress };
2831
2832 llvm::Value *Value;
2833 Kind K;
2834 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2835
2836 public:
2837 static bool needsSaving(RValue value);
2838 static saved_type save(CodeGenFunction &CGF, RValue value);
2839 RValue restore(CodeGenFunction &CGF);
2840
2841 // implementations in CGExprCXX.cpp
2842 };
2843
2844 static bool needsSaving(type value) {
2845 return saved_type::needsSaving(value);
2846 }
2847 static saved_type save(CodeGenFunction &CGF, type value) {
2848 return saved_type::save(CGF, value);
2849 }
2850 static type restore(CodeGenFunction &CGF, saved_type value) {
2851 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00002852 }
2853};
2854
Chris Lattnerbed31442007-05-28 01:07:47 +00002855} // end namespace CodeGen
2856} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00002857
Chris Lattnerbed31442007-05-28 01:07:47 +00002858#endif