blob: 802386b51067e9b79247bc749c247c43353935ee [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"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000039
Chris Lattnerbed31442007-05-28 01:07:47 +000040namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000041class BasicBlock;
42class LLVMContext;
43class MDNode;
44class Module;
45class SwitchInst;
46class Twine;
47class Value;
48class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000049}
50
Chris Lattnerbed31442007-05-28 01:07:47 +000051namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000052class ASTContext;
53class BlockDecl;
54class CXXDestructorDecl;
55class CXXForRangeStmt;
56class CXXTryStmt;
57class Decl;
58class LabelDecl;
59class EnumConstantDecl;
60class FunctionDecl;
61class FunctionProtoType;
62class LabelStmt;
63class ObjCContainerDecl;
64class ObjCInterfaceDecl;
65class ObjCIvarDecl;
66class ObjCMethodDecl;
67class ObjCImplementationDecl;
68class ObjCPropertyImplDecl;
69class TargetInfo;
70class TargetCodeGenInfo;
71class VarDecl;
72class ObjCForCollectionStmt;
73class ObjCAtTryStmt;
74class ObjCAtThrowStmt;
75class ObjCAtSynchronizedStmt;
76class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000077
Chris Lattnerbed31442007-05-28 01:07:47 +000078namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000079class CodeGenTypes;
80class CGFunctionInfo;
81class CGRecordLayout;
82class CGBlockInfo;
83class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000084class BlockByrefHelpers;
85class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000086class BlockFlags;
87class BlockFieldFlags;
Mike Stumpfc496822009-02-08 23:14:22 +000088
John McCall47fb9502013-03-07 21:37:08 +000089/// The kind of evaluation to perform on values of a particular
90/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
91/// CGExprAgg?
92///
93/// TODO: should vectors maybe be split out into their own thing?
94enum TypeEvaluationKind {
95 TEK_Scalar,
96 TEK_Complex,
97 TEK_Aggregate
98};
99
Chris Lattnerbed31442007-05-28 01:07:47 +0000100/// CodeGenFunction - This class organizes the per-function state that is used
101/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000102class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000103 CodeGenFunction(const CodeGenFunction &) = delete;
104 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000105
106 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000107public:
John McCallad5d61e2010-07-23 21:56:41 +0000108 /// A jump destination is an abstract label, branching to which may
109 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000110 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000111 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000112 JumpDest(llvm::BasicBlock *Block,
113 EHScopeStack::stable_iterator Depth,
114 unsigned Index)
115 : Block(Block), ScopeDepth(Depth), Index(Index) {}
116
Craig Topper8a13c412014-05-21 05:09:00 +0000117 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000118 llvm::BasicBlock *getBlock() const { return Block; }
119 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
120 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000121
Nadav Rotem1da30942013-03-23 06:43:35 +0000122 // This should be used cautiously.
123 void setScopeDepth(EHScopeStack::stable_iterator depth) {
124 ScopeDepth = depth;
125 }
126
John McCallad5d61e2010-07-23 21:56:41 +0000127 private:
John McCallbd309292010-07-06 01:34:17 +0000128 llvm::BasicBlock *Block;
129 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000130 unsigned Index;
131 };
132
Chris Lattnerbed31442007-05-28 01:07:47 +0000133 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000134 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000135
Chris Lattner96d72562007-08-21 16:57:55 +0000136 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000137 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000138 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000139
Alexander Musman515ad8c2014-05-22 08:54:05 +0000140 /// \brief CGBuilder insert helper. This function is called after an
141 /// instruction is created using Builder.
142 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
143 llvm::BasicBlock *BB,
144 llvm::BasicBlock::iterator InsertPt) const;
145
John McCalldec348f72013-05-03 07:33:41 +0000146 /// CurFuncDecl - Holds the Decl for the current outermost
147 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000148 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000149 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
150 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000151 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000152 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000153 llvm::Function *CurFn;
154
Mike Stumpbee78dd2009-12-04 23:26:17 +0000155 /// CurGD - The GlobalDecl for the current function being compiled.
156 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000157
John McCall31168b02011-06-15 23:02:42 +0000158 /// PrologueCleanupDepth - The cleanup depth enclosing all the
159 /// cleanups associated with the parameters.
160 EHScopeStack::stable_iterator PrologueCleanupDepth;
161
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000162 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000163 JumpDest ReturnBlock;
164
John McCall7f416cc2015-09-08 08:05:57 +0000165 /// ReturnValue - The temporary alloca to hold the return
166 /// value. This is invalid iff the function has no return value.
167 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000168
Chris Lattner03df1222007-06-02 04:53:11 +0000169 /// AllocaInsertPoint - This is an instruction in the entry block before which
170 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000171 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000172
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000173 /// \brief API for captured statement code generation.
174 class CGCapturedStmtInfo {
175 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000176 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
177 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000178 explicit CGCapturedStmtInfo(const CapturedStmt &S,
179 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000180 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000181
182 RecordDecl::field_iterator Field =
183 S.getCapturedRecordDecl()->field_begin();
184 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
185 E = S.capture_end();
186 I != E; ++I, ++Field) {
187 if (I->capturesThis())
188 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000189 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000190 CaptureFields[I->getCapturedVar()] = *Field;
191 }
192 }
193
194 virtual ~CGCapturedStmtInfo();
195
196 CapturedRegionKind getKind() const { return Kind; }
197
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000198 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000199 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000200 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000201
202 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000203 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000204 return CaptureFields.lookup(VD);
205 }
206
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000207 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
208 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000209
Alexey Bataev18095712014-10-10 12:19:54 +0000210 static bool classof(const CGCapturedStmtInfo *) {
211 return true;
212 }
213
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000214 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000215 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000216 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000217 CGF.EmitStmt(S);
218 }
219
220 /// \brief Get the name of the capture helper.
221 virtual StringRef getHelperName() const { return "__captured_stmt"; }
222
223 private:
224 /// \brief The kind of captured statement being generated.
225 CapturedRegionKind Kind;
226
227 /// \brief Keep the map between VarDecl and FieldDecl.
228 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
229
230 /// \brief The base address of the captured record, passed in as the first
231 /// argument of the parallel region function.
232 llvm::Value *ThisValue;
233
234 /// \brief Captured 'this' type.
235 FieldDecl *CXXThisFieldDecl;
236 };
237 CGCapturedStmtInfo *CapturedStmtInfo;
238
Alexey Bataevd157d472015-06-24 03:35:38 +0000239 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
240 class CGCapturedStmtRAII {
241 private:
242 CodeGenFunction &CGF;
243 CGCapturedStmtInfo *PrevCapturedStmtInfo;
244 public:
245 CGCapturedStmtRAII(CodeGenFunction &CGF,
246 CGCapturedStmtInfo *NewCapturedStmtInfo)
247 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
248 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
249 }
250 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
251 };
252
Alexey Samsonova0416102014-11-11 01:26:14 +0000253 /// \brief Sanitizers enabled for this function.
254 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000255
Alexey Samsonov24cad992014-07-17 18:46:27 +0000256 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
257 bool IsSanitizerScope;
258
259 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
260 class SanitizerScope {
261 CodeGenFunction *CGF;
262 public:
263 SanitizerScope(CodeGenFunction *CGF);
264 ~SanitizerScope();
265 };
266
Reid Kleckner19819442014-07-25 21:39:46 +0000267 /// In C++, whether we are code generating a thunk. This controls whether we
268 /// should emit cleanups.
269 bool CurFuncIsThunk;
270
John McCall31168b02011-06-15 23:02:42 +0000271 /// In ARC, whether we should autorelease the return value.
272 bool AutoreleaseResult;
273
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000274 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
275 /// potentially set the return value.
276 bool SawAsmBlock;
277
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000278 /// True if the current function is an outlined SEH helper. This can be a
279 /// finally block or filter expression.
280 bool IsOutlinedSEHHelper;
281
Reid Klecknera002bd52015-10-28 23:06:42 +0000282 bool IsCleanupPadScope = false;
283
John McCallad7c5c12011-02-08 08:22:06 +0000284 const CodeGen::CGBlockInfo *BlockInfo;
285 llvm::Value *BlockPointer;
286
Eli Friedman9fbeba02012-02-11 02:57:39 +0000287 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
288 FieldDecl *LambdaThisCaptureField;
289
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000290 /// \brief A mapping from NRVO variables to the flags used to indicate
291 /// when the NRVO has been applied to this variable.
292 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000293
John McCallbd309292010-07-06 01:34:17 +0000294 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000295 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000296 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000297
298 /// Header for data within LifetimeExtendedCleanupStack.
299 struct LifetimeExtendedCleanupHeader {
300 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000301 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000302 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000303 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000304
Justin Bognerbdff2192015-07-01 00:59:27 +0000305 size_t getSize() const { return Size; }
306 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000307 };
John McCallbd309292010-07-06 01:34:17 +0000308
John McCallad5d61e2010-07-23 21:56:41 +0000309 /// i32s containing the indexes of the cleanup destinations.
310 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000311
312 unsigned NextCleanupDestIndex;
313
John McCall08ef4662011-11-10 08:15:53 +0000314 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
315 CGBlockInfo *FirstBlockInfo;
316
John McCall8e4c74b2011-08-11 02:22:43 +0000317 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
318 llvm::BasicBlock *EHResumeBlock;
319
Bill Wendlingf0724e82011-09-19 20:31:14 +0000320 /// The exception slot. All landing pads write the current exception pointer
321 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000322 llvm::Value *ExceptionSlot;
323
Bill Wendlingf0724e82011-09-19 20:31:14 +0000324 /// The selector slot. Under the MandatoryCleanup model, all landing pads
325 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000326 llvm::AllocaInst *EHSelectorSlot;
327
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000328 /// A stack of exception code slots. Entering an __except block pushes a slot
329 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
330 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000331 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000332
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000333 /// Value returned by __exception_info intrinsic.
334 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000335
John McCallbd309292010-07-06 01:34:17 +0000336 /// Emits a landing pad for the current EH stack.
337 llvm::BasicBlock *EmitLandingPad();
338
339 llvm::BasicBlock *getInvokeDestImpl();
340
John McCallce1de612011-01-26 04:00:11 +0000341 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000342 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
343 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000344 }
345
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000346public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000347 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
348 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000349 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000350
John McCall6b0feb72011-06-22 02:32:12 +0000351 /// A class controlling the emission of a finally block.
352 class FinallyInfo {
353 /// Where the catchall's edge through the cleanup should go.
354 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000355
John McCall6b0feb72011-06-22 02:32:12 +0000356 /// A function to call to enter the catch.
357 llvm::Constant *BeginCatchFn;
358
359 /// An i1 variable indicating whether or not the @finally is
360 /// running for an exception.
361 llvm::AllocaInst *ForEHVar;
362
363 /// An i8* variable into which the exception pointer to rethrow
364 /// has been saved.
365 llvm::AllocaInst *SavedExnVar;
366
367 public:
368 void enter(CodeGenFunction &CGF, const Stmt *Finally,
369 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
370 llvm::Constant *rethrowFn);
371 void exit(CodeGenFunction &CGF);
372 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000373
Reid Kleckner11c033e2015-02-12 23:40:45 +0000374 /// Returns true inside SEH __try blocks.
375 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
376
Reid Klecknera002bd52015-10-28 23:06:42 +0000377 /// Returns true while emitting a cleanuppad.
378 bool isCleanupPadScope() const { return IsCleanupPadScope; }
379
John McCallce1de612011-01-26 04:00:11 +0000380 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
381 /// current full-expression. Safe against the possibility that
382 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000383 template <class T, class... As>
384 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000385 // If we're not in a conditional branch, or if none of the
386 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000387 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000388 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000389
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000390 // Stash values in a tuple so we can guarantee the order of saves.
391 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
392 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000393
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000394 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000395 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000396 initFullExprCleanup();
397 }
398
Richard Smith736a9472013-06-12 20:42:33 +0000399 /// \brief Queue a cleanup to be pushed after finishing the current
400 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000401 template <class T, class... As>
402 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000403 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
404
405 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
406
407 size_t OldSize = LifetimeExtendedCleanupStack.size();
408 LifetimeExtendedCleanupStack.resize(
409 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
410
Justin Bognerbdff2192015-07-01 00:59:27 +0000411 static_assert(sizeof(Header) % llvm::AlignOf<T>::Alignment == 0,
412 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000413 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
414 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000415 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000416 }
417
John McCallf4beacd2011-11-10 10:43:54 +0000418 /// Set up the last cleaup that was pushed as a conditional
419 /// full-expression cleanup.
420 void initFullExprCleanup();
421
John McCallbd309292010-07-06 01:34:17 +0000422 /// PushDestructorCleanup - Push a cleanup to call the
423 /// complete-object destructor of an object of the given type at the
424 /// given address. Does nothing if T is not a C++ class type with a
425 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000426 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000427
John McCall8680f872010-07-21 06:29:51 +0000428 /// PushDestructorCleanup - Push a cleanup to call the
429 /// complete-object variant of the given destructor on the object at
430 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000431 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000432
John McCallbd309292010-07-06 01:34:17 +0000433 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
434 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000435 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000436
John McCall824c2f52010-09-14 07:57:04 +0000437 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
438 /// The block cannot be reactivated. Pops it if it's the top of the
439 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000440 ///
441 /// \param DominatingIP - An instruction which is known to
442 /// dominate the current IP (if set) and which lies along
443 /// all paths of execution between the current IP and the
444 /// the point at which the cleanup comes into scope.
445 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
446 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000447
448 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
449 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000450 ///
451 /// \param DominatingIP - An instruction which is known to
452 /// dominate the current IP (if set) and which lies along
453 /// all paths of execution between the current IP and the
454 /// the point at which the cleanup comes into scope.
455 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
456 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000457
John McCallbd309292010-07-06 01:34:17 +0000458 /// \brief Enters a new scope for capturing cleanups, all of which
459 /// will be executed once the scope is exited.
460 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000461 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000462 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000463 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000464 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000465 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000466 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000467
Aaron Ballmanabc18922015-02-15 22:54:08 +0000468 RunCleanupsScope(const RunCleanupsScope &) = delete;
469 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000470
Eric Christophera9d34972011-10-19 00:43:52 +0000471 protected:
472 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000473
Douglas Gregor965f4502009-11-24 16:43:22 +0000474 public:
475 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000476 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000477 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000478 {
John McCallbd309292010-07-06 01:34:17 +0000479 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000480 LifetimeExtendedCleanupStackSize =
481 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000482 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000483 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000484 }
485
486 /// \brief Exit this cleanup scope, emitting any accumulated
487 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000488 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000489 if (PerformCleanup) {
490 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000491 CGF.PopCleanupBlocks(CleanupStackDepth,
492 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000493 }
494 }
495
496 /// \brief Determine whether this scope requires any cleanups.
497 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000498 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000499 }
500
501 /// \brief Force the emission of cleanups now, instead of waiting
502 /// until this object is destroyed.
503 void ForceCleanup() {
504 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000505 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000506 CGF.PopCleanupBlocks(CleanupStackDepth,
507 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000508 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000509 }
510 };
511
David Blaikie93be0b22014-08-22 21:37:04 +0000512 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000513 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000514 SmallVector<const LabelDecl*, 4> Labels;
515 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000516
Aaron Ballmanabc18922015-02-15 22:54:08 +0000517 LexicalScope(const LexicalScope &) = delete;
518 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000519
520 public:
521 /// \brief Enter a new cleanup scope.
522 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000523 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
524 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000525 if (CGDebugInfo *DI = CGF.getDebugInfo())
526 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
527 }
528
Nadav Rotem1da30942013-03-23 06:43:35 +0000529 void addLabel(const LabelDecl *label) {
530 assert(PerformCleanup && "adding label to dead scope?");
531 Labels.push_back(label);
532 }
533
Eric Christophera9d34972011-10-19 00:43:52 +0000534 /// \brief Exit this cleanup scope, emitting any accumulated
535 /// cleanups.
536 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000537 if (CGDebugInfo *DI = CGF.getDebugInfo())
538 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
539
Nadav Rotem1da30942013-03-23 06:43:35 +0000540 // If we should perform a cleanup, force them now. Note that
541 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000542 if (PerformCleanup) {
543 ApplyDebugLocation DL(CGF, Range.getEnd());
544 ForceCleanup();
545 }
Eric Christophera9d34972011-10-19 00:43:52 +0000546 }
547
548 /// \brief Force the emission of cleanups now, instead of waiting
549 /// until this object is destroyed.
550 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000551 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000552 RunCleanupsScope::ForceCleanup();
553
Nadav Rotem1da30942013-03-23 06:43:35 +0000554 if (!Labels.empty())
555 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000556 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000557
558 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000559 };
560
John McCall7f416cc2015-09-08 08:05:57 +0000561 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
562
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000563 /// \brief The scope used to remap some variables as private in the OpenMP
564 /// loop body (or other captured region emitted without outlining), and to
565 /// restore old vars back on exit.
566 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000567 DeclMapTy SavedLocals;
568 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000569
570 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000571 OMPPrivateScope(const OMPPrivateScope &) = delete;
572 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000573
574 public:
575 /// \brief Enter a new OpenMP private scope.
576 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
577
578 /// \brief Registers \a LocalVD variable as a private and apply \a
579 /// PrivateGen function for it to generate corresponding private variable.
580 /// \a PrivateGen returns an address of the generated private variable.
581 /// \return true if the variable is registered as private, false if it has
582 /// been privatized already.
583 bool
584 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000585 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000586 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000587
588 // Only save it once.
589 if (SavedLocals.count(LocalVD)) return false;
590
591 // Copy the existing local entry to SavedLocals.
592 auto it = CGF.LocalDeclMap.find(LocalVD);
593 if (it != CGF.LocalDeclMap.end()) {
594 SavedLocals.insert({LocalVD, it->second});
595 } else {
596 SavedLocals.insert({LocalVD, Address::invalid()});
597 }
598
599 // Generate the private entry.
600 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000601 QualType VarTy = LocalVD->getType();
602 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000603 Address Temp = CGF.CreateMemTemp(VarTy);
604 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
605 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000606 }
John McCall7f416cc2015-09-08 08:05:57 +0000607 SavedPrivates.insert({LocalVD, Addr});
608
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000609 return true;
610 }
611
612 /// \brief Privatizes local variables previously registered as private.
613 /// Registration is separate from the actual privatization to allow
614 /// initializers use values of the original variables, not the private one.
615 /// This is important, for example, if the private variable is a class
616 /// variable initialized by a constructor that references other private
617 /// variables. But at initialization original variables must be used, not
618 /// private copies.
619 /// \return true if at least one variable was privatized, false otherwise.
620 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000621 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000622 SavedPrivates.clear();
623 return !SavedLocals.empty();
624 }
625
626 void ForceCleanup() {
627 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000628 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000629 SavedLocals.clear();
630 }
631
632 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000633 ~OMPPrivateScope() {
634 if (PerformCleanup)
635 ForceCleanup();
636 }
John McCall7f416cc2015-09-08 08:05:57 +0000637
638 private:
639 /// Copy all the entries in the source map over the corresponding
640 /// entries in the destination, which must exist.
641 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
642 for (auto &pair : src) {
643 if (!pair.second.isValid()) {
644 dest.erase(pair.first);
645 continue;
646 }
647
648 auto it = dest.find(pair.first);
649 if (it != dest.end()) {
650 it->second = pair.second;
651 } else {
652 dest.insert(pair);
653 }
654 }
655 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000656 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000657
Richard Smith736a9472013-06-12 20:42:33 +0000658 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
659 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000660 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000661
Richard Smith736a9472013-06-12 20:42:33 +0000662 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
663 /// that have been added, then adds all lifetime-extended cleanups from
664 /// the given position to the stack.
665 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
666 size_t OldLifetimeExtendedStackSize);
667
John McCallad5d61e2010-07-23 21:56:41 +0000668 void ResolveBranchFixups(llvm::BasicBlock *Target);
669
John McCallbd309292010-07-06 01:34:17 +0000670 /// The given basic block lies in the current EH scope, but may be a
671 /// target of a potentially scope-crossing jump; get a stable handle
672 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000673 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000674 return JumpDest(Target,
675 EHStack.getInnermostNormalCleanup(),
676 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000677 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000678
John McCallbd309292010-07-06 01:34:17 +0000679 /// The given basic block lies in the current EH scope, but may be a
680 /// target of a potentially scope-crossing jump; get a stable handle
681 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000682 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000683 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000684 }
685
686 /// EmitBranchThroughCleanup - Emit a branch from the current insert
687 /// block through the normal cleanup handling code (if any) and then
688 /// on to \arg Dest.
689 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000690
Justin Bognere25ffdf2014-01-21 00:35:11 +0000691 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
692 /// specified destination obviously has no cleanups to run. 'false' is always
693 /// a conservatively correct answer for this method.
694 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
695
John McCall8e4c74b2011-08-11 02:22:43 +0000696 /// popCatchScope - Pops the catch scope at the top of the EHScope
697 /// stack, emitting any required code (other than the catch handlers
698 /// themselves).
699 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000700
David Chisnall9a837be2012-11-07 16:50:40 +0000701 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000702 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000703 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000704
John McCallce1de612011-01-26 04:00:11 +0000705 /// An object to manage conditionally-evaluated expressions.
706 class ConditionalEvaluation {
707 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000708
John McCallce1de612011-01-26 04:00:11 +0000709 public:
710 ConditionalEvaluation(CodeGenFunction &CGF)
711 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000712
John McCallce1de612011-01-26 04:00:11 +0000713 void begin(CodeGenFunction &CGF) {
714 assert(CGF.OutermostConditional != this);
715 if (!CGF.OutermostConditional)
716 CGF.OutermostConditional = this;
717 }
718
719 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000720 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000721 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000722 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000723 }
724
725 /// Returns a block which will be executed prior to each
726 /// evaluation of the conditional code.
727 llvm::BasicBlock *getStartingBlock() const {
728 return StartBB;
729 }
730 };
Mike Stump11289f42009-09-09 15:08:12 +0000731
John McCall7f9c92a2010-09-17 00:50:28 +0000732 /// isInConditionalBranch - Return true if we're currently emitting
733 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000734 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000735
John McCall7f416cc2015-09-08 08:05:57 +0000736 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000737 assert(isInConditionalBranch());
738 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000739 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
740 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000741 }
742
John McCallce1de612011-01-26 04:00:11 +0000743 /// An RAII object to record that we're evaluating a statement
744 /// expression.
745 class StmtExprEvaluation {
746 CodeGenFunction &CGF;
747
748 /// We have to save the outermost conditional: cleanups in a
749 /// statement expression aren't conditional just because the
750 /// StmtExpr is.
751 ConditionalEvaluation *SavedOutermostConditional;
752
753 public:
754 StmtExprEvaluation(CodeGenFunction &CGF)
755 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000756 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000757 }
758
759 ~StmtExprEvaluation() {
760 CGF.OutermostConditional = SavedOutermostConditional;
761 CGF.EnsureInsertPoint();
762 }
763 };
John McCall1bf58462011-02-16 08:02:54 +0000764
John McCallc07a0c72011-02-17 10:25:35 +0000765 /// An object which temporarily prevents a value from being
766 /// destroyed by aggressive peephole optimizations that assume that
767 /// all uses of a value have been realized in the IR.
768 class PeepholeProtection {
769 llvm::Instruction *Inst;
770 friend class CodeGenFunction;
771
772 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000773 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000774 };
John McCallc07a0c72011-02-17 10:25:35 +0000775
John McCallfe96e0b2011-11-06 09:01:30 +0000776 /// A non-RAII class containing all the information about a bound
777 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
778 /// this which makes individual mappings very simple; using this
779 /// class directly is useful when you have a variable number of
780 /// opaque values or don't want the RAII functionality for some
781 /// reason.
782 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000783 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000784 bool BoundLValue;
785 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000786
John McCallfe96e0b2011-11-06 09:01:30 +0000787 OpaqueValueMappingData(const OpaqueValueExpr *ov,
788 bool boundLValue)
789 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000790 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000791 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000792
John McCallc07a0c72011-02-17 10:25:35 +0000793 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000794 // gl-values should be bound as l-values for obvious reasons.
795 // Records should be bound as l-values because IR generation
796 // always keeps them in memory. Expressions of function type
797 // act exactly like l-values but are formally required to be
798 // r-values in C.
799 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000800 expr->getType()->isFunctionType() ||
801 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000802 }
803
John McCallfe96e0b2011-11-06 09:01:30 +0000804 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
805 const OpaqueValueExpr *ov,
806 const Expr *e) {
807 if (shouldBindAsLValue(ov))
808 return bind(CGF, ov, CGF.EmitLValue(e));
809 return bind(CGF, ov, CGF.EmitAnyExpr(e));
810 }
811
812 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
813 const OpaqueValueExpr *ov,
814 const LValue &lv) {
815 assert(shouldBindAsLValue(ov));
816 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
817 return OpaqueValueMappingData(ov, true);
818 }
819
820 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
821 const OpaqueValueExpr *ov,
822 const RValue &rv) {
823 assert(!shouldBindAsLValue(ov));
824 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
825
826 OpaqueValueMappingData data(ov, false);
827
828 // Work around an extremely aggressive peephole optimization in
829 // EmitScalarConversion which assumes that all other uses of a
830 // value are extant.
831 data.Protection = CGF.protectFromPeepholes(rv);
832
833 return data;
834 }
835
Craig Topper8a13c412014-05-21 05:09:00 +0000836 bool isValid() const { return OpaqueValue != nullptr; }
837 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000838
839 void unbind(CodeGenFunction &CGF) {
840 assert(OpaqueValue && "no data to unbind!");
841
842 if (BoundLValue) {
843 CGF.OpaqueLValues.erase(OpaqueValue);
844 } else {
845 CGF.OpaqueRValues.erase(OpaqueValue);
846 CGF.unprotectFromPeepholes(Protection);
847 }
848 }
849 };
850
851 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
852 class OpaqueValueMapping {
853 CodeGenFunction &CGF;
854 OpaqueValueMappingData Data;
855
856 public:
857 static bool shouldBindAsLValue(const Expr *expr) {
858 return OpaqueValueMappingData::shouldBindAsLValue(expr);
859 }
860
John McCallc07a0c72011-02-17 10:25:35 +0000861 /// Build the opaque value mapping for the given conditional
862 /// operator if it's the GNU ?: extension. This is a common
863 /// enough pattern that the convenience operator is really
864 /// helpful.
865 ///
866 OpaqueValueMapping(CodeGenFunction &CGF,
867 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000868 if (isa<ConditionalOperator>(op))
869 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000870 return;
John McCallc07a0c72011-02-17 10:25:35 +0000871
872 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000873 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
874 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000875 }
876
John McCall1bf58462011-02-16 08:02:54 +0000877 OpaqueValueMapping(CodeGenFunction &CGF,
878 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000879 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000880 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000881 }
882
883 OpaqueValueMapping(CodeGenFunction &CGF,
884 const OpaqueValueExpr *opaqueValue,
885 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000886 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000887 }
888
889 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000890 Data.unbind(CGF);
891 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000892 }
893
894 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000895 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000896 }
897 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000898
Chris Lattner2da04b32007-08-24 05:35:26 +0000899private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000900 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000901 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000902
John McCall9b382dd2011-05-28 21:13:02 +0000903 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
904 /// calling llvm.stacksave for multiple VLAs in the same scope.
905 bool DidCallStackSave;
906
Mike Stumpe5311b02009-11-30 20:08:49 +0000907 /// IndirectBranch - The first time an indirect goto is seen we create a block
908 /// with an indirect branch. Every time we see the address of a label taken,
909 /// we add the label to the indirect goto. Every subsequent indirect goto is
910 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000911 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000912
Mike Stumpfc496822009-02-08 23:14:22 +0000913 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
914 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000915 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000916
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000917 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
918 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
919 /// parameter.
920 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
921 SizeArguments;
922
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000923 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000924 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000925 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
926
Chris Lattnerac248202007-05-30 00:13:02 +0000927 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000928 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000929
Mike Stumpfc496822009-02-08 23:14:22 +0000930 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000931 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000932 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000933 BreakContinue(JumpDest Break, JumpDest Continue)
934 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000935
John McCallbd309292010-07-06 01:34:17 +0000936 JumpDest BreakBlock;
937 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000938 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000939 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000940
Justin Bogneref512b92014-01-06 22:27:43 +0000941 CodeGenPGO PGO;
942
Justin Bogner65512642015-05-02 05:00:55 +0000943 /// Calculate branch weights appropriate for PGO data
944 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
945 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
946 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
947 uint64_t LoopCount);
948
Justin Bogneref512b92014-01-06 22:27:43 +0000949public:
Justin Bogner66242d62015-04-23 23:06:47 +0000950 /// Increment the profiler's counter for the given statement.
951 void incrementProfileCounter(const Stmt *S) {
952 if (CGM.getCodeGenOpts().ProfileInstrGenerate)
953 PGO.emitCounterIncrement(Builder, S);
954 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +0000955 }
Justin Bogner66242d62015-04-23 23:06:47 +0000956
957 /// Get the profiler's count for the given statement.
958 uint64_t getProfileCount(const Stmt *S) {
959 Optional<uint64_t> Count = PGO.getStmtCount(S);
960 if (!Count.hasValue())
961 return 0;
962 return *Count;
963 }
964
965 /// Set the profiler's current count.
966 void setCurrentProfileCount(uint64_t Count) {
967 PGO.setCurrentRegionCount(Count);
968 }
969
970 /// Get the profiler's current count. This is generally the count for the most
971 /// recently incremented counter.
972 uint64_t getCurrentProfileCount() {
973 return PGO.getCurrentRegionCount();
974 }
975
Justin Bogneref512b92014-01-06 22:27:43 +0000976private:
977
Zhongxing Xu82846ea2012-01-14 09:08:15 +0000978 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +0000979 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000980 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +0000981 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
982 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +0000983
Mike Stumpfc496822009-02-08 23:14:22 +0000984 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000985 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000986 llvm::BasicBlock *CaseRangeBlock;
987
John McCallc07a0c72011-02-17 10:25:35 +0000988 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +0000989 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +0000990 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
991 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +0000992
Mike Stumpfc496822009-02-08 23:14:22 +0000993 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +0000994 // We track this by the size expression rather than the type itself because
995 // in certain situations, like a const qualifier applied to an VLA typedef,
996 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +0000997 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
998 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +0000999 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001000
John McCallbd309292010-07-06 01:34:17 +00001001 /// A block containing a single 'unreachable' instruction. Created
1002 /// lazily by getUnreachableBlock().
1003 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001004
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001005 /// Counts of the number return expressions in the function.
1006 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001007
1008 /// Count the number of simple (constant) return expressions in the function.
1009 unsigned NumSimpleReturnExprs;
1010
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001011 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001012 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001013
Richard Smith852c9db2013-04-20 22:23:05 +00001014public:
1015 /// A scope within which we are constructing the fields of an object which
1016 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1017 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1018 class FieldConstructionScope {
1019 public:
John McCall7f416cc2015-09-08 08:05:57 +00001020 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001021 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1022 CGF.CXXDefaultInitExprThis = This;
1023 }
1024 ~FieldConstructionScope() {
1025 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1026 }
1027
1028 private:
1029 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001030 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001031 };
1032
1033 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1034 /// is overridden to be the object under construction.
1035 class CXXDefaultInitExprScope {
1036 public:
1037 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001038 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1039 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1040 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1041 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001042 }
1043 ~CXXDefaultInitExprScope() {
1044 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001045 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001046 }
1047
1048 public:
1049 CodeGenFunction &CGF;
1050 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001051 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001052 };
1053
1054private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001055 /// CXXThisDecl - When generating code for a C++ member function,
1056 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001057 ImplicitParamDecl *CXXABIThisDecl;
1058 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001059 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001060 CharUnits CXXABIThisAlignment;
1061 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001062
Richard Smith852c9db2013-04-20 22:23:05 +00001063 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1064 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001065 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001066
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001067 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1068 /// destructor, this will hold the implicit argument (e.g. VTT).
1069 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1070 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001071
John McCallce1de612011-01-26 04:00:11 +00001072 /// OutermostConditional - Points to the outermost active
1073 /// conditional control. This is used so that we know if a
1074 /// temporary should be destroyed conditionally.
1075 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001076
Nadav Rotem1da30942013-03-23 06:43:35 +00001077 /// The current lexical scope.
1078 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001079
Adrian Prantldc237b52013-05-16 00:41:26 +00001080 /// The current source location that should be used for exception
1081 /// handling code.
1082 SourceLocation CurEHLocation;
1083
John McCall7f416cc2015-09-08 08:05:57 +00001084 /// BlockByrefInfos - For each __block variable, contains
1085 /// information about the layout of the variable.
1086 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001087
John McCallbd309292010-07-06 01:34:17 +00001088 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001089 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001090 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001091
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001092 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1093 /// In the kernel metadata node, reference the kernel function and metadata
1094 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001095 /// - A node for the vec_type_hint(<type>) qualifier contains string
1096 /// "vec_type_hint", an undefined value of the <type> data type,
1097 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001098 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1099 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1100 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1101 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1102 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1103 llvm::Function *Fn);
1104
Chris Lattnerbed31442007-05-28 01:07:47 +00001105public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001106 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001107 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001108
John McCall8ed55a52010-09-02 09:58:18 +00001109 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001110 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001111 CGDebugInfo *getDebugInfo() {
1112 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001113 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001114 return DebugInfo;
1115 }
1116 void disableDebugInfo() { DisableDebugInfo = true; }
1117 void enableDebugInfo() { DisableDebugInfo = false; }
1118
John McCall31168b02011-06-15 23:02:42 +00001119 bool shouldUseFusedARCCalls() {
1120 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1121 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001122
David Blaikiebbafb8a2012-03-11 07:00:24 +00001123 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001124
Bill Wendlingf0724e82011-09-19 20:31:14 +00001125 /// Returns a pointer to the function's exception object and selector slot,
1126 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001127 Address getExceptionSlot();
1128 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001129
Bill Wendling79a70e42011-09-15 18:57:19 +00001130 /// Returns the contents of the function's exception object and selector
1131 /// slots.
1132 llvm::Value *getExceptionFromSlot();
1133 llvm::Value *getSelectorFromSlot();
1134
John McCall7f416cc2015-09-08 08:05:57 +00001135 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001136
John McCallbd309292010-07-06 01:34:17 +00001137 llvm::BasicBlock *getUnreachableBlock() {
1138 if (!UnreachableBlock) {
1139 UnreachableBlock = createBasicBlock("unreachable");
1140 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1141 }
1142 return UnreachableBlock;
1143 }
1144
1145 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001146 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001147 return getInvokeDestImpl();
1148 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001149
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001150 bool currentFunctionUsesSEHTry() const {
1151 const auto *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl);
1152 return FD && FD->usesSEHTry();
1153 }
1154
John McCallc8e01702013-04-16 22:48:15 +00001155 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001156 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001157
Daniel Dunbar12347492009-02-23 17:26:39 +00001158 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001159 // Cleanups
1160 //===--------------------------------------------------------------------===//
1161
John McCall7f416cc2015-09-08 08:05:57 +00001162 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001163
John McCall178360e2011-07-11 08:38:19 +00001164 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001165 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001166 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001167 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001168 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001169 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1170 llvm::Value *arrayEnd,
1171 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001172 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001173 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001174
John McCall4bd0fb12011-07-12 16:41:08 +00001175 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001176 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001177 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001178 Address addr, QualType type);
1179 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001180 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001181 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001182 QualType type, Destroyer *destroyer,
1183 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001184 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1185 llvm::Value *CompletePtr,
1186 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001187 void pushStackRestore(CleanupKind kind, Address SPMem);
1188 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001189 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001190 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001191 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001192 bool useEHCleanupForArray,
1193 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001194 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001195 QualType elementType, CharUnits elementAlign,
1196 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001197 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001198
Peter Collingbourne1425b452012-01-26 03:33:36 +00001199 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001200
John McCall82fe67b2011-07-09 01:37:26 +00001201 /// Determines whether an EH cleanup is required to destroy a type
1202 /// with the given destruction kind.
1203 bool needsEHCleanup(QualType::DestructionKind kind) {
1204 switch (kind) {
1205 case QualType::DK_none:
1206 return false;
1207 case QualType::DK_cxx_destructor:
1208 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001209 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001210 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001211 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001212 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1213 }
1214 llvm_unreachable("bad destruction kind");
1215 }
1216
John McCall4bd0fb12011-07-12 16:41:08 +00001217 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1218 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1219 }
1220
John McCall82fe67b2011-07-09 01:37:26 +00001221 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001222 // Objective-C
1223 //===--------------------------------------------------------------------===//
1224
Chris Lattner4bd55962008-03-30 23:03:07 +00001225 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001226
David Blaikief1425802015-01-14 00:04:42 +00001227 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001228
Mike Stumpfc496822009-02-08 23:14:22 +00001229 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001230 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1231 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001232 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001233 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001234 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001235 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001236
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001237 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1238 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001239
Mike Stumpfc496822009-02-08 23:14:22 +00001240 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1241 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001242 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1243 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001244 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001245 const ObjCPropertyImplDecl *propImpl,
1246 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001247
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001248 //===--------------------------------------------------------------------===//
1249 // Block Bits
1250 //===--------------------------------------------------------------------===//
1251
John McCall351762c2011-02-07 10:33:21 +00001252 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001253 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1254 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001255
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001256 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001257 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001258 const DeclMapTy &ldm,
1259 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001260
John McCallad7c5c12011-02-08 08:22:06 +00001261 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1262 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001263 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1264 const ObjCPropertyImplDecl *PID);
1265 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1266 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001267 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001268
John McCallad7c5c12011-02-08 08:22:06 +00001269 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1270
John McCall73064872011-03-31 01:59:53 +00001271 class AutoVarEmission;
1272
1273 void emitByrefStructureInit(const AutoVarEmission &emission);
1274 void enterByrefCleanup(const AutoVarEmission &emission);
1275
John McCall7f416cc2015-09-08 08:05:57 +00001276 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1277 llvm::Value *ptr);
1278
1279 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001280 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1281
1282 /// BuildBlockByrefAddress - Computes the location of the
1283 /// data in a variable which is declared as __block.
1284 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1285 bool followForward = true);
1286 Address emitBlockByrefAddress(Address baseAddr,
1287 const BlockByrefInfo &info,
1288 bool followForward,
1289 const llvm::Twine &name);
1290
1291 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001292
John McCalla738c252011-03-09 04:27:21 +00001293 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1294 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001295 /// \brief Emit code for the start of a function.
1296 /// \param Loc The location to be associated with the function.
1297 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001298 void StartFunction(GlobalDecl GD,
1299 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001300 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001301 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001302 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001303 SourceLocation Loc = SourceLocation(),
1304 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001305
John McCallb81884d2010-02-19 09:25:03 +00001306 void EmitConstructorBody(FunctionArgList &Args);
1307 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001308 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001309 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001310 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001311
Faisal Vali571df122013-09-29 08:45:24 +00001312 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001313 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001314 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001315 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001316 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1317 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001318 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001319
David Blaikiea0a1a872015-01-18 02:48:07 +00001320 /// \brief Emit the unified return block, trying to avoid its emission when
1321 /// possible.
1322 /// \return The debug location of the user written return statement if the
1323 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001324 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001325
Mike Stumpfc496822009-02-08 23:14:22 +00001326 /// FinishFunction - Complete IR generation of the current function. It is
1327 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001328 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001329
Nico Weber1bebad12015-02-11 22:33:32 +00001330 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1331 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001332
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001333 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001334
John McCall7f416cc2015-09-08 08:05:57 +00001335 void FinishThunk();
1336
Reid Klecknerab2090d2014-07-26 01:34:32 +00001337 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1338 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1339 llvm::Value *Callee);
1340
Rafael Espindolad6e66942015-07-13 06:07:58 +00001341 /// Generate a thunk for the given method.
1342 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001343 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001344
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001345 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1346 const CGFunctionInfo &FnInfo,
1347 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001348
Douglas Gregor94f9a482010-05-05 05:51:00 +00001349 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1350 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001351
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001352 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001353 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001354
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001355 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1356 struct VPtr {
1357 BaseSubobject Base;
1358 const CXXRecordDecl *NearestVBase;
1359 CharUnits OffsetFromNearestVBase;
1360 const CXXRecordDecl *VTableClass;
1361 };
1362
1363 /// Initialize the vtable pointer of the given subobject.
1364 void InitializeVTablePointer(const VPtr &vptr);
1365
1366 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001367
1368 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001369 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1370
1371 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1372 CharUnits OffsetFromNearestVBase,
1373 bool BaseIsNonVirtualPrimaryBase,
1374 const CXXRecordDecl *VTableClass,
1375 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001376
Anders Carlssond5895932010-03-28 21:07:49 +00001377 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001378
Dan Gohman8fc50c22010-10-26 18:44:08 +00001379 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1380 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001381 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1382 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001383
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001384 enum CFITypeCheckKind {
1385 CFITCK_VCall,
1386 CFITCK_NVCall,
1387 CFITCK_DerivedCast,
1388 CFITCK_UnrelatedCast,
1389 };
1390
Peter Collingbourned2926c92015-03-14 02:42:25 +00001391 /// \brief Derived is the presumed address of an object of type T after a
1392 /// cast. If T is a polymorphic class type, emit a check that the virtual
1393 /// table for Derived belongs to a class derived from T.
1394 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001395 bool MayBeNull, CFITypeCheckKind TCK,
1396 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001397
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001398 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1399 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001400 void EmitVTablePtrCheckForCall(const CXXMethodDecl *MD, llvm::Value *VTable,
1401 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001402
Peter Collingbourned2926c92015-03-14 02:42:25 +00001403 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
1404 /// RD using llvm.bitset.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001405 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1406 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001407
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001408 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1409 /// expr can be devirtualized.
1410 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1411 const CXXMethodDecl *MD);
1412
John McCallf99a6312010-07-21 05:30:47 +00001413 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1414 /// given phase of destruction for a destructor. The end result
1415 /// should call destructors on members and base classes in reverse
1416 /// order of their construction.
1417 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001418
Chris Lattner3c77a352010-06-22 00:03:40 +00001419 /// ShouldInstrumentFunction - Return true if the current function should be
1420 /// instrumented with __cyg_profile_func_* calls
1421 bool ShouldInstrumentFunction();
1422
1423 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1424 /// instrumentation function with the current function and the call site, if
1425 /// function instrumentation is enabled.
1426 void EmitFunctionInstrumentation(const char *Fn);
1427
Roman Divacky178e01602011-02-10 16:52:03 +00001428 /// EmitMCountInstrumentation - Emit call to .mcount.
1429 void EmitMCountInstrumentation();
1430
Mike Stumpfc496822009-02-08 23:14:22 +00001431 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1432 /// arguments for the given function. This is also responsible for naming the
1433 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001434 void EmitFunctionProlog(const CGFunctionInfo &FI,
1435 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001436 const FunctionArgList &Args);
1437
Mike Stumpfc496822009-02-08 23:14:22 +00001438 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1439 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001440 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1441 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001442
Mike Stump1d849212009-12-07 23:38:24 +00001443 /// EmitStartEHSpec - Emit the start of the exception spec.
1444 void EmitStartEHSpec(const Decl *D);
1445
1446 /// EmitEndEHSpec - Emit the end of the exception spec.
1447 void EmitEndEHSpec(const Decl *D);
1448
John McCallbd309292010-07-06 01:34:17 +00001449 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1450 llvm::BasicBlock *getTerminateLandingPad();
1451
1452 /// getTerminateHandler - Return a handler (not a landing pad, just
1453 /// a catch handler) that just calls terminate. This is used when
1454 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001455 llvm::BasicBlock *getTerminateHandler();
1456
Chris Lattnera5f58b02011-07-09 17:41:47 +00001457 llvm::Type *ConvertTypeForMem(QualType T);
1458 llvm::Type *ConvertType(QualType T);
1459 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001460 return ConvertType(getContext().getTypeDeclType(T));
1461 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001462
Mike Stumpfc496822009-02-08 23:14:22 +00001463 /// LoadObjCSelf - Load the value of self. This function is only valid while
1464 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001465 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001466
1467 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001468 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001469
Chris Lattner54fb19e2007-06-22 22:02:34 +00001470 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1471 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001472 static TypeEvaluationKind getEvaluationKind(QualType T);
1473
1474 static bool hasScalarEvaluationKind(QualType T) {
1475 return getEvaluationKind(T) == TEK_Scalar;
1476 }
1477
1478 static bool hasAggregateEvaluationKind(QualType T) {
1479 return getEvaluationKind(T) == TEK_Aggregate;
1480 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001481
1482 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001483 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001484 llvm::Function *parent = nullptr,
1485 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001486#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001487 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001488#else
John McCallad7c5c12011-02-08 08:22:06 +00001489 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001490#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001491 }
Mike Stumpfc496822009-02-08 23:14:22 +00001492
Chris Lattnerac248202007-05-30 00:13:02 +00001493 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1494 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001495 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001496
Mike Stumpe5311b02009-11-30 20:08:49 +00001497 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1498 /// another basic block, simplify it. This assumes that no other code could
1499 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001500 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1501
Mike Stumpfc496822009-02-08 23:14:22 +00001502 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1503 /// adding a fall-through branch from the current insert block if
1504 /// necessary. It is legal to call this function even if there is no current
1505 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001506 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001507 /// IsFinished - If true, indicates that the caller has finished emitting
1508 /// branches to the given block and does not expect to emit code into it. This
1509 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001510 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001511
John McCall8e4c74b2011-08-11 02:22:43 +00001512 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1513 /// near its uses, and leave the insertion point in it.
1514 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1515
Mike Stumpfc496822009-02-08 23:14:22 +00001516 /// EmitBranch - Emit a branch to the specified basic block from the current
1517 /// insert block, taking care to avoid creation of branches from dummy
1518 /// blocks. It is legal to call this function even if there is no current
1519 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001520 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001521 /// This function clears the current insertion point. The caller should follow
1522 /// calls to this function with calls to Emit*Block prior to generation new
1523 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001524 void EmitBranch(llvm::BasicBlock *Block);
1525
Mike Stumpfc496822009-02-08 23:14:22 +00001526 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1527 /// indicates that the current code being emitted is unreachable.
1528 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001529 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001530 }
1531
Mike Stumpfc496822009-02-08 23:14:22 +00001532 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1533 /// emitted IR has a place to go. Note that by definition, if this function
1534 /// creates a block then that block is unreachable; callers may do better to
1535 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001536 void EnsureInsertPoint() {
1537 if (!HaveInsertPoint())
1538 EmitBlock(createBasicBlock());
1539 }
Mike Stumpfc496822009-02-08 23:14:22 +00001540
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001541 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001542 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001543 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001544
Chris Lattnere9a64532007-06-22 21:44:33 +00001545 //===--------------------------------------------------------------------===//
1546 // Helpers
1547 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001548
John McCall7f416cc2015-09-08 08:05:57 +00001549 LValue MakeAddrLValue(Address Addr, QualType T,
1550 AlignmentSource AlignSource = AlignmentSource::Type) {
1551 return LValue::MakeAddr(Addr, T, getContext(), AlignSource,
Dan Gohman947c9af2010-10-14 23:06:10 +00001552 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001553 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001554
John McCall7f416cc2015-09-08 08:05:57 +00001555 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1556 AlignmentSource AlignSource = AlignmentSource::Type) {
1557 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1558 AlignSource, CGM.getTBAAInfo(T));
1559 }
1560
1561 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001562 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001563 CharUnits getNaturalTypeAlignment(QualType T,
1564 AlignmentSource *Source = nullptr,
1565 bool forPointeeType = false);
1566 CharUnits getNaturalPointeeTypeAlignment(QualType T,
1567 AlignmentSource *Source = nullptr);
1568
1569 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
1570 AlignmentSource *Source = nullptr);
1571 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001572
Chris Lattnere9a64532007-06-22 21:44:33 +00001573 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001574 /// block. The caller is responsible for setting an appropriate alignment on
1575 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001576 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001577 const Twine &Name = "tmp");
John McCall7f416cc2015-09-08 08:05:57 +00001578 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
1579 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001580
John McCall7f416cc2015-09-08 08:05:57 +00001581 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1582 /// default ABI alignment of the given LLVM type.
1583 ///
1584 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1585 /// any given AST type that happens to have been lowered to the
1586 /// given IR type. This should only ever be used for function-local,
1587 /// IR-driven manipulations like saving and restoring a value. Do
1588 /// not hand this address off to arbitrary IRGen routines, and especially
1589 /// do not pass it as an argument to a function that might expect a
1590 /// properly ABI-aligned value.
1591 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1592 const Twine &Name = "tmp");
1593
1594 /// InitTempAlloca - Provide an initial value for the given alloca which
1595 /// will be observable at all locations in the function.
1596 ///
1597 /// The address should be something that was returned from one of
1598 /// the CreateTempAlloca or CreateMemTemp routines, and the
1599 /// initializer must be valid in the entry block (i.e. it must
1600 /// either be a constant or an argument value).
1601 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001602
Daniel Dunbard0049182010-02-16 19:44:13 +00001603 /// CreateIRTemp - Create a temporary IR object of the given type, with
1604 /// appropriate alignment. This routine should only be used when an temporary
1605 /// value needs to be stored into an alloca (for example, to avoid explicit
1606 /// PHI construction), but the type is the IR type, not the type appropriate
1607 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001608 ///
1609 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1610 /// ConvertType instead of ConvertTypeForMem.
1611 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001612
Daniel Dunbara7566f12010-02-09 02:48:28 +00001613 /// CreateMemTemp - Create a temporary memory object of the given type, with
1614 /// appropriate alignment.
John McCall7f416cc2015-09-08 08:05:57 +00001615 Address CreateMemTemp(QualType T, const Twine &Name = "tmp");
1616 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001617
John McCall7a626f62010-09-15 10:14:12 +00001618 /// CreateAggTemp - Create a temporary memory object for the given
1619 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001620 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00001621 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001622 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001623 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001624 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001625 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001626 }
1627
John McCallad7c5c12011-02-08 08:22:06 +00001628 /// Emit a cast to void* in the appropriate address space.
1629 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1630
Chris Lattner8394d792007-06-05 20:53:16 +00001631 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1632 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001633 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001634
John McCalla2342eb2010-12-05 02:00:02 +00001635 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1636 void EmitIgnoredExpr(const Expr *E);
1637
Chris Lattner4647a212007-08-31 22:49:20 +00001638 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1639 /// any type. The result is returned as an RValue struct. If this is an
1640 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1641 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001642 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001643 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001644 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001645 AggValueSlot aggSlot = AggValueSlot::ignored(),
1646 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001647
Mike Stumpfc496822009-02-08 23:14:22 +00001648 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1649 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00001650 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001651
Charles Davisc7d5c942015-09-17 20:55:33 +00001652 /// Emit a "reference" to a __builtin_ms_va_list; this is
1653 /// always the value of the expression, because a __builtin_ms_va_list is a
1654 /// pointer to a char.
1655 Address EmitMSVAListRef(const Expr *E);
1656
Mike Stumpfc496822009-02-08 23:14:22 +00001657 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1658 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001659 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001660
John McCall91ca10f2011-03-08 09:11:50 +00001661 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001662 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00001663 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001664 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001665
John McCall7f416cc2015-09-08 08:05:57 +00001666 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00001667
John McCall91ca10f2011-03-08 09:11:50 +00001668 /// EmitExprAsInit - Emits the code necessary to initialize a
1669 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001670 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001671 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001672
Fariborz Jahanian78652202013-01-25 23:57:05 +00001673 /// hasVolatileMember - returns true if aggregate type has a volatile
1674 /// member.
1675 bool hasVolatileMember(QualType T) {
1676 if (const RecordType *RT = T->getAs<RecordType>()) {
1677 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1678 return RD->hasVolatileMember();
1679 }
1680 return false;
1681 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001682 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001683 ///
1684 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1685 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00001686 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001687 QualType EltTy) {
1688 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00001689 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001690 }
1691
John McCall7f416cc2015-09-08 08:05:57 +00001692 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
1693 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00001694 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00001695 /*IsAssignment=*/false);
1696 }
1697
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001698 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001699 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001700 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001701 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001702 /// \param isAssignment - If false, allow padding to be copied. This often
1703 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00001704 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001705 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001706 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001707
Anders Carlsson9396a892008-09-11 09:15:33 +00001708 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00001709 Address GetAddrOfLocalVar(const VarDecl *VD) {
1710 auto it = LocalDeclMap.find(VD);
1711 assert(it != LocalDeclMap.end() &&
1712 "Invalid argument to GetAddrOfLocalVar(), no decl!");
1713 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00001714 }
Mike Stumpfc496822009-02-08 23:14:22 +00001715
John McCallc07a0c72011-02-17 10:25:35 +00001716 /// getOpaqueLValueMapping - Given an opaque value expression (which
1717 /// must be mapped to an l-value), return its mapping.
1718 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1719 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1720
1721 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1722 it = OpaqueLValues.find(e);
1723 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1724 return it->second;
1725 }
1726
1727 /// getOpaqueRValueMapping - Given an opaque value expression (which
1728 /// must be mapped to an r-value), return its mapping.
1729 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1730 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1731
1732 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1733 it = OpaqueRValues.find(e);
1734 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001735 return it->second;
1736 }
1737
Dan Gohman75d69da2008-05-22 00:50:06 +00001738 /// getAccessedFieldNo - Given an encoded value and a result number, return
1739 /// the input field number being accessed.
1740 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1741
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001742 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001743 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001744
Anders Carlssonc0964b62010-05-22 17:35:42 +00001745 /// EmitNullInitialization - Generate code to set a value of the given type to
1746 /// null, If the type contains data member pointers, they will be initialized
1747 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00001748 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001749
Charles Davisc7d5c942015-09-17 20:55:33 +00001750 /// Emits a call to an LLVM variable-argument intrinsic, either
1751 /// \c llvm.va_start or \c llvm.va_end.
1752 /// \param ArgValue A reference to the \c va_list as emitted by either
1753 /// \c EmitVAListRef or \c EmitMSVAListRef.
1754 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
1755 /// calls \c llvm.va_end.
1756 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
1757
1758 /// Generate code to get an argument from the passed in pointer
1759 /// and update it accordingly.
1760 /// \param VE The \c VAArgExpr for which to generate code.
1761 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
1762 /// either \c EmitVAListRef or \c EmitMSVAListRef.
1763 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001764 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001765 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00001766 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001767
John McCall82fe67b2011-07-09 01:37:26 +00001768 /// emitArrayLength - Compute the length of an array, even if it's a
1769 /// VLA, and drill down to the base element type.
1770 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1771 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001772 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00001773
John McCall23c29fe2011-06-24 21:55:10 +00001774 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1775 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001776 ///
1777 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001778 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001779
John McCall23c29fe2011-06-24 21:55:10 +00001780 /// getVLASize - Returns an LLVM value that corresponds to the size,
1781 /// in non-variably-sized elements, of a variable length array type,
1782 /// plus that largest non-variably-sized element type. Assumes that
1783 /// the type has already been emitted with EmitVariablyModifiedType.
1784 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1785 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001786
Anders Carlssona5d077d2009-04-14 16:58:56 +00001787 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1788 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001789 llvm::Value *LoadCXXThis() {
1790 assert(CXXThisValue && "no 'this' value for this function");
1791 return CXXThisValue;
1792 }
John McCall7f416cc2015-09-08 08:05:57 +00001793 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00001794
Anders Carlssone36a6b32010-01-02 01:01:18 +00001795 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1796 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001797 // FIXME: Every place that calls LoadCXXVTT is something
1798 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001799 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001800 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1801 return CXXStructorImplicitParamValue;
1802 }
1803
John McCall6ce74722010-02-16 04:15:37 +00001804 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001805 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00001806 Address
1807 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001808 const CXXRecordDecl *Derived,
1809 const CXXRecordDecl *Base,
1810 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001811
John McCall7f416cc2015-09-08 08:05:57 +00001812 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
1813
Mike Stumpe5311b02009-11-30 20:08:49 +00001814 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1815 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00001816 Address GetAddressOfBaseClass(Address Value,
1817 const CXXRecordDecl *Derived,
1818 CastExpr::path_const_iterator PathBegin,
1819 CastExpr::path_const_iterator PathEnd,
1820 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001821
John McCall7f416cc2015-09-08 08:05:57 +00001822 Address GetAddressOfDerivedClass(Address Value,
1823 const CXXRecordDecl *Derived,
1824 CastExpr::path_const_iterator PathBegin,
1825 CastExpr::path_const_iterator PathEnd,
1826 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00001827
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001828 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1829 /// base constructor/destructor with virtual bases.
1830 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1831 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1832 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1833 bool Delegating);
1834
John McCallf8ff7b92010-02-23 00:48:20 +00001835 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1836 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001837 const FunctionArgList &Args,
1838 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001839 // It's important not to confuse this and the previous function. Delegating
1840 // constructors are the C++0x feature. The constructor delegate optimization
1841 // is used to reduce duplication in the base and complete consturctors where
1842 // they are substantially the same.
1843 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1844 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001845
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001846 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001847 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001848 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001849
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001850 /// Emit assumption load for all bases. Requires to be be called only on
1851 /// most-derived class and not under construction of the object.
1852 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
1853
1854 /// Emit assumption that vptr load == global vtable.
1855 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
1856
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001857 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00001858 Address This, Address Src,
1859 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001860
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001861 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001862 const ConstantArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00001863 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001864 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001865 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001866
Anders Carlssond49844b2009-09-23 02:45:36 +00001867 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1868 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00001869 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001870 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001871 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001872
John McCall82fe67b2011-07-09 01:37:26 +00001873 static Destroyer destroyCXXObject;
1874
Anders Carlsson0a637412009-05-29 21:03:38 +00001875 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001876 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001877 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001878
John McCall99210dc2011-09-15 06:49:18 +00001879 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001880 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00001881 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00001882 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00001883
Peter Collingbourne702b2842011-11-27 22:09:22 +00001884 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00001885 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001886
David Majnemerdc012fa2015-04-22 21:38:15 +00001887 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
1888 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
1889
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001890 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001891 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001892
Eli Friedman24f55432009-11-18 00:57:03 +00001893 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1894 QualType DeleteTy);
1895
Richard Smith760520b2014-06-03 23:27:44 +00001896 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1897 const Expr *Arg, bool IsDelete);
1898
John McCall7f416cc2015-09-08 08:05:57 +00001899 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
1900 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
1901 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001902
Richard Smith69d0d262012-08-24 00:54:33 +00001903 /// \brief Situations in which we might emit a check for the suitability of a
1904 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001905 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001906 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001907 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001908 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001909 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001910 /// Checking the bound value in a reference binding. Must be suitably sized
1911 /// and aligned, but is not required to refer to an object (until the
1912 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001913 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001914 /// Checking the object expression in a non-static data member access. Must
1915 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001916 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001917 /// Checking the 'this' pointer for a call to a non-static member function.
1918 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001919 TCK_MemberCall,
1920 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001921 TCK_ConstructorCall,
1922 /// Checking the operand of a static_cast to a derived pointer type. Must be
1923 /// null or an object within its lifetime.
1924 TCK_DowncastPointer,
1925 /// Checking the operand of a static_cast to a derived reference type. Must
1926 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001927 TCK_DowncastReference,
1928 /// Checking the operand of a cast to a base object. Must be suitably sized
1929 /// and aligned.
1930 TCK_Upcast,
1931 /// Checking the operand of a cast to a virtual base object. Must be an
1932 /// object within its lifetime.
1933 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00001934 };
1935
Alexey Samsonovac4afe42014-07-07 23:59:57 +00001936 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
1937 /// calls to EmitTypeCheck can be skipped.
1938 bool sanitizePerformTypeCheck() const;
1939
Richard Smith4d1458e2012-09-08 02:08:36 +00001940 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001941 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001942 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001943 QualType Type, CharUnits Alignment = CharUnits::Zero(),
1944 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001945
Richard Smith539e4a72013-02-23 02:53:19 +00001946 /// \brief Emit a check that \p Base points into an array object, which
1947 /// we can access at index \p Index. \p Accessed should be \c false if we
1948 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1949 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1950 QualType IndexType, bool Accessed);
1951
Chris Lattner116ce8f2010-01-09 21:40:03 +00001952 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1953 bool isInc, bool isPre);
1954 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1955 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00001956
1957 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00001958 llvm::Value *OffsetValue = nullptr) {
1959 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
1960 OffsetValue);
1961 }
Hal Finkelbcc06082014-09-07 22:58:14 +00001962
Chris Lattner8394d792007-06-05 20:53:16 +00001963 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001964 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001965 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001966
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001967 /// EmitDecl - Emit a declaration.
1968 ///
1969 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001970 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001971
John McCall1c9c3fd2010-10-15 04:57:14 +00001972 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001973 ///
1974 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001975 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001976
David Blaikie73ca5692014-12-09 00:32:22 +00001977 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001978 bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00001979 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001980
John McCallbd309292010-07-06 01:34:17 +00001981 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1982 llvm::Value *Address);
1983
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001984 /// \brief Determine whether the given initializer is trivial in the sense
1985 /// that it requires no code to be generated.
1986 bool isTrivialInitializer(const Expr *Init);
1987
John McCall1c9c3fd2010-10-15 04:57:14 +00001988 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001989 ///
1990 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00001991 void EmitAutoVarDecl(const VarDecl &D);
1992
1993 class AutoVarEmission {
1994 friend class CodeGenFunction;
1995
John McCall9e2e22f2011-02-22 07:16:58 +00001996 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00001997
John McCall7f416cc2015-09-08 08:05:57 +00001998 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00001999 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002000 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002001
2002 llvm::Value *NRVOFlag;
2003
2004 /// True if the variable is a __block variable.
2005 bool IsByRef;
2006
2007 /// True if the variable is of aggregate type and has a constant
2008 /// initializer.
2009 bool IsConstantAggregate;
2010
Nadav Rotem1da30942013-03-23 06:43:35 +00002011 /// Non-null if we should use lifetime annotations.
2012 llvm::Value *SizeForLifetimeMarkers;
2013
John McCall9e2e22f2011-02-22 07:16:58 +00002014 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002015 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002016
John McCallc533cb72011-02-22 06:44:22 +00002017 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002018 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002019 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002020 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002021
John McCall7f416cc2015-09-08 08:05:57 +00002022 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002023
2024 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002025 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2026
Craig Topper8a13c412014-05-21 05:09:00 +00002027 bool useLifetimeMarkers() const {
2028 return SizeForLifetimeMarkers != nullptr;
2029 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002030 llvm::Value *getSizeForLifetimeMarkers() const {
2031 assert(useLifetimeMarkers());
2032 return SizeForLifetimeMarkers;
2033 }
2034
2035 /// Returns the raw, allocated address, which is not necessarily
2036 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002037 Address getAllocatedAddress() const {
2038 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002039 }
2040
John McCallc533cb72011-02-22 06:44:22 +00002041 /// Returns the address of the object within this declaration.
2042 /// Note that this does not chase the forwarding pointer for
2043 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002044 Address getObjectAddress(CodeGenFunction &CGF) const {
2045 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002046
John McCall7f416cc2015-09-08 08:05:57 +00002047 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002048 }
2049 };
2050 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2051 void EmitAutoVarInit(const AutoVarEmission &emission);
2052 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002053 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2054 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002055
John McCall1c9c3fd2010-10-15 04:57:14 +00002056 void EmitStaticVarDecl(const VarDecl &D,
2057 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002058
John McCall7f416cc2015-09-08 08:05:57 +00002059 class ParamValue {
2060 llvm::Value *Value;
2061 unsigned Alignment;
2062 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2063 public:
2064 static ParamValue forDirect(llvm::Value *value) {
2065 return ParamValue(value, 0);
2066 }
2067 static ParamValue forIndirect(Address addr) {
2068 assert(!addr.getAlignment().isZero());
2069 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2070 }
2071
2072 bool isIndirect() const { return Alignment != 0; }
2073 llvm::Value *getAnyValue() const { return Value; }
2074
2075 llvm::Value *getDirectValue() const {
2076 assert(!isIndirect());
2077 return Value;
2078 }
2079
2080 Address getIndirectAddress() const {
2081 assert(isIndirect());
2082 return Address(Value, CharUnits::fromQuantity(Alignment));
2083 }
2084 };
2085
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002086 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002087 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002088
John McCallc07a0c72011-02-17 10:25:35 +00002089 /// protectFromPeepholes - Protect a value that we're intending to
2090 /// store to the side, but which will probably be used later, from
2091 /// aggressive peepholing optimizations that might delete it.
2092 ///
2093 /// Pass the result to unprotectFromPeepholes to declare that
2094 /// protection is no longer required.
2095 ///
2096 /// There's no particular reason why this shouldn't apply to
2097 /// l-values, it's just that no existing peepholes work on pointers.
2098 PeepholeProtection protectFromPeepholes(RValue rvalue);
2099 void unprotectFromPeepholes(PeepholeProtection protection);
2100
Chris Lattner84915fa2007-06-02 04:16:21 +00002101 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002102 // Statement Emission
2103 //===--------------------------------------------------------------------===//
2104
Mike Stumpfc496822009-02-08 23:14:22 +00002105 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002106 void EmitStopPoint(const Stmt *S);
2107
Mike Stumpfc496822009-02-08 23:14:22 +00002108 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2109 /// this function even if there is no current insertion point.
2110 ///
2111 /// This function may clear the current insertion point; callers should use
2112 /// EnsureInsertPoint if they wish to subsequently generate code without first
2113 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002114 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002115
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002116 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002117 /// necessarily require an insertion point or debug information; typically
2118 /// because the statement amounts to a jump or a container of other
2119 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002120 ///
2121 /// \return True if the statement was handled.
2122 bool EmitSimpleStmt(const Stmt *S);
2123
John McCall7f416cc2015-09-08 08:05:57 +00002124 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2125 AggValueSlot AVS = AggValueSlot::ignored());
2126 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2127 bool GetLast = false,
2128 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002129 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002130
Mike Stumpfc496822009-02-08 23:14:22 +00002131 /// EmitLabel - Emit the block for the given label. It is legal to call this
2132 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002133 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002134
Chris Lattnerac248202007-05-30 00:13:02 +00002135 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002136 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002137 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002138 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002139 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002140
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002141 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002142 ArrayRef<const Attr *> Attrs = None);
2143 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002144 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002145 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002146 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002147 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002148 void EmitBreakStmt(const BreakStmt &S);
2149 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002150 void EmitSwitchStmt(const SwitchStmt &S);
2151 void EmitDefaultStmt(const DefaultStmt &S);
2152 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002153 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002154 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002155
Anders Carlsson2e744e82008-08-30 19:51:14 +00002156 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002157 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2158 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002159 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002160 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002161
John McCallb609d3f2010-07-07 06:56:46 +00002162 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2163 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002164
Anders Carlsson52d78a52009-09-27 18:58:34 +00002165 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002166 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002167 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002168 void EnterSEHTryStmt(const SEHTryStmt &S);
2169 void ExitSEHTryStmt(const SEHTryStmt &S);
2170
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002171 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002172 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002173
2174 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2175 const SEHExceptStmt &Except);
2176
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002177 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2178 const SEHFinallyStmt &Finally);
2179
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002180 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2181 llvm::Value *ParentFP,
2182 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002183 llvm::Value *EmitSEHExceptionCode();
2184 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002185 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002186
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002187 /// Scan the outlined statement for captures from the parent function. For
2188 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002189 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002190 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002191 bool IsFilter);
2192
2193 /// Recovers the address of a local in a parent function. ParentVar is the
2194 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002195 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002196 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2197 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002198 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2199 Address ParentVar,
2200 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002201
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002202 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002203 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002204
Alexey Bataev330de032014-10-29 12:21:55 +00002205 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002206 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002207 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002208 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002209 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002210 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002211 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002212 /// \brief Perform element by element copying of arrays with type \a
2213 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2214 /// generated by \a CopyGen.
2215 ///
2216 /// \param DestAddr Address of the destination array.
2217 /// \param SrcAddr Address of the source array.
2218 /// \param OriginalType Type of destination and source arrays.
2219 /// \param CopyGen Copying procedure that copies value of single array element
2220 /// to another single array element.
2221 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002222 Address DestAddr, Address SrcAddr, QualType OriginalType,
2223 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002224 /// \brief Emit proper copying of data from one variable to another.
2225 ///
2226 /// \param OriginalType Original type of the copied variables.
2227 /// \param DestAddr Destination address.
2228 /// \param SrcAddr Source address.
2229 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2230 /// type of the base array element).
2231 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2232 /// the base array element).
2233 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2234 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002235 void EmitOMPCopy(QualType OriginalType,
2236 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002237 const VarDecl *DestVD, const VarDecl *SrcVD,
2238 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002239 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2240 /// \a X = \a E \a BO \a E.
2241 ///
2242 /// \param X Value to be updated.
2243 /// \param E Update value.
2244 /// \param BO Binary operation for update operation.
2245 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2246 /// expression, false otherwise.
2247 /// \param AO Atomic ordering of the generated atomic instructions.
2248 /// \param CommonGen Code generator for complex expressions that cannot be
2249 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002250 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2251 /// generated, <false, RValue::get(nullptr)> otherwise.
2252 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002253 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2254 llvm::AtomicOrdering AO, SourceLocation Loc,
2255 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002256 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002257 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002258 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2259 OMPPrivateScope &PrivateScope);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002260 /// \brief Emit code for copyin clause in \a D directive. The next code is
2261 /// generated at the start of outlined functions for directives:
2262 /// \code
2263 /// threadprivate_var1 = master_threadprivate_var1;
2264 /// operator=(threadprivate_var2, master_threadprivate_var2);
2265 /// ...
2266 /// __kmpc_barrier(&loc, global_tid);
2267 /// \endcode
2268 ///
2269 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2270 /// \returns true if at least one copyin variable is found, false otherwise.
2271 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002272 /// \brief Emit initial code for lastprivate variables. If some variable is
2273 /// not also firstprivate, then the default initialization is used. Otherwise
2274 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2275 /// method.
2276 ///
2277 /// \param D Directive that may have 'lastprivate' directives.
2278 /// \param PrivateScope Private scope for capturing lastprivate variables for
2279 /// proper codegen in internal captured statement.
2280 ///
2281 /// \returns true if there is at least one lastprivate variable, false
2282 /// otherwise.
2283 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2284 OMPPrivateScope &PrivateScope);
2285 /// \brief Emit final copying of lastprivate values to original variables at
2286 /// the end of the worksharing or simd directive.
2287 ///
2288 /// \param D Directive that has at least one 'lastprivate' directives.
2289 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2290 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002291 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002292 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002293 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002294 /// \brief Emit initial code for reduction variables. Creates reduction copies
2295 /// and initializes them with the values according to OpenMP standard.
2296 ///
2297 /// \param D Directive (possibly) with the 'reduction' clause.
2298 /// \param PrivateScope Private scope for capturing reduction variables for
2299 /// proper codegen in internal captured statement.
2300 ///
2301 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2302 OMPPrivateScope &PrivateScope);
2303 /// \brief Emit final update of reduction values to original variables at
2304 /// the end of the directive.
2305 ///
2306 /// \param D Directive that has at least one 'reduction' directives.
2307 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002308 /// \brief Emit initial code for linear variables. Creates private copies
2309 /// and initializes them with the values according to OpenMP standard.
2310 ///
2311 /// \param D Directive (possibly) with the 'linear' clause.
2312 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002313
2314 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002315 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002316 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002317 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002318 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002319 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002320 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002321 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002322 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002323 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002324 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002325 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002326 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002327 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002328 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002329 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002330 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002331 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002332 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002333 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002334 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002335 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002336 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002337 void
2338 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002339 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002340 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002341
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002342 /// \brief Emit inner loop of the worksharing/simd construct.
2343 ///
2344 /// \param S Directive, for which the inner loop must be emitted.
2345 /// \param RequiresCleanup true, if directive has some associated private
2346 /// variables.
2347 /// \param LoopCond Bollean condition for loop continuation.
2348 /// \param IncExpr Increment expression for loop control variable.
2349 /// \param BodyGen Generator for the inner body of the inner loop.
2350 /// \param PostIncGen Genrator for post-increment code (required for ordered
2351 /// loop directvies).
2352 void EmitOMPInnerLoop(
2353 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2354 const Expr *IncExpr,
2355 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2356 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002357
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002358 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
2359
Alexander Musmanc6388682014-12-15 07:07:06 +00002360private:
2361
2362 /// Helpers for the OpenMP loop directives.
Alexey Bataev0f34da12015-07-02 04:17:07 +00002363 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
Alexey Bataev58e5bdb2015-06-18 04:45:29 +00002364 void EmitOMPSimdInit(const OMPLoopDirective &D);
2365 void EmitOMPSimdFinal(const OMPLoopDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002366 /// \brief Emit code for the worksharing loop-based directive.
2367 /// \return true, if this construct has any lastprivate clause, false -
2368 /// otherwise.
2369 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Alexander Musmandf7a8e22015-01-22 08:49:35 +00002370 void EmitOMPForOuterLoop(OpenMPScheduleClauseKind ScheduleKind,
2371 const OMPLoopDirective &S,
Alexey Bataevd7589ffe2015-05-20 13:12:48 +00002372 OMPPrivateScope &LoopScope, bool Ordered,
John McCall7f416cc2015-09-08 08:05:57 +00002373 Address LB, Address UB, Address ST,
2374 Address IL, llvm::Value *Chunk);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002375 /// \brief Emit code for sections directive.
2376 OpenMPDirectiveKind EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002377
2378public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002379
Chris Lattner208ae962007-05-30 17:57:17 +00002380 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002381 // LValue Expression Emission
2382 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002383
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002384 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2385 RValue GetUndefRValue(QualType Ty);
2386
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002387 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2388 /// and issue an ErrorUnsupported style diagnostic (using the
2389 /// provided Name).
2390 RValue EmitUnsupportedRValue(const Expr *E,
2391 const char *Name);
2392
Mike Stumpfc496822009-02-08 23:14:22 +00002393 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2394 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002395 LValue EmitUnsupportedLValue(const Expr *E,
2396 const char *Name);
2397
Chris Lattner8394d792007-06-05 20:53:16 +00002398 /// EmitLValue - Emit code to compute a designator that specifies the location
2399 /// of the expression.
2400 ///
2401 /// This can return one of two things: a simple address or a bitfield
2402 /// reference. In either case, the LLVM Value* in the LValue structure is
2403 /// guaranteed to be an LLVM pointer type.
2404 ///
2405 /// If this returns a bitfield reference, nothing about the pointee type of
2406 /// the LLVM value is known: For example, it may not be a pointer to an
2407 /// integer.
2408 ///
2409 /// If this returns a normal address, and if the lvalue's C type is fixed
2410 /// size, this method guarantees that the returned pointer type will point to
2411 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2412 /// variable length type, this is not possible.
2413 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002414 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002415
Richard Smith4d1458e2012-09-08 02:08:36 +00002416 /// \brief Same as EmitLValue but additionally we generate checking code to
2417 /// guard against undefined behavior. This is only suitable when we know
2418 /// that the address will be used to access the object.
2419 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002420
John McCall7f416cc2015-09-08 08:05:57 +00002421 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002422 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002423
John McCalla8ec7eb2013-03-07 21:37:17 +00002424 void EmitAtomicInit(Expr *E, LValue lvalue);
2425
David Majnemera5b195a2015-02-14 01:35:12 +00002426 bool LValueIsSuitableForInlineAtomic(LValue Src);
2427 bool typeIsSuitableForInlineAtomic(QualType Ty, bool IsVolatile) const;
2428
2429 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2430 AggValueSlot Slot = AggValueSlot::ignored());
2431
Nick Lewycky2d84e842013-10-02 02:29:49 +00002432 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002433 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002434 AggValueSlot slot = AggValueSlot::ignored());
2435
2436 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2437
David Majnemera5b195a2015-02-14 01:35:12 +00002438 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2439 bool IsVolatile, bool isInit);
2440
Alexey Bataevb4505a72015-03-30 05:20:59 +00002441 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002442 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
2443 llvm::AtomicOrdering Success = llvm::SequentiallyConsistent,
2444 llvm::AtomicOrdering Failure = llvm::SequentiallyConsistent,
2445 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2446
Alexey Bataevb4505a72015-03-30 05:20:59 +00002447 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002448 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002449 bool IsVolatile);
2450
John McCall3a7f6922010-10-27 20:58:56 +00002451 /// EmitToMemory - Change a scalar value from its value
2452 /// representation to its in-memory representation.
2453 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2454
2455 /// EmitFromMemory - Change a scalar value from its memory
2456 /// representation to its value representation.
2457 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2458
Daniel Dunbar1d425462009-02-10 00:57:50 +00002459 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2460 /// care to appropriately convert from the memory representation to
2461 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002462 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002463 SourceLocation Loc,
John McCall7f416cc2015-09-08 08:05:57 +00002464 AlignmentSource AlignSource =
2465 AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002466 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002467 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002468 uint64_t TBAAOffset = 0,
2469 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002470
2471 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2472 /// care to appropriately convert from the memory representation to
2473 /// the LLVM value representation. The l-value must be a simple
2474 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002475 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002476
2477 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2478 /// care to appropriately convert from the memory representation to
2479 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002480 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
2481 bool Volatile, QualType Ty,
2482 AlignmentSource AlignSource = AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002483 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002484 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002485 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002486
2487 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2488 /// care to appropriately convert from the memory representation to
2489 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002490 /// l-value. The isInit flag indicates whether this is an initialization.
2491 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2492 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002493
Chris Lattner8394d792007-06-05 20:53:16 +00002494 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2495 /// this method emits the address of the lvalue, then loads the result as an
2496 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002497 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002498 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2499 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002500 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002501
Chris Lattner8394d792007-06-05 20:53:16 +00002502 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2503 /// lvalue, where both are guaranteed to the have the same type, and that type
2504 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002505 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002506 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002507 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002508
Nick Lewycky2d84e842013-10-02 02:29:49 +00002509 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2510 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002511 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002512 /// \param Result [out] - If non-null, this will be set to a Value* for the
2513 /// bit-field contents after the store, appropriate for use as the result of
2514 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002515 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002516 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002517
John McCall4f29b492010-11-16 23:07:28 +00002518 /// Emit an l-value for an assignment (simple or compound) of complex type.
2519 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002520 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002521 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2522 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002523
Chris Lattner57540c52011-04-15 05:22:18 +00002524 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002525 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002526 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002527 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002528 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002529 // Note: only available for agg return types
2530 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002531 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002532 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002533 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002534 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002535 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002536 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2537 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00002538 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
2539 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002540 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002541 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002542 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002543 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002544 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002545 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002546 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002547 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002548 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002549
John McCall7f416cc2015-09-08 08:05:57 +00002550 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002551
Nick Lewycky2d84e842013-10-02 02:29:49 +00002552 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002553
John McCall7f416cc2015-09-08 08:05:57 +00002554 Address EmitArrayToPointerDecay(const Expr *Array,
2555 AlignmentSource *AlignSource = nullptr);
2556
John McCall71335052012-03-10 03:05:10 +00002557 class ConstantEmission {
2558 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2559 ConstantEmission(llvm::Constant *C, bool isReference)
2560 : ValueAndIsReference(C, isReference) {}
2561 public:
2562 ConstantEmission() {}
2563 static ConstantEmission forReference(llvm::Constant *C) {
2564 return ConstantEmission(C, true);
2565 }
2566 static ConstantEmission forValue(llvm::Constant *C) {
2567 return ConstantEmission(C, false);
2568 }
2569
Aaron Ballman67347662015-02-15 22:00:28 +00002570 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002571 return ValueAndIsReference.getOpaqueValue() != nullptr;
2572 }
John McCall71335052012-03-10 03:05:10 +00002573
2574 bool isReference() const { return ValueAndIsReference.getInt(); }
2575 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2576 assert(isReference());
2577 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2578 refExpr->getType());
2579 }
2580
2581 llvm::Constant *getValue() const {
2582 assert(!isReference());
2583 return ValueAndIsReference.getPointer();
2584 }
2585 };
2586
John McCall113bee02012-03-10 09:33:50 +00002587 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002588
John McCallfe96e0b2011-11-06 09:01:30 +00002589 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2590 AggValueSlot slot = AggValueSlot::ignored());
2591 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2592
Daniel Dunbar722f4242009-04-22 05:08:15 +00002593 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002594 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002595 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002596 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002597
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002598 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2599 /// if the Field is a reference, this will return the address of the reference
2600 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002601 LValue EmitLValueForFieldInitialization(LValue Base,
2602 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002603
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002604 LValue EmitLValueForIvar(QualType ObjectTy,
2605 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002606 unsigned CVRQualifiers);
2607
Anders Carlsson3be22e22009-05-30 23:23:33 +00002608 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002609 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002610 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002611 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002612 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002613
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002614 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002615 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002616 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002617 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002618 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002619 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002620
Chris Lattnerd7f58862007-06-02 05:24:33 +00002621 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002622 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002623 //===--------------------------------------------------------------------===//
2624
Mike Stumpfc496822009-02-08 23:14:22 +00002625 /// EmitCall - Generate a call of the given function, expecting the given
2626 /// result type, and using the given argument list which specifies both the
2627 /// LLVM arguments and the types they were derived from.
Samuel Antao798f11c2015-11-23 22:04:44 +00002628 RValue EmitCall(const CGFunctionInfo &FnInfo, llvm::Value *Callee,
2629 ReturnValueSlot ReturnValue, const CallArgList &Args,
2630 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Craig Topper8a13c412014-05-21 05:09:00 +00002631 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002632
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002633 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002634 ReturnValueSlot ReturnValue,
Samuel Antao798f11c2015-11-23 22:04:44 +00002635 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Peter Collingbournef7706832014-12-12 23:41:25 +00002636 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002637 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002638 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002639
Eric Christopherc7e79db2015-11-12 00:44:04 +00002640 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00002641
John McCall882987f2013-02-28 19:01:20 +00002642 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2643 const Twine &name = "");
2644 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2645 ArrayRef<llvm::Value*> args,
2646 const Twine &name = "");
2647 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2648 const Twine &name = "");
2649 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2650 ArrayRef<llvm::Value*> args,
2651 const Twine &name = "");
2652
John McCallbd309292010-07-06 01:34:17 +00002653 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002654 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002655 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002656 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2657 ArrayRef<llvm::Value*> args,
2658 const Twine &name = "");
2659 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2660 const Twine &name = "");
2661 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2662 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002663
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002664 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2665 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002666 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002667
2668 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2669 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002670 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002671
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002672 RValue
2673 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2674 ReturnValueSlot ReturnValue, llvm::Value *This,
2675 llvm::Value *ImplicitParam,
2676 QualType ImplicitParamTy, const CallExpr *E);
David Majnemer0c0b6d92014-10-31 20:09:12 +00002677 RValue EmitCXXStructorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2678 ReturnValueSlot ReturnValue, llvm::Value *This,
2679 llvm::Value *ImplicitParam,
2680 QualType ImplicitParamTy, const CallExpr *E,
2681 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002682 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2683 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002684 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2685 const CXXMethodDecl *MD,
2686 ReturnValueSlot ReturnValue,
2687 bool HasQualifier,
2688 NestedNameSpecifier *Qualifier,
2689 bool IsArrow, const Expr *Base);
2690 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002691 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
2692 llvm::Value *memberPtr,
2693 const MemberPointerType *memberPtrType,
2694 AlignmentSource *AlignSource = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002695 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2696 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002697
Anders Carlsson4034a952009-05-27 04:18:27 +00002698 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002699 const CXXMethodDecl *MD,
2700 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002701
Peter Collingbournefe883422011-10-06 18:29:37 +00002702 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2703 ReturnValueSlot ReturnValue);
2704
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002705
Mike Stump11289f42009-09-09 15:08:12 +00002706 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002707 unsigned BuiltinID, const CallExpr *E,
2708 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002709
Anders Carlssonbfb36712009-12-24 21:13:40 +00002710 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002711
Mike Stumpfc496822009-02-08 23:14:22 +00002712 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2713 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002714 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2715
Kevin Qin1718af62013-11-14 02:45:18 +00002716 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2717 const llvm::CmpInst::Predicate Fp,
2718 const llvm::CmpInst::Predicate Ip,
2719 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002720 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002721
2722 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2723 unsigned LLVMIntrinsic,
2724 unsigned AltLLVMIntrinsic,
2725 const char *NameHint,
2726 unsigned Modifier,
2727 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002728 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00002729 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00002730 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2731 unsigned Modifier, llvm::Type *ArgTy,
2732 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002733 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002734 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002735 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002736 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002737 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002738 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002739 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002740 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2741 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00002742 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00002743 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002744
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002745 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002746 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2747 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00002748 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00002749 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00002750 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00002751 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
2752 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002753
Daniel Dunbar66912a12008-08-20 00:28:19 +00002754 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002755 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002756 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002757 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2758 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2759 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002760 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002761 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002762 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2763 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002764
John McCall31168b02011-06-15 23:02:42 +00002765 /// Retrieves the default cleanup kind for an ARC cleanup.
2766 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2767 CleanupKind getARCCleanupKind() {
2768 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2769 ? NormalAndEHCleanup : NormalCleanup;
2770 }
2771
2772 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00002773 void EmitARCInitWeak(Address addr, llvm::Value *value);
2774 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00002775 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00002776 llvm::Value *EmitARCLoadWeakRetained(Address addr);
2777 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
2778 void EmitARCCopyWeak(Address dst, Address src);
2779 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00002780 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2781 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002782 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002783 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00002784 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002785 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002786 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2787 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002788 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00002789 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00002790 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCall31168b02011-06-15 23:02:42 +00002791 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2792 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2793 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2794 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2795
2796 std::pair<LValue,llvm::Value*>
2797 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2798 std::pair<LValue,llvm::Value*>
2799 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2800
John McCall248512a2011-10-01 10:32:24 +00002801 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002802 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2803 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2804
John McCallff613032011-10-04 06:23:45 +00002805 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002806 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2807 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2808
Craig Topper00bbdcf2014-06-28 23:22:23 +00002809 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002810
John McCall82fe67b2011-07-09 01:37:26 +00002811 static Destroyer destroyARCStrongImprecise;
2812 static Destroyer destroyARCStrongPrecise;
2813 static Destroyer destroyARCWeak;
2814
John McCall31168b02011-06-15 23:02:42 +00002815 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2816 llvm::Value *EmitObjCAutoreleasePoolPush();
2817 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2818 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2819 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2820
Richard Smitha1c9d4d2013-06-12 23:38:09 +00002821 /// \brief Emits a reference binding to the passed in expression.
2822 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002823
Chris Lattner6278e6a2007-08-11 00:04:45 +00002824 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002825 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002826 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002827
2828 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002829
2830 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2831 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002832 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002833
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00002834 /// Emit a conversion from the specified type to the specified destination
2835 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00002836 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00002837 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00002838
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00002839 /// Emit a conversion from the specified complex type to the specified
2840 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002841 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00002842 QualType DstTy,
2843 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00002844
John McCall7a626f62010-09-15 10:14:12 +00002845 /// EmitAggExpr - Emit the computation of the specified expression
2846 /// of aggregate type. The result is computed into the given slot,
2847 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002848 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002849
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002850 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2851 /// aggregate type into a temporary LValue.
2852 LValue EmitAggExprToLValue(const Expr *E);
2853
John McCall1bd25562011-06-24 23:21:27 +00002854 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2855 /// make sure it survives garbage collection until this point.
2856 void EmitExtendGCLifetime(llvm::Value *object);
2857
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002858 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002859 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002860 ComplexPairTy EmitComplexExpr(const Expr *E,
2861 bool IgnoreReal = false,
2862 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002863
John McCall47fb9502013-03-07 21:37:08 +00002864 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2865 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002866 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002867
John McCall47fb9502013-03-07 21:37:08 +00002868 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002869 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00002870
2871 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002872 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002873
John McCall7f416cc2015-09-08 08:05:57 +00002874 Address emitAddrOfRealComponent(Address complex, QualType complexType);
2875 Address emitAddrOfImagComponent(Address complex, QualType complexType);
2876
Chandler Carruth84537952012-03-30 19:44:53 +00002877 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2878 /// global variable that has already been created for it. If the initializer
2879 /// has a different type than GV does, this may free GV and return a different
2880 /// one. Otherwise it just returns GV.
2881 llvm::GlobalVariable *
2882 AddInitializerToStaticVarDecl(const VarDecl &D,
2883 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002884
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002885
Anders Carlssonf40886a2009-08-08 21:45:14 +00002886 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2887 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002888 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2889 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002890
David Majnemerb3341ea2014-10-05 05:05:40 +00002891 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
2892 llvm::Constant *Addr);
2893
John McCallc84ed6a2012-05-01 06:13:13 +00002894 /// Call atexit() with a function that passes the given argument to
2895 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00002896 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2897 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002898
John McCallcdf7ef52010-11-06 09:44:32 +00002899 /// Emit code in this function to perform a guarded variable
2900 /// initialization. Guarded initializations are used when it's not
2901 /// possible to prove that an initialization will be done exactly
2902 /// once, e.g. with a static local variable or a static data member
2903 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002904 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002905 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002906
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002907 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2908 /// variables.
2909 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00002910 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00002911 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002912
John McCallee08c532012-04-06 18:21:03 +00002913 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002914 /// variables.
John McCallee08c532012-04-06 18:21:03 +00002915 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2916 const std::vector<std::pair<llvm::WeakVH,
2917 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002918
John McCalla738c252011-03-09 04:27:21 +00002919 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2920 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00002921 llvm::GlobalVariable *Addr,
2922 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002923
John McCall7a626f62010-09-15 10:14:12 +00002924 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002925
John McCall7f416cc2015-09-08 08:05:57 +00002926 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00002927
John McCall08ef4662011-11-10 08:15:53 +00002928 void enterFullExpression(const ExprWithCleanups *E) {
2929 if (E->getNumObjects() == 0) return;
2930 enterNonTrivialFullExpression(E);
2931 }
2932 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00002933
Richard Smithea852322013-05-07 21:53:22 +00002934 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00002935
Eli Friedmanc370a7e2012-02-09 03:32:31 +00002936 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2937
Tim Northovercc2a6e02015-11-09 19:56:35 +00002938 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00002939
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002940 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002941 // Annotations Emission
2942 //===--------------------------------------------------------------------===//
2943
2944 /// Emit an annotation call (intrinsic or builtin).
2945 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2946 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002947 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002948 SourceLocation Location);
2949
2950 /// Emit local annotations for the local variable V, declared by D.
2951 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2952
2953 /// Emit field annotations for the given field & value. Returns the
2954 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00002955 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002956
2957 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002958 // Internal Helpers
2959 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002960
Chris Lattner5b1964b2008-11-11 07:41:27 +00002961 /// ContainsLabel - Return true if the statement contains a label in it. If
2962 /// this statement is not executed normally, it not containing a label means
2963 /// that we can just remove the code.
2964 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002965
Chris Lattner29911cc2011-02-28 00:18:40 +00002966 /// containsBreak - Return true if the statement contains a break out of it.
2967 /// If the statement (recursively) contains a switch or loop with a break
2968 /// inside of it, this is fine.
2969 static bool containsBreak(const Stmt *S);
2970
Daniel Dunbar682712c2008-11-12 10:12:14 +00002971 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00002972 /// to a constant, or if it does but contains a label, return false. If it
2973 /// constant folds return true and set the boolean result in Result.
2974 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00002975
Chris Lattner29911cc2011-02-28 00:18:40 +00002976 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2977 /// to a constant, or if it does but contains a label, return false. If it
2978 /// constant folds return true and set the folded value.
Richard Trieuc320c742012-07-23 20:21:35 +00002979 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattner29911cc2011-02-28 00:18:40 +00002980
Chris Lattnercd439292008-11-12 08:04:58 +00002981 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2982 /// if statement) to the specified blocks. Based on the condition, this might
2983 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00002984 /// TrueCount should be the number of times we expect the condition to
2985 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00002986 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00002987 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00002988
Richard Smithe30752c2012-10-09 19:52:38 +00002989 /// \brief Emit a description of a type in a format suitable for passing to
2990 /// a runtime sanitizer handler.
2991 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2992
2993 /// \brief Convert a value into a format suitable for passing to a runtime
2994 /// sanitizer handler.
2995 llvm::Value *EmitCheckValue(llvm::Value *V);
2996
2997 /// \brief Emit a description of a source location in a format suitable for
2998 /// passing to a runtime sanitizer handler.
2999 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3000
Richard Smithde670682012-11-01 22:15:34 +00003001 /// \brief Create a basic block that will call a handler function in a
3002 /// sanitizer runtime with the provided arguments, and create a conditional
3003 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003004 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003005 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
3006 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003007
Richard Smithde670682012-11-01 22:15:34 +00003008 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3009 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003010 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003011
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003012 /// \brief Emit a call to trap or debugtrap and attach function attribute
3013 /// "trap-func-name" if specified.
3014 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3015
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003016 /// \brief Create a check for a function parameter that may potentially be
3017 /// declared as non-null.
3018 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
3019 const FunctionDecl *FD, unsigned ParmNum);
3020
Anders Carlsson093bdff2010-03-30 03:27:09 +00003021 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003022 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003023
John McCall23f66262010-05-26 22:34:26 +00003024 /// EmitDelegateCallArg - We are performing a delegate call; that
3025 /// is, the current function is delegating to another one. Produce
3026 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003027 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3028 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003029
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003030 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3031 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003032 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003033
Chris Lattnercd439292008-11-12 08:04:58 +00003034private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003035 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003036 void EmitReturnOfRValue(RValue RV, QualType Ty);
3037
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003038 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3039
3040 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3041 DeferredReplacements;
3042
John McCall7f416cc2015-09-08 08:05:57 +00003043 /// Set the address of a local variable.
3044 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3045 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3046 LocalDeclMap.insert({VD, Addr});
3047 }
3048
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003049 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3050 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3051 ///
3052 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003053 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
3054 SmallVectorImpl<llvm::Argument *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003055
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003056 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3057 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3058 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3059 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3060 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3061 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003062
Chad Rosier59df25b2012-08-23 20:00:18 +00003063 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003064 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003065
Chad Rosier59df25b2012-08-23 20:00:18 +00003066 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003067 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003068 std::string &ConstraintStr,
3069 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003070
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003071 /// \brief Attempts to statically evaluate the object size of E. If that
3072 /// fails, emits code to figure the size of E out for us. This is
3073 /// pass_object_size aware.
3074 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
3075 llvm::IntegerType *ResType);
3076
3077 /// \brief Emits the size of E, as required by __builtin_object_size. This
3078 /// function is aware of pass_object_size parameters, and will act accordingly
3079 /// if E is a parameter with the pass_object_size attribute.
3080 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
3081 llvm::IntegerType *ResType);
3082
Reid Kleckner89077a12013-12-17 19:46:40 +00003083public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003084#ifndef NDEBUG
3085 // Determine whether the given argument is an Objective-C method
3086 // that may have type parameters in its signature.
3087 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3088 const DeclContext *dc = method->getDeclContext();
3089 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3090 return classDecl->getTypeParamListAsWritten();
3091 }
3092
3093 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3094 return catDecl->getTypeParamList();
3095 }
3096
3097 return false;
3098 }
3099
3100 template<typename T>
3101 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3102#endif
3103
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003104 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003105 template <typename T>
3106 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003107 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003108 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00003109 unsigned ParamsToSkip = 0) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003110 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003111 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003112
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003113 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3114 "Can't skip parameters if type info is not provided");
3115 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003116#ifndef NDEBUG
3117 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3118#endif
3119
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003120 // First, use the argument types that the type info knows about
3121 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3122 E = CallArgTypeInfo->param_type_end();
3123 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003124 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003125 assert((isGenericMethod ||
3126 ((*I)->isVariablyModifiedType() ||
3127 (*I).getNonReferenceType()->isObjCRetainableType() ||
3128 getContext()
3129 .getCanonicalType((*I).getNonReferenceType())
3130 .getTypePtr() ==
3131 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003132 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003133 .getTypePtr())) &&
3134 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003135 ArgTypes.push_back(*I);
3136 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003137 }
Mike Stump11289f42009-09-09 15:08:12 +00003138
Reid Kleckner739756c2013-12-04 19:23:12 +00003139 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003140 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003141 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3142 CallArgTypeInfo->isVariadic()) &&
3143 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003144
Anders Carlsson603d6af2009-04-18 20:20:22 +00003145 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003146 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
3147 ArgTypes.push_back(getVarArgType(A));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003148
David Blaikief05779e2015-07-21 18:37:18 +00003149 EmitCallArgs(Args, ArgTypes, ArgRange, CalleeDecl, ParamsToSkip);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003150 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003151
Reid Kleckner739756c2013-12-04 19:23:12 +00003152 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003153 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003154 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00003155 unsigned ParamsToSkip = 0);
Reid Kleckner739756c2013-12-04 19:23:12 +00003156
John McCall7f416cc2015-09-08 08:05:57 +00003157 /// EmitPointerWithAlignment - Given an expression with a pointer
3158 /// type, emit the value and compute our best estimate of the
3159 /// alignment of the pointee.
3160 ///
3161 /// Note that this function will conservatively fall back on the type
3162 /// when it doesn't
3163 ///
3164 /// \param Source - If non-null, this will be initialized with
3165 /// information about the source of the alignment. Note that this
3166 /// function will conservatively fall back on the type when it
3167 /// doesn't recognize the expression, which means that sometimes
3168 ///
3169 /// a worst-case One
3170 /// reasonable way to use this information is when there's a
3171 /// language guarantee that the pointer must be aligned to some
3172 /// stricter value, and we're simply trying to ensure that
3173 /// sufficiently obvious uses of under-aligned objects don't get
3174 /// miscompiled; for example, a placement new into the address of
3175 /// a local variable. In such a case, it's quite reasonable to
3176 /// just ignore the returned alignment when it isn't from an
3177 /// explicit source.
3178 Address EmitPointerWithAlignment(const Expr *Addr,
3179 AlignmentSource *Source = nullptr);
3180
Reid Kleckner89077a12013-12-17 19:46:40 +00003181private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003182 QualType getVarArgType(const Expr *Arg);
3183
John McCalld4f4b7f2010-03-03 04:15:11 +00003184 const TargetCodeGenInfo &getTargetHooks() const {
3185 return CGM.getTargetCodeGenInfo();
3186 }
John McCall09ae0322010-07-06 23:57:41 +00003187
3188 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003189
John McCall7f416cc2015-09-08 08:05:57 +00003190 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3191 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003192
3193 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003194
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003195 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003196};
Mike Stump11289f42009-09-09 15:08:12 +00003197
John McCallce1de612011-01-26 04:00:11 +00003198/// Helper class with most of the code for saving a value for a
3199/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003200struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003201 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3202
3203 /// Answer whether the given value needs extra work to be saved.
3204 static bool needsSaving(llvm::Value *value) {
3205 // If it's not an instruction, we don't need to save.
3206 if (!isa<llvm::Instruction>(value)) return false;
3207
3208 // If it's an instruction in the entry block, we don't need to save.
3209 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3210 return (block != &block->getParent()->getEntryBlock());
3211 }
3212
3213 /// Try to save the given value.
3214 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3215 if (!needsSaving(value)) return saved_type(value, false);
3216
John McCall7f416cc2015-09-08 08:05:57 +00003217 // Otherwise, we need an alloca.
3218 auto align = CharUnits::fromQuantity(
3219 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3220 Address alloca =
3221 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003222 CGF.Builder.CreateStore(value, alloca);
3223
John McCall7f416cc2015-09-08 08:05:57 +00003224 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003225 }
3226
3227 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003228 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003229 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003230
3231 // Otherwise, it should be an alloca instruction, as set up in save().
3232 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3233 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003234 }
3235};
3236
John McCallcb5f77f2011-01-28 10:53:53 +00003237/// A partial specialization of DominatingValue for llvm::Values that
3238/// might be llvm::Instructions.
3239template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3240 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003241 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003242 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3243 }
3244};
3245
John McCall7f416cc2015-09-08 08:05:57 +00003246/// A specialization of DominatingValue for Address.
3247template <> struct DominatingValue<Address> {
3248 typedef Address type;
3249
3250 struct saved_type {
3251 DominatingLLVMValue::saved_type SavedValue;
3252 CharUnits Alignment;
3253 };
3254
3255 static bool needsSaving(type value) {
3256 return DominatingLLVMValue::needsSaving(value.getPointer());
3257 }
3258 static saved_type save(CodeGenFunction &CGF, type value) {
3259 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3260 value.getAlignment() };
3261 }
3262 static type restore(CodeGenFunction &CGF, saved_type value) {
3263 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3264 value.Alignment);
3265 }
3266};
3267
John McCallcb5f77f2011-01-28 10:53:53 +00003268/// A specialization of DominatingValue for RValue.
3269template <> struct DominatingValue<RValue> {
3270 typedef RValue type;
3271 class saved_type {
3272 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3273 AggregateAddress, ComplexAddress };
3274
3275 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003276 unsigned K : 3;
3277 unsigned Align : 29;
3278 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3279 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003280
3281 public:
3282 static bool needsSaving(RValue value);
3283 static saved_type save(CodeGenFunction &CGF, RValue value);
3284 RValue restore(CodeGenFunction &CGF);
3285
John McCall7f416cc2015-09-08 08:05:57 +00003286 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003287 };
3288
3289 static bool needsSaving(type value) {
3290 return saved_type::needsSaving(value);
3291 }
3292 static saved_type save(CodeGenFunction &CGF, type value) {
3293 return saved_type::save(CGF, value);
3294 }
3295 static type restore(CodeGenFunction &CGF, saved_type value) {
3296 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003297 }
3298};
3299
Chris Lattnerbed31442007-05-28 01:07:47 +00003300} // end namespace CodeGen
3301} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003302
Chris Lattnerbed31442007-05-28 01:07:47 +00003303#endif