blob: af7e6114af63de2acd976faf8bff6a5688d31763 [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"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000033#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000034#include "llvm/ADT/ArrayRef.h"
35#include "llvm/ADT/DenseMap.h"
36#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000037#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000038#include "llvm/Support/Debug.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000039#include "llvm/Transforms/Utils/SanitizerStats.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000040
Chris Lattnerbed31442007-05-28 01:07:47 +000041namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000042class BasicBlock;
43class LLVMContext;
44class MDNode;
45class Module;
46class SwitchInst;
47class Twine;
48class Value;
49class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000050}
51
Chris Lattnerbed31442007-05-28 01:07:47 +000052namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000053class ASTContext;
54class BlockDecl;
55class CXXDestructorDecl;
56class CXXForRangeStmt;
57class CXXTryStmt;
58class Decl;
59class LabelDecl;
60class EnumConstantDecl;
61class FunctionDecl;
62class FunctionProtoType;
63class LabelStmt;
64class ObjCContainerDecl;
65class ObjCInterfaceDecl;
66class ObjCIvarDecl;
67class ObjCMethodDecl;
68class ObjCImplementationDecl;
69class ObjCPropertyImplDecl;
70class TargetInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000071class 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;
Alexey Bataev7292c292016-04-25 12:22:29 +000088class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000089class TargetCodeGenInfo;
Alexey Bataev24b5bae2016-04-28 09:23:51 +000090struct OMPTaskDataTy;
Mike Stumpfc496822009-02-08 23:14:22 +000091
John McCall47fb9502013-03-07 21:37:08 +000092/// The kind of evaluation to perform on values of a particular
93/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
94/// CGExprAgg?
95///
96/// TODO: should vectors maybe be split out into their own thing?
97enum TypeEvaluationKind {
98 TEK_Scalar,
99 TEK_Complex,
100 TEK_Aggregate
101};
102
Chris Lattnerbed31442007-05-28 01:07:47 +0000103/// CodeGenFunction - This class organizes the per-function state that is used
104/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000105class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000106 CodeGenFunction(const CodeGenFunction &) = delete;
107 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000108
109 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000110public:
John McCallad5d61e2010-07-23 21:56:41 +0000111 /// A jump destination is an abstract label, branching to which may
112 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000113 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000114 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000115 JumpDest(llvm::BasicBlock *Block,
116 EHScopeStack::stable_iterator Depth,
117 unsigned Index)
118 : Block(Block), ScopeDepth(Depth), Index(Index) {}
119
Craig Topper8a13c412014-05-21 05:09:00 +0000120 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000121 llvm::BasicBlock *getBlock() const { return Block; }
122 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
123 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000124
Nadav Rotem1da30942013-03-23 06:43:35 +0000125 // This should be used cautiously.
126 void setScopeDepth(EHScopeStack::stable_iterator depth) {
127 ScopeDepth = depth;
128 }
129
John McCallad5d61e2010-07-23 21:56:41 +0000130 private:
John McCallbd309292010-07-06 01:34:17 +0000131 llvm::BasicBlock *Block;
132 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000133 unsigned Index;
134 };
135
Chris Lattnerbed31442007-05-28 01:07:47 +0000136 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000137 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000138
Chris Lattner96d72562007-08-21 16:57:55 +0000139 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000140 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000141 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000142
Alexander Musman515ad8c2014-05-22 08:54:05 +0000143 /// \brief CGBuilder insert helper. This function is called after an
144 /// instruction is created using Builder.
145 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
146 llvm::BasicBlock *BB,
147 llvm::BasicBlock::iterator InsertPt) const;
148
John McCalldec348f72013-05-03 07:33:41 +0000149 /// CurFuncDecl - Holds the Decl for the current outermost
150 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000151 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000152 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
153 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000154 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000155 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000156 llvm::Function *CurFn;
157
Mike Stumpbee78dd2009-12-04 23:26:17 +0000158 /// CurGD - The GlobalDecl for the current function being compiled.
159 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000160
John McCall31168b02011-06-15 23:02:42 +0000161 /// PrologueCleanupDepth - The cleanup depth enclosing all the
162 /// cleanups associated with the parameters.
163 EHScopeStack::stable_iterator PrologueCleanupDepth;
164
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000165 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000166 JumpDest ReturnBlock;
167
John McCall7f416cc2015-09-08 08:05:57 +0000168 /// ReturnValue - The temporary alloca to hold the return
169 /// value. This is invalid iff the function has no return value.
170 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000171
Chris Lattner03df1222007-06-02 04:53:11 +0000172 /// AllocaInsertPoint - This is an instruction in the entry block before which
173 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000174 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000175
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000176 /// \brief API for captured statement code generation.
177 class CGCapturedStmtInfo {
178 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000179 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
180 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000181 explicit CGCapturedStmtInfo(const CapturedStmt &S,
182 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000183 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000184
185 RecordDecl::field_iterator Field =
186 S.getCapturedRecordDecl()->field_begin();
187 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
188 E = S.capture_end();
189 I != E; ++I, ++Field) {
190 if (I->capturesThis())
191 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000192 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000193 CaptureFields[I->getCapturedVar()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000194 else if (I->capturesVariableByCopy())
195 CaptureFields[I->getCapturedVar()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000196 }
197 }
198
199 virtual ~CGCapturedStmtInfo();
200
201 CapturedRegionKind getKind() const { return Kind; }
202
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000203 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000204 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000205 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000206
207 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000208 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000209 return CaptureFields.lookup(VD);
210 }
211
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000212 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
213 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000214
Alexey Bataev18095712014-10-10 12:19:54 +0000215 static bool classof(const CGCapturedStmtInfo *) {
216 return true;
217 }
218
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000219 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000220 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000221 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000222 CGF.EmitStmt(S);
223 }
224
225 /// \brief Get the name of the capture helper.
226 virtual StringRef getHelperName() const { return "__captured_stmt"; }
227
228 private:
229 /// \brief The kind of captured statement being generated.
230 CapturedRegionKind Kind;
231
232 /// \brief Keep the map between VarDecl and FieldDecl.
233 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
234
235 /// \brief The base address of the captured record, passed in as the first
236 /// argument of the parallel region function.
237 llvm::Value *ThisValue;
238
239 /// \brief Captured 'this' type.
240 FieldDecl *CXXThisFieldDecl;
241 };
242 CGCapturedStmtInfo *CapturedStmtInfo;
243
Alexey Bataevd157d472015-06-24 03:35:38 +0000244 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
245 class CGCapturedStmtRAII {
246 private:
247 CodeGenFunction &CGF;
248 CGCapturedStmtInfo *PrevCapturedStmtInfo;
249 public:
250 CGCapturedStmtRAII(CodeGenFunction &CGF,
251 CGCapturedStmtInfo *NewCapturedStmtInfo)
252 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
253 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
254 }
255 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
256 };
257
Alexey Samsonova0416102014-11-11 01:26:14 +0000258 /// \brief Sanitizers enabled for this function.
259 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000260
Alexey Samsonov24cad992014-07-17 18:46:27 +0000261 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
262 bool IsSanitizerScope;
263
264 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
265 class SanitizerScope {
266 CodeGenFunction *CGF;
267 public:
268 SanitizerScope(CodeGenFunction *CGF);
269 ~SanitizerScope();
270 };
271
Reid Kleckner19819442014-07-25 21:39:46 +0000272 /// In C++, whether we are code generating a thunk. This controls whether we
273 /// should emit cleanups.
274 bool CurFuncIsThunk;
275
John McCall31168b02011-06-15 23:02:42 +0000276 /// In ARC, whether we should autorelease the return value.
277 bool AutoreleaseResult;
278
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000279 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
280 /// potentially set the return value.
281 bool SawAsmBlock;
282
David Majnemer25eb1652016-03-01 19:42:53 +0000283 const FunctionDecl *CurSEHParent = nullptr;
284
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000285 /// True if the current function is an outlined SEH helper. This can be a
286 /// finally block or filter expression.
287 bool IsOutlinedSEHHelper;
288
John McCallad7c5c12011-02-08 08:22:06 +0000289 const CodeGen::CGBlockInfo *BlockInfo;
290 llvm::Value *BlockPointer;
291
Eli Friedman9fbeba02012-02-11 02:57:39 +0000292 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
293 FieldDecl *LambdaThisCaptureField;
294
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000295 /// \brief A mapping from NRVO variables to the flags used to indicate
296 /// when the NRVO has been applied to this variable.
297 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000298
John McCallbd309292010-07-06 01:34:17 +0000299 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000300 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000301 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000302
David Majnemer4e52d6f2015-12-12 05:39:21 +0000303 llvm::Instruction *CurrentFuncletPad = nullptr;
304
Richard Smith736a9472013-06-12 20:42:33 +0000305 /// Header for data within LifetimeExtendedCleanupStack.
306 struct LifetimeExtendedCleanupHeader {
307 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000308 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000309 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000310 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000311
Justin Bognerbdff2192015-07-01 00:59:27 +0000312 size_t getSize() const { return Size; }
313 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000314 };
John McCallbd309292010-07-06 01:34:17 +0000315
John McCallad5d61e2010-07-23 21:56:41 +0000316 /// i32s containing the indexes of the cleanup destinations.
317 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000318
319 unsigned NextCleanupDestIndex;
320
John McCall08ef4662011-11-10 08:15:53 +0000321 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
322 CGBlockInfo *FirstBlockInfo;
323
John McCall8e4c74b2011-08-11 02:22:43 +0000324 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
325 llvm::BasicBlock *EHResumeBlock;
326
Bill Wendlingf0724e82011-09-19 20:31:14 +0000327 /// The exception slot. All landing pads write the current exception pointer
328 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000329 llvm::Value *ExceptionSlot;
330
Bill Wendlingf0724e82011-09-19 20:31:14 +0000331 /// The selector slot. Under the MandatoryCleanup model, all landing pads
332 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000333 llvm::AllocaInst *EHSelectorSlot;
334
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000335 /// A stack of exception code slots. Entering an __except block pushes a slot
336 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
337 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000338 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000339
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000340 /// Value returned by __exception_info intrinsic.
341 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000342
John McCallbd309292010-07-06 01:34:17 +0000343 /// Emits a landing pad for the current EH stack.
344 llvm::BasicBlock *EmitLandingPad();
345
346 llvm::BasicBlock *getInvokeDestImpl();
347
John McCallce1de612011-01-26 04:00:11 +0000348 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000349 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
350 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000351 }
352
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000353public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000354 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
355 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000356 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000357
John McCall6b0feb72011-06-22 02:32:12 +0000358 /// A class controlling the emission of a finally block.
359 class FinallyInfo {
360 /// Where the catchall's edge through the cleanup should go.
361 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000362
John McCall6b0feb72011-06-22 02:32:12 +0000363 /// A function to call to enter the catch.
364 llvm::Constant *BeginCatchFn;
365
366 /// An i1 variable indicating whether or not the @finally is
367 /// running for an exception.
368 llvm::AllocaInst *ForEHVar;
369
370 /// An i8* variable into which the exception pointer to rethrow
371 /// has been saved.
372 llvm::AllocaInst *SavedExnVar;
373
374 public:
375 void enter(CodeGenFunction &CGF, const Stmt *Finally,
376 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
377 llvm::Constant *rethrowFn);
378 void exit(CodeGenFunction &CGF);
379 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000380
Reid Kleckner11c033e2015-02-12 23:40:45 +0000381 /// Returns true inside SEH __try blocks.
382 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
383
Reid Klecknera002bd52015-10-28 23:06:42 +0000384 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000385 bool isCleanupPadScope() const {
386 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
387 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000388
John McCallce1de612011-01-26 04:00:11 +0000389 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
390 /// current full-expression. Safe against the possibility that
391 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000392 template <class T, class... As>
393 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000394 // If we're not in a conditional branch, or if none of the
395 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000396 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000397 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000398
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000399 // Stash values in a tuple so we can guarantee the order of saves.
400 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
401 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000402
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000403 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000404 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000405 initFullExprCleanup();
406 }
407
Richard Smith736a9472013-06-12 20:42:33 +0000408 /// \brief Queue a cleanup to be pushed after finishing the current
409 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000410 template <class T, class... As>
411 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000412 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
413
414 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
415
416 size_t OldSize = LifetimeExtendedCleanupStack.size();
417 LifetimeExtendedCleanupStack.resize(
418 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
419
Justin Bognerbdff2192015-07-01 00:59:27 +0000420 static_assert(sizeof(Header) % llvm::AlignOf<T>::Alignment == 0,
421 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000422 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
423 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000424 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000425 }
426
John McCallf4beacd2011-11-10 10:43:54 +0000427 /// Set up the last cleaup that was pushed as a conditional
428 /// full-expression cleanup.
429 void initFullExprCleanup();
430
John McCallbd309292010-07-06 01:34:17 +0000431 /// PushDestructorCleanup - Push a cleanup to call the
432 /// complete-object destructor of an object of the given type at the
433 /// given address. Does nothing if T is not a C++ class type with a
434 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000435 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000436
John McCall8680f872010-07-21 06:29:51 +0000437 /// PushDestructorCleanup - Push a cleanup to call the
438 /// complete-object variant of the given destructor on the object at
439 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000440 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000441
John McCallbd309292010-07-06 01:34:17 +0000442 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
443 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000444 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000445
John McCall824c2f52010-09-14 07:57:04 +0000446 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
447 /// The block cannot be reactivated. Pops it if it's the top of the
448 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000449 ///
450 /// \param DominatingIP - An instruction which is known to
451 /// dominate the current IP (if set) and which lies along
452 /// all paths of execution between the current IP and the
453 /// the point at which the cleanup comes into scope.
454 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
455 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000456
457 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
458 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000459 ///
460 /// \param DominatingIP - An instruction which is known to
461 /// dominate the current IP (if set) and which lies along
462 /// all paths of execution between the current IP and the
463 /// the point at which the cleanup comes into scope.
464 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
465 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000466
John McCallbd309292010-07-06 01:34:17 +0000467 /// \brief Enters a new scope for capturing cleanups, all of which
468 /// will be executed once the scope is exited.
469 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000470 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000471 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000472 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000473 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000474 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000475 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000476
Aaron Ballmanabc18922015-02-15 22:54:08 +0000477 RunCleanupsScope(const RunCleanupsScope &) = delete;
478 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000479
Eric Christophera9d34972011-10-19 00:43:52 +0000480 protected:
481 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000482
Douglas Gregor965f4502009-11-24 16:43:22 +0000483 public:
484 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000485 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000486 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000487 {
John McCallbd309292010-07-06 01:34:17 +0000488 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000489 LifetimeExtendedCleanupStackSize =
490 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000491 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000492 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000493 }
494
495 /// \brief Exit this cleanup scope, emitting any accumulated
496 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000497 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000498 if (PerformCleanup) {
499 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000500 CGF.PopCleanupBlocks(CleanupStackDepth,
501 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000502 }
503 }
504
505 /// \brief Determine whether this scope requires any cleanups.
506 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000507 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000508 }
509
510 /// \brief Force the emission of cleanups now, instead of waiting
511 /// until this object is destroyed.
512 void ForceCleanup() {
513 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000514 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000515 CGF.PopCleanupBlocks(CleanupStackDepth,
516 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000517 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000518 }
519 };
520
David Blaikie93be0b22014-08-22 21:37:04 +0000521 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000522 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000523 SmallVector<const LabelDecl*, 4> Labels;
524 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000525
Aaron Ballmanabc18922015-02-15 22:54:08 +0000526 LexicalScope(const LexicalScope &) = delete;
527 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000528
529 public:
530 /// \brief Enter a new cleanup scope.
531 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000532 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
533 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000534 if (CGDebugInfo *DI = CGF.getDebugInfo())
535 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
536 }
537
Nadav Rotem1da30942013-03-23 06:43:35 +0000538 void addLabel(const LabelDecl *label) {
539 assert(PerformCleanup && "adding label to dead scope?");
540 Labels.push_back(label);
541 }
542
Eric Christophera9d34972011-10-19 00:43:52 +0000543 /// \brief Exit this cleanup scope, emitting any accumulated
544 /// cleanups.
545 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000546 if (CGDebugInfo *DI = CGF.getDebugInfo())
547 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
548
Nadav Rotem1da30942013-03-23 06:43:35 +0000549 // If we should perform a cleanup, force them now. Note that
550 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000551 if (PerformCleanup) {
552 ApplyDebugLocation DL(CGF, Range.getEnd());
553 ForceCleanup();
554 }
Eric Christophera9d34972011-10-19 00:43:52 +0000555 }
556
557 /// \brief Force the emission of cleanups now, instead of waiting
558 /// until this object is destroyed.
559 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000560 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000561 RunCleanupsScope::ForceCleanup();
562
Nadav Rotem1da30942013-03-23 06:43:35 +0000563 if (!Labels.empty())
564 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000565 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000566
567 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000568 };
569
John McCall7f416cc2015-09-08 08:05:57 +0000570 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
571
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000572 /// \brief The scope used to remap some variables as private in the OpenMP
573 /// loop body (or other captured region emitted without outlining), and to
574 /// restore old vars back on exit.
575 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000576 DeclMapTy SavedLocals;
577 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000578
579 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000580 OMPPrivateScope(const OMPPrivateScope &) = delete;
581 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000582
583 public:
584 /// \brief Enter a new OpenMP private scope.
585 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
586
587 /// \brief Registers \a LocalVD variable as a private and apply \a
588 /// PrivateGen function for it to generate corresponding private variable.
589 /// \a PrivateGen returns an address of the generated private variable.
590 /// \return true if the variable is registered as private, false if it has
591 /// been privatized already.
592 bool
593 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000594 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000595 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000596
597 // Only save it once.
598 if (SavedLocals.count(LocalVD)) return false;
599
600 // Copy the existing local entry to SavedLocals.
601 auto it = CGF.LocalDeclMap.find(LocalVD);
602 if (it != CGF.LocalDeclMap.end()) {
603 SavedLocals.insert({LocalVD, it->second});
604 } else {
605 SavedLocals.insert({LocalVD, Address::invalid()});
606 }
607
608 // Generate the private entry.
609 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000610 QualType VarTy = LocalVD->getType();
611 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000612 Address Temp = CGF.CreateMemTemp(VarTy);
613 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
614 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000615 }
John McCall7f416cc2015-09-08 08:05:57 +0000616 SavedPrivates.insert({LocalVD, Addr});
617
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000618 return true;
619 }
620
621 /// \brief Privatizes local variables previously registered as private.
622 /// Registration is separate from the actual privatization to allow
623 /// initializers use values of the original variables, not the private one.
624 /// This is important, for example, if the private variable is a class
625 /// variable initialized by a constructor that references other private
626 /// variables. But at initialization original variables must be used, not
627 /// private copies.
628 /// \return true if at least one variable was privatized, false otherwise.
629 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000630 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000631 SavedPrivates.clear();
632 return !SavedLocals.empty();
633 }
634
635 void ForceCleanup() {
636 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000637 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000638 SavedLocals.clear();
639 }
640
641 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000642 ~OMPPrivateScope() {
643 if (PerformCleanup)
644 ForceCleanup();
645 }
John McCall7f416cc2015-09-08 08:05:57 +0000646
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000647 /// Checks if the global variable is captured in current function.
648 bool isGlobalVarCaptured(const VarDecl *VD) const {
649 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
650 }
651
John McCall7f416cc2015-09-08 08:05:57 +0000652 private:
653 /// Copy all the entries in the source map over the corresponding
654 /// entries in the destination, which must exist.
655 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
656 for (auto &pair : src) {
657 if (!pair.second.isValid()) {
658 dest.erase(pair.first);
659 continue;
660 }
661
662 auto it = dest.find(pair.first);
663 if (it != dest.end()) {
664 it->second = pair.second;
665 } else {
666 dest.insert(pair);
667 }
668 }
669 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000670 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000671
Richard Smith736a9472013-06-12 20:42:33 +0000672 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
673 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000674 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000675
Richard Smith736a9472013-06-12 20:42:33 +0000676 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
677 /// that have been added, then adds all lifetime-extended cleanups from
678 /// the given position to the stack.
679 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
680 size_t OldLifetimeExtendedStackSize);
681
John McCallad5d61e2010-07-23 21:56:41 +0000682 void ResolveBranchFixups(llvm::BasicBlock *Target);
683
John McCallbd309292010-07-06 01:34:17 +0000684 /// The given basic block lies in the current EH scope, but may be a
685 /// target of a potentially scope-crossing jump; get a stable handle
686 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000687 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000688 return JumpDest(Target,
689 EHStack.getInnermostNormalCleanup(),
690 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000691 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000692
John McCallbd309292010-07-06 01:34:17 +0000693 /// The given basic block lies in the current EH scope, but may be a
694 /// target of a potentially scope-crossing jump; get a stable handle
695 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000696 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000697 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000698 }
699
700 /// EmitBranchThroughCleanup - Emit a branch from the current insert
701 /// block through the normal cleanup handling code (if any) and then
702 /// on to \arg Dest.
703 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000704
Justin Bognere25ffdf2014-01-21 00:35:11 +0000705 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
706 /// specified destination obviously has no cleanups to run. 'false' is always
707 /// a conservatively correct answer for this method.
708 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
709
John McCall8e4c74b2011-08-11 02:22:43 +0000710 /// popCatchScope - Pops the catch scope at the top of the EHScope
711 /// stack, emitting any required code (other than the catch handlers
712 /// themselves).
713 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000714
David Chisnall9a837be2012-11-07 16:50:40 +0000715 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000716 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000717 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000718
John McCallce1de612011-01-26 04:00:11 +0000719 /// An object to manage conditionally-evaluated expressions.
720 class ConditionalEvaluation {
721 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000722
John McCallce1de612011-01-26 04:00:11 +0000723 public:
724 ConditionalEvaluation(CodeGenFunction &CGF)
725 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000726
John McCallce1de612011-01-26 04:00:11 +0000727 void begin(CodeGenFunction &CGF) {
728 assert(CGF.OutermostConditional != this);
729 if (!CGF.OutermostConditional)
730 CGF.OutermostConditional = this;
731 }
732
733 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000734 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000735 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000736 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000737 }
738
739 /// Returns a block which will be executed prior to each
740 /// evaluation of the conditional code.
741 llvm::BasicBlock *getStartingBlock() const {
742 return StartBB;
743 }
744 };
Mike Stump11289f42009-09-09 15:08:12 +0000745
John McCall7f9c92a2010-09-17 00:50:28 +0000746 /// isInConditionalBranch - Return true if we're currently emitting
747 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000748 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000749
John McCall7f416cc2015-09-08 08:05:57 +0000750 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000751 assert(isInConditionalBranch());
752 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000753 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
754 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000755 }
756
John McCallce1de612011-01-26 04:00:11 +0000757 /// An RAII object to record that we're evaluating a statement
758 /// expression.
759 class StmtExprEvaluation {
760 CodeGenFunction &CGF;
761
762 /// We have to save the outermost conditional: cleanups in a
763 /// statement expression aren't conditional just because the
764 /// StmtExpr is.
765 ConditionalEvaluation *SavedOutermostConditional;
766
767 public:
768 StmtExprEvaluation(CodeGenFunction &CGF)
769 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000770 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000771 }
772
773 ~StmtExprEvaluation() {
774 CGF.OutermostConditional = SavedOutermostConditional;
775 CGF.EnsureInsertPoint();
776 }
777 };
John McCall1bf58462011-02-16 08:02:54 +0000778
John McCallc07a0c72011-02-17 10:25:35 +0000779 /// An object which temporarily prevents a value from being
780 /// destroyed by aggressive peephole optimizations that assume that
781 /// all uses of a value have been realized in the IR.
782 class PeepholeProtection {
783 llvm::Instruction *Inst;
784 friend class CodeGenFunction;
785
786 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000787 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000788 };
John McCallc07a0c72011-02-17 10:25:35 +0000789
John McCallfe96e0b2011-11-06 09:01:30 +0000790 /// A non-RAII class containing all the information about a bound
791 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
792 /// this which makes individual mappings very simple; using this
793 /// class directly is useful when you have a variable number of
794 /// opaque values or don't want the RAII functionality for some
795 /// reason.
796 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000797 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000798 bool BoundLValue;
799 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000800
John McCallfe96e0b2011-11-06 09:01:30 +0000801 OpaqueValueMappingData(const OpaqueValueExpr *ov,
802 bool boundLValue)
803 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000804 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000805 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000806
John McCallc07a0c72011-02-17 10:25:35 +0000807 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000808 // gl-values should be bound as l-values for obvious reasons.
809 // Records should be bound as l-values because IR generation
810 // always keeps them in memory. Expressions of function type
811 // act exactly like l-values but are formally required to be
812 // r-values in C.
813 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000814 expr->getType()->isFunctionType() ||
815 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000816 }
817
John McCallfe96e0b2011-11-06 09:01:30 +0000818 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
819 const OpaqueValueExpr *ov,
820 const Expr *e) {
821 if (shouldBindAsLValue(ov))
822 return bind(CGF, ov, CGF.EmitLValue(e));
823 return bind(CGF, ov, CGF.EmitAnyExpr(e));
824 }
825
826 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
827 const OpaqueValueExpr *ov,
828 const LValue &lv) {
829 assert(shouldBindAsLValue(ov));
830 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
831 return OpaqueValueMappingData(ov, true);
832 }
833
834 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
835 const OpaqueValueExpr *ov,
836 const RValue &rv) {
837 assert(!shouldBindAsLValue(ov));
838 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
839
840 OpaqueValueMappingData data(ov, false);
841
842 // Work around an extremely aggressive peephole optimization in
843 // EmitScalarConversion which assumes that all other uses of a
844 // value are extant.
845 data.Protection = CGF.protectFromPeepholes(rv);
846
847 return data;
848 }
849
Craig Topper8a13c412014-05-21 05:09:00 +0000850 bool isValid() const { return OpaqueValue != nullptr; }
851 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000852
853 void unbind(CodeGenFunction &CGF) {
854 assert(OpaqueValue && "no data to unbind!");
855
856 if (BoundLValue) {
857 CGF.OpaqueLValues.erase(OpaqueValue);
858 } else {
859 CGF.OpaqueRValues.erase(OpaqueValue);
860 CGF.unprotectFromPeepholes(Protection);
861 }
862 }
863 };
864
865 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
866 class OpaqueValueMapping {
867 CodeGenFunction &CGF;
868 OpaqueValueMappingData Data;
869
870 public:
871 static bool shouldBindAsLValue(const Expr *expr) {
872 return OpaqueValueMappingData::shouldBindAsLValue(expr);
873 }
874
John McCallc07a0c72011-02-17 10:25:35 +0000875 /// Build the opaque value mapping for the given conditional
876 /// operator if it's the GNU ?: extension. This is a common
877 /// enough pattern that the convenience operator is really
878 /// helpful.
879 ///
880 OpaqueValueMapping(CodeGenFunction &CGF,
881 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000882 if (isa<ConditionalOperator>(op))
883 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000884 return;
John McCallc07a0c72011-02-17 10:25:35 +0000885
886 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000887 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
888 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000889 }
890
John McCall1bf58462011-02-16 08:02:54 +0000891 OpaqueValueMapping(CodeGenFunction &CGF,
892 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000893 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000894 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000895 }
896
897 OpaqueValueMapping(CodeGenFunction &CGF,
898 const OpaqueValueExpr *opaqueValue,
899 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000900 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000901 }
902
903 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000904 Data.unbind(CGF);
905 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000906 }
907
908 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000909 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000910 }
911 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000912
Chris Lattner2da04b32007-08-24 05:35:26 +0000913private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000914 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000915 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000916
John McCall9b382dd2011-05-28 21:13:02 +0000917 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
918 /// calling llvm.stacksave for multiple VLAs in the same scope.
919 bool DidCallStackSave;
920
Mike Stumpe5311b02009-11-30 20:08:49 +0000921 /// IndirectBranch - The first time an indirect goto is seen we create a block
922 /// with an indirect branch. Every time we see the address of a label taken,
923 /// we add the label to the indirect goto. Every subsequent indirect goto is
924 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000925 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000926
Mike Stumpfc496822009-02-08 23:14:22 +0000927 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
928 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000929 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000930
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000931 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
932 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
933 /// parameter.
934 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
935 SizeArguments;
936
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000937 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000938 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000939 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
940
Chris Lattnerac248202007-05-30 00:13:02 +0000941 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000942 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000943
Mike Stumpfc496822009-02-08 23:14:22 +0000944 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000945 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000946 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000947 BreakContinue(JumpDest Break, JumpDest Continue)
948 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000949
John McCallbd309292010-07-06 01:34:17 +0000950 JumpDest BreakBlock;
951 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000952 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000953 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000954
Justin Bogneref512b92014-01-06 22:27:43 +0000955 CodeGenPGO PGO;
956
Justin Bogner65512642015-05-02 05:00:55 +0000957 /// Calculate branch weights appropriate for PGO data
958 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
959 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
960 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
961 uint64_t LoopCount);
962
Justin Bogneref512b92014-01-06 22:27:43 +0000963public:
Justin Bogner66242d62015-04-23 23:06:47 +0000964 /// Increment the profiler's counter for the given statement.
965 void incrementProfileCounter(const Stmt *S) {
Rong Xu9837ef52016-02-04 18:39:09 +0000966 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Justin Bogner66242d62015-04-23 23:06:47 +0000967 PGO.emitCounterIncrement(Builder, S);
968 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +0000969 }
Justin Bogner66242d62015-04-23 23:06:47 +0000970
971 /// Get the profiler's count for the given statement.
972 uint64_t getProfileCount(const Stmt *S) {
973 Optional<uint64_t> Count = PGO.getStmtCount(S);
974 if (!Count.hasValue())
975 return 0;
976 return *Count;
977 }
978
979 /// Set the profiler's current count.
980 void setCurrentProfileCount(uint64_t Count) {
981 PGO.setCurrentRegionCount(Count);
982 }
983
984 /// Get the profiler's current count. This is generally the count for the most
985 /// recently incremented counter.
986 uint64_t getCurrentProfileCount() {
987 return PGO.getCurrentRegionCount();
988 }
989
Justin Bogneref512b92014-01-06 22:27:43 +0000990private:
991
Zhongxing Xu82846ea2012-01-14 09:08:15 +0000992 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +0000993 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000994 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +0000995 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
996 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +0000997
Mike Stumpfc496822009-02-08 23:14:22 +0000998 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000999 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001000 llvm::BasicBlock *CaseRangeBlock;
1001
John McCallc07a0c72011-02-17 10:25:35 +00001002 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001003 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001004 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1005 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001006
Mike Stumpfc496822009-02-08 23:14:22 +00001007 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001008 // We track this by the size expression rather than the type itself because
1009 // in certain situations, like a const qualifier applied to an VLA typedef,
1010 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001011 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1012 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001013 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001014
John McCallbd309292010-07-06 01:34:17 +00001015 /// A block containing a single 'unreachable' instruction. Created
1016 /// lazily by getUnreachableBlock().
1017 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001018
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001019 /// Counts of the number return expressions in the function.
1020 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001021
1022 /// Count the number of simple (constant) return expressions in the function.
1023 unsigned NumSimpleReturnExprs;
1024
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001025 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001026 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001027
Richard Smith852c9db2013-04-20 22:23:05 +00001028public:
1029 /// A scope within which we are constructing the fields of an object which
1030 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1031 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1032 class FieldConstructionScope {
1033 public:
John McCall7f416cc2015-09-08 08:05:57 +00001034 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001035 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1036 CGF.CXXDefaultInitExprThis = This;
1037 }
1038 ~FieldConstructionScope() {
1039 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1040 }
1041
1042 private:
1043 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001044 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001045 };
1046
1047 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1048 /// is overridden to be the object under construction.
1049 class CXXDefaultInitExprScope {
1050 public:
1051 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001052 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1053 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1054 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1055 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001056 }
1057 ~CXXDefaultInitExprScope() {
1058 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001059 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001060 }
1061
1062 public:
1063 CodeGenFunction &CGF;
1064 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001065 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001066 };
1067
1068private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001069 /// CXXThisDecl - When generating code for a C++ member function,
1070 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001071 ImplicitParamDecl *CXXABIThisDecl;
1072 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001073 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001074 CharUnits CXXABIThisAlignment;
1075 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001076
Richard Smith852c9db2013-04-20 22:23:05 +00001077 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1078 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001079 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001080
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001081 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1082 /// destructor, this will hold the implicit argument (e.g. VTT).
1083 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1084 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001085
John McCallce1de612011-01-26 04:00:11 +00001086 /// OutermostConditional - Points to the outermost active
1087 /// conditional control. This is used so that we know if a
1088 /// temporary should be destroyed conditionally.
1089 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001090
Nadav Rotem1da30942013-03-23 06:43:35 +00001091 /// The current lexical scope.
1092 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001093
Adrian Prantldc237b52013-05-16 00:41:26 +00001094 /// The current source location that should be used for exception
1095 /// handling code.
1096 SourceLocation CurEHLocation;
1097
John McCall7f416cc2015-09-08 08:05:57 +00001098 /// BlockByrefInfos - For each __block variable, contains
1099 /// information about the layout of the variable.
1100 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001101
John McCallbd309292010-07-06 01:34:17 +00001102 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001103 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001104 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001105
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001106 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1107 /// In the kernel metadata node, reference the kernel function and metadata
1108 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001109 /// - A node for the vec_type_hint(<type>) qualifier contains string
1110 /// "vec_type_hint", an undefined value of the <type> data type,
1111 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001112 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1113 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1114 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1115 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1116 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1117 llvm::Function *Fn);
1118
Chris Lattnerbed31442007-05-28 01:07:47 +00001119public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001120 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001121 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001122
John McCall8ed55a52010-09-02 09:58:18 +00001123 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001124 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001125 CGDebugInfo *getDebugInfo() {
1126 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001127 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001128 return DebugInfo;
1129 }
1130 void disableDebugInfo() { DisableDebugInfo = true; }
1131 void enableDebugInfo() { DisableDebugInfo = false; }
1132
John McCall31168b02011-06-15 23:02:42 +00001133 bool shouldUseFusedARCCalls() {
1134 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1135 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001136
David Blaikiebbafb8a2012-03-11 07:00:24 +00001137 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001138
Bill Wendlingf0724e82011-09-19 20:31:14 +00001139 /// Returns a pointer to the function's exception object and selector slot,
1140 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001141 Address getExceptionSlot();
1142 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001143
Bill Wendling79a70e42011-09-15 18:57:19 +00001144 /// Returns the contents of the function's exception object and selector
1145 /// slots.
1146 llvm::Value *getExceptionFromSlot();
1147 llvm::Value *getSelectorFromSlot();
1148
John McCall7f416cc2015-09-08 08:05:57 +00001149 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001150
John McCallbd309292010-07-06 01:34:17 +00001151 llvm::BasicBlock *getUnreachableBlock() {
1152 if (!UnreachableBlock) {
1153 UnreachableBlock = createBasicBlock("unreachable");
1154 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1155 }
1156 return UnreachableBlock;
1157 }
1158
1159 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001160 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001161 return getInvokeDestImpl();
1162 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001163
David Majnemer25eb1652016-03-01 19:42:53 +00001164 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001165
John McCallc8e01702013-04-16 22:48:15 +00001166 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001167 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001168
Daniel Dunbar12347492009-02-23 17:26:39 +00001169 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001170 // Cleanups
1171 //===--------------------------------------------------------------------===//
1172
John McCall7f416cc2015-09-08 08:05:57 +00001173 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001174
John McCall178360e2011-07-11 08:38:19 +00001175 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001176 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001177 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001178 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001179 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001180 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1181 llvm::Value *arrayEnd,
1182 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001183 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001184 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001185
John McCall4bd0fb12011-07-12 16:41:08 +00001186 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001187 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001188 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001189 Address addr, QualType type);
1190 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001191 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001192 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001193 QualType type, Destroyer *destroyer,
1194 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001195 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1196 llvm::Value *CompletePtr,
1197 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001198 void pushStackRestore(CleanupKind kind, Address SPMem);
1199 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001200 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001201 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001202 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001203 bool useEHCleanupForArray,
1204 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001205 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001206 QualType elementType, CharUnits elementAlign,
1207 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001208 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001209
Peter Collingbourne1425b452012-01-26 03:33:36 +00001210 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001211
John McCall82fe67b2011-07-09 01:37:26 +00001212 /// Determines whether an EH cleanup is required to destroy a type
1213 /// with the given destruction kind.
1214 bool needsEHCleanup(QualType::DestructionKind kind) {
1215 switch (kind) {
1216 case QualType::DK_none:
1217 return false;
1218 case QualType::DK_cxx_destructor:
1219 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001220 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001221 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001222 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001223 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1224 }
1225 llvm_unreachable("bad destruction kind");
1226 }
1227
John McCall4bd0fb12011-07-12 16:41:08 +00001228 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1229 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1230 }
1231
John McCall82fe67b2011-07-09 01:37:26 +00001232 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001233 // Objective-C
1234 //===--------------------------------------------------------------------===//
1235
Chris Lattner4bd55962008-03-30 23:03:07 +00001236 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001237
David Blaikief1425802015-01-14 00:04:42 +00001238 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001239
Mike Stumpfc496822009-02-08 23:14:22 +00001240 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001241 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1242 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001243 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001244 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001245 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001246 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001247
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001248 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1249 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001250
Mike Stumpfc496822009-02-08 23:14:22 +00001251 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1252 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001253 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1254 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001255 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001256 const ObjCPropertyImplDecl *propImpl,
1257 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001258
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001259 //===--------------------------------------------------------------------===//
1260 // Block Bits
1261 //===--------------------------------------------------------------------===//
1262
John McCall351762c2011-02-07 10:33:21 +00001263 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001264 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1265 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001266
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001267 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001268 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001269 const DeclMapTy &ldm,
1270 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001271
John McCallad7c5c12011-02-08 08:22:06 +00001272 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1273 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001274 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1275 const ObjCPropertyImplDecl *PID);
1276 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1277 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001278 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001279
John McCallad7c5c12011-02-08 08:22:06 +00001280 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1281
John McCall73064872011-03-31 01:59:53 +00001282 class AutoVarEmission;
1283
1284 void emitByrefStructureInit(const AutoVarEmission &emission);
1285 void enterByrefCleanup(const AutoVarEmission &emission);
1286
John McCall7f416cc2015-09-08 08:05:57 +00001287 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1288 llvm::Value *ptr);
1289
1290 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001291 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1292
1293 /// BuildBlockByrefAddress - Computes the location of the
1294 /// data in a variable which is declared as __block.
1295 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1296 bool followForward = true);
1297 Address emitBlockByrefAddress(Address baseAddr,
1298 const BlockByrefInfo &info,
1299 bool followForward,
1300 const llvm::Twine &name);
1301
1302 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001303
John McCalla738c252011-03-09 04:27:21 +00001304 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1305 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001306 /// \brief Emit code for the start of a function.
1307 /// \param Loc The location to be associated with the function.
1308 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001309 void StartFunction(GlobalDecl GD,
1310 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001311 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001312 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001313 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001314 SourceLocation Loc = SourceLocation(),
1315 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001316
John McCallb81884d2010-02-19 09:25:03 +00001317 void EmitConstructorBody(FunctionArgList &Args);
1318 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001319 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001320 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001321 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001322
Faisal Vali571df122013-09-29 08:45:24 +00001323 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001324 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001325 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001326 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001327 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1328 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001329 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001330
David Blaikiea0a1a872015-01-18 02:48:07 +00001331 /// \brief Emit the unified return block, trying to avoid its emission when
1332 /// possible.
1333 /// \return The debug location of the user written return statement if the
1334 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001335 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001336
Mike Stumpfc496822009-02-08 23:14:22 +00001337 /// FinishFunction - Complete IR generation of the current function. It is
1338 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001339 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001340
Nico Weber1bebad12015-02-11 22:33:32 +00001341 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1342 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001343
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001344 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001345
John McCall7f416cc2015-09-08 08:05:57 +00001346 void FinishThunk();
1347
Reid Klecknerab2090d2014-07-26 01:34:32 +00001348 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1349 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1350 llvm::Value *Callee);
1351
Rafael Espindolad6e66942015-07-13 06:07:58 +00001352 /// Generate a thunk for the given method.
1353 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001354 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001355
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001356 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1357 const CGFunctionInfo &FnInfo,
1358 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001359
Douglas Gregor94f9a482010-05-05 05:51:00 +00001360 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1361 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001362
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001363 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001364 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001365
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001366 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1367 struct VPtr {
1368 BaseSubobject Base;
1369 const CXXRecordDecl *NearestVBase;
1370 CharUnits OffsetFromNearestVBase;
1371 const CXXRecordDecl *VTableClass;
1372 };
1373
1374 /// Initialize the vtable pointer of the given subobject.
1375 void InitializeVTablePointer(const VPtr &vptr);
1376
1377 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001378
1379 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001380 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1381
1382 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1383 CharUnits OffsetFromNearestVBase,
1384 bool BaseIsNonVirtualPrimaryBase,
1385 const CXXRecordDecl *VTableClass,
1386 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001387
Anders Carlssond5895932010-03-28 21:07:49 +00001388 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001389
Dan Gohman8fc50c22010-10-26 18:44:08 +00001390 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1391 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001392 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1393 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001394
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001395 enum CFITypeCheckKind {
1396 CFITCK_VCall,
1397 CFITCK_NVCall,
1398 CFITCK_DerivedCast,
1399 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001400 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001401 };
1402
Peter Collingbourned2926c92015-03-14 02:42:25 +00001403 /// \brief Derived is the presumed address of an object of type T after a
1404 /// cast. If T is a polymorphic class type, emit a check that the virtual
1405 /// table for Derived belongs to a class derived from T.
1406 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001407 bool MayBeNull, CFITypeCheckKind TCK,
1408 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001409
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001410 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1411 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001412 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001413 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001414
Peter Collingbourned2926c92015-03-14 02:42:25 +00001415 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
1416 /// RD using llvm.bitset.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001417 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1418 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001419
Peter Collingbournefb532b92016-02-24 20:46:36 +00001420 /// If whole-program virtual table optimization is enabled, emit an assumption
1421 /// that VTable is a member of the type's bitset. Or, if vptr CFI is enabled,
1422 /// emit a check that VTable is a member of the type's bitset.
1423 void EmitBitSetCodeForVCall(const CXXRecordDecl *RD, llvm::Value *VTable,
1424 SourceLocation Loc);
1425
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001426 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1427 /// expr can be devirtualized.
1428 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1429 const CXXMethodDecl *MD);
1430
John McCallf99a6312010-07-21 05:30:47 +00001431 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1432 /// given phase of destruction for a destructor. The end result
1433 /// should call destructors on members and base classes in reverse
1434 /// order of their construction.
1435 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001436
Chris Lattner3c77a352010-06-22 00:03:40 +00001437 /// ShouldInstrumentFunction - Return true if the current function should be
1438 /// instrumented with __cyg_profile_func_* calls
1439 bool ShouldInstrumentFunction();
1440
1441 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1442 /// instrumentation function with the current function and the call site, if
1443 /// function instrumentation is enabled.
1444 void EmitFunctionInstrumentation(const char *Fn);
1445
Roman Divacky178e01602011-02-10 16:52:03 +00001446 /// EmitMCountInstrumentation - Emit call to .mcount.
1447 void EmitMCountInstrumentation();
1448
Mike Stumpfc496822009-02-08 23:14:22 +00001449 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1450 /// arguments for the given function. This is also responsible for naming the
1451 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001452 void EmitFunctionProlog(const CGFunctionInfo &FI,
1453 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001454 const FunctionArgList &Args);
1455
Mike Stumpfc496822009-02-08 23:14:22 +00001456 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1457 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001458 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1459 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001460
Mike Stump1d849212009-12-07 23:38:24 +00001461 /// EmitStartEHSpec - Emit the start of the exception spec.
1462 void EmitStartEHSpec(const Decl *D);
1463
1464 /// EmitEndEHSpec - Emit the end of the exception spec.
1465 void EmitEndEHSpec(const Decl *D);
1466
John McCallbd309292010-07-06 01:34:17 +00001467 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1468 llvm::BasicBlock *getTerminateLandingPad();
1469
1470 /// getTerminateHandler - Return a handler (not a landing pad, just
1471 /// a catch handler) that just calls terminate. This is used when
1472 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001473 llvm::BasicBlock *getTerminateHandler();
1474
Chris Lattnera5f58b02011-07-09 17:41:47 +00001475 llvm::Type *ConvertTypeForMem(QualType T);
1476 llvm::Type *ConvertType(QualType T);
1477 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001478 return ConvertType(getContext().getTypeDeclType(T));
1479 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001480
Mike Stumpfc496822009-02-08 23:14:22 +00001481 /// LoadObjCSelf - Load the value of self. This function is only valid while
1482 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001483 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001484
1485 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001486 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001487
Chris Lattner54fb19e2007-06-22 22:02:34 +00001488 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1489 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001490 static TypeEvaluationKind getEvaluationKind(QualType T);
1491
1492 static bool hasScalarEvaluationKind(QualType T) {
1493 return getEvaluationKind(T) == TEK_Scalar;
1494 }
1495
1496 static bool hasAggregateEvaluationKind(QualType T) {
1497 return getEvaluationKind(T) == TEK_Aggregate;
1498 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001499
1500 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001501 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001502 llvm::Function *parent = nullptr,
1503 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001504#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001505 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001506#else
John McCallad7c5c12011-02-08 08:22:06 +00001507 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001508#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001509 }
Mike Stumpfc496822009-02-08 23:14:22 +00001510
Chris Lattnerac248202007-05-30 00:13:02 +00001511 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1512 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001513 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001514
Mike Stumpe5311b02009-11-30 20:08:49 +00001515 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1516 /// another basic block, simplify it. This assumes that no other code could
1517 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001518 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1519
Mike Stumpfc496822009-02-08 23:14:22 +00001520 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1521 /// adding a fall-through branch from the current insert block if
1522 /// necessary. It is legal to call this function even if there is no current
1523 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001524 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001525 /// IsFinished - If true, indicates that the caller has finished emitting
1526 /// branches to the given block and does not expect to emit code into it. This
1527 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001528 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001529
John McCall8e4c74b2011-08-11 02:22:43 +00001530 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1531 /// near its uses, and leave the insertion point in it.
1532 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1533
Mike Stumpfc496822009-02-08 23:14:22 +00001534 /// EmitBranch - Emit a branch to the specified basic block from the current
1535 /// insert block, taking care to avoid creation of branches from dummy
1536 /// blocks. It is legal to call this function even if there is no current
1537 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001538 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001539 /// This function clears the current insertion point. The caller should follow
1540 /// calls to this function with calls to Emit*Block prior to generation new
1541 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001542 void EmitBranch(llvm::BasicBlock *Block);
1543
Mike Stumpfc496822009-02-08 23:14:22 +00001544 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1545 /// indicates that the current code being emitted is unreachable.
1546 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001547 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001548 }
1549
Mike Stumpfc496822009-02-08 23:14:22 +00001550 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1551 /// emitted IR has a place to go. Note that by definition, if this function
1552 /// creates a block then that block is unreachable; callers may do better to
1553 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001554 void EnsureInsertPoint() {
1555 if (!HaveInsertPoint())
1556 EmitBlock(createBasicBlock());
1557 }
Mike Stumpfc496822009-02-08 23:14:22 +00001558
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001559 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001560 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001561 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001562
Chris Lattnere9a64532007-06-22 21:44:33 +00001563 //===--------------------------------------------------------------------===//
1564 // Helpers
1565 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001566
John McCall7f416cc2015-09-08 08:05:57 +00001567 LValue MakeAddrLValue(Address Addr, QualType T,
1568 AlignmentSource AlignSource = AlignmentSource::Type) {
1569 return LValue::MakeAddr(Addr, T, getContext(), AlignSource,
Dan Gohman947c9af2010-10-14 23:06:10 +00001570 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001571 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001572
John McCall7f416cc2015-09-08 08:05:57 +00001573 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1574 AlignmentSource AlignSource = AlignmentSource::Type) {
1575 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1576 AlignSource, CGM.getTBAAInfo(T));
1577 }
1578
1579 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001580 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001581 CharUnits getNaturalTypeAlignment(QualType T,
1582 AlignmentSource *Source = nullptr,
1583 bool forPointeeType = false);
1584 CharUnits getNaturalPointeeTypeAlignment(QualType T,
1585 AlignmentSource *Source = nullptr);
1586
1587 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
1588 AlignmentSource *Source = nullptr);
1589 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001590
Alexey Bataev31300ed2016-02-04 11:27:03 +00001591 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
1592 AlignmentSource *Source = nullptr);
1593 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1594
Chris Lattnere9a64532007-06-22 21:44:33 +00001595 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001596 /// block. The caller is responsible for setting an appropriate alignment on
1597 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001598 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001599 const Twine &Name = "tmp");
John McCall7f416cc2015-09-08 08:05:57 +00001600 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
1601 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001602
John McCall7f416cc2015-09-08 08:05:57 +00001603 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1604 /// default ABI alignment of the given LLVM type.
1605 ///
1606 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1607 /// any given AST type that happens to have been lowered to the
1608 /// given IR type. This should only ever be used for function-local,
1609 /// IR-driven manipulations like saving and restoring a value. Do
1610 /// not hand this address off to arbitrary IRGen routines, and especially
1611 /// do not pass it as an argument to a function that might expect a
1612 /// properly ABI-aligned value.
1613 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1614 const Twine &Name = "tmp");
1615
1616 /// InitTempAlloca - Provide an initial value for the given alloca which
1617 /// will be observable at all locations in the function.
1618 ///
1619 /// The address should be something that was returned from one of
1620 /// the CreateTempAlloca or CreateMemTemp routines, and the
1621 /// initializer must be valid in the entry block (i.e. it must
1622 /// either be a constant or an argument value).
1623 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001624
Daniel Dunbard0049182010-02-16 19:44:13 +00001625 /// CreateIRTemp - Create a temporary IR object of the given type, with
1626 /// appropriate alignment. This routine should only be used when an temporary
1627 /// value needs to be stored into an alloca (for example, to avoid explicit
1628 /// PHI construction), but the type is the IR type, not the type appropriate
1629 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001630 ///
1631 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1632 /// ConvertType instead of ConvertTypeForMem.
1633 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001634
Daniel Dunbara7566f12010-02-09 02:48:28 +00001635 /// CreateMemTemp - Create a temporary memory object of the given type, with
1636 /// appropriate alignment.
John McCall7f416cc2015-09-08 08:05:57 +00001637 Address CreateMemTemp(QualType T, const Twine &Name = "tmp");
1638 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001639
John McCall7a626f62010-09-15 10:14:12 +00001640 /// CreateAggTemp - Create a temporary memory object for the given
1641 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001642 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00001643 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001644 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001645 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001646 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001647 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001648 }
1649
John McCallad7c5c12011-02-08 08:22:06 +00001650 /// Emit a cast to void* in the appropriate address space.
1651 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1652
Chris Lattner8394d792007-06-05 20:53:16 +00001653 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1654 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001655 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001656
John McCalla2342eb2010-12-05 02:00:02 +00001657 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1658 void EmitIgnoredExpr(const Expr *E);
1659
Chris Lattner4647a212007-08-31 22:49:20 +00001660 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1661 /// any type. The result is returned as an RValue struct. If this is an
1662 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1663 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001664 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001665 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001666 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001667 AggValueSlot aggSlot = AggValueSlot::ignored(),
1668 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001669
Mike Stumpfc496822009-02-08 23:14:22 +00001670 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1671 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00001672 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001673
Charles Davisc7d5c942015-09-17 20:55:33 +00001674 /// Emit a "reference" to a __builtin_ms_va_list; this is
1675 /// always the value of the expression, because a __builtin_ms_va_list is a
1676 /// pointer to a char.
1677 Address EmitMSVAListRef(const Expr *E);
1678
Mike Stumpfc496822009-02-08 23:14:22 +00001679 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1680 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001681 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001682
John McCall91ca10f2011-03-08 09:11:50 +00001683 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001684 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00001685 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001686 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001687
John McCall7f416cc2015-09-08 08:05:57 +00001688 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00001689
John McCall91ca10f2011-03-08 09:11:50 +00001690 /// EmitExprAsInit - Emits the code necessary to initialize a
1691 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001692 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001693 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001694
Fariborz Jahanian78652202013-01-25 23:57:05 +00001695 /// hasVolatileMember - returns true if aggregate type has a volatile
1696 /// member.
1697 bool hasVolatileMember(QualType T) {
1698 if (const RecordType *RT = T->getAs<RecordType>()) {
1699 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1700 return RD->hasVolatileMember();
1701 }
1702 return false;
1703 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001704 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001705 ///
1706 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1707 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00001708 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001709 QualType EltTy) {
1710 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00001711 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001712 }
1713
John McCall7f416cc2015-09-08 08:05:57 +00001714 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
1715 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00001716 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00001717 /*IsAssignment=*/false);
1718 }
1719
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001720 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001721 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001722 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001723 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001724 /// \param isAssignment - If false, allow padding to be copied. This often
1725 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00001726 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001727 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001728 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001729
Anders Carlsson9396a892008-09-11 09:15:33 +00001730 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00001731 Address GetAddrOfLocalVar(const VarDecl *VD) {
1732 auto it = LocalDeclMap.find(VD);
1733 assert(it != LocalDeclMap.end() &&
1734 "Invalid argument to GetAddrOfLocalVar(), no decl!");
1735 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00001736 }
Mike Stumpfc496822009-02-08 23:14:22 +00001737
John McCallc07a0c72011-02-17 10:25:35 +00001738 /// getOpaqueLValueMapping - Given an opaque value expression (which
1739 /// must be mapped to an l-value), return its mapping.
1740 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1741 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1742
1743 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1744 it = OpaqueLValues.find(e);
1745 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1746 return it->second;
1747 }
1748
1749 /// getOpaqueRValueMapping - Given an opaque value expression (which
1750 /// must be mapped to an r-value), return its mapping.
1751 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1752 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1753
1754 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1755 it = OpaqueRValues.find(e);
1756 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001757 return it->second;
1758 }
1759
Dan Gohman75d69da2008-05-22 00:50:06 +00001760 /// getAccessedFieldNo - Given an encoded value and a result number, return
1761 /// the input field number being accessed.
1762 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1763
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001764 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001765 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001766
Anders Carlssonc0964b62010-05-22 17:35:42 +00001767 /// EmitNullInitialization - Generate code to set a value of the given type to
1768 /// null, If the type contains data member pointers, they will be initialized
1769 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00001770 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001771
Charles Davisc7d5c942015-09-17 20:55:33 +00001772 /// Emits a call to an LLVM variable-argument intrinsic, either
1773 /// \c llvm.va_start or \c llvm.va_end.
1774 /// \param ArgValue A reference to the \c va_list as emitted by either
1775 /// \c EmitVAListRef or \c EmitMSVAListRef.
1776 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
1777 /// calls \c llvm.va_end.
1778 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
1779
1780 /// Generate code to get an argument from the passed in pointer
1781 /// and update it accordingly.
1782 /// \param VE The \c VAArgExpr for which to generate code.
1783 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
1784 /// either \c EmitVAListRef or \c EmitMSVAListRef.
1785 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001786 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001787 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00001788 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001789
John McCall82fe67b2011-07-09 01:37:26 +00001790 /// emitArrayLength - Compute the length of an array, even if it's a
1791 /// VLA, and drill down to the base element type.
1792 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1793 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001794 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00001795
John McCall23c29fe2011-06-24 21:55:10 +00001796 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1797 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001798 ///
1799 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001800 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001801
John McCall23c29fe2011-06-24 21:55:10 +00001802 /// getVLASize - Returns an LLVM value that corresponds to the size,
1803 /// in non-variably-sized elements, of a variable length array type,
1804 /// plus that largest non-variably-sized element type. Assumes that
1805 /// the type has already been emitted with EmitVariablyModifiedType.
1806 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1807 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001808
Anders Carlssona5d077d2009-04-14 16:58:56 +00001809 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1810 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001811 llvm::Value *LoadCXXThis() {
1812 assert(CXXThisValue && "no 'this' value for this function");
1813 return CXXThisValue;
1814 }
John McCall7f416cc2015-09-08 08:05:57 +00001815 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00001816
Anders Carlssone36a6b32010-01-02 01:01:18 +00001817 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1818 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001819 // FIXME: Every place that calls LoadCXXVTT is something
1820 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001821 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001822 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1823 return CXXStructorImplicitParamValue;
1824 }
1825
John McCall6ce74722010-02-16 04:15:37 +00001826 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001827 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00001828 Address
1829 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001830 const CXXRecordDecl *Derived,
1831 const CXXRecordDecl *Base,
1832 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001833
John McCall7f416cc2015-09-08 08:05:57 +00001834 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
1835
Mike Stumpe5311b02009-11-30 20:08:49 +00001836 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1837 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00001838 Address GetAddressOfBaseClass(Address Value,
1839 const CXXRecordDecl *Derived,
1840 CastExpr::path_const_iterator PathBegin,
1841 CastExpr::path_const_iterator PathEnd,
1842 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001843
John McCall7f416cc2015-09-08 08:05:57 +00001844 Address GetAddressOfDerivedClass(Address Value,
1845 const CXXRecordDecl *Derived,
1846 CastExpr::path_const_iterator PathBegin,
1847 CastExpr::path_const_iterator PathEnd,
1848 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00001849
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001850 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1851 /// base constructor/destructor with virtual bases.
1852 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1853 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1854 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1855 bool Delegating);
1856
John McCallf8ff7b92010-02-23 00:48:20 +00001857 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1858 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001859 const FunctionArgList &Args,
1860 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001861 // It's important not to confuse this and the previous function. Delegating
1862 // constructors are the C++0x feature. The constructor delegate optimization
1863 // is used to reduce duplication in the base and complete consturctors where
1864 // they are substantially the same.
1865 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1866 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001867
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001868 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001869 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001870 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001871
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001872 /// Emit assumption load for all bases. Requires to be be called only on
1873 /// most-derived class and not under construction of the object.
1874 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
1875
1876 /// Emit assumption that vptr load == global vtable.
1877 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
1878
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001879 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00001880 Address This, Address Src,
1881 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001882
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001883 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00001884 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00001885 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001886 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001887 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001888
Anders Carlssond49844b2009-09-23 02:45:36 +00001889 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1890 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00001891 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001892 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001893 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001894
John McCall82fe67b2011-07-09 01:37:26 +00001895 static Destroyer destroyCXXObject;
1896
Anders Carlsson0a637412009-05-29 21:03:38 +00001897 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001898 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001899 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001900
John McCall99210dc2011-09-15 06:49:18 +00001901 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001902 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00001903 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00001904 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00001905
Peter Collingbourne702b2842011-11-27 22:09:22 +00001906 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00001907 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001908
David Majnemerdc012fa2015-04-22 21:38:15 +00001909 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
1910 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
1911
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001912 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001913 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001914
Eli Friedman24f55432009-11-18 00:57:03 +00001915 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1916 QualType DeleteTy);
1917
Richard Smith760520b2014-06-03 23:27:44 +00001918 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1919 const Expr *Arg, bool IsDelete);
1920
John McCall7f416cc2015-09-08 08:05:57 +00001921 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
1922 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
1923 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001924
Richard Smith69d0d262012-08-24 00:54:33 +00001925 /// \brief Situations in which we might emit a check for the suitability of a
1926 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001927 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001928 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001929 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001930 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001931 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001932 /// Checking the bound value in a reference binding. Must be suitably sized
1933 /// and aligned, but is not required to refer to an object (until the
1934 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001935 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001936 /// Checking the object expression in a non-static data member access. Must
1937 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001938 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001939 /// Checking the 'this' pointer for a call to a non-static member function.
1940 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001941 TCK_MemberCall,
1942 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001943 TCK_ConstructorCall,
1944 /// Checking the operand of a static_cast to a derived pointer type. Must be
1945 /// null or an object within its lifetime.
1946 TCK_DowncastPointer,
1947 /// Checking the operand of a static_cast to a derived reference type. Must
1948 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001949 TCK_DowncastReference,
1950 /// Checking the operand of a cast to a base object. Must be suitably sized
1951 /// and aligned.
1952 TCK_Upcast,
1953 /// Checking the operand of a cast to a virtual base object. Must be an
1954 /// object within its lifetime.
1955 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00001956 };
1957
Alexey Samsonovac4afe42014-07-07 23:59:57 +00001958 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
1959 /// calls to EmitTypeCheck can be skipped.
1960 bool sanitizePerformTypeCheck() const;
1961
Richard Smith4d1458e2012-09-08 02:08:36 +00001962 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001963 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001964 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001965 QualType Type, CharUnits Alignment = CharUnits::Zero(),
1966 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001967
Richard Smith539e4a72013-02-23 02:53:19 +00001968 /// \brief Emit a check that \p Base points into an array object, which
1969 /// we can access at index \p Index. \p Accessed should be \c false if we
1970 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1971 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1972 QualType IndexType, bool Accessed);
1973
Chris Lattner116ce8f2010-01-09 21:40:03 +00001974 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1975 bool isInc, bool isPre);
1976 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1977 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00001978
1979 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00001980 llvm::Value *OffsetValue = nullptr) {
1981 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
1982 OffsetValue);
1983 }
Hal Finkelbcc06082014-09-07 22:58:14 +00001984
Chris Lattner8394d792007-06-05 20:53:16 +00001985 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001986 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001987 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001988
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001989 /// EmitDecl - Emit a declaration.
1990 ///
1991 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001992 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001993
John McCall1c9c3fd2010-10-15 04:57:14 +00001994 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001995 ///
1996 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001997 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001998
David Blaikie73ca5692014-12-09 00:32:22 +00001999 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002000 bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00002001 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00002002
John McCallbd309292010-07-06 01:34:17 +00002003 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2004 llvm::Value *Address);
2005
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002006 /// \brief Determine whether the given initializer is trivial in the sense
2007 /// that it requires no code to be generated.
2008 bool isTrivialInitializer(const Expr *Init);
2009
John McCall1c9c3fd2010-10-15 04:57:14 +00002010 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002011 ///
2012 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002013 void EmitAutoVarDecl(const VarDecl &D);
2014
2015 class AutoVarEmission {
2016 friend class CodeGenFunction;
2017
John McCall9e2e22f2011-02-22 07:16:58 +00002018 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002019
John McCall7f416cc2015-09-08 08:05:57 +00002020 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002021 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002022 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002023
2024 llvm::Value *NRVOFlag;
2025
2026 /// True if the variable is a __block variable.
2027 bool IsByRef;
2028
2029 /// True if the variable is of aggregate type and has a constant
2030 /// initializer.
2031 bool IsConstantAggregate;
2032
Nadav Rotem1da30942013-03-23 06:43:35 +00002033 /// Non-null if we should use lifetime annotations.
2034 llvm::Value *SizeForLifetimeMarkers;
2035
John McCall9e2e22f2011-02-22 07:16:58 +00002036 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002037 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002038
John McCallc533cb72011-02-22 06:44:22 +00002039 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002040 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002041 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002042 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002043
John McCall7f416cc2015-09-08 08:05:57 +00002044 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002045
2046 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002047 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2048
Craig Topper8a13c412014-05-21 05:09:00 +00002049 bool useLifetimeMarkers() const {
2050 return SizeForLifetimeMarkers != nullptr;
2051 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002052 llvm::Value *getSizeForLifetimeMarkers() const {
2053 assert(useLifetimeMarkers());
2054 return SizeForLifetimeMarkers;
2055 }
2056
2057 /// Returns the raw, allocated address, which is not necessarily
2058 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002059 Address getAllocatedAddress() const {
2060 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002061 }
2062
John McCallc533cb72011-02-22 06:44:22 +00002063 /// Returns the address of the object within this declaration.
2064 /// Note that this does not chase the forwarding pointer for
2065 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002066 Address getObjectAddress(CodeGenFunction &CGF) const {
2067 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002068
John McCall7f416cc2015-09-08 08:05:57 +00002069 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002070 }
2071 };
2072 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2073 void EmitAutoVarInit(const AutoVarEmission &emission);
2074 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002075 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2076 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002077
John McCall1c9c3fd2010-10-15 04:57:14 +00002078 void EmitStaticVarDecl(const VarDecl &D,
2079 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002080
John McCall7f416cc2015-09-08 08:05:57 +00002081 class ParamValue {
2082 llvm::Value *Value;
2083 unsigned Alignment;
2084 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2085 public:
2086 static ParamValue forDirect(llvm::Value *value) {
2087 return ParamValue(value, 0);
2088 }
2089 static ParamValue forIndirect(Address addr) {
2090 assert(!addr.getAlignment().isZero());
2091 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2092 }
2093
2094 bool isIndirect() const { return Alignment != 0; }
2095 llvm::Value *getAnyValue() const { return Value; }
2096
2097 llvm::Value *getDirectValue() const {
2098 assert(!isIndirect());
2099 return Value;
2100 }
2101
2102 Address getIndirectAddress() const {
2103 assert(isIndirect());
2104 return Address(Value, CharUnits::fromQuantity(Alignment));
2105 }
2106 };
2107
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002108 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002109 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002110
John McCallc07a0c72011-02-17 10:25:35 +00002111 /// protectFromPeepholes - Protect a value that we're intending to
2112 /// store to the side, but which will probably be used later, from
2113 /// aggressive peepholing optimizations that might delete it.
2114 ///
2115 /// Pass the result to unprotectFromPeepholes to declare that
2116 /// protection is no longer required.
2117 ///
2118 /// There's no particular reason why this shouldn't apply to
2119 /// l-values, it's just that no existing peepholes work on pointers.
2120 PeepholeProtection protectFromPeepholes(RValue rvalue);
2121 void unprotectFromPeepholes(PeepholeProtection protection);
2122
Chris Lattner84915fa2007-06-02 04:16:21 +00002123 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002124 // Statement Emission
2125 //===--------------------------------------------------------------------===//
2126
Mike Stumpfc496822009-02-08 23:14:22 +00002127 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002128 void EmitStopPoint(const Stmt *S);
2129
Mike Stumpfc496822009-02-08 23:14:22 +00002130 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2131 /// this function even if there is no current insertion point.
2132 ///
2133 /// This function may clear the current insertion point; callers should use
2134 /// EnsureInsertPoint if they wish to subsequently generate code without first
2135 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002136 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002137
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002138 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002139 /// necessarily require an insertion point or debug information; typically
2140 /// because the statement amounts to a jump or a container of other
2141 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002142 ///
2143 /// \return True if the statement was handled.
2144 bool EmitSimpleStmt(const Stmt *S);
2145
John McCall7f416cc2015-09-08 08:05:57 +00002146 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2147 AggValueSlot AVS = AggValueSlot::ignored());
2148 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2149 bool GetLast = false,
2150 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002151 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002152
Mike Stumpfc496822009-02-08 23:14:22 +00002153 /// EmitLabel - Emit the block for the given label. It is legal to call this
2154 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002155 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002156
Chris Lattnerac248202007-05-30 00:13:02 +00002157 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002158 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002159 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002160 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002161 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002162
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002163 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002164 ArrayRef<const Attr *> Attrs = None);
2165 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002166 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002167 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002168 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002169 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002170 void EmitBreakStmt(const BreakStmt &S);
2171 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002172 void EmitSwitchStmt(const SwitchStmt &S);
2173 void EmitDefaultStmt(const DefaultStmt &S);
2174 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002175 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002176 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002177
Anders Carlsson2e744e82008-08-30 19:51:14 +00002178 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002179 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2180 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002181 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002182 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002183
John McCallb609d3f2010-07-07 06:56:46 +00002184 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2185 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002186
Anders Carlsson52d78a52009-09-27 18:58:34 +00002187 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002188 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002189 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002190 void EnterSEHTryStmt(const SEHTryStmt &S);
2191 void ExitSEHTryStmt(const SEHTryStmt &S);
2192
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002193 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002194 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002195
2196 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2197 const SEHExceptStmt &Except);
2198
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002199 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2200 const SEHFinallyStmt &Finally);
2201
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002202 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2203 llvm::Value *ParentFP,
2204 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002205 llvm::Value *EmitSEHExceptionCode();
2206 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002207 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002208
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002209 /// Scan the outlined statement for captures from the parent function. For
2210 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002211 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002212 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002213 bool IsFilter);
2214
2215 /// Recovers the address of a local in a parent function. ParentVar is the
2216 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002217 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002218 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2219 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002220 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2221 Address ParentVar,
2222 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002223
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002224 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002225 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002226
Alexey Bataev1189bd02016-01-26 12:20:39 +00002227 /// Returns calculated size of the specified type.
2228 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002229 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002230 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002231 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002232 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002233 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002234 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002235 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002236 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2237 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002238 /// \brief Perform element by element copying of arrays with type \a
2239 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2240 /// generated by \a CopyGen.
2241 ///
2242 /// \param DestAddr Address of the destination array.
2243 /// \param SrcAddr Address of the source array.
2244 /// \param OriginalType Type of destination and source arrays.
2245 /// \param CopyGen Copying procedure that copies value of single array element
2246 /// to another single array element.
2247 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002248 Address DestAddr, Address SrcAddr, QualType OriginalType,
2249 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002250 /// \brief Emit proper copying of data from one variable to another.
2251 ///
2252 /// \param OriginalType Original type of the copied variables.
2253 /// \param DestAddr Destination address.
2254 /// \param SrcAddr Source address.
2255 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2256 /// type of the base array element).
2257 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2258 /// the base array element).
2259 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2260 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002261 void EmitOMPCopy(QualType OriginalType,
2262 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002263 const VarDecl *DestVD, const VarDecl *SrcVD,
2264 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002265 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2266 /// \a X = \a E \a BO \a E.
2267 ///
2268 /// \param X Value to be updated.
2269 /// \param E Update value.
2270 /// \param BO Binary operation for update operation.
2271 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2272 /// expression, false otherwise.
2273 /// \param AO Atomic ordering of the generated atomic instructions.
2274 /// \param CommonGen Code generator for complex expressions that cannot be
2275 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002276 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2277 /// generated, <false, RValue::get(nullptr)> otherwise.
2278 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002279 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2280 llvm::AtomicOrdering AO, SourceLocation Loc,
2281 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002282 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002283 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002284 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2285 OMPPrivateScope &PrivateScope);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002286 /// \brief Emit code for copyin clause in \a D directive. The next code is
2287 /// generated at the start of outlined functions for directives:
2288 /// \code
2289 /// threadprivate_var1 = master_threadprivate_var1;
2290 /// operator=(threadprivate_var2, master_threadprivate_var2);
2291 /// ...
2292 /// __kmpc_barrier(&loc, global_tid);
2293 /// \endcode
2294 ///
2295 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2296 /// \returns true if at least one copyin variable is found, false otherwise.
2297 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002298 /// \brief Emit initial code for lastprivate variables. If some variable is
2299 /// not also firstprivate, then the default initialization is used. Otherwise
2300 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2301 /// method.
2302 ///
2303 /// \param D Directive that may have 'lastprivate' directives.
2304 /// \param PrivateScope Private scope for capturing lastprivate variables for
2305 /// proper codegen in internal captured statement.
2306 ///
2307 /// \returns true if there is at least one lastprivate variable, false
2308 /// otherwise.
2309 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2310 OMPPrivateScope &PrivateScope);
2311 /// \brief Emit final copying of lastprivate values to original variables at
2312 /// the end of the worksharing or simd directive.
2313 ///
2314 /// \param D Directive that has at least one 'lastprivate' directives.
2315 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2316 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002317 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002318 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002319 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002320 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002321 /// Emit initial code for linear clauses.
2322 void EmitOMPLinearClause(const OMPLoopDirective &D,
2323 CodeGenFunction::OMPPrivateScope &PrivateScope);
2324 /// Emit final code for linear clauses.
2325 /// \param CondGen Optional conditional code for final part of codegen for
2326 /// linear clause.
2327 void EmitOMPLinearClauseFinal(
2328 const OMPLoopDirective &D,
2329 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002330 /// \brief Emit initial code for reduction variables. Creates reduction copies
2331 /// and initializes them with the values according to OpenMP standard.
2332 ///
2333 /// \param D Directive (possibly) with the 'reduction' clause.
2334 /// \param PrivateScope Private scope for capturing reduction variables for
2335 /// proper codegen in internal captured statement.
2336 ///
2337 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2338 OMPPrivateScope &PrivateScope);
2339 /// \brief Emit final update of reduction values to original variables at
2340 /// the end of the directive.
2341 ///
2342 /// \param D Directive that has at least one 'reduction' directives.
2343 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002344 /// \brief Emit initial code for linear variables. Creates private copies
2345 /// and initializes them with the values according to OpenMP standard.
2346 ///
2347 /// \param D Directive (possibly) with the 'linear' clause.
2348 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002349
Alexey Bataev7292c292016-04-25 12:22:29 +00002350 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2351 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002352 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002353 TaskGenTy;
2354 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2355 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002356 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00002357
Alexey Bataev9959db52014-05-06 10:08:46 +00002358 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002359 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002360 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002361 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002362 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002363 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002364 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002365 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002366 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002367 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002368 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002369 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002370 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002371 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002372 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002373 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002374 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002375 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002376 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002377 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002378 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002379 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002380 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002381 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002382 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002383 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002384 void
2385 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002386 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002387 void
2388 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002389 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002390 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002391 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002392 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002393 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002394 void EmitOMPDistributeLoop(const OMPDistributeDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002395
Alexey Bataev14fa1c62016-03-29 05:34:15 +00002396 /// Emit outlined function for the target directive.
2397 static std::pair<llvm::Function * /*OutlinedFn*/,
2398 llvm::Constant * /*OutlinedFnID*/>
2399 EmitOMPTargetDirectiveOutlinedFunction(CodeGenModule &CGM,
2400 const OMPTargetDirective &S,
2401 StringRef ParentName,
2402 bool IsOffloadEntry);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002403 /// \brief Emit inner loop of the worksharing/simd construct.
2404 ///
2405 /// \param S Directive, for which the inner loop must be emitted.
2406 /// \param RequiresCleanup true, if directive has some associated private
2407 /// variables.
2408 /// \param LoopCond Bollean condition for loop continuation.
2409 /// \param IncExpr Increment expression for loop control variable.
2410 /// \param BodyGen Generator for the inner body of the inner loop.
2411 /// \param PostIncGen Genrator for post-increment code (required for ordered
2412 /// loop directvies).
2413 void EmitOMPInnerLoop(
2414 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2415 const Expr *IncExpr,
2416 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2417 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002418
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002419 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002420 /// Emit initial code for loop counters of loop-based directives.
2421 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2422 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002423
Alexander Musmanc6388682014-12-15 07:07:06 +00002424private:
Alexander Musmanc6388682014-12-15 07:07:06 +00002425 /// Helpers for the OpenMP loop directives.
Alexey Bataev0f34da12015-07-02 04:17:07 +00002426 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002427 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002428 void EmitOMPSimdFinal(
2429 const OMPLoopDirective &D,
2430 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev38e89532015-04-16 04:54:05 +00002431 /// \brief Emit code for the worksharing loop-based directive.
2432 /// \return true, if this construct has any lastprivate clause, false -
2433 /// otherwise.
2434 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002435 void EmitOMPOuterLoop(bool IsMonotonic, bool DynamicOrOrdered,
2436 const OMPLoopDirective &S, OMPPrivateScope &LoopScope, bool Ordered,
2437 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00002438 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002439 bool IsMonotonic, const OMPLoopDirective &S,
2440 OMPPrivateScope &LoopScope, bool Ordered, Address LB,
2441 Address UB, Address ST, Address IL,
2442 llvm::Value *Chunk);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002443 void EmitOMPDistributeOuterLoop(
2444 OpenMPDistScheduleClauseKind ScheduleKind,
2445 const OMPDistributeDirective &S, OMPPrivateScope &LoopScope,
2446 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002447 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002448 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002449
2450public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002451
Chris Lattner208ae962007-05-30 17:57:17 +00002452 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002453 // LValue Expression Emission
2454 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002455
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002456 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2457 RValue GetUndefRValue(QualType Ty);
2458
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002459 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2460 /// and issue an ErrorUnsupported style diagnostic (using the
2461 /// provided Name).
2462 RValue EmitUnsupportedRValue(const Expr *E,
2463 const char *Name);
2464
Mike Stumpfc496822009-02-08 23:14:22 +00002465 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2466 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002467 LValue EmitUnsupportedLValue(const Expr *E,
2468 const char *Name);
2469
Chris Lattner8394d792007-06-05 20:53:16 +00002470 /// EmitLValue - Emit code to compute a designator that specifies the location
2471 /// of the expression.
2472 ///
2473 /// This can return one of two things: a simple address or a bitfield
2474 /// reference. In either case, the LLVM Value* in the LValue structure is
2475 /// guaranteed to be an LLVM pointer type.
2476 ///
2477 /// If this returns a bitfield reference, nothing about the pointee type of
2478 /// the LLVM value is known: For example, it may not be a pointer to an
2479 /// integer.
2480 ///
2481 /// If this returns a normal address, and if the lvalue's C type is fixed
2482 /// size, this method guarantees that the returned pointer type will point to
2483 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2484 /// variable length type, this is not possible.
2485 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002486 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002487
Richard Smith4d1458e2012-09-08 02:08:36 +00002488 /// \brief Same as EmitLValue but additionally we generate checking code to
2489 /// guard against undefined behavior. This is only suitable when we know
2490 /// that the address will be used to access the object.
2491 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002492
John McCall7f416cc2015-09-08 08:05:57 +00002493 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002494 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002495
John McCalla8ec7eb2013-03-07 21:37:17 +00002496 void EmitAtomicInit(Expr *E, LValue lvalue);
2497
David Majnemera5b195a2015-02-14 01:35:12 +00002498 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00002499
2500 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2501 AggValueSlot Slot = AggValueSlot::ignored());
2502
Nick Lewycky2d84e842013-10-02 02:29:49 +00002503 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002504 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002505 AggValueSlot slot = AggValueSlot::ignored());
2506
2507 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2508
David Majnemera5b195a2015-02-14 01:35:12 +00002509 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2510 bool IsVolatile, bool isInit);
2511
Alexey Bataevb4505a72015-03-30 05:20:59 +00002512 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002513 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00002514 llvm::AtomicOrdering Success =
2515 llvm::AtomicOrdering::SequentiallyConsistent,
2516 llvm::AtomicOrdering Failure =
2517 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00002518 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2519
Alexey Bataevb4505a72015-03-30 05:20:59 +00002520 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002521 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002522 bool IsVolatile);
2523
John McCall3a7f6922010-10-27 20:58:56 +00002524 /// EmitToMemory - Change a scalar value from its value
2525 /// representation to its in-memory representation.
2526 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2527
2528 /// EmitFromMemory - Change a scalar value from its memory
2529 /// representation to its value representation.
2530 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2531
Daniel Dunbar1d425462009-02-10 00:57:50 +00002532 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2533 /// care to appropriately convert from the memory representation to
2534 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002535 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002536 SourceLocation Loc,
John McCall7f416cc2015-09-08 08:05:57 +00002537 AlignmentSource AlignSource =
2538 AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002539 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002540 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002541 uint64_t TBAAOffset = 0,
2542 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002543
2544 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2545 /// care to appropriately convert from the memory representation to
2546 /// the LLVM value representation. The l-value must be a simple
2547 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002548 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002549
2550 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2551 /// care to appropriately convert from the memory representation to
2552 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002553 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
2554 bool Volatile, QualType Ty,
2555 AlignmentSource AlignSource = AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002556 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002557 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002558 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002559
2560 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2561 /// care to appropriately convert from the memory representation to
2562 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002563 /// l-value. The isInit flag indicates whether this is an initialization.
2564 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2565 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002566
Chris Lattner8394d792007-06-05 20:53:16 +00002567 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2568 /// this method emits the address of the lvalue, then loads the result as an
2569 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002570 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002571 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2572 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002573 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002574
Chris Lattner8394d792007-06-05 20:53:16 +00002575 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2576 /// lvalue, where both are guaranteed to the have the same type, and that type
2577 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002578 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002579 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002580 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002581
Nick Lewycky2d84e842013-10-02 02:29:49 +00002582 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2583 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002584 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002585 /// \param Result [out] - If non-null, this will be set to a Value* for the
2586 /// bit-field contents after the store, appropriate for use as the result of
2587 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002588 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002589 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002590
John McCall4f29b492010-11-16 23:07:28 +00002591 /// Emit an l-value for an assignment (simple or compound) of complex type.
2592 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002593 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002594 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2595 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002596
Chris Lattner57540c52011-04-15 05:22:18 +00002597 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002598 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002599 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002600 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002601 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002602 // Note: only available for agg return types
2603 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002604 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002605 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002606 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002607 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002608 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002609 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2610 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00002611 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
2612 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002613 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002614 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002615 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002616 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002617 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002618 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002619 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002620 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002621 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002622
John McCall7f416cc2015-09-08 08:05:57 +00002623 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002624
Nick Lewycky2d84e842013-10-02 02:29:49 +00002625 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002626
John McCall7f416cc2015-09-08 08:05:57 +00002627 Address EmitArrayToPointerDecay(const Expr *Array,
2628 AlignmentSource *AlignSource = nullptr);
2629
John McCall71335052012-03-10 03:05:10 +00002630 class ConstantEmission {
2631 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2632 ConstantEmission(llvm::Constant *C, bool isReference)
2633 : ValueAndIsReference(C, isReference) {}
2634 public:
2635 ConstantEmission() {}
2636 static ConstantEmission forReference(llvm::Constant *C) {
2637 return ConstantEmission(C, true);
2638 }
2639 static ConstantEmission forValue(llvm::Constant *C) {
2640 return ConstantEmission(C, false);
2641 }
2642
Aaron Ballman67347662015-02-15 22:00:28 +00002643 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002644 return ValueAndIsReference.getOpaqueValue() != nullptr;
2645 }
John McCall71335052012-03-10 03:05:10 +00002646
2647 bool isReference() const { return ValueAndIsReference.getInt(); }
2648 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2649 assert(isReference());
2650 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2651 refExpr->getType());
2652 }
2653
2654 llvm::Constant *getValue() const {
2655 assert(!isReference());
2656 return ValueAndIsReference.getPointer();
2657 }
2658 };
2659
John McCall113bee02012-03-10 09:33:50 +00002660 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002661
John McCallfe96e0b2011-11-06 09:01:30 +00002662 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2663 AggValueSlot slot = AggValueSlot::ignored());
2664 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2665
Daniel Dunbar722f4242009-04-22 05:08:15 +00002666 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002667 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002668 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002669 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002670
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002671 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2672 /// if the Field is a reference, this will return the address of the reference
2673 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002674 LValue EmitLValueForFieldInitialization(LValue Base,
2675 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002676
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002677 LValue EmitLValueForIvar(QualType ObjectTy,
2678 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002679 unsigned CVRQualifiers);
2680
Anders Carlsson3be22e22009-05-30 23:23:33 +00002681 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002682 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002683 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002684 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002685 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002686
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002687 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002688 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002689 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002690 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002691 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002692 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002693
Chris Lattnerd7f58862007-06-02 05:24:33 +00002694 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002695 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002696 //===--------------------------------------------------------------------===//
2697
Mike Stumpfc496822009-02-08 23:14:22 +00002698 /// EmitCall - Generate a call of the given function, expecting the given
2699 /// result type, and using the given argument list which specifies both the
2700 /// LLVM arguments and the types they were derived from.
Samuel Antao798f11c2015-11-23 22:04:44 +00002701 RValue EmitCall(const CGFunctionInfo &FnInfo, llvm::Value *Callee,
2702 ReturnValueSlot ReturnValue, const CallArgList &Args,
2703 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Craig Topper8a13c412014-05-21 05:09:00 +00002704 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002705
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002706 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002707 ReturnValueSlot ReturnValue,
Samuel Antao798f11c2015-11-23 22:04:44 +00002708 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Peter Collingbournef7706832014-12-12 23:41:25 +00002709 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002710 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002711 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002712
Eric Christopherc7e79db2015-11-12 00:44:04 +00002713 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00002714
John McCall882987f2013-02-28 19:01:20 +00002715 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2716 const Twine &name = "");
2717 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2718 ArrayRef<llvm::Value*> args,
2719 const Twine &name = "");
2720 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2721 const Twine &name = "");
2722 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2723 ArrayRef<llvm::Value*> args,
2724 const Twine &name = "");
2725
John McCallbd309292010-07-06 01:34:17 +00002726 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002727 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002728 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002729 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2730 ArrayRef<llvm::Value*> args,
2731 const Twine &name = "");
2732 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2733 const Twine &name = "");
2734 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2735 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002736
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002737 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2738 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002739 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002740
2741 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2742 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002743 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002744
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002745 RValue
2746 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2747 ReturnValueSlot ReturnValue, llvm::Value *This,
2748 llvm::Value *ImplicitParam,
2749 QualType ImplicitParamTy, const CallExpr *E);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00002750 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD, llvm::Value *Callee,
2751 llvm::Value *This, llvm::Value *ImplicitParam,
2752 QualType ImplicitParamTy, const CallExpr *E,
2753 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002754 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2755 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002756 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2757 const CXXMethodDecl *MD,
2758 ReturnValueSlot ReturnValue,
2759 bool HasQualifier,
2760 NestedNameSpecifier *Qualifier,
2761 bool IsArrow, const Expr *Base);
2762 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002763 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
2764 llvm::Value *memberPtr,
2765 const MemberPointerType *memberPtrType,
2766 AlignmentSource *AlignSource = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002767 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2768 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002769
Anders Carlsson4034a952009-05-27 04:18:27 +00002770 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002771 const CXXMethodDecl *MD,
2772 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002773
Peter Collingbournefe883422011-10-06 18:29:37 +00002774 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2775 ReturnValueSlot ReturnValue);
2776
Justin Lebar3039a592016-01-23 21:28:14 +00002777 RValue EmitCUDADevicePrintfCallExpr(const CallExpr *E,
2778 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002779
Mike Stump11289f42009-09-09 15:08:12 +00002780 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002781 unsigned BuiltinID, const CallExpr *E,
2782 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002783
Anders Carlssonbfb36712009-12-24 21:13:40 +00002784 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002785
Mike Stumpfc496822009-02-08 23:14:22 +00002786 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2787 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002788 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2789
Kevin Qin1718af62013-11-14 02:45:18 +00002790 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2791 const llvm::CmpInst::Predicate Fp,
2792 const llvm::CmpInst::Predicate Ip,
2793 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002794 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002795
2796 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2797 unsigned LLVMIntrinsic,
2798 unsigned AltLLVMIntrinsic,
2799 const char *NameHint,
2800 unsigned Modifier,
2801 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002802 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00002803 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00002804 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2805 unsigned Modifier, llvm::Type *ArgTy,
2806 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002807 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002808 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002809 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002810 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002811 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002812 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002813 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002814 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2815 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00002816 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00002817 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002818
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002819 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002820 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2821 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00002822 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00002823 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00002824 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00002825 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
2826 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002827
Daniel Dunbar66912a12008-08-20 00:28:19 +00002828 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002829 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002830 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002831 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2832 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2833 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002834 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002835 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002836 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2837 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002838
John McCall31168b02011-06-15 23:02:42 +00002839 /// Retrieves the default cleanup kind for an ARC cleanup.
2840 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2841 CleanupKind getARCCleanupKind() {
2842 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2843 ? NormalAndEHCleanup : NormalCleanup;
2844 }
2845
2846 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00002847 void EmitARCInitWeak(Address addr, llvm::Value *value);
2848 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00002849 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00002850 llvm::Value *EmitARCLoadWeakRetained(Address addr);
2851 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
2852 void EmitARCCopyWeak(Address dst, Address src);
2853 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00002854 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2855 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002856 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002857 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00002858 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002859 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002860 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00002861 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002862 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00002863 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00002864 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00002865 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00002866 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2867 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2868 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00002869 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00002870
2871 std::pair<LValue,llvm::Value*>
2872 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2873 std::pair<LValue,llvm::Value*>
2874 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00002875 std::pair<LValue,llvm::Value*>
2876 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00002877
John McCall248512a2011-10-01 10:32:24 +00002878 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002879 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2880 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2881
John McCallff613032011-10-04 06:23:45 +00002882 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00002883 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
2884 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00002885 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2886 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00002887 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002888
Craig Topper00bbdcf2014-06-28 23:22:23 +00002889 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002890
John McCall82fe67b2011-07-09 01:37:26 +00002891 static Destroyer destroyARCStrongImprecise;
2892 static Destroyer destroyARCStrongPrecise;
2893 static Destroyer destroyARCWeak;
2894
John McCall31168b02011-06-15 23:02:42 +00002895 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2896 llvm::Value *EmitObjCAutoreleasePoolPush();
2897 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2898 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2899 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2900
Richard Smitha1c9d4d2013-06-12 23:38:09 +00002901 /// \brief Emits a reference binding to the passed in expression.
2902 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002903
Chris Lattner6278e6a2007-08-11 00:04:45 +00002904 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002905 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002906 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002907
2908 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002909
2910 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2911 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002912 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002913
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00002914 /// Emit a conversion from the specified type to the specified destination
2915 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00002916 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00002917 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00002918
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00002919 /// Emit a conversion from the specified complex type to the specified
2920 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002921 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00002922 QualType DstTy,
2923 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00002924
John McCall7a626f62010-09-15 10:14:12 +00002925 /// EmitAggExpr - Emit the computation of the specified expression
2926 /// of aggregate type. The result is computed into the given slot,
2927 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002928 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002929
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002930 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2931 /// aggregate type into a temporary LValue.
2932 LValue EmitAggExprToLValue(const Expr *E);
2933
John McCall1bd25562011-06-24 23:21:27 +00002934 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2935 /// make sure it survives garbage collection until this point.
2936 void EmitExtendGCLifetime(llvm::Value *object);
2937
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002938 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002939 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002940 ComplexPairTy EmitComplexExpr(const Expr *E,
2941 bool IgnoreReal = false,
2942 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002943
John McCall47fb9502013-03-07 21:37:08 +00002944 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2945 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002946 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002947
John McCall47fb9502013-03-07 21:37:08 +00002948 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002949 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00002950
2951 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002952 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002953
John McCall7f416cc2015-09-08 08:05:57 +00002954 Address emitAddrOfRealComponent(Address complex, QualType complexType);
2955 Address emitAddrOfImagComponent(Address complex, QualType complexType);
2956
Chandler Carruth84537952012-03-30 19:44:53 +00002957 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2958 /// global variable that has already been created for it. If the initializer
2959 /// has a different type than GV does, this may free GV and return a different
2960 /// one. Otherwise it just returns GV.
2961 llvm::GlobalVariable *
2962 AddInitializerToStaticVarDecl(const VarDecl &D,
2963 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002964
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002965
Anders Carlssonf40886a2009-08-08 21:45:14 +00002966 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2967 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002968 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2969 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002970
David Majnemerb3341ea2014-10-05 05:05:40 +00002971 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
2972 llvm::Constant *Addr);
2973
John McCallc84ed6a2012-05-01 06:13:13 +00002974 /// Call atexit() with a function that passes the given argument to
2975 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00002976 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2977 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002978
John McCallcdf7ef52010-11-06 09:44:32 +00002979 /// Emit code in this function to perform a guarded variable
2980 /// initialization. Guarded initializations are used when it's not
2981 /// possible to prove that an initialization will be done exactly
2982 /// once, e.g. with a static local variable or a static data member
2983 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002984 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002985 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002986
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002987 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2988 /// variables.
2989 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00002990 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00002991 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002992
John McCallee08c532012-04-06 18:21:03 +00002993 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002994 /// variables.
John McCallee08c532012-04-06 18:21:03 +00002995 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2996 const std::vector<std::pair<llvm::WeakVH,
2997 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002998
John McCalla738c252011-03-09 04:27:21 +00002999 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3000 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003001 llvm::GlobalVariable *Addr,
3002 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003003
John McCall7a626f62010-09-15 10:14:12 +00003004 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00003005
John McCall7f416cc2015-09-08 08:05:57 +00003006 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003007
John McCall08ef4662011-11-10 08:15:53 +00003008 void enterFullExpression(const ExprWithCleanups *E) {
3009 if (E->getNumObjects() == 0) return;
3010 enterNonTrivialFullExpression(E);
3011 }
3012 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003013
Richard Smithea852322013-05-07 21:53:22 +00003014 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003015
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003016 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3017
Tim Northovercc2a6e02015-11-09 19:56:35 +00003018 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003019
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003020 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003021 // Annotations Emission
3022 //===--------------------------------------------------------------------===//
3023
3024 /// Emit an annotation call (intrinsic or builtin).
3025 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3026 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003027 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003028 SourceLocation Location);
3029
3030 /// Emit local annotations for the local variable V, declared by D.
3031 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3032
3033 /// Emit field annotations for the given field & value. Returns the
3034 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003035 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003036
3037 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003038 // Internal Helpers
3039 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003040
Chris Lattner5b1964b2008-11-11 07:41:27 +00003041 /// ContainsLabel - Return true if the statement contains a label in it. If
3042 /// this statement is not executed normally, it not containing a label means
3043 /// that we can just remove the code.
3044 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003045
Chris Lattner29911cc2011-02-28 00:18:40 +00003046 /// containsBreak - Return true if the statement contains a break out of it.
3047 /// If the statement (recursively) contains a switch or loop with a break
3048 /// inside of it, this is fine.
3049 static bool containsBreak(const Stmt *S);
3050
Daniel Dunbar682712c2008-11-12 10:12:14 +00003051 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003052 /// to a constant, or if it does but contains a label, return false. If it
3053 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003054 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3055 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003056
Chris Lattner29911cc2011-02-28 00:18:40 +00003057 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3058 /// to a constant, or if it does but contains a label, return false. If it
3059 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003060 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3061 bool AllowLabels = false);
3062
Chris Lattnercd439292008-11-12 08:04:58 +00003063 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3064 /// if statement) to the specified blocks. Based on the condition, this might
3065 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003066 /// TrueCount should be the number of times we expect the condition to
3067 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003068 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003069 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003070
Richard Smithe30752c2012-10-09 19:52:38 +00003071 /// \brief Emit a description of a type in a format suitable for passing to
3072 /// a runtime sanitizer handler.
3073 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3074
3075 /// \brief Convert a value into a format suitable for passing to a runtime
3076 /// sanitizer handler.
3077 llvm::Value *EmitCheckValue(llvm::Value *V);
3078
3079 /// \brief Emit a description of a source location in a format suitable for
3080 /// passing to a runtime sanitizer handler.
3081 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3082
Richard Smithde670682012-11-01 22:15:34 +00003083 /// \brief Create a basic block that will call a handler function in a
3084 /// sanitizer runtime with the provided arguments, and create a conditional
3085 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003086 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003087 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
3088 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003089
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003090 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3091 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003092 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3093 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3094 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003095
Richard Smithde670682012-11-01 22:15:34 +00003096 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3097 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003098 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003099
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003100 /// \brief Emit a call to trap or debugtrap and attach function attribute
3101 /// "trap-func-name" if specified.
3102 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3103
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003104 /// \brief Emit a cross-DSO CFI failure handling function.
3105 void EmitCfiCheckFail();
3106
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003107 /// \brief Create a check for a function parameter that may potentially be
3108 /// declared as non-null.
3109 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
3110 const FunctionDecl *FD, unsigned ParmNum);
3111
Anders Carlsson093bdff2010-03-30 03:27:09 +00003112 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003113 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003114
John McCall23f66262010-05-26 22:34:26 +00003115 /// EmitDelegateCallArg - We are performing a delegate call; that
3116 /// is, the current function is delegating to another one. Produce
3117 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003118 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3119 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003120
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003121 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3122 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003123 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003124
Chris Lattnercd439292008-11-12 08:04:58 +00003125private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003126 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003127 void EmitReturnOfRValue(RValue RV, QualType Ty);
3128
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003129 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3130
3131 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3132 DeferredReplacements;
3133
John McCall7f416cc2015-09-08 08:05:57 +00003134 /// Set the address of a local variable.
3135 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3136 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3137 LocalDeclMap.insert({VD, Addr});
3138 }
3139
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003140 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3141 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3142 ///
3143 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003144 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003145 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003146
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003147 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3148 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3149 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3150 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3151 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3152 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003153
Chad Rosier59df25b2012-08-23 20:00:18 +00003154 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003155 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003156
Chad Rosier59df25b2012-08-23 20:00:18 +00003157 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003158 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003159 std::string &ConstraintStr,
3160 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003161
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003162 /// \brief Attempts to statically evaluate the object size of E. If that
3163 /// fails, emits code to figure the size of E out for us. This is
3164 /// pass_object_size aware.
3165 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
3166 llvm::IntegerType *ResType);
3167
3168 /// \brief Emits the size of E, as required by __builtin_object_size. This
3169 /// function is aware of pass_object_size parameters, and will act accordingly
3170 /// if E is a parameter with the pass_object_size attribute.
3171 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
3172 llvm::IntegerType *ResType);
3173
Reid Kleckner89077a12013-12-17 19:46:40 +00003174public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003175#ifndef NDEBUG
3176 // Determine whether the given argument is an Objective-C method
3177 // that may have type parameters in its signature.
3178 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3179 const DeclContext *dc = method->getDeclContext();
3180 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3181 return classDecl->getTypeParamListAsWritten();
3182 }
3183
3184 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3185 return catDecl->getTypeParamList();
3186 }
3187
3188 return false;
3189 }
3190
3191 template<typename T>
3192 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3193#endif
3194
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003195 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003196 template <typename T>
3197 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003198 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003199 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00003200 unsigned ParamsToSkip = 0) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003201 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003202 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003203
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003204 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3205 "Can't skip parameters if type info is not provided");
3206 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003207#ifndef NDEBUG
3208 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3209#endif
3210
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003211 // First, use the argument types that the type info knows about
3212 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3213 E = CallArgTypeInfo->param_type_end();
3214 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003215 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003216 assert((isGenericMethod ||
3217 ((*I)->isVariablyModifiedType() ||
3218 (*I).getNonReferenceType()->isObjCRetainableType() ||
3219 getContext()
3220 .getCanonicalType((*I).getNonReferenceType())
3221 .getTypePtr() ==
3222 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003223 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003224 .getTypePtr())) &&
3225 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003226 ArgTypes.push_back(*I);
3227 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003228 }
Mike Stump11289f42009-09-09 15:08:12 +00003229
Reid Kleckner739756c2013-12-04 19:23:12 +00003230 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003231 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003232 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3233 CallArgTypeInfo->isVariadic()) &&
3234 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003235
Anders Carlsson603d6af2009-04-18 20:20:22 +00003236 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003237 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
3238 ArgTypes.push_back(getVarArgType(A));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003239
David Blaikief05779e2015-07-21 18:37:18 +00003240 EmitCallArgs(Args, ArgTypes, ArgRange, CalleeDecl, ParamsToSkip);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003241 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003242
Reid Kleckner739756c2013-12-04 19:23:12 +00003243 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003244 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003245 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00003246 unsigned ParamsToSkip = 0);
Reid Kleckner739756c2013-12-04 19:23:12 +00003247
John McCall7f416cc2015-09-08 08:05:57 +00003248 /// EmitPointerWithAlignment - Given an expression with a pointer
3249 /// type, emit the value and compute our best estimate of the
3250 /// alignment of the pointee.
3251 ///
3252 /// Note that this function will conservatively fall back on the type
3253 /// when it doesn't
3254 ///
3255 /// \param Source - If non-null, this will be initialized with
3256 /// information about the source of the alignment. Note that this
3257 /// function will conservatively fall back on the type when it
3258 /// doesn't recognize the expression, which means that sometimes
3259 ///
3260 /// a worst-case One
3261 /// reasonable way to use this information is when there's a
3262 /// language guarantee that the pointer must be aligned to some
3263 /// stricter value, and we're simply trying to ensure that
3264 /// sufficiently obvious uses of under-aligned objects don't get
3265 /// miscompiled; for example, a placement new into the address of
3266 /// a local variable. In such a case, it's quite reasonable to
3267 /// just ignore the returned alignment when it isn't from an
3268 /// explicit source.
3269 Address EmitPointerWithAlignment(const Expr *Addr,
3270 AlignmentSource *Source = nullptr);
3271
Peter Collingbournedc134532016-01-16 00:31:22 +00003272 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3273
Reid Kleckner89077a12013-12-17 19:46:40 +00003274private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003275 QualType getVarArgType(const Expr *Arg);
3276
John McCalld4f4b7f2010-03-03 04:15:11 +00003277 const TargetCodeGenInfo &getTargetHooks() const {
3278 return CGM.getTargetCodeGenInfo();
3279 }
John McCall09ae0322010-07-06 23:57:41 +00003280
3281 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003282
John McCall7f416cc2015-09-08 08:05:57 +00003283 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3284 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003285
3286 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003287
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003288 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003289};
Mike Stump11289f42009-09-09 15:08:12 +00003290
John McCallce1de612011-01-26 04:00:11 +00003291/// Helper class with most of the code for saving a value for a
3292/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003293struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003294 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3295
3296 /// Answer whether the given value needs extra work to be saved.
3297 static bool needsSaving(llvm::Value *value) {
3298 // If it's not an instruction, we don't need to save.
3299 if (!isa<llvm::Instruction>(value)) return false;
3300
3301 // If it's an instruction in the entry block, we don't need to save.
3302 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3303 return (block != &block->getParent()->getEntryBlock());
3304 }
3305
3306 /// Try to save the given value.
3307 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3308 if (!needsSaving(value)) return saved_type(value, false);
3309
John McCall7f416cc2015-09-08 08:05:57 +00003310 // Otherwise, we need an alloca.
3311 auto align = CharUnits::fromQuantity(
3312 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3313 Address alloca =
3314 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003315 CGF.Builder.CreateStore(value, alloca);
3316
John McCall7f416cc2015-09-08 08:05:57 +00003317 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003318 }
3319
3320 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003321 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003322 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003323
3324 // Otherwise, it should be an alloca instruction, as set up in save().
3325 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3326 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003327 }
3328};
3329
John McCallcb5f77f2011-01-28 10:53:53 +00003330/// A partial specialization of DominatingValue for llvm::Values that
3331/// might be llvm::Instructions.
3332template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3333 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003334 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003335 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3336 }
3337};
3338
John McCall7f416cc2015-09-08 08:05:57 +00003339/// A specialization of DominatingValue for Address.
3340template <> struct DominatingValue<Address> {
3341 typedef Address type;
3342
3343 struct saved_type {
3344 DominatingLLVMValue::saved_type SavedValue;
3345 CharUnits Alignment;
3346 };
3347
3348 static bool needsSaving(type value) {
3349 return DominatingLLVMValue::needsSaving(value.getPointer());
3350 }
3351 static saved_type save(CodeGenFunction &CGF, type value) {
3352 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3353 value.getAlignment() };
3354 }
3355 static type restore(CodeGenFunction &CGF, saved_type value) {
3356 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3357 value.Alignment);
3358 }
3359};
3360
John McCallcb5f77f2011-01-28 10:53:53 +00003361/// A specialization of DominatingValue for RValue.
3362template <> struct DominatingValue<RValue> {
3363 typedef RValue type;
3364 class saved_type {
3365 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3366 AggregateAddress, ComplexAddress };
3367
3368 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003369 unsigned K : 3;
3370 unsigned Align : 29;
3371 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3372 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003373
3374 public:
3375 static bool needsSaving(RValue value);
3376 static saved_type save(CodeGenFunction &CGF, RValue value);
3377 RValue restore(CodeGenFunction &CGF);
3378
John McCall7f416cc2015-09-08 08:05:57 +00003379 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003380 };
3381
3382 static bool needsSaving(type value) {
3383 return saved_type::needsSaving(value);
3384 }
3385 static saved_type save(CodeGenFunction &CGF, type value) {
3386 return saved_type::save(CGF, value);
3387 }
3388 static type restore(CodeGenFunction &CGF, saved_type value) {
3389 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003390 }
3391};
3392
Chris Lattnerbed31442007-05-28 01:07:47 +00003393} // end namespace CodeGen
3394} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003395
Chris Lattnerbed31442007-05-28 01:07:47 +00003396#endif