blob: 4352f6e2b537fa3b26a42ce0947d31b6bbcef4c5 [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"
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +000027#include "clang/AST/ExprOpenMP.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000028#include "clang/AST/Type.h"
29#include "clang/Basic/ABI.h"
Ben Langmuir3b4c30b2013-05-09 19:17:11 +000030#include "clang/Basic/CapturedStmt.h"
Alexander Musmandf7a8e22015-01-22 08:49:35 +000031#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000032#include "clang/Basic/TargetInfo.h"
33#include "clang/Frontend/CodeGenOptions.h"
34#include "llvm/ADT/ArrayRef.h"
35#include "llvm/ADT/DenseMap.h"
36#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000037#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000038#include "llvm/Support/Debug.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000039#include "llvm/Transforms/Utils/SanitizerStats.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000040
Chris Lattnerbed31442007-05-28 01:07:47 +000041namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000042class BasicBlock;
43class LLVMContext;
44class MDNode;
45class Module;
46class SwitchInst;
47class Twine;
48class Value;
49class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000050}
51
Chris Lattnerbed31442007-05-28 01:07:47 +000052namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000053class ASTContext;
54class BlockDecl;
55class CXXDestructorDecl;
56class CXXForRangeStmt;
57class CXXTryStmt;
58class Decl;
59class LabelDecl;
60class EnumConstantDecl;
61class FunctionDecl;
62class FunctionProtoType;
63class LabelStmt;
64class ObjCContainerDecl;
65class ObjCInterfaceDecl;
66class ObjCIvarDecl;
67class ObjCMethodDecl;
68class ObjCImplementationDecl;
69class ObjCPropertyImplDecl;
70class TargetInfo;
71class TargetCodeGenInfo;
72class VarDecl;
73class ObjCForCollectionStmt;
74class ObjCAtTryStmt;
75class ObjCAtThrowStmt;
76class ObjCAtSynchronizedStmt;
77class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000078
Chris Lattnerbed31442007-05-28 01:07:47 +000079namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000080class CodeGenTypes;
81class CGFunctionInfo;
82class CGRecordLayout;
83class CGBlockInfo;
84class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000085class BlockByrefHelpers;
86class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000087class BlockFlags;
88class BlockFieldFlags;
Mike Stumpfc496822009-02-08 23:14:22 +000089
John McCall47fb9502013-03-07 21:37:08 +000090/// The kind of evaluation to perform on values of a particular
91/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
92/// CGExprAgg?
93///
94/// TODO: should vectors maybe be split out into their own thing?
95enum TypeEvaluationKind {
96 TEK_Scalar,
97 TEK_Complex,
98 TEK_Aggregate
99};
100
Chris Lattnerbed31442007-05-28 01:07:47 +0000101/// CodeGenFunction - This class organizes the per-function state that is used
102/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000103class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000104 CodeGenFunction(const CodeGenFunction &) = delete;
105 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000106
107 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000108public:
John McCallad5d61e2010-07-23 21:56:41 +0000109 /// A jump destination is an abstract label, branching to which may
110 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000111 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000112 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000113 JumpDest(llvm::BasicBlock *Block,
114 EHScopeStack::stable_iterator Depth,
115 unsigned Index)
116 : Block(Block), ScopeDepth(Depth), Index(Index) {}
117
Craig Topper8a13c412014-05-21 05:09:00 +0000118 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000119 llvm::BasicBlock *getBlock() const { return Block; }
120 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
121 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000122
Nadav Rotem1da30942013-03-23 06:43:35 +0000123 // This should be used cautiously.
124 void setScopeDepth(EHScopeStack::stable_iterator depth) {
125 ScopeDepth = depth;
126 }
127
John McCallad5d61e2010-07-23 21:56:41 +0000128 private:
John McCallbd309292010-07-06 01:34:17 +0000129 llvm::BasicBlock *Block;
130 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000131 unsigned Index;
132 };
133
Chris Lattnerbed31442007-05-28 01:07:47 +0000134 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000135 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000136
Chris Lattner96d72562007-08-21 16:57:55 +0000137 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000138 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000139 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000140
Alexander Musman515ad8c2014-05-22 08:54:05 +0000141 /// \brief CGBuilder insert helper. This function is called after an
142 /// instruction is created using Builder.
143 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
144 llvm::BasicBlock *BB,
145 llvm::BasicBlock::iterator InsertPt) const;
146
John McCalldec348f72013-05-03 07:33:41 +0000147 /// CurFuncDecl - Holds the Decl for the current outermost
148 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000149 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000150 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
151 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000152 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000153 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000154 llvm::Function *CurFn;
155
Mike Stumpbee78dd2009-12-04 23:26:17 +0000156 /// CurGD - The GlobalDecl for the current function being compiled.
157 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000158
John McCall31168b02011-06-15 23:02:42 +0000159 /// PrologueCleanupDepth - The cleanup depth enclosing all the
160 /// cleanups associated with the parameters.
161 EHScopeStack::stable_iterator PrologueCleanupDepth;
162
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000163 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000164 JumpDest ReturnBlock;
165
John McCall7f416cc2015-09-08 08:05:57 +0000166 /// ReturnValue - The temporary alloca to hold the return
167 /// value. This is invalid iff the function has no return value.
168 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000169
Chris Lattner03df1222007-06-02 04:53:11 +0000170 /// AllocaInsertPoint - This is an instruction in the entry block before which
171 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000172 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000173
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000174 /// \brief API for captured statement code generation.
175 class CGCapturedStmtInfo {
176 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000177 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
178 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000179 explicit CGCapturedStmtInfo(const CapturedStmt &S,
180 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000181 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000182
183 RecordDecl::field_iterator Field =
184 S.getCapturedRecordDecl()->field_begin();
185 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
186 E = S.capture_end();
187 I != E; ++I, ++Field) {
188 if (I->capturesThis())
189 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000190 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000191 CaptureFields[I->getCapturedVar()] = *Field;
192 }
193 }
194
195 virtual ~CGCapturedStmtInfo();
196
197 CapturedRegionKind getKind() const { return Kind; }
198
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000199 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000200 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000201 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000202
203 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000204 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000205 return CaptureFields.lookup(VD);
206 }
207
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000208 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
209 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000210
Alexey Bataev18095712014-10-10 12:19:54 +0000211 static bool classof(const CGCapturedStmtInfo *) {
212 return true;
213 }
214
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000215 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000216 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000217 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000218 CGF.EmitStmt(S);
219 }
220
221 /// \brief Get the name of the capture helper.
222 virtual StringRef getHelperName() const { return "__captured_stmt"; }
223
224 private:
225 /// \brief The kind of captured statement being generated.
226 CapturedRegionKind Kind;
227
228 /// \brief Keep the map between VarDecl and FieldDecl.
229 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
230
231 /// \brief The base address of the captured record, passed in as the first
232 /// argument of the parallel region function.
233 llvm::Value *ThisValue;
234
235 /// \brief Captured 'this' type.
236 FieldDecl *CXXThisFieldDecl;
237 };
238 CGCapturedStmtInfo *CapturedStmtInfo;
239
Alexey Bataevd157d472015-06-24 03:35:38 +0000240 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
241 class CGCapturedStmtRAII {
242 private:
243 CodeGenFunction &CGF;
244 CGCapturedStmtInfo *PrevCapturedStmtInfo;
245 public:
246 CGCapturedStmtRAII(CodeGenFunction &CGF,
247 CGCapturedStmtInfo *NewCapturedStmtInfo)
248 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
249 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
250 }
251 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
252 };
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
David Majnemer4e52d6f2015-12-12 05:39:21 +0000297 llvm::Instruction *CurrentFuncletPad = nullptr;
298
Richard Smith736a9472013-06-12 20:42:33 +0000299 /// Header for data within LifetimeExtendedCleanupStack.
300 struct LifetimeExtendedCleanupHeader {
301 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000302 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000303 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000304 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000305
Justin Bognerbdff2192015-07-01 00:59:27 +0000306 size_t getSize() const { return Size; }
307 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000308 };
John McCallbd309292010-07-06 01:34:17 +0000309
John McCallad5d61e2010-07-23 21:56:41 +0000310 /// i32s containing the indexes of the cleanup destinations.
311 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000312
313 unsigned NextCleanupDestIndex;
314
John McCall08ef4662011-11-10 08:15:53 +0000315 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
316 CGBlockInfo *FirstBlockInfo;
317
John McCall8e4c74b2011-08-11 02:22:43 +0000318 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
319 llvm::BasicBlock *EHResumeBlock;
320
Bill Wendlingf0724e82011-09-19 20:31:14 +0000321 /// The exception slot. All landing pads write the current exception pointer
322 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000323 llvm::Value *ExceptionSlot;
324
Bill Wendlingf0724e82011-09-19 20:31:14 +0000325 /// The selector slot. Under the MandatoryCleanup model, all landing pads
326 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000327 llvm::AllocaInst *EHSelectorSlot;
328
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000329 /// A stack of exception code slots. Entering an __except block pushes a slot
330 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
331 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000332 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000333
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000334 /// Value returned by __exception_info intrinsic.
335 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000336
John McCallbd309292010-07-06 01:34:17 +0000337 /// Emits a landing pad for the current EH stack.
338 llvm::BasicBlock *EmitLandingPad();
339
340 llvm::BasicBlock *getInvokeDestImpl();
341
John McCallce1de612011-01-26 04:00:11 +0000342 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000343 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
344 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000345 }
346
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000347public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000348 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
349 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000350 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000351
John McCall6b0feb72011-06-22 02:32:12 +0000352 /// A class controlling the emission of a finally block.
353 class FinallyInfo {
354 /// Where the catchall's edge through the cleanup should go.
355 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000356
John McCall6b0feb72011-06-22 02:32:12 +0000357 /// A function to call to enter the catch.
358 llvm::Constant *BeginCatchFn;
359
360 /// An i1 variable indicating whether or not the @finally is
361 /// running for an exception.
362 llvm::AllocaInst *ForEHVar;
363
364 /// An i8* variable into which the exception pointer to rethrow
365 /// has been saved.
366 llvm::AllocaInst *SavedExnVar;
367
368 public:
369 void enter(CodeGenFunction &CGF, const Stmt *Finally,
370 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
371 llvm::Constant *rethrowFn);
372 void exit(CodeGenFunction &CGF);
373 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000374
Reid Kleckner11c033e2015-02-12 23:40:45 +0000375 /// Returns true inside SEH __try blocks.
376 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
377
Reid Klecknera002bd52015-10-28 23:06:42 +0000378 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000379 bool isCleanupPadScope() const {
380 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
381 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000382
John McCallce1de612011-01-26 04:00:11 +0000383 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
384 /// current full-expression. Safe against the possibility that
385 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000386 template <class T, class... As>
387 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000388 // If we're not in a conditional branch, or if none of the
389 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000390 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000391 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000392
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000393 // Stash values in a tuple so we can guarantee the order of saves.
394 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
395 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000396
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000397 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000398 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000399 initFullExprCleanup();
400 }
401
Richard Smith736a9472013-06-12 20:42:33 +0000402 /// \brief Queue a cleanup to be pushed after finishing the current
403 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000404 template <class T, class... As>
405 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000406 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
407
408 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
409
410 size_t OldSize = LifetimeExtendedCleanupStack.size();
411 LifetimeExtendedCleanupStack.resize(
412 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
413
Justin Bognerbdff2192015-07-01 00:59:27 +0000414 static_assert(sizeof(Header) % llvm::AlignOf<T>::Alignment == 0,
415 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000416 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
417 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000418 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000419 }
420
John McCallf4beacd2011-11-10 10:43:54 +0000421 /// Set up the last cleaup that was pushed as a conditional
422 /// full-expression cleanup.
423 void initFullExprCleanup();
424
John McCallbd309292010-07-06 01:34:17 +0000425 /// PushDestructorCleanup - Push a cleanup to call the
426 /// complete-object destructor of an object of the given type at the
427 /// given address. Does nothing if T is not a C++ class type with a
428 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000429 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000430
John McCall8680f872010-07-21 06:29:51 +0000431 /// PushDestructorCleanup - Push a cleanup to call the
432 /// complete-object variant of the given destructor on the object at
433 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000434 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000435
John McCallbd309292010-07-06 01:34:17 +0000436 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
437 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000438 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000439
John McCall824c2f52010-09-14 07:57:04 +0000440 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
441 /// The block cannot be reactivated. Pops it if it's the top of the
442 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000443 ///
444 /// \param DominatingIP - An instruction which is known to
445 /// dominate the current IP (if set) and which lies along
446 /// all paths of execution between the current IP and the
447 /// the point at which the cleanup comes into scope.
448 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
449 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000450
451 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
452 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000453 ///
454 /// \param DominatingIP - An instruction which is known to
455 /// dominate the current IP (if set) and which lies along
456 /// all paths of execution between the current IP and the
457 /// the point at which the cleanup comes into scope.
458 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
459 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000460
John McCallbd309292010-07-06 01:34:17 +0000461 /// \brief Enters a new scope for capturing cleanups, all of which
462 /// will be executed once the scope is exited.
463 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000464 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000465 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000466 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000467 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000468 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000469 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000470
Aaron Ballmanabc18922015-02-15 22:54:08 +0000471 RunCleanupsScope(const RunCleanupsScope &) = delete;
472 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000473
Eric Christophera9d34972011-10-19 00:43:52 +0000474 protected:
475 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000476
Douglas Gregor965f4502009-11-24 16:43:22 +0000477 public:
478 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000479 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000480 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000481 {
John McCallbd309292010-07-06 01:34:17 +0000482 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000483 LifetimeExtendedCleanupStackSize =
484 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000485 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000486 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000487 }
488
489 /// \brief Exit this cleanup scope, emitting any accumulated
490 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000491 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000492 if (PerformCleanup) {
493 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000494 CGF.PopCleanupBlocks(CleanupStackDepth,
495 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000496 }
497 }
498
499 /// \brief Determine whether this scope requires any cleanups.
500 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000501 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000502 }
503
504 /// \brief Force the emission of cleanups now, instead of waiting
505 /// until this object is destroyed.
506 void ForceCleanup() {
507 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000508 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000509 CGF.PopCleanupBlocks(CleanupStackDepth,
510 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000511 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000512 }
513 };
514
David Blaikie93be0b22014-08-22 21:37:04 +0000515 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000516 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000517 SmallVector<const LabelDecl*, 4> Labels;
518 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000519
Aaron Ballmanabc18922015-02-15 22:54:08 +0000520 LexicalScope(const LexicalScope &) = delete;
521 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000522
523 public:
524 /// \brief Enter a new cleanup scope.
525 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000526 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
527 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000528 if (CGDebugInfo *DI = CGF.getDebugInfo())
529 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
530 }
531
Nadav Rotem1da30942013-03-23 06:43:35 +0000532 void addLabel(const LabelDecl *label) {
533 assert(PerformCleanup && "adding label to dead scope?");
534 Labels.push_back(label);
535 }
536
Eric Christophera9d34972011-10-19 00:43:52 +0000537 /// \brief Exit this cleanup scope, emitting any accumulated
538 /// cleanups.
539 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000540 if (CGDebugInfo *DI = CGF.getDebugInfo())
541 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
542
Nadav Rotem1da30942013-03-23 06:43:35 +0000543 // If we should perform a cleanup, force them now. Note that
544 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000545 if (PerformCleanup) {
546 ApplyDebugLocation DL(CGF, Range.getEnd());
547 ForceCleanup();
548 }
Eric Christophera9d34972011-10-19 00:43:52 +0000549 }
550
551 /// \brief Force the emission of cleanups now, instead of waiting
552 /// until this object is destroyed.
553 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000554 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000555 RunCleanupsScope::ForceCleanup();
556
Nadav Rotem1da30942013-03-23 06:43:35 +0000557 if (!Labels.empty())
558 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000559 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000560
561 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000562 };
563
John McCall7f416cc2015-09-08 08:05:57 +0000564 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
565
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000566 /// \brief The scope used to remap some variables as private in the OpenMP
567 /// loop body (or other captured region emitted without outlining), and to
568 /// restore old vars back on exit.
569 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000570 DeclMapTy SavedLocals;
571 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000572
573 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000574 OMPPrivateScope(const OMPPrivateScope &) = delete;
575 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000576
577 public:
578 /// \brief Enter a new OpenMP private scope.
579 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
580
581 /// \brief Registers \a LocalVD variable as a private and apply \a
582 /// PrivateGen function for it to generate corresponding private variable.
583 /// \a PrivateGen returns an address of the generated private variable.
584 /// \return true if the variable is registered as private, false if it has
585 /// been privatized already.
586 bool
587 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000588 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000589 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000590
591 // Only save it once.
592 if (SavedLocals.count(LocalVD)) return false;
593
594 // Copy the existing local entry to SavedLocals.
595 auto it = CGF.LocalDeclMap.find(LocalVD);
596 if (it != CGF.LocalDeclMap.end()) {
597 SavedLocals.insert({LocalVD, it->second});
598 } else {
599 SavedLocals.insert({LocalVD, Address::invalid()});
600 }
601
602 // Generate the private entry.
603 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000604 QualType VarTy = LocalVD->getType();
605 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000606 Address Temp = CGF.CreateMemTemp(VarTy);
607 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
608 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000609 }
John McCall7f416cc2015-09-08 08:05:57 +0000610 SavedPrivates.insert({LocalVD, Addr});
611
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000612 return true;
613 }
614
615 /// \brief Privatizes local variables previously registered as private.
616 /// Registration is separate from the actual privatization to allow
617 /// initializers use values of the original variables, not the private one.
618 /// This is important, for example, if the private variable is a class
619 /// variable initialized by a constructor that references other private
620 /// variables. But at initialization original variables must be used, not
621 /// private copies.
622 /// \return true if at least one variable was privatized, false otherwise.
623 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000624 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000625 SavedPrivates.clear();
626 return !SavedLocals.empty();
627 }
628
629 void ForceCleanup() {
630 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000631 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000632 SavedLocals.clear();
633 }
634
635 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000636 ~OMPPrivateScope() {
637 if (PerformCleanup)
638 ForceCleanup();
639 }
John McCall7f416cc2015-09-08 08:05:57 +0000640
641 private:
642 /// Copy all the entries in the source map over the corresponding
643 /// entries in the destination, which must exist.
644 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
645 for (auto &pair : src) {
646 if (!pair.second.isValid()) {
647 dest.erase(pair.first);
648 continue;
649 }
650
651 auto it = dest.find(pair.first);
652 if (it != dest.end()) {
653 it->second = pair.second;
654 } else {
655 dest.insert(pair);
656 }
657 }
658 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000659 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000660
Richard Smith736a9472013-06-12 20:42:33 +0000661 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
662 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000663 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000664
Richard Smith736a9472013-06-12 20:42:33 +0000665 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
666 /// that have been added, then adds all lifetime-extended cleanups from
667 /// the given position to the stack.
668 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
669 size_t OldLifetimeExtendedStackSize);
670
John McCallad5d61e2010-07-23 21:56:41 +0000671 void ResolveBranchFixups(llvm::BasicBlock *Target);
672
John McCallbd309292010-07-06 01:34:17 +0000673 /// The given basic block lies in the current EH scope, but may be a
674 /// target of a potentially scope-crossing jump; get a stable handle
675 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000676 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000677 return JumpDest(Target,
678 EHStack.getInnermostNormalCleanup(),
679 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000680 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000681
John McCallbd309292010-07-06 01:34:17 +0000682 /// The given basic block lies in the current EH scope, but may be a
683 /// target of a potentially scope-crossing jump; get a stable handle
684 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000685 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000686 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000687 }
688
689 /// EmitBranchThroughCleanup - Emit a branch from the current insert
690 /// block through the normal cleanup handling code (if any) and then
691 /// on to \arg Dest.
692 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000693
Justin Bognere25ffdf2014-01-21 00:35:11 +0000694 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
695 /// specified destination obviously has no cleanups to run. 'false' is always
696 /// a conservatively correct answer for this method.
697 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
698
John McCall8e4c74b2011-08-11 02:22:43 +0000699 /// popCatchScope - Pops the catch scope at the top of the EHScope
700 /// stack, emitting any required code (other than the catch handlers
701 /// themselves).
702 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000703
David Chisnall9a837be2012-11-07 16:50:40 +0000704 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000705 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000706 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000707
John McCallce1de612011-01-26 04:00:11 +0000708 /// An object to manage conditionally-evaluated expressions.
709 class ConditionalEvaluation {
710 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000711
John McCallce1de612011-01-26 04:00:11 +0000712 public:
713 ConditionalEvaluation(CodeGenFunction &CGF)
714 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000715
John McCallce1de612011-01-26 04:00:11 +0000716 void begin(CodeGenFunction &CGF) {
717 assert(CGF.OutermostConditional != this);
718 if (!CGF.OutermostConditional)
719 CGF.OutermostConditional = this;
720 }
721
722 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000723 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000724 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000725 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000726 }
727
728 /// Returns a block which will be executed prior to each
729 /// evaluation of the conditional code.
730 llvm::BasicBlock *getStartingBlock() const {
731 return StartBB;
732 }
733 };
Mike Stump11289f42009-09-09 15:08:12 +0000734
John McCall7f9c92a2010-09-17 00:50:28 +0000735 /// isInConditionalBranch - Return true if we're currently emitting
736 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000737 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000738
John McCall7f416cc2015-09-08 08:05:57 +0000739 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000740 assert(isInConditionalBranch());
741 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000742 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
743 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000744 }
745
John McCallce1de612011-01-26 04:00:11 +0000746 /// An RAII object to record that we're evaluating a statement
747 /// expression.
748 class StmtExprEvaluation {
749 CodeGenFunction &CGF;
750
751 /// We have to save the outermost conditional: cleanups in a
752 /// statement expression aren't conditional just because the
753 /// StmtExpr is.
754 ConditionalEvaluation *SavedOutermostConditional;
755
756 public:
757 StmtExprEvaluation(CodeGenFunction &CGF)
758 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000759 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000760 }
761
762 ~StmtExprEvaluation() {
763 CGF.OutermostConditional = SavedOutermostConditional;
764 CGF.EnsureInsertPoint();
765 }
766 };
John McCall1bf58462011-02-16 08:02:54 +0000767
John McCallc07a0c72011-02-17 10:25:35 +0000768 /// An object which temporarily prevents a value from being
769 /// destroyed by aggressive peephole optimizations that assume that
770 /// all uses of a value have been realized in the IR.
771 class PeepholeProtection {
772 llvm::Instruction *Inst;
773 friend class CodeGenFunction;
774
775 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000776 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000777 };
John McCallc07a0c72011-02-17 10:25:35 +0000778
John McCallfe96e0b2011-11-06 09:01:30 +0000779 /// A non-RAII class containing all the information about a bound
780 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
781 /// this which makes individual mappings very simple; using this
782 /// class directly is useful when you have a variable number of
783 /// opaque values or don't want the RAII functionality for some
784 /// reason.
785 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000786 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000787 bool BoundLValue;
788 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000789
John McCallfe96e0b2011-11-06 09:01:30 +0000790 OpaqueValueMappingData(const OpaqueValueExpr *ov,
791 bool boundLValue)
792 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000793 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000794 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000795
John McCallc07a0c72011-02-17 10:25:35 +0000796 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000797 // gl-values should be bound as l-values for obvious reasons.
798 // Records should be bound as l-values because IR generation
799 // always keeps them in memory. Expressions of function type
800 // act exactly like l-values but are formally required to be
801 // r-values in C.
802 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000803 expr->getType()->isFunctionType() ||
804 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000805 }
806
John McCallfe96e0b2011-11-06 09:01:30 +0000807 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
808 const OpaqueValueExpr *ov,
809 const Expr *e) {
810 if (shouldBindAsLValue(ov))
811 return bind(CGF, ov, CGF.EmitLValue(e));
812 return bind(CGF, ov, CGF.EmitAnyExpr(e));
813 }
814
815 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
816 const OpaqueValueExpr *ov,
817 const LValue &lv) {
818 assert(shouldBindAsLValue(ov));
819 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
820 return OpaqueValueMappingData(ov, true);
821 }
822
823 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
824 const OpaqueValueExpr *ov,
825 const RValue &rv) {
826 assert(!shouldBindAsLValue(ov));
827 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
828
829 OpaqueValueMappingData data(ov, false);
830
831 // Work around an extremely aggressive peephole optimization in
832 // EmitScalarConversion which assumes that all other uses of a
833 // value are extant.
834 data.Protection = CGF.protectFromPeepholes(rv);
835
836 return data;
837 }
838
Craig Topper8a13c412014-05-21 05:09:00 +0000839 bool isValid() const { return OpaqueValue != nullptr; }
840 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000841
842 void unbind(CodeGenFunction &CGF) {
843 assert(OpaqueValue && "no data to unbind!");
844
845 if (BoundLValue) {
846 CGF.OpaqueLValues.erase(OpaqueValue);
847 } else {
848 CGF.OpaqueRValues.erase(OpaqueValue);
849 CGF.unprotectFromPeepholes(Protection);
850 }
851 }
852 };
853
854 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
855 class OpaqueValueMapping {
856 CodeGenFunction &CGF;
857 OpaqueValueMappingData Data;
858
859 public:
860 static bool shouldBindAsLValue(const Expr *expr) {
861 return OpaqueValueMappingData::shouldBindAsLValue(expr);
862 }
863
John McCallc07a0c72011-02-17 10:25:35 +0000864 /// Build the opaque value mapping for the given conditional
865 /// operator if it's the GNU ?: extension. This is a common
866 /// enough pattern that the convenience operator is really
867 /// helpful.
868 ///
869 OpaqueValueMapping(CodeGenFunction &CGF,
870 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000871 if (isa<ConditionalOperator>(op))
872 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000873 return;
John McCallc07a0c72011-02-17 10:25:35 +0000874
875 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000876 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
877 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000878 }
879
John McCall1bf58462011-02-16 08:02:54 +0000880 OpaqueValueMapping(CodeGenFunction &CGF,
881 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000882 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000883 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000884 }
885
886 OpaqueValueMapping(CodeGenFunction &CGF,
887 const OpaqueValueExpr *opaqueValue,
888 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000889 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000890 }
891
892 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000893 Data.unbind(CGF);
894 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000895 }
896
897 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000898 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000899 }
900 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000901
Chris Lattner2da04b32007-08-24 05:35:26 +0000902private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000903 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000904 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000905
John McCall9b382dd2011-05-28 21:13:02 +0000906 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
907 /// calling llvm.stacksave for multiple VLAs in the same scope.
908 bool DidCallStackSave;
909
Mike Stumpe5311b02009-11-30 20:08:49 +0000910 /// IndirectBranch - The first time an indirect goto is seen we create a block
911 /// with an indirect branch. Every time we see the address of a label taken,
912 /// we add the label to the indirect goto. Every subsequent indirect goto is
913 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000914 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000915
Mike Stumpfc496822009-02-08 23:14:22 +0000916 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
917 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000918 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000919
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000920 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
921 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
922 /// parameter.
923 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
924 SizeArguments;
925
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000926 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000927 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000928 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
929
Chris Lattnerac248202007-05-30 00:13:02 +0000930 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000931 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000932
Mike Stumpfc496822009-02-08 23:14:22 +0000933 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000934 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000935 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000936 BreakContinue(JumpDest Break, JumpDest Continue)
937 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000938
John McCallbd309292010-07-06 01:34:17 +0000939 JumpDest BreakBlock;
940 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000941 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000942 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000943
Justin Bogneref512b92014-01-06 22:27:43 +0000944 CodeGenPGO PGO;
945
Justin Bogner65512642015-05-02 05:00:55 +0000946 /// Calculate branch weights appropriate for PGO data
947 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
948 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
949 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
950 uint64_t LoopCount);
951
Justin Bogneref512b92014-01-06 22:27:43 +0000952public:
Justin Bogner66242d62015-04-23 23:06:47 +0000953 /// Increment the profiler's counter for the given statement.
954 void incrementProfileCounter(const Stmt *S) {
955 if (CGM.getCodeGenOpts().ProfileInstrGenerate)
956 PGO.emitCounterIncrement(Builder, S);
957 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +0000958 }
Justin Bogner66242d62015-04-23 23:06:47 +0000959
960 /// Get the profiler's count for the given statement.
961 uint64_t getProfileCount(const Stmt *S) {
962 Optional<uint64_t> Count = PGO.getStmtCount(S);
963 if (!Count.hasValue())
964 return 0;
965 return *Count;
966 }
967
968 /// Set the profiler's current count.
969 void setCurrentProfileCount(uint64_t Count) {
970 PGO.setCurrentRegionCount(Count);
971 }
972
973 /// Get the profiler's current count. This is generally the count for the most
974 /// recently incremented counter.
975 uint64_t getCurrentProfileCount() {
976 return PGO.getCurrentRegionCount();
977 }
978
Justin Bogneref512b92014-01-06 22:27:43 +0000979private:
980
Zhongxing Xu82846ea2012-01-14 09:08:15 +0000981 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +0000982 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000983 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +0000984 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
985 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +0000986
Mike Stumpfc496822009-02-08 23:14:22 +0000987 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000988 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000989 llvm::BasicBlock *CaseRangeBlock;
990
John McCallc07a0c72011-02-17 10:25:35 +0000991 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +0000992 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +0000993 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
994 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +0000995
Mike Stumpfc496822009-02-08 23:14:22 +0000996 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +0000997 // We track this by the size expression rather than the type itself because
998 // in certain situations, like a const qualifier applied to an VLA typedef,
999 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001000 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1001 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001002 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001003
John McCallbd309292010-07-06 01:34:17 +00001004 /// A block containing a single 'unreachable' instruction. Created
1005 /// lazily by getUnreachableBlock().
1006 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001007
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001008 /// Counts of the number return expressions in the function.
1009 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001010
1011 /// Count the number of simple (constant) return expressions in the function.
1012 unsigned NumSimpleReturnExprs;
1013
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001014 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001015 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001016
Richard Smith852c9db2013-04-20 22:23:05 +00001017public:
1018 /// A scope within which we are constructing the fields of an object which
1019 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1020 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1021 class FieldConstructionScope {
1022 public:
John McCall7f416cc2015-09-08 08:05:57 +00001023 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001024 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1025 CGF.CXXDefaultInitExprThis = This;
1026 }
1027 ~FieldConstructionScope() {
1028 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1029 }
1030
1031 private:
1032 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001033 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001034 };
1035
1036 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1037 /// is overridden to be the object under construction.
1038 class CXXDefaultInitExprScope {
1039 public:
1040 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001041 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1042 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1043 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1044 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001045 }
1046 ~CXXDefaultInitExprScope() {
1047 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001048 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001049 }
1050
1051 public:
1052 CodeGenFunction &CGF;
1053 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001054 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001055 };
1056
1057private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001058 /// CXXThisDecl - When generating code for a C++ member function,
1059 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001060 ImplicitParamDecl *CXXABIThisDecl;
1061 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001062 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001063 CharUnits CXXABIThisAlignment;
1064 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001065
Richard Smith852c9db2013-04-20 22:23:05 +00001066 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1067 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001068 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001069
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001070 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1071 /// destructor, this will hold the implicit argument (e.g. VTT).
1072 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1073 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001074
John McCallce1de612011-01-26 04:00:11 +00001075 /// OutermostConditional - Points to the outermost active
1076 /// conditional control. This is used so that we know if a
1077 /// temporary should be destroyed conditionally.
1078 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001079
Nadav Rotem1da30942013-03-23 06:43:35 +00001080 /// The current lexical scope.
1081 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001082
Adrian Prantldc237b52013-05-16 00:41:26 +00001083 /// The current source location that should be used for exception
1084 /// handling code.
1085 SourceLocation CurEHLocation;
1086
John McCall7f416cc2015-09-08 08:05:57 +00001087 /// BlockByrefInfos - For each __block variable, contains
1088 /// information about the layout of the variable.
1089 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001090
John McCallbd309292010-07-06 01:34:17 +00001091 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001092 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001093 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001094
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001095 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1096 /// In the kernel metadata node, reference the kernel function and metadata
1097 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001098 /// - A node for the vec_type_hint(<type>) qualifier contains string
1099 /// "vec_type_hint", an undefined value of the <type> data type,
1100 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001101 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1102 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1103 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1104 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1105 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1106 llvm::Function *Fn);
1107
Chris Lattnerbed31442007-05-28 01:07:47 +00001108public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001109 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001110 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001111
John McCall8ed55a52010-09-02 09:58:18 +00001112 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001113 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001114 CGDebugInfo *getDebugInfo() {
1115 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001116 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001117 return DebugInfo;
1118 }
1119 void disableDebugInfo() { DisableDebugInfo = true; }
1120 void enableDebugInfo() { DisableDebugInfo = false; }
1121
John McCall31168b02011-06-15 23:02:42 +00001122 bool shouldUseFusedARCCalls() {
1123 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1124 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001125
David Blaikiebbafb8a2012-03-11 07:00:24 +00001126 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001127
Bill Wendlingf0724e82011-09-19 20:31:14 +00001128 /// Returns a pointer to the function's exception object and selector slot,
1129 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001130 Address getExceptionSlot();
1131 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001132
Bill Wendling79a70e42011-09-15 18:57:19 +00001133 /// Returns the contents of the function's exception object and selector
1134 /// slots.
1135 llvm::Value *getExceptionFromSlot();
1136 llvm::Value *getSelectorFromSlot();
1137
John McCall7f416cc2015-09-08 08:05:57 +00001138 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001139
John McCallbd309292010-07-06 01:34:17 +00001140 llvm::BasicBlock *getUnreachableBlock() {
1141 if (!UnreachableBlock) {
1142 UnreachableBlock = createBasicBlock("unreachable");
1143 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1144 }
1145 return UnreachableBlock;
1146 }
1147
1148 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001149 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001150 return getInvokeDestImpl();
1151 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001152
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001153 bool currentFunctionUsesSEHTry() const {
1154 const auto *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl);
1155 return FD && FD->usesSEHTry();
1156 }
1157
John McCallc8e01702013-04-16 22:48:15 +00001158 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001159 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001160
Daniel Dunbar12347492009-02-23 17:26:39 +00001161 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001162 // Cleanups
1163 //===--------------------------------------------------------------------===//
1164
John McCall7f416cc2015-09-08 08:05:57 +00001165 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001166
John McCall178360e2011-07-11 08:38:19 +00001167 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001168 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001169 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001170 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001171 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001172 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1173 llvm::Value *arrayEnd,
1174 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001175 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001176 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001177
John McCall4bd0fb12011-07-12 16:41:08 +00001178 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001179 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001180 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001181 Address addr, QualType type);
1182 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001183 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001184 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001185 QualType type, Destroyer *destroyer,
1186 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001187 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1188 llvm::Value *CompletePtr,
1189 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001190 void pushStackRestore(CleanupKind kind, Address SPMem);
1191 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001192 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001193 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001194 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001195 bool useEHCleanupForArray,
1196 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001197 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001198 QualType elementType, CharUnits elementAlign,
1199 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001200 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001201
Peter Collingbourne1425b452012-01-26 03:33:36 +00001202 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001203
John McCall82fe67b2011-07-09 01:37:26 +00001204 /// Determines whether an EH cleanup is required to destroy a type
1205 /// with the given destruction kind.
1206 bool needsEHCleanup(QualType::DestructionKind kind) {
1207 switch (kind) {
1208 case QualType::DK_none:
1209 return false;
1210 case QualType::DK_cxx_destructor:
1211 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001212 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001213 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001214 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001215 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1216 }
1217 llvm_unreachable("bad destruction kind");
1218 }
1219
John McCall4bd0fb12011-07-12 16:41:08 +00001220 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1221 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1222 }
1223
John McCall82fe67b2011-07-09 01:37:26 +00001224 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001225 // Objective-C
1226 //===--------------------------------------------------------------------===//
1227
Chris Lattner4bd55962008-03-30 23:03:07 +00001228 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001229
David Blaikief1425802015-01-14 00:04:42 +00001230 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001231
Mike Stumpfc496822009-02-08 23:14:22 +00001232 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001233 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1234 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001235 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001236 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001237 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001238 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001239
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001240 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1241 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001242
Mike Stumpfc496822009-02-08 23:14:22 +00001243 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1244 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001245 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1246 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001247 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001248 const ObjCPropertyImplDecl *propImpl,
1249 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001250
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001251 //===--------------------------------------------------------------------===//
1252 // Block Bits
1253 //===--------------------------------------------------------------------===//
1254
John McCall351762c2011-02-07 10:33:21 +00001255 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001256 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1257 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001258
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001259 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001260 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001261 const DeclMapTy &ldm,
1262 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001263
John McCallad7c5c12011-02-08 08:22:06 +00001264 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1265 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001266 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1267 const ObjCPropertyImplDecl *PID);
1268 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1269 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001270 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001271
John McCallad7c5c12011-02-08 08:22:06 +00001272 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1273
John McCall73064872011-03-31 01:59:53 +00001274 class AutoVarEmission;
1275
1276 void emitByrefStructureInit(const AutoVarEmission &emission);
1277 void enterByrefCleanup(const AutoVarEmission &emission);
1278
John McCall7f416cc2015-09-08 08:05:57 +00001279 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1280 llvm::Value *ptr);
1281
1282 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001283 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1284
1285 /// BuildBlockByrefAddress - Computes the location of the
1286 /// data in a variable which is declared as __block.
1287 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1288 bool followForward = true);
1289 Address emitBlockByrefAddress(Address baseAddr,
1290 const BlockByrefInfo &info,
1291 bool followForward,
1292 const llvm::Twine &name);
1293
1294 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001295
John McCalla738c252011-03-09 04:27:21 +00001296 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1297 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001298 /// \brief Emit code for the start of a function.
1299 /// \param Loc The location to be associated with the function.
1300 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001301 void StartFunction(GlobalDecl GD,
1302 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001303 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001304 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001305 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001306 SourceLocation Loc = SourceLocation(),
1307 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001308
John McCallb81884d2010-02-19 09:25:03 +00001309 void EmitConstructorBody(FunctionArgList &Args);
1310 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001311 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001312 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001313 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001314
Faisal Vali571df122013-09-29 08:45:24 +00001315 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001316 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001317 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001318 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001319 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1320 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001321 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001322
David Blaikiea0a1a872015-01-18 02:48:07 +00001323 /// \brief Emit the unified return block, trying to avoid its emission when
1324 /// possible.
1325 /// \return The debug location of the user written return statement if the
1326 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001327 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001328
Mike Stumpfc496822009-02-08 23:14:22 +00001329 /// FinishFunction - Complete IR generation of the current function. It is
1330 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001331 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001332
Nico Weber1bebad12015-02-11 22:33:32 +00001333 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1334 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001335
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001336 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001337
John McCall7f416cc2015-09-08 08:05:57 +00001338 void FinishThunk();
1339
Reid Klecknerab2090d2014-07-26 01:34:32 +00001340 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1341 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1342 llvm::Value *Callee);
1343
Rafael Espindolad6e66942015-07-13 06:07:58 +00001344 /// Generate a thunk for the given method.
1345 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001346 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001347
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001348 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1349 const CGFunctionInfo &FnInfo,
1350 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001351
Douglas Gregor94f9a482010-05-05 05:51:00 +00001352 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1353 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001354
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001355 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001356 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001357
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001358 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1359 struct VPtr {
1360 BaseSubobject Base;
1361 const CXXRecordDecl *NearestVBase;
1362 CharUnits OffsetFromNearestVBase;
1363 const CXXRecordDecl *VTableClass;
1364 };
1365
1366 /// Initialize the vtable pointer of the given subobject.
1367 void InitializeVTablePointer(const VPtr &vptr);
1368
1369 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001370
1371 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001372 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1373
1374 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1375 CharUnits OffsetFromNearestVBase,
1376 bool BaseIsNonVirtualPrimaryBase,
1377 const CXXRecordDecl *VTableClass,
1378 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001379
Anders Carlssond5895932010-03-28 21:07:49 +00001380 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001381
Dan Gohman8fc50c22010-10-26 18:44:08 +00001382 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1383 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001384 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1385 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001386
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001387 enum CFITypeCheckKind {
1388 CFITCK_VCall,
1389 CFITCK_NVCall,
1390 CFITCK_DerivedCast,
1391 CFITCK_UnrelatedCast,
1392 };
1393
Peter Collingbourned2926c92015-03-14 02:42:25 +00001394 /// \brief Derived is the presumed address of an object of type T after a
1395 /// cast. If T is a polymorphic class type, emit a check that the virtual
1396 /// table for Derived belongs to a class derived from T.
1397 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001398 bool MayBeNull, CFITypeCheckKind TCK,
1399 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001400
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001401 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1402 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001403 void EmitVTablePtrCheckForCall(const CXXMethodDecl *MD, llvm::Value *VTable,
1404 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001405
Peter Collingbourned2926c92015-03-14 02:42:25 +00001406 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
1407 /// RD using llvm.bitset.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001408 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1409 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001410
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001411 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1412 /// expr can be devirtualized.
1413 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1414 const CXXMethodDecl *MD);
1415
John McCallf99a6312010-07-21 05:30:47 +00001416 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1417 /// given phase of destruction for a destructor. The end result
1418 /// should call destructors on members and base classes in reverse
1419 /// order of their construction.
1420 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001421
Chris Lattner3c77a352010-06-22 00:03:40 +00001422 /// ShouldInstrumentFunction - Return true if the current function should be
1423 /// instrumented with __cyg_profile_func_* calls
1424 bool ShouldInstrumentFunction();
1425
1426 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1427 /// instrumentation function with the current function and the call site, if
1428 /// function instrumentation is enabled.
1429 void EmitFunctionInstrumentation(const char *Fn);
1430
Roman Divacky178e01602011-02-10 16:52:03 +00001431 /// EmitMCountInstrumentation - Emit call to .mcount.
1432 void EmitMCountInstrumentation();
1433
Mike Stumpfc496822009-02-08 23:14:22 +00001434 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1435 /// arguments for the given function. This is also responsible for naming the
1436 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001437 void EmitFunctionProlog(const CGFunctionInfo &FI,
1438 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001439 const FunctionArgList &Args);
1440
Mike Stumpfc496822009-02-08 23:14:22 +00001441 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1442 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001443 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1444 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001445
Mike Stump1d849212009-12-07 23:38:24 +00001446 /// EmitStartEHSpec - Emit the start of the exception spec.
1447 void EmitStartEHSpec(const Decl *D);
1448
1449 /// EmitEndEHSpec - Emit the end of the exception spec.
1450 void EmitEndEHSpec(const Decl *D);
1451
John McCallbd309292010-07-06 01:34:17 +00001452 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1453 llvm::BasicBlock *getTerminateLandingPad();
1454
1455 /// getTerminateHandler - Return a handler (not a landing pad, just
1456 /// a catch handler) that just calls terminate. This is used when
1457 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001458 llvm::BasicBlock *getTerminateHandler();
1459
Chris Lattnera5f58b02011-07-09 17:41:47 +00001460 llvm::Type *ConvertTypeForMem(QualType T);
1461 llvm::Type *ConvertType(QualType T);
1462 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001463 return ConvertType(getContext().getTypeDeclType(T));
1464 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001465
Mike Stumpfc496822009-02-08 23:14:22 +00001466 /// LoadObjCSelf - Load the value of self. This function is only valid while
1467 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001468 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001469
1470 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001471 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001472
Chris Lattner54fb19e2007-06-22 22:02:34 +00001473 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1474 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001475 static TypeEvaluationKind getEvaluationKind(QualType T);
1476
1477 static bool hasScalarEvaluationKind(QualType T) {
1478 return getEvaluationKind(T) == TEK_Scalar;
1479 }
1480
1481 static bool hasAggregateEvaluationKind(QualType T) {
1482 return getEvaluationKind(T) == TEK_Aggregate;
1483 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001484
1485 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001486 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001487 llvm::Function *parent = nullptr,
1488 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001489#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001490 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001491#else
John McCallad7c5c12011-02-08 08:22:06 +00001492 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001493#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001494 }
Mike Stumpfc496822009-02-08 23:14:22 +00001495
Chris Lattnerac248202007-05-30 00:13:02 +00001496 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1497 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001498 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001499
Mike Stumpe5311b02009-11-30 20:08:49 +00001500 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1501 /// another basic block, simplify it. This assumes that no other code could
1502 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001503 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1504
Mike Stumpfc496822009-02-08 23:14:22 +00001505 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1506 /// adding a fall-through branch from the current insert block if
1507 /// necessary. It is legal to call this function even if there is no current
1508 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001509 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001510 /// IsFinished - If true, indicates that the caller has finished emitting
1511 /// branches to the given block and does not expect to emit code into it. This
1512 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001513 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001514
John McCall8e4c74b2011-08-11 02:22:43 +00001515 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1516 /// near its uses, and leave the insertion point in it.
1517 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1518
Mike Stumpfc496822009-02-08 23:14:22 +00001519 /// EmitBranch - Emit a branch to the specified basic block from the current
1520 /// insert block, taking care to avoid creation of branches from dummy
1521 /// blocks. It is legal to call this function even if there is no current
1522 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001523 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001524 /// This function clears the current insertion point. The caller should follow
1525 /// calls to this function with calls to Emit*Block prior to generation new
1526 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001527 void EmitBranch(llvm::BasicBlock *Block);
1528
Mike Stumpfc496822009-02-08 23:14:22 +00001529 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1530 /// indicates that the current code being emitted is unreachable.
1531 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001532 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001533 }
1534
Mike Stumpfc496822009-02-08 23:14:22 +00001535 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1536 /// emitted IR has a place to go. Note that by definition, if this function
1537 /// creates a block then that block is unreachable; callers may do better to
1538 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001539 void EnsureInsertPoint() {
1540 if (!HaveInsertPoint())
1541 EmitBlock(createBasicBlock());
1542 }
Mike Stumpfc496822009-02-08 23:14:22 +00001543
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001544 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001545 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001546 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001547
Chris Lattnere9a64532007-06-22 21:44:33 +00001548 //===--------------------------------------------------------------------===//
1549 // Helpers
1550 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001551
John McCall7f416cc2015-09-08 08:05:57 +00001552 LValue MakeAddrLValue(Address Addr, QualType T,
1553 AlignmentSource AlignSource = AlignmentSource::Type) {
1554 return LValue::MakeAddr(Addr, T, getContext(), AlignSource,
Dan Gohman947c9af2010-10-14 23:06:10 +00001555 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001556 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001557
John McCall7f416cc2015-09-08 08:05:57 +00001558 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1559 AlignmentSource AlignSource = AlignmentSource::Type) {
1560 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1561 AlignSource, CGM.getTBAAInfo(T));
1562 }
1563
1564 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001565 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001566 CharUnits getNaturalTypeAlignment(QualType T,
1567 AlignmentSource *Source = nullptr,
1568 bool forPointeeType = false);
1569 CharUnits getNaturalPointeeTypeAlignment(QualType T,
1570 AlignmentSource *Source = nullptr);
1571
1572 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
1573 AlignmentSource *Source = nullptr);
1574 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001575
Chris Lattnere9a64532007-06-22 21:44:33 +00001576 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001577 /// block. The caller is responsible for setting an appropriate alignment on
1578 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001579 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001580 const Twine &Name = "tmp");
John McCall7f416cc2015-09-08 08:05:57 +00001581 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
1582 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001583
John McCall7f416cc2015-09-08 08:05:57 +00001584 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1585 /// default ABI alignment of the given LLVM type.
1586 ///
1587 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1588 /// any given AST type that happens to have been lowered to the
1589 /// given IR type. This should only ever be used for function-local,
1590 /// IR-driven manipulations like saving and restoring a value. Do
1591 /// not hand this address off to arbitrary IRGen routines, and especially
1592 /// do not pass it as an argument to a function that might expect a
1593 /// properly ABI-aligned value.
1594 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1595 const Twine &Name = "tmp");
1596
1597 /// InitTempAlloca - Provide an initial value for the given alloca which
1598 /// will be observable at all locations in the function.
1599 ///
1600 /// The address should be something that was returned from one of
1601 /// the CreateTempAlloca or CreateMemTemp routines, and the
1602 /// initializer must be valid in the entry block (i.e. it must
1603 /// either be a constant or an argument value).
1604 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001605
Daniel Dunbard0049182010-02-16 19:44:13 +00001606 /// CreateIRTemp - Create a temporary IR object of the given type, with
1607 /// appropriate alignment. This routine should only be used when an temporary
1608 /// value needs to be stored into an alloca (for example, to avoid explicit
1609 /// PHI construction), but the type is the IR type, not the type appropriate
1610 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001611 ///
1612 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1613 /// ConvertType instead of ConvertTypeForMem.
1614 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001615
Daniel Dunbara7566f12010-02-09 02:48:28 +00001616 /// CreateMemTemp - Create a temporary memory object of the given type, with
1617 /// appropriate alignment.
John McCall7f416cc2015-09-08 08:05:57 +00001618 Address CreateMemTemp(QualType T, const Twine &Name = "tmp");
1619 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001620
John McCall7a626f62010-09-15 10:14:12 +00001621 /// CreateAggTemp - Create a temporary memory object for the given
1622 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001623 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00001624 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001625 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001626 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001627 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001628 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001629 }
1630
John McCallad7c5c12011-02-08 08:22:06 +00001631 /// Emit a cast to void* in the appropriate address space.
1632 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1633
Chris Lattner8394d792007-06-05 20:53:16 +00001634 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1635 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001636 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001637
John McCalla2342eb2010-12-05 02:00:02 +00001638 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1639 void EmitIgnoredExpr(const Expr *E);
1640
Chris Lattner4647a212007-08-31 22:49:20 +00001641 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1642 /// any type. The result is returned as an RValue struct. If this is an
1643 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1644 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001645 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001646 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001647 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001648 AggValueSlot aggSlot = AggValueSlot::ignored(),
1649 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001650
Mike Stumpfc496822009-02-08 23:14:22 +00001651 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1652 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00001653 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001654
Charles Davisc7d5c942015-09-17 20:55:33 +00001655 /// Emit a "reference" to a __builtin_ms_va_list; this is
1656 /// always the value of the expression, because a __builtin_ms_va_list is a
1657 /// pointer to a char.
1658 Address EmitMSVAListRef(const Expr *E);
1659
Mike Stumpfc496822009-02-08 23:14:22 +00001660 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1661 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001662 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001663
John McCall91ca10f2011-03-08 09:11:50 +00001664 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001665 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00001666 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001667 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001668
John McCall7f416cc2015-09-08 08:05:57 +00001669 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00001670
John McCall91ca10f2011-03-08 09:11:50 +00001671 /// EmitExprAsInit - Emits the code necessary to initialize a
1672 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001673 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001674 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001675
Fariborz Jahanian78652202013-01-25 23:57:05 +00001676 /// hasVolatileMember - returns true if aggregate type has a volatile
1677 /// member.
1678 bool hasVolatileMember(QualType T) {
1679 if (const RecordType *RT = T->getAs<RecordType>()) {
1680 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1681 return RD->hasVolatileMember();
1682 }
1683 return false;
1684 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001685 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001686 ///
1687 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1688 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00001689 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001690 QualType EltTy) {
1691 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00001692 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001693 }
1694
John McCall7f416cc2015-09-08 08:05:57 +00001695 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
1696 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00001697 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00001698 /*IsAssignment=*/false);
1699 }
1700
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001701 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001702 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001703 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001704 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001705 /// \param isAssignment - If false, allow padding to be copied. This often
1706 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00001707 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001708 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001709 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001710
Anders Carlsson9396a892008-09-11 09:15:33 +00001711 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00001712 Address GetAddrOfLocalVar(const VarDecl *VD) {
1713 auto it = LocalDeclMap.find(VD);
1714 assert(it != LocalDeclMap.end() &&
1715 "Invalid argument to GetAddrOfLocalVar(), no decl!");
1716 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00001717 }
Mike Stumpfc496822009-02-08 23:14:22 +00001718
John McCallc07a0c72011-02-17 10:25:35 +00001719 /// getOpaqueLValueMapping - Given an opaque value expression (which
1720 /// must be mapped to an l-value), return its mapping.
1721 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1722 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1723
1724 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1725 it = OpaqueLValues.find(e);
1726 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1727 return it->second;
1728 }
1729
1730 /// getOpaqueRValueMapping - Given an opaque value expression (which
1731 /// must be mapped to an r-value), return its mapping.
1732 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1733 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1734
1735 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1736 it = OpaqueRValues.find(e);
1737 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001738 return it->second;
1739 }
1740
Dan Gohman75d69da2008-05-22 00:50:06 +00001741 /// getAccessedFieldNo - Given an encoded value and a result number, return
1742 /// the input field number being accessed.
1743 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1744
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001745 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001746 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001747
Anders Carlssonc0964b62010-05-22 17:35:42 +00001748 /// EmitNullInitialization - Generate code to set a value of the given type to
1749 /// null, If the type contains data member pointers, they will be initialized
1750 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00001751 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001752
Charles Davisc7d5c942015-09-17 20:55:33 +00001753 /// Emits a call to an LLVM variable-argument intrinsic, either
1754 /// \c llvm.va_start or \c llvm.va_end.
1755 /// \param ArgValue A reference to the \c va_list as emitted by either
1756 /// \c EmitVAListRef or \c EmitMSVAListRef.
1757 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
1758 /// calls \c llvm.va_end.
1759 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
1760
1761 /// Generate code to get an argument from the passed in pointer
1762 /// and update it accordingly.
1763 /// \param VE The \c VAArgExpr for which to generate code.
1764 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
1765 /// either \c EmitVAListRef or \c EmitMSVAListRef.
1766 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001767 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001768 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00001769 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001770
John McCall82fe67b2011-07-09 01:37:26 +00001771 /// emitArrayLength - Compute the length of an array, even if it's a
1772 /// VLA, and drill down to the base element type.
1773 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1774 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001775 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00001776
John McCall23c29fe2011-06-24 21:55:10 +00001777 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1778 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001779 ///
1780 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001781 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001782
John McCall23c29fe2011-06-24 21:55:10 +00001783 /// getVLASize - Returns an LLVM value that corresponds to the size,
1784 /// in non-variably-sized elements, of a variable length array type,
1785 /// plus that largest non-variably-sized element type. Assumes that
1786 /// the type has already been emitted with EmitVariablyModifiedType.
1787 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1788 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001789
Anders Carlssona5d077d2009-04-14 16:58:56 +00001790 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1791 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001792 llvm::Value *LoadCXXThis() {
1793 assert(CXXThisValue && "no 'this' value for this function");
1794 return CXXThisValue;
1795 }
John McCall7f416cc2015-09-08 08:05:57 +00001796 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00001797
Anders Carlssone36a6b32010-01-02 01:01:18 +00001798 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1799 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001800 // FIXME: Every place that calls LoadCXXVTT is something
1801 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001802 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001803 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1804 return CXXStructorImplicitParamValue;
1805 }
1806
John McCall6ce74722010-02-16 04:15:37 +00001807 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001808 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00001809 Address
1810 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001811 const CXXRecordDecl *Derived,
1812 const CXXRecordDecl *Base,
1813 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001814
John McCall7f416cc2015-09-08 08:05:57 +00001815 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
1816
Mike Stumpe5311b02009-11-30 20:08:49 +00001817 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1818 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00001819 Address GetAddressOfBaseClass(Address Value,
1820 const CXXRecordDecl *Derived,
1821 CastExpr::path_const_iterator PathBegin,
1822 CastExpr::path_const_iterator PathEnd,
1823 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001824
John McCall7f416cc2015-09-08 08:05:57 +00001825 Address GetAddressOfDerivedClass(Address Value,
1826 const CXXRecordDecl *Derived,
1827 CastExpr::path_const_iterator PathBegin,
1828 CastExpr::path_const_iterator PathEnd,
1829 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00001830
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001831 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1832 /// base constructor/destructor with virtual bases.
1833 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1834 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1835 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1836 bool Delegating);
1837
John McCallf8ff7b92010-02-23 00:48:20 +00001838 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1839 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001840 const FunctionArgList &Args,
1841 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001842 // It's important not to confuse this and the previous function. Delegating
1843 // constructors are the C++0x feature. The constructor delegate optimization
1844 // is used to reduce duplication in the base and complete consturctors where
1845 // they are substantially the same.
1846 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1847 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001848
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001849 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001850 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001851 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001852
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001853 /// Emit assumption load for all bases. Requires to be be called only on
1854 /// most-derived class and not under construction of the object.
1855 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
1856
1857 /// Emit assumption that vptr load == global vtable.
1858 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
1859
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001860 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00001861 Address This, Address Src,
1862 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001863
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001864 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001865 const ConstantArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00001866 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001867 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001868 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001869
Anders Carlssond49844b2009-09-23 02:45:36 +00001870 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1871 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00001872 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001873 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001874 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001875
John McCall82fe67b2011-07-09 01:37:26 +00001876 static Destroyer destroyCXXObject;
1877
Anders Carlsson0a637412009-05-29 21:03:38 +00001878 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001879 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001880 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001881
John McCall99210dc2011-09-15 06:49:18 +00001882 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001883 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00001884 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00001885 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00001886
Peter Collingbourne702b2842011-11-27 22:09:22 +00001887 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00001888 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001889
David Majnemerdc012fa2015-04-22 21:38:15 +00001890 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
1891 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
1892
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001893 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001894 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001895
Eli Friedman24f55432009-11-18 00:57:03 +00001896 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1897 QualType DeleteTy);
1898
Richard Smith760520b2014-06-03 23:27:44 +00001899 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1900 const Expr *Arg, bool IsDelete);
1901
John McCall7f416cc2015-09-08 08:05:57 +00001902 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
1903 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
1904 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001905
Richard Smith69d0d262012-08-24 00:54:33 +00001906 /// \brief Situations in which we might emit a check for the suitability of a
1907 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001908 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001909 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001910 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001911 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001912 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001913 /// Checking the bound value in a reference binding. Must be suitably sized
1914 /// and aligned, but is not required to refer to an object (until the
1915 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001916 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001917 /// Checking the object expression in a non-static data member access. Must
1918 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001919 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001920 /// Checking the 'this' pointer for a call to a non-static member function.
1921 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001922 TCK_MemberCall,
1923 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001924 TCK_ConstructorCall,
1925 /// Checking the operand of a static_cast to a derived pointer type. Must be
1926 /// null or an object within its lifetime.
1927 TCK_DowncastPointer,
1928 /// Checking the operand of a static_cast to a derived reference type. Must
1929 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001930 TCK_DowncastReference,
1931 /// Checking the operand of a cast to a base object. Must be suitably sized
1932 /// and aligned.
1933 TCK_Upcast,
1934 /// Checking the operand of a cast to a virtual base object. Must be an
1935 /// object within its lifetime.
1936 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00001937 };
1938
Alexey Samsonovac4afe42014-07-07 23:59:57 +00001939 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
1940 /// calls to EmitTypeCheck can be skipped.
1941 bool sanitizePerformTypeCheck() const;
1942
Richard Smith4d1458e2012-09-08 02:08:36 +00001943 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001944 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001945 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001946 QualType Type, CharUnits Alignment = CharUnits::Zero(),
1947 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001948
Richard Smith539e4a72013-02-23 02:53:19 +00001949 /// \brief Emit a check that \p Base points into an array object, which
1950 /// we can access at index \p Index. \p Accessed should be \c false if we
1951 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1952 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1953 QualType IndexType, bool Accessed);
1954
Chris Lattner116ce8f2010-01-09 21:40:03 +00001955 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1956 bool isInc, bool isPre);
1957 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1958 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00001959
1960 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00001961 llvm::Value *OffsetValue = nullptr) {
1962 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
1963 OffsetValue);
1964 }
Hal Finkelbcc06082014-09-07 22:58:14 +00001965
Chris Lattner8394d792007-06-05 20:53:16 +00001966 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001967 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001968 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001969
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001970 /// EmitDecl - Emit a declaration.
1971 ///
1972 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001973 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001974
John McCall1c9c3fd2010-10-15 04:57:14 +00001975 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001976 ///
1977 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001978 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001979
David Blaikie73ca5692014-12-09 00:32:22 +00001980 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001981 bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00001982 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001983
John McCallbd309292010-07-06 01:34:17 +00001984 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1985 llvm::Value *Address);
1986
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001987 /// \brief Determine whether the given initializer is trivial in the sense
1988 /// that it requires no code to be generated.
1989 bool isTrivialInitializer(const Expr *Init);
1990
John McCall1c9c3fd2010-10-15 04:57:14 +00001991 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001992 ///
1993 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00001994 void EmitAutoVarDecl(const VarDecl &D);
1995
1996 class AutoVarEmission {
1997 friend class CodeGenFunction;
1998
John McCall9e2e22f2011-02-22 07:16:58 +00001999 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002000
John McCall7f416cc2015-09-08 08:05:57 +00002001 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002002 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002003 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002004
2005 llvm::Value *NRVOFlag;
2006
2007 /// True if the variable is a __block variable.
2008 bool IsByRef;
2009
2010 /// True if the variable is of aggregate type and has a constant
2011 /// initializer.
2012 bool IsConstantAggregate;
2013
Nadav Rotem1da30942013-03-23 06:43:35 +00002014 /// Non-null if we should use lifetime annotations.
2015 llvm::Value *SizeForLifetimeMarkers;
2016
John McCall9e2e22f2011-02-22 07:16:58 +00002017 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002018 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002019
John McCallc533cb72011-02-22 06:44:22 +00002020 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002021 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002022 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002023 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002024
John McCall7f416cc2015-09-08 08:05:57 +00002025 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002026
2027 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002028 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2029
Craig Topper8a13c412014-05-21 05:09:00 +00002030 bool useLifetimeMarkers() const {
2031 return SizeForLifetimeMarkers != nullptr;
2032 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002033 llvm::Value *getSizeForLifetimeMarkers() const {
2034 assert(useLifetimeMarkers());
2035 return SizeForLifetimeMarkers;
2036 }
2037
2038 /// Returns the raw, allocated address, which is not necessarily
2039 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002040 Address getAllocatedAddress() const {
2041 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002042 }
2043
John McCallc533cb72011-02-22 06:44:22 +00002044 /// Returns the address of the object within this declaration.
2045 /// Note that this does not chase the forwarding pointer for
2046 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002047 Address getObjectAddress(CodeGenFunction &CGF) const {
2048 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002049
John McCall7f416cc2015-09-08 08:05:57 +00002050 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002051 }
2052 };
2053 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2054 void EmitAutoVarInit(const AutoVarEmission &emission);
2055 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002056 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2057 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002058
John McCall1c9c3fd2010-10-15 04:57:14 +00002059 void EmitStaticVarDecl(const VarDecl &D,
2060 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002061
John McCall7f416cc2015-09-08 08:05:57 +00002062 class ParamValue {
2063 llvm::Value *Value;
2064 unsigned Alignment;
2065 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2066 public:
2067 static ParamValue forDirect(llvm::Value *value) {
2068 return ParamValue(value, 0);
2069 }
2070 static ParamValue forIndirect(Address addr) {
2071 assert(!addr.getAlignment().isZero());
2072 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2073 }
2074
2075 bool isIndirect() const { return Alignment != 0; }
2076 llvm::Value *getAnyValue() const { return Value; }
2077
2078 llvm::Value *getDirectValue() const {
2079 assert(!isIndirect());
2080 return Value;
2081 }
2082
2083 Address getIndirectAddress() const {
2084 assert(isIndirect());
2085 return Address(Value, CharUnits::fromQuantity(Alignment));
2086 }
2087 };
2088
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002089 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002090 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002091
John McCallc07a0c72011-02-17 10:25:35 +00002092 /// protectFromPeepholes - Protect a value that we're intending to
2093 /// store to the side, but which will probably be used later, from
2094 /// aggressive peepholing optimizations that might delete it.
2095 ///
2096 /// Pass the result to unprotectFromPeepholes to declare that
2097 /// protection is no longer required.
2098 ///
2099 /// There's no particular reason why this shouldn't apply to
2100 /// l-values, it's just that no existing peepholes work on pointers.
2101 PeepholeProtection protectFromPeepholes(RValue rvalue);
2102 void unprotectFromPeepholes(PeepholeProtection protection);
2103
Chris Lattner84915fa2007-06-02 04:16:21 +00002104 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002105 // Statement Emission
2106 //===--------------------------------------------------------------------===//
2107
Mike Stumpfc496822009-02-08 23:14:22 +00002108 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002109 void EmitStopPoint(const Stmt *S);
2110
Mike Stumpfc496822009-02-08 23:14:22 +00002111 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2112 /// this function even if there is no current insertion point.
2113 ///
2114 /// This function may clear the current insertion point; callers should use
2115 /// EnsureInsertPoint if they wish to subsequently generate code without first
2116 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002117 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002118
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002119 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002120 /// necessarily require an insertion point or debug information; typically
2121 /// because the statement amounts to a jump or a container of other
2122 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002123 ///
2124 /// \return True if the statement was handled.
2125 bool EmitSimpleStmt(const Stmt *S);
2126
John McCall7f416cc2015-09-08 08:05:57 +00002127 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2128 AggValueSlot AVS = AggValueSlot::ignored());
2129 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2130 bool GetLast = false,
2131 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002132 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002133
Mike Stumpfc496822009-02-08 23:14:22 +00002134 /// EmitLabel - Emit the block for the given label. It is legal to call this
2135 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002136 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002137
Chris Lattnerac248202007-05-30 00:13:02 +00002138 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002139 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002140 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002141 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002142 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002143
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002144 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002145 ArrayRef<const Attr *> Attrs = None);
2146 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002147 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002148 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002149 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002150 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002151 void EmitBreakStmt(const BreakStmt &S);
2152 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002153 void EmitSwitchStmt(const SwitchStmt &S);
2154 void EmitDefaultStmt(const DefaultStmt &S);
2155 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002156 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002157 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002158
Anders Carlsson2e744e82008-08-30 19:51:14 +00002159 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002160 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2161 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002162 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002163 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002164
John McCallb609d3f2010-07-07 06:56:46 +00002165 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2166 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002167
Anders Carlsson52d78a52009-09-27 18:58:34 +00002168 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002169 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002170 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002171 void EnterSEHTryStmt(const SEHTryStmt &S);
2172 void ExitSEHTryStmt(const SEHTryStmt &S);
2173
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002174 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002175 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002176
2177 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2178 const SEHExceptStmt &Except);
2179
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002180 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2181 const SEHFinallyStmt &Finally);
2182
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002183 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2184 llvm::Value *ParentFP,
2185 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002186 llvm::Value *EmitSEHExceptionCode();
2187 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002188 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002189
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002190 /// Scan the outlined statement for captures from the parent function. For
2191 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002192 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002193 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002194 bool IsFilter);
2195
2196 /// Recovers the address of a local in a parent function. ParentVar is the
2197 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002198 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002199 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2200 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002201 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2202 Address ParentVar,
2203 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002204
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002205 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002206 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002207
Alexey Bataev330de032014-10-29 12:21:55 +00002208 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002209 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002210 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002211 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002212 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002213 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002214 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002215 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2216 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002217 /// \brief Perform element by element copying of arrays with type \a
2218 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2219 /// generated by \a CopyGen.
2220 ///
2221 /// \param DestAddr Address of the destination array.
2222 /// \param SrcAddr Address of the source array.
2223 /// \param OriginalType Type of destination and source arrays.
2224 /// \param CopyGen Copying procedure that copies value of single array element
2225 /// to another single array element.
2226 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002227 Address DestAddr, Address SrcAddr, QualType OriginalType,
2228 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002229 /// \brief Emit proper copying of data from one variable to another.
2230 ///
2231 /// \param OriginalType Original type of the copied variables.
2232 /// \param DestAddr Destination address.
2233 /// \param SrcAddr Source address.
2234 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2235 /// type of the base array element).
2236 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2237 /// the base array element).
2238 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2239 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002240 void EmitOMPCopy(QualType OriginalType,
2241 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002242 const VarDecl *DestVD, const VarDecl *SrcVD,
2243 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002244 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2245 /// \a X = \a E \a BO \a E.
2246 ///
2247 /// \param X Value to be updated.
2248 /// \param E Update value.
2249 /// \param BO Binary operation for update operation.
2250 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2251 /// expression, false otherwise.
2252 /// \param AO Atomic ordering of the generated atomic instructions.
2253 /// \param CommonGen Code generator for complex expressions that cannot be
2254 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002255 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2256 /// generated, <false, RValue::get(nullptr)> otherwise.
2257 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002258 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2259 llvm::AtomicOrdering AO, SourceLocation Loc,
2260 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002261 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002262 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002263 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2264 OMPPrivateScope &PrivateScope);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002265 /// \brief Emit code for copyin clause in \a D directive. The next code is
2266 /// generated at the start of outlined functions for directives:
2267 /// \code
2268 /// threadprivate_var1 = master_threadprivate_var1;
2269 /// operator=(threadprivate_var2, master_threadprivate_var2);
2270 /// ...
2271 /// __kmpc_barrier(&loc, global_tid);
2272 /// \endcode
2273 ///
2274 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2275 /// \returns true if at least one copyin variable is found, false otherwise.
2276 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002277 /// \brief Emit initial code for lastprivate variables. If some variable is
2278 /// not also firstprivate, then the default initialization is used. Otherwise
2279 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2280 /// method.
2281 ///
2282 /// \param D Directive that may have 'lastprivate' directives.
2283 /// \param PrivateScope Private scope for capturing lastprivate variables for
2284 /// proper codegen in internal captured statement.
2285 ///
2286 /// \returns true if there is at least one lastprivate variable, false
2287 /// otherwise.
2288 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2289 OMPPrivateScope &PrivateScope);
2290 /// \brief Emit final copying of lastprivate values to original variables at
2291 /// the end of the worksharing or simd directive.
2292 ///
2293 /// \param D Directive that has at least one 'lastprivate' directives.
2294 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2295 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002296 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002297 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002298 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002299 /// \brief Emit initial code for reduction variables. Creates reduction copies
2300 /// and initializes them with the values according to OpenMP standard.
2301 ///
2302 /// \param D Directive (possibly) with the 'reduction' clause.
2303 /// \param PrivateScope Private scope for capturing reduction variables for
2304 /// proper codegen in internal captured statement.
2305 ///
2306 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2307 OMPPrivateScope &PrivateScope);
2308 /// \brief Emit final update of reduction values to original variables at
2309 /// the end of the directive.
2310 ///
2311 /// \param D Directive that has at least one 'reduction' directives.
2312 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002313 /// \brief Emit initial code for linear variables. Creates private copies
2314 /// and initializes them with the values according to OpenMP standard.
2315 ///
2316 /// \param D Directive (possibly) with the 'linear' clause.
2317 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002318
2319 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002320 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002321 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002322 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002323 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002324 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002325 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002326 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002327 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002328 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002329 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002330 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002331 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002332 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002333 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002334 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002335 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002336 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002337 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002338 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002339 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002340 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002341 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002342 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002343 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002344 void
2345 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002346 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002347 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002348 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002349 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002350
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002351 /// \brief Emit inner loop of the worksharing/simd construct.
2352 ///
2353 /// \param S Directive, for which the inner loop must be emitted.
2354 /// \param RequiresCleanup true, if directive has some associated private
2355 /// variables.
2356 /// \param LoopCond Bollean condition for loop continuation.
2357 /// \param IncExpr Increment expression for loop control variable.
2358 /// \param BodyGen Generator for the inner body of the inner loop.
2359 /// \param PostIncGen Genrator for post-increment code (required for ordered
2360 /// loop directvies).
2361 void EmitOMPInnerLoop(
2362 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2363 const Expr *IncExpr,
2364 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2365 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002366
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002367 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
2368
Alexander Musmanc6388682014-12-15 07:07:06 +00002369private:
2370
2371 /// Helpers for the OpenMP loop directives.
Alexey Bataev0f34da12015-07-02 04:17:07 +00002372 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002373 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataev58e5bdb2015-06-18 04:45:29 +00002374 void EmitOMPSimdFinal(const OMPLoopDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002375 /// \brief Emit code for the worksharing loop-based directive.
2376 /// \return true, if this construct has any lastprivate clause, false -
2377 /// otherwise.
2378 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Alexander Musmandf7a8e22015-01-22 08:49:35 +00002379 void EmitOMPForOuterLoop(OpenMPScheduleClauseKind ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002380 bool IsMonotonic, const OMPLoopDirective &S,
2381 OMPPrivateScope &LoopScope, bool Ordered, Address LB,
2382 Address UB, Address ST, Address IL,
2383 llvm::Value *Chunk);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002384 /// \brief Emit code for sections directive.
2385 OpenMPDirectiveKind EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002386
2387public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002388
Chris Lattner208ae962007-05-30 17:57:17 +00002389 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002390 // LValue Expression Emission
2391 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002392
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002393 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2394 RValue GetUndefRValue(QualType Ty);
2395
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002396 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2397 /// and issue an ErrorUnsupported style diagnostic (using the
2398 /// provided Name).
2399 RValue EmitUnsupportedRValue(const Expr *E,
2400 const char *Name);
2401
Mike Stumpfc496822009-02-08 23:14:22 +00002402 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2403 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002404 LValue EmitUnsupportedLValue(const Expr *E,
2405 const char *Name);
2406
Chris Lattner8394d792007-06-05 20:53:16 +00002407 /// EmitLValue - Emit code to compute a designator that specifies the location
2408 /// of the expression.
2409 ///
2410 /// This can return one of two things: a simple address or a bitfield
2411 /// reference. In either case, the LLVM Value* in the LValue structure is
2412 /// guaranteed to be an LLVM pointer type.
2413 ///
2414 /// If this returns a bitfield reference, nothing about the pointee type of
2415 /// the LLVM value is known: For example, it may not be a pointer to an
2416 /// integer.
2417 ///
2418 /// If this returns a normal address, and if the lvalue's C type is fixed
2419 /// size, this method guarantees that the returned pointer type will point to
2420 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2421 /// variable length type, this is not possible.
2422 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002423 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002424
Richard Smith4d1458e2012-09-08 02:08:36 +00002425 /// \brief Same as EmitLValue but additionally we generate checking code to
2426 /// guard against undefined behavior. This is only suitable when we know
2427 /// that the address will be used to access the object.
2428 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002429
John McCall7f416cc2015-09-08 08:05:57 +00002430 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002431 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002432
John McCalla8ec7eb2013-03-07 21:37:17 +00002433 void EmitAtomicInit(Expr *E, LValue lvalue);
2434
David Majnemera5b195a2015-02-14 01:35:12 +00002435 bool LValueIsSuitableForInlineAtomic(LValue Src);
2436 bool typeIsSuitableForInlineAtomic(QualType Ty, bool IsVolatile) const;
2437
2438 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2439 AggValueSlot Slot = AggValueSlot::ignored());
2440
Nick Lewycky2d84e842013-10-02 02:29:49 +00002441 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002442 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002443 AggValueSlot slot = AggValueSlot::ignored());
2444
2445 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2446
David Majnemera5b195a2015-02-14 01:35:12 +00002447 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2448 bool IsVolatile, bool isInit);
2449
Alexey Bataevb4505a72015-03-30 05:20:59 +00002450 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002451 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
2452 llvm::AtomicOrdering Success = llvm::SequentiallyConsistent,
2453 llvm::AtomicOrdering Failure = llvm::SequentiallyConsistent,
2454 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2455
Alexey Bataevb4505a72015-03-30 05:20:59 +00002456 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002457 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002458 bool IsVolatile);
2459
John McCall3a7f6922010-10-27 20:58:56 +00002460 /// EmitToMemory - Change a scalar value from its value
2461 /// representation to its in-memory representation.
2462 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2463
2464 /// EmitFromMemory - Change a scalar value from its memory
2465 /// representation to its value representation.
2466 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2467
Daniel Dunbar1d425462009-02-10 00:57:50 +00002468 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2469 /// care to appropriately convert from the memory representation to
2470 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002471 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002472 SourceLocation Loc,
John McCall7f416cc2015-09-08 08:05:57 +00002473 AlignmentSource AlignSource =
2474 AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002475 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002476 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002477 uint64_t TBAAOffset = 0,
2478 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002479
2480 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2481 /// care to appropriately convert from the memory representation to
2482 /// the LLVM value representation. The l-value must be a simple
2483 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002484 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002485
2486 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2487 /// care to appropriately convert from the memory representation to
2488 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002489 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
2490 bool Volatile, QualType Ty,
2491 AlignmentSource AlignSource = AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002492 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002493 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002494 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002495
2496 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2497 /// care to appropriately convert from the memory representation to
2498 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002499 /// l-value. The isInit flag indicates whether this is an initialization.
2500 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2501 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002502
Chris Lattner8394d792007-06-05 20:53:16 +00002503 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2504 /// this method emits the address of the lvalue, then loads the result as an
2505 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002506 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002507 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2508 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002509 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002510
Chris Lattner8394d792007-06-05 20:53:16 +00002511 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2512 /// lvalue, where both are guaranteed to the have the same type, and that type
2513 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002514 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002515 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002516 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002517
Nick Lewycky2d84e842013-10-02 02:29:49 +00002518 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2519 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002520 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002521 /// \param Result [out] - If non-null, this will be set to a Value* for the
2522 /// bit-field contents after the store, appropriate for use as the result of
2523 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002524 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002525 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002526
John McCall4f29b492010-11-16 23:07:28 +00002527 /// Emit an l-value for an assignment (simple or compound) of complex type.
2528 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002529 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002530 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2531 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002532
Chris Lattner57540c52011-04-15 05:22:18 +00002533 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002534 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002535 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002536 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002537 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002538 // Note: only available for agg return types
2539 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002540 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002541 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002542 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002543 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002544 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002545 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2546 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00002547 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
2548 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002549 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002550 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002551 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002552 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002553 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002554 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002555 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002556 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002557 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002558
John McCall7f416cc2015-09-08 08:05:57 +00002559 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002560
Nick Lewycky2d84e842013-10-02 02:29:49 +00002561 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002562
John McCall7f416cc2015-09-08 08:05:57 +00002563 Address EmitArrayToPointerDecay(const Expr *Array,
2564 AlignmentSource *AlignSource = nullptr);
2565
John McCall71335052012-03-10 03:05:10 +00002566 class ConstantEmission {
2567 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2568 ConstantEmission(llvm::Constant *C, bool isReference)
2569 : ValueAndIsReference(C, isReference) {}
2570 public:
2571 ConstantEmission() {}
2572 static ConstantEmission forReference(llvm::Constant *C) {
2573 return ConstantEmission(C, true);
2574 }
2575 static ConstantEmission forValue(llvm::Constant *C) {
2576 return ConstantEmission(C, false);
2577 }
2578
Aaron Ballman67347662015-02-15 22:00:28 +00002579 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002580 return ValueAndIsReference.getOpaqueValue() != nullptr;
2581 }
John McCall71335052012-03-10 03:05:10 +00002582
2583 bool isReference() const { return ValueAndIsReference.getInt(); }
2584 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2585 assert(isReference());
2586 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2587 refExpr->getType());
2588 }
2589
2590 llvm::Constant *getValue() const {
2591 assert(!isReference());
2592 return ValueAndIsReference.getPointer();
2593 }
2594 };
2595
John McCall113bee02012-03-10 09:33:50 +00002596 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002597
John McCallfe96e0b2011-11-06 09:01:30 +00002598 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2599 AggValueSlot slot = AggValueSlot::ignored());
2600 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2601
Daniel Dunbar722f4242009-04-22 05:08:15 +00002602 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002603 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002604 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002605 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002606
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002607 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2608 /// if the Field is a reference, this will return the address of the reference
2609 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002610 LValue EmitLValueForFieldInitialization(LValue Base,
2611 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002612
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002613 LValue EmitLValueForIvar(QualType ObjectTy,
2614 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002615 unsigned CVRQualifiers);
2616
Anders Carlsson3be22e22009-05-30 23:23:33 +00002617 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002618 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002619 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002620 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002621 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002622
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002623 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002624 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002625 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002626 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002627 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002628 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002629
Chris Lattnerd7f58862007-06-02 05:24:33 +00002630 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002631 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002632 //===--------------------------------------------------------------------===//
2633
Mike Stumpfc496822009-02-08 23:14:22 +00002634 /// EmitCall - Generate a call of the given function, expecting the given
2635 /// result type, and using the given argument list which specifies both the
2636 /// LLVM arguments and the types they were derived from.
Samuel Antao798f11c2015-11-23 22:04:44 +00002637 RValue EmitCall(const CGFunctionInfo &FnInfo, llvm::Value *Callee,
2638 ReturnValueSlot ReturnValue, const CallArgList &Args,
2639 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Craig Topper8a13c412014-05-21 05:09:00 +00002640 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002641
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002642 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002643 ReturnValueSlot ReturnValue,
Samuel Antao798f11c2015-11-23 22:04:44 +00002644 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Peter Collingbournef7706832014-12-12 23:41:25 +00002645 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002646 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002647 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002648
Eric Christopherc7e79db2015-11-12 00:44:04 +00002649 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00002650
John McCall882987f2013-02-28 19:01:20 +00002651 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2652 const Twine &name = "");
2653 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2654 ArrayRef<llvm::Value*> args,
2655 const Twine &name = "");
2656 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2657 const Twine &name = "");
2658 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2659 ArrayRef<llvm::Value*> args,
2660 const Twine &name = "");
2661
John McCallbd309292010-07-06 01:34:17 +00002662 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002663 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002664 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002665 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2666 ArrayRef<llvm::Value*> args,
2667 const Twine &name = "");
2668 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2669 const Twine &name = "");
2670 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2671 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002672
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002673 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2674 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002675 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002676
2677 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2678 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002679 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002680
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002681 RValue
2682 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2683 ReturnValueSlot ReturnValue, llvm::Value *This,
2684 llvm::Value *ImplicitParam,
2685 QualType ImplicitParamTy, const CallExpr *E);
David Majnemer0c0b6d92014-10-31 20:09:12 +00002686 RValue EmitCXXStructorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2687 ReturnValueSlot ReturnValue, llvm::Value *This,
2688 llvm::Value *ImplicitParam,
2689 QualType ImplicitParamTy, const CallExpr *E,
2690 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002691 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2692 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002693 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2694 const CXXMethodDecl *MD,
2695 ReturnValueSlot ReturnValue,
2696 bool HasQualifier,
2697 NestedNameSpecifier *Qualifier,
2698 bool IsArrow, const Expr *Base);
2699 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002700 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
2701 llvm::Value *memberPtr,
2702 const MemberPointerType *memberPtrType,
2703 AlignmentSource *AlignSource = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002704 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2705 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002706
Anders Carlsson4034a952009-05-27 04:18:27 +00002707 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002708 const CXXMethodDecl *MD,
2709 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002710
Peter Collingbournefe883422011-10-06 18:29:37 +00002711 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2712 ReturnValueSlot ReturnValue);
2713
Justin Lebar3039a592016-01-23 21:28:14 +00002714 RValue EmitCUDADevicePrintfCallExpr(const CallExpr *E,
2715 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002716
Mike Stump11289f42009-09-09 15:08:12 +00002717 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002718 unsigned BuiltinID, const CallExpr *E,
2719 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002720
Anders Carlssonbfb36712009-12-24 21:13:40 +00002721 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002722
Mike Stumpfc496822009-02-08 23:14:22 +00002723 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2724 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002725 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2726
Kevin Qin1718af62013-11-14 02:45:18 +00002727 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2728 const llvm::CmpInst::Predicate Fp,
2729 const llvm::CmpInst::Predicate Ip,
2730 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002731 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002732
2733 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2734 unsigned LLVMIntrinsic,
2735 unsigned AltLLVMIntrinsic,
2736 const char *NameHint,
2737 unsigned Modifier,
2738 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002739 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00002740 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00002741 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2742 unsigned Modifier, llvm::Type *ArgTy,
2743 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002744 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002745 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002746 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002747 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002748 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002749 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002750 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002751 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2752 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00002753 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00002754 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002755
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002756 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002757 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2758 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00002759 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00002760 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00002761 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00002762 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
2763 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002764
Daniel Dunbar66912a12008-08-20 00:28:19 +00002765 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002766 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002767 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002768 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2769 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2770 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002771 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002772 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002773 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2774 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002775
John McCall31168b02011-06-15 23:02:42 +00002776 /// Retrieves the default cleanup kind for an ARC cleanup.
2777 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2778 CleanupKind getARCCleanupKind() {
2779 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2780 ? NormalAndEHCleanup : NormalCleanup;
2781 }
2782
2783 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00002784 void EmitARCInitWeak(Address addr, llvm::Value *value);
2785 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00002786 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00002787 llvm::Value *EmitARCLoadWeakRetained(Address addr);
2788 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
2789 void EmitARCCopyWeak(Address dst, Address src);
2790 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00002791 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2792 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002793 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002794 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00002795 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002796 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002797 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2798 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002799 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00002800 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00002801 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCall31168b02011-06-15 23:02:42 +00002802 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2803 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2804 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2805 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2806
2807 std::pair<LValue,llvm::Value*>
2808 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2809 std::pair<LValue,llvm::Value*>
2810 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2811
John McCall248512a2011-10-01 10:32:24 +00002812 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002813 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2814 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2815
John McCallff613032011-10-04 06:23:45 +00002816 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002817 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2818 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2819
Craig Topper00bbdcf2014-06-28 23:22:23 +00002820 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002821
John McCall82fe67b2011-07-09 01:37:26 +00002822 static Destroyer destroyARCStrongImprecise;
2823 static Destroyer destroyARCStrongPrecise;
2824 static Destroyer destroyARCWeak;
2825
John McCall31168b02011-06-15 23:02:42 +00002826 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2827 llvm::Value *EmitObjCAutoreleasePoolPush();
2828 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2829 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2830 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2831
Richard Smitha1c9d4d2013-06-12 23:38:09 +00002832 /// \brief Emits a reference binding to the passed in expression.
2833 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002834
Chris Lattner6278e6a2007-08-11 00:04:45 +00002835 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002836 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002837 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002838
2839 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002840
2841 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2842 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002843 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002844
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00002845 /// Emit a conversion from the specified type to the specified destination
2846 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00002847 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00002848 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00002849
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00002850 /// Emit a conversion from the specified complex type to the specified
2851 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002852 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00002853 QualType DstTy,
2854 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00002855
John McCall7a626f62010-09-15 10:14:12 +00002856 /// EmitAggExpr - Emit the computation of the specified expression
2857 /// of aggregate type. The result is computed into the given slot,
2858 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002859 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002860
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002861 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2862 /// aggregate type into a temporary LValue.
2863 LValue EmitAggExprToLValue(const Expr *E);
2864
John McCall1bd25562011-06-24 23:21:27 +00002865 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2866 /// make sure it survives garbage collection until this point.
2867 void EmitExtendGCLifetime(llvm::Value *object);
2868
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002869 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002870 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002871 ComplexPairTy EmitComplexExpr(const Expr *E,
2872 bool IgnoreReal = false,
2873 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002874
John McCall47fb9502013-03-07 21:37:08 +00002875 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2876 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002877 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002878
John McCall47fb9502013-03-07 21:37:08 +00002879 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002880 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00002881
2882 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002883 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002884
John McCall7f416cc2015-09-08 08:05:57 +00002885 Address emitAddrOfRealComponent(Address complex, QualType complexType);
2886 Address emitAddrOfImagComponent(Address complex, QualType complexType);
2887
Chandler Carruth84537952012-03-30 19:44:53 +00002888 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2889 /// global variable that has already been created for it. If the initializer
2890 /// has a different type than GV does, this may free GV and return a different
2891 /// one. Otherwise it just returns GV.
2892 llvm::GlobalVariable *
2893 AddInitializerToStaticVarDecl(const VarDecl &D,
2894 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002895
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002896
Anders Carlssonf40886a2009-08-08 21:45:14 +00002897 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2898 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002899 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2900 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002901
David Majnemerb3341ea2014-10-05 05:05:40 +00002902 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
2903 llvm::Constant *Addr);
2904
John McCallc84ed6a2012-05-01 06:13:13 +00002905 /// Call atexit() with a function that passes the given argument to
2906 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00002907 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2908 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002909
John McCallcdf7ef52010-11-06 09:44:32 +00002910 /// Emit code in this function to perform a guarded variable
2911 /// initialization. Guarded initializations are used when it's not
2912 /// possible to prove that an initialization will be done exactly
2913 /// once, e.g. with a static local variable or a static data member
2914 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002915 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002916 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002917
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002918 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2919 /// variables.
2920 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00002921 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00002922 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002923
John McCallee08c532012-04-06 18:21:03 +00002924 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002925 /// variables.
John McCallee08c532012-04-06 18:21:03 +00002926 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2927 const std::vector<std::pair<llvm::WeakVH,
2928 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002929
John McCalla738c252011-03-09 04:27:21 +00002930 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2931 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00002932 llvm::GlobalVariable *Addr,
2933 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002934
John McCall7a626f62010-09-15 10:14:12 +00002935 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002936
John McCall7f416cc2015-09-08 08:05:57 +00002937 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00002938
John McCall08ef4662011-11-10 08:15:53 +00002939 void enterFullExpression(const ExprWithCleanups *E) {
2940 if (E->getNumObjects() == 0) return;
2941 enterNonTrivialFullExpression(E);
2942 }
2943 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00002944
Richard Smithea852322013-05-07 21:53:22 +00002945 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00002946
Eli Friedmanc370a7e2012-02-09 03:32:31 +00002947 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2948
Tim Northovercc2a6e02015-11-09 19:56:35 +00002949 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00002950
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002951 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002952 // Annotations Emission
2953 //===--------------------------------------------------------------------===//
2954
2955 /// Emit an annotation call (intrinsic or builtin).
2956 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2957 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002958 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002959 SourceLocation Location);
2960
2961 /// Emit local annotations for the local variable V, declared by D.
2962 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2963
2964 /// Emit field annotations for the given field & value. Returns the
2965 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00002966 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002967
2968 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002969 // Internal Helpers
2970 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002971
Chris Lattner5b1964b2008-11-11 07:41:27 +00002972 /// ContainsLabel - Return true if the statement contains a label in it. If
2973 /// this statement is not executed normally, it not containing a label means
2974 /// that we can just remove the code.
2975 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002976
Chris Lattner29911cc2011-02-28 00:18:40 +00002977 /// containsBreak - Return true if the statement contains a break out of it.
2978 /// If the statement (recursively) contains a switch or loop with a break
2979 /// inside of it, this is fine.
2980 static bool containsBreak(const Stmt *S);
2981
Daniel Dunbar682712c2008-11-12 10:12:14 +00002982 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00002983 /// to a constant, or if it does but contains a label, return false. If it
2984 /// constant folds return true and set the boolean result in Result.
2985 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00002986
Chris Lattner29911cc2011-02-28 00:18:40 +00002987 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2988 /// to a constant, or if it does but contains a label, return false. If it
2989 /// constant folds return true and set the folded value.
Richard Trieuc320c742012-07-23 20:21:35 +00002990 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattner29911cc2011-02-28 00:18:40 +00002991
Chris Lattnercd439292008-11-12 08:04:58 +00002992 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2993 /// if statement) to the specified blocks. Based on the condition, this might
2994 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00002995 /// TrueCount should be the number of times we expect the condition to
2996 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00002997 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00002998 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00002999
Richard Smithe30752c2012-10-09 19:52:38 +00003000 /// \brief Emit a description of a type in a format suitable for passing to
3001 /// a runtime sanitizer handler.
3002 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3003
3004 /// \brief Convert a value into a format suitable for passing to a runtime
3005 /// sanitizer handler.
3006 llvm::Value *EmitCheckValue(llvm::Value *V);
3007
3008 /// \brief Emit a description of a source location in a format suitable for
3009 /// passing to a runtime sanitizer handler.
3010 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3011
Richard Smithde670682012-11-01 22:15:34 +00003012 /// \brief Create a basic block that will call a handler function in a
3013 /// sanitizer runtime with the provided arguments, and create a conditional
3014 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003015 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003016 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
3017 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003018
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003019 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3020 /// if Cond if false.
3021 void EmitCfiSlowPathCheck(llvm::Value *Cond, llvm::ConstantInt *TypeId,
3022 llvm::Value *Ptr);
3023
Richard Smithde670682012-11-01 22:15:34 +00003024 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3025 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003026 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003027
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003028 /// \brief Emit a call to trap or debugtrap and attach function attribute
3029 /// "trap-func-name" if specified.
3030 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3031
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003032 /// \brief Create a check for a function parameter that may potentially be
3033 /// declared as non-null.
3034 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
3035 const FunctionDecl *FD, unsigned ParmNum);
3036
Anders Carlsson093bdff2010-03-30 03:27:09 +00003037 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003038 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003039
John McCall23f66262010-05-26 22:34:26 +00003040 /// EmitDelegateCallArg - We are performing a delegate call; that
3041 /// is, the current function is delegating to another one. Produce
3042 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003043 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3044 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003045
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003046 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3047 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003048 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003049
Chris Lattnercd439292008-11-12 08:04:58 +00003050private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003051 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003052 void EmitReturnOfRValue(RValue RV, QualType Ty);
3053
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003054 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3055
3056 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3057 DeferredReplacements;
3058
John McCall7f416cc2015-09-08 08:05:57 +00003059 /// Set the address of a local variable.
3060 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3061 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3062 LocalDeclMap.insert({VD, Addr});
3063 }
3064
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003065 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3066 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3067 ///
3068 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003069 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
3070 SmallVectorImpl<llvm::Argument *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003071
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003072 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3073 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3074 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3075 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3076 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3077 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003078
Chad Rosier59df25b2012-08-23 20:00:18 +00003079 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003080 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003081
Chad Rosier59df25b2012-08-23 20:00:18 +00003082 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003083 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003084 std::string &ConstraintStr,
3085 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003086
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003087 /// \brief Attempts to statically evaluate the object size of E. If that
3088 /// fails, emits code to figure the size of E out for us. This is
3089 /// pass_object_size aware.
3090 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
3091 llvm::IntegerType *ResType);
3092
3093 /// \brief Emits the size of E, as required by __builtin_object_size. This
3094 /// function is aware of pass_object_size parameters, and will act accordingly
3095 /// if E is a parameter with the pass_object_size attribute.
3096 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
3097 llvm::IntegerType *ResType);
3098
Reid Kleckner89077a12013-12-17 19:46:40 +00003099public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003100#ifndef NDEBUG
3101 // Determine whether the given argument is an Objective-C method
3102 // that may have type parameters in its signature.
3103 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3104 const DeclContext *dc = method->getDeclContext();
3105 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3106 return classDecl->getTypeParamListAsWritten();
3107 }
3108
3109 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3110 return catDecl->getTypeParamList();
3111 }
3112
3113 return false;
3114 }
3115
3116 template<typename T>
3117 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3118#endif
3119
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003120 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003121 template <typename T>
3122 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003123 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003124 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00003125 unsigned ParamsToSkip = 0) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003126 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003127 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003128
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003129 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3130 "Can't skip parameters if type info is not provided");
3131 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003132#ifndef NDEBUG
3133 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3134#endif
3135
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003136 // First, use the argument types that the type info knows about
3137 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3138 E = CallArgTypeInfo->param_type_end();
3139 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003140 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003141 assert((isGenericMethod ||
3142 ((*I)->isVariablyModifiedType() ||
3143 (*I).getNonReferenceType()->isObjCRetainableType() ||
3144 getContext()
3145 .getCanonicalType((*I).getNonReferenceType())
3146 .getTypePtr() ==
3147 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003148 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003149 .getTypePtr())) &&
3150 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003151 ArgTypes.push_back(*I);
3152 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003153 }
Mike Stump11289f42009-09-09 15:08:12 +00003154
Reid Kleckner739756c2013-12-04 19:23:12 +00003155 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003156 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003157 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3158 CallArgTypeInfo->isVariadic()) &&
3159 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003160
Anders Carlsson603d6af2009-04-18 20:20:22 +00003161 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003162 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
3163 ArgTypes.push_back(getVarArgType(A));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003164
David Blaikief05779e2015-07-21 18:37:18 +00003165 EmitCallArgs(Args, ArgTypes, ArgRange, CalleeDecl, ParamsToSkip);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003166 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003167
Reid Kleckner739756c2013-12-04 19:23:12 +00003168 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003169 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003170 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00003171 unsigned ParamsToSkip = 0);
Reid Kleckner739756c2013-12-04 19:23:12 +00003172
John McCall7f416cc2015-09-08 08:05:57 +00003173 /// EmitPointerWithAlignment - Given an expression with a pointer
3174 /// type, emit the value and compute our best estimate of the
3175 /// alignment of the pointee.
3176 ///
3177 /// Note that this function will conservatively fall back on the type
3178 /// when it doesn't
3179 ///
3180 /// \param Source - If non-null, this will be initialized with
3181 /// information about the source of the alignment. Note that this
3182 /// function will conservatively fall back on the type when it
3183 /// doesn't recognize the expression, which means that sometimes
3184 ///
3185 /// a worst-case One
3186 /// reasonable way to use this information is when there's a
3187 /// language guarantee that the pointer must be aligned to some
3188 /// stricter value, and we're simply trying to ensure that
3189 /// sufficiently obvious uses of under-aligned objects don't get
3190 /// miscompiled; for example, a placement new into the address of
3191 /// a local variable. In such a case, it's quite reasonable to
3192 /// just ignore the returned alignment when it isn't from an
3193 /// explicit source.
3194 Address EmitPointerWithAlignment(const Expr *Addr,
3195 AlignmentSource *Source = nullptr);
3196
Peter Collingbournedc134532016-01-16 00:31:22 +00003197 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3198
Reid Kleckner89077a12013-12-17 19:46:40 +00003199private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003200 QualType getVarArgType(const Expr *Arg);
3201
John McCalld4f4b7f2010-03-03 04:15:11 +00003202 const TargetCodeGenInfo &getTargetHooks() const {
3203 return CGM.getTargetCodeGenInfo();
3204 }
John McCall09ae0322010-07-06 23:57:41 +00003205
3206 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003207
John McCall7f416cc2015-09-08 08:05:57 +00003208 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3209 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003210
3211 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003212
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003213 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003214};
Mike Stump11289f42009-09-09 15:08:12 +00003215
John McCallce1de612011-01-26 04:00:11 +00003216/// Helper class with most of the code for saving a value for a
3217/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003218struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003219 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3220
3221 /// Answer whether the given value needs extra work to be saved.
3222 static bool needsSaving(llvm::Value *value) {
3223 // If it's not an instruction, we don't need to save.
3224 if (!isa<llvm::Instruction>(value)) return false;
3225
3226 // If it's an instruction in the entry block, we don't need to save.
3227 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3228 return (block != &block->getParent()->getEntryBlock());
3229 }
3230
3231 /// Try to save the given value.
3232 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3233 if (!needsSaving(value)) return saved_type(value, false);
3234
John McCall7f416cc2015-09-08 08:05:57 +00003235 // Otherwise, we need an alloca.
3236 auto align = CharUnits::fromQuantity(
3237 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3238 Address alloca =
3239 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003240 CGF.Builder.CreateStore(value, alloca);
3241
John McCall7f416cc2015-09-08 08:05:57 +00003242 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003243 }
3244
3245 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003246 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003247 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003248
3249 // Otherwise, it should be an alloca instruction, as set up in save().
3250 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3251 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003252 }
3253};
3254
John McCallcb5f77f2011-01-28 10:53:53 +00003255/// A partial specialization of DominatingValue for llvm::Values that
3256/// might be llvm::Instructions.
3257template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3258 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003259 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003260 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3261 }
3262};
3263
John McCall7f416cc2015-09-08 08:05:57 +00003264/// A specialization of DominatingValue for Address.
3265template <> struct DominatingValue<Address> {
3266 typedef Address type;
3267
3268 struct saved_type {
3269 DominatingLLVMValue::saved_type SavedValue;
3270 CharUnits Alignment;
3271 };
3272
3273 static bool needsSaving(type value) {
3274 return DominatingLLVMValue::needsSaving(value.getPointer());
3275 }
3276 static saved_type save(CodeGenFunction &CGF, type value) {
3277 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3278 value.getAlignment() };
3279 }
3280 static type restore(CodeGenFunction &CGF, saved_type value) {
3281 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3282 value.Alignment);
3283 }
3284};
3285
John McCallcb5f77f2011-01-28 10:53:53 +00003286/// A specialization of DominatingValue for RValue.
3287template <> struct DominatingValue<RValue> {
3288 typedef RValue type;
3289 class saved_type {
3290 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3291 AggregateAddress, ComplexAddress };
3292
3293 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003294 unsigned K : 3;
3295 unsigned Align : 29;
3296 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3297 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003298
3299 public:
3300 static bool needsSaving(RValue value);
3301 static saved_type save(CodeGenFunction &CGF, RValue value);
3302 RValue restore(CodeGenFunction &CGF);
3303
John McCall7f416cc2015-09-08 08:05:57 +00003304 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003305 };
3306
3307 static bool needsSaving(type value) {
3308 return saved_type::needsSaving(value);
3309 }
3310 static saved_type save(CodeGenFunction &CGF, type value) {
3311 return saved_type::save(CGF, value);
3312 }
3313 static type restore(CodeGenFunction &CGF, saved_type value) {
3314 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003315 }
3316};
3317
Chris Lattnerbed31442007-05-28 01:07:47 +00003318} // end namespace CodeGen
3319} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003320
Chris Lattnerbed31442007-05-28 01:07:47 +00003321#endif