blob: 85d5f7a43202520a5433cafb0ab3ea847e498388 [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
David Majnemer25eb1652016-03-01 19:42:53 +0000279 const FunctionDecl *CurSEHParent = nullptr;
280
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000281 /// True if the current function is an outlined SEH helper. This can be a
282 /// finally block or filter expression.
283 bool IsOutlinedSEHHelper;
284
John McCallad7c5c12011-02-08 08:22:06 +0000285 const CodeGen::CGBlockInfo *BlockInfo;
286 llvm::Value *BlockPointer;
287
Eli Friedman9fbeba02012-02-11 02:57:39 +0000288 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
289 FieldDecl *LambdaThisCaptureField;
290
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000291 /// \brief A mapping from NRVO variables to the flags used to indicate
292 /// when the NRVO has been applied to this variable.
293 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000294
John McCallbd309292010-07-06 01:34:17 +0000295 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000296 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000297 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000298
David Majnemer4e52d6f2015-12-12 05:39:21 +0000299 llvm::Instruction *CurrentFuncletPad = nullptr;
300
Richard Smith736a9472013-06-12 20:42:33 +0000301 /// Header for data within LifetimeExtendedCleanupStack.
302 struct LifetimeExtendedCleanupHeader {
303 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000304 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000305 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000306 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000307
Justin Bognerbdff2192015-07-01 00:59:27 +0000308 size_t getSize() const { return Size; }
309 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000310 };
John McCallbd309292010-07-06 01:34:17 +0000311
John McCallad5d61e2010-07-23 21:56:41 +0000312 /// i32s containing the indexes of the cleanup destinations.
313 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000314
315 unsigned NextCleanupDestIndex;
316
John McCall08ef4662011-11-10 08:15:53 +0000317 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
318 CGBlockInfo *FirstBlockInfo;
319
John McCall8e4c74b2011-08-11 02:22:43 +0000320 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
321 llvm::BasicBlock *EHResumeBlock;
322
Bill Wendlingf0724e82011-09-19 20:31:14 +0000323 /// The exception slot. All landing pads write the current exception pointer
324 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000325 llvm::Value *ExceptionSlot;
326
Bill Wendlingf0724e82011-09-19 20:31:14 +0000327 /// The selector slot. Under the MandatoryCleanup model, all landing pads
328 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000329 llvm::AllocaInst *EHSelectorSlot;
330
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000331 /// A stack of exception code slots. Entering an __except block pushes a slot
332 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
333 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000334 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000335
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000336 /// Value returned by __exception_info intrinsic.
337 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000338
John McCallbd309292010-07-06 01:34:17 +0000339 /// Emits a landing pad for the current EH stack.
340 llvm::BasicBlock *EmitLandingPad();
341
342 llvm::BasicBlock *getInvokeDestImpl();
343
John McCallce1de612011-01-26 04:00:11 +0000344 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000345 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
346 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000347 }
348
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000349public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000350 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
351 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000352 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000353
John McCall6b0feb72011-06-22 02:32:12 +0000354 /// A class controlling the emission of a finally block.
355 class FinallyInfo {
356 /// Where the catchall's edge through the cleanup should go.
357 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000358
John McCall6b0feb72011-06-22 02:32:12 +0000359 /// A function to call to enter the catch.
360 llvm::Constant *BeginCatchFn;
361
362 /// An i1 variable indicating whether or not the @finally is
363 /// running for an exception.
364 llvm::AllocaInst *ForEHVar;
365
366 /// An i8* variable into which the exception pointer to rethrow
367 /// has been saved.
368 llvm::AllocaInst *SavedExnVar;
369
370 public:
371 void enter(CodeGenFunction &CGF, const Stmt *Finally,
372 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
373 llvm::Constant *rethrowFn);
374 void exit(CodeGenFunction &CGF);
375 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000376
Reid Kleckner11c033e2015-02-12 23:40:45 +0000377 /// Returns true inside SEH __try blocks.
378 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
379
Reid Klecknera002bd52015-10-28 23:06:42 +0000380 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000381 bool isCleanupPadScope() const {
382 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
383 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000384
John McCallce1de612011-01-26 04:00:11 +0000385 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
386 /// current full-expression. Safe against the possibility that
387 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000388 template <class T, class... As>
389 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000390 // If we're not in a conditional branch, or if none of the
391 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000392 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000393 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000394
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000395 // Stash values in a tuple so we can guarantee the order of saves.
396 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
397 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000398
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000399 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000400 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000401 initFullExprCleanup();
402 }
403
Richard Smith736a9472013-06-12 20:42:33 +0000404 /// \brief Queue a cleanup to be pushed after finishing the current
405 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000406 template <class T, class... As>
407 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000408 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
409
410 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
411
412 size_t OldSize = LifetimeExtendedCleanupStack.size();
413 LifetimeExtendedCleanupStack.resize(
414 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
415
Justin Bognerbdff2192015-07-01 00:59:27 +0000416 static_assert(sizeof(Header) % llvm::AlignOf<T>::Alignment == 0,
417 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000418 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
419 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000420 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000421 }
422
John McCallf4beacd2011-11-10 10:43:54 +0000423 /// Set up the last cleaup that was pushed as a conditional
424 /// full-expression cleanup.
425 void initFullExprCleanup();
426
John McCallbd309292010-07-06 01:34:17 +0000427 /// PushDestructorCleanup - Push a cleanup to call the
428 /// complete-object destructor of an object of the given type at the
429 /// given address. Does nothing if T is not a C++ class type with a
430 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000431 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000432
John McCall8680f872010-07-21 06:29:51 +0000433 /// PushDestructorCleanup - Push a cleanup to call the
434 /// complete-object variant of the given destructor on the object at
435 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000436 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000437
John McCallbd309292010-07-06 01:34:17 +0000438 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
439 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000440 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000441
John McCall824c2f52010-09-14 07:57:04 +0000442 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
443 /// The block cannot be reactivated. Pops it if it's the top of the
444 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000445 ///
446 /// \param DominatingIP - An instruction which is known to
447 /// dominate the current IP (if set) and which lies along
448 /// all paths of execution between the current IP and the
449 /// the point at which the cleanup comes into scope.
450 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
451 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000452
453 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
454 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000455 ///
456 /// \param DominatingIP - An instruction which is known to
457 /// dominate the current IP (if set) and which lies along
458 /// all paths of execution between the current IP and the
459 /// the point at which the cleanup comes into scope.
460 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
461 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000462
John McCallbd309292010-07-06 01:34:17 +0000463 /// \brief Enters a new scope for capturing cleanups, all of which
464 /// will be executed once the scope is exited.
465 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000466 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000467 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000468 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000469 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000470 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000471 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000472
Aaron Ballmanabc18922015-02-15 22:54:08 +0000473 RunCleanupsScope(const RunCleanupsScope &) = delete;
474 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000475
Eric Christophera9d34972011-10-19 00:43:52 +0000476 protected:
477 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000478
Douglas Gregor965f4502009-11-24 16:43:22 +0000479 public:
480 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000481 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000482 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000483 {
John McCallbd309292010-07-06 01:34:17 +0000484 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000485 LifetimeExtendedCleanupStackSize =
486 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000487 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000488 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000489 }
490
491 /// \brief Exit this cleanup scope, emitting any accumulated
492 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000493 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000494 if (PerformCleanup) {
495 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000496 CGF.PopCleanupBlocks(CleanupStackDepth,
497 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000498 }
499 }
500
501 /// \brief Determine whether this scope requires any cleanups.
502 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000503 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000504 }
505
506 /// \brief Force the emission of cleanups now, instead of waiting
507 /// until this object is destroyed.
508 void ForceCleanup() {
509 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000510 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000511 CGF.PopCleanupBlocks(CleanupStackDepth,
512 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000513 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000514 }
515 };
516
David Blaikie93be0b22014-08-22 21:37:04 +0000517 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000518 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000519 SmallVector<const LabelDecl*, 4> Labels;
520 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000521
Aaron Ballmanabc18922015-02-15 22:54:08 +0000522 LexicalScope(const LexicalScope &) = delete;
523 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000524
525 public:
526 /// \brief Enter a new cleanup scope.
527 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000528 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
529 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000530 if (CGDebugInfo *DI = CGF.getDebugInfo())
531 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
532 }
533
Nadav Rotem1da30942013-03-23 06:43:35 +0000534 void addLabel(const LabelDecl *label) {
535 assert(PerformCleanup && "adding label to dead scope?");
536 Labels.push_back(label);
537 }
538
Eric Christophera9d34972011-10-19 00:43:52 +0000539 /// \brief Exit this cleanup scope, emitting any accumulated
540 /// cleanups.
541 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000542 if (CGDebugInfo *DI = CGF.getDebugInfo())
543 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
544
Nadav Rotem1da30942013-03-23 06:43:35 +0000545 // If we should perform a cleanup, force them now. Note that
546 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000547 if (PerformCleanup) {
548 ApplyDebugLocation DL(CGF, Range.getEnd());
549 ForceCleanup();
550 }
Eric Christophera9d34972011-10-19 00:43:52 +0000551 }
552
553 /// \brief Force the emission of cleanups now, instead of waiting
554 /// until this object is destroyed.
555 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000556 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000557 RunCleanupsScope::ForceCleanup();
558
Nadav Rotem1da30942013-03-23 06:43:35 +0000559 if (!Labels.empty())
560 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000561 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000562
563 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000564 };
565
John McCall7f416cc2015-09-08 08:05:57 +0000566 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
567
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000568 /// \brief The scope used to remap some variables as private in the OpenMP
569 /// loop body (or other captured region emitted without outlining), and to
570 /// restore old vars back on exit.
571 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000572 DeclMapTy SavedLocals;
573 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000574
575 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000576 OMPPrivateScope(const OMPPrivateScope &) = delete;
577 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000578
579 public:
580 /// \brief Enter a new OpenMP private scope.
581 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
582
583 /// \brief Registers \a LocalVD variable as a private and apply \a
584 /// PrivateGen function for it to generate corresponding private variable.
585 /// \a PrivateGen returns an address of the generated private variable.
586 /// \return true if the variable is registered as private, false if it has
587 /// been privatized already.
588 bool
589 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000590 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000591 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000592
593 // Only save it once.
594 if (SavedLocals.count(LocalVD)) return false;
595
596 // Copy the existing local entry to SavedLocals.
597 auto it = CGF.LocalDeclMap.find(LocalVD);
598 if (it != CGF.LocalDeclMap.end()) {
599 SavedLocals.insert({LocalVD, it->second});
600 } else {
601 SavedLocals.insert({LocalVD, Address::invalid()});
602 }
603
604 // Generate the private entry.
605 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000606 QualType VarTy = LocalVD->getType();
607 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000608 Address Temp = CGF.CreateMemTemp(VarTy);
609 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
610 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000611 }
John McCall7f416cc2015-09-08 08:05:57 +0000612 SavedPrivates.insert({LocalVD, Addr});
613
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000614 return true;
615 }
616
617 /// \brief Privatizes local variables previously registered as private.
618 /// Registration is separate from the actual privatization to allow
619 /// initializers use values of the original variables, not the private one.
620 /// This is important, for example, if the private variable is a class
621 /// variable initialized by a constructor that references other private
622 /// variables. But at initialization original variables must be used, not
623 /// private copies.
624 /// \return true if at least one variable was privatized, false otherwise.
625 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000626 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000627 SavedPrivates.clear();
628 return !SavedLocals.empty();
629 }
630
631 void ForceCleanup() {
632 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000633 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000634 SavedLocals.clear();
635 }
636
637 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000638 ~OMPPrivateScope() {
639 if (PerformCleanup)
640 ForceCleanup();
641 }
John McCall7f416cc2015-09-08 08:05:57 +0000642
643 private:
644 /// Copy all the entries in the source map over the corresponding
645 /// entries in the destination, which must exist.
646 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
647 for (auto &pair : src) {
648 if (!pair.second.isValid()) {
649 dest.erase(pair.first);
650 continue;
651 }
652
653 auto it = dest.find(pair.first);
654 if (it != dest.end()) {
655 it->second = pair.second;
656 } else {
657 dest.insert(pair);
658 }
659 }
660 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000661 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000662
Richard Smith736a9472013-06-12 20:42:33 +0000663 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
664 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000665 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000666
Richard Smith736a9472013-06-12 20:42:33 +0000667 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
668 /// that have been added, then adds all lifetime-extended cleanups from
669 /// the given position to the stack.
670 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
671 size_t OldLifetimeExtendedStackSize);
672
John McCallad5d61e2010-07-23 21:56:41 +0000673 void ResolveBranchFixups(llvm::BasicBlock *Target);
674
John McCallbd309292010-07-06 01:34:17 +0000675 /// The given basic block lies in the current EH scope, but may be a
676 /// target of a potentially scope-crossing jump; get a stable handle
677 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000678 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000679 return JumpDest(Target,
680 EHStack.getInnermostNormalCleanup(),
681 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000682 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000683
John McCallbd309292010-07-06 01:34:17 +0000684 /// The given basic block lies in the current EH scope, but may be a
685 /// target of a potentially scope-crossing jump; get a stable handle
686 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000687 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000688 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000689 }
690
691 /// EmitBranchThroughCleanup - Emit a branch from the current insert
692 /// block through the normal cleanup handling code (if any) and then
693 /// on to \arg Dest.
694 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000695
Justin Bognere25ffdf2014-01-21 00:35:11 +0000696 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
697 /// specified destination obviously has no cleanups to run. 'false' is always
698 /// a conservatively correct answer for this method.
699 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
700
John McCall8e4c74b2011-08-11 02:22:43 +0000701 /// popCatchScope - Pops the catch scope at the top of the EHScope
702 /// stack, emitting any required code (other than the catch handlers
703 /// themselves).
704 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000705
David Chisnall9a837be2012-11-07 16:50:40 +0000706 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000707 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000708 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000709
John McCallce1de612011-01-26 04:00:11 +0000710 /// An object to manage conditionally-evaluated expressions.
711 class ConditionalEvaluation {
712 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000713
John McCallce1de612011-01-26 04:00:11 +0000714 public:
715 ConditionalEvaluation(CodeGenFunction &CGF)
716 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000717
John McCallce1de612011-01-26 04:00:11 +0000718 void begin(CodeGenFunction &CGF) {
719 assert(CGF.OutermostConditional != this);
720 if (!CGF.OutermostConditional)
721 CGF.OutermostConditional = this;
722 }
723
724 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000725 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000726 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000727 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000728 }
729
730 /// Returns a block which will be executed prior to each
731 /// evaluation of the conditional code.
732 llvm::BasicBlock *getStartingBlock() const {
733 return StartBB;
734 }
735 };
Mike Stump11289f42009-09-09 15:08:12 +0000736
John McCall7f9c92a2010-09-17 00:50:28 +0000737 /// isInConditionalBranch - Return true if we're currently emitting
738 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000739 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000740
John McCall7f416cc2015-09-08 08:05:57 +0000741 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000742 assert(isInConditionalBranch());
743 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000744 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
745 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000746 }
747
John McCallce1de612011-01-26 04:00:11 +0000748 /// An RAII object to record that we're evaluating a statement
749 /// expression.
750 class StmtExprEvaluation {
751 CodeGenFunction &CGF;
752
753 /// We have to save the outermost conditional: cleanups in a
754 /// statement expression aren't conditional just because the
755 /// StmtExpr is.
756 ConditionalEvaluation *SavedOutermostConditional;
757
758 public:
759 StmtExprEvaluation(CodeGenFunction &CGF)
760 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000761 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000762 }
763
764 ~StmtExprEvaluation() {
765 CGF.OutermostConditional = SavedOutermostConditional;
766 CGF.EnsureInsertPoint();
767 }
768 };
John McCall1bf58462011-02-16 08:02:54 +0000769
John McCallc07a0c72011-02-17 10:25:35 +0000770 /// An object which temporarily prevents a value from being
771 /// destroyed by aggressive peephole optimizations that assume that
772 /// all uses of a value have been realized in the IR.
773 class PeepholeProtection {
774 llvm::Instruction *Inst;
775 friend class CodeGenFunction;
776
777 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000778 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000779 };
John McCallc07a0c72011-02-17 10:25:35 +0000780
John McCallfe96e0b2011-11-06 09:01:30 +0000781 /// A non-RAII class containing all the information about a bound
782 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
783 /// this which makes individual mappings very simple; using this
784 /// class directly is useful when you have a variable number of
785 /// opaque values or don't want the RAII functionality for some
786 /// reason.
787 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000788 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000789 bool BoundLValue;
790 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000791
John McCallfe96e0b2011-11-06 09:01:30 +0000792 OpaqueValueMappingData(const OpaqueValueExpr *ov,
793 bool boundLValue)
794 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000795 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000796 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000797
John McCallc07a0c72011-02-17 10:25:35 +0000798 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000799 // gl-values should be bound as l-values for obvious reasons.
800 // Records should be bound as l-values because IR generation
801 // always keeps them in memory. Expressions of function type
802 // act exactly like l-values but are formally required to be
803 // r-values in C.
804 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000805 expr->getType()->isFunctionType() ||
806 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000807 }
808
John McCallfe96e0b2011-11-06 09:01:30 +0000809 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
810 const OpaqueValueExpr *ov,
811 const Expr *e) {
812 if (shouldBindAsLValue(ov))
813 return bind(CGF, ov, CGF.EmitLValue(e));
814 return bind(CGF, ov, CGF.EmitAnyExpr(e));
815 }
816
817 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
818 const OpaqueValueExpr *ov,
819 const LValue &lv) {
820 assert(shouldBindAsLValue(ov));
821 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
822 return OpaqueValueMappingData(ov, true);
823 }
824
825 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
826 const OpaqueValueExpr *ov,
827 const RValue &rv) {
828 assert(!shouldBindAsLValue(ov));
829 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
830
831 OpaqueValueMappingData data(ov, false);
832
833 // Work around an extremely aggressive peephole optimization in
834 // EmitScalarConversion which assumes that all other uses of a
835 // value are extant.
836 data.Protection = CGF.protectFromPeepholes(rv);
837
838 return data;
839 }
840
Craig Topper8a13c412014-05-21 05:09:00 +0000841 bool isValid() const { return OpaqueValue != nullptr; }
842 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000843
844 void unbind(CodeGenFunction &CGF) {
845 assert(OpaqueValue && "no data to unbind!");
846
847 if (BoundLValue) {
848 CGF.OpaqueLValues.erase(OpaqueValue);
849 } else {
850 CGF.OpaqueRValues.erase(OpaqueValue);
851 CGF.unprotectFromPeepholes(Protection);
852 }
853 }
854 };
855
856 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
857 class OpaqueValueMapping {
858 CodeGenFunction &CGF;
859 OpaqueValueMappingData Data;
860
861 public:
862 static bool shouldBindAsLValue(const Expr *expr) {
863 return OpaqueValueMappingData::shouldBindAsLValue(expr);
864 }
865
John McCallc07a0c72011-02-17 10:25:35 +0000866 /// Build the opaque value mapping for the given conditional
867 /// operator if it's the GNU ?: extension. This is a common
868 /// enough pattern that the convenience operator is really
869 /// helpful.
870 ///
871 OpaqueValueMapping(CodeGenFunction &CGF,
872 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000873 if (isa<ConditionalOperator>(op))
874 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000875 return;
John McCallc07a0c72011-02-17 10:25:35 +0000876
877 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000878 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
879 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000880 }
881
John McCall1bf58462011-02-16 08:02:54 +0000882 OpaqueValueMapping(CodeGenFunction &CGF,
883 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000884 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000885 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000886 }
887
888 OpaqueValueMapping(CodeGenFunction &CGF,
889 const OpaqueValueExpr *opaqueValue,
890 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000891 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000892 }
893
894 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000895 Data.unbind(CGF);
896 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000897 }
898
899 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000900 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000901 }
902 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000903
Chris Lattner2da04b32007-08-24 05:35:26 +0000904private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000905 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000906 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000907
John McCall9b382dd2011-05-28 21:13:02 +0000908 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
909 /// calling llvm.stacksave for multiple VLAs in the same scope.
910 bool DidCallStackSave;
911
Mike Stumpe5311b02009-11-30 20:08:49 +0000912 /// IndirectBranch - The first time an indirect goto is seen we create a block
913 /// with an indirect branch. Every time we see the address of a label taken,
914 /// we add the label to the indirect goto. Every subsequent indirect goto is
915 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000916 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000917
Mike Stumpfc496822009-02-08 23:14:22 +0000918 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
919 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000920 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000921
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000922 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
923 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
924 /// parameter.
925 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
926 SizeArguments;
927
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000928 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000929 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000930 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
931
Chris Lattnerac248202007-05-30 00:13:02 +0000932 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000933 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000934
Mike Stumpfc496822009-02-08 23:14:22 +0000935 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000936 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000937 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000938 BreakContinue(JumpDest Break, JumpDest Continue)
939 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000940
John McCallbd309292010-07-06 01:34:17 +0000941 JumpDest BreakBlock;
942 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000943 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000944 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000945
Justin Bogneref512b92014-01-06 22:27:43 +0000946 CodeGenPGO PGO;
947
Justin Bogner65512642015-05-02 05:00:55 +0000948 /// Calculate branch weights appropriate for PGO data
949 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
950 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
951 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
952 uint64_t LoopCount);
953
Justin Bogneref512b92014-01-06 22:27:43 +0000954public:
Justin Bogner66242d62015-04-23 23:06:47 +0000955 /// Increment the profiler's counter for the given statement.
956 void incrementProfileCounter(const Stmt *S) {
Rong Xu9837ef52016-02-04 18:39:09 +0000957 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Justin Bogner66242d62015-04-23 23:06:47 +0000958 PGO.emitCounterIncrement(Builder, S);
959 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +0000960 }
Justin Bogner66242d62015-04-23 23:06:47 +0000961
962 /// Get the profiler's count for the given statement.
963 uint64_t getProfileCount(const Stmt *S) {
964 Optional<uint64_t> Count = PGO.getStmtCount(S);
965 if (!Count.hasValue())
966 return 0;
967 return *Count;
968 }
969
970 /// Set the profiler's current count.
971 void setCurrentProfileCount(uint64_t Count) {
972 PGO.setCurrentRegionCount(Count);
973 }
974
975 /// Get the profiler's current count. This is generally the count for the most
976 /// recently incremented counter.
977 uint64_t getCurrentProfileCount() {
978 return PGO.getCurrentRegionCount();
979 }
980
Justin Bogneref512b92014-01-06 22:27:43 +0000981private:
982
Zhongxing Xu82846ea2012-01-14 09:08:15 +0000983 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +0000984 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000985 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +0000986 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
987 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +0000988
Mike Stumpfc496822009-02-08 23:14:22 +0000989 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000990 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000991 llvm::BasicBlock *CaseRangeBlock;
992
John McCallc07a0c72011-02-17 10:25:35 +0000993 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +0000994 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +0000995 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
996 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +0000997
Mike Stumpfc496822009-02-08 23:14:22 +0000998 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +0000999 // We track this by the size expression rather than the type itself because
1000 // in certain situations, like a const qualifier applied to an VLA typedef,
1001 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001002 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1003 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001004 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001005
John McCallbd309292010-07-06 01:34:17 +00001006 /// A block containing a single 'unreachable' instruction. Created
1007 /// lazily by getUnreachableBlock().
1008 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001009
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001010 /// Counts of the number return expressions in the function.
1011 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001012
1013 /// Count the number of simple (constant) return expressions in the function.
1014 unsigned NumSimpleReturnExprs;
1015
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001016 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001017 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001018
Richard Smith852c9db2013-04-20 22:23:05 +00001019public:
1020 /// A scope within which we are constructing the fields of an object which
1021 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1022 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1023 class FieldConstructionScope {
1024 public:
John McCall7f416cc2015-09-08 08:05:57 +00001025 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001026 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1027 CGF.CXXDefaultInitExprThis = This;
1028 }
1029 ~FieldConstructionScope() {
1030 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1031 }
1032
1033 private:
1034 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001035 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001036 };
1037
1038 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1039 /// is overridden to be the object under construction.
1040 class CXXDefaultInitExprScope {
1041 public:
1042 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001043 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1044 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1045 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1046 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001047 }
1048 ~CXXDefaultInitExprScope() {
1049 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001050 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001051 }
1052
1053 public:
1054 CodeGenFunction &CGF;
1055 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001056 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001057 };
1058
1059private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001060 /// CXXThisDecl - When generating code for a C++ member function,
1061 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001062 ImplicitParamDecl *CXXABIThisDecl;
1063 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001064 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001065 CharUnits CXXABIThisAlignment;
1066 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001067
Richard Smith852c9db2013-04-20 22:23:05 +00001068 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1069 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001070 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001071
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001072 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1073 /// destructor, this will hold the implicit argument (e.g. VTT).
1074 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1075 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001076
John McCallce1de612011-01-26 04:00:11 +00001077 /// OutermostConditional - Points to the outermost active
1078 /// conditional control. This is used so that we know if a
1079 /// temporary should be destroyed conditionally.
1080 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001081
Nadav Rotem1da30942013-03-23 06:43:35 +00001082 /// The current lexical scope.
1083 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001084
Adrian Prantldc237b52013-05-16 00:41:26 +00001085 /// The current source location that should be used for exception
1086 /// handling code.
1087 SourceLocation CurEHLocation;
1088
John McCall7f416cc2015-09-08 08:05:57 +00001089 /// BlockByrefInfos - For each __block variable, contains
1090 /// information about the layout of the variable.
1091 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001092
John McCallbd309292010-07-06 01:34:17 +00001093 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001094 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001095 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001096
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001097 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1098 /// In the kernel metadata node, reference the kernel function and metadata
1099 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001100 /// - A node for the vec_type_hint(<type>) qualifier contains string
1101 /// "vec_type_hint", an undefined value of the <type> data type,
1102 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001103 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1104 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1105 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1106 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1107 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1108 llvm::Function *Fn);
1109
Chris Lattnerbed31442007-05-28 01:07:47 +00001110public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001111 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001112 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001113
John McCall8ed55a52010-09-02 09:58:18 +00001114 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001115 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001116 CGDebugInfo *getDebugInfo() {
1117 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001118 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001119 return DebugInfo;
1120 }
1121 void disableDebugInfo() { DisableDebugInfo = true; }
1122 void enableDebugInfo() { DisableDebugInfo = false; }
1123
John McCall31168b02011-06-15 23:02:42 +00001124 bool shouldUseFusedARCCalls() {
1125 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1126 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001127
David Blaikiebbafb8a2012-03-11 07:00:24 +00001128 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001129
Bill Wendlingf0724e82011-09-19 20:31:14 +00001130 /// Returns a pointer to the function's exception object and selector slot,
1131 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001132 Address getExceptionSlot();
1133 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001134
Bill Wendling79a70e42011-09-15 18:57:19 +00001135 /// Returns the contents of the function's exception object and selector
1136 /// slots.
1137 llvm::Value *getExceptionFromSlot();
1138 llvm::Value *getSelectorFromSlot();
1139
John McCall7f416cc2015-09-08 08:05:57 +00001140 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001141
John McCallbd309292010-07-06 01:34:17 +00001142 llvm::BasicBlock *getUnreachableBlock() {
1143 if (!UnreachableBlock) {
1144 UnreachableBlock = createBasicBlock("unreachable");
1145 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1146 }
1147 return UnreachableBlock;
1148 }
1149
1150 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001151 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001152 return getInvokeDestImpl();
1153 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001154
David Majnemer25eb1652016-03-01 19:42:53 +00001155 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001156
John McCallc8e01702013-04-16 22:48:15 +00001157 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001158 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001159
Daniel Dunbar12347492009-02-23 17:26:39 +00001160 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001161 // Cleanups
1162 //===--------------------------------------------------------------------===//
1163
John McCall7f416cc2015-09-08 08:05:57 +00001164 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001165
John McCall178360e2011-07-11 08:38:19 +00001166 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001167 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001168 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001169 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001170 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001171 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1172 llvm::Value *arrayEnd,
1173 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001174 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001175 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001176
John McCall4bd0fb12011-07-12 16:41:08 +00001177 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001178 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001179 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001180 Address addr, QualType type);
1181 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001182 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001183 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001184 QualType type, Destroyer *destroyer,
1185 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001186 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1187 llvm::Value *CompletePtr,
1188 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001189 void pushStackRestore(CleanupKind kind, Address SPMem);
1190 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001191 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001192 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001193 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001194 bool useEHCleanupForArray,
1195 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001196 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001197 QualType elementType, CharUnits elementAlign,
1198 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001199 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001200
Peter Collingbourne1425b452012-01-26 03:33:36 +00001201 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001202
John McCall82fe67b2011-07-09 01:37:26 +00001203 /// Determines whether an EH cleanup is required to destroy a type
1204 /// with the given destruction kind.
1205 bool needsEHCleanup(QualType::DestructionKind kind) {
1206 switch (kind) {
1207 case QualType::DK_none:
1208 return false;
1209 case QualType::DK_cxx_destructor:
1210 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001211 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001212 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001213 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001214 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1215 }
1216 llvm_unreachable("bad destruction kind");
1217 }
1218
John McCall4bd0fb12011-07-12 16:41:08 +00001219 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1220 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1221 }
1222
John McCall82fe67b2011-07-09 01:37:26 +00001223 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001224 // Objective-C
1225 //===--------------------------------------------------------------------===//
1226
Chris Lattner4bd55962008-03-30 23:03:07 +00001227 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001228
David Blaikief1425802015-01-14 00:04:42 +00001229 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001230
Mike Stumpfc496822009-02-08 23:14:22 +00001231 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001232 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1233 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001234 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001235 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001236 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001237 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001238
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001239 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1240 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001241
Mike Stumpfc496822009-02-08 23:14:22 +00001242 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1243 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001244 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1245 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001246 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001247 const ObjCPropertyImplDecl *propImpl,
1248 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001249
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001250 //===--------------------------------------------------------------------===//
1251 // Block Bits
1252 //===--------------------------------------------------------------------===//
1253
John McCall351762c2011-02-07 10:33:21 +00001254 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001255 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1256 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001257
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001258 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001259 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001260 const DeclMapTy &ldm,
1261 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001262
John McCallad7c5c12011-02-08 08:22:06 +00001263 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1264 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001265 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1266 const ObjCPropertyImplDecl *PID);
1267 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1268 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001269 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001270
John McCallad7c5c12011-02-08 08:22:06 +00001271 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1272
John McCall73064872011-03-31 01:59:53 +00001273 class AutoVarEmission;
1274
1275 void emitByrefStructureInit(const AutoVarEmission &emission);
1276 void enterByrefCleanup(const AutoVarEmission &emission);
1277
John McCall7f416cc2015-09-08 08:05:57 +00001278 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1279 llvm::Value *ptr);
1280
1281 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001282 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1283
1284 /// BuildBlockByrefAddress - Computes the location of the
1285 /// data in a variable which is declared as __block.
1286 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1287 bool followForward = true);
1288 Address emitBlockByrefAddress(Address baseAddr,
1289 const BlockByrefInfo &info,
1290 bool followForward,
1291 const llvm::Twine &name);
1292
1293 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001294
John McCalla738c252011-03-09 04:27:21 +00001295 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1296 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001297 /// \brief Emit code for the start of a function.
1298 /// \param Loc The location to be associated with the function.
1299 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001300 void StartFunction(GlobalDecl GD,
1301 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001302 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001303 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001304 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001305 SourceLocation Loc = SourceLocation(),
1306 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001307
John McCallb81884d2010-02-19 09:25:03 +00001308 void EmitConstructorBody(FunctionArgList &Args);
1309 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001310 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001311 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001312 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001313
Faisal Vali571df122013-09-29 08:45:24 +00001314 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001315 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001316 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001317 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001318 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1319 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001320 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001321
David Blaikiea0a1a872015-01-18 02:48:07 +00001322 /// \brief Emit the unified return block, trying to avoid its emission when
1323 /// possible.
1324 /// \return The debug location of the user written return statement if the
1325 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001326 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001327
Mike Stumpfc496822009-02-08 23:14:22 +00001328 /// FinishFunction - Complete IR generation of the current function. It is
1329 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001330 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001331
Nico Weber1bebad12015-02-11 22:33:32 +00001332 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1333 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001334
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001335 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001336
John McCall7f416cc2015-09-08 08:05:57 +00001337 void FinishThunk();
1338
Reid Klecknerab2090d2014-07-26 01:34:32 +00001339 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1340 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1341 llvm::Value *Callee);
1342
Rafael Espindolad6e66942015-07-13 06:07:58 +00001343 /// Generate a thunk for the given method.
1344 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001345 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001346
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001347 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1348 const CGFunctionInfo &FnInfo,
1349 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001350
Douglas Gregor94f9a482010-05-05 05:51:00 +00001351 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1352 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001353
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001354 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001355 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001356
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001357 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1358 struct VPtr {
1359 BaseSubobject Base;
1360 const CXXRecordDecl *NearestVBase;
1361 CharUnits OffsetFromNearestVBase;
1362 const CXXRecordDecl *VTableClass;
1363 };
1364
1365 /// Initialize the vtable pointer of the given subobject.
1366 void InitializeVTablePointer(const VPtr &vptr);
1367
1368 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001369
1370 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001371 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1372
1373 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1374 CharUnits OffsetFromNearestVBase,
1375 bool BaseIsNonVirtualPrimaryBase,
1376 const CXXRecordDecl *VTableClass,
1377 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001378
Anders Carlssond5895932010-03-28 21:07:49 +00001379 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001380
Dan Gohman8fc50c22010-10-26 18:44:08 +00001381 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1382 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001383 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1384 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001385
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001386 enum CFITypeCheckKind {
1387 CFITCK_VCall,
1388 CFITCK_NVCall,
1389 CFITCK_DerivedCast,
1390 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001391 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001392 };
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 Collingbournefb532b92016-02-24 20:46:36 +00001403 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001404 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
Peter Collingbournefb532b92016-02-24 20:46:36 +00001411 /// If whole-program virtual table optimization is enabled, emit an assumption
1412 /// that VTable is a member of the type's bitset. Or, if vptr CFI is enabled,
1413 /// emit a check that VTable is a member of the type's bitset.
1414 void EmitBitSetCodeForVCall(const CXXRecordDecl *RD, llvm::Value *VTable,
1415 SourceLocation Loc);
1416
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001417 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1418 /// expr can be devirtualized.
1419 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1420 const CXXMethodDecl *MD);
1421
John McCallf99a6312010-07-21 05:30:47 +00001422 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1423 /// given phase of destruction for a destructor. The end result
1424 /// should call destructors on members and base classes in reverse
1425 /// order of their construction.
1426 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001427
Chris Lattner3c77a352010-06-22 00:03:40 +00001428 /// ShouldInstrumentFunction - Return true if the current function should be
1429 /// instrumented with __cyg_profile_func_* calls
1430 bool ShouldInstrumentFunction();
1431
1432 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1433 /// instrumentation function with the current function and the call site, if
1434 /// function instrumentation is enabled.
1435 void EmitFunctionInstrumentation(const char *Fn);
1436
Roman Divacky178e01602011-02-10 16:52:03 +00001437 /// EmitMCountInstrumentation - Emit call to .mcount.
1438 void EmitMCountInstrumentation();
1439
Mike Stumpfc496822009-02-08 23:14:22 +00001440 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1441 /// arguments for the given function. This is also responsible for naming the
1442 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001443 void EmitFunctionProlog(const CGFunctionInfo &FI,
1444 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001445 const FunctionArgList &Args);
1446
Mike Stumpfc496822009-02-08 23:14:22 +00001447 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1448 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001449 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1450 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001451
Mike Stump1d849212009-12-07 23:38:24 +00001452 /// EmitStartEHSpec - Emit the start of the exception spec.
1453 void EmitStartEHSpec(const Decl *D);
1454
1455 /// EmitEndEHSpec - Emit the end of the exception spec.
1456 void EmitEndEHSpec(const Decl *D);
1457
John McCallbd309292010-07-06 01:34:17 +00001458 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1459 llvm::BasicBlock *getTerminateLandingPad();
1460
1461 /// getTerminateHandler - Return a handler (not a landing pad, just
1462 /// a catch handler) that just calls terminate. This is used when
1463 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001464 llvm::BasicBlock *getTerminateHandler();
1465
Chris Lattnera5f58b02011-07-09 17:41:47 +00001466 llvm::Type *ConvertTypeForMem(QualType T);
1467 llvm::Type *ConvertType(QualType T);
1468 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001469 return ConvertType(getContext().getTypeDeclType(T));
1470 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001471
Mike Stumpfc496822009-02-08 23:14:22 +00001472 /// LoadObjCSelf - Load the value of self. This function is only valid while
1473 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001474 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001475
1476 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001477 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001478
Chris Lattner54fb19e2007-06-22 22:02:34 +00001479 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1480 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001481 static TypeEvaluationKind getEvaluationKind(QualType T);
1482
1483 static bool hasScalarEvaluationKind(QualType T) {
1484 return getEvaluationKind(T) == TEK_Scalar;
1485 }
1486
1487 static bool hasAggregateEvaluationKind(QualType T) {
1488 return getEvaluationKind(T) == TEK_Aggregate;
1489 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001490
1491 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001492 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001493 llvm::Function *parent = nullptr,
1494 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001495#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001496 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001497#else
John McCallad7c5c12011-02-08 08:22:06 +00001498 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001499#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001500 }
Mike Stumpfc496822009-02-08 23:14:22 +00001501
Chris Lattnerac248202007-05-30 00:13:02 +00001502 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1503 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001504 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001505
Mike Stumpe5311b02009-11-30 20:08:49 +00001506 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1507 /// another basic block, simplify it. This assumes that no other code could
1508 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001509 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1510
Mike Stumpfc496822009-02-08 23:14:22 +00001511 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1512 /// adding a fall-through branch from the current insert block if
1513 /// necessary. It is legal to call this function even if there is no current
1514 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001515 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001516 /// IsFinished - If true, indicates that the caller has finished emitting
1517 /// branches to the given block and does not expect to emit code into it. This
1518 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001519 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001520
John McCall8e4c74b2011-08-11 02:22:43 +00001521 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1522 /// near its uses, and leave the insertion point in it.
1523 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1524
Mike Stumpfc496822009-02-08 23:14:22 +00001525 /// EmitBranch - Emit a branch to the specified basic block from the current
1526 /// insert block, taking care to avoid creation of branches from dummy
1527 /// blocks. It is legal to call this function even if there is no current
1528 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001529 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001530 /// This function clears the current insertion point. The caller should follow
1531 /// calls to this function with calls to Emit*Block prior to generation new
1532 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001533 void EmitBranch(llvm::BasicBlock *Block);
1534
Mike Stumpfc496822009-02-08 23:14:22 +00001535 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1536 /// indicates that the current code being emitted is unreachable.
1537 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001538 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001539 }
1540
Mike Stumpfc496822009-02-08 23:14:22 +00001541 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1542 /// emitted IR has a place to go. Note that by definition, if this function
1543 /// creates a block then that block is unreachable; callers may do better to
1544 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001545 void EnsureInsertPoint() {
1546 if (!HaveInsertPoint())
1547 EmitBlock(createBasicBlock());
1548 }
Mike Stumpfc496822009-02-08 23:14:22 +00001549
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001550 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001551 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001552 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001553
Chris Lattnere9a64532007-06-22 21:44:33 +00001554 //===--------------------------------------------------------------------===//
1555 // Helpers
1556 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001557
John McCall7f416cc2015-09-08 08:05:57 +00001558 LValue MakeAddrLValue(Address Addr, QualType T,
1559 AlignmentSource AlignSource = AlignmentSource::Type) {
1560 return LValue::MakeAddr(Addr, T, getContext(), AlignSource,
Dan Gohman947c9af2010-10-14 23:06:10 +00001561 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001562 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001563
John McCall7f416cc2015-09-08 08:05:57 +00001564 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1565 AlignmentSource AlignSource = AlignmentSource::Type) {
1566 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1567 AlignSource, CGM.getTBAAInfo(T));
1568 }
1569
1570 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001571 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001572 CharUnits getNaturalTypeAlignment(QualType T,
1573 AlignmentSource *Source = nullptr,
1574 bool forPointeeType = false);
1575 CharUnits getNaturalPointeeTypeAlignment(QualType T,
1576 AlignmentSource *Source = nullptr);
1577
1578 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
1579 AlignmentSource *Source = nullptr);
1580 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001581
Alexey Bataev31300ed2016-02-04 11:27:03 +00001582 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
1583 AlignmentSource *Source = nullptr);
1584 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1585
Chris Lattnere9a64532007-06-22 21:44:33 +00001586 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001587 /// block. The caller is responsible for setting an appropriate alignment on
1588 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001589 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001590 const Twine &Name = "tmp");
John McCall7f416cc2015-09-08 08:05:57 +00001591 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
1592 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001593
John McCall7f416cc2015-09-08 08:05:57 +00001594 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1595 /// default ABI alignment of the given LLVM type.
1596 ///
1597 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1598 /// any given AST type that happens to have been lowered to the
1599 /// given IR type. This should only ever be used for function-local,
1600 /// IR-driven manipulations like saving and restoring a value. Do
1601 /// not hand this address off to arbitrary IRGen routines, and especially
1602 /// do not pass it as an argument to a function that might expect a
1603 /// properly ABI-aligned value.
1604 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1605 const Twine &Name = "tmp");
1606
1607 /// InitTempAlloca - Provide an initial value for the given alloca which
1608 /// will be observable at all locations in the function.
1609 ///
1610 /// The address should be something that was returned from one of
1611 /// the CreateTempAlloca or CreateMemTemp routines, and the
1612 /// initializer must be valid in the entry block (i.e. it must
1613 /// either be a constant or an argument value).
1614 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001615
Daniel Dunbard0049182010-02-16 19:44:13 +00001616 /// CreateIRTemp - Create a temporary IR object of the given type, with
1617 /// appropriate alignment. This routine should only be used when an temporary
1618 /// value needs to be stored into an alloca (for example, to avoid explicit
1619 /// PHI construction), but the type is the IR type, not the type appropriate
1620 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001621 ///
1622 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1623 /// ConvertType instead of ConvertTypeForMem.
1624 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001625
Daniel Dunbara7566f12010-02-09 02:48:28 +00001626 /// CreateMemTemp - Create a temporary memory object of the given type, with
1627 /// appropriate alignment.
John McCall7f416cc2015-09-08 08:05:57 +00001628 Address CreateMemTemp(QualType T, const Twine &Name = "tmp");
1629 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001630
John McCall7a626f62010-09-15 10:14:12 +00001631 /// CreateAggTemp - Create a temporary memory object for the given
1632 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001633 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00001634 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001635 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001636 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001637 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001638 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001639 }
1640
John McCallad7c5c12011-02-08 08:22:06 +00001641 /// Emit a cast to void* in the appropriate address space.
1642 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1643
Chris Lattner8394d792007-06-05 20:53:16 +00001644 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1645 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001646 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001647
John McCalla2342eb2010-12-05 02:00:02 +00001648 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1649 void EmitIgnoredExpr(const Expr *E);
1650
Chris Lattner4647a212007-08-31 22:49:20 +00001651 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1652 /// any type. The result is returned as an RValue struct. If this is an
1653 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1654 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001655 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001656 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001657 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001658 AggValueSlot aggSlot = AggValueSlot::ignored(),
1659 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001660
Mike Stumpfc496822009-02-08 23:14:22 +00001661 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1662 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00001663 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001664
Charles Davisc7d5c942015-09-17 20:55:33 +00001665 /// Emit a "reference" to a __builtin_ms_va_list; this is
1666 /// always the value of the expression, because a __builtin_ms_va_list is a
1667 /// pointer to a char.
1668 Address EmitMSVAListRef(const Expr *E);
1669
Mike Stumpfc496822009-02-08 23:14:22 +00001670 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1671 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001672 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001673
John McCall91ca10f2011-03-08 09:11:50 +00001674 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001675 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00001676 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001677 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001678
John McCall7f416cc2015-09-08 08:05:57 +00001679 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00001680
John McCall91ca10f2011-03-08 09:11:50 +00001681 /// EmitExprAsInit - Emits the code necessary to initialize a
1682 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001683 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001684 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001685
Fariborz Jahanian78652202013-01-25 23:57:05 +00001686 /// hasVolatileMember - returns true if aggregate type has a volatile
1687 /// member.
1688 bool hasVolatileMember(QualType T) {
1689 if (const RecordType *RT = T->getAs<RecordType>()) {
1690 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1691 return RD->hasVolatileMember();
1692 }
1693 return false;
1694 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001695 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001696 ///
1697 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1698 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00001699 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001700 QualType EltTy) {
1701 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00001702 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001703 }
1704
John McCall7f416cc2015-09-08 08:05:57 +00001705 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
1706 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00001707 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00001708 /*IsAssignment=*/false);
1709 }
1710
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001711 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001712 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001713 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001714 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001715 /// \param isAssignment - If false, allow padding to be copied. This often
1716 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00001717 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001718 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001719 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001720
Anders Carlsson9396a892008-09-11 09:15:33 +00001721 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00001722 Address GetAddrOfLocalVar(const VarDecl *VD) {
1723 auto it = LocalDeclMap.find(VD);
1724 assert(it != LocalDeclMap.end() &&
1725 "Invalid argument to GetAddrOfLocalVar(), no decl!");
1726 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00001727 }
Mike Stumpfc496822009-02-08 23:14:22 +00001728
John McCallc07a0c72011-02-17 10:25:35 +00001729 /// getOpaqueLValueMapping - Given an opaque value expression (which
1730 /// must be mapped to an l-value), return its mapping.
1731 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1732 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1733
1734 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1735 it = OpaqueLValues.find(e);
1736 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1737 return it->second;
1738 }
1739
1740 /// getOpaqueRValueMapping - Given an opaque value expression (which
1741 /// must be mapped to an r-value), return its mapping.
1742 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1743 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1744
1745 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1746 it = OpaqueRValues.find(e);
1747 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001748 return it->second;
1749 }
1750
Dan Gohman75d69da2008-05-22 00:50:06 +00001751 /// getAccessedFieldNo - Given an encoded value and a result number, return
1752 /// the input field number being accessed.
1753 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1754
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001755 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001756 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001757
Anders Carlssonc0964b62010-05-22 17:35:42 +00001758 /// EmitNullInitialization - Generate code to set a value of the given type to
1759 /// null, If the type contains data member pointers, they will be initialized
1760 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00001761 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001762
Charles Davisc7d5c942015-09-17 20:55:33 +00001763 /// Emits a call to an LLVM variable-argument intrinsic, either
1764 /// \c llvm.va_start or \c llvm.va_end.
1765 /// \param ArgValue A reference to the \c va_list as emitted by either
1766 /// \c EmitVAListRef or \c EmitMSVAListRef.
1767 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
1768 /// calls \c llvm.va_end.
1769 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
1770
1771 /// Generate code to get an argument from the passed in pointer
1772 /// and update it accordingly.
1773 /// \param VE The \c VAArgExpr for which to generate code.
1774 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
1775 /// either \c EmitVAListRef or \c EmitMSVAListRef.
1776 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001777 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001778 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00001779 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001780
John McCall82fe67b2011-07-09 01:37:26 +00001781 /// emitArrayLength - Compute the length of an array, even if it's a
1782 /// VLA, and drill down to the base element type.
1783 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1784 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001785 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00001786
John McCall23c29fe2011-06-24 21:55:10 +00001787 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1788 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001789 ///
1790 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001791 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001792
John McCall23c29fe2011-06-24 21:55:10 +00001793 /// getVLASize - Returns an LLVM value that corresponds to the size,
1794 /// in non-variably-sized elements, of a variable length array type,
1795 /// plus that largest non-variably-sized element type. Assumes that
1796 /// the type has already been emitted with EmitVariablyModifiedType.
1797 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1798 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001799
Anders Carlssona5d077d2009-04-14 16:58:56 +00001800 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1801 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001802 llvm::Value *LoadCXXThis() {
1803 assert(CXXThisValue && "no 'this' value for this function");
1804 return CXXThisValue;
1805 }
John McCall7f416cc2015-09-08 08:05:57 +00001806 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00001807
Anders Carlssone36a6b32010-01-02 01:01:18 +00001808 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1809 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001810 // FIXME: Every place that calls LoadCXXVTT is something
1811 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001812 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001813 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1814 return CXXStructorImplicitParamValue;
1815 }
1816
John McCall6ce74722010-02-16 04:15:37 +00001817 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001818 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00001819 Address
1820 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001821 const CXXRecordDecl *Derived,
1822 const CXXRecordDecl *Base,
1823 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001824
John McCall7f416cc2015-09-08 08:05:57 +00001825 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
1826
Mike Stumpe5311b02009-11-30 20:08:49 +00001827 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1828 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00001829 Address GetAddressOfBaseClass(Address Value,
1830 const CXXRecordDecl *Derived,
1831 CastExpr::path_const_iterator PathBegin,
1832 CastExpr::path_const_iterator PathEnd,
1833 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001834
John McCall7f416cc2015-09-08 08:05:57 +00001835 Address GetAddressOfDerivedClass(Address Value,
1836 const CXXRecordDecl *Derived,
1837 CastExpr::path_const_iterator PathBegin,
1838 CastExpr::path_const_iterator PathEnd,
1839 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00001840
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001841 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1842 /// base constructor/destructor with virtual bases.
1843 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1844 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1845 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1846 bool Delegating);
1847
John McCallf8ff7b92010-02-23 00:48:20 +00001848 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1849 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001850 const FunctionArgList &Args,
1851 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001852 // It's important not to confuse this and the previous function. Delegating
1853 // constructors are the C++0x feature. The constructor delegate optimization
1854 // is used to reduce duplication in the base and complete consturctors where
1855 // they are substantially the same.
1856 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1857 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001858
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001859 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001860 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001861 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001862
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001863 /// Emit assumption load for all bases. Requires to be be called only on
1864 /// most-derived class and not under construction of the object.
1865 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
1866
1867 /// Emit assumption that vptr load == global vtable.
1868 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
1869
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001870 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00001871 Address This, Address Src,
1872 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001873
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001874 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001875 const ConstantArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00001876 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001877 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001878 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001879
Anders Carlssond49844b2009-09-23 02:45:36 +00001880 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1881 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00001882 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001883 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001884 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001885
John McCall82fe67b2011-07-09 01:37:26 +00001886 static Destroyer destroyCXXObject;
1887
Anders Carlsson0a637412009-05-29 21:03:38 +00001888 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001889 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001890 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001891
John McCall99210dc2011-09-15 06:49:18 +00001892 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001893 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00001894 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00001895 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00001896
Peter Collingbourne702b2842011-11-27 22:09:22 +00001897 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00001898 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001899
David Majnemerdc012fa2015-04-22 21:38:15 +00001900 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
1901 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
1902
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001903 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001904 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001905
Eli Friedman24f55432009-11-18 00:57:03 +00001906 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1907 QualType DeleteTy);
1908
Richard Smith760520b2014-06-03 23:27:44 +00001909 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1910 const Expr *Arg, bool IsDelete);
1911
John McCall7f416cc2015-09-08 08:05:57 +00001912 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
1913 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
1914 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001915
Richard Smith69d0d262012-08-24 00:54:33 +00001916 /// \brief Situations in which we might emit a check for the suitability of a
1917 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001918 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001919 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001920 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001921 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001922 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001923 /// Checking the bound value in a reference binding. Must be suitably sized
1924 /// and aligned, but is not required to refer to an object (until the
1925 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001926 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001927 /// Checking the object expression in a non-static data member access. Must
1928 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001929 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001930 /// Checking the 'this' pointer for a call to a non-static member function.
1931 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001932 TCK_MemberCall,
1933 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001934 TCK_ConstructorCall,
1935 /// Checking the operand of a static_cast to a derived pointer type. Must be
1936 /// null or an object within its lifetime.
1937 TCK_DowncastPointer,
1938 /// Checking the operand of a static_cast to a derived reference type. Must
1939 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001940 TCK_DowncastReference,
1941 /// Checking the operand of a cast to a base object. Must be suitably sized
1942 /// and aligned.
1943 TCK_Upcast,
1944 /// Checking the operand of a cast to a virtual base object. Must be an
1945 /// object within its lifetime.
1946 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00001947 };
1948
Alexey Samsonovac4afe42014-07-07 23:59:57 +00001949 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
1950 /// calls to EmitTypeCheck can be skipped.
1951 bool sanitizePerformTypeCheck() const;
1952
Richard Smith4d1458e2012-09-08 02:08:36 +00001953 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001954 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001955 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001956 QualType Type, CharUnits Alignment = CharUnits::Zero(),
1957 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001958
Richard Smith539e4a72013-02-23 02:53:19 +00001959 /// \brief Emit a check that \p Base points into an array object, which
1960 /// we can access at index \p Index. \p Accessed should be \c false if we
1961 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1962 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1963 QualType IndexType, bool Accessed);
1964
Chris Lattner116ce8f2010-01-09 21:40:03 +00001965 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1966 bool isInc, bool isPre);
1967 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1968 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00001969
1970 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00001971 llvm::Value *OffsetValue = nullptr) {
1972 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
1973 OffsetValue);
1974 }
Hal Finkelbcc06082014-09-07 22:58:14 +00001975
Chris Lattner8394d792007-06-05 20:53:16 +00001976 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001977 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001978 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001979
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001980 /// EmitDecl - Emit a declaration.
1981 ///
1982 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001983 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001984
John McCall1c9c3fd2010-10-15 04:57:14 +00001985 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001986 ///
1987 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001988 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001989
David Blaikie73ca5692014-12-09 00:32:22 +00001990 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001991 bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00001992 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001993
John McCallbd309292010-07-06 01:34:17 +00001994 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1995 llvm::Value *Address);
1996
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001997 /// \brief Determine whether the given initializer is trivial in the sense
1998 /// that it requires no code to be generated.
1999 bool isTrivialInitializer(const Expr *Init);
2000
John McCall1c9c3fd2010-10-15 04:57:14 +00002001 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002002 ///
2003 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002004 void EmitAutoVarDecl(const VarDecl &D);
2005
2006 class AutoVarEmission {
2007 friend class CodeGenFunction;
2008
John McCall9e2e22f2011-02-22 07:16:58 +00002009 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002010
John McCall7f416cc2015-09-08 08:05:57 +00002011 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002012 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002013 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002014
2015 llvm::Value *NRVOFlag;
2016
2017 /// True if the variable is a __block variable.
2018 bool IsByRef;
2019
2020 /// True if the variable is of aggregate type and has a constant
2021 /// initializer.
2022 bool IsConstantAggregate;
2023
Nadav Rotem1da30942013-03-23 06:43:35 +00002024 /// Non-null if we should use lifetime annotations.
2025 llvm::Value *SizeForLifetimeMarkers;
2026
John McCall9e2e22f2011-02-22 07:16:58 +00002027 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002028 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002029
John McCallc533cb72011-02-22 06:44:22 +00002030 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002031 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002032 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002033 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002034
John McCall7f416cc2015-09-08 08:05:57 +00002035 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002036
2037 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002038 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2039
Craig Topper8a13c412014-05-21 05:09:00 +00002040 bool useLifetimeMarkers() const {
2041 return SizeForLifetimeMarkers != nullptr;
2042 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002043 llvm::Value *getSizeForLifetimeMarkers() const {
2044 assert(useLifetimeMarkers());
2045 return SizeForLifetimeMarkers;
2046 }
2047
2048 /// Returns the raw, allocated address, which is not necessarily
2049 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002050 Address getAllocatedAddress() const {
2051 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002052 }
2053
John McCallc533cb72011-02-22 06:44:22 +00002054 /// Returns the address of the object within this declaration.
2055 /// Note that this does not chase the forwarding pointer for
2056 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002057 Address getObjectAddress(CodeGenFunction &CGF) const {
2058 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002059
John McCall7f416cc2015-09-08 08:05:57 +00002060 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002061 }
2062 };
2063 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2064 void EmitAutoVarInit(const AutoVarEmission &emission);
2065 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002066 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2067 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002068
John McCall1c9c3fd2010-10-15 04:57:14 +00002069 void EmitStaticVarDecl(const VarDecl &D,
2070 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002071
John McCall7f416cc2015-09-08 08:05:57 +00002072 class ParamValue {
2073 llvm::Value *Value;
2074 unsigned Alignment;
2075 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2076 public:
2077 static ParamValue forDirect(llvm::Value *value) {
2078 return ParamValue(value, 0);
2079 }
2080 static ParamValue forIndirect(Address addr) {
2081 assert(!addr.getAlignment().isZero());
2082 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2083 }
2084
2085 bool isIndirect() const { return Alignment != 0; }
2086 llvm::Value *getAnyValue() const { return Value; }
2087
2088 llvm::Value *getDirectValue() const {
2089 assert(!isIndirect());
2090 return Value;
2091 }
2092
2093 Address getIndirectAddress() const {
2094 assert(isIndirect());
2095 return Address(Value, CharUnits::fromQuantity(Alignment));
2096 }
2097 };
2098
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002099 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002100 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002101
John McCallc07a0c72011-02-17 10:25:35 +00002102 /// protectFromPeepholes - Protect a value that we're intending to
2103 /// store to the side, but which will probably be used later, from
2104 /// aggressive peepholing optimizations that might delete it.
2105 ///
2106 /// Pass the result to unprotectFromPeepholes to declare that
2107 /// protection is no longer required.
2108 ///
2109 /// There's no particular reason why this shouldn't apply to
2110 /// l-values, it's just that no existing peepholes work on pointers.
2111 PeepholeProtection protectFromPeepholes(RValue rvalue);
2112 void unprotectFromPeepholes(PeepholeProtection protection);
2113
Chris Lattner84915fa2007-06-02 04:16:21 +00002114 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002115 // Statement Emission
2116 //===--------------------------------------------------------------------===//
2117
Mike Stumpfc496822009-02-08 23:14:22 +00002118 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002119 void EmitStopPoint(const Stmt *S);
2120
Mike Stumpfc496822009-02-08 23:14:22 +00002121 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2122 /// this function even if there is no current insertion point.
2123 ///
2124 /// This function may clear the current insertion point; callers should use
2125 /// EnsureInsertPoint if they wish to subsequently generate code without first
2126 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002127 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002128
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002129 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002130 /// necessarily require an insertion point or debug information; typically
2131 /// because the statement amounts to a jump or a container of other
2132 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002133 ///
2134 /// \return True if the statement was handled.
2135 bool EmitSimpleStmt(const Stmt *S);
2136
John McCall7f416cc2015-09-08 08:05:57 +00002137 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2138 AggValueSlot AVS = AggValueSlot::ignored());
2139 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2140 bool GetLast = false,
2141 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002142 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002143
Mike Stumpfc496822009-02-08 23:14:22 +00002144 /// EmitLabel - Emit the block for the given label. It is legal to call this
2145 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002146 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002147
Chris Lattnerac248202007-05-30 00:13:02 +00002148 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002149 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002150 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002151 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002152 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002153
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002154 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002155 ArrayRef<const Attr *> Attrs = None);
2156 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002157 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002158 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002159 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002160 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002161 void EmitBreakStmt(const BreakStmt &S);
2162 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002163 void EmitSwitchStmt(const SwitchStmt &S);
2164 void EmitDefaultStmt(const DefaultStmt &S);
2165 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002166 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002167 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002168
Anders Carlsson2e744e82008-08-30 19:51:14 +00002169 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002170 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2171 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002172 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002173 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002174
John McCallb609d3f2010-07-07 06:56:46 +00002175 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2176 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002177
Anders Carlsson52d78a52009-09-27 18:58:34 +00002178 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002179 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002180 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002181 void EnterSEHTryStmt(const SEHTryStmt &S);
2182 void ExitSEHTryStmt(const SEHTryStmt &S);
2183
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002184 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002185 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002186
2187 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2188 const SEHExceptStmt &Except);
2189
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002190 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2191 const SEHFinallyStmt &Finally);
2192
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002193 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2194 llvm::Value *ParentFP,
2195 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002196 llvm::Value *EmitSEHExceptionCode();
2197 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002198 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002199
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002200 /// Scan the outlined statement for captures from the parent function. For
2201 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002202 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002203 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002204 bool IsFilter);
2205
2206 /// Recovers the address of a local in a parent function. ParentVar is the
2207 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002208 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002209 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2210 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002211 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2212 Address ParentVar,
2213 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002214
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002215 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002216 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002217
Alexey Bataev1189bd02016-01-26 12:20:39 +00002218 /// Returns calculated size of the specified type.
2219 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002220 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002221 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002222 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002223 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Carlo Bertolli430d8ec2016-03-03 20:34:23 +00002224 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S,
2225 QualType ReturnQTy);
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002226 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002227 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002228 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002229 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2230 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002231 /// \brief Perform element by element copying of arrays with type \a
2232 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2233 /// generated by \a CopyGen.
2234 ///
2235 /// \param DestAddr Address of the destination array.
2236 /// \param SrcAddr Address of the source array.
2237 /// \param OriginalType Type of destination and source arrays.
2238 /// \param CopyGen Copying procedure that copies value of single array element
2239 /// to another single array element.
2240 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002241 Address DestAddr, Address SrcAddr, QualType OriginalType,
2242 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002243 /// \brief Emit proper copying of data from one variable to another.
2244 ///
2245 /// \param OriginalType Original type of the copied variables.
2246 /// \param DestAddr Destination address.
2247 /// \param SrcAddr Source address.
2248 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2249 /// type of the base array element).
2250 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2251 /// the base array element).
2252 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2253 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002254 void EmitOMPCopy(QualType OriginalType,
2255 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002256 const VarDecl *DestVD, const VarDecl *SrcVD,
2257 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002258 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2259 /// \a X = \a E \a BO \a E.
2260 ///
2261 /// \param X Value to be updated.
2262 /// \param E Update value.
2263 /// \param BO Binary operation for update operation.
2264 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2265 /// expression, false otherwise.
2266 /// \param AO Atomic ordering of the generated atomic instructions.
2267 /// \param CommonGen Code generator for complex expressions that cannot be
2268 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002269 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2270 /// generated, <false, RValue::get(nullptr)> otherwise.
2271 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002272 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2273 llvm::AtomicOrdering AO, SourceLocation Loc,
2274 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002275 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002276 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002277 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2278 OMPPrivateScope &PrivateScope);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002279 /// \brief Emit code for copyin clause in \a D directive. The next code is
2280 /// generated at the start of outlined functions for directives:
2281 /// \code
2282 /// threadprivate_var1 = master_threadprivate_var1;
2283 /// operator=(threadprivate_var2, master_threadprivate_var2);
2284 /// ...
2285 /// __kmpc_barrier(&loc, global_tid);
2286 /// \endcode
2287 ///
2288 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2289 /// \returns true if at least one copyin variable is found, false otherwise.
2290 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002291 /// \brief Emit initial code for lastprivate variables. If some variable is
2292 /// not also firstprivate, then the default initialization is used. Otherwise
2293 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2294 /// method.
2295 ///
2296 /// \param D Directive that may have 'lastprivate' directives.
2297 /// \param PrivateScope Private scope for capturing lastprivate variables for
2298 /// proper codegen in internal captured statement.
2299 ///
2300 /// \returns true if there is at least one lastprivate variable, false
2301 /// otherwise.
2302 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2303 OMPPrivateScope &PrivateScope);
2304 /// \brief Emit final copying of lastprivate values to original variables at
2305 /// the end of the worksharing or simd directive.
2306 ///
2307 /// \param D Directive that has at least one 'lastprivate' directives.
2308 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2309 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002310 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002311 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002312 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002313 /// \brief Emit initial code for reduction variables. Creates reduction copies
2314 /// and initializes them with the values according to OpenMP standard.
2315 ///
2316 /// \param D Directive (possibly) with the 'reduction' clause.
2317 /// \param PrivateScope Private scope for capturing reduction variables for
2318 /// proper codegen in internal captured statement.
2319 ///
2320 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2321 OMPPrivateScope &PrivateScope);
2322 /// \brief Emit final update of reduction values to original variables at
2323 /// the end of the directive.
2324 ///
2325 /// \param D Directive that has at least one 'reduction' directives.
2326 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002327 /// \brief Emit initial code for linear variables. Creates private copies
2328 /// and initializes them with the values according to OpenMP standard.
2329 ///
2330 /// \param D Directive (possibly) with the 'linear' clause.
2331 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002332
2333 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002334 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002335 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002336 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002337 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002338 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002339 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002340 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002341 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002342 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002343 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002344 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002345 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002346 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002347 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002348 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002349 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002350 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002351 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002352 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002353 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002354 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002355 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002356 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002357 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002358 void
2359 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002360 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002361 void
2362 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002363 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002364 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002365 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002366 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002367 void EmitOMPDistributeLoop(const OMPDistributeDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002368
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002369 /// \brief Emit inner loop of the worksharing/simd construct.
2370 ///
2371 /// \param S Directive, for which the inner loop must be emitted.
2372 /// \param RequiresCleanup true, if directive has some associated private
2373 /// variables.
2374 /// \param LoopCond Bollean condition for loop continuation.
2375 /// \param IncExpr Increment expression for loop control variable.
2376 /// \param BodyGen Generator for the inner body of the inner loop.
2377 /// \param PostIncGen Genrator for post-increment code (required for ordered
2378 /// loop directvies).
2379 void EmitOMPInnerLoop(
2380 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2381 const Expr *IncExpr,
2382 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2383 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002384
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002385 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
2386
Alexander Musmanc6388682014-12-15 07:07:06 +00002387private:
2388
2389 /// Helpers for the OpenMP loop directives.
Alexey Bataev0f34da12015-07-02 04:17:07 +00002390 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002391 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002392 void EmitOMPSimdFinal(
2393 const OMPLoopDirective &D,
2394 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev38e89532015-04-16 04:54:05 +00002395 /// \brief Emit code for the worksharing loop-based directive.
2396 /// \return true, if this construct has any lastprivate clause, false -
2397 /// otherwise.
2398 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002399 void EmitOMPOuterLoop(bool IsMonotonic, bool DynamicOrOrdered,
2400 const OMPLoopDirective &S, OMPPrivateScope &LoopScope, bool Ordered,
2401 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexander Musmandf7a8e22015-01-22 08:49:35 +00002402 void EmitOMPForOuterLoop(OpenMPScheduleClauseKind ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002403 bool IsMonotonic, const OMPLoopDirective &S,
2404 OMPPrivateScope &LoopScope, bool Ordered, Address LB,
2405 Address UB, Address ST, Address IL,
2406 llvm::Value *Chunk);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002407 void EmitOMPDistributeOuterLoop(
2408 OpenMPDistScheduleClauseKind ScheduleKind,
2409 const OMPDistributeDirective &S, OMPPrivateScope &LoopScope,
2410 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002411 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002412 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002413
2414public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002415
Chris Lattner208ae962007-05-30 17:57:17 +00002416 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002417 // LValue Expression Emission
2418 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002419
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002420 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2421 RValue GetUndefRValue(QualType Ty);
2422
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002423 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2424 /// and issue an ErrorUnsupported style diagnostic (using the
2425 /// provided Name).
2426 RValue EmitUnsupportedRValue(const Expr *E,
2427 const char *Name);
2428
Mike Stumpfc496822009-02-08 23:14:22 +00002429 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2430 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002431 LValue EmitUnsupportedLValue(const Expr *E,
2432 const char *Name);
2433
Chris Lattner8394d792007-06-05 20:53:16 +00002434 /// EmitLValue - Emit code to compute a designator that specifies the location
2435 /// of the expression.
2436 ///
2437 /// This can return one of two things: a simple address or a bitfield
2438 /// reference. In either case, the LLVM Value* in the LValue structure is
2439 /// guaranteed to be an LLVM pointer type.
2440 ///
2441 /// If this returns a bitfield reference, nothing about the pointee type of
2442 /// the LLVM value is known: For example, it may not be a pointer to an
2443 /// integer.
2444 ///
2445 /// If this returns a normal address, and if the lvalue's C type is fixed
2446 /// size, this method guarantees that the returned pointer type will point to
2447 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2448 /// variable length type, this is not possible.
2449 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002450 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002451
Richard Smith4d1458e2012-09-08 02:08:36 +00002452 /// \brief Same as EmitLValue but additionally we generate checking code to
2453 /// guard against undefined behavior. This is only suitable when we know
2454 /// that the address will be used to access the object.
2455 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002456
John McCall7f416cc2015-09-08 08:05:57 +00002457 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002458 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002459
John McCalla8ec7eb2013-03-07 21:37:17 +00002460 void EmitAtomicInit(Expr *E, LValue lvalue);
2461
David Majnemera5b195a2015-02-14 01:35:12 +00002462 bool LValueIsSuitableForInlineAtomic(LValue Src);
2463 bool typeIsSuitableForInlineAtomic(QualType Ty, bool IsVolatile) const;
2464
2465 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2466 AggValueSlot Slot = AggValueSlot::ignored());
2467
Nick Lewycky2d84e842013-10-02 02:29:49 +00002468 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002469 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002470 AggValueSlot slot = AggValueSlot::ignored());
2471
2472 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2473
David Majnemera5b195a2015-02-14 01:35:12 +00002474 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2475 bool IsVolatile, bool isInit);
2476
Alexey Bataevb4505a72015-03-30 05:20:59 +00002477 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002478 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
2479 llvm::AtomicOrdering Success = llvm::SequentiallyConsistent,
2480 llvm::AtomicOrdering Failure = llvm::SequentiallyConsistent,
2481 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2482
Alexey Bataevb4505a72015-03-30 05:20:59 +00002483 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002484 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002485 bool IsVolatile);
2486
John McCall3a7f6922010-10-27 20:58:56 +00002487 /// EmitToMemory - Change a scalar value from its value
2488 /// representation to its in-memory representation.
2489 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2490
2491 /// EmitFromMemory - Change a scalar value from its memory
2492 /// representation to its value representation.
2493 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2494
Daniel Dunbar1d425462009-02-10 00:57:50 +00002495 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2496 /// care to appropriately convert from the memory representation to
2497 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002498 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002499 SourceLocation Loc,
John McCall7f416cc2015-09-08 08:05:57 +00002500 AlignmentSource AlignSource =
2501 AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002502 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002503 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002504 uint64_t TBAAOffset = 0,
2505 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002506
2507 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2508 /// care to appropriately convert from the memory representation to
2509 /// the LLVM value representation. The l-value must be a simple
2510 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002511 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002512
2513 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2514 /// care to appropriately convert from the memory representation to
2515 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002516 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
2517 bool Volatile, QualType Ty,
2518 AlignmentSource AlignSource = AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002519 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002520 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002521 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002522
2523 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2524 /// care to appropriately convert from the memory representation to
2525 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002526 /// l-value. The isInit flag indicates whether this is an initialization.
2527 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2528 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002529
Chris Lattner8394d792007-06-05 20:53:16 +00002530 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2531 /// this method emits the address of the lvalue, then loads the result as an
2532 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002533 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002534 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2535 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002536 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002537
Chris Lattner8394d792007-06-05 20:53:16 +00002538 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2539 /// lvalue, where both are guaranteed to the have the same type, and that type
2540 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002541 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002542 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002543 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002544
Nick Lewycky2d84e842013-10-02 02:29:49 +00002545 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2546 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002547 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002548 /// \param Result [out] - If non-null, this will be set to a Value* for the
2549 /// bit-field contents after the store, appropriate for use as the result of
2550 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002551 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002552 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002553
John McCall4f29b492010-11-16 23:07:28 +00002554 /// Emit an l-value for an assignment (simple or compound) of complex type.
2555 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002556 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002557 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2558 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002559
Chris Lattner57540c52011-04-15 05:22:18 +00002560 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002561 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002562 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002563 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002564 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002565 // Note: only available for agg return types
2566 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002567 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002568 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002569 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002570 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002571 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002572 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2573 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00002574 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
2575 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002576 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002577 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002578 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002579 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002580 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002581 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002582 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002583 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002584 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002585
John McCall7f416cc2015-09-08 08:05:57 +00002586 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002587
Nick Lewycky2d84e842013-10-02 02:29:49 +00002588 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002589
John McCall7f416cc2015-09-08 08:05:57 +00002590 Address EmitArrayToPointerDecay(const Expr *Array,
2591 AlignmentSource *AlignSource = nullptr);
2592
John McCall71335052012-03-10 03:05:10 +00002593 class ConstantEmission {
2594 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2595 ConstantEmission(llvm::Constant *C, bool isReference)
2596 : ValueAndIsReference(C, isReference) {}
2597 public:
2598 ConstantEmission() {}
2599 static ConstantEmission forReference(llvm::Constant *C) {
2600 return ConstantEmission(C, true);
2601 }
2602 static ConstantEmission forValue(llvm::Constant *C) {
2603 return ConstantEmission(C, false);
2604 }
2605
Aaron Ballman67347662015-02-15 22:00:28 +00002606 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002607 return ValueAndIsReference.getOpaqueValue() != nullptr;
2608 }
John McCall71335052012-03-10 03:05:10 +00002609
2610 bool isReference() const { return ValueAndIsReference.getInt(); }
2611 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2612 assert(isReference());
2613 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2614 refExpr->getType());
2615 }
2616
2617 llvm::Constant *getValue() const {
2618 assert(!isReference());
2619 return ValueAndIsReference.getPointer();
2620 }
2621 };
2622
John McCall113bee02012-03-10 09:33:50 +00002623 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002624
John McCallfe96e0b2011-11-06 09:01:30 +00002625 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2626 AggValueSlot slot = AggValueSlot::ignored());
2627 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2628
Daniel Dunbar722f4242009-04-22 05:08:15 +00002629 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002630 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002631 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002632 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002633
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002634 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2635 /// if the Field is a reference, this will return the address of the reference
2636 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002637 LValue EmitLValueForFieldInitialization(LValue Base,
2638 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002639
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002640 LValue EmitLValueForIvar(QualType ObjectTy,
2641 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002642 unsigned CVRQualifiers);
2643
Anders Carlsson3be22e22009-05-30 23:23:33 +00002644 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002645 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002646 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002647 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002648 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002649
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002650 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002651 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002652 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002653 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002654 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002655 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002656
Chris Lattnerd7f58862007-06-02 05:24:33 +00002657 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002658 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002659 //===--------------------------------------------------------------------===//
2660
Mike Stumpfc496822009-02-08 23:14:22 +00002661 /// EmitCall - Generate a call of the given function, expecting the given
2662 /// result type, and using the given argument list which specifies both the
2663 /// LLVM arguments and the types they were derived from.
Samuel Antao798f11c2015-11-23 22:04:44 +00002664 RValue EmitCall(const CGFunctionInfo &FnInfo, llvm::Value *Callee,
2665 ReturnValueSlot ReturnValue, const CallArgList &Args,
2666 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Craig Topper8a13c412014-05-21 05:09:00 +00002667 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002668
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002669 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002670 ReturnValueSlot ReturnValue,
Samuel Antao798f11c2015-11-23 22:04:44 +00002671 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Peter Collingbournef7706832014-12-12 23:41:25 +00002672 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002673 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002674 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002675
Eric Christopherc7e79db2015-11-12 00:44:04 +00002676 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00002677
John McCall882987f2013-02-28 19:01:20 +00002678 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2679 const Twine &name = "");
2680 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2681 ArrayRef<llvm::Value*> args,
2682 const Twine &name = "");
2683 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2684 const Twine &name = "");
2685 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2686 ArrayRef<llvm::Value*> args,
2687 const Twine &name = "");
2688
John McCallbd309292010-07-06 01:34:17 +00002689 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002690 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002691 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002692 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2693 ArrayRef<llvm::Value*> args,
2694 const Twine &name = "");
2695 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2696 const Twine &name = "");
2697 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2698 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002699
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002700 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2701 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002702 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002703
2704 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2705 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002706 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002707
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002708 RValue
2709 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2710 ReturnValueSlot ReturnValue, llvm::Value *This,
2711 llvm::Value *ImplicitParam,
2712 QualType ImplicitParamTy, const CallExpr *E);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00002713 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD, llvm::Value *Callee,
2714 llvm::Value *This, llvm::Value *ImplicitParam,
2715 QualType ImplicitParamTy, const CallExpr *E,
2716 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002717 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2718 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002719 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2720 const CXXMethodDecl *MD,
2721 ReturnValueSlot ReturnValue,
2722 bool HasQualifier,
2723 NestedNameSpecifier *Qualifier,
2724 bool IsArrow, const Expr *Base);
2725 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002726 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
2727 llvm::Value *memberPtr,
2728 const MemberPointerType *memberPtrType,
2729 AlignmentSource *AlignSource = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002730 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2731 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002732
Anders Carlsson4034a952009-05-27 04:18:27 +00002733 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002734 const CXXMethodDecl *MD,
2735 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002736
Peter Collingbournefe883422011-10-06 18:29:37 +00002737 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2738 ReturnValueSlot ReturnValue);
2739
Justin Lebar3039a592016-01-23 21:28:14 +00002740 RValue EmitCUDADevicePrintfCallExpr(const CallExpr *E,
2741 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002742
Mike Stump11289f42009-09-09 15:08:12 +00002743 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002744 unsigned BuiltinID, const CallExpr *E,
2745 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002746
Anders Carlssonbfb36712009-12-24 21:13:40 +00002747 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002748
Mike Stumpfc496822009-02-08 23:14:22 +00002749 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2750 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002751 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2752
Kevin Qin1718af62013-11-14 02:45:18 +00002753 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2754 const llvm::CmpInst::Predicate Fp,
2755 const llvm::CmpInst::Predicate Ip,
2756 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002757 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002758
2759 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2760 unsigned LLVMIntrinsic,
2761 unsigned AltLLVMIntrinsic,
2762 const char *NameHint,
2763 unsigned Modifier,
2764 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002765 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00002766 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00002767 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2768 unsigned Modifier, llvm::Type *ArgTy,
2769 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002770 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002771 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002772 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002773 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002774 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002775 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002776 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002777 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2778 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00002779 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00002780 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002781
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002782 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002783 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2784 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00002785 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00002786 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00002787 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00002788 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
2789 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002790
Daniel Dunbar66912a12008-08-20 00:28:19 +00002791 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002792 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002793 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002794 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2795 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2796 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002797 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002798 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002799 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2800 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002801
John McCall31168b02011-06-15 23:02:42 +00002802 /// Retrieves the default cleanup kind for an ARC cleanup.
2803 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2804 CleanupKind getARCCleanupKind() {
2805 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2806 ? NormalAndEHCleanup : NormalCleanup;
2807 }
2808
2809 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00002810 void EmitARCInitWeak(Address addr, llvm::Value *value);
2811 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00002812 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00002813 llvm::Value *EmitARCLoadWeakRetained(Address addr);
2814 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
2815 void EmitARCCopyWeak(Address dst, Address src);
2816 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00002817 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2818 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002819 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002820 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00002821 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002822 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002823 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00002824 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002825 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00002826 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00002827 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00002828 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00002829 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2830 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2831 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00002832 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00002833
2834 std::pair<LValue,llvm::Value*>
2835 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2836 std::pair<LValue,llvm::Value*>
2837 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00002838 std::pair<LValue,llvm::Value*>
2839 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00002840
John McCall248512a2011-10-01 10:32:24 +00002841 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002842 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2843 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2844
John McCallff613032011-10-04 06:23:45 +00002845 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00002846 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
2847 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00002848 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2849 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00002850 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002851
Craig Topper00bbdcf2014-06-28 23:22:23 +00002852 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002853
John McCall82fe67b2011-07-09 01:37:26 +00002854 static Destroyer destroyARCStrongImprecise;
2855 static Destroyer destroyARCStrongPrecise;
2856 static Destroyer destroyARCWeak;
2857
John McCall31168b02011-06-15 23:02:42 +00002858 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2859 llvm::Value *EmitObjCAutoreleasePoolPush();
2860 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2861 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2862 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2863
Richard Smitha1c9d4d2013-06-12 23:38:09 +00002864 /// \brief Emits a reference binding to the passed in expression.
2865 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002866
Chris Lattner6278e6a2007-08-11 00:04:45 +00002867 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002868 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002869 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002870
2871 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002872
2873 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2874 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002875 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002876
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00002877 /// Emit a conversion from the specified type to the specified destination
2878 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00002879 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00002880 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00002881
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00002882 /// Emit a conversion from the specified complex type to the specified
2883 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002884 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00002885 QualType DstTy,
2886 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00002887
John McCall7a626f62010-09-15 10:14:12 +00002888 /// EmitAggExpr - Emit the computation of the specified expression
2889 /// of aggregate type. The result is computed into the given slot,
2890 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002891 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002892
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002893 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2894 /// aggregate type into a temporary LValue.
2895 LValue EmitAggExprToLValue(const Expr *E);
2896
John McCall1bd25562011-06-24 23:21:27 +00002897 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2898 /// make sure it survives garbage collection until this point.
2899 void EmitExtendGCLifetime(llvm::Value *object);
2900
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002901 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002902 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002903 ComplexPairTy EmitComplexExpr(const Expr *E,
2904 bool IgnoreReal = false,
2905 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002906
John McCall47fb9502013-03-07 21:37:08 +00002907 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2908 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002909 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002910
John McCall47fb9502013-03-07 21:37:08 +00002911 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002912 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00002913
2914 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002915 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002916
John McCall7f416cc2015-09-08 08:05:57 +00002917 Address emitAddrOfRealComponent(Address complex, QualType complexType);
2918 Address emitAddrOfImagComponent(Address complex, QualType complexType);
2919
Chandler Carruth84537952012-03-30 19:44:53 +00002920 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2921 /// global variable that has already been created for it. If the initializer
2922 /// has a different type than GV does, this may free GV and return a different
2923 /// one. Otherwise it just returns GV.
2924 llvm::GlobalVariable *
2925 AddInitializerToStaticVarDecl(const VarDecl &D,
2926 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002927
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002928
Anders Carlssonf40886a2009-08-08 21:45:14 +00002929 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2930 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002931 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2932 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002933
David Majnemerb3341ea2014-10-05 05:05:40 +00002934 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
2935 llvm::Constant *Addr);
2936
John McCallc84ed6a2012-05-01 06:13:13 +00002937 /// Call atexit() with a function that passes the given argument to
2938 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00002939 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2940 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002941
John McCallcdf7ef52010-11-06 09:44:32 +00002942 /// Emit code in this function to perform a guarded variable
2943 /// initialization. Guarded initializations are used when it's not
2944 /// possible to prove that an initialization will be done exactly
2945 /// once, e.g. with a static local variable or a static data member
2946 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002947 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002948 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002949
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002950 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2951 /// variables.
2952 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00002953 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00002954 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002955
John McCallee08c532012-04-06 18:21:03 +00002956 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002957 /// variables.
John McCallee08c532012-04-06 18:21:03 +00002958 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2959 const std::vector<std::pair<llvm::WeakVH,
2960 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002961
John McCalla738c252011-03-09 04:27:21 +00002962 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2963 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00002964 llvm::GlobalVariable *Addr,
2965 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002966
John McCall7a626f62010-09-15 10:14:12 +00002967 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002968
John McCall7f416cc2015-09-08 08:05:57 +00002969 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00002970
John McCall08ef4662011-11-10 08:15:53 +00002971 void enterFullExpression(const ExprWithCleanups *E) {
2972 if (E->getNumObjects() == 0) return;
2973 enterNonTrivialFullExpression(E);
2974 }
2975 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00002976
Richard Smithea852322013-05-07 21:53:22 +00002977 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00002978
Eli Friedmanc370a7e2012-02-09 03:32:31 +00002979 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2980
Tim Northovercc2a6e02015-11-09 19:56:35 +00002981 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00002982
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002983 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002984 // Annotations Emission
2985 //===--------------------------------------------------------------------===//
2986
2987 /// Emit an annotation call (intrinsic or builtin).
2988 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2989 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002990 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002991 SourceLocation Location);
2992
2993 /// Emit local annotations for the local variable V, declared by D.
2994 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2995
2996 /// Emit field annotations for the given field & value. Returns the
2997 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00002998 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002999
3000 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003001 // Internal Helpers
3002 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003003
Chris Lattner5b1964b2008-11-11 07:41:27 +00003004 /// ContainsLabel - Return true if the statement contains a label in it. If
3005 /// this statement is not executed normally, it not containing a label means
3006 /// that we can just remove the code.
3007 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003008
Chris Lattner29911cc2011-02-28 00:18:40 +00003009 /// containsBreak - Return true if the statement contains a break out of it.
3010 /// If the statement (recursively) contains a switch or loop with a break
3011 /// inside of it, this is fine.
3012 static bool containsBreak(const Stmt *S);
3013
Daniel Dunbar682712c2008-11-12 10:12:14 +00003014 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003015 /// to a constant, or if it does but contains a label, return false. If it
3016 /// constant folds return true and set the boolean result in Result.
3017 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00003018
Chris Lattner29911cc2011-02-28 00:18:40 +00003019 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3020 /// to a constant, or if it does but contains a label, return false. If it
3021 /// constant folds return true and set the folded value.
Richard Trieuc320c742012-07-23 20:21:35 +00003022 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattner29911cc2011-02-28 00:18:40 +00003023
Chris Lattnercd439292008-11-12 08:04:58 +00003024 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3025 /// if statement) to the specified blocks. Based on the condition, this might
3026 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003027 /// TrueCount should be the number of times we expect the condition to
3028 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003029 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003030 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003031
Richard Smithe30752c2012-10-09 19:52:38 +00003032 /// \brief Emit a description of a type in a format suitable for passing to
3033 /// a runtime sanitizer handler.
3034 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3035
3036 /// \brief Convert a value into a format suitable for passing to a runtime
3037 /// sanitizer handler.
3038 llvm::Value *EmitCheckValue(llvm::Value *V);
3039
3040 /// \brief Emit a description of a source location in a format suitable for
3041 /// passing to a runtime sanitizer handler.
3042 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3043
Richard Smithde670682012-11-01 22:15:34 +00003044 /// \brief Create a basic block that will call a handler function in a
3045 /// sanitizer runtime with the provided arguments, and create a conditional
3046 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003047 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003048 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
3049 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003050
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003051 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3052 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003053 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3054 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3055 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003056
Richard Smithde670682012-11-01 22:15:34 +00003057 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3058 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003059 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003060
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003061 /// \brief Emit a call to trap or debugtrap and attach function attribute
3062 /// "trap-func-name" if specified.
3063 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3064
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003065 /// \brief Emit a cross-DSO CFI failure handling function.
3066 void EmitCfiCheckFail();
3067
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003068 /// \brief Create a check for a function parameter that may potentially be
3069 /// declared as non-null.
3070 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
3071 const FunctionDecl *FD, unsigned ParmNum);
3072
Anders Carlsson093bdff2010-03-30 03:27:09 +00003073 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003074 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003075
John McCall23f66262010-05-26 22:34:26 +00003076 /// EmitDelegateCallArg - We are performing a delegate call; that
3077 /// is, the current function is delegating to another one. Produce
3078 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003079 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3080 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003081
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003082 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3083 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003084 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003085
Chris Lattnercd439292008-11-12 08:04:58 +00003086private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003087 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003088 void EmitReturnOfRValue(RValue RV, QualType Ty);
3089
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003090 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3091
3092 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3093 DeferredReplacements;
3094
John McCall7f416cc2015-09-08 08:05:57 +00003095 /// Set the address of a local variable.
3096 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3097 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3098 LocalDeclMap.insert({VD, Addr});
3099 }
3100
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003101 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3102 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3103 ///
3104 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003105 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
3106 SmallVectorImpl<llvm::Argument *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003107
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003108 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3109 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3110 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3111 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3112 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3113 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003114
Chad Rosier59df25b2012-08-23 20:00:18 +00003115 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003116 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003117
Chad Rosier59df25b2012-08-23 20:00:18 +00003118 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003119 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003120 std::string &ConstraintStr,
3121 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003122
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003123 /// \brief Attempts to statically evaluate the object size of E. If that
3124 /// fails, emits code to figure the size of E out for us. This is
3125 /// pass_object_size aware.
3126 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
3127 llvm::IntegerType *ResType);
3128
3129 /// \brief Emits the size of E, as required by __builtin_object_size. This
3130 /// function is aware of pass_object_size parameters, and will act accordingly
3131 /// if E is a parameter with the pass_object_size attribute.
3132 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
3133 llvm::IntegerType *ResType);
3134
Reid Kleckner89077a12013-12-17 19:46:40 +00003135public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003136#ifndef NDEBUG
3137 // Determine whether the given argument is an Objective-C method
3138 // that may have type parameters in its signature.
3139 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3140 const DeclContext *dc = method->getDeclContext();
3141 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3142 return classDecl->getTypeParamListAsWritten();
3143 }
3144
3145 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3146 return catDecl->getTypeParamList();
3147 }
3148
3149 return false;
3150 }
3151
3152 template<typename T>
3153 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3154#endif
3155
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003156 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003157 template <typename T>
3158 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003159 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003160 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00003161 unsigned ParamsToSkip = 0) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003162 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003163 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003164
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003165 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3166 "Can't skip parameters if type info is not provided");
3167 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003168#ifndef NDEBUG
3169 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3170#endif
3171
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003172 // First, use the argument types that the type info knows about
3173 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3174 E = CallArgTypeInfo->param_type_end();
3175 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003176 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003177 assert((isGenericMethod ||
3178 ((*I)->isVariablyModifiedType() ||
3179 (*I).getNonReferenceType()->isObjCRetainableType() ||
3180 getContext()
3181 .getCanonicalType((*I).getNonReferenceType())
3182 .getTypePtr() ==
3183 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003184 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003185 .getTypePtr())) &&
3186 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003187 ArgTypes.push_back(*I);
3188 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003189 }
Mike Stump11289f42009-09-09 15:08:12 +00003190
Reid Kleckner739756c2013-12-04 19:23:12 +00003191 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003192 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003193 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3194 CallArgTypeInfo->isVariadic()) &&
3195 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003196
Anders Carlsson603d6af2009-04-18 20:20:22 +00003197 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003198 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
3199 ArgTypes.push_back(getVarArgType(A));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003200
David Blaikief05779e2015-07-21 18:37:18 +00003201 EmitCallArgs(Args, ArgTypes, ArgRange, CalleeDecl, ParamsToSkip);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003202 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003203
Reid Kleckner739756c2013-12-04 19:23:12 +00003204 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003205 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003206 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00003207 unsigned ParamsToSkip = 0);
Reid Kleckner739756c2013-12-04 19:23:12 +00003208
John McCall7f416cc2015-09-08 08:05:57 +00003209 /// EmitPointerWithAlignment - Given an expression with a pointer
3210 /// type, emit the value and compute our best estimate of the
3211 /// alignment of the pointee.
3212 ///
3213 /// Note that this function will conservatively fall back on the type
3214 /// when it doesn't
3215 ///
3216 /// \param Source - If non-null, this will be initialized with
3217 /// information about the source of the alignment. Note that this
3218 /// function will conservatively fall back on the type when it
3219 /// doesn't recognize the expression, which means that sometimes
3220 ///
3221 /// a worst-case One
3222 /// reasonable way to use this information is when there's a
3223 /// language guarantee that the pointer must be aligned to some
3224 /// stricter value, and we're simply trying to ensure that
3225 /// sufficiently obvious uses of under-aligned objects don't get
3226 /// miscompiled; for example, a placement new into the address of
3227 /// a local variable. In such a case, it's quite reasonable to
3228 /// just ignore the returned alignment when it isn't from an
3229 /// explicit source.
3230 Address EmitPointerWithAlignment(const Expr *Addr,
3231 AlignmentSource *Source = nullptr);
3232
Peter Collingbournedc134532016-01-16 00:31:22 +00003233 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3234
Reid Kleckner89077a12013-12-17 19:46:40 +00003235private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003236 QualType getVarArgType(const Expr *Arg);
3237
John McCalld4f4b7f2010-03-03 04:15:11 +00003238 const TargetCodeGenInfo &getTargetHooks() const {
3239 return CGM.getTargetCodeGenInfo();
3240 }
John McCall09ae0322010-07-06 23:57:41 +00003241
3242 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003243
John McCall7f416cc2015-09-08 08:05:57 +00003244 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3245 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003246
3247 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003248
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003249 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003250};
Mike Stump11289f42009-09-09 15:08:12 +00003251
John McCallce1de612011-01-26 04:00:11 +00003252/// Helper class with most of the code for saving a value for a
3253/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003254struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003255 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3256
3257 /// Answer whether the given value needs extra work to be saved.
3258 static bool needsSaving(llvm::Value *value) {
3259 // If it's not an instruction, we don't need to save.
3260 if (!isa<llvm::Instruction>(value)) return false;
3261
3262 // If it's an instruction in the entry block, we don't need to save.
3263 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3264 return (block != &block->getParent()->getEntryBlock());
3265 }
3266
3267 /// Try to save the given value.
3268 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3269 if (!needsSaving(value)) return saved_type(value, false);
3270
John McCall7f416cc2015-09-08 08:05:57 +00003271 // Otherwise, we need an alloca.
3272 auto align = CharUnits::fromQuantity(
3273 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3274 Address alloca =
3275 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003276 CGF.Builder.CreateStore(value, alloca);
3277
John McCall7f416cc2015-09-08 08:05:57 +00003278 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003279 }
3280
3281 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003282 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003283 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003284
3285 // Otherwise, it should be an alloca instruction, as set up in save().
3286 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3287 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003288 }
3289};
3290
John McCallcb5f77f2011-01-28 10:53:53 +00003291/// A partial specialization of DominatingValue for llvm::Values that
3292/// might be llvm::Instructions.
3293template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3294 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003295 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003296 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3297 }
3298};
3299
John McCall7f416cc2015-09-08 08:05:57 +00003300/// A specialization of DominatingValue for Address.
3301template <> struct DominatingValue<Address> {
3302 typedef Address type;
3303
3304 struct saved_type {
3305 DominatingLLVMValue::saved_type SavedValue;
3306 CharUnits Alignment;
3307 };
3308
3309 static bool needsSaving(type value) {
3310 return DominatingLLVMValue::needsSaving(value.getPointer());
3311 }
3312 static saved_type save(CodeGenFunction &CGF, type value) {
3313 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3314 value.getAlignment() };
3315 }
3316 static type restore(CodeGenFunction &CGF, saved_type value) {
3317 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3318 value.Alignment);
3319 }
3320};
3321
John McCallcb5f77f2011-01-28 10:53:53 +00003322/// A specialization of DominatingValue for RValue.
3323template <> struct DominatingValue<RValue> {
3324 typedef RValue type;
3325 class saved_type {
3326 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3327 AggregateAddress, ComplexAddress };
3328
3329 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003330 unsigned K : 3;
3331 unsigned Align : 29;
3332 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3333 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003334
3335 public:
3336 static bool needsSaving(RValue value);
3337 static saved_type save(CodeGenFunction &CGF, RValue value);
3338 RValue restore(CodeGenFunction &CGF);
3339
John McCall7f416cc2015-09-08 08:05:57 +00003340 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003341 };
3342
3343 static bool needsSaving(type value) {
3344 return saved_type::needsSaving(value);
3345 }
3346 static saved_type save(CodeGenFunction &CGF, type value) {
3347 return saved_type::save(CGF, value);
3348 }
3349 static type restore(CodeGenFunction &CGF, saved_type value) {
3350 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003351 }
3352};
3353
Chris Lattnerbed31442007-05-28 01:07:47 +00003354} // end namespace CodeGen
3355} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003356
Chris Lattnerbed31442007-05-28 01:07:47 +00003357#endif