blob: a74c474232c886857a4d13d0a58f3c1a5c3bed44 [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"
Alexander Musmandf7a8e22015-01-22 08:49:35 +000030#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000031#include "clang/Basic/TargetInfo.h"
32#include "clang/Frontend/CodeGenOptions.h"
33#include "llvm/ADT/ArrayRef.h"
34#include "llvm/ADT/DenseMap.h"
35#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000036#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000037#include "llvm/Support/Debug.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000038
Chris Lattnerbed31442007-05-28 01:07:47 +000039namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000040class BasicBlock;
41class LLVMContext;
42class MDNode;
43class Module;
44class SwitchInst;
45class Twine;
46class Value;
47class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000048}
49
Chris Lattnerbed31442007-05-28 01:07:47 +000050namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000051class ASTContext;
52class BlockDecl;
53class CXXDestructorDecl;
54class CXXForRangeStmt;
55class CXXTryStmt;
56class Decl;
57class LabelDecl;
58class EnumConstantDecl;
59class FunctionDecl;
60class FunctionProtoType;
61class LabelStmt;
62class ObjCContainerDecl;
63class ObjCInterfaceDecl;
64class ObjCIvarDecl;
65class ObjCMethodDecl;
66class ObjCImplementationDecl;
67class ObjCPropertyImplDecl;
68class TargetInfo;
69class TargetCodeGenInfo;
70class VarDecl;
71class ObjCForCollectionStmt;
72class ObjCAtTryStmt;
73class ObjCAtThrowStmt;
74class ObjCAtSynchronizedStmt;
75class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000076
Chris Lattnerbed31442007-05-28 01:07:47 +000077namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000078class CodeGenTypes;
79class CGFunctionInfo;
80class CGRecordLayout;
81class CGBlockInfo;
82class CGCXXABI;
83class BlockFlags;
84class BlockFieldFlags;
Mike Stumpfc496822009-02-08 23:14:22 +000085
John McCall47fb9502013-03-07 21:37:08 +000086/// The kind of evaluation to perform on values of a particular
87/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
88/// CGExprAgg?
89///
90/// TODO: should vectors maybe be split out into their own thing?
91enum TypeEvaluationKind {
92 TEK_Scalar,
93 TEK_Complex,
94 TEK_Aggregate
95};
96
Chris Lattnerbed31442007-05-28 01:07:47 +000097/// CodeGenFunction - This class organizes the per-function state that is used
98/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +000099class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000100 CodeGenFunction(const CodeGenFunction &) = delete;
101 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000102
103 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000104public:
John McCallad5d61e2010-07-23 21:56:41 +0000105 /// A jump destination is an abstract label, branching to which may
106 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000107 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000108 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000109 JumpDest(llvm::BasicBlock *Block,
110 EHScopeStack::stable_iterator Depth,
111 unsigned Index)
112 : Block(Block), ScopeDepth(Depth), Index(Index) {}
113
Craig Topper8a13c412014-05-21 05:09:00 +0000114 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000115 llvm::BasicBlock *getBlock() const { return Block; }
116 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
117 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000118
Nadav Rotem1da30942013-03-23 06:43:35 +0000119 // This should be used cautiously.
120 void setScopeDepth(EHScopeStack::stable_iterator depth) {
121 ScopeDepth = depth;
122 }
123
John McCallad5d61e2010-07-23 21:56:41 +0000124 private:
John McCallbd309292010-07-06 01:34:17 +0000125 llvm::BasicBlock *Block;
126 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000127 unsigned Index;
128 };
129
Chris Lattnerbed31442007-05-28 01:07:47 +0000130 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000131 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000132
Chris Lattner96d72562007-08-21 16:57:55 +0000133 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000134 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000135 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000136
Alexander Musman515ad8c2014-05-22 08:54:05 +0000137 /// \brief CGBuilder insert helper. This function is called after an
138 /// instruction is created using Builder.
139 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
140 llvm::BasicBlock *BB,
141 llvm::BasicBlock::iterator InsertPt) const;
142
John McCalldec348f72013-05-03 07:33:41 +0000143 /// CurFuncDecl - Holds the Decl for the current outermost
144 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000145 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000146 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
147 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000148 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000149 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000150 llvm::Function *CurFn;
151
Mike Stumpbee78dd2009-12-04 23:26:17 +0000152 /// CurGD - The GlobalDecl for the current function being compiled.
153 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000154
John McCall31168b02011-06-15 23:02:42 +0000155 /// PrologueCleanupDepth - The cleanup depth enclosing all the
156 /// cleanups associated with the parameters.
157 EHScopeStack::stable_iterator PrologueCleanupDepth;
158
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000159 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000160 JumpDest ReturnBlock;
161
Mike Stumpfc496822009-02-08 23:14:22 +0000162 /// ReturnValue - The temporary alloca to hold the return value. This is null
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +0000163 /// iff the function has no return value.
Eli Friedman4b1942c2009-12-04 02:43:40 +0000164 llvm::Value *ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000165
Chris Lattner03df1222007-06-02 04:53:11 +0000166 /// AllocaInsertPoint - This is an instruction in the entry block before which
167 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000168 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000169
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000170 /// \brief API for captured statement code generation.
171 class CGCapturedStmtInfo {
172 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000173 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
174 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000175 explicit CGCapturedStmtInfo(const CapturedStmt &S,
176 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000177 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000178
179 RecordDecl::field_iterator Field =
180 S.getCapturedRecordDecl()->field_begin();
181 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
182 E = S.capture_end();
183 I != E; ++I, ++Field) {
184 if (I->capturesThis())
185 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000186 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000187 CaptureFields[I->getCapturedVar()] = *Field;
188 }
189 }
190
191 virtual ~CGCapturedStmtInfo();
192
193 CapturedRegionKind getKind() const { return Kind; }
194
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000195 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000196 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000197 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000198
199 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000200 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000201 return CaptureFields.lookup(VD);
202 }
203
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000204 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
205 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000206
Alexey Bataev18095712014-10-10 12:19:54 +0000207 static bool classof(const CGCapturedStmtInfo *) {
208 return true;
209 }
210
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000211 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000212 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000213 CGF.incrementProfileCounter(S);
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
Alexey Bataevd157d472015-06-24 03:35:38 +0000236 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
237 class CGCapturedStmtRAII {
238 private:
239 CodeGenFunction &CGF;
240 CGCapturedStmtInfo *PrevCapturedStmtInfo;
241 public:
242 CGCapturedStmtRAII(CodeGenFunction &CGF,
243 CGCapturedStmtInfo *NewCapturedStmtInfo)
244 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
245 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
246 }
247 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
248 };
249
Nuno Lopes3d6311d2012-05-08 22:10:46 +0000250 /// BoundsChecking - Emit run-time bounds checks. Higher values mean
251 /// potentially higher performance penalties.
252 unsigned char BoundsChecking;
253
Alexey Samsonova0416102014-11-11 01:26:14 +0000254 /// \brief Sanitizers enabled for this function.
255 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000256
Alexey Samsonov24cad992014-07-17 18:46:27 +0000257 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
258 bool IsSanitizerScope;
259
260 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
261 class SanitizerScope {
262 CodeGenFunction *CGF;
263 public:
264 SanitizerScope(CodeGenFunction *CGF);
265 ~SanitizerScope();
266 };
267
Reid Kleckner19819442014-07-25 21:39:46 +0000268 /// In C++, whether we are code generating a thunk. This controls whether we
269 /// should emit cleanups.
270 bool CurFuncIsThunk;
271
John McCall31168b02011-06-15 23:02:42 +0000272 /// In ARC, whether we should autorelease the return value.
273 bool AutoreleaseResult;
274
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000275 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
276 /// potentially set the return value.
277 bool SawAsmBlock;
278
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000279 /// True if the current function is an outlined SEH helper. This can be a
280 /// finally block or filter expression.
281 bool IsOutlinedSEHHelper;
282
John McCallad7c5c12011-02-08 08:22:06 +0000283 const CodeGen::CGBlockInfo *BlockInfo;
284 llvm::Value *BlockPointer;
285
Eli Friedman9fbeba02012-02-11 02:57:39 +0000286 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
287 FieldDecl *LambdaThisCaptureField;
288
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000289 /// \brief A mapping from NRVO variables to the flags used to indicate
290 /// when the NRVO has been applied to this variable.
291 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000292
John McCallbd309292010-07-06 01:34:17 +0000293 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000294 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000295 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000296
297 /// Header for data within LifetimeExtendedCleanupStack.
298 struct LifetimeExtendedCleanupHeader {
299 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000300 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000301 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000302 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000303
Justin Bognerbdff2192015-07-01 00:59:27 +0000304 size_t getSize() const { return Size; }
305 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000306 };
John McCallbd309292010-07-06 01:34:17 +0000307
John McCallad5d61e2010-07-23 21:56:41 +0000308 /// i32s containing the indexes of the cleanup destinations.
309 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000310
311 unsigned NextCleanupDestIndex;
312
John McCall08ef4662011-11-10 08:15:53 +0000313 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
314 CGBlockInfo *FirstBlockInfo;
315
John McCall8e4c74b2011-08-11 02:22:43 +0000316 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
317 llvm::BasicBlock *EHResumeBlock;
318
Bill Wendlingf0724e82011-09-19 20:31:14 +0000319 /// The exception slot. All landing pads write the current exception pointer
320 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000321 llvm::Value *ExceptionSlot;
322
Bill Wendlingf0724e82011-09-19 20:31:14 +0000323 /// The selector slot. Under the MandatoryCleanup model, all landing pads
324 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000325 llvm::AllocaInst *EHSelectorSlot;
326
Nico Webere4f974c2015-07-02 06:10:53 +0000327 llvm::AllocaInst *AbnormalTerminationSlot;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000328
Nico Webere4f974c2015-07-02 06:10:53 +0000329 /// The implicit parameter to SEH filter functions of type
330 /// 'EXCEPTION_POINTERS*'.
331 ImplicitParamDecl *SEHPointersDecl;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000332
John McCallbd309292010-07-06 01:34:17 +0000333 /// Emits a landing pad for the current EH stack.
334 llvm::BasicBlock *EmitLandingPad();
335
336 llvm::BasicBlock *getInvokeDestImpl();
337
John McCallce1de612011-01-26 04:00:11 +0000338 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000339 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
340 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000341 }
342
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000343public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000344 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
345 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000346 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000347
John McCall6b0feb72011-06-22 02:32:12 +0000348 /// A class controlling the emission of a finally block.
349 class FinallyInfo {
350 /// Where the catchall's edge through the cleanup should go.
351 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000352
John McCall6b0feb72011-06-22 02:32:12 +0000353 /// A function to call to enter the catch.
354 llvm::Constant *BeginCatchFn;
355
356 /// An i1 variable indicating whether or not the @finally is
357 /// running for an exception.
358 llvm::AllocaInst *ForEHVar;
359
360 /// An i8* variable into which the exception pointer to rethrow
361 /// has been saved.
362 llvm::AllocaInst *SavedExnVar;
363
364 public:
365 void enter(CodeGenFunction &CGF, const Stmt *Finally,
366 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
367 llvm::Constant *rethrowFn);
368 void exit(CodeGenFunction &CGF);
369 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000370
Reid Kleckner11c033e2015-02-12 23:40:45 +0000371 /// Returns true inside SEH __try blocks.
372 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
373
John McCallce1de612011-01-26 04:00:11 +0000374 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
375 /// current full-expression. Safe against the possibility that
376 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000377 template <class T, class... As>
378 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000379 // If we're not in a conditional branch, or if none of the
380 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000381 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000382 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000383
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000384 // Stash values in a tuple so we can guarantee the order of saves.
385 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
386 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000387
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000388 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000389 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000390 initFullExprCleanup();
391 }
392
Richard Smith736a9472013-06-12 20:42:33 +0000393 /// \brief Queue a cleanup to be pushed after finishing the current
394 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000395 template <class T, class... As>
396 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000397 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
398
399 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
400
401 size_t OldSize = LifetimeExtendedCleanupStack.size();
402 LifetimeExtendedCleanupStack.resize(
403 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
404
Justin Bognerbdff2192015-07-01 00:59:27 +0000405 static_assert(sizeof(Header) % llvm::AlignOf<T>::Alignment == 0,
406 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000407 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
408 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000409 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000410 }
411
John McCallf4beacd2011-11-10 10:43:54 +0000412 /// Set up the last cleaup that was pushed as a conditional
413 /// full-expression cleanup.
414 void initFullExprCleanup();
415
John McCallbd309292010-07-06 01:34:17 +0000416 /// PushDestructorCleanup - Push a cleanup to call the
417 /// complete-object destructor of an object of the given type at the
418 /// given address. Does nothing if T is not a C++ class type with a
419 /// non-trivial destructor.
420 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
421
John McCall8680f872010-07-21 06:29:51 +0000422 /// PushDestructorCleanup - Push a cleanup to call the
423 /// complete-object variant of the given destructor on the object at
424 /// the given address.
425 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
426 llvm::Value *Addr);
427
John McCallbd309292010-07-06 01:34:17 +0000428 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
429 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000430 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000431
John McCall824c2f52010-09-14 07:57:04 +0000432 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
433 /// The block cannot be reactivated. Pops it if it's the top of the
434 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000435 ///
436 /// \param DominatingIP - An instruction which is known to
437 /// dominate the current IP (if set) and which lies along
438 /// all paths of execution between the current IP and the
439 /// the point at which the cleanup comes into scope.
440 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
441 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000442
443 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
444 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000445 ///
446 /// \param DominatingIP - An instruction which is known to
447 /// dominate the current IP (if set) and which lies along
448 /// all paths of execution between the current IP and the
449 /// the point at which the cleanup comes into scope.
450 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
451 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000452
John McCallbd309292010-07-06 01:34:17 +0000453 /// \brief Enters a new scope for capturing cleanups, all of which
454 /// will be executed once the scope is exited.
455 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000456 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000457 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000458 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000459 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000460 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000461 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000462
Aaron Ballmanabc18922015-02-15 22:54:08 +0000463 RunCleanupsScope(const RunCleanupsScope &) = delete;
464 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000465
Eric Christophera9d34972011-10-19 00:43:52 +0000466 protected:
467 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000468
Douglas Gregor965f4502009-11-24 16:43:22 +0000469 public:
470 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000471 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000472 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000473 {
John McCallbd309292010-07-06 01:34:17 +0000474 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000475 LifetimeExtendedCleanupStackSize =
476 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000477 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000478 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000479 }
480
481 /// \brief Exit this cleanup scope, emitting any accumulated
482 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000483 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000484 if (PerformCleanup) {
485 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000486 CGF.PopCleanupBlocks(CleanupStackDepth,
487 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000488 }
489 }
490
491 /// \brief Determine whether this scope requires any cleanups.
492 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000493 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000494 }
495
496 /// \brief Force the emission of cleanups now, instead of waiting
497 /// until this object is destroyed.
498 void ForceCleanup() {
499 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000500 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000501 CGF.PopCleanupBlocks(CleanupStackDepth,
502 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000503 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000504 }
505 };
506
David Blaikie93be0b22014-08-22 21:37:04 +0000507 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000508 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000509 SmallVector<const LabelDecl*, 4> Labels;
510 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000511
Aaron Ballmanabc18922015-02-15 22:54:08 +0000512 LexicalScope(const LexicalScope &) = delete;
513 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000514
515 public:
516 /// \brief Enter a new cleanup scope.
517 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000518 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
519 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000520 if (CGDebugInfo *DI = CGF.getDebugInfo())
521 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
522 }
523
Nadav Rotem1da30942013-03-23 06:43:35 +0000524 void addLabel(const LabelDecl *label) {
525 assert(PerformCleanup && "adding label to dead scope?");
526 Labels.push_back(label);
527 }
528
Eric Christophera9d34972011-10-19 00:43:52 +0000529 /// \brief Exit this cleanup scope, emitting any accumulated
530 /// cleanups.
531 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000532 if (CGDebugInfo *DI = CGF.getDebugInfo())
533 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
534
Nadav Rotem1da30942013-03-23 06:43:35 +0000535 // If we should perform a cleanup, force them now. Note that
536 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000537 if (PerformCleanup) {
538 ApplyDebugLocation DL(CGF, Range.getEnd());
539 ForceCleanup();
540 }
Eric Christophera9d34972011-10-19 00:43:52 +0000541 }
542
543 /// \brief Force the emission of cleanups now, instead of waiting
544 /// until this object is destroyed.
545 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000546 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000547 RunCleanupsScope::ForceCleanup();
548
Nadav Rotem1da30942013-03-23 06:43:35 +0000549 if (!Labels.empty())
550 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000551 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000552
553 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000554 };
555
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000556 /// \brief The scope used to remap some variables as private in the OpenMP
557 /// loop body (or other captured region emitted without outlining), and to
558 /// restore old vars back on exit.
559 class OMPPrivateScope : public RunCleanupsScope {
560 typedef llvm::DenseMap<const VarDecl *, llvm::Value *> VarDeclMapTy;
561 VarDeclMapTy SavedLocals;
562 VarDeclMapTy SavedPrivates;
563
564 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000565 OMPPrivateScope(const OMPPrivateScope &) = delete;
566 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000567
568 public:
569 /// \brief Enter a new OpenMP private scope.
570 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
571
572 /// \brief Registers \a LocalVD variable as a private and apply \a
573 /// PrivateGen function for it to generate corresponding private variable.
574 /// \a PrivateGen returns an address of the generated private variable.
575 /// \return true if the variable is registered as private, false if it has
576 /// been privatized already.
577 bool
578 addPrivate(const VarDecl *LocalVD,
579 const std::function<llvm::Value *()> &PrivateGen) {
580 assert(PerformCleanup && "adding private to dead scope");
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000581 if (SavedLocals.count(LocalVD) > 0) return false;
582 SavedLocals[LocalVD] = CGF.LocalDeclMap.lookup(LocalVD);
583 CGF.LocalDeclMap.erase(LocalVD);
584 SavedPrivates[LocalVD] = PrivateGen();
585 CGF.LocalDeclMap[LocalVD] = SavedLocals[LocalVD];
586 return true;
587 }
588
589 /// \brief Privatizes local variables previously registered as private.
590 /// Registration is separate from the actual privatization to allow
591 /// initializers use values of the original variables, not the private one.
592 /// This is important, for example, if the private variable is a class
593 /// variable initialized by a constructor that references other private
594 /// variables. But at initialization original variables must be used, not
595 /// private copies.
596 /// \return true if at least one variable was privatized, false otherwise.
597 bool Privatize() {
598 for (auto VDPair : SavedPrivates) {
599 CGF.LocalDeclMap[VDPair.first] = VDPair.second;
600 }
601 SavedPrivates.clear();
602 return !SavedLocals.empty();
603 }
604
605 void ForceCleanup() {
606 RunCleanupsScope::ForceCleanup();
607 // Remap vars back to the original values.
608 for (auto I : SavedLocals) {
609 CGF.LocalDeclMap[I.first] = I.second;
610 }
611 SavedLocals.clear();
612 }
613
614 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000615 ~OMPPrivateScope() {
616 if (PerformCleanup)
617 ForceCleanup();
618 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000619 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000620
Richard Smith736a9472013-06-12 20:42:33 +0000621 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
622 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000623 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000624
Richard Smith736a9472013-06-12 20:42:33 +0000625 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
626 /// that have been added, then adds all lifetime-extended cleanups from
627 /// the given position to the stack.
628 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
629 size_t OldLifetimeExtendedStackSize);
630
John McCallad5d61e2010-07-23 21:56:41 +0000631 void ResolveBranchFixups(llvm::BasicBlock *Target);
632
John McCallbd309292010-07-06 01:34:17 +0000633 /// The given basic block lies in the current EH scope, but may be a
634 /// target of a potentially scope-crossing jump; get a stable handle
635 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000636 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000637 return JumpDest(Target,
638 EHStack.getInnermostNormalCleanup(),
639 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000640 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000641
John McCallbd309292010-07-06 01:34:17 +0000642 /// The given basic block lies in the current EH scope, but may be a
643 /// target of a potentially scope-crossing jump; get a stable handle
644 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000645 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000646 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000647 }
648
649 /// EmitBranchThroughCleanup - Emit a branch from the current insert
650 /// block through the normal cleanup handling code (if any) and then
651 /// on to \arg Dest.
652 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000653
Justin Bognere25ffdf2014-01-21 00:35:11 +0000654 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
655 /// specified destination obviously has no cleanups to run. 'false' is always
656 /// a conservatively correct answer for this method.
657 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
658
John McCall8e4c74b2011-08-11 02:22:43 +0000659 /// popCatchScope - Pops the catch scope at the top of the EHScope
660 /// stack, emitting any required code (other than the catch handlers
661 /// themselves).
662 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000663
David Chisnall9a837be2012-11-07 16:50:40 +0000664 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000665 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000666
John McCallce1de612011-01-26 04:00:11 +0000667 /// An object to manage conditionally-evaluated expressions.
668 class ConditionalEvaluation {
669 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000670
John McCallce1de612011-01-26 04:00:11 +0000671 public:
672 ConditionalEvaluation(CodeGenFunction &CGF)
673 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000674
John McCallce1de612011-01-26 04:00:11 +0000675 void begin(CodeGenFunction &CGF) {
676 assert(CGF.OutermostConditional != this);
677 if (!CGF.OutermostConditional)
678 CGF.OutermostConditional = this;
679 }
680
681 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000682 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000683 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000684 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000685 }
686
687 /// Returns a block which will be executed prior to each
688 /// evaluation of the conditional code.
689 llvm::BasicBlock *getStartingBlock() const {
690 return StartBB;
691 }
692 };
Mike Stump11289f42009-09-09 15:08:12 +0000693
John McCall7f9c92a2010-09-17 00:50:28 +0000694 /// isInConditionalBranch - Return true if we're currently emitting
695 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000696 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000697
John McCallf4beacd2011-11-10 10:43:54 +0000698 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
699 assert(isInConditionalBranch());
700 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
701 new llvm::StoreInst(value, addr, &block->back());
702 }
703
John McCallce1de612011-01-26 04:00:11 +0000704 /// An RAII object to record that we're evaluating a statement
705 /// expression.
706 class StmtExprEvaluation {
707 CodeGenFunction &CGF;
708
709 /// We have to save the outermost conditional: cleanups in a
710 /// statement expression aren't conditional just because the
711 /// StmtExpr is.
712 ConditionalEvaluation *SavedOutermostConditional;
713
714 public:
715 StmtExprEvaluation(CodeGenFunction &CGF)
716 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000717 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000718 }
719
720 ~StmtExprEvaluation() {
721 CGF.OutermostConditional = SavedOutermostConditional;
722 CGF.EnsureInsertPoint();
723 }
724 };
John McCall1bf58462011-02-16 08:02:54 +0000725
John McCallc07a0c72011-02-17 10:25:35 +0000726 /// An object which temporarily prevents a value from being
727 /// destroyed by aggressive peephole optimizations that assume that
728 /// all uses of a value have been realized in the IR.
729 class PeepholeProtection {
730 llvm::Instruction *Inst;
731 friend class CodeGenFunction;
732
733 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000734 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000735 };
John McCallc07a0c72011-02-17 10:25:35 +0000736
John McCallfe96e0b2011-11-06 09:01:30 +0000737 /// A non-RAII class containing all the information about a bound
738 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
739 /// this which makes individual mappings very simple; using this
740 /// class directly is useful when you have a variable number of
741 /// opaque values or don't want the RAII functionality for some
742 /// reason.
743 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000744 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000745 bool BoundLValue;
746 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000747
John McCallfe96e0b2011-11-06 09:01:30 +0000748 OpaqueValueMappingData(const OpaqueValueExpr *ov,
749 bool boundLValue)
750 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000751 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000752 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000753
John McCallc07a0c72011-02-17 10:25:35 +0000754 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000755 // gl-values should be bound as l-values for obvious reasons.
756 // Records should be bound as l-values because IR generation
757 // always keeps them in memory. Expressions of function type
758 // act exactly like l-values but are formally required to be
759 // r-values in C.
760 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000761 expr->getType()->isFunctionType() ||
762 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000763 }
764
John McCallfe96e0b2011-11-06 09:01:30 +0000765 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
766 const OpaqueValueExpr *ov,
767 const Expr *e) {
768 if (shouldBindAsLValue(ov))
769 return bind(CGF, ov, CGF.EmitLValue(e));
770 return bind(CGF, ov, CGF.EmitAnyExpr(e));
771 }
772
773 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
774 const OpaqueValueExpr *ov,
775 const LValue &lv) {
776 assert(shouldBindAsLValue(ov));
777 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
778 return OpaqueValueMappingData(ov, true);
779 }
780
781 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
782 const OpaqueValueExpr *ov,
783 const RValue &rv) {
784 assert(!shouldBindAsLValue(ov));
785 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
786
787 OpaqueValueMappingData data(ov, false);
788
789 // Work around an extremely aggressive peephole optimization in
790 // EmitScalarConversion which assumes that all other uses of a
791 // value are extant.
792 data.Protection = CGF.protectFromPeepholes(rv);
793
794 return data;
795 }
796
Craig Topper8a13c412014-05-21 05:09:00 +0000797 bool isValid() const { return OpaqueValue != nullptr; }
798 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000799
800 void unbind(CodeGenFunction &CGF) {
801 assert(OpaqueValue && "no data to unbind!");
802
803 if (BoundLValue) {
804 CGF.OpaqueLValues.erase(OpaqueValue);
805 } else {
806 CGF.OpaqueRValues.erase(OpaqueValue);
807 CGF.unprotectFromPeepholes(Protection);
808 }
809 }
810 };
811
812 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
813 class OpaqueValueMapping {
814 CodeGenFunction &CGF;
815 OpaqueValueMappingData Data;
816
817 public:
818 static bool shouldBindAsLValue(const Expr *expr) {
819 return OpaqueValueMappingData::shouldBindAsLValue(expr);
820 }
821
John McCallc07a0c72011-02-17 10:25:35 +0000822 /// Build the opaque value mapping for the given conditional
823 /// operator if it's the GNU ?: extension. This is a common
824 /// enough pattern that the convenience operator is really
825 /// helpful.
826 ///
827 OpaqueValueMapping(CodeGenFunction &CGF,
828 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000829 if (isa<ConditionalOperator>(op))
830 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000831 return;
John McCallc07a0c72011-02-17 10:25:35 +0000832
833 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000834 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
835 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000836 }
837
John McCall1bf58462011-02-16 08:02:54 +0000838 OpaqueValueMapping(CodeGenFunction &CGF,
839 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000840 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000841 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000842 }
843
844 OpaqueValueMapping(CodeGenFunction &CGF,
845 const OpaqueValueExpr *opaqueValue,
846 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000847 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000848 }
849
850 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000851 Data.unbind(CGF);
852 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000853 }
854
855 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000856 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000857 }
858 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000859
860 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
861 /// number that holds the value.
David Blaikie1ed728c2015-04-05 22:45:47 +0000862 std::pair<llvm::Type *, unsigned>
863 getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian2f2fa722011-01-26 23:08:27 +0000864
865 /// BuildBlockByrefAddress - Computes address location of the
866 /// variable which is declared as __block.
867 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
868 const VarDecl *V);
Chris Lattner2da04b32007-08-24 05:35:26 +0000869private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000870 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000871 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000872
John McCall9b382dd2011-05-28 21:13:02 +0000873 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
874 /// calling llvm.stacksave for multiple VLAs in the same scope.
875 bool DidCallStackSave;
876
Mike Stumpe5311b02009-11-30 20:08:49 +0000877 /// IndirectBranch - The first time an indirect goto is seen we create a block
878 /// with an indirect branch. Every time we see the address of a label taken,
879 /// we add the label to the indirect goto. Every subsequent indirect goto is
880 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000881 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000882
Mike Stumpfc496822009-02-08 23:14:22 +0000883 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
884 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000885 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
886 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000887
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000888 /// Track escaped local variables with auto storage. Used during SEH
889 /// outlining to produce a call to llvm.frameescape.
890 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
891
Chris Lattnerac248202007-05-30 00:13:02 +0000892 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000893 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000894
Mike Stumpfc496822009-02-08 23:14:22 +0000895 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000896 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000897 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000898 BreakContinue(JumpDest Break, JumpDest Continue)
899 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000900
John McCallbd309292010-07-06 01:34:17 +0000901 JumpDest BreakBlock;
902 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000903 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000904 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000905
Justin Bogneref512b92014-01-06 22:27:43 +0000906 CodeGenPGO PGO;
907
Justin Bogner65512642015-05-02 05:00:55 +0000908 /// Calculate branch weights appropriate for PGO data
909 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
910 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
911 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
912 uint64_t LoopCount);
913
Justin Bogneref512b92014-01-06 22:27:43 +0000914public:
Justin Bogner66242d62015-04-23 23:06:47 +0000915 /// Increment the profiler's counter for the given statement.
916 void incrementProfileCounter(const Stmt *S) {
917 if (CGM.getCodeGenOpts().ProfileInstrGenerate)
918 PGO.emitCounterIncrement(Builder, S);
919 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +0000920 }
Justin Bogner66242d62015-04-23 23:06:47 +0000921
922 /// Get the profiler's count for the given statement.
923 uint64_t getProfileCount(const Stmt *S) {
924 Optional<uint64_t> Count = PGO.getStmtCount(S);
925 if (!Count.hasValue())
926 return 0;
927 return *Count;
928 }
929
930 /// Set the profiler's current count.
931 void setCurrentProfileCount(uint64_t Count) {
932 PGO.setCurrentRegionCount(Count);
933 }
934
935 /// Get the profiler's current count. This is generally the count for the most
936 /// recently incremented counter.
937 uint64_t getCurrentProfileCount() {
938 return PGO.getCurrentRegionCount();
939 }
940
Justin Bogneref512b92014-01-06 22:27:43 +0000941private:
942
Zhongxing Xu82846ea2012-01-14 09:08:15 +0000943 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +0000944 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000945 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +0000946 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
947 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +0000948
Mike Stumpfc496822009-02-08 23:14:22 +0000949 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000950 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000951 llvm::BasicBlock *CaseRangeBlock;
952
John McCallc07a0c72011-02-17 10:25:35 +0000953 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +0000954 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +0000955 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
956 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +0000957
Mike Stumpfc496822009-02-08 23:14:22 +0000958 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +0000959 // We track this by the size expression rather than the type itself because
960 // in certain situations, like a const qualifier applied to an VLA typedef,
961 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +0000962 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
963 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +0000964 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000965
John McCallbd309292010-07-06 01:34:17 +0000966 /// A block containing a single 'unreachable' instruction. Created
967 /// lazily by getUnreachableBlock().
968 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000969
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000970 /// Counts of the number return expressions in the function.
971 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +0000972
973 /// Count the number of simple (constant) return expressions in the function.
974 unsigned NumSimpleReturnExprs;
975
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000976 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +0000977 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +0000978
Richard Smith852c9db2013-04-20 22:23:05 +0000979public:
980 /// A scope within which we are constructing the fields of an object which
981 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
982 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
983 class FieldConstructionScope {
984 public:
985 FieldConstructionScope(CodeGenFunction &CGF, llvm::Value *This)
986 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
987 CGF.CXXDefaultInitExprThis = This;
988 }
989 ~FieldConstructionScope() {
990 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
991 }
992
993 private:
994 CodeGenFunction &CGF;
995 llvm::Value *OldCXXDefaultInitExprThis;
996 };
997
998 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
999 /// is overridden to be the object under construction.
1000 class CXXDefaultInitExprScope {
1001 public:
1002 CXXDefaultInitExprScope(CodeGenFunction &CGF)
1003 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue) {
1004 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis;
1005 }
1006 ~CXXDefaultInitExprScope() {
1007 CGF.CXXThisValue = OldCXXThisValue;
1008 }
1009
1010 public:
1011 CodeGenFunction &CGF;
1012 llvm::Value *OldCXXThisValue;
1013 };
1014
1015private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001016 /// CXXThisDecl - When generating code for a C++ member function,
1017 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001018 ImplicitParamDecl *CXXABIThisDecl;
1019 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001020 llvm::Value *CXXThisValue;
Mike Stump11289f42009-09-09 15:08:12 +00001021
Richard Smith852c9db2013-04-20 22:23:05 +00001022 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1023 /// this expression.
1024 llvm::Value *CXXDefaultInitExprThis;
1025
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001026 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1027 /// destructor, this will hold the implicit argument (e.g. VTT).
1028 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1029 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001030
John McCallce1de612011-01-26 04:00:11 +00001031 /// OutermostConditional - Points to the outermost active
1032 /// conditional control. This is used so that we know if a
1033 /// temporary should be destroyed conditionally.
1034 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001035
Nadav Rotem1da30942013-03-23 06:43:35 +00001036 /// The current lexical scope.
1037 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001038
Adrian Prantldc237b52013-05-16 00:41:26 +00001039 /// The current source location that should be used for exception
1040 /// handling code.
1041 SourceLocation CurEHLocation;
1042
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001043 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1044 /// type as well as the field number that contains the actual data.
Chris Lattner2192fe52011-07-18 04:24:23 +00001045 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001046 unsigned> > ByRefValueInfo;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001047
John McCallbd309292010-07-06 01:34:17 +00001048 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001049 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001050 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001051
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001052 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1053 /// In the kernel metadata node, reference the kernel function and metadata
1054 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001055 /// - A node for the vec_type_hint(<type>) qualifier contains string
1056 /// "vec_type_hint", an undefined value of the <type> data type,
1057 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001058 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1059 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1060 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1061 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1062 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1063 llvm::Function *Fn);
1064
Chris Lattnerbed31442007-05-28 01:07:47 +00001065public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001066 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001067 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001068
John McCall8ed55a52010-09-02 09:58:18 +00001069 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001070 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001071 CGDebugInfo *getDebugInfo() {
1072 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001073 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001074 return DebugInfo;
1075 }
1076 void disableDebugInfo() { DisableDebugInfo = true; }
1077 void enableDebugInfo() { DisableDebugInfo = false; }
1078
John McCall31168b02011-06-15 23:02:42 +00001079 bool shouldUseFusedARCCalls() {
1080 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1081 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001082
David Blaikiebbafb8a2012-03-11 07:00:24 +00001083 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001084
Bill Wendlingf0724e82011-09-19 20:31:14 +00001085 /// Returns a pointer to the function's exception object and selector slot,
1086 /// which is assigned in every landing pad.
John McCallbd309292010-07-06 01:34:17 +00001087 llvm::Value *getExceptionSlot();
John McCall9b382dd2011-05-28 21:13:02 +00001088 llvm::Value *getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001089
Bill Wendling79a70e42011-09-15 18:57:19 +00001090 /// Returns the contents of the function's exception object and selector
1091 /// slots.
1092 llvm::Value *getExceptionFromSlot();
1093 llvm::Value *getSelectorFromSlot();
1094
John McCallad5d61e2010-07-23 21:56:41 +00001095 llvm::Value *getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001096
John McCallbd309292010-07-06 01:34:17 +00001097 llvm::BasicBlock *getUnreachableBlock() {
1098 if (!UnreachableBlock) {
1099 UnreachableBlock = createBasicBlock("unreachable");
1100 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1101 }
1102 return UnreachableBlock;
1103 }
1104
1105 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001106 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001107 return getInvokeDestImpl();
1108 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001109
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001110 bool currentFunctionUsesSEHTry() const {
1111 const auto *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl);
1112 return FD && FD->usesSEHTry();
1113 }
1114
John McCallc8e01702013-04-16 22:48:15 +00001115 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001116 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001117
Daniel Dunbar12347492009-02-23 17:26:39 +00001118 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001119 // Cleanups
1120 //===--------------------------------------------------------------------===//
1121
1122 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1123
John McCall178360e2011-07-11 08:38:19 +00001124 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1125 llvm::Value *arrayEndPointer,
1126 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001127 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001128 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1129 llvm::Value *arrayEnd,
1130 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001131 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001132
John McCall4bd0fb12011-07-12 16:41:08 +00001133 void pushDestroy(QualType::DestructionKind dtorKind,
1134 llvm::Value *addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001135 void pushEHDestroy(QualType::DestructionKind dtorKind,
1136 llvm::Value *addr, QualType type);
John McCall82fe67b2011-07-09 01:37:26 +00001137 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001138 Destroyer *destroyer, bool useEHCleanupForArray);
Richard Smith736a9472013-06-12 20:42:33 +00001139 void pushLifetimeExtendedDestroy(CleanupKind kind, llvm::Value *addr,
1140 QualType type, Destroyer *destroyer,
1141 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001142 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1143 llvm::Value *CompletePtr,
1144 QualType ElementType);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001145 void pushStackRestore(CleanupKind kind, llvm::Value *SPMem);
Peter Collingbourne1425b452012-01-26 03:33:36 +00001146 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001147 bool useEHCleanupForArray);
David Blaikieebe87e12013-08-27 23:57:18 +00001148 llvm::Function *generateDestroyHelper(llvm::Constant *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001149 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001150 bool useEHCleanupForArray,
1151 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001152 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001153 QualType type, Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001154 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001155
Peter Collingbourne1425b452012-01-26 03:33:36 +00001156 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001157
John McCall82fe67b2011-07-09 01:37:26 +00001158 /// Determines whether an EH cleanup is required to destroy a type
1159 /// with the given destruction kind.
1160 bool needsEHCleanup(QualType::DestructionKind kind) {
1161 switch (kind) {
1162 case QualType::DK_none:
1163 return false;
1164 case QualType::DK_cxx_destructor:
1165 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001166 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001167 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001168 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001169 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1170 }
1171 llvm_unreachable("bad destruction kind");
1172 }
1173
John McCall4bd0fb12011-07-12 16:41:08 +00001174 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1175 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1176 }
1177
John McCall82fe67b2011-07-09 01:37:26 +00001178 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001179 // Objective-C
1180 //===--------------------------------------------------------------------===//
1181
Chris Lattner4bd55962008-03-30 23:03:07 +00001182 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001183
David Blaikief1425802015-01-14 00:04:42 +00001184 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001185
Mike Stumpfc496822009-02-08 23:14:22 +00001186 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001187 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1188 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001189 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001190 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001191 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001192 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001193
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001194 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1195 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001196
Mike Stumpfc496822009-02-08 23:14:22 +00001197 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1198 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001199 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1200 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001201 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001202 const ObjCPropertyImplDecl *propImpl,
1203 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian08b0f662010-04-13 00:38:05 +00001204 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001205 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001206
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001207 //===--------------------------------------------------------------------===//
1208 // Block Bits
1209 //===--------------------------------------------------------------------===//
1210
John McCall351762c2011-02-07 10:33:21 +00001211 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001212 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1213 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garstfc83aa02010-02-23 21:51:17 +00001214 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001215 const CGBlockInfo &Info,
Chris Lattner2192fe52011-07-18 04:24:23 +00001216 llvm::StructType *,
John McCallad7c5c12011-02-08 08:22:06 +00001217 llvm::Constant *BlockVarLayout);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001218
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001219 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001220 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001221 const DeclMapTy &ldm,
1222 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001223
John McCallad7c5c12011-02-08 08:22:06 +00001224 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1225 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001226 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1227 const ObjCPropertyImplDecl *PID);
1228 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1229 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001230 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001231
John McCallad7c5c12011-02-08 08:22:06 +00001232 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1233
John McCall73064872011-03-31 01:59:53 +00001234 class AutoVarEmission;
1235
1236 void emitByrefStructureInit(const AutoVarEmission &emission);
1237 void enterByrefCleanup(const AutoVarEmission &emission);
1238
John McCall351762c2011-02-07 10:33:21 +00001239 llvm::Value *LoadBlockStruct() {
1240 assert(BlockPointer && "no block pointer set!");
1241 return BlockPointer;
1242 }
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001243
John McCall87fe5d52010-05-20 01:18:31 +00001244 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCall113bee02012-03-10 09:33:50 +00001245 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall351762c2011-02-07 10:33:21 +00001246 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2192fe52011-07-18 04:24:23 +00001247 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001248
John McCalla738c252011-03-09 04:27:21 +00001249 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1250 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001251 /// \brief Emit code for the start of a function.
1252 /// \param Loc The location to be associated with the function.
1253 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001254 void StartFunction(GlobalDecl GD,
1255 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001256 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001257 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001258 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001259 SourceLocation Loc = SourceLocation(),
1260 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001261
John McCallb81884d2010-02-19 09:25:03 +00001262 void EmitConstructorBody(FunctionArgList &Args);
1263 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001264 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001265 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001266 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001267
Faisal Vali571df122013-09-29 08:45:24 +00001268 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001269 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001270 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001271 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001272 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1273 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001274 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001275
David Blaikiea0a1a872015-01-18 02:48:07 +00001276 /// \brief Emit the unified return block, trying to avoid its emission when
1277 /// possible.
1278 /// \return The debug location of the user written return statement if the
1279 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001280 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001281
Mike Stumpfc496822009-02-08 23:14:22 +00001282 /// FinishFunction - Complete IR generation of the current function. It is
1283 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001284 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001285
Nico Weber1bebad12015-02-11 22:33:32 +00001286 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1287 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001288
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001289 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001290
Reid Klecknerab2090d2014-07-26 01:34:32 +00001291 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1292 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1293 llvm::Value *Callee);
1294
Anders Carlssonbad991d2010-03-24 00:39:18 +00001295 /// GenerateThunk - Generate a thunk for the given method.
John McCalla738c252011-03-09 04:27:21 +00001296 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1297 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001298
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001299 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1300 const CGFunctionInfo &FnInfo,
1301 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001302
Douglas Gregor94f9a482010-05-05 05:51:00 +00001303 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1304 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001305
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001306 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001307 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001308
Anders Carlssone87fae92010-03-28 19:40:00 +00001309 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1310 /// subobject.
1311 ///
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001312 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001313 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001314 CharUnits OffsetFromNearestVBase,
Anders Carlssone87fae92010-03-28 19:40:00 +00001315 const CXXRecordDecl *VTableClass);
1316
1317 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001318 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001319 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001320 CharUnits OffsetFromNearestVBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001321 bool BaseIsNonVirtualPrimaryBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001322 const CXXRecordDecl *VTableClass,
1323 VisitedVirtualBasesSetTy& VBases);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001324
Anders Carlssond5895932010-03-28 21:07:49 +00001325 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001326
Dan Gohman8fc50c22010-10-26 18:44:08 +00001327 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1328 /// to by This.
Chris Lattner2192fe52011-07-18 04:24:23 +00001329 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssone87fae92010-03-28 19:40:00 +00001330
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001331 enum CFITypeCheckKind {
1332 CFITCK_VCall,
1333 CFITCK_NVCall,
1334 CFITCK_DerivedCast,
1335 CFITCK_UnrelatedCast,
1336 };
1337
Peter Collingbourned2926c92015-03-14 02:42:25 +00001338 /// \brief Derived is the presumed address of an object of type T after a
1339 /// cast. If T is a polymorphic class type, emit a check that the virtual
1340 /// table for Derived belongs to a class derived from T.
1341 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001342 bool MayBeNull, CFITypeCheckKind TCK,
1343 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001344
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001345 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1346 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001347 void EmitVTablePtrCheckForCall(const CXXMethodDecl *MD, llvm::Value *VTable,
1348 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001349
Peter Collingbourned2926c92015-03-14 02:42:25 +00001350 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
1351 /// RD using llvm.bitset.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001352 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1353 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001354
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001355 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1356 /// expr can be devirtualized.
1357 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1358 const CXXMethodDecl *MD);
1359
John McCallf99a6312010-07-21 05:30:47 +00001360 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1361 /// given phase of destruction for a destructor. The end result
1362 /// should call destructors on members and base classes in reverse
1363 /// order of their construction.
1364 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001365
Chris Lattner3c77a352010-06-22 00:03:40 +00001366 /// ShouldInstrumentFunction - Return true if the current function should be
1367 /// instrumented with __cyg_profile_func_* calls
1368 bool ShouldInstrumentFunction();
1369
1370 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1371 /// instrumentation function with the current function and the call site, if
1372 /// function instrumentation is enabled.
1373 void EmitFunctionInstrumentation(const char *Fn);
1374
Roman Divacky178e01602011-02-10 16:52:03 +00001375 /// EmitMCountInstrumentation - Emit call to .mcount.
1376 void EmitMCountInstrumentation();
1377
Mike Stumpfc496822009-02-08 23:14:22 +00001378 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1379 /// arguments for the given function. This is also responsible for naming the
1380 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001381 void EmitFunctionProlog(const CGFunctionInfo &FI,
1382 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001383 const FunctionArgList &Args);
1384
Mike Stumpfc496822009-02-08 23:14:22 +00001385 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1386 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001387 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1388 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001389
Mike Stump1d849212009-12-07 23:38:24 +00001390 /// EmitStartEHSpec - Emit the start of the exception spec.
1391 void EmitStartEHSpec(const Decl *D);
1392
1393 /// EmitEndEHSpec - Emit the end of the exception spec.
1394 void EmitEndEHSpec(const Decl *D);
1395
John McCallbd309292010-07-06 01:34:17 +00001396 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1397 llvm::BasicBlock *getTerminateLandingPad();
1398
1399 /// getTerminateHandler - Return a handler (not a landing pad, just
1400 /// a catch handler) that just calls terminate. This is used when
1401 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001402 llvm::BasicBlock *getTerminateHandler();
1403
Chris Lattnera5f58b02011-07-09 17:41:47 +00001404 llvm::Type *ConvertTypeForMem(QualType T);
1405 llvm::Type *ConvertType(QualType T);
1406 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001407 return ConvertType(getContext().getTypeDeclType(T));
1408 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001409
Mike Stumpfc496822009-02-08 23:14:22 +00001410 /// LoadObjCSelf - Load the value of self. This function is only valid while
1411 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001412 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001413
1414 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001415 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001416
Chris Lattner54fb19e2007-06-22 22:02:34 +00001417 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1418 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001419 static TypeEvaluationKind getEvaluationKind(QualType T);
1420
1421 static bool hasScalarEvaluationKind(QualType T) {
1422 return getEvaluationKind(T) == TEK_Scalar;
1423 }
1424
1425 static bool hasAggregateEvaluationKind(QualType T) {
1426 return getEvaluationKind(T) == TEK_Aggregate;
1427 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001428
1429 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001430 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001431 llvm::Function *parent = nullptr,
1432 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001433#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001434 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001435#else
John McCallad7c5c12011-02-08 08:22:06 +00001436 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001437#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001438 }
Mike Stumpfc496822009-02-08 23:14:22 +00001439
Chris Lattnerac248202007-05-30 00:13:02 +00001440 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1441 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001442 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001443
Mike Stumpe5311b02009-11-30 20:08:49 +00001444 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1445 /// another basic block, simplify it. This assumes that no other code could
1446 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001447 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1448
Mike Stumpfc496822009-02-08 23:14:22 +00001449 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1450 /// adding a fall-through branch from the current insert block if
1451 /// necessary. It is legal to call this function even if there is no current
1452 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001453 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001454 /// IsFinished - If true, indicates that the caller has finished emitting
1455 /// branches to the given block and does not expect to emit code into it. This
1456 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001457 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001458
John McCall8e4c74b2011-08-11 02:22:43 +00001459 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1460 /// near its uses, and leave the insertion point in it.
1461 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1462
Mike Stumpfc496822009-02-08 23:14:22 +00001463 /// EmitBranch - Emit a branch to the specified basic block from the current
1464 /// insert block, taking care to avoid creation of branches from dummy
1465 /// blocks. It is legal to call this function even if there is no current
1466 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001467 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001468 /// This function clears the current insertion point. The caller should follow
1469 /// calls to this function with calls to Emit*Block prior to generation new
1470 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001471 void EmitBranch(llvm::BasicBlock *Block);
1472
Mike Stumpfc496822009-02-08 23:14:22 +00001473 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1474 /// indicates that the current code being emitted is unreachable.
1475 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001476 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001477 }
1478
Mike Stumpfc496822009-02-08 23:14:22 +00001479 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1480 /// emitted IR has a place to go. Note that by definition, if this function
1481 /// creates a block then that block is unreachable; callers may do better to
1482 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001483 void EnsureInsertPoint() {
1484 if (!HaveInsertPoint())
1485 EmitBlock(createBasicBlock());
1486 }
Mike Stumpfc496822009-02-08 23:14:22 +00001487
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001488 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001489 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001490 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001491
Chris Lattnere9a64532007-06-22 21:44:33 +00001492 //===--------------------------------------------------------------------===//
1493 // Helpers
1494 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001495
Eli Friedmana0544d62011-12-03 04:14:32 +00001496 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1497 CharUnits Alignment = CharUnits()) {
Dan Gohman947c9af2010-10-14 23:06:10 +00001498 return LValue::MakeAddr(V, T, Alignment, getContext(),
1499 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001500 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001501
David Majnemer99281062014-09-18 22:05:54 +00001502 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001503
Chris Lattnere9a64532007-06-22 21:44:33 +00001504 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001505 /// block. The caller is responsible for setting an appropriate alignment on
1506 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001507 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001508 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001509
John McCall2e6567a2010-04-22 01:10:34 +00001510 /// InitTempAlloca - Provide an initial value for the given alloca.
1511 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1512
Daniel Dunbard0049182010-02-16 19:44:13 +00001513 /// CreateIRTemp - Create a temporary IR object of the given type, with
1514 /// appropriate alignment. This routine should only be used when an temporary
1515 /// value needs to be stored into an alloca (for example, to avoid explicit
1516 /// PHI construction), but the type is the IR type, not the type appropriate
1517 /// for storing in memory.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001518 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001519
Daniel Dunbara7566f12010-02-09 02:48:28 +00001520 /// CreateMemTemp - Create a temporary memory object of the given type, with
1521 /// appropriate alignment.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001522 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001523
John McCall7a626f62010-09-15 10:14:12 +00001524 /// CreateAggTemp - Create a temporary memory object for the given
1525 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001526 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedman38cd36d2011-12-03 02:13:40 +00001527 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001528 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1529 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001530 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001531 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001532 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001533 }
1534
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001535 /// CreateInAllocaTmp - Create a temporary memory object for the given
1536 /// aggregate type.
1537 AggValueSlot CreateInAllocaTmp(QualType T, const Twine &Name = "inalloca");
1538
John McCallad7c5c12011-02-08 08:22:06 +00001539 /// Emit a cast to void* in the appropriate address space.
1540 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1541
Chris Lattner8394d792007-06-05 20:53:16 +00001542 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1543 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001544 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001545
John McCalla2342eb2010-12-05 02:00:02 +00001546 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1547 void EmitIgnoredExpr(const Expr *E);
1548
Chris Lattner4647a212007-08-31 22:49:20 +00001549 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1550 /// any type. The result is returned as an RValue struct. If this is an
1551 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1552 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001553 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001554 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001555 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001556 AggValueSlot aggSlot = AggValueSlot::ignored(),
1557 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001558
Mike Stumpfc496822009-02-08 23:14:22 +00001559 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1560 // or the value of the expression, depending on how va_list is defined.
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001561 llvm::Value *EmitVAListRef(const Expr *E);
1562
Mike Stumpfc496822009-02-08 23:14:22 +00001563 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1564 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001565 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001566
John McCall91ca10f2011-03-08 09:11:50 +00001567 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001568 /// arbitrary expression into the given memory location.
John McCall21886962010-04-21 10:05:39 +00001569 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001570 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001571
David Majnemer7c237072015-03-05 00:46:22 +00001572 void EmitAnyExprToExn(const Expr *E, llvm::Value *Addr);
1573
John McCall91ca10f2011-03-08 09:11:50 +00001574 /// EmitExprAsInit - Emits the code necessary to initialize a
1575 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001576 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001577 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001578
Fariborz Jahanian78652202013-01-25 23:57:05 +00001579 /// hasVolatileMember - returns true if aggregate type has a volatile
1580 /// member.
1581 bool hasVolatileMember(QualType T) {
1582 if (const RecordType *RT = T->getAs<RecordType>()) {
1583 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1584 return RD->hasVolatileMember();
1585 }
1586 return false;
1587 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001588 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001589 ///
1590 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1591 /// This is required for correctness when assigning non-POD structures in C++.
1592 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001593 QualType EltTy) {
1594 bool IsVolatile = hasVolatileMember(EltTy);
1595 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1596 true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001597 }
1598
David Majnemerfd1e7392015-02-03 23:04:06 +00001599 void EmitAggregateCopyCtor(llvm::Value *DestPtr, llvm::Value *SrcPtr,
1600 QualType DestTy, QualType SrcTy) {
1601 CharUnits DestTypeAlign = getContext().getTypeAlignInChars(DestTy);
1602 CharUnits SrcTypeAlign = getContext().getTypeAlignInChars(SrcTy);
1603 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
1604 std::min(DestTypeAlign, SrcTypeAlign),
1605 /*IsAssignment=*/false);
1606 }
1607
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001608 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001609 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001610 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001611 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001612 /// \param isAssignment - If false, allow padding to be copied. This often
1613 /// yields more efficient.
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001614 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001615 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001616 CharUnits Alignment = CharUnits::Zero(),
1617 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001618
Devang Patelda5d6bb2007-10-04 23:45:31 +00001619 /// StartBlock - Start new block named N. If insert block is a dummy block
1620 /// then reuse it.
1621 void StartBlock(const char *N);
1622
Anders Carlsson9396a892008-09-11 09:15:33 +00001623 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall5d865c322010-08-31 07:33:07 +00001624 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1625 llvm::Value *Res = LocalDeclMap[VD];
1626 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1627 return Res;
1628 }
Mike Stumpfc496822009-02-08 23:14:22 +00001629
John McCallc07a0c72011-02-17 10:25:35 +00001630 /// getOpaqueLValueMapping - Given an opaque value expression (which
1631 /// must be mapped to an l-value), return its mapping.
1632 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1633 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1634
1635 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1636 it = OpaqueLValues.find(e);
1637 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1638 return it->second;
1639 }
1640
1641 /// getOpaqueRValueMapping - Given an opaque value expression (which
1642 /// must be mapped to an r-value), return its mapping.
1643 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1644 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1645
1646 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1647 it = OpaqueRValues.find(e);
1648 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001649 return it->second;
1650 }
1651
Dan Gohman75d69da2008-05-22 00:50:06 +00001652 /// getAccessedFieldNo - Given an encoded value and a result number, return
1653 /// the input field number being accessed.
1654 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1655
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001656 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001657 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001658
Anders Carlssonc0964b62010-05-22 17:35:42 +00001659 /// EmitNullInitialization - Generate code to set a value of the given type to
1660 /// null, If the type contains data member pointers, they will be initialized
1661 /// to -1 in accordance with the Itanium C++ ABI.
1662 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001663
1664 // EmitVAArg - Generate code to get an argument from the passed in pointer
1665 // and update it accordingly. The return value is a pointer to the argument.
1666 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001667 // instruction in LLVM instead once it works well enough.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001668 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001669
John McCall82fe67b2011-07-09 01:37:26 +00001670 /// emitArrayLength - Compute the length of an array, even if it's a
1671 /// VLA, and drill down to the base element type.
1672 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1673 QualType &baseType,
1674 llvm::Value *&addr);
1675
John McCall23c29fe2011-06-24 21:55:10 +00001676 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1677 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001678 ///
1679 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001680 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001681
John McCall23c29fe2011-06-24 21:55:10 +00001682 /// getVLASize - Returns an LLVM value that corresponds to the size,
1683 /// in non-variably-sized elements, of a variable length array type,
1684 /// plus that largest non-variably-sized element type. Assumes that
1685 /// the type has already been emitted with EmitVariablyModifiedType.
1686 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1687 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001688
Anders Carlssona5d077d2009-04-14 16:58:56 +00001689 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1690 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001691 llvm::Value *LoadCXXThis() {
1692 assert(CXXThisValue && "no 'this' value for this function");
1693 return CXXThisValue;
1694 }
Mike Stump11289f42009-09-09 15:08:12 +00001695
Anders Carlssone36a6b32010-01-02 01:01:18 +00001696 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1697 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001698 // FIXME: Every place that calls LoadCXXVTT is something
1699 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001700 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001701 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1702 return CXXStructorImplicitParamValue;
1703 }
1704
1705 /// LoadCXXStructorImplicitParam - Load the implicit parameter
1706 /// for a constructor/destructor.
1707 llvm::Value *LoadCXXStructorImplicitParam() {
1708 assert(CXXStructorImplicitParamValue &&
1709 "no implicit argument value for this function");
1710 return CXXStructorImplicitParamValue;
John McCall347132b2010-02-16 22:04:33 +00001711 }
John McCall6ce74722010-02-16 04:15:37 +00001712
1713 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001714 /// complete class to the given direct base.
1715 llvm::Value *
1716 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1717 const CXXRecordDecl *Derived,
1718 const CXXRecordDecl *Base,
1719 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001720
Mike Stumpe5311b02009-11-30 20:08:49 +00001721 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1722 /// load of 'this' and returns address of the base class.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001723 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001724 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001725 CastExpr::path_const_iterator PathBegin,
1726 CastExpr::path_const_iterator PathEnd,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001727 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001728
Anders Carlsson8c793172009-11-23 17:57:54 +00001729 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001730 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001731 CastExpr::path_const_iterator PathBegin,
1732 CastExpr::path_const_iterator PathEnd,
Anders Carlsson8c793172009-11-23 17:57:54 +00001733 bool NullCheckValue);
1734
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001735 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1736 /// base constructor/destructor with virtual bases.
1737 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1738 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1739 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1740 bool Delegating);
1741
John McCallf8ff7b92010-02-23 00:48:20 +00001742 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1743 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001744 const FunctionArgList &Args,
1745 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001746 // It's important not to confuse this and the previous function. Delegating
1747 // constructors are the C++0x feature. The constructor delegate optimization
1748 // is used to reduce duplication in the base and complete consturctors where
1749 // they are substantially the same.
1750 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1751 const FunctionArgList &Args);
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001752 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001753 bool ForVirtualBase, bool Delegating,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001754 llvm::Value *This, const CXXConstructExpr *E);
1755
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001756 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1757 llvm::Value *This, llvm::Value *Src,
Alexey Samsonov525bf652014-08-25 21:58:56 +00001758 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001759
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001760 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001761 const ConstantArrayType *ArrayTy,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001762 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001763 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001764 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001765
Anders Carlssond49844b2009-09-23 02:45:36 +00001766 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1767 llvm::Value *NumElements,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001768 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001769 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001770 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001771
John McCall82fe67b2011-07-09 01:37:26 +00001772 static Destroyer destroyCXXObject;
1773
Anders Carlsson0a637412009-05-29 21:03:38 +00001774 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001775 bool ForVirtualBase, bool Delegating,
1776 llvm::Value *This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001777
John McCall99210dc2011-09-15 06:49:18 +00001778 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
David Blaikiefb901c7a2015-04-04 15:12:29 +00001779 llvm::Type *ElementTy, llvm::Value *NewPtr,
1780 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00001781 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00001782
Peter Collingbourne702b2842011-11-27 22:09:22 +00001783 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1784 llvm::Value *Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001785
David Majnemerdc012fa2015-04-22 21:38:15 +00001786 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
1787 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
1788
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001789 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001790 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001791
Eli Friedman24f55432009-11-18 00:57:03 +00001792 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1793 QualType DeleteTy);
1794
Richard Smith760520b2014-06-03 23:27:44 +00001795 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1796 const Expr *Arg, bool IsDelete);
1797
Mike Stumpc9b231c2009-11-15 08:09:41 +00001798 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stump65511702009-11-16 06:50:58 +00001799 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Nico Webercf4ff5862012-10-11 10:13:44 +00001800 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001801
Richard Smith69d0d262012-08-24 00:54:33 +00001802 /// \brief Situations in which we might emit a check for the suitability of a
1803 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001804 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001805 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001806 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001807 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001808 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001809 /// Checking the bound value in a reference binding. Must be suitably sized
1810 /// and aligned, but is not required to refer to an object (until the
1811 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001812 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001813 /// Checking the object expression in a non-static data member access. Must
1814 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001815 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001816 /// Checking the 'this' pointer for a call to a non-static member function.
1817 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001818 TCK_MemberCall,
1819 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001820 TCK_ConstructorCall,
1821 /// Checking the operand of a static_cast to a derived pointer type. Must be
1822 /// null or an object within its lifetime.
1823 TCK_DowncastPointer,
1824 /// Checking the operand of a static_cast to a derived reference type. Must
1825 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001826 TCK_DowncastReference,
1827 /// Checking the operand of a cast to a base object. Must be suitably sized
1828 /// and aligned.
1829 TCK_Upcast,
1830 /// Checking the operand of a cast to a virtual base object. Must be an
1831 /// object within its lifetime.
1832 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00001833 };
1834
Alexey Samsonovac4afe42014-07-07 23:59:57 +00001835 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
1836 /// calls to EmitTypeCheck can be skipped.
1837 bool sanitizePerformTypeCheck() const;
1838
Richard Smith4d1458e2012-09-08 02:08:36 +00001839 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001840 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001841 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001842 QualType Type, CharUnits Alignment = CharUnits::Zero(),
1843 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001844
Richard Smith539e4a72013-02-23 02:53:19 +00001845 /// \brief Emit a check that \p Base points into an array object, which
1846 /// we can access at index \p Index. \p Accessed should be \c false if we
1847 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1848 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1849 QualType IndexType, bool Accessed);
1850
Chris Lattner116ce8f2010-01-09 21:40:03 +00001851 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1852 bool isInc, bool isPre);
1853 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1854 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00001855
1856 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00001857 llvm::Value *OffsetValue = nullptr) {
1858 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
1859 OffsetValue);
1860 }
Hal Finkelbcc06082014-09-07 22:58:14 +00001861
Chris Lattner8394d792007-06-05 20:53:16 +00001862 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001863 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001864 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001865
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001866 /// EmitDecl - Emit a declaration.
1867 ///
1868 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001869 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001870
John McCall1c9c3fd2010-10-15 04:57:14 +00001871 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001872 ///
1873 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001874 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001875
David Blaikie73ca5692014-12-09 00:32:22 +00001876 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001877 bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00001878 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001879
John McCallbd309292010-07-06 01:34:17 +00001880 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1881 llvm::Value *Address);
1882
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001883 /// \brief Determine whether the given initializer is trivial in the sense
1884 /// that it requires no code to be generated.
1885 bool isTrivialInitializer(const Expr *Init);
1886
John McCall1c9c3fd2010-10-15 04:57:14 +00001887 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001888 ///
1889 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00001890 void EmitAutoVarDecl(const VarDecl &D);
1891
1892 class AutoVarEmission {
1893 friend class CodeGenFunction;
1894
John McCall9e2e22f2011-02-22 07:16:58 +00001895 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00001896
1897 /// The alignment of the variable.
1898 CharUnits Alignment;
1899
1900 /// The address of the alloca. Null if the variable was emitted
1901 /// as a global constant.
1902 llvm::Value *Address;
1903
1904 llvm::Value *NRVOFlag;
1905
1906 /// True if the variable is a __block variable.
1907 bool IsByRef;
1908
1909 /// True if the variable is of aggregate type and has a constant
1910 /// initializer.
1911 bool IsConstantAggregate;
1912
Nadav Rotem1da30942013-03-23 06:43:35 +00001913 /// Non-null if we should use lifetime annotations.
1914 llvm::Value *SizeForLifetimeMarkers;
1915
John McCall9e2e22f2011-02-22 07:16:58 +00001916 struct Invalid {};
Craig Topper8a13c412014-05-21 05:09:00 +00001917 AutoVarEmission(Invalid) : Variable(nullptr) {}
John McCall9e2e22f2011-02-22 07:16:58 +00001918
John McCallc533cb72011-02-22 06:44:22 +00001919 AutoVarEmission(const VarDecl &variable)
Craig Topper8a13c412014-05-21 05:09:00 +00001920 : Variable(&variable), Address(nullptr), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00001921 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00001922 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00001923
Craig Topper8a13c412014-05-21 05:09:00 +00001924 bool wasEmittedAsGlobal() const { return Address == nullptr; }
John McCallc533cb72011-02-22 06:44:22 +00001925
1926 public:
John McCall9e2e22f2011-02-22 07:16:58 +00001927 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1928
Craig Topper8a13c412014-05-21 05:09:00 +00001929 bool useLifetimeMarkers() const {
1930 return SizeForLifetimeMarkers != nullptr;
1931 }
Nadav Rotem1da30942013-03-23 06:43:35 +00001932 llvm::Value *getSizeForLifetimeMarkers() const {
1933 assert(useLifetimeMarkers());
1934 return SizeForLifetimeMarkers;
1935 }
1936
1937 /// Returns the raw, allocated address, which is not necessarily
1938 /// the address of the object itself.
1939 llvm::Value *getAllocatedAddress() const {
1940 return Address;
1941 }
1942
John McCallc533cb72011-02-22 06:44:22 +00001943 /// Returns the address of the object within this declaration.
1944 /// Note that this does not chase the forwarding pointer for
1945 /// __block decls.
1946 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1947 if (!IsByRef) return Address;
1948
David Blaikie1ed728c2015-04-05 22:45:47 +00001949 auto F = CGF.getByRefValueLLVMField(Variable);
1950 return CGF.Builder.CreateStructGEP(F.first, Address, F.second,
John McCall9e2e22f2011-02-22 07:16:58 +00001951 Variable->getNameAsString());
John McCallc533cb72011-02-22 06:44:22 +00001952 }
1953 };
1954 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1955 void EmitAutoVarInit(const AutoVarEmission &emission);
1956 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00001957 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1958 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001959
John McCall1c9c3fd2010-10-15 04:57:14 +00001960 void EmitStaticVarDecl(const VarDecl &D,
1961 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001962
1963 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001964 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, bool ArgIsPointer,
1965 unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00001966
John McCallc07a0c72011-02-17 10:25:35 +00001967 /// protectFromPeepholes - Protect a value that we're intending to
1968 /// store to the side, but which will probably be used later, from
1969 /// aggressive peepholing optimizations that might delete it.
1970 ///
1971 /// Pass the result to unprotectFromPeepholes to declare that
1972 /// protection is no longer required.
1973 ///
1974 /// There's no particular reason why this shouldn't apply to
1975 /// l-values, it's just that no existing peepholes work on pointers.
1976 PeepholeProtection protectFromPeepholes(RValue rvalue);
1977 void unprotectFromPeepholes(PeepholeProtection protection);
1978
Chris Lattner84915fa2007-06-02 04:16:21 +00001979 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00001980 // Statement Emission
1981 //===--------------------------------------------------------------------===//
1982
Mike Stumpfc496822009-02-08 23:14:22 +00001983 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001984 void EmitStopPoint(const Stmt *S);
1985
Mike Stumpfc496822009-02-08 23:14:22 +00001986 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1987 /// this function even if there is no current insertion point.
1988 ///
1989 /// This function may clear the current insertion point; callers should use
1990 /// EnsureInsertPoint if they wish to subsequently generate code without first
1991 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00001992 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001993
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001994 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00001995 /// necessarily require an insertion point or debug information; typically
1996 /// because the statement amounts to a jump or a container of other
1997 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001998 ///
1999 /// \return True if the statement was handled.
2000 bool EmitSimpleStmt(const Stmt *S);
2001
Eli Friedman4871a462013-06-10 22:04:49 +00002002 llvm::Value *EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2003 AggValueSlot AVS = AggValueSlot::ignored());
2004 llvm::Value *EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2005 bool GetLast = false,
2006 AggValueSlot AVS =
2007 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002008
Mike Stumpfc496822009-02-08 23:14:22 +00002009 /// EmitLabel - Emit the block for the given label. It is legal to call this
2010 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002011 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002012
Chris Lattnerac248202007-05-30 00:13:02 +00002013 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002014 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002015 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002016 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002017 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002018
2019 void EmitCondBrHints(llvm::LLVMContext &Context, llvm::BranchInst *CondBr,
Craig Topper3cb91b22014-08-27 06:28:16 +00002020 ArrayRef<const Attr *> Attrs);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002021 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002022 ArrayRef<const Attr *> Attrs = None);
2023 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002024 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002025 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002026 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002027 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002028 void EmitBreakStmt(const BreakStmt &S);
2029 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002030 void EmitSwitchStmt(const SwitchStmt &S);
2031 void EmitDefaultStmt(const DefaultStmt &S);
2032 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002033 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002034 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002035
Anders Carlsson2e744e82008-08-30 19:51:14 +00002036 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002037 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2038 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002039 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002040 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002041
John McCallb609d3f2010-07-07 06:56:46 +00002042 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2043 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002044
Anders Carlsson52d78a52009-09-27 18:58:34 +00002045 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002046 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002047 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002048 void EnterSEHTryStmt(const SEHTryStmt &S);
2049 void ExitSEHTryStmt(const SEHTryStmt &S);
2050
Nico Webere4f974c2015-07-02 06:10:53 +00002051 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, StringRef Name,
2052 QualType RetTy, FunctionArgList &Args,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002053 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002054
2055 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2056 const SEHExceptStmt &Except);
2057
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002058 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2059 const SEHFinallyStmt &Finally);
2060
Nico Webere4f974c2015-07-02 06:10:53 +00002061 void EmitSEHExceptionCodeSave();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002062 llvm::Value *EmitSEHExceptionCode();
2063 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002064 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002065
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002066 /// Scan the outlined statement for captures from the parent function. For
2067 /// each capture, mark the capture as escaped and emit a call to
2068 /// llvm.framerecover. Insert the framerecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002069 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Nico Webere4f974c2015-07-02 06:10:53 +00002070 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002071
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002072 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002073 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002074
Alexey Bataev330de032014-10-29 12:21:55 +00002075 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002076 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002077 void GenerateCapturedStmtFunctionProlog(const CapturedStmt &S);
2078 llvm::Function *GenerateCapturedStmtFunctionEpilog(const CapturedStmt &S);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002079 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev9959db52014-05-06 10:08:46 +00002080 llvm::Value *GenerateCapturedStmtArgument(const CapturedStmt &S);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002081 /// \brief Perform element by element copying of arrays with type \a
2082 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2083 /// generated by \a CopyGen.
2084 ///
2085 /// \param DestAddr Address of the destination array.
2086 /// \param SrcAddr Address of the source array.
2087 /// \param OriginalType Type of destination and source arrays.
2088 /// \param CopyGen Copying procedure that copies value of single array element
2089 /// to another single array element.
2090 void EmitOMPAggregateAssign(
2091 llvm::Value *DestAddr, llvm::Value *SrcAddr, QualType OriginalType,
2092 const llvm::function_ref<void(llvm::Value *, llvm::Value *)> &CopyGen);
2093 /// \brief Emit proper copying of data from one variable to another.
2094 ///
2095 /// \param OriginalType Original type of the copied variables.
2096 /// \param DestAddr Destination address.
2097 /// \param SrcAddr Source address.
2098 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2099 /// type of the base array element).
2100 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2101 /// the base array element).
2102 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2103 /// DestVD.
2104 void EmitOMPCopy(CodeGenFunction &CGF, QualType OriginalType,
2105 llvm::Value *DestAddr, llvm::Value *SrcAddr,
2106 const VarDecl *DestVD, const VarDecl *SrcVD,
2107 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002108 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2109 /// \a X = \a E \a BO \a E.
2110 ///
2111 /// \param X Value to be updated.
2112 /// \param E Update value.
2113 /// \param BO Binary operation for update operation.
2114 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2115 /// expression, false otherwise.
2116 /// \param AO Atomic ordering of the generated atomic instructions.
2117 /// \param CommonGen Code generator for complex expressions that cannot be
2118 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002119 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2120 /// generated, <false, RValue::get(nullptr)> otherwise.
2121 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002122 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2123 llvm::AtomicOrdering AO, SourceLocation Loc,
2124 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002125 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002126 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002127 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2128 OMPPrivateScope &PrivateScope);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002129 /// \brief Emit code for copyin clause in \a D directive. The next code is
2130 /// generated at the start of outlined functions for directives:
2131 /// \code
2132 /// threadprivate_var1 = master_threadprivate_var1;
2133 /// operator=(threadprivate_var2, master_threadprivate_var2);
2134 /// ...
2135 /// __kmpc_barrier(&loc, global_tid);
2136 /// \endcode
2137 ///
2138 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2139 /// \returns true if at least one copyin variable is found, false otherwise.
2140 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002141 /// \brief Emit initial code for lastprivate variables. If some variable is
2142 /// not also firstprivate, then the default initialization is used. Otherwise
2143 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2144 /// method.
2145 ///
2146 /// \param D Directive that may have 'lastprivate' directives.
2147 /// \param PrivateScope Private scope for capturing lastprivate variables for
2148 /// proper codegen in internal captured statement.
2149 ///
2150 /// \returns true if there is at least one lastprivate variable, false
2151 /// otherwise.
2152 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2153 OMPPrivateScope &PrivateScope);
2154 /// \brief Emit final copying of lastprivate values to original variables at
2155 /// the end of the worksharing or simd directive.
2156 ///
2157 /// \param D Directive that has at least one 'lastprivate' directives.
2158 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2159 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002160 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002161 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002162 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002163 /// \brief Emit initial code for reduction variables. Creates reduction copies
2164 /// and initializes them with the values according to OpenMP standard.
2165 ///
2166 /// \param D Directive (possibly) with the 'reduction' clause.
2167 /// \param PrivateScope Private scope for capturing reduction variables for
2168 /// proper codegen in internal captured statement.
2169 ///
2170 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2171 OMPPrivateScope &PrivateScope);
2172 /// \brief Emit final update of reduction values to original variables at
2173 /// the end of the directive.
2174 ///
2175 /// \param D Directive that has at least one 'reduction' directives.
2176 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002177 /// \brief Emit initial code for linear variables. Creates private copies
2178 /// and initializes them with the values according to OpenMP standard.
2179 ///
2180 /// \param D Directive (possibly) with the 'linear' clause.
2181 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002182
2183 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002184 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002185 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002186 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002187 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002188 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002189 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002190 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002191 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002192 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002193 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002194 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002195 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002196 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002197 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002198 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002199 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002200 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002201 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002202 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002203 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002204 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002205 void
2206 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002207 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002208
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002209 /// \brief Emit inner loop of the worksharing/simd construct.
2210 ///
2211 /// \param S Directive, for which the inner loop must be emitted.
2212 /// \param RequiresCleanup true, if directive has some associated private
2213 /// variables.
2214 /// \param LoopCond Bollean condition for loop continuation.
2215 /// \param IncExpr Increment expression for loop control variable.
2216 /// \param BodyGen Generator for the inner body of the inner loop.
2217 /// \param PostIncGen Genrator for post-increment code (required for ordered
2218 /// loop directvies).
2219 void EmitOMPInnerLoop(
2220 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2221 const Expr *IncExpr,
2222 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2223 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002224
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002225 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
2226
Alexander Musmanc6388682014-12-15 07:07:06 +00002227private:
2228
2229 /// Helpers for the OpenMP loop directives.
Alexey Bataev0f34da12015-07-02 04:17:07 +00002230 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
Alexey Bataev58e5bdb2015-06-18 04:45:29 +00002231 void EmitOMPSimdInit(const OMPLoopDirective &D);
2232 void EmitOMPSimdFinal(const OMPLoopDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002233 /// \brief Emit code for the worksharing loop-based directive.
2234 /// \return true, if this construct has any lastprivate clause, false -
2235 /// otherwise.
2236 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Alexander Musmandf7a8e22015-01-22 08:49:35 +00002237 void EmitOMPForOuterLoop(OpenMPScheduleClauseKind ScheduleKind,
2238 const OMPLoopDirective &S,
Alexey Bataevd7589ffe2015-05-20 13:12:48 +00002239 OMPPrivateScope &LoopScope, bool Ordered,
2240 llvm::Value *LB, llvm::Value *UB, llvm::Value *ST,
2241 llvm::Value *IL, llvm::Value *Chunk);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002242 /// \brief Emit code for sections directive.
2243 OpenMPDirectiveKind EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002244
2245public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002246
Chris Lattner208ae962007-05-30 17:57:17 +00002247 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002248 // LValue Expression Emission
2249 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002250
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002251 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2252 RValue GetUndefRValue(QualType Ty);
2253
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002254 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2255 /// and issue an ErrorUnsupported style diagnostic (using the
2256 /// provided Name).
2257 RValue EmitUnsupportedRValue(const Expr *E,
2258 const char *Name);
2259
Mike Stumpfc496822009-02-08 23:14:22 +00002260 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2261 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002262 LValue EmitUnsupportedLValue(const Expr *E,
2263 const char *Name);
2264
Chris Lattner8394d792007-06-05 20:53:16 +00002265 /// EmitLValue - Emit code to compute a designator that specifies the location
2266 /// of the expression.
2267 ///
2268 /// This can return one of two things: a simple address or a bitfield
2269 /// reference. In either case, the LLVM Value* in the LValue structure is
2270 /// guaranteed to be an LLVM pointer type.
2271 ///
2272 /// If this returns a bitfield reference, nothing about the pointee type of
2273 /// the LLVM value is known: For example, it may not be a pointer to an
2274 /// integer.
2275 ///
2276 /// If this returns a normal address, and if the lvalue's C type is fixed
2277 /// size, this method guarantees that the returned pointer type will point to
2278 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2279 /// variable length type, this is not possible.
2280 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002281 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002282
Richard Smith4d1458e2012-09-08 02:08:36 +00002283 /// \brief Same as EmitLValue but additionally we generate checking code to
2284 /// guard against undefined behavior. This is only suitable when we know
2285 /// that the address will be used to access the object.
2286 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002287
Nick Lewycky2d84e842013-10-02 02:29:49 +00002288 RValue convertTempToRValue(llvm::Value *addr, QualType type,
2289 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002290
John McCalla8ec7eb2013-03-07 21:37:17 +00002291 void EmitAtomicInit(Expr *E, LValue lvalue);
2292
David Majnemera5b195a2015-02-14 01:35:12 +00002293 bool LValueIsSuitableForInlineAtomic(LValue Src);
2294 bool typeIsSuitableForInlineAtomic(QualType Ty, bool IsVolatile) const;
2295
2296 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2297 AggValueSlot Slot = AggValueSlot::ignored());
2298
Nick Lewycky2d84e842013-10-02 02:29:49 +00002299 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002300 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002301 AggValueSlot slot = AggValueSlot::ignored());
2302
2303 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2304
David Majnemera5b195a2015-02-14 01:35:12 +00002305 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2306 bool IsVolatile, bool isInit);
2307
Alexey Bataevb4505a72015-03-30 05:20:59 +00002308 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002309 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
2310 llvm::AtomicOrdering Success = llvm::SequentiallyConsistent,
2311 llvm::AtomicOrdering Failure = llvm::SequentiallyConsistent,
2312 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2313
Alexey Bataevb4505a72015-03-30 05:20:59 +00002314 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002315 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002316 bool IsVolatile);
2317
John McCall3a7f6922010-10-27 20:58:56 +00002318 /// EmitToMemory - Change a scalar value from its value
2319 /// representation to its in-memory representation.
2320 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2321
2322 /// EmitFromMemory - Change a scalar value from its memory
2323 /// representation to its value representation.
2324 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2325
Daniel Dunbar1d425462009-02-10 00:57:50 +00002326 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2327 /// care to appropriately convert from the memory representation to
2328 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002329 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman947c9af2010-10-14 23:06:10 +00002330 unsigned Alignment, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002331 SourceLocation Loc,
Craig Topper8a13c412014-05-21 05:09:00 +00002332 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002333 QualType TBAABaseTy = QualType(),
2334 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002335
2336 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2337 /// care to appropriately convert from the memory representation to
2338 /// the LLVM value representation. The l-value must be a simple
2339 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002340 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002341
2342 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2343 /// care to appropriately convert from the memory representation to
2344 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002345 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman947c9af2010-10-14 23:06:10 +00002346 bool Volatile, unsigned Alignment, QualType Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00002347 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002348 QualType TBAABaseTy = QualType(),
2349 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002350
2351 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2352 /// care to appropriately convert from the memory representation to
2353 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002354 /// l-value. The isInit flag indicates whether this is an initialization.
2355 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2356 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002357
Chris Lattner8394d792007-06-05 20:53:16 +00002358 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2359 /// this method emits the address of the lvalue, then loads the result as an
2360 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002361 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002362 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2363 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002364 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002365
Chris Lattner8394d792007-06-05 20:53:16 +00002366 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2367 /// lvalue, where both are guaranteed to the have the same type, and that type
2368 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002369 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002370 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002371 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002372
Nick Lewycky2d84e842013-10-02 02:29:49 +00002373 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2374 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002375 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002376 /// \param Result [out] - If non-null, this will be set to a Value* for the
2377 /// bit-field contents after the store, appropriate for use as the result of
2378 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002379 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002380 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002381
John McCall4f29b492010-11-16 23:07:28 +00002382 /// Emit an l-value for an assignment (simple or compound) of complex type.
2383 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002384 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002385 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2386 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002387
Chris Lattner57540c52011-04-15 05:22:18 +00002388 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002389 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002390 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002391 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002392 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002393 // Note: only available for agg return types
2394 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002395 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Renato Golin230c5eb2014-05-19 18:15:42 +00002396 LValue EmitReadRegister(const VarDecl *VD);
Chris Lattner4347e3692007-06-06 04:54:52 +00002397 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002398 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002399 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002400 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002401 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2402 bool Accessed = false);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002403 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002404 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002405 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002406 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002407 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002408 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002409 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002410 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002411 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002412
2413 llvm::Value *EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002414
Nick Lewycky2d84e842013-10-02 02:29:49 +00002415 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002416
John McCall71335052012-03-10 03:05:10 +00002417 class ConstantEmission {
2418 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2419 ConstantEmission(llvm::Constant *C, bool isReference)
2420 : ValueAndIsReference(C, isReference) {}
2421 public:
2422 ConstantEmission() {}
2423 static ConstantEmission forReference(llvm::Constant *C) {
2424 return ConstantEmission(C, true);
2425 }
2426 static ConstantEmission forValue(llvm::Constant *C) {
2427 return ConstantEmission(C, false);
2428 }
2429
Aaron Ballman67347662015-02-15 22:00:28 +00002430 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002431 return ValueAndIsReference.getOpaqueValue() != nullptr;
2432 }
John McCall71335052012-03-10 03:05:10 +00002433
2434 bool isReference() const { return ValueAndIsReference.getInt(); }
2435 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2436 assert(isReference());
2437 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2438 refExpr->getType());
2439 }
2440
2441 llvm::Constant *getValue() const {
2442 assert(!isReference());
2443 return ValueAndIsReference.getPointer();
2444 }
2445 };
2446
John McCall113bee02012-03-10 09:33:50 +00002447 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002448
John McCallfe96e0b2011-11-06 09:01:30 +00002449 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2450 AggValueSlot slot = AggValueSlot::ignored());
2451 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2452
Daniel Dunbar722f4242009-04-22 05:08:15 +00002453 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002454 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002455 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002456 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002457
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002458 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2459 /// if the Field is a reference, this will return the address of the reference
2460 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002461 LValue EmitLValueForFieldInitialization(LValue Base,
2462 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002463
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002464 LValue EmitLValueForIvar(QualType ObjectTy,
2465 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002466 unsigned CVRQualifiers);
2467
Anders Carlsson3be22e22009-05-30 23:23:33 +00002468 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002469 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002470 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002471 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002472 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002473
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002474 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002475 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002476 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002477 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002478 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002479 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002480
Chris Lattnerd7f58862007-06-02 05:24:33 +00002481 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002482 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002483 //===--------------------------------------------------------------------===//
2484
Mike Stumpfc496822009-02-08 23:14:22 +00002485 /// EmitCall - Generate a call of the given function, expecting the given
2486 /// result type, and using the given argument list which specifies both the
2487 /// LLVM arguments and the types they were derived from.
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002488 ///
Mike Stumpe5311b02009-11-30 20:08:49 +00002489 /// \param TargetDecl - If given, the decl of the function in a direct call;
2490 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbard931a872009-02-02 22:03:45 +00002491 RValue EmitCall(const CGFunctionInfo &FnInfo,
2492 llvm::Value *Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00002493 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002494 const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00002495 const Decl *TargetDecl = nullptr,
2496 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002497
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002498 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002499 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00002500 const Decl *TargetDecl = nullptr,
2501 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002502 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002503 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002504
John McCall882987f2013-02-28 19:01:20 +00002505 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2506 const Twine &name = "");
2507 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2508 ArrayRef<llvm::Value*> args,
2509 const Twine &name = "");
2510 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2511 const Twine &name = "");
2512 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2513 ArrayRef<llvm::Value*> args,
2514 const Twine &name = "");
2515
John McCallbd309292010-07-06 01:34:17 +00002516 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002517 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002518 const Twine &Name = "");
Jay Foad5bd375a2011-07-15 08:37:34 +00002519 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002520 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002521 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2522 ArrayRef<llvm::Value*> args,
2523 const Twine &name = "");
2524 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2525 const Twine &name = "");
2526 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2527 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002528
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002529 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2530 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002531 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002532
2533 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2534 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002535 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002536
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002537 RValue
2538 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2539 ReturnValueSlot ReturnValue, llvm::Value *This,
2540 llvm::Value *ImplicitParam,
2541 QualType ImplicitParamTy, const CallExpr *E);
David Majnemer0c0b6d92014-10-31 20:09:12 +00002542 RValue EmitCXXStructorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2543 ReturnValueSlot ReturnValue, llvm::Value *This,
2544 llvm::Value *ImplicitParam,
2545 QualType ImplicitParamTy, const CallExpr *E,
2546 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002547 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2548 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002549 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2550 const CXXMethodDecl *MD,
2551 ReturnValueSlot ReturnValue,
2552 bool HasQualifier,
2553 NestedNameSpecifier *Qualifier,
2554 bool IsArrow, const Expr *Base);
2555 // Compute the object pointer.
Anders Carlssonbfb36712009-12-24 21:13:40 +00002556 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2557 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002558
Anders Carlsson4034a952009-05-27 04:18:27 +00002559 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002560 const CXXMethodDecl *MD,
2561 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002562
Peter Collingbournefe883422011-10-06 18:29:37 +00002563 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2564 ReturnValueSlot ReturnValue);
2565
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002566
Mike Stump11289f42009-09-09 15:08:12 +00002567 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002568 unsigned BuiltinID, const CallExpr *E,
2569 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002570
Anders Carlssonbfb36712009-12-24 21:13:40 +00002571 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002572
Mike Stumpfc496822009-02-08 23:14:22 +00002573 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2574 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002575 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2576
Kevin Qin1718af62013-11-14 02:45:18 +00002577 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2578 const llvm::CmpInst::Predicate Fp,
2579 const llvm::CmpInst::Predicate Ip,
2580 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002581 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002582
2583 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2584 unsigned LLVMIntrinsic,
2585 unsigned AltLLVMIntrinsic,
2586 const char *NameHint,
2587 unsigned Modifier,
2588 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002589 SmallVectorImpl<llvm::Value *> &Ops,
Craig Topper8a13c412014-05-21 05:09:00 +00002590 llvm::Value *Align = nullptr);
Tim Northover8fe03d62014-02-21 11:57:24 +00002591 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2592 unsigned Modifier, llvm::Type *ArgTy,
2593 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002594 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002595 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002596 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002597 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002598 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002599 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002600 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002601 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2602 llvm::Type *Ty, bool usgn, const char *name);
Tim Northover573cbee2014-05-24 12:52:07 +00002603 // Helper functions for EmitAArch64BuiltinExpr.
Tim Northovera2ee4332014-03-29 15:09:45 +00002604 llvm::Value *vectorWrapScalar8(llvm::Value *Op);
2605 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00002606 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002607
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002608 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002609 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2610 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00002611 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00002612 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00002613 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002614
Daniel Dunbar66912a12008-08-20 00:28:19 +00002615 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002616 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002617 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002618 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2619 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2620 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002621 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002622 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002623 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2624 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002625
John McCall31168b02011-06-15 23:02:42 +00002626 /// Retrieves the default cleanup kind for an ARC cleanup.
2627 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2628 CleanupKind getARCCleanupKind() {
2629 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2630 ? NormalAndEHCleanup : NormalCleanup;
2631 }
2632
2633 // ARC primitives.
2634 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2635 void EmitARCDestroyWeak(llvm::Value *addr);
2636 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2637 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2638 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2639 bool ignored);
2640 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2641 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2642 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2643 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002644 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002645 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002646 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002647 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002648 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2649 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002650 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCallcdda29c2013-03-13 03:10:54 +00002651 void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise);
2652 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCall31168b02011-06-15 23:02:42 +00002653 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2654 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2655 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2656 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2657
2658 std::pair<LValue,llvm::Value*>
2659 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2660 std::pair<LValue,llvm::Value*>
2661 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2662
John McCall248512a2011-10-01 10:32:24 +00002663 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2664
John McCall31168b02011-06-15 23:02:42 +00002665 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2666 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2667 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2668
John McCallff613032011-10-04 06:23:45 +00002669 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002670 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2671 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2672
Craig Topper00bbdcf2014-06-28 23:22:23 +00002673 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002674
John McCall82fe67b2011-07-09 01:37:26 +00002675 static Destroyer destroyARCStrongImprecise;
2676 static Destroyer destroyARCStrongPrecise;
2677 static Destroyer destroyARCWeak;
2678
John McCall31168b02011-06-15 23:02:42 +00002679 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2680 llvm::Value *EmitObjCAutoreleasePoolPush();
2681 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2682 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2683 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2684
Richard Smitha1c9d4d2013-06-12 23:38:09 +00002685 /// \brief Emits a reference binding to the passed in expression.
2686 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002687
Chris Lattner6278e6a2007-08-11 00:04:45 +00002688 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002689 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002690 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002691
2692 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002693
2694 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2695 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002696 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002697
Chris Lattner3474c202007-08-26 06:48:56 +00002698 /// EmitScalarConversion - Emit a conversion from the specified type to the
2699 /// specified destination type, both of which are LLVM scalar types.
2700 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2701 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002702
Chris Lattner42e6b812007-08-26 16:34:22 +00002703 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stumpfc496822009-02-08 23:14:22 +00002704 /// complex type to the specified destination type, where the destination type
2705 /// is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002706 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2707 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002708
2709
John McCall7a626f62010-09-15 10:14:12 +00002710 /// EmitAggExpr - Emit the computation of the specified expression
2711 /// of aggregate type. The result is computed into the given slot,
2712 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002713 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002714
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002715 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2716 /// aggregate type into a temporary LValue.
2717 LValue EmitAggExprToLValue(const Expr *E);
2718
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002719 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2720 /// pointers.
2721 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian879d7262009-08-31 19:33:16 +00002722 QualType Ty);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002723
John McCall1bd25562011-06-24 23:21:27 +00002724 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2725 /// make sure it survives garbage collection until this point.
2726 void EmitExtendGCLifetime(llvm::Value *object);
2727
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002728 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002729 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002730 ComplexPairTy EmitComplexExpr(const Expr *E,
2731 bool IgnoreReal = false,
2732 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002733
John McCall47fb9502013-03-07 21:37:08 +00002734 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2735 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002736 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002737
John McCall47fb9502013-03-07 21:37:08 +00002738 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002739 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00002740
2741 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002742 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002743
Chandler Carruth84537952012-03-30 19:44:53 +00002744 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2745 /// global variable that has already been created for it. If the initializer
2746 /// has a different type than GV does, this may free GV and return a different
2747 /// one. Otherwise it just returns GV.
2748 llvm::GlobalVariable *
2749 AddInitializerToStaticVarDecl(const VarDecl &D,
2750 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002751
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002752
Anders Carlssonf40886a2009-08-08 21:45:14 +00002753 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2754 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002755 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2756 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002757
David Majnemerb3341ea2014-10-05 05:05:40 +00002758 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
2759 llvm::Constant *Addr);
2760
John McCallc84ed6a2012-05-01 06:13:13 +00002761 /// Call atexit() with a function that passes the given argument to
2762 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00002763 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2764 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002765
John McCallcdf7ef52010-11-06 09:44:32 +00002766 /// Emit code in this function to perform a guarded variable
2767 /// initialization. Guarded initializations are used when it's not
2768 /// possible to prove that an initialization will be done exactly
2769 /// once, e.g. with a static local variable or a static data member
2770 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002771 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002772 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002773
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002774 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2775 /// variables.
2776 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00002777 ArrayRef<llvm::Function *> CXXThreadLocals,
Craig Topper8a13c412014-05-21 05:09:00 +00002778 llvm::GlobalVariable *Guard = nullptr);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002779
John McCallee08c532012-04-06 18:21:03 +00002780 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002781 /// variables.
John McCallee08c532012-04-06 18:21:03 +00002782 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2783 const std::vector<std::pair<llvm::WeakVH,
2784 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002785
John McCalla738c252011-03-09 04:27:21 +00002786 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2787 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00002788 llvm::GlobalVariable *Addr,
2789 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002790
John McCall7a626f62010-09-15 10:14:12 +00002791 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002792
2793 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian50198092010-12-02 17:02:11 +00002794 const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00002795
John McCall08ef4662011-11-10 08:15:53 +00002796 void enterFullExpression(const ExprWithCleanups *E) {
2797 if (E->getNumObjects() == 0) return;
2798 enterNonTrivialFullExpression(E);
2799 }
2800 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00002801
Richard Smithea852322013-05-07 21:53:22 +00002802 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00002803
Eli Friedmanc370a7e2012-02-09 03:32:31 +00002804 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2805
Craig Topper8a13c412014-05-21 05:09:00 +00002806 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = nullptr);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00002807
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002808 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002809 // Annotations Emission
2810 //===--------------------------------------------------------------------===//
2811
2812 /// Emit an annotation call (intrinsic or builtin).
2813 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2814 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002815 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002816 SourceLocation Location);
2817
2818 /// Emit local annotations for the local variable V, declared by D.
2819 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2820
2821 /// Emit field annotations for the given field & value. Returns the
2822 /// annotation result.
2823 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2824
2825 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002826 // Internal Helpers
2827 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002828
Chris Lattner5b1964b2008-11-11 07:41:27 +00002829 /// ContainsLabel - Return true if the statement contains a label in it. If
2830 /// this statement is not executed normally, it not containing a label means
2831 /// that we can just remove the code.
2832 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002833
Chris Lattner29911cc2011-02-28 00:18:40 +00002834 /// containsBreak - Return true if the statement contains a break out of it.
2835 /// If the statement (recursively) contains a switch or loop with a break
2836 /// inside of it, this is fine.
2837 static bool containsBreak(const Stmt *S);
2838
Daniel Dunbar682712c2008-11-12 10:12:14 +00002839 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00002840 /// to a constant, or if it does but contains a label, return false. If it
2841 /// constant folds return true and set the boolean result in Result.
2842 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00002843
Chris Lattner29911cc2011-02-28 00:18:40 +00002844 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2845 /// to a constant, or if it does but contains a label, return false. If it
2846 /// constant folds return true and set the folded value.
Richard Trieuc320c742012-07-23 20:21:35 +00002847 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattner29911cc2011-02-28 00:18:40 +00002848
Chris Lattnercd439292008-11-12 08:04:58 +00002849 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2850 /// if statement) to the specified blocks. Based on the condition, this might
2851 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00002852 /// TrueCount should be the number of times we expect the condition to
2853 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00002854 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00002855 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00002856
Richard Smithe30752c2012-10-09 19:52:38 +00002857 /// \brief Emit a description of a type in a format suitable for passing to
2858 /// a runtime sanitizer handler.
2859 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2860
2861 /// \brief Convert a value into a format suitable for passing to a runtime
2862 /// sanitizer handler.
2863 llvm::Value *EmitCheckValue(llvm::Value *V);
2864
2865 /// \brief Emit a description of a source location in a format suitable for
2866 /// passing to a runtime sanitizer handler.
2867 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2868
Richard Smithde670682012-11-01 22:15:34 +00002869 /// \brief Create a basic block that will call a handler function in a
2870 /// sanitizer runtime with the provided arguments, and create a conditional
2871 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00002872 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00002873 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
2874 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002875
Richard Smithde670682012-11-01 22:15:34 +00002876 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2877 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00002878 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00002879
Akira Hatanaka85365cd2015-07-02 22:15:41 +00002880 /// \brief Emit a call to trap or debugtrap and attach function attribute
2881 /// "trap-func-name" if specified.
2882 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
2883
Nuno Lopes1ba2d782015-05-30 16:11:40 +00002884 /// \brief Create a check for a function parameter that may potentially be
2885 /// declared as non-null.
2886 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
2887 const FunctionDecl *FD, unsigned ParmNum);
2888
Anders Carlsson093bdff2010-03-30 03:27:09 +00002889 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00002890 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00002891
John McCall23f66262010-05-26 22:34:26 +00002892 /// EmitDelegateCallArg - We are performing a delegate call; that
2893 /// is, the current function is delegating to another one. Produce
2894 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002895 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
2896 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00002897
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002898 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2899 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00002900 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002901
Chris Lattnercd439292008-11-12 08:04:58 +00002902private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00002903 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002904 void EmitReturnOfRValue(RValue RV, QualType Ty);
2905
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002906 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
2907
2908 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
2909 DeferredReplacements;
2910
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002911 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2912 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2913 ///
2914 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002915 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
2916 SmallVectorImpl<llvm::Argument *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002917
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002918 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
2919 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
2920 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
2921 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
2922 SmallVectorImpl<llvm::Value *> &IRCallArgs,
2923 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00002924
Chad Rosier59df25b2012-08-23 20:00:18 +00002925 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00002926 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00002927
Chad Rosier59df25b2012-08-23 20:00:18 +00002928 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00002929 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002930 std::string &ConstraintStr,
2931 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00002932
Reid Kleckner89077a12013-12-17 19:46:40 +00002933public:
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002934 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00002935 template <typename T>
2936 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002937 CallExpr::const_arg_iterator ArgBeg,
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002938 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002939 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00002940 unsigned ParamsToSkip = 0) {
Reid Kleckner739756c2013-12-04 19:23:12 +00002941 SmallVector<QualType, 16> ArgTypes;
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002942 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002943
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002944 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
2945 "Can't skip parameters if type info is not provided");
2946 if (CallArgTypeInfo) {
2947 // First, use the argument types that the type info knows about
2948 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
2949 E = CallArgTypeInfo->param_type_end();
2950 I != E; ++I, ++Arg) {
2951 assert(Arg != ArgEnd && "Running over edge of argument list!");
Alexey Bataev7cb17892014-12-18 06:54:53 +00002952 assert(
2953 ((*I)->isVariablyModifiedType() ||
2954 getContext()
2955 .getCanonicalType((*I).getNonReferenceType())
2956 .getTypePtr() ==
2957 getContext().getCanonicalType(Arg->getType()).getTypePtr()) &&
2958 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002959 ArgTypes.push_back(*I);
2960 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00002961 }
Mike Stump11289f42009-09-09 15:08:12 +00002962
Reid Kleckner739756c2013-12-04 19:23:12 +00002963 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002964 // function.
2965 assert(
2966 (Arg == ArgEnd || !CallArgTypeInfo || CallArgTypeInfo->isVariadic()) &&
2967 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00002968
Anders Carlsson603d6af2009-04-18 20:20:22 +00002969 // If we still have any arguments, emit them using the type of the argument.
Reid Kleckner739756c2013-12-04 19:23:12 +00002970 for (; Arg != ArgEnd; ++Arg)
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002971 ArgTypes.push_back(getVarArgType(*Arg));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002972
David Blaikie835afb22015-01-21 23:08:17 +00002973 EmitCallArgs(Args, ArgTypes, ArgBeg, ArgEnd, CalleeDecl, ParamsToSkip);
Anders Carlsson603d6af2009-04-18 20:20:22 +00002974 }
John McCalld4f4b7f2010-03-03 04:15:11 +00002975
Reid Kleckner739756c2013-12-04 19:23:12 +00002976 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
2977 CallExpr::const_arg_iterator ArgBeg,
Richard Smith760520b2014-06-03 23:27:44 +00002978 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002979 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00002980 unsigned ParamsToSkip = 0);
Reid Kleckner739756c2013-12-04 19:23:12 +00002981
Reid Kleckner89077a12013-12-17 19:46:40 +00002982private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002983 QualType getVarArgType(const Expr *Arg);
2984
John McCalld4f4b7f2010-03-03 04:15:11 +00002985 const TargetCodeGenInfo &getTargetHooks() const {
2986 return CGM.getTargetCodeGenInfo();
2987 }
John McCall09ae0322010-07-06 23:57:41 +00002988
2989 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00002990
2991 CodeGenModule::ByrefHelpers *
Chris Lattner2192fe52011-07-18 04:24:23 +00002992 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf9b056b2011-03-31 08:03:29 +00002993 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00002994
2995 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00002996
Eli Friedmana5dd5682012-08-23 03:10:17 +00002997 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2998 /// value and compute our best estimate of the alignment of the pointee.
2999 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003000
3001 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003002};
Mike Stump11289f42009-09-09 15:08:12 +00003003
John McCallce1de612011-01-26 04:00:11 +00003004/// Helper class with most of the code for saving a value for a
3005/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003006struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003007 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3008
3009 /// Answer whether the given value needs extra work to be saved.
3010 static bool needsSaving(llvm::Value *value) {
3011 // If it's not an instruction, we don't need to save.
3012 if (!isa<llvm::Instruction>(value)) return false;
3013
3014 // If it's an instruction in the entry block, we don't need to save.
3015 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3016 return (block != &block->getParent()->getEntryBlock());
3017 }
3018
3019 /// Try to save the given value.
3020 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3021 if (!needsSaving(value)) return saved_type(value, false);
3022
3023 // Otherwise we need an alloca.
3024 llvm::Value *alloca =
3025 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
3026 CGF.Builder.CreateStore(value, alloca);
3027
3028 return saved_type(alloca, true);
3029 }
3030
3031 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
3032 if (!value.getInt()) return value.getPointer();
3033 return CGF.Builder.CreateLoad(value.getPointer());
3034 }
3035};
3036
John McCallcb5f77f2011-01-28 10:53:53 +00003037/// A partial specialization of DominatingValue for llvm::Values that
3038/// might be llvm::Instructions.
3039template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3040 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003041 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003042 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3043 }
3044};
3045
3046/// A specialization of DominatingValue for RValue.
3047template <> struct DominatingValue<RValue> {
3048 typedef RValue type;
3049 class saved_type {
3050 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3051 AggregateAddress, ComplexAddress };
3052
3053 llvm::Value *Value;
3054 Kind K;
3055 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
3056
3057 public:
3058 static bool needsSaving(RValue value);
3059 static saved_type save(CodeGenFunction &CGF, RValue value);
3060 RValue restore(CodeGenFunction &CGF);
3061
3062 // implementations in CGExprCXX.cpp
3063 };
3064
3065 static bool needsSaving(type value) {
3066 return saved_type::needsSaving(value);
3067 }
3068 static saved_type save(CodeGenFunction &CGF, type value) {
3069 return saved_type::save(CGF, value);
3070 }
3071 static type restore(CodeGenFunction &CGF, saved_type value) {
3072 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003073 }
3074};
3075
Chris Lattnerbed31442007-05-28 01:07:47 +00003076} // end namespace CodeGen
3077} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003078
Chris Lattnerbed31442007-05-28 01:07:47 +00003079#endif