blob: 9d46ff2647c3b2096d1fb291814e705299f25140 [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
Tim Shen421119f2016-07-01 21:08:47 +0000305 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
306 llvm::Value *Addr;
307 llvm::Value *Size;
308
309 public:
310 CallLifetimeEnd(Address addr, llvm::Value *size)
311 : Addr(addr.getPointer()), Size(size) {}
312
313 void Emit(CodeGenFunction &CGF, Flags flags) override {
314 CGF.EmitLifetimeEnd(Size, Addr);
315 }
316 };
317
Richard Smith736a9472013-06-12 20:42:33 +0000318 /// Header for data within LifetimeExtendedCleanupStack.
319 struct LifetimeExtendedCleanupHeader {
320 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000321 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000322 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000323 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000324
Justin Bognerbdff2192015-07-01 00:59:27 +0000325 size_t getSize() const { return Size; }
326 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000327 };
John McCallbd309292010-07-06 01:34:17 +0000328
John McCallad5d61e2010-07-23 21:56:41 +0000329 /// i32s containing the indexes of the cleanup destinations.
330 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000331
332 unsigned NextCleanupDestIndex;
333
John McCall08ef4662011-11-10 08:15:53 +0000334 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
335 CGBlockInfo *FirstBlockInfo;
336
John McCall8e4c74b2011-08-11 02:22:43 +0000337 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
338 llvm::BasicBlock *EHResumeBlock;
339
Bill Wendlingf0724e82011-09-19 20:31:14 +0000340 /// The exception slot. All landing pads write the current exception pointer
341 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000342 llvm::Value *ExceptionSlot;
343
Bill Wendlingf0724e82011-09-19 20:31:14 +0000344 /// The selector slot. Under the MandatoryCleanup model, all landing pads
345 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000346 llvm::AllocaInst *EHSelectorSlot;
347
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000348 /// A stack of exception code slots. Entering an __except block pushes a slot
349 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
350 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000351 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000352
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000353 /// Value returned by __exception_info intrinsic.
354 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000355
John McCallbd309292010-07-06 01:34:17 +0000356 /// Emits a landing pad for the current EH stack.
357 llvm::BasicBlock *EmitLandingPad();
358
359 llvm::BasicBlock *getInvokeDestImpl();
360
John McCallce1de612011-01-26 04:00:11 +0000361 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000362 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
363 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000364 }
365
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000366public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000367 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
368 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000369 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000370
John McCall6b0feb72011-06-22 02:32:12 +0000371 /// A class controlling the emission of a finally block.
372 class FinallyInfo {
373 /// Where the catchall's edge through the cleanup should go.
374 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000375
John McCall6b0feb72011-06-22 02:32:12 +0000376 /// A function to call to enter the catch.
377 llvm::Constant *BeginCatchFn;
378
379 /// An i1 variable indicating whether or not the @finally is
380 /// running for an exception.
381 llvm::AllocaInst *ForEHVar;
382
383 /// An i8* variable into which the exception pointer to rethrow
384 /// has been saved.
385 llvm::AllocaInst *SavedExnVar;
386
387 public:
388 void enter(CodeGenFunction &CGF, const Stmt *Finally,
389 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
390 llvm::Constant *rethrowFn);
391 void exit(CodeGenFunction &CGF);
392 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000393
Reid Kleckner11c033e2015-02-12 23:40:45 +0000394 /// Returns true inside SEH __try blocks.
395 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
396
Reid Klecknera002bd52015-10-28 23:06:42 +0000397 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000398 bool isCleanupPadScope() const {
399 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
400 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000401
John McCallce1de612011-01-26 04:00:11 +0000402 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
403 /// current full-expression. Safe against the possibility that
404 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000405 template <class T, class... As>
406 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000407 // If we're not in a conditional branch, or if none of the
408 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000409 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000410 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000411
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000412 // Stash values in a tuple so we can guarantee the order of saves.
413 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
414 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000415
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000416 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000417 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000418 initFullExprCleanup();
419 }
420
Richard Smith736a9472013-06-12 20:42:33 +0000421 /// \brief Queue a cleanup to be pushed after finishing the current
422 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000423 template <class T, class... As>
424 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000425 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
426
427 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
428
429 size_t OldSize = LifetimeExtendedCleanupStack.size();
430 LifetimeExtendedCleanupStack.resize(
431 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
432
Justin Bognerbdff2192015-07-01 00:59:27 +0000433 static_assert(sizeof(Header) % llvm::AlignOf<T>::Alignment == 0,
434 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000435 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
436 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000437 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000438 }
439
John McCallf4beacd2011-11-10 10:43:54 +0000440 /// Set up the last cleaup that was pushed as a conditional
441 /// full-expression cleanup.
442 void initFullExprCleanup();
443
John McCallbd309292010-07-06 01:34:17 +0000444 /// PushDestructorCleanup - Push a cleanup to call the
445 /// complete-object destructor of an object of the given type at the
446 /// given address. Does nothing if T is not a C++ class type with a
447 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000448 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000449
John McCall8680f872010-07-21 06:29:51 +0000450 /// PushDestructorCleanup - Push a cleanup to call the
451 /// complete-object variant of the given destructor on the object at
452 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000453 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000454
John McCallbd309292010-07-06 01:34:17 +0000455 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
456 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000457 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000458
John McCall824c2f52010-09-14 07:57:04 +0000459 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
460 /// The block cannot be reactivated. Pops it if it's the top of the
461 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000462 ///
463 /// \param DominatingIP - An instruction which is known to
464 /// dominate the current IP (if set) and which lies along
465 /// all paths of execution between the current IP and the
466 /// the point at which the cleanup comes into scope.
467 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
468 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000469
470 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
471 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000472 ///
473 /// \param DominatingIP - An instruction which is known to
474 /// dominate the current IP (if set) and which lies along
475 /// all paths of execution between the current IP and the
476 /// the point at which the cleanup comes into scope.
477 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
478 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000479
John McCallbd309292010-07-06 01:34:17 +0000480 /// \brief Enters a new scope for capturing cleanups, all of which
481 /// will be executed once the scope is exited.
482 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000483 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000484 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000485 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000486 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000487 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000488 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000489
Aaron Ballmanabc18922015-02-15 22:54:08 +0000490 RunCleanupsScope(const RunCleanupsScope &) = delete;
491 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000492
Eric Christophera9d34972011-10-19 00:43:52 +0000493 protected:
494 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000495
Douglas Gregor965f4502009-11-24 16:43:22 +0000496 public:
497 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000498 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000499 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000500 {
John McCallbd309292010-07-06 01:34:17 +0000501 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000502 LifetimeExtendedCleanupStackSize =
503 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000504 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000505 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000506 }
507
508 /// \brief Exit this cleanup scope, emitting any accumulated
509 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000510 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000511 if (PerformCleanup) {
512 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000513 CGF.PopCleanupBlocks(CleanupStackDepth,
514 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000515 }
516 }
517
518 /// \brief Determine whether this scope requires any cleanups.
519 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000520 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000521 }
522
523 /// \brief Force the emission of cleanups now, instead of waiting
524 /// until this object is destroyed.
525 void ForceCleanup() {
526 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000527 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000528 CGF.PopCleanupBlocks(CleanupStackDepth,
529 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000530 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000531 }
532 };
533
David Blaikie93be0b22014-08-22 21:37:04 +0000534 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000535 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000536 SmallVector<const LabelDecl*, 4> Labels;
537 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000538
Aaron Ballmanabc18922015-02-15 22:54:08 +0000539 LexicalScope(const LexicalScope &) = delete;
540 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000541
542 public:
543 /// \brief Enter a new cleanup scope.
544 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000545 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
546 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000547 if (CGDebugInfo *DI = CGF.getDebugInfo())
548 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
549 }
550
Nadav Rotem1da30942013-03-23 06:43:35 +0000551 void addLabel(const LabelDecl *label) {
552 assert(PerformCleanup && "adding label to dead scope?");
553 Labels.push_back(label);
554 }
555
Eric Christophera9d34972011-10-19 00:43:52 +0000556 /// \brief Exit this cleanup scope, emitting any accumulated
557 /// cleanups.
558 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000559 if (CGDebugInfo *DI = CGF.getDebugInfo())
560 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
561
Nadav Rotem1da30942013-03-23 06:43:35 +0000562 // If we should perform a cleanup, force them now. Note that
563 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000564 if (PerformCleanup) {
565 ApplyDebugLocation DL(CGF, Range.getEnd());
566 ForceCleanup();
567 }
Eric Christophera9d34972011-10-19 00:43:52 +0000568 }
569
570 /// \brief Force the emission of cleanups now, instead of waiting
571 /// until this object is destroyed.
572 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000573 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000574 RunCleanupsScope::ForceCleanup();
575
Nadav Rotem1da30942013-03-23 06:43:35 +0000576 if (!Labels.empty())
577 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000578 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000579
580 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000581 };
582
John McCall7f416cc2015-09-08 08:05:57 +0000583 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
584
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000585 /// \brief The scope used to remap some variables as private in the OpenMP
586 /// loop body (or other captured region emitted without outlining), and to
587 /// restore old vars back on exit.
588 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000589 DeclMapTy SavedLocals;
590 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000591
592 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000593 OMPPrivateScope(const OMPPrivateScope &) = delete;
594 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000595
596 public:
597 /// \brief Enter a new OpenMP private scope.
598 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
599
600 /// \brief Registers \a LocalVD variable as a private and apply \a
601 /// PrivateGen function for it to generate corresponding private variable.
602 /// \a PrivateGen returns an address of the generated private variable.
603 /// \return true if the variable is registered as private, false if it has
604 /// been privatized already.
605 bool
606 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000607 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000608 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000609
610 // Only save it once.
611 if (SavedLocals.count(LocalVD)) return false;
612
613 // Copy the existing local entry to SavedLocals.
614 auto it = CGF.LocalDeclMap.find(LocalVD);
615 if (it != CGF.LocalDeclMap.end()) {
616 SavedLocals.insert({LocalVD, it->second});
617 } else {
618 SavedLocals.insert({LocalVD, Address::invalid()});
619 }
620
621 // Generate the private entry.
622 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000623 QualType VarTy = LocalVD->getType();
624 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000625 Address Temp = CGF.CreateMemTemp(VarTy);
626 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
627 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000628 }
John McCall7f416cc2015-09-08 08:05:57 +0000629 SavedPrivates.insert({LocalVD, Addr});
630
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000631 return true;
632 }
633
634 /// \brief Privatizes local variables previously registered as private.
635 /// Registration is separate from the actual privatization to allow
636 /// initializers use values of the original variables, not the private one.
637 /// This is important, for example, if the private variable is a class
638 /// variable initialized by a constructor that references other private
639 /// variables. But at initialization original variables must be used, not
640 /// private copies.
641 /// \return true if at least one variable was privatized, false otherwise.
642 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000643 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000644 SavedPrivates.clear();
645 return !SavedLocals.empty();
646 }
647
648 void ForceCleanup() {
649 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000650 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000651 SavedLocals.clear();
652 }
653
654 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000655 ~OMPPrivateScope() {
656 if (PerformCleanup)
657 ForceCleanup();
658 }
John McCall7f416cc2015-09-08 08:05:57 +0000659
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000660 /// Checks if the global variable is captured in current function.
661 bool isGlobalVarCaptured(const VarDecl *VD) const {
662 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
663 }
664
John McCall7f416cc2015-09-08 08:05:57 +0000665 private:
666 /// Copy all the entries in the source map over the corresponding
667 /// entries in the destination, which must exist.
668 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
669 for (auto &pair : src) {
670 if (!pair.second.isValid()) {
671 dest.erase(pair.first);
672 continue;
673 }
674
675 auto it = dest.find(pair.first);
676 if (it != dest.end()) {
677 it->second = pair.second;
678 } else {
679 dest.insert(pair);
680 }
681 }
682 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000683 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000684
Richard Smith736a9472013-06-12 20:42:33 +0000685 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
686 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000687 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000688
Richard Smith736a9472013-06-12 20:42:33 +0000689 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
690 /// that have been added, then adds all lifetime-extended cleanups from
691 /// the given position to the stack.
692 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
693 size_t OldLifetimeExtendedStackSize);
694
John McCallad5d61e2010-07-23 21:56:41 +0000695 void ResolveBranchFixups(llvm::BasicBlock *Target);
696
John McCallbd309292010-07-06 01:34:17 +0000697 /// The given basic block lies in the current EH scope, but may be a
698 /// target of a potentially scope-crossing jump; get a stable handle
699 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000700 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000701 return JumpDest(Target,
702 EHStack.getInnermostNormalCleanup(),
703 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000704 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000705
John McCallbd309292010-07-06 01:34:17 +0000706 /// The given basic block lies in the current EH scope, but may be a
707 /// target of a potentially scope-crossing jump; get a stable handle
708 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000709 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000710 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000711 }
712
713 /// EmitBranchThroughCleanup - Emit a branch from the current insert
714 /// block through the normal cleanup handling code (if any) and then
715 /// on to \arg Dest.
716 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000717
Justin Bognere25ffdf2014-01-21 00:35:11 +0000718 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
719 /// specified destination obviously has no cleanups to run. 'false' is always
720 /// a conservatively correct answer for this method.
721 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
722
John McCall8e4c74b2011-08-11 02:22:43 +0000723 /// popCatchScope - Pops the catch scope at the top of the EHScope
724 /// stack, emitting any required code (other than the catch handlers
725 /// themselves).
726 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000727
David Chisnall9a837be2012-11-07 16:50:40 +0000728 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000729 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000730 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000731
John McCallce1de612011-01-26 04:00:11 +0000732 /// An object to manage conditionally-evaluated expressions.
733 class ConditionalEvaluation {
734 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000735
John McCallce1de612011-01-26 04:00:11 +0000736 public:
737 ConditionalEvaluation(CodeGenFunction &CGF)
738 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000739
John McCallce1de612011-01-26 04:00:11 +0000740 void begin(CodeGenFunction &CGF) {
741 assert(CGF.OutermostConditional != this);
742 if (!CGF.OutermostConditional)
743 CGF.OutermostConditional = this;
744 }
745
746 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000747 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000748 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000749 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000750 }
751
752 /// Returns a block which will be executed prior to each
753 /// evaluation of the conditional code.
754 llvm::BasicBlock *getStartingBlock() const {
755 return StartBB;
756 }
757 };
Mike Stump11289f42009-09-09 15:08:12 +0000758
John McCall7f9c92a2010-09-17 00:50:28 +0000759 /// isInConditionalBranch - Return true if we're currently emitting
760 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000761 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000762
John McCall7f416cc2015-09-08 08:05:57 +0000763 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000764 assert(isInConditionalBranch());
765 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000766 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
767 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000768 }
769
John McCallce1de612011-01-26 04:00:11 +0000770 /// An RAII object to record that we're evaluating a statement
771 /// expression.
772 class StmtExprEvaluation {
773 CodeGenFunction &CGF;
774
775 /// We have to save the outermost conditional: cleanups in a
776 /// statement expression aren't conditional just because the
777 /// StmtExpr is.
778 ConditionalEvaluation *SavedOutermostConditional;
779
780 public:
781 StmtExprEvaluation(CodeGenFunction &CGF)
782 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000783 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000784 }
785
786 ~StmtExprEvaluation() {
787 CGF.OutermostConditional = SavedOutermostConditional;
788 CGF.EnsureInsertPoint();
789 }
790 };
John McCall1bf58462011-02-16 08:02:54 +0000791
John McCallc07a0c72011-02-17 10:25:35 +0000792 /// An object which temporarily prevents a value from being
793 /// destroyed by aggressive peephole optimizations that assume that
794 /// all uses of a value have been realized in the IR.
795 class PeepholeProtection {
796 llvm::Instruction *Inst;
797 friend class CodeGenFunction;
798
799 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000800 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000801 };
John McCallc07a0c72011-02-17 10:25:35 +0000802
John McCallfe96e0b2011-11-06 09:01:30 +0000803 /// A non-RAII class containing all the information about a bound
804 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
805 /// this which makes individual mappings very simple; using this
806 /// class directly is useful when you have a variable number of
807 /// opaque values or don't want the RAII functionality for some
808 /// reason.
809 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000810 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000811 bool BoundLValue;
812 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000813
John McCallfe96e0b2011-11-06 09:01:30 +0000814 OpaqueValueMappingData(const OpaqueValueExpr *ov,
815 bool boundLValue)
816 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000817 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000818 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000819
John McCallc07a0c72011-02-17 10:25:35 +0000820 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000821 // gl-values should be bound as l-values for obvious reasons.
822 // Records should be bound as l-values because IR generation
823 // always keeps them in memory. Expressions of function type
824 // act exactly like l-values but are formally required to be
825 // r-values in C.
826 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000827 expr->getType()->isFunctionType() ||
828 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000829 }
830
John McCallfe96e0b2011-11-06 09:01:30 +0000831 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
832 const OpaqueValueExpr *ov,
833 const Expr *e) {
834 if (shouldBindAsLValue(ov))
835 return bind(CGF, ov, CGF.EmitLValue(e));
836 return bind(CGF, ov, CGF.EmitAnyExpr(e));
837 }
838
839 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
840 const OpaqueValueExpr *ov,
841 const LValue &lv) {
842 assert(shouldBindAsLValue(ov));
843 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
844 return OpaqueValueMappingData(ov, true);
845 }
846
847 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
848 const OpaqueValueExpr *ov,
849 const RValue &rv) {
850 assert(!shouldBindAsLValue(ov));
851 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
852
853 OpaqueValueMappingData data(ov, false);
854
855 // Work around an extremely aggressive peephole optimization in
856 // EmitScalarConversion which assumes that all other uses of a
857 // value are extant.
858 data.Protection = CGF.protectFromPeepholes(rv);
859
860 return data;
861 }
862
Craig Topper8a13c412014-05-21 05:09:00 +0000863 bool isValid() const { return OpaqueValue != nullptr; }
864 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000865
866 void unbind(CodeGenFunction &CGF) {
867 assert(OpaqueValue && "no data to unbind!");
868
869 if (BoundLValue) {
870 CGF.OpaqueLValues.erase(OpaqueValue);
871 } else {
872 CGF.OpaqueRValues.erase(OpaqueValue);
873 CGF.unprotectFromPeepholes(Protection);
874 }
875 }
876 };
877
878 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
879 class OpaqueValueMapping {
880 CodeGenFunction &CGF;
881 OpaqueValueMappingData Data;
882
883 public:
884 static bool shouldBindAsLValue(const Expr *expr) {
885 return OpaqueValueMappingData::shouldBindAsLValue(expr);
886 }
887
John McCallc07a0c72011-02-17 10:25:35 +0000888 /// Build the opaque value mapping for the given conditional
889 /// operator if it's the GNU ?: extension. This is a common
890 /// enough pattern that the convenience operator is really
891 /// helpful.
892 ///
893 OpaqueValueMapping(CodeGenFunction &CGF,
894 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000895 if (isa<ConditionalOperator>(op))
896 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000897 return;
John McCallc07a0c72011-02-17 10:25:35 +0000898
899 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000900 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
901 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000902 }
903
John McCall1bf58462011-02-16 08:02:54 +0000904 OpaqueValueMapping(CodeGenFunction &CGF,
905 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000906 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000907 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000908 }
909
910 OpaqueValueMapping(CodeGenFunction &CGF,
911 const OpaqueValueExpr *opaqueValue,
912 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000913 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000914 }
915
916 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000917 Data.unbind(CGF);
918 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000919 }
920
921 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000922 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000923 }
924 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000925
Chris Lattner2da04b32007-08-24 05:35:26 +0000926private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000927 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000928 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000929
John McCall9b382dd2011-05-28 21:13:02 +0000930 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
931 /// calling llvm.stacksave for multiple VLAs in the same scope.
932 bool DidCallStackSave;
933
Mike Stumpe5311b02009-11-30 20:08:49 +0000934 /// IndirectBranch - The first time an indirect goto is seen we create a block
935 /// with an indirect branch. Every time we see the address of a label taken,
936 /// we add the label to the indirect goto. Every subsequent indirect goto is
937 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000938 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000939
Mike Stumpfc496822009-02-08 23:14:22 +0000940 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
941 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000942 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000943
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000944 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
945 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
946 /// parameter.
947 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
948 SizeArguments;
949
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000950 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000951 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000952 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
953
Chris Lattnerac248202007-05-30 00:13:02 +0000954 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000955 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000956
Mike Stumpfc496822009-02-08 23:14:22 +0000957 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000958 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000959 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000960 BreakContinue(JumpDest Break, JumpDest Continue)
961 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000962
John McCallbd309292010-07-06 01:34:17 +0000963 JumpDest BreakBlock;
964 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000965 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000966 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000967
Justin Bogneref512b92014-01-06 22:27:43 +0000968 CodeGenPGO PGO;
969
Justin Bogner65512642015-05-02 05:00:55 +0000970 /// Calculate branch weights appropriate for PGO data
971 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
972 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
973 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
974 uint64_t LoopCount);
975
Justin Bogneref512b92014-01-06 22:27:43 +0000976public:
Justin Bogner66242d62015-04-23 23:06:47 +0000977 /// Increment the profiler's counter for the given statement.
978 void incrementProfileCounter(const Stmt *S) {
Rong Xu9837ef52016-02-04 18:39:09 +0000979 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Justin Bogner66242d62015-04-23 23:06:47 +0000980 PGO.emitCounterIncrement(Builder, S);
981 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +0000982 }
Justin Bogner66242d62015-04-23 23:06:47 +0000983
984 /// Get the profiler's count for the given statement.
985 uint64_t getProfileCount(const Stmt *S) {
986 Optional<uint64_t> Count = PGO.getStmtCount(S);
987 if (!Count.hasValue())
988 return 0;
989 return *Count;
990 }
991
992 /// Set the profiler's current count.
993 void setCurrentProfileCount(uint64_t Count) {
994 PGO.setCurrentRegionCount(Count);
995 }
996
997 /// Get the profiler's current count. This is generally the count for the most
998 /// recently incremented counter.
999 uint64_t getCurrentProfileCount() {
1000 return PGO.getCurrentRegionCount();
1001 }
1002
Justin Bogneref512b92014-01-06 22:27:43 +00001003private:
1004
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001005 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001006 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001007 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001008 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1009 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001010
Mike Stumpfc496822009-02-08 23:14:22 +00001011 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001012 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001013 llvm::BasicBlock *CaseRangeBlock;
1014
John McCallc07a0c72011-02-17 10:25:35 +00001015 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001016 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001017 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1018 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001019
Mike Stumpfc496822009-02-08 23:14:22 +00001020 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001021 // We track this by the size expression rather than the type itself because
1022 // in certain situations, like a const qualifier applied to an VLA typedef,
1023 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001024 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1025 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001026 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001027
John McCallbd309292010-07-06 01:34:17 +00001028 /// A block containing a single 'unreachable' instruction. Created
1029 /// lazily by getUnreachableBlock().
1030 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001031
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001032 /// Counts of the number return expressions in the function.
1033 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001034
1035 /// Count the number of simple (constant) return expressions in the function.
1036 unsigned NumSimpleReturnExprs;
1037
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001038 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001039 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001040
Richard Smith852c9db2013-04-20 22:23:05 +00001041public:
1042 /// A scope within which we are constructing the fields of an object which
1043 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1044 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1045 class FieldConstructionScope {
1046 public:
John McCall7f416cc2015-09-08 08:05:57 +00001047 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001048 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1049 CGF.CXXDefaultInitExprThis = This;
1050 }
1051 ~FieldConstructionScope() {
1052 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1053 }
1054
1055 private:
1056 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001057 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001058 };
1059
1060 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1061 /// is overridden to be the object under construction.
1062 class CXXDefaultInitExprScope {
1063 public:
1064 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001065 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1066 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1067 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1068 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001069 }
1070 ~CXXDefaultInitExprScope() {
1071 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001072 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001073 }
1074
1075 public:
1076 CodeGenFunction &CGF;
1077 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001078 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001079 };
1080
Richard Smith5179eb72016-06-28 19:03:57 +00001081 class InlinedInheritingConstructorScope {
1082 public:
1083 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1084 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1085 OldCurCodeDecl(CGF.CurCodeDecl),
1086 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1087 OldCXXABIThisValue(CGF.CXXABIThisValue),
1088 OldCXXThisValue(CGF.CXXThisValue),
1089 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1090 OldCXXThisAlignment(CGF.CXXThisAlignment),
1091 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1092 OldCXXInheritedCtorInitExprArgs(
1093 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1094 CGF.CurGD = GD;
1095 CGF.CurFuncDecl = CGF.CurCodeDecl =
1096 cast<CXXConstructorDecl>(GD.getDecl());
1097 CGF.CXXABIThisDecl = nullptr;
1098 CGF.CXXABIThisValue = nullptr;
1099 CGF.CXXThisValue = nullptr;
1100 CGF.CXXABIThisAlignment = CharUnits();
1101 CGF.CXXThisAlignment = CharUnits();
1102 CGF.ReturnValue = Address::invalid();
1103 CGF.FnRetTy = QualType();
1104 CGF.CXXInheritedCtorInitExprArgs.clear();
1105 }
1106 ~InlinedInheritingConstructorScope() {
1107 CGF.CurGD = OldCurGD;
1108 CGF.CurFuncDecl = OldCurFuncDecl;
1109 CGF.CurCodeDecl = OldCurCodeDecl;
1110 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1111 CGF.CXXABIThisValue = OldCXXABIThisValue;
1112 CGF.CXXThisValue = OldCXXThisValue;
1113 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1114 CGF.CXXThisAlignment = OldCXXThisAlignment;
1115 CGF.ReturnValue = OldReturnValue;
1116 CGF.FnRetTy = OldFnRetTy;
1117 CGF.CXXInheritedCtorInitExprArgs =
1118 std::move(OldCXXInheritedCtorInitExprArgs);
1119 }
1120
1121 private:
1122 CodeGenFunction &CGF;
1123 GlobalDecl OldCurGD;
1124 const Decl *OldCurFuncDecl;
1125 const Decl *OldCurCodeDecl;
1126 ImplicitParamDecl *OldCXXABIThisDecl;
1127 llvm::Value *OldCXXABIThisValue;
1128 llvm::Value *OldCXXThisValue;
1129 CharUnits OldCXXABIThisAlignment;
1130 CharUnits OldCXXThisAlignment;
1131 Address OldReturnValue;
1132 QualType OldFnRetTy;
1133 CallArgList OldCXXInheritedCtorInitExprArgs;
1134 };
1135
Richard Smith852c9db2013-04-20 22:23:05 +00001136private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001137 /// CXXThisDecl - When generating code for a C++ member function,
1138 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001139 ImplicitParamDecl *CXXABIThisDecl;
1140 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001141 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001142 CharUnits CXXABIThisAlignment;
1143 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001144
Richard Smith852c9db2013-04-20 22:23:05 +00001145 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1146 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001147 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001148
Richard Smith5179eb72016-06-28 19:03:57 +00001149 /// The values of function arguments to use when evaluating
1150 /// CXXInheritedCtorInitExprs within this context.
1151 CallArgList CXXInheritedCtorInitExprArgs;
1152
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001153 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1154 /// destructor, this will hold the implicit argument (e.g. VTT).
1155 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1156 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001157
John McCallce1de612011-01-26 04:00:11 +00001158 /// OutermostConditional - Points to the outermost active
1159 /// conditional control. This is used so that we know if a
1160 /// temporary should be destroyed conditionally.
1161 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001162
Nadav Rotem1da30942013-03-23 06:43:35 +00001163 /// The current lexical scope.
1164 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001165
Adrian Prantldc237b52013-05-16 00:41:26 +00001166 /// The current source location that should be used for exception
1167 /// handling code.
1168 SourceLocation CurEHLocation;
1169
John McCall7f416cc2015-09-08 08:05:57 +00001170 /// BlockByrefInfos - For each __block variable, contains
1171 /// information about the layout of the variable.
1172 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001173
John McCallbd309292010-07-06 01:34:17 +00001174 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001175 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001176 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001177
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001178 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1179 /// In the kernel metadata node, reference the kernel function and metadata
1180 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001181 /// - A node for the vec_type_hint(<type>) qualifier contains string
1182 /// "vec_type_hint", an undefined value of the <type> data type,
1183 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001184 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1185 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1186 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1187 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1188 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1189 llvm::Function *Fn);
1190
Chris Lattnerbed31442007-05-28 01:07:47 +00001191public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001192 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001193 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001194
John McCall8ed55a52010-09-02 09:58:18 +00001195 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001196 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001197 CGDebugInfo *getDebugInfo() {
1198 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001199 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001200 return DebugInfo;
1201 }
1202 void disableDebugInfo() { DisableDebugInfo = true; }
1203 void enableDebugInfo() { DisableDebugInfo = false; }
1204
John McCall31168b02011-06-15 23:02:42 +00001205 bool shouldUseFusedARCCalls() {
1206 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1207 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001208
David Blaikiebbafb8a2012-03-11 07:00:24 +00001209 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001210
Bill Wendlingf0724e82011-09-19 20:31:14 +00001211 /// Returns a pointer to the function's exception object and selector slot,
1212 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001213 Address getExceptionSlot();
1214 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001215
Bill Wendling79a70e42011-09-15 18:57:19 +00001216 /// Returns the contents of the function's exception object and selector
1217 /// slots.
1218 llvm::Value *getExceptionFromSlot();
1219 llvm::Value *getSelectorFromSlot();
1220
John McCall7f416cc2015-09-08 08:05:57 +00001221 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001222
John McCallbd309292010-07-06 01:34:17 +00001223 llvm::BasicBlock *getUnreachableBlock() {
1224 if (!UnreachableBlock) {
1225 UnreachableBlock = createBasicBlock("unreachable");
1226 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1227 }
1228 return UnreachableBlock;
1229 }
1230
1231 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001232 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001233 return getInvokeDestImpl();
1234 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001235
David Majnemer25eb1652016-03-01 19:42:53 +00001236 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001237
John McCallc8e01702013-04-16 22:48:15 +00001238 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001239 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001240
Daniel Dunbar12347492009-02-23 17:26:39 +00001241 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001242 // Cleanups
1243 //===--------------------------------------------------------------------===//
1244
John McCall7f416cc2015-09-08 08:05:57 +00001245 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001246
John McCall178360e2011-07-11 08:38:19 +00001247 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001248 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001249 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001250 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001251 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001252 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1253 llvm::Value *arrayEnd,
1254 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001255 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001256 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001257
John McCall4bd0fb12011-07-12 16:41:08 +00001258 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001259 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001260 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001261 Address addr, QualType type);
1262 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001263 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001264 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001265 QualType type, Destroyer *destroyer,
1266 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001267 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1268 llvm::Value *CompletePtr,
1269 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001270 void pushStackRestore(CleanupKind kind, Address SPMem);
1271 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001272 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001273 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001274 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001275 bool useEHCleanupForArray,
1276 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001277 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001278 QualType elementType, CharUnits elementAlign,
1279 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001280 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001281
Peter Collingbourne1425b452012-01-26 03:33:36 +00001282 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001283
John McCall82fe67b2011-07-09 01:37:26 +00001284 /// Determines whether an EH cleanup is required to destroy a type
1285 /// with the given destruction kind.
1286 bool needsEHCleanup(QualType::DestructionKind kind) {
1287 switch (kind) {
1288 case QualType::DK_none:
1289 return false;
1290 case QualType::DK_cxx_destructor:
1291 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001292 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001293 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001294 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001295 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1296 }
1297 llvm_unreachable("bad destruction kind");
1298 }
1299
John McCall4bd0fb12011-07-12 16:41:08 +00001300 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1301 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1302 }
1303
John McCall82fe67b2011-07-09 01:37:26 +00001304 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001305 // Objective-C
1306 //===--------------------------------------------------------------------===//
1307
Chris Lattner4bd55962008-03-30 23:03:07 +00001308 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001309
David Blaikief1425802015-01-14 00:04:42 +00001310 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001311
Mike Stumpfc496822009-02-08 23:14:22 +00001312 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001313 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1314 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001315 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001316 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001317 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001318 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001319
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001320 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1321 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001322
Mike Stumpfc496822009-02-08 23:14:22 +00001323 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1324 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001325 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1326 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001327 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001328 const ObjCPropertyImplDecl *propImpl,
1329 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001330
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001331 //===--------------------------------------------------------------------===//
1332 // Block Bits
1333 //===--------------------------------------------------------------------===//
1334
John McCall351762c2011-02-07 10:33:21 +00001335 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001336 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1337 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001338
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001339 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001340 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001341 const DeclMapTy &ldm,
1342 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001343
John McCallad7c5c12011-02-08 08:22:06 +00001344 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1345 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001346 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1347 const ObjCPropertyImplDecl *PID);
1348 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1349 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001350 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001351
John McCallad7c5c12011-02-08 08:22:06 +00001352 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1353
John McCall73064872011-03-31 01:59:53 +00001354 class AutoVarEmission;
1355
1356 void emitByrefStructureInit(const AutoVarEmission &emission);
1357 void enterByrefCleanup(const AutoVarEmission &emission);
1358
John McCall7f416cc2015-09-08 08:05:57 +00001359 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1360 llvm::Value *ptr);
1361
1362 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001363 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1364
1365 /// BuildBlockByrefAddress - Computes the location of the
1366 /// data in a variable which is declared as __block.
1367 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1368 bool followForward = true);
1369 Address emitBlockByrefAddress(Address baseAddr,
1370 const BlockByrefInfo &info,
1371 bool followForward,
1372 const llvm::Twine &name);
1373
1374 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001375
Richard Smith5179eb72016-06-28 19:03:57 +00001376 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1377
John McCalla738c252011-03-09 04:27:21 +00001378 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1379 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001380 /// \brief Emit code for the start of a function.
1381 /// \param Loc The location to be associated with the function.
1382 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001383 void StartFunction(GlobalDecl GD,
1384 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001385 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001386 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001387 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001388 SourceLocation Loc = SourceLocation(),
1389 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001390
John McCallb81884d2010-02-19 09:25:03 +00001391 void EmitConstructorBody(FunctionArgList &Args);
1392 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001393 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001394 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001395 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001396
Faisal Vali571df122013-09-29 08:45:24 +00001397 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001398 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001399 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001400 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001401 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1402 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001403 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001404
David Blaikiea0a1a872015-01-18 02:48:07 +00001405 /// \brief Emit the unified return block, trying to avoid its emission when
1406 /// possible.
1407 /// \return The debug location of the user written return statement if the
1408 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001409 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001410
Mike Stumpfc496822009-02-08 23:14:22 +00001411 /// FinishFunction - Complete IR generation of the current function. It is
1412 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001413 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001414
Nico Weber1bebad12015-02-11 22:33:32 +00001415 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1416 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001417
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001418 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001419
John McCall7f416cc2015-09-08 08:05:57 +00001420 void FinishThunk();
1421
Reid Klecknerab2090d2014-07-26 01:34:32 +00001422 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1423 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1424 llvm::Value *Callee);
1425
Rafael Espindolad6e66942015-07-13 06:07:58 +00001426 /// Generate a thunk for the given method.
1427 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001428 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001429
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001430 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1431 const CGFunctionInfo &FnInfo,
1432 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001433
Douglas Gregor94f9a482010-05-05 05:51:00 +00001434 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1435 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001436
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001437 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001438 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001439
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001440 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1441 struct VPtr {
1442 BaseSubobject Base;
1443 const CXXRecordDecl *NearestVBase;
1444 CharUnits OffsetFromNearestVBase;
1445 const CXXRecordDecl *VTableClass;
1446 };
1447
1448 /// Initialize the vtable pointer of the given subobject.
1449 void InitializeVTablePointer(const VPtr &vptr);
1450
1451 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001452
1453 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001454 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1455
1456 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1457 CharUnits OffsetFromNearestVBase,
1458 bool BaseIsNonVirtualPrimaryBase,
1459 const CXXRecordDecl *VTableClass,
1460 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001461
Anders Carlssond5895932010-03-28 21:07:49 +00001462 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001463
Dan Gohman8fc50c22010-10-26 18:44:08 +00001464 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1465 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001466 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1467 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001468
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001469 enum CFITypeCheckKind {
1470 CFITCK_VCall,
1471 CFITCK_NVCall,
1472 CFITCK_DerivedCast,
1473 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001474 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001475 };
1476
Peter Collingbourned2926c92015-03-14 02:42:25 +00001477 /// \brief Derived is the presumed address of an object of type T after a
1478 /// cast. If T is a polymorphic class type, emit a check that the virtual
1479 /// table for Derived belongs to a class derived from T.
1480 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001481 bool MayBeNull, CFITypeCheckKind TCK,
1482 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001483
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001484 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1485 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001486 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001487 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001488
Peter Collingbourned2926c92015-03-14 02:42:25 +00001489 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001490 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001491 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1492 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001493
Peter Collingbournefb532b92016-02-24 20:46:36 +00001494 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001495 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1496 /// enabled, emit a check that VTable is a member of RD's type identifier.
1497 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1498 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001499
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001500 /// Returns whether we should perform a type checked load when loading a
1501 /// virtual function for virtual calls to members of RD. This is generally
1502 /// true when both vcall CFI and whole-program-vtables are enabled.
1503 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1504
1505 /// Emit a type checked load from the given vtable.
1506 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1507 uint64_t VTableByteOffset);
1508
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001509 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1510 /// expr can be devirtualized.
1511 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1512 const CXXMethodDecl *MD);
1513
John McCallf99a6312010-07-21 05:30:47 +00001514 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1515 /// given phase of destruction for a destructor. The end result
1516 /// should call destructors on members and base classes in reverse
1517 /// order of their construction.
1518 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001519
Chris Lattner3c77a352010-06-22 00:03:40 +00001520 /// ShouldInstrumentFunction - Return true if the current function should be
1521 /// instrumented with __cyg_profile_func_* calls
1522 bool ShouldInstrumentFunction();
1523
1524 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1525 /// instrumentation function with the current function and the call site, if
1526 /// function instrumentation is enabled.
1527 void EmitFunctionInstrumentation(const char *Fn);
1528
Roman Divacky178e01602011-02-10 16:52:03 +00001529 /// EmitMCountInstrumentation - Emit call to .mcount.
1530 void EmitMCountInstrumentation();
1531
Mike Stumpfc496822009-02-08 23:14:22 +00001532 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1533 /// arguments for the given function. This is also responsible for naming the
1534 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001535 void EmitFunctionProlog(const CGFunctionInfo &FI,
1536 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001537 const FunctionArgList &Args);
1538
Mike Stumpfc496822009-02-08 23:14:22 +00001539 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1540 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001541 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1542 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001543
Mike Stump1d849212009-12-07 23:38:24 +00001544 /// EmitStartEHSpec - Emit the start of the exception spec.
1545 void EmitStartEHSpec(const Decl *D);
1546
1547 /// EmitEndEHSpec - Emit the end of the exception spec.
1548 void EmitEndEHSpec(const Decl *D);
1549
John McCallbd309292010-07-06 01:34:17 +00001550 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1551 llvm::BasicBlock *getTerminateLandingPad();
1552
1553 /// getTerminateHandler - Return a handler (not a landing pad, just
1554 /// a catch handler) that just calls terminate. This is used when
1555 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001556 llvm::BasicBlock *getTerminateHandler();
1557
Chris Lattnera5f58b02011-07-09 17:41:47 +00001558 llvm::Type *ConvertTypeForMem(QualType T);
1559 llvm::Type *ConvertType(QualType T);
1560 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001561 return ConvertType(getContext().getTypeDeclType(T));
1562 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001563
Mike Stumpfc496822009-02-08 23:14:22 +00001564 /// LoadObjCSelf - Load the value of self. This function is only valid while
1565 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001566 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001567
1568 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001569 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001570
Chris Lattner54fb19e2007-06-22 22:02:34 +00001571 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1572 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001573 static TypeEvaluationKind getEvaluationKind(QualType T);
1574
1575 static bool hasScalarEvaluationKind(QualType T) {
1576 return getEvaluationKind(T) == TEK_Scalar;
1577 }
1578
1579 static bool hasAggregateEvaluationKind(QualType T) {
1580 return getEvaluationKind(T) == TEK_Aggregate;
1581 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001582
1583 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001584 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001585 llvm::Function *parent = nullptr,
1586 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001587#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001588 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001589#else
John McCallad7c5c12011-02-08 08:22:06 +00001590 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001591#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001592 }
Mike Stumpfc496822009-02-08 23:14:22 +00001593
Chris Lattnerac248202007-05-30 00:13:02 +00001594 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1595 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001596 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001597
Mike Stumpe5311b02009-11-30 20:08:49 +00001598 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1599 /// another basic block, simplify it. This assumes that no other code could
1600 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001601 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1602
Mike Stumpfc496822009-02-08 23:14:22 +00001603 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1604 /// adding a fall-through branch from the current insert block if
1605 /// necessary. It is legal to call this function even if there is no current
1606 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001607 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001608 /// IsFinished - If true, indicates that the caller has finished emitting
1609 /// branches to the given block and does not expect to emit code into it. This
1610 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001611 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001612
John McCall8e4c74b2011-08-11 02:22:43 +00001613 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1614 /// near its uses, and leave the insertion point in it.
1615 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1616
Mike Stumpfc496822009-02-08 23:14:22 +00001617 /// EmitBranch - Emit a branch to the specified basic block from the current
1618 /// insert block, taking care to avoid creation of branches from dummy
1619 /// blocks. It is legal to call this function even if there is no current
1620 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001621 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001622 /// This function clears the current insertion point. The caller should follow
1623 /// calls to this function with calls to Emit*Block prior to generation new
1624 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001625 void EmitBranch(llvm::BasicBlock *Block);
1626
Mike Stumpfc496822009-02-08 23:14:22 +00001627 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1628 /// indicates that the current code being emitted is unreachable.
1629 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001630 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001631 }
1632
Mike Stumpfc496822009-02-08 23:14:22 +00001633 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1634 /// emitted IR has a place to go. Note that by definition, if this function
1635 /// creates a block then that block is unreachable; callers may do better to
1636 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001637 void EnsureInsertPoint() {
1638 if (!HaveInsertPoint())
1639 EmitBlock(createBasicBlock());
1640 }
Mike Stumpfc496822009-02-08 23:14:22 +00001641
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001642 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001643 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001644 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001645
Chris Lattnere9a64532007-06-22 21:44:33 +00001646 //===--------------------------------------------------------------------===//
1647 // Helpers
1648 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001649
John McCall7f416cc2015-09-08 08:05:57 +00001650 LValue MakeAddrLValue(Address Addr, QualType T,
1651 AlignmentSource AlignSource = AlignmentSource::Type) {
1652 return LValue::MakeAddr(Addr, T, getContext(), AlignSource,
Dan Gohman947c9af2010-10-14 23:06:10 +00001653 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001654 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001655
John McCall7f416cc2015-09-08 08:05:57 +00001656 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1657 AlignmentSource AlignSource = AlignmentSource::Type) {
1658 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1659 AlignSource, CGM.getTBAAInfo(T));
1660 }
1661
1662 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001663 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001664 CharUnits getNaturalTypeAlignment(QualType T,
1665 AlignmentSource *Source = nullptr,
1666 bool forPointeeType = false);
1667 CharUnits getNaturalPointeeTypeAlignment(QualType T,
1668 AlignmentSource *Source = nullptr);
1669
1670 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
1671 AlignmentSource *Source = nullptr);
1672 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001673
Alexey Bataev31300ed2016-02-04 11:27:03 +00001674 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
1675 AlignmentSource *Source = nullptr);
1676 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1677
Chris Lattnere9a64532007-06-22 21:44:33 +00001678 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001679 /// block. The caller is responsible for setting an appropriate alignment on
1680 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001681 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001682 const Twine &Name = "tmp");
John McCall7f416cc2015-09-08 08:05:57 +00001683 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
1684 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001685
John McCall7f416cc2015-09-08 08:05:57 +00001686 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1687 /// default ABI alignment of the given LLVM type.
1688 ///
1689 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1690 /// any given AST type that happens to have been lowered to the
1691 /// given IR type. This should only ever be used for function-local,
1692 /// IR-driven manipulations like saving and restoring a value. Do
1693 /// not hand this address off to arbitrary IRGen routines, and especially
1694 /// do not pass it as an argument to a function that might expect a
1695 /// properly ABI-aligned value.
1696 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1697 const Twine &Name = "tmp");
1698
1699 /// InitTempAlloca - Provide an initial value for the given alloca which
1700 /// will be observable at all locations in the function.
1701 ///
1702 /// The address should be something that was returned from one of
1703 /// the CreateTempAlloca or CreateMemTemp routines, and the
1704 /// initializer must be valid in the entry block (i.e. it must
1705 /// either be a constant or an argument value).
1706 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001707
Daniel Dunbard0049182010-02-16 19:44:13 +00001708 /// CreateIRTemp - Create a temporary IR object of the given type, with
1709 /// appropriate alignment. This routine should only be used when an temporary
1710 /// value needs to be stored into an alloca (for example, to avoid explicit
1711 /// PHI construction), but the type is the IR type, not the type appropriate
1712 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001713 ///
1714 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1715 /// ConvertType instead of ConvertTypeForMem.
1716 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001717
Daniel Dunbara7566f12010-02-09 02:48:28 +00001718 /// CreateMemTemp - Create a temporary memory object of the given type, with
1719 /// appropriate alignment.
John McCall7f416cc2015-09-08 08:05:57 +00001720 Address CreateMemTemp(QualType T, const Twine &Name = "tmp");
1721 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001722
John McCall7a626f62010-09-15 10:14:12 +00001723 /// CreateAggTemp - Create a temporary memory object for the given
1724 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001725 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00001726 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001727 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001728 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001729 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001730 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001731 }
1732
John McCallad7c5c12011-02-08 08:22:06 +00001733 /// Emit a cast to void* in the appropriate address space.
1734 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1735
Chris Lattner8394d792007-06-05 20:53:16 +00001736 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1737 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001738 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001739
John McCalla2342eb2010-12-05 02:00:02 +00001740 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1741 void EmitIgnoredExpr(const Expr *E);
1742
Chris Lattner4647a212007-08-31 22:49:20 +00001743 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1744 /// any type. The result is returned as an RValue struct. If this is an
1745 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1746 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001747 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001748 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001749 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001750 AggValueSlot aggSlot = AggValueSlot::ignored(),
1751 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001752
Mike Stumpfc496822009-02-08 23:14:22 +00001753 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1754 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00001755 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001756
Charles Davisc7d5c942015-09-17 20:55:33 +00001757 /// Emit a "reference" to a __builtin_ms_va_list; this is
1758 /// always the value of the expression, because a __builtin_ms_va_list is a
1759 /// pointer to a char.
1760 Address EmitMSVAListRef(const Expr *E);
1761
Mike Stumpfc496822009-02-08 23:14:22 +00001762 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1763 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001764 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001765
John McCall91ca10f2011-03-08 09:11:50 +00001766 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001767 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00001768 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001769 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001770
John McCall7f416cc2015-09-08 08:05:57 +00001771 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00001772
John McCall91ca10f2011-03-08 09:11:50 +00001773 /// EmitExprAsInit - Emits the code necessary to initialize a
1774 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001775 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001776 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001777
Fariborz Jahanian78652202013-01-25 23:57:05 +00001778 /// hasVolatileMember - returns true if aggregate type has a volatile
1779 /// member.
1780 bool hasVolatileMember(QualType T) {
1781 if (const RecordType *RT = T->getAs<RecordType>()) {
1782 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1783 return RD->hasVolatileMember();
1784 }
1785 return false;
1786 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001787 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001788 ///
1789 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1790 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00001791 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001792 QualType EltTy) {
1793 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00001794 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001795 }
1796
John McCall7f416cc2015-09-08 08:05:57 +00001797 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
1798 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00001799 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00001800 /*IsAssignment=*/false);
1801 }
1802
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001803 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001804 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001805 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001806 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001807 /// \param isAssignment - If false, allow padding to be copied. This often
1808 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00001809 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001810 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001811 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001812
Anders Carlsson9396a892008-09-11 09:15:33 +00001813 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00001814 Address GetAddrOfLocalVar(const VarDecl *VD) {
1815 auto it = LocalDeclMap.find(VD);
1816 assert(it != LocalDeclMap.end() &&
1817 "Invalid argument to GetAddrOfLocalVar(), no decl!");
1818 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00001819 }
Mike Stumpfc496822009-02-08 23:14:22 +00001820
John McCallc07a0c72011-02-17 10:25:35 +00001821 /// getOpaqueLValueMapping - Given an opaque value expression (which
1822 /// must be mapped to an l-value), return its mapping.
1823 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1824 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1825
1826 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1827 it = OpaqueLValues.find(e);
1828 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1829 return it->second;
1830 }
1831
1832 /// getOpaqueRValueMapping - Given an opaque value expression (which
1833 /// must be mapped to an r-value), return its mapping.
1834 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1835 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1836
1837 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1838 it = OpaqueRValues.find(e);
1839 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001840 return it->second;
1841 }
1842
Dan Gohman75d69da2008-05-22 00:50:06 +00001843 /// getAccessedFieldNo - Given an encoded value and a result number, return
1844 /// the input field number being accessed.
1845 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1846
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001847 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001848 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001849
Anders Carlssonc0964b62010-05-22 17:35:42 +00001850 /// EmitNullInitialization - Generate code to set a value of the given type to
1851 /// null, If the type contains data member pointers, they will be initialized
1852 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00001853 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001854
Charles Davisc7d5c942015-09-17 20:55:33 +00001855 /// Emits a call to an LLVM variable-argument intrinsic, either
1856 /// \c llvm.va_start or \c llvm.va_end.
1857 /// \param ArgValue A reference to the \c va_list as emitted by either
1858 /// \c EmitVAListRef or \c EmitMSVAListRef.
1859 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
1860 /// calls \c llvm.va_end.
1861 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
1862
1863 /// Generate code to get an argument from the passed in pointer
1864 /// and update it accordingly.
1865 /// \param VE The \c VAArgExpr for which to generate code.
1866 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
1867 /// either \c EmitVAListRef or \c EmitMSVAListRef.
1868 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001869 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001870 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00001871 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001872
John McCall82fe67b2011-07-09 01:37:26 +00001873 /// emitArrayLength - Compute the length of an array, even if it's a
1874 /// VLA, and drill down to the base element type.
1875 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1876 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001877 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00001878
John McCall23c29fe2011-06-24 21:55:10 +00001879 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1880 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001881 ///
1882 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001883 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001884
John McCall23c29fe2011-06-24 21:55:10 +00001885 /// getVLASize - Returns an LLVM value that corresponds to the size,
1886 /// in non-variably-sized elements, of a variable length array type,
1887 /// plus that largest non-variably-sized element type. Assumes that
1888 /// the type has already been emitted with EmitVariablyModifiedType.
1889 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1890 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001891
Anders Carlssona5d077d2009-04-14 16:58:56 +00001892 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1893 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001894 llvm::Value *LoadCXXThis() {
1895 assert(CXXThisValue && "no 'this' value for this function");
1896 return CXXThisValue;
1897 }
John McCall7f416cc2015-09-08 08:05:57 +00001898 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00001899
Anders Carlssone36a6b32010-01-02 01:01:18 +00001900 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1901 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001902 // FIXME: Every place that calls LoadCXXVTT is something
1903 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001904 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001905 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1906 return CXXStructorImplicitParamValue;
1907 }
1908
John McCall6ce74722010-02-16 04:15:37 +00001909 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001910 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00001911 Address
1912 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001913 const CXXRecordDecl *Derived,
1914 const CXXRecordDecl *Base,
1915 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001916
John McCall7f416cc2015-09-08 08:05:57 +00001917 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
1918
Mike Stumpe5311b02009-11-30 20:08:49 +00001919 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1920 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00001921 Address GetAddressOfBaseClass(Address Value,
1922 const CXXRecordDecl *Derived,
1923 CastExpr::path_const_iterator PathBegin,
1924 CastExpr::path_const_iterator PathEnd,
1925 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001926
John McCall7f416cc2015-09-08 08:05:57 +00001927 Address GetAddressOfDerivedClass(Address Value,
1928 const CXXRecordDecl *Derived,
1929 CastExpr::path_const_iterator PathBegin,
1930 CastExpr::path_const_iterator PathEnd,
1931 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00001932
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001933 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1934 /// base constructor/destructor with virtual bases.
1935 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1936 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1937 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1938 bool Delegating);
1939
John McCallf8ff7b92010-02-23 00:48:20 +00001940 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1941 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001942 const FunctionArgList &Args,
1943 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001944 // It's important not to confuse this and the previous function. Delegating
1945 // constructors are the C++0x feature. The constructor delegate optimization
1946 // is used to reduce duplication in the base and complete consturctors where
1947 // they are substantially the same.
1948 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1949 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001950
Richard Smith5179eb72016-06-28 19:03:57 +00001951 /// Emit a call to an inheriting constructor (that is, one that invokes a
1952 /// constructor inherited from a base class) by inlining its definition. This
1953 /// is necessary if the ABI does not support forwarding the arguments to the
1954 /// base class constructor (because they're variadic or similar).
1955 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1956 CXXCtorType CtorType,
1957 bool ForVirtualBase,
1958 bool Delegating,
1959 CallArgList &Args);
1960
1961 /// Emit a call to a constructor inherited from a base class, passing the
1962 /// current constructor's arguments along unmodified (without even making
1963 /// a copy).
1964 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
1965 bool ForVirtualBase, Address This,
1966 bool InheritedFromVBase,
1967 const CXXInheritedCtorInitExpr *E);
1968
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001969 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001970 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001971 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001972
Richard Smith5179eb72016-06-28 19:03:57 +00001973 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
1974 bool ForVirtualBase, bool Delegating,
1975 Address This, CallArgList &Args);
1976
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001977 /// Emit assumption load for all bases. Requires to be be called only on
1978 /// most-derived class and not under construction of the object.
1979 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
1980
1981 /// Emit assumption that vptr load == global vtable.
1982 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
1983
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001984 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00001985 Address This, Address Src,
1986 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001987
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001988 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00001989 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00001990 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001991 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001992 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001993
Anders Carlssond49844b2009-09-23 02:45:36 +00001994 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1995 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00001996 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001997 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001998 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001999
John McCall82fe67b2011-07-09 01:37:26 +00002000 static Destroyer destroyCXXObject;
2001
Anders Carlsson0a637412009-05-29 21:03:38 +00002002 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002003 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002004 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002005
John McCall99210dc2011-09-15 06:49:18 +00002006 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002007 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002008 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002009 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002010
Peter Collingbourne702b2842011-11-27 22:09:22 +00002011 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002012 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002013
David Majnemerdc012fa2015-04-22 21:38:15 +00002014 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2015 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2016
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002017 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002018 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002019
Eli Friedman24f55432009-11-18 00:57:03 +00002020 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
2021 QualType DeleteTy);
2022
Richard Smith760520b2014-06-03 23:27:44 +00002023 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2024 const Expr *Arg, bool IsDelete);
2025
John McCall7f416cc2015-09-08 08:05:57 +00002026 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2027 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2028 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002029
Richard Smith69d0d262012-08-24 00:54:33 +00002030 /// \brief Situations in which we might emit a check for the suitability of a
2031 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002032 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002033 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002034 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002035 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002036 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002037 /// Checking the bound value in a reference binding. Must be suitably sized
2038 /// and aligned, but is not required to refer to an object (until the
2039 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002040 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002041 /// Checking the object expression in a non-static data member access. Must
2042 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002043 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002044 /// Checking the 'this' pointer for a call to a non-static member function.
2045 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002046 TCK_MemberCall,
2047 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002048 TCK_ConstructorCall,
2049 /// Checking the operand of a static_cast to a derived pointer type. Must be
2050 /// null or an object within its lifetime.
2051 TCK_DowncastPointer,
2052 /// Checking the operand of a static_cast to a derived reference type. Must
2053 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002054 TCK_DowncastReference,
2055 /// Checking the operand of a cast to a base object. Must be suitably sized
2056 /// and aligned.
2057 TCK_Upcast,
2058 /// Checking the operand of a cast to a virtual base object. Must be an
2059 /// object within its lifetime.
2060 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00002061 };
2062
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002063 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2064 /// calls to EmitTypeCheck can be skipped.
2065 bool sanitizePerformTypeCheck() const;
2066
Richard Smith4d1458e2012-09-08 02:08:36 +00002067 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002068 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002069 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002070 QualType Type, CharUnits Alignment = CharUnits::Zero(),
2071 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002072
Richard Smith539e4a72013-02-23 02:53:19 +00002073 /// \brief Emit a check that \p Base points into an array object, which
2074 /// we can access at index \p Index. \p Accessed should be \c false if we
2075 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2076 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2077 QualType IndexType, bool Accessed);
2078
Chris Lattner116ce8f2010-01-09 21:40:03 +00002079 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2080 bool isInc, bool isPre);
2081 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2082 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002083
2084 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002085 llvm::Value *OffsetValue = nullptr) {
2086 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2087 OffsetValue);
2088 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002089
Chris Lattner8394d792007-06-05 20:53:16 +00002090 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002091 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002092 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002093
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002094 /// EmitDecl - Emit a declaration.
2095 ///
2096 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002097 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002098
John McCall1c9c3fd2010-10-15 04:57:14 +00002099 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002100 ///
2101 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002102 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002103
David Blaikie73ca5692014-12-09 00:32:22 +00002104 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002105 bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00002106 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00002107
John McCallbd309292010-07-06 01:34:17 +00002108 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2109 llvm::Value *Address);
2110
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002111 /// \brief Determine whether the given initializer is trivial in the sense
2112 /// that it requires no code to be generated.
2113 bool isTrivialInitializer(const Expr *Init);
2114
John McCall1c9c3fd2010-10-15 04:57:14 +00002115 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002116 ///
2117 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002118 void EmitAutoVarDecl(const VarDecl &D);
2119
2120 class AutoVarEmission {
2121 friend class CodeGenFunction;
2122
John McCall9e2e22f2011-02-22 07:16:58 +00002123 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002124
John McCall7f416cc2015-09-08 08:05:57 +00002125 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002126 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002127 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002128
2129 llvm::Value *NRVOFlag;
2130
2131 /// True if the variable is a __block variable.
2132 bool IsByRef;
2133
2134 /// True if the variable is of aggregate type and has a constant
2135 /// initializer.
2136 bool IsConstantAggregate;
2137
Nadav Rotem1da30942013-03-23 06:43:35 +00002138 /// Non-null if we should use lifetime annotations.
2139 llvm::Value *SizeForLifetimeMarkers;
2140
John McCall9e2e22f2011-02-22 07:16:58 +00002141 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002142 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002143
John McCallc533cb72011-02-22 06:44:22 +00002144 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002145 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002146 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002147 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002148
John McCall7f416cc2015-09-08 08:05:57 +00002149 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002150
2151 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002152 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2153
Craig Topper8a13c412014-05-21 05:09:00 +00002154 bool useLifetimeMarkers() const {
2155 return SizeForLifetimeMarkers != nullptr;
2156 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002157 llvm::Value *getSizeForLifetimeMarkers() const {
2158 assert(useLifetimeMarkers());
2159 return SizeForLifetimeMarkers;
2160 }
2161
2162 /// Returns the raw, allocated address, which is not necessarily
2163 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002164 Address getAllocatedAddress() const {
2165 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002166 }
2167
John McCallc533cb72011-02-22 06:44:22 +00002168 /// Returns the address of the object within this declaration.
2169 /// Note that this does not chase the forwarding pointer for
2170 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002171 Address getObjectAddress(CodeGenFunction &CGF) const {
2172 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002173
John McCall7f416cc2015-09-08 08:05:57 +00002174 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002175 }
2176 };
2177 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2178 void EmitAutoVarInit(const AutoVarEmission &emission);
2179 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002180 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2181 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002182
John McCall1c9c3fd2010-10-15 04:57:14 +00002183 void EmitStaticVarDecl(const VarDecl &D,
2184 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002185
John McCall7f416cc2015-09-08 08:05:57 +00002186 class ParamValue {
2187 llvm::Value *Value;
2188 unsigned Alignment;
2189 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2190 public:
2191 static ParamValue forDirect(llvm::Value *value) {
2192 return ParamValue(value, 0);
2193 }
2194 static ParamValue forIndirect(Address addr) {
2195 assert(!addr.getAlignment().isZero());
2196 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2197 }
2198
2199 bool isIndirect() const { return Alignment != 0; }
2200 llvm::Value *getAnyValue() const { return Value; }
2201
2202 llvm::Value *getDirectValue() const {
2203 assert(!isIndirect());
2204 return Value;
2205 }
2206
2207 Address getIndirectAddress() const {
2208 assert(isIndirect());
2209 return Address(Value, CharUnits::fromQuantity(Alignment));
2210 }
2211 };
2212
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002213 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002214 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002215
John McCallc07a0c72011-02-17 10:25:35 +00002216 /// protectFromPeepholes - Protect a value that we're intending to
2217 /// store to the side, but which will probably be used later, from
2218 /// aggressive peepholing optimizations that might delete it.
2219 ///
2220 /// Pass the result to unprotectFromPeepholes to declare that
2221 /// protection is no longer required.
2222 ///
2223 /// There's no particular reason why this shouldn't apply to
2224 /// l-values, it's just that no existing peepholes work on pointers.
2225 PeepholeProtection protectFromPeepholes(RValue rvalue);
2226 void unprotectFromPeepholes(PeepholeProtection protection);
2227
Chris Lattner84915fa2007-06-02 04:16:21 +00002228 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002229 // Statement Emission
2230 //===--------------------------------------------------------------------===//
2231
Mike Stumpfc496822009-02-08 23:14:22 +00002232 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002233 void EmitStopPoint(const Stmt *S);
2234
Mike Stumpfc496822009-02-08 23:14:22 +00002235 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2236 /// this function even if there is no current insertion point.
2237 ///
2238 /// This function may clear the current insertion point; callers should use
2239 /// EnsureInsertPoint if they wish to subsequently generate code without first
2240 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002241 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002242
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002243 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002244 /// necessarily require an insertion point or debug information; typically
2245 /// because the statement amounts to a jump or a container of other
2246 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002247 ///
2248 /// \return True if the statement was handled.
2249 bool EmitSimpleStmt(const Stmt *S);
2250
John McCall7f416cc2015-09-08 08:05:57 +00002251 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2252 AggValueSlot AVS = AggValueSlot::ignored());
2253 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2254 bool GetLast = false,
2255 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002256 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002257
Mike Stumpfc496822009-02-08 23:14:22 +00002258 /// EmitLabel - Emit the block for the given label. It is legal to call this
2259 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002260 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002261
Chris Lattnerac248202007-05-30 00:13:02 +00002262 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002263 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002264 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002265 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002266 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002267
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002268 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002269 ArrayRef<const Attr *> Attrs = None);
2270 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002271 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002272 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002273 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002274 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002275 void EmitBreakStmt(const BreakStmt &S);
2276 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002277 void EmitSwitchStmt(const SwitchStmt &S);
2278 void EmitDefaultStmt(const DefaultStmt &S);
2279 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002280 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002281 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002282
Anders Carlsson2e744e82008-08-30 19:51:14 +00002283 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002284 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2285 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002286 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002287 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002288
John McCallb609d3f2010-07-07 06:56:46 +00002289 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2290 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002291
Anders Carlsson52d78a52009-09-27 18:58:34 +00002292 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002293 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002294 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002295 void EnterSEHTryStmt(const SEHTryStmt &S);
2296 void ExitSEHTryStmt(const SEHTryStmt &S);
2297
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002298 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002299 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002300
2301 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2302 const SEHExceptStmt &Except);
2303
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002304 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2305 const SEHFinallyStmt &Finally);
2306
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002307 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2308 llvm::Value *ParentFP,
2309 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002310 llvm::Value *EmitSEHExceptionCode();
2311 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002312 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002313
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002314 /// Scan the outlined statement for captures from the parent function. For
2315 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002316 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002317 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002318 bool IsFilter);
2319
2320 /// Recovers the address of a local in a parent function. ParentVar is the
2321 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002322 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002323 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2324 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002325 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2326 Address ParentVar,
2327 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002328
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002329 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002330 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002331
Alexey Bataev1189bd02016-01-26 12:20:39 +00002332 /// Returns calculated size of the specified type.
2333 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002334 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002335 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002336 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002337 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002338 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002339 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002340 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002341 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2342 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002343 /// \brief Perform element by element copying of arrays with type \a
2344 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2345 /// generated by \a CopyGen.
2346 ///
2347 /// \param DestAddr Address of the destination array.
2348 /// \param SrcAddr Address of the source array.
2349 /// \param OriginalType Type of destination and source arrays.
2350 /// \param CopyGen Copying procedure that copies value of single array element
2351 /// to another single array element.
2352 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002353 Address DestAddr, Address SrcAddr, QualType OriginalType,
2354 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002355 /// \brief Emit proper copying of data from one variable to another.
2356 ///
2357 /// \param OriginalType Original type of the copied variables.
2358 /// \param DestAddr Destination address.
2359 /// \param SrcAddr Source address.
2360 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2361 /// type of the base array element).
2362 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2363 /// the base array element).
2364 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2365 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002366 void EmitOMPCopy(QualType OriginalType,
2367 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002368 const VarDecl *DestVD, const VarDecl *SrcVD,
2369 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002370 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2371 /// \a X = \a E \a BO \a E.
2372 ///
2373 /// \param X Value to be updated.
2374 /// \param E Update value.
2375 /// \param BO Binary operation for update operation.
2376 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2377 /// expression, false otherwise.
2378 /// \param AO Atomic ordering of the generated atomic instructions.
2379 /// \param CommonGen Code generator for complex expressions that cannot be
2380 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002381 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2382 /// generated, <false, RValue::get(nullptr)> otherwise.
2383 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002384 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2385 llvm::AtomicOrdering AO, SourceLocation Loc,
2386 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002387 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002388 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002389 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2390 OMPPrivateScope &PrivateScope);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002391 /// \brief Emit code for copyin clause in \a D directive. The next code is
2392 /// generated at the start of outlined functions for directives:
2393 /// \code
2394 /// threadprivate_var1 = master_threadprivate_var1;
2395 /// operator=(threadprivate_var2, master_threadprivate_var2);
2396 /// ...
2397 /// __kmpc_barrier(&loc, global_tid);
2398 /// \endcode
2399 ///
2400 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2401 /// \returns true if at least one copyin variable is found, false otherwise.
2402 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002403 /// \brief Emit initial code for lastprivate variables. If some variable is
2404 /// not also firstprivate, then the default initialization is used. Otherwise
2405 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2406 /// method.
2407 ///
2408 /// \param D Directive that may have 'lastprivate' directives.
2409 /// \param PrivateScope Private scope for capturing lastprivate variables for
2410 /// proper codegen in internal captured statement.
2411 ///
2412 /// \returns true if there is at least one lastprivate variable, false
2413 /// otherwise.
2414 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2415 OMPPrivateScope &PrivateScope);
2416 /// \brief Emit final copying of lastprivate values to original variables at
2417 /// the end of the worksharing or simd directive.
2418 ///
2419 /// \param D Directive that has at least one 'lastprivate' directives.
2420 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2421 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002422 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002423 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002424 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002425 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002426 /// Emit initial code for linear clauses.
2427 void EmitOMPLinearClause(const OMPLoopDirective &D,
2428 CodeGenFunction::OMPPrivateScope &PrivateScope);
2429 /// Emit final code for linear clauses.
2430 /// \param CondGen Optional conditional code for final part of codegen for
2431 /// linear clause.
2432 void EmitOMPLinearClauseFinal(
2433 const OMPLoopDirective &D,
2434 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002435 /// \brief Emit initial code for reduction variables. Creates reduction copies
2436 /// and initializes them with the values according to OpenMP standard.
2437 ///
2438 /// \param D Directive (possibly) with the 'reduction' clause.
2439 /// \param PrivateScope Private scope for capturing reduction variables for
2440 /// proper codegen in internal captured statement.
2441 ///
2442 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2443 OMPPrivateScope &PrivateScope);
2444 /// \brief Emit final update of reduction values to original variables at
2445 /// the end of the directive.
2446 ///
2447 /// \param D Directive that has at least one 'reduction' directives.
2448 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002449 /// \brief Emit initial code for linear variables. Creates private copies
2450 /// and initializes them with the values according to OpenMP standard.
2451 ///
2452 /// \param D Directive (possibly) with the 'linear' clause.
2453 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002454
Alexey Bataev7292c292016-04-25 12:22:29 +00002455 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2456 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002457 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002458 TaskGenTy;
2459 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2460 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002461 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00002462
Alexey Bataev9959db52014-05-06 10:08:46 +00002463 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002464 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002465 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002466 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002467 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002468 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002469 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002470 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002471 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002472 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002473 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002474 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002475 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002476 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002477 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002478 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002479 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002480 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002481 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002482 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002483 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002484 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002485 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002486 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002487 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002488 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002489 void
2490 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002491 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002492 void
2493 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002494 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002495 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002496 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002497 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002498 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002499 void EmitOMPDistributeLoop(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002500 void EmitOMPDistributeParallelForDirective(
2501 const OMPDistributeParallelForDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002502
Alexey Bataev14fa1c62016-03-29 05:34:15 +00002503 /// Emit outlined function for the target directive.
2504 static std::pair<llvm::Function * /*OutlinedFn*/,
2505 llvm::Constant * /*OutlinedFnID*/>
2506 EmitOMPTargetDirectiveOutlinedFunction(CodeGenModule &CGM,
2507 const OMPTargetDirective &S,
2508 StringRef ParentName,
2509 bool IsOffloadEntry);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002510 /// \brief Emit inner loop of the worksharing/simd construct.
2511 ///
2512 /// \param S Directive, for which the inner loop must be emitted.
2513 /// \param RequiresCleanup true, if directive has some associated private
2514 /// variables.
2515 /// \param LoopCond Bollean condition for loop continuation.
2516 /// \param IncExpr Increment expression for loop control variable.
2517 /// \param BodyGen Generator for the inner body of the inner loop.
2518 /// \param PostIncGen Genrator for post-increment code (required for ordered
2519 /// loop directvies).
2520 void EmitOMPInnerLoop(
2521 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2522 const Expr *IncExpr,
2523 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2524 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002525
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002526 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002527 /// Emit initial code for loop counters of loop-based directives.
2528 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2529 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002530
Alexander Musmanc6388682014-12-15 07:07:06 +00002531private:
Alexander Musmanc6388682014-12-15 07:07:06 +00002532 /// Helpers for the OpenMP loop directives.
Alexey Bataev0f34da12015-07-02 04:17:07 +00002533 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002534 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002535 void EmitOMPSimdFinal(
2536 const OMPLoopDirective &D,
2537 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev38e89532015-04-16 04:54:05 +00002538 /// \brief Emit code for the worksharing loop-based directive.
2539 /// \return true, if this construct has any lastprivate clause, false -
2540 /// otherwise.
2541 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002542 void EmitOMPOuterLoop(bool IsMonotonic, bool DynamicOrOrdered,
2543 const OMPLoopDirective &S, OMPPrivateScope &LoopScope, bool Ordered,
2544 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00002545 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002546 bool IsMonotonic, const OMPLoopDirective &S,
2547 OMPPrivateScope &LoopScope, bool Ordered, Address LB,
2548 Address UB, Address ST, Address IL,
2549 llvm::Value *Chunk);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002550 void EmitOMPDistributeOuterLoop(
2551 OpenMPDistScheduleClauseKind ScheduleKind,
2552 const OMPDistributeDirective &S, OMPPrivateScope &LoopScope,
2553 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002554 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002555 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002556
2557public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002558
Chris Lattner208ae962007-05-30 17:57:17 +00002559 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002560 // LValue Expression Emission
2561 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002562
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002563 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2564 RValue GetUndefRValue(QualType Ty);
2565
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002566 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2567 /// and issue an ErrorUnsupported style diagnostic (using the
2568 /// provided Name).
2569 RValue EmitUnsupportedRValue(const Expr *E,
2570 const char *Name);
2571
Mike Stumpfc496822009-02-08 23:14:22 +00002572 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2573 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002574 LValue EmitUnsupportedLValue(const Expr *E,
2575 const char *Name);
2576
Chris Lattner8394d792007-06-05 20:53:16 +00002577 /// EmitLValue - Emit code to compute a designator that specifies the location
2578 /// of the expression.
2579 ///
2580 /// This can return one of two things: a simple address or a bitfield
2581 /// reference. In either case, the LLVM Value* in the LValue structure is
2582 /// guaranteed to be an LLVM pointer type.
2583 ///
2584 /// If this returns a bitfield reference, nothing about the pointee type of
2585 /// the LLVM value is known: For example, it may not be a pointer to an
2586 /// integer.
2587 ///
2588 /// If this returns a normal address, and if the lvalue's C type is fixed
2589 /// size, this method guarantees that the returned pointer type will point to
2590 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2591 /// variable length type, this is not possible.
2592 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002593 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002594
Richard Smith4d1458e2012-09-08 02:08:36 +00002595 /// \brief Same as EmitLValue but additionally we generate checking code to
2596 /// guard against undefined behavior. This is only suitable when we know
2597 /// that the address will be used to access the object.
2598 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002599
John McCall7f416cc2015-09-08 08:05:57 +00002600 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002601 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002602
John McCalla8ec7eb2013-03-07 21:37:17 +00002603 void EmitAtomicInit(Expr *E, LValue lvalue);
2604
David Majnemera5b195a2015-02-14 01:35:12 +00002605 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00002606
2607 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2608 AggValueSlot Slot = AggValueSlot::ignored());
2609
Nick Lewycky2d84e842013-10-02 02:29:49 +00002610 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002611 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002612 AggValueSlot slot = AggValueSlot::ignored());
2613
2614 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2615
David Majnemera5b195a2015-02-14 01:35:12 +00002616 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2617 bool IsVolatile, bool isInit);
2618
Alexey Bataevb4505a72015-03-30 05:20:59 +00002619 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002620 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00002621 llvm::AtomicOrdering Success =
2622 llvm::AtomicOrdering::SequentiallyConsistent,
2623 llvm::AtomicOrdering Failure =
2624 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00002625 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2626
Alexey Bataevb4505a72015-03-30 05:20:59 +00002627 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002628 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002629 bool IsVolatile);
2630
John McCall3a7f6922010-10-27 20:58:56 +00002631 /// EmitToMemory - Change a scalar value from its value
2632 /// representation to its in-memory representation.
2633 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2634
2635 /// EmitFromMemory - Change a scalar value from its memory
2636 /// representation to its value representation.
2637 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2638
Daniel Dunbar1d425462009-02-10 00:57:50 +00002639 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2640 /// care to appropriately convert from the memory representation to
2641 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002642 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002643 SourceLocation Loc,
John McCall7f416cc2015-09-08 08:05:57 +00002644 AlignmentSource AlignSource =
2645 AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002646 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002647 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002648 uint64_t TBAAOffset = 0,
2649 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002650
2651 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2652 /// care to appropriately convert from the memory representation to
2653 /// the LLVM value representation. The l-value must be a simple
2654 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002655 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002656
2657 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2658 /// care to appropriately convert from the memory representation to
2659 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002660 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
2661 bool Volatile, QualType Ty,
2662 AlignmentSource AlignSource = AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002663 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002664 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002665 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002666
2667 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2668 /// care to appropriately convert from the memory representation to
2669 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002670 /// l-value. The isInit flag indicates whether this is an initialization.
2671 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2672 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002673
Chris Lattner8394d792007-06-05 20:53:16 +00002674 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2675 /// this method emits the address of the lvalue, then loads the result as an
2676 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002677 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002678 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2679 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002680 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002681
Chris Lattner8394d792007-06-05 20:53:16 +00002682 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2683 /// lvalue, where both are guaranteed to the have the same type, and that type
2684 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002685 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002686 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002687 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002688
Nick Lewycky2d84e842013-10-02 02:29:49 +00002689 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2690 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002691 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002692 /// \param Result [out] - If non-null, this will be set to a Value* for the
2693 /// bit-field contents after the store, appropriate for use as the result of
2694 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002695 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002696 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002697
John McCall4f29b492010-11-16 23:07:28 +00002698 /// Emit an l-value for an assignment (simple or compound) of complex type.
2699 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002700 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002701 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2702 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002703
Chris Lattner57540c52011-04-15 05:22:18 +00002704 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002705 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002706 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002707 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002708 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002709 // Note: only available for agg return types
2710 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002711 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002712 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002713 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002714 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002715 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002716 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2717 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00002718 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
2719 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002720 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002721 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002722 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002723 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002724 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002725 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002726 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002727 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002728 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002729
John McCall7f416cc2015-09-08 08:05:57 +00002730 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002731
Nick Lewycky2d84e842013-10-02 02:29:49 +00002732 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002733
John McCall7f416cc2015-09-08 08:05:57 +00002734 Address EmitArrayToPointerDecay(const Expr *Array,
2735 AlignmentSource *AlignSource = nullptr);
2736
John McCall71335052012-03-10 03:05:10 +00002737 class ConstantEmission {
2738 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2739 ConstantEmission(llvm::Constant *C, bool isReference)
2740 : ValueAndIsReference(C, isReference) {}
2741 public:
2742 ConstantEmission() {}
2743 static ConstantEmission forReference(llvm::Constant *C) {
2744 return ConstantEmission(C, true);
2745 }
2746 static ConstantEmission forValue(llvm::Constant *C) {
2747 return ConstantEmission(C, false);
2748 }
2749
Aaron Ballman67347662015-02-15 22:00:28 +00002750 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002751 return ValueAndIsReference.getOpaqueValue() != nullptr;
2752 }
John McCall71335052012-03-10 03:05:10 +00002753
2754 bool isReference() const { return ValueAndIsReference.getInt(); }
2755 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2756 assert(isReference());
2757 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2758 refExpr->getType());
2759 }
2760
2761 llvm::Constant *getValue() const {
2762 assert(!isReference());
2763 return ValueAndIsReference.getPointer();
2764 }
2765 };
2766
John McCall113bee02012-03-10 09:33:50 +00002767 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002768
John McCallfe96e0b2011-11-06 09:01:30 +00002769 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2770 AggValueSlot slot = AggValueSlot::ignored());
2771 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2772
Daniel Dunbar722f4242009-04-22 05:08:15 +00002773 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002774 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002775 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002776 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002777
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002778 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2779 /// if the Field is a reference, this will return the address of the reference
2780 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002781 LValue EmitLValueForFieldInitialization(LValue Base,
2782 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002783
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002784 LValue EmitLValueForIvar(QualType ObjectTy,
2785 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002786 unsigned CVRQualifiers);
2787
Anders Carlsson3be22e22009-05-30 23:23:33 +00002788 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002789 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002790 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002791 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002792 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002793
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002794 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002795 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002796 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002797 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002798 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002799 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002800
Chris Lattnerd7f58862007-06-02 05:24:33 +00002801 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002802 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002803 //===--------------------------------------------------------------------===//
2804
Mike Stumpfc496822009-02-08 23:14:22 +00002805 /// EmitCall - Generate a call of the given function, expecting the given
2806 /// result type, and using the given argument list which specifies both the
2807 /// LLVM arguments and the types they were derived from.
Samuel Antao798f11c2015-11-23 22:04:44 +00002808 RValue EmitCall(const CGFunctionInfo &FnInfo, llvm::Value *Callee,
2809 ReturnValueSlot ReturnValue, const CallArgList &Args,
2810 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Craig Topper8a13c412014-05-21 05:09:00 +00002811 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002812
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002813 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002814 ReturnValueSlot ReturnValue,
Samuel Antao798f11c2015-11-23 22:04:44 +00002815 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Peter Collingbournef7706832014-12-12 23:41:25 +00002816 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002817 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002818 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002819
Eric Christopherc7e79db2015-11-12 00:44:04 +00002820 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00002821
John McCall882987f2013-02-28 19:01:20 +00002822 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2823 const Twine &name = "");
2824 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2825 ArrayRef<llvm::Value*> args,
2826 const Twine &name = "");
2827 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2828 const Twine &name = "");
2829 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2830 ArrayRef<llvm::Value*> args,
2831 const Twine &name = "");
2832
John McCallbd309292010-07-06 01:34:17 +00002833 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002834 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002835 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002836 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2837 ArrayRef<llvm::Value*> args,
2838 const Twine &name = "");
2839 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2840 const Twine &name = "");
2841 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2842 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002843
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002844 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2845 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002846 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002847
2848 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2849 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002850 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002851
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002852 RValue
2853 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2854 ReturnValueSlot ReturnValue, llvm::Value *This,
2855 llvm::Value *ImplicitParam,
2856 QualType ImplicitParamTy, const CallExpr *E);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00002857 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD, llvm::Value *Callee,
2858 llvm::Value *This, llvm::Value *ImplicitParam,
2859 QualType ImplicitParamTy, const CallExpr *E,
2860 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002861 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2862 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002863 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2864 const CXXMethodDecl *MD,
2865 ReturnValueSlot ReturnValue,
2866 bool HasQualifier,
2867 NestedNameSpecifier *Qualifier,
2868 bool IsArrow, const Expr *Base);
2869 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002870 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
2871 llvm::Value *memberPtr,
2872 const MemberPointerType *memberPtrType,
2873 AlignmentSource *AlignSource = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002874 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2875 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002876
Anders Carlsson4034a952009-05-27 04:18:27 +00002877 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002878 const CXXMethodDecl *MD,
2879 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002880
Peter Collingbournefe883422011-10-06 18:29:37 +00002881 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2882 ReturnValueSlot ReturnValue);
2883
Justin Lebar3039a592016-01-23 21:28:14 +00002884 RValue EmitCUDADevicePrintfCallExpr(const CallExpr *E,
2885 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002886
Mike Stump11289f42009-09-09 15:08:12 +00002887 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002888 unsigned BuiltinID, const CallExpr *E,
2889 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002890
Anders Carlssonbfb36712009-12-24 21:13:40 +00002891 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002892
Mike Stumpfc496822009-02-08 23:14:22 +00002893 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2894 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002895 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2896
Kevin Qin1718af62013-11-14 02:45:18 +00002897 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2898 const llvm::CmpInst::Predicate Fp,
2899 const llvm::CmpInst::Predicate Ip,
2900 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002901 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002902
2903 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2904 unsigned LLVMIntrinsic,
2905 unsigned AltLLVMIntrinsic,
2906 const char *NameHint,
2907 unsigned Modifier,
2908 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002909 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00002910 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00002911 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2912 unsigned Modifier, llvm::Type *ArgTy,
2913 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002914 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002915 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002916 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002917 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002918 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002919 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002920 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002921 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2922 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00002923 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00002924 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002925
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002926 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002927 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2928 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00002929 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00002930 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00002931 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00002932 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
2933 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002934
Daniel Dunbar66912a12008-08-20 00:28:19 +00002935 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002936 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002937 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002938 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2939 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2940 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002941 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002942 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002943 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2944 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002945
John McCall31168b02011-06-15 23:02:42 +00002946 /// Retrieves the default cleanup kind for an ARC cleanup.
2947 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2948 CleanupKind getARCCleanupKind() {
2949 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2950 ? NormalAndEHCleanup : NormalCleanup;
2951 }
2952
2953 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00002954 void EmitARCInitWeak(Address addr, llvm::Value *value);
2955 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00002956 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00002957 llvm::Value *EmitARCLoadWeakRetained(Address addr);
2958 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
2959 void EmitARCCopyWeak(Address dst, Address src);
2960 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00002961 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2962 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002963 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002964 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00002965 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002966 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002967 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00002968 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002969 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00002970 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00002971 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00002972 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00002973 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2974 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2975 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00002976 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00002977
2978 std::pair<LValue,llvm::Value*>
2979 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2980 std::pair<LValue,llvm::Value*>
2981 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00002982 std::pair<LValue,llvm::Value*>
2983 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00002984
John McCall248512a2011-10-01 10:32:24 +00002985 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002986 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2987 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2988
John McCallff613032011-10-04 06:23:45 +00002989 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00002990 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
2991 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00002992 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2993 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00002994 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002995
Craig Topper00bbdcf2014-06-28 23:22:23 +00002996 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002997
John McCall82fe67b2011-07-09 01:37:26 +00002998 static Destroyer destroyARCStrongImprecise;
2999 static Destroyer destroyARCStrongPrecise;
3000 static Destroyer destroyARCWeak;
3001
John McCall31168b02011-06-15 23:02:42 +00003002 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3003 llvm::Value *EmitObjCAutoreleasePoolPush();
3004 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3005 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3006 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3007
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003008 /// \brief Emits a reference binding to the passed in expression.
3009 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003010
Chris Lattner6278e6a2007-08-11 00:04:45 +00003011 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003012 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003013 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003014
3015 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003016
3017 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3018 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003019 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003020
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003021 /// Emit a conversion from the specified type to the specified destination
3022 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003023 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003024 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003025
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003026 /// Emit a conversion from the specified complex type to the specified
3027 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003028 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003029 QualType DstTy,
3030 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003031
John McCall7a626f62010-09-15 10:14:12 +00003032 /// EmitAggExpr - Emit the computation of the specified expression
3033 /// of aggregate type. The result is computed into the given slot,
3034 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003035 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003036
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003037 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3038 /// aggregate type into a temporary LValue.
3039 LValue EmitAggExprToLValue(const Expr *E);
3040
John McCall1bd25562011-06-24 23:21:27 +00003041 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3042 /// make sure it survives garbage collection until this point.
3043 void EmitExtendGCLifetime(llvm::Value *object);
3044
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003045 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003046 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003047 ComplexPairTy EmitComplexExpr(const Expr *E,
3048 bool IgnoreReal = false,
3049 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003050
John McCall47fb9502013-03-07 21:37:08 +00003051 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3052 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003053 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003054
John McCall47fb9502013-03-07 21:37:08 +00003055 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003056 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003057
3058 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003059 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003060
John McCall7f416cc2015-09-08 08:05:57 +00003061 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3062 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3063
Chandler Carruth84537952012-03-30 19:44:53 +00003064 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3065 /// global variable that has already been created for it. If the initializer
3066 /// has a different type than GV does, this may free GV and return a different
3067 /// one. Otherwise it just returns GV.
3068 llvm::GlobalVariable *
3069 AddInitializerToStaticVarDecl(const VarDecl &D,
3070 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003071
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003072
Anders Carlssonf40886a2009-08-08 21:45:14 +00003073 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3074 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003075 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3076 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003077
David Majnemerb3341ea2014-10-05 05:05:40 +00003078 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3079 llvm::Constant *Addr);
3080
John McCallc84ed6a2012-05-01 06:13:13 +00003081 /// Call atexit() with a function that passes the given argument to
3082 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003083 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3084 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003085
John McCallcdf7ef52010-11-06 09:44:32 +00003086 /// Emit code in this function to perform a guarded variable
3087 /// initialization. Guarded initializations are used when it's not
3088 /// possible to prove that an initialization will be done exactly
3089 /// once, e.g. with a static local variable or a static data member
3090 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003091 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003092 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003093
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003094 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3095 /// variables.
3096 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003097 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003098 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003099
John McCallee08c532012-04-06 18:21:03 +00003100 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003101 /// variables.
John McCallee08c532012-04-06 18:21:03 +00003102 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
3103 const std::vector<std::pair<llvm::WeakVH,
3104 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003105
John McCalla738c252011-03-09 04:27:21 +00003106 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3107 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003108 llvm::GlobalVariable *Addr,
3109 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003110
John McCall7a626f62010-09-15 10:14:12 +00003111 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00003112
John McCall7f416cc2015-09-08 08:05:57 +00003113 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003114
John McCall08ef4662011-11-10 08:15:53 +00003115 void enterFullExpression(const ExprWithCleanups *E) {
3116 if (E->getNumObjects() == 0) return;
3117 enterNonTrivialFullExpression(E);
3118 }
3119 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003120
Richard Smithea852322013-05-07 21:53:22 +00003121 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003122
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003123 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3124
Tim Northovercc2a6e02015-11-09 19:56:35 +00003125 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003126
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003127 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003128 // Annotations Emission
3129 //===--------------------------------------------------------------------===//
3130
3131 /// Emit an annotation call (intrinsic or builtin).
3132 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3133 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003134 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003135 SourceLocation Location);
3136
3137 /// Emit local annotations for the local variable V, declared by D.
3138 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3139
3140 /// Emit field annotations for the given field & value. Returns the
3141 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003142 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003143
3144 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003145 // Internal Helpers
3146 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003147
Chris Lattner5b1964b2008-11-11 07:41:27 +00003148 /// ContainsLabel - Return true if the statement contains a label in it. If
3149 /// this statement is not executed normally, it not containing a label means
3150 /// that we can just remove the code.
3151 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003152
Chris Lattner29911cc2011-02-28 00:18:40 +00003153 /// containsBreak - Return true if the statement contains a break out of it.
3154 /// If the statement (recursively) contains a switch or loop with a break
3155 /// inside of it, this is fine.
3156 static bool containsBreak(const Stmt *S);
3157
Daniel Dunbar682712c2008-11-12 10:12:14 +00003158 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003159 /// to a constant, or if it does but contains a label, return false. If it
3160 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003161 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3162 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003163
Chris Lattner29911cc2011-02-28 00:18:40 +00003164 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3165 /// to a constant, or if it does but contains a label, return false. If it
3166 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003167 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3168 bool AllowLabels = false);
3169
Chris Lattnercd439292008-11-12 08:04:58 +00003170 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3171 /// if statement) to the specified blocks. Based on the condition, this might
3172 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003173 /// TrueCount should be the number of times we expect the condition to
3174 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003175 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003176 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003177
Richard Smithe30752c2012-10-09 19:52:38 +00003178 /// \brief Emit a description of a type in a format suitable for passing to
3179 /// a runtime sanitizer handler.
3180 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3181
3182 /// \brief Convert a value into a format suitable for passing to a runtime
3183 /// sanitizer handler.
3184 llvm::Value *EmitCheckValue(llvm::Value *V);
3185
3186 /// \brief Emit a description of a source location in a format suitable for
3187 /// passing to a runtime sanitizer handler.
3188 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3189
Richard Smithde670682012-11-01 22:15:34 +00003190 /// \brief Create a basic block that will call a handler function in a
3191 /// sanitizer runtime with the provided arguments, and create a conditional
3192 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003193 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003194 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
3195 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003196
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003197 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3198 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003199 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3200 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3201 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003202
Richard Smithde670682012-11-01 22:15:34 +00003203 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3204 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003205 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003206
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003207 /// \brief Emit a call to trap or debugtrap and attach function attribute
3208 /// "trap-func-name" if specified.
3209 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3210
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003211 /// \brief Emit a cross-DSO CFI failure handling function.
3212 void EmitCfiCheckFail();
3213
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003214 /// \brief Create a check for a function parameter that may potentially be
3215 /// declared as non-null.
3216 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
3217 const FunctionDecl *FD, unsigned ParmNum);
3218
Anders Carlsson093bdff2010-03-30 03:27:09 +00003219 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003220 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003221
John McCall23f66262010-05-26 22:34:26 +00003222 /// EmitDelegateCallArg - We are performing a delegate call; that
3223 /// is, the current function is delegating to another one. Produce
3224 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003225 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3226 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003227
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003228 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3229 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003230 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003231
Chris Lattnercd439292008-11-12 08:04:58 +00003232private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003233 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003234 void EmitReturnOfRValue(RValue RV, QualType Ty);
3235
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003236 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3237
3238 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3239 DeferredReplacements;
3240
John McCall7f416cc2015-09-08 08:05:57 +00003241 /// Set the address of a local variable.
3242 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3243 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3244 LocalDeclMap.insert({VD, Addr});
3245 }
3246
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003247 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3248 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3249 ///
3250 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003251 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003252 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003253
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003254 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3255 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3256 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3257 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3258 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3259 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003260
Chad Rosier59df25b2012-08-23 20:00:18 +00003261 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003262 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003263
Chad Rosier59df25b2012-08-23 20:00:18 +00003264 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003265 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003266 std::string &ConstraintStr,
3267 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003268
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003269 /// \brief Attempts to statically evaluate the object size of E. If that
3270 /// fails, emits code to figure the size of E out for us. This is
3271 /// pass_object_size aware.
3272 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
3273 llvm::IntegerType *ResType);
3274
3275 /// \brief Emits the size of E, as required by __builtin_object_size. This
3276 /// function is aware of pass_object_size parameters, and will act accordingly
3277 /// if E is a parameter with the pass_object_size attribute.
3278 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
3279 llvm::IntegerType *ResType);
3280
Reid Kleckner89077a12013-12-17 19:46:40 +00003281public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003282#ifndef NDEBUG
3283 // Determine whether the given argument is an Objective-C method
3284 // that may have type parameters in its signature.
3285 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3286 const DeclContext *dc = method->getDeclContext();
3287 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3288 return classDecl->getTypeParamListAsWritten();
3289 }
3290
3291 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3292 return catDecl->getTypeParamList();
3293 }
3294
3295 return false;
3296 }
3297
3298 template<typename T>
3299 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3300#endif
3301
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003302 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003303 template <typename T>
3304 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003305 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003306 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00003307 unsigned ParamsToSkip = 0) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003308 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003309 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003310
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003311 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3312 "Can't skip parameters if type info is not provided");
3313 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003314#ifndef NDEBUG
3315 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3316#endif
3317
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003318 // First, use the argument types that the type info knows about
3319 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3320 E = CallArgTypeInfo->param_type_end();
3321 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003322 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003323 assert((isGenericMethod ||
3324 ((*I)->isVariablyModifiedType() ||
3325 (*I).getNonReferenceType()->isObjCRetainableType() ||
3326 getContext()
3327 .getCanonicalType((*I).getNonReferenceType())
3328 .getTypePtr() ==
3329 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003330 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003331 .getTypePtr())) &&
3332 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003333 ArgTypes.push_back(*I);
3334 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003335 }
Mike Stump11289f42009-09-09 15:08:12 +00003336
Reid Kleckner739756c2013-12-04 19:23:12 +00003337 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003338 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003339 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3340 CallArgTypeInfo->isVariadic()) &&
3341 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003342
Anders Carlsson603d6af2009-04-18 20:20:22 +00003343 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003344 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
3345 ArgTypes.push_back(getVarArgType(A));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003346
David Blaikief05779e2015-07-21 18:37:18 +00003347 EmitCallArgs(Args, ArgTypes, ArgRange, CalleeDecl, ParamsToSkip);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003348 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003349
Reid Kleckner739756c2013-12-04 19:23:12 +00003350 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003351 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003352 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00003353 unsigned ParamsToSkip = 0);
Reid Kleckner739756c2013-12-04 19:23:12 +00003354
John McCall7f416cc2015-09-08 08:05:57 +00003355 /// EmitPointerWithAlignment - Given an expression with a pointer
3356 /// type, emit the value and compute our best estimate of the
3357 /// alignment of the pointee.
3358 ///
3359 /// Note that this function will conservatively fall back on the type
3360 /// when it doesn't
3361 ///
3362 /// \param Source - If non-null, this will be initialized with
3363 /// information about the source of the alignment. Note that this
3364 /// function will conservatively fall back on the type when it
3365 /// doesn't recognize the expression, which means that sometimes
3366 ///
3367 /// a worst-case One
3368 /// reasonable way to use this information is when there's a
3369 /// language guarantee that the pointer must be aligned to some
3370 /// stricter value, and we're simply trying to ensure that
3371 /// sufficiently obvious uses of under-aligned objects don't get
3372 /// miscompiled; for example, a placement new into the address of
3373 /// a local variable. In such a case, it's quite reasonable to
3374 /// just ignore the returned alignment when it isn't from an
3375 /// explicit source.
3376 Address EmitPointerWithAlignment(const Expr *Addr,
3377 AlignmentSource *Source = nullptr);
3378
Peter Collingbournedc134532016-01-16 00:31:22 +00003379 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3380
Reid Kleckner89077a12013-12-17 19:46:40 +00003381private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003382 QualType getVarArgType(const Expr *Arg);
3383
John McCalld4f4b7f2010-03-03 04:15:11 +00003384 const TargetCodeGenInfo &getTargetHooks() const {
3385 return CGM.getTargetCodeGenInfo();
3386 }
John McCall09ae0322010-07-06 23:57:41 +00003387
3388 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003389
John McCall7f416cc2015-09-08 08:05:57 +00003390 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3391 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003392
3393 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003394
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003395 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003396};
Mike Stump11289f42009-09-09 15:08:12 +00003397
John McCallce1de612011-01-26 04:00:11 +00003398/// Helper class with most of the code for saving a value for a
3399/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003400struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003401 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3402
3403 /// Answer whether the given value needs extra work to be saved.
3404 static bool needsSaving(llvm::Value *value) {
3405 // If it's not an instruction, we don't need to save.
3406 if (!isa<llvm::Instruction>(value)) return false;
3407
3408 // If it's an instruction in the entry block, we don't need to save.
3409 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3410 return (block != &block->getParent()->getEntryBlock());
3411 }
3412
3413 /// Try to save the given value.
3414 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3415 if (!needsSaving(value)) return saved_type(value, false);
3416
John McCall7f416cc2015-09-08 08:05:57 +00003417 // Otherwise, we need an alloca.
3418 auto align = CharUnits::fromQuantity(
3419 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3420 Address alloca =
3421 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003422 CGF.Builder.CreateStore(value, alloca);
3423
John McCall7f416cc2015-09-08 08:05:57 +00003424 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003425 }
3426
3427 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003428 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003429 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003430
3431 // Otherwise, it should be an alloca instruction, as set up in save().
3432 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3433 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003434 }
3435};
3436
John McCallcb5f77f2011-01-28 10:53:53 +00003437/// A partial specialization of DominatingValue for llvm::Values that
3438/// might be llvm::Instructions.
3439template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3440 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003441 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003442 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3443 }
3444};
3445
John McCall7f416cc2015-09-08 08:05:57 +00003446/// A specialization of DominatingValue for Address.
3447template <> struct DominatingValue<Address> {
3448 typedef Address type;
3449
3450 struct saved_type {
3451 DominatingLLVMValue::saved_type SavedValue;
3452 CharUnits Alignment;
3453 };
3454
3455 static bool needsSaving(type value) {
3456 return DominatingLLVMValue::needsSaving(value.getPointer());
3457 }
3458 static saved_type save(CodeGenFunction &CGF, type value) {
3459 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3460 value.getAlignment() };
3461 }
3462 static type restore(CodeGenFunction &CGF, saved_type value) {
3463 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3464 value.Alignment);
3465 }
3466};
3467
John McCallcb5f77f2011-01-28 10:53:53 +00003468/// A specialization of DominatingValue for RValue.
3469template <> struct DominatingValue<RValue> {
3470 typedef RValue type;
3471 class saved_type {
3472 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3473 AggregateAddress, ComplexAddress };
3474
3475 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003476 unsigned K : 3;
3477 unsigned Align : 29;
3478 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3479 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003480
3481 public:
3482 static bool needsSaving(RValue value);
3483 static saved_type save(CodeGenFunction &CGF, RValue value);
3484 RValue restore(CodeGenFunction &CGF);
3485
John McCall7f416cc2015-09-08 08:05:57 +00003486 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003487 };
3488
3489 static bool needsSaving(type value) {
3490 return saved_type::needsSaving(value);
3491 }
3492 static saved_type save(CodeGenFunction &CGF, type value) {
3493 return saved_type::save(CGF, value);
3494 }
3495 static type restore(CodeGenFunction &CGF, saved_type value) {
3496 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003497 }
3498};
3499
Chris Lattnerbed31442007-05-28 01:07:47 +00003500} // end namespace CodeGen
3501} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003502
Chris Lattnerbed31442007-05-28 01:07:47 +00003503#endif