blob: 7a6fd93052b19079a49b90ff2e84895d1607bc76 [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"
Vitaly Buka64c80b42016-10-26 05:42:30 +000024#include "VarBypassDetector.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000025#include "clang/AST/CharUnits.h"
26#include "clang/AST/ExprCXX.h"
27#include "clang/AST/ExprObjC.h"
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +000028#include "clang/AST/ExprOpenMP.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000029#include "clang/AST/Type.h"
30#include "clang/Basic/ABI.h"
Ben Langmuir3b4c30b2013-05-09 19:17:11 +000031#include "clang/Basic/CapturedStmt.h"
Alexander Musmandf7a8e22015-01-22 08:49:35 +000032#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000033#include "clang/Basic/TargetInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000034#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000035#include "llvm/ADT/ArrayRef.h"
36#include "llvm/ADT/DenseMap.h"
37#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000038#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000039#include "llvm/Support/Debug.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000040#include "llvm/Transforms/Utils/SanitizerStats.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000041
Chris Lattnerbed31442007-05-28 01:07:47 +000042namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000043class BasicBlock;
44class LLVMContext;
45class MDNode;
46class Module;
47class SwitchInst;
48class Twine;
49class Value;
50class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000051}
52
Chris Lattnerbed31442007-05-28 01:07:47 +000053namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000054class ASTContext;
55class BlockDecl;
56class CXXDestructorDecl;
57class CXXForRangeStmt;
58class CXXTryStmt;
59class Decl;
60class LabelDecl;
61class EnumConstantDecl;
62class FunctionDecl;
63class FunctionProtoType;
64class LabelStmt;
65class ObjCContainerDecl;
66class ObjCInterfaceDecl;
67class ObjCIvarDecl;
68class ObjCMethodDecl;
69class ObjCImplementationDecl;
70class ObjCPropertyImplDecl;
71class TargetInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000072class VarDecl;
73class ObjCForCollectionStmt;
74class ObjCAtTryStmt;
75class ObjCAtThrowStmt;
76class ObjCAtSynchronizedStmt;
77class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000078
Chris Lattnerbed31442007-05-28 01:07:47 +000079namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000080class CodeGenTypes;
81class CGFunctionInfo;
82class CGRecordLayout;
83class CGBlockInfo;
84class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000085class BlockByrefHelpers;
86class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000087class BlockFlags;
88class BlockFieldFlags;
Alexey Bataev7292c292016-04-25 12:22:29 +000089class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000090class TargetCodeGenInfo;
Alexey Bataev24b5bae2016-04-28 09:23:51 +000091struct OMPTaskDataTy;
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000092struct CGCoroData;
Mike Stumpfc496822009-02-08 23:14:22 +000093
John McCall47fb9502013-03-07 21:37:08 +000094/// The kind of evaluation to perform on values of a particular
95/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
96/// CGExprAgg?
97///
98/// TODO: should vectors maybe be split out into their own thing?
99enum TypeEvaluationKind {
100 TEK_Scalar,
101 TEK_Complex,
102 TEK_Aggregate
103};
104
Chris Lattnerbed31442007-05-28 01:07:47 +0000105/// CodeGenFunction - This class organizes the per-function state that is used
106/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000107class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000108 CodeGenFunction(const CodeGenFunction &) = delete;
109 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000110
111 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000112public:
John McCallad5d61e2010-07-23 21:56:41 +0000113 /// A jump destination is an abstract label, branching to which may
114 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000115 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000116 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000117 JumpDest(llvm::BasicBlock *Block,
118 EHScopeStack::stable_iterator Depth,
119 unsigned Index)
120 : Block(Block), ScopeDepth(Depth), Index(Index) {}
121
Craig Topper8a13c412014-05-21 05:09:00 +0000122 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000123 llvm::BasicBlock *getBlock() const { return Block; }
124 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
125 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000126
Nadav Rotem1da30942013-03-23 06:43:35 +0000127 // This should be used cautiously.
128 void setScopeDepth(EHScopeStack::stable_iterator depth) {
129 ScopeDepth = depth;
130 }
131
John McCallad5d61e2010-07-23 21:56:41 +0000132 private:
John McCallbd309292010-07-06 01:34:17 +0000133 llvm::BasicBlock *Block;
134 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000135 unsigned Index;
136 };
137
Chris Lattnerbed31442007-05-28 01:07:47 +0000138 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000139 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000140
Chris Lattner96d72562007-08-21 16:57:55 +0000141 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000142 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000143 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000144
Vitaly Buka64c80b42016-10-26 05:42:30 +0000145 // Stores variables for which we can't generate correct lifetime markers
146 // because of jumps.
147 VarBypassDetector Bypasses;
148
Alexander Musman515ad8c2014-05-22 08:54:05 +0000149 /// \brief CGBuilder insert helper. This function is called after an
150 /// instruction is created using Builder.
151 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
152 llvm::BasicBlock *BB,
153 llvm::BasicBlock::iterator InsertPt) const;
154
John McCalldec348f72013-05-03 07:33:41 +0000155 /// CurFuncDecl - Holds the Decl for the current outermost
156 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000157 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000158 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
159 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000160 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000161 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000162 llvm::Function *CurFn;
163
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000164 // Holds coroutine data if the current function is a coroutine. We use a
165 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
166 // in this header.
167 struct CGCoroInfo {
168 std::unique_ptr<CGCoroData> Data;
169 CGCoroInfo();
170 ~CGCoroInfo();
171 };
172 CGCoroInfo CurCoro;
173
Mike Stumpbee78dd2009-12-04 23:26:17 +0000174 /// CurGD - The GlobalDecl for the current function being compiled.
175 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000176
John McCall31168b02011-06-15 23:02:42 +0000177 /// PrologueCleanupDepth - The cleanup depth enclosing all the
178 /// cleanups associated with the parameters.
179 EHScopeStack::stable_iterator PrologueCleanupDepth;
180
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000181 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000182 JumpDest ReturnBlock;
183
John McCall7f416cc2015-09-08 08:05:57 +0000184 /// ReturnValue - The temporary alloca to hold the return
185 /// value. This is invalid iff the function has no return value.
186 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000187
Chris Lattner03df1222007-06-02 04:53:11 +0000188 /// AllocaInsertPoint - This is an instruction in the entry block before which
189 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000190 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000191
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000192 /// \brief API for captured statement code generation.
193 class CGCapturedStmtInfo {
194 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000195 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
196 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000197 explicit CGCapturedStmtInfo(const CapturedStmt &S,
198 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000199 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000200
201 RecordDecl::field_iterator Field =
202 S.getCapturedRecordDecl()->field_begin();
203 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
204 E = S.capture_end();
205 I != E; ++I, ++Field) {
206 if (I->capturesThis())
207 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000208 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000209 CaptureFields[I->getCapturedVar()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000210 else if (I->capturesVariableByCopy())
211 CaptureFields[I->getCapturedVar()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000212 }
213 }
214
215 virtual ~CGCapturedStmtInfo();
216
217 CapturedRegionKind getKind() const { return Kind; }
218
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000219 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000220 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000221 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000222
223 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000224 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000225 return CaptureFields.lookup(VD);
226 }
227
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000228 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
229 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000230
Alexey Bataev18095712014-10-10 12:19:54 +0000231 static bool classof(const CGCapturedStmtInfo *) {
232 return true;
233 }
234
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000235 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000236 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000237 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000238 CGF.EmitStmt(S);
239 }
240
241 /// \brief Get the name of the capture helper.
242 virtual StringRef getHelperName() const { return "__captured_stmt"; }
243
244 private:
245 /// \brief The kind of captured statement being generated.
246 CapturedRegionKind Kind;
247
248 /// \brief Keep the map between VarDecl and FieldDecl.
249 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
250
251 /// \brief The base address of the captured record, passed in as the first
252 /// argument of the parallel region function.
253 llvm::Value *ThisValue;
254
255 /// \brief Captured 'this' type.
256 FieldDecl *CXXThisFieldDecl;
257 };
258 CGCapturedStmtInfo *CapturedStmtInfo;
259
Alexey Bataevd157d472015-06-24 03:35:38 +0000260 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
261 class CGCapturedStmtRAII {
262 private:
263 CodeGenFunction &CGF;
264 CGCapturedStmtInfo *PrevCapturedStmtInfo;
265 public:
266 CGCapturedStmtRAII(CodeGenFunction &CGF,
267 CGCapturedStmtInfo *NewCapturedStmtInfo)
268 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
269 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
270 }
271 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
272 };
273
Alexey Samsonova0416102014-11-11 01:26:14 +0000274 /// \brief Sanitizers enabled for this function.
275 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000276
Alexey Samsonov24cad992014-07-17 18:46:27 +0000277 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
278 bool IsSanitizerScope;
279
280 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
281 class SanitizerScope {
282 CodeGenFunction *CGF;
283 public:
284 SanitizerScope(CodeGenFunction *CGF);
285 ~SanitizerScope();
286 };
287
Reid Kleckner19819442014-07-25 21:39:46 +0000288 /// In C++, whether we are code generating a thunk. This controls whether we
289 /// should emit cleanups.
290 bool CurFuncIsThunk;
291
John McCall31168b02011-06-15 23:02:42 +0000292 /// In ARC, whether we should autorelease the return value.
293 bool AutoreleaseResult;
294
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000295 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
296 /// potentially set the return value.
297 bool SawAsmBlock;
298
David Majnemer25eb1652016-03-01 19:42:53 +0000299 const FunctionDecl *CurSEHParent = nullptr;
300
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000301 /// True if the current function is an outlined SEH helper. This can be a
302 /// finally block or filter expression.
303 bool IsOutlinedSEHHelper;
304
John McCallad7c5c12011-02-08 08:22:06 +0000305 const CodeGen::CGBlockInfo *BlockInfo;
306 llvm::Value *BlockPointer;
307
Eli Friedman9fbeba02012-02-11 02:57:39 +0000308 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
309 FieldDecl *LambdaThisCaptureField;
310
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000311 /// \brief A mapping from NRVO variables to the flags used to indicate
312 /// when the NRVO has been applied to this variable.
313 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000314
John McCallbd309292010-07-06 01:34:17 +0000315 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000316 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000317 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000318
David Majnemer4e52d6f2015-12-12 05:39:21 +0000319 llvm::Instruction *CurrentFuncletPad = nullptr;
320
Tim Shen421119f2016-07-01 21:08:47 +0000321 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
322 llvm::Value *Addr;
323 llvm::Value *Size;
324
325 public:
326 CallLifetimeEnd(Address addr, llvm::Value *size)
327 : Addr(addr.getPointer()), Size(size) {}
328
329 void Emit(CodeGenFunction &CGF, Flags flags) override {
330 CGF.EmitLifetimeEnd(Size, Addr);
331 }
332 };
333
Richard Smith736a9472013-06-12 20:42:33 +0000334 /// Header for data within LifetimeExtendedCleanupStack.
335 struct LifetimeExtendedCleanupHeader {
336 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000337 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000338 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000339 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000340
Justin Bognerbdff2192015-07-01 00:59:27 +0000341 size_t getSize() const { return Size; }
342 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000343 };
John McCallbd309292010-07-06 01:34:17 +0000344
John McCallad5d61e2010-07-23 21:56:41 +0000345 /// i32s containing the indexes of the cleanup destinations.
346 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000347
348 unsigned NextCleanupDestIndex;
349
John McCall08ef4662011-11-10 08:15:53 +0000350 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
351 CGBlockInfo *FirstBlockInfo;
352
John McCall8e4c74b2011-08-11 02:22:43 +0000353 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
354 llvm::BasicBlock *EHResumeBlock;
355
Bill Wendlingf0724e82011-09-19 20:31:14 +0000356 /// The exception slot. All landing pads write the current exception pointer
357 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000358 llvm::Value *ExceptionSlot;
359
Bill Wendlingf0724e82011-09-19 20:31:14 +0000360 /// The selector slot. Under the MandatoryCleanup model, all landing pads
361 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000362 llvm::AllocaInst *EHSelectorSlot;
363
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000364 /// A stack of exception code slots. Entering an __except block pushes a slot
365 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
366 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000367 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000368
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000369 /// Value returned by __exception_info intrinsic.
370 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000371
John McCallbd309292010-07-06 01:34:17 +0000372 /// Emits a landing pad for the current EH stack.
373 llvm::BasicBlock *EmitLandingPad();
374
375 llvm::BasicBlock *getInvokeDestImpl();
376
John McCallce1de612011-01-26 04:00:11 +0000377 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000378 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
379 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000380 }
381
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000382public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000383 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
384 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000385 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000386
John McCall6b0feb72011-06-22 02:32:12 +0000387 /// A class controlling the emission of a finally block.
388 class FinallyInfo {
389 /// Where the catchall's edge through the cleanup should go.
390 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000391
John McCall6b0feb72011-06-22 02:32:12 +0000392 /// A function to call to enter the catch.
393 llvm::Constant *BeginCatchFn;
394
395 /// An i1 variable indicating whether or not the @finally is
396 /// running for an exception.
397 llvm::AllocaInst *ForEHVar;
398
399 /// An i8* variable into which the exception pointer to rethrow
400 /// has been saved.
401 llvm::AllocaInst *SavedExnVar;
402
403 public:
404 void enter(CodeGenFunction &CGF, const Stmt *Finally,
405 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
406 llvm::Constant *rethrowFn);
407 void exit(CodeGenFunction &CGF);
408 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000409
Reid Kleckner11c033e2015-02-12 23:40:45 +0000410 /// Returns true inside SEH __try blocks.
411 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
412
Reid Klecknera002bd52015-10-28 23:06:42 +0000413 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000414 bool isCleanupPadScope() const {
415 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
416 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000417
John McCallce1de612011-01-26 04:00:11 +0000418 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
419 /// current full-expression. Safe against the possibility that
420 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000421 template <class T, class... As>
422 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000423 // If we're not in a conditional branch, or if none of the
424 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000425 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000426 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000427
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000428 // Stash values in a tuple so we can guarantee the order of saves.
429 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
430 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000431
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000432 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000433 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000434 initFullExprCleanup();
435 }
436
Richard Smith736a9472013-06-12 20:42:33 +0000437 /// \brief Queue a cleanup to be pushed after finishing the current
438 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000439 template <class T, class... As>
440 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000441 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
442
443 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
444
445 size_t OldSize = LifetimeExtendedCleanupStack.size();
446 LifetimeExtendedCleanupStack.resize(
447 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
448
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000449 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000450 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000451 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
452 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000453 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000454 }
455
John McCallf4beacd2011-11-10 10:43:54 +0000456 /// Set up the last cleaup that was pushed as a conditional
457 /// full-expression cleanup.
458 void initFullExprCleanup();
459
John McCallbd309292010-07-06 01:34:17 +0000460 /// PushDestructorCleanup - Push a cleanup to call the
461 /// complete-object destructor of an object of the given type at the
462 /// given address. Does nothing if T is not a C++ class type with a
463 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000464 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000465
John McCall8680f872010-07-21 06:29:51 +0000466 /// PushDestructorCleanup - Push a cleanup to call the
467 /// complete-object variant of the given destructor on the object at
468 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000469 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000470
John McCallbd309292010-07-06 01:34:17 +0000471 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
472 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000473 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000474
John McCall824c2f52010-09-14 07:57:04 +0000475 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
476 /// The block cannot be reactivated. Pops it if it's the top of the
477 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000478 ///
479 /// \param DominatingIP - An instruction which is known to
480 /// dominate the current IP (if set) and which lies along
481 /// all paths of execution between the current IP and the
482 /// the point at which the cleanup comes into scope.
483 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
484 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000485
486 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
487 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000488 ///
489 /// \param DominatingIP - An instruction which is known to
490 /// dominate the current IP (if set) and which lies along
491 /// all paths of execution between the current IP and the
492 /// the point at which the cleanup comes into scope.
493 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
494 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000495
John McCallbd309292010-07-06 01:34:17 +0000496 /// \brief Enters a new scope for capturing cleanups, all of which
497 /// will be executed once the scope is exited.
498 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000499 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000500 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000501 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000502 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000503 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000504 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000505
Aaron Ballmanabc18922015-02-15 22:54:08 +0000506 RunCleanupsScope(const RunCleanupsScope &) = delete;
507 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000508
Eric Christophera9d34972011-10-19 00:43:52 +0000509 protected:
510 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000511
Douglas Gregor965f4502009-11-24 16:43:22 +0000512 public:
513 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000514 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000515 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000516 {
John McCallbd309292010-07-06 01:34:17 +0000517 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000518 LifetimeExtendedCleanupStackSize =
519 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000520 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000521 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000522 }
523
524 /// \brief Exit this cleanup scope, emitting any accumulated
525 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000526 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000527 if (PerformCleanup) {
528 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000529 CGF.PopCleanupBlocks(CleanupStackDepth,
530 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000531 }
532 }
533
534 /// \brief Determine whether this scope requires any cleanups.
535 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000536 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000537 }
538
539 /// \brief Force the emission of cleanups now, instead of waiting
540 /// until this object is destroyed.
541 void ForceCleanup() {
542 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000543 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000544 CGF.PopCleanupBlocks(CleanupStackDepth,
545 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000546 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000547 }
548 };
549
David Blaikie93be0b22014-08-22 21:37:04 +0000550 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000551 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000552 SmallVector<const LabelDecl*, 4> Labels;
553 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000554
Aaron Ballmanabc18922015-02-15 22:54:08 +0000555 LexicalScope(const LexicalScope &) = delete;
556 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000557
558 public:
559 /// \brief Enter a new cleanup scope.
560 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000561 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
562 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000563 if (CGDebugInfo *DI = CGF.getDebugInfo())
564 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
565 }
566
Nadav Rotem1da30942013-03-23 06:43:35 +0000567 void addLabel(const LabelDecl *label) {
568 assert(PerformCleanup && "adding label to dead scope?");
569 Labels.push_back(label);
570 }
571
Eric Christophera9d34972011-10-19 00:43:52 +0000572 /// \brief Exit this cleanup scope, emitting any accumulated
573 /// cleanups.
574 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000575 if (CGDebugInfo *DI = CGF.getDebugInfo())
576 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
577
Nadav Rotem1da30942013-03-23 06:43:35 +0000578 // If we should perform a cleanup, force them now. Note that
579 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000580 if (PerformCleanup) {
581 ApplyDebugLocation DL(CGF, Range.getEnd());
582 ForceCleanup();
583 }
Eric Christophera9d34972011-10-19 00:43:52 +0000584 }
585
586 /// \brief Force the emission of cleanups now, instead of waiting
587 /// until this object is destroyed.
588 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000589 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000590 RunCleanupsScope::ForceCleanup();
591
Nadav Rotem1da30942013-03-23 06:43:35 +0000592 if (!Labels.empty())
593 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000594 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000595
596 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000597 };
598
John McCall7f416cc2015-09-08 08:05:57 +0000599 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
600
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000601 /// \brief The scope used to remap some variables as private in the OpenMP
602 /// loop body (or other captured region emitted without outlining), and to
603 /// restore old vars back on exit.
604 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000605 DeclMapTy SavedLocals;
606 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000607
608 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000609 OMPPrivateScope(const OMPPrivateScope &) = delete;
610 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000611
612 public:
613 /// \brief Enter a new OpenMP private scope.
614 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
615
616 /// \brief Registers \a LocalVD variable as a private and apply \a
617 /// PrivateGen function for it to generate corresponding private variable.
618 /// \a PrivateGen returns an address of the generated private variable.
619 /// \return true if the variable is registered as private, false if it has
620 /// been privatized already.
621 bool
622 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000623 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000624 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000625
626 // Only save it once.
627 if (SavedLocals.count(LocalVD)) return false;
628
629 // Copy the existing local entry to SavedLocals.
630 auto it = CGF.LocalDeclMap.find(LocalVD);
631 if (it != CGF.LocalDeclMap.end()) {
632 SavedLocals.insert({LocalVD, it->second});
633 } else {
634 SavedLocals.insert({LocalVD, Address::invalid()});
635 }
636
637 // Generate the private entry.
638 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000639 QualType VarTy = LocalVD->getType();
640 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000641 Address Temp = CGF.CreateMemTemp(VarTy);
642 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
643 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000644 }
John McCall7f416cc2015-09-08 08:05:57 +0000645 SavedPrivates.insert({LocalVD, Addr});
646
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000647 return true;
648 }
649
650 /// \brief Privatizes local variables previously registered as private.
651 /// Registration is separate from the actual privatization to allow
652 /// initializers use values of the original variables, not the private one.
653 /// This is important, for example, if the private variable is a class
654 /// variable initialized by a constructor that references other private
655 /// variables. But at initialization original variables must be used, not
656 /// private copies.
657 /// \return true if at least one variable was privatized, false otherwise.
658 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000659 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000660 SavedPrivates.clear();
661 return !SavedLocals.empty();
662 }
663
664 void ForceCleanup() {
665 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000666 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000667 SavedLocals.clear();
668 }
669
670 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000671 ~OMPPrivateScope() {
672 if (PerformCleanup)
673 ForceCleanup();
674 }
John McCall7f416cc2015-09-08 08:05:57 +0000675
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000676 /// Checks if the global variable is captured in current function.
677 bool isGlobalVarCaptured(const VarDecl *VD) const {
678 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
679 }
680
John McCall7f416cc2015-09-08 08:05:57 +0000681 private:
682 /// Copy all the entries in the source map over the corresponding
683 /// entries in the destination, which must exist.
684 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
685 for (auto &pair : src) {
686 if (!pair.second.isValid()) {
687 dest.erase(pair.first);
688 continue;
689 }
690
691 auto it = dest.find(pair.first);
692 if (it != dest.end()) {
693 it->second = pair.second;
694 } else {
695 dest.insert(pair);
696 }
697 }
698 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000699 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000700
Richard Smith736a9472013-06-12 20:42:33 +0000701 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
702 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000703 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000704
Richard Smith736a9472013-06-12 20:42:33 +0000705 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
706 /// that have been added, then adds all lifetime-extended cleanups from
707 /// the given position to the stack.
708 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
709 size_t OldLifetimeExtendedStackSize);
710
John McCallad5d61e2010-07-23 21:56:41 +0000711 void ResolveBranchFixups(llvm::BasicBlock *Target);
712
John McCallbd309292010-07-06 01:34:17 +0000713 /// The given basic block lies in the current EH scope, but may be a
714 /// target of a potentially scope-crossing jump; get a stable handle
715 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000716 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000717 return JumpDest(Target,
718 EHStack.getInnermostNormalCleanup(),
719 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000720 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000721
John McCallbd309292010-07-06 01:34:17 +0000722 /// The given basic block lies in the current EH scope, but may be a
723 /// target of a potentially scope-crossing jump; get a stable handle
724 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000725 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000726 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000727 }
728
729 /// EmitBranchThroughCleanup - Emit a branch from the current insert
730 /// block through the normal cleanup handling code (if any) and then
731 /// on to \arg Dest.
732 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000733
Justin Bognere25ffdf2014-01-21 00:35:11 +0000734 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
735 /// specified destination obviously has no cleanups to run. 'false' is always
736 /// a conservatively correct answer for this method.
737 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
738
John McCall8e4c74b2011-08-11 02:22:43 +0000739 /// popCatchScope - Pops the catch scope at the top of the EHScope
740 /// stack, emitting any required code (other than the catch handlers
741 /// themselves).
742 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000743
David Chisnall9a837be2012-11-07 16:50:40 +0000744 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000745 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000746 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000747
John McCallce1de612011-01-26 04:00:11 +0000748 /// An object to manage conditionally-evaluated expressions.
749 class ConditionalEvaluation {
750 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000751
John McCallce1de612011-01-26 04:00:11 +0000752 public:
753 ConditionalEvaluation(CodeGenFunction &CGF)
754 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000755
John McCallce1de612011-01-26 04:00:11 +0000756 void begin(CodeGenFunction &CGF) {
757 assert(CGF.OutermostConditional != this);
758 if (!CGF.OutermostConditional)
759 CGF.OutermostConditional = this;
760 }
761
762 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000763 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000764 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000765 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000766 }
767
768 /// Returns a block which will be executed prior to each
769 /// evaluation of the conditional code.
770 llvm::BasicBlock *getStartingBlock() const {
771 return StartBB;
772 }
773 };
Mike Stump11289f42009-09-09 15:08:12 +0000774
John McCall7f9c92a2010-09-17 00:50:28 +0000775 /// isInConditionalBranch - Return true if we're currently emitting
776 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000777 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000778
John McCall7f416cc2015-09-08 08:05:57 +0000779 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000780 assert(isInConditionalBranch());
781 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000782 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
783 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000784 }
785
John McCallce1de612011-01-26 04:00:11 +0000786 /// An RAII object to record that we're evaluating a statement
787 /// expression.
788 class StmtExprEvaluation {
789 CodeGenFunction &CGF;
790
791 /// We have to save the outermost conditional: cleanups in a
792 /// statement expression aren't conditional just because the
793 /// StmtExpr is.
794 ConditionalEvaluation *SavedOutermostConditional;
795
796 public:
797 StmtExprEvaluation(CodeGenFunction &CGF)
798 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000799 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000800 }
801
802 ~StmtExprEvaluation() {
803 CGF.OutermostConditional = SavedOutermostConditional;
804 CGF.EnsureInsertPoint();
805 }
806 };
John McCall1bf58462011-02-16 08:02:54 +0000807
John McCallc07a0c72011-02-17 10:25:35 +0000808 /// An object which temporarily prevents a value from being
809 /// destroyed by aggressive peephole optimizations that assume that
810 /// all uses of a value have been realized in the IR.
811 class PeepholeProtection {
812 llvm::Instruction *Inst;
813 friend class CodeGenFunction;
814
815 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000816 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000817 };
John McCallc07a0c72011-02-17 10:25:35 +0000818
John McCallfe96e0b2011-11-06 09:01:30 +0000819 /// A non-RAII class containing all the information about a bound
820 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
821 /// this which makes individual mappings very simple; using this
822 /// class directly is useful when you have a variable number of
823 /// opaque values or don't want the RAII functionality for some
824 /// reason.
825 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000826 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000827 bool BoundLValue;
828 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000829
John McCallfe96e0b2011-11-06 09:01:30 +0000830 OpaqueValueMappingData(const OpaqueValueExpr *ov,
831 bool boundLValue)
832 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000833 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000834 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000835
John McCallc07a0c72011-02-17 10:25:35 +0000836 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000837 // gl-values should be bound as l-values for obvious reasons.
838 // Records should be bound as l-values because IR generation
839 // always keeps them in memory. Expressions of function type
840 // act exactly like l-values but are formally required to be
841 // r-values in C.
842 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000843 expr->getType()->isFunctionType() ||
844 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000845 }
846
John McCallfe96e0b2011-11-06 09:01:30 +0000847 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
848 const OpaqueValueExpr *ov,
849 const Expr *e) {
850 if (shouldBindAsLValue(ov))
851 return bind(CGF, ov, CGF.EmitLValue(e));
852 return bind(CGF, ov, CGF.EmitAnyExpr(e));
853 }
854
855 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
856 const OpaqueValueExpr *ov,
857 const LValue &lv) {
858 assert(shouldBindAsLValue(ov));
859 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
860 return OpaqueValueMappingData(ov, true);
861 }
862
863 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
864 const OpaqueValueExpr *ov,
865 const RValue &rv) {
866 assert(!shouldBindAsLValue(ov));
867 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
868
869 OpaqueValueMappingData data(ov, false);
870
871 // Work around an extremely aggressive peephole optimization in
872 // EmitScalarConversion which assumes that all other uses of a
873 // value are extant.
874 data.Protection = CGF.protectFromPeepholes(rv);
875
876 return data;
877 }
878
Craig Topper8a13c412014-05-21 05:09:00 +0000879 bool isValid() const { return OpaqueValue != nullptr; }
880 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000881
882 void unbind(CodeGenFunction &CGF) {
883 assert(OpaqueValue && "no data to unbind!");
884
885 if (BoundLValue) {
886 CGF.OpaqueLValues.erase(OpaqueValue);
887 } else {
888 CGF.OpaqueRValues.erase(OpaqueValue);
889 CGF.unprotectFromPeepholes(Protection);
890 }
891 }
892 };
893
894 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
895 class OpaqueValueMapping {
896 CodeGenFunction &CGF;
897 OpaqueValueMappingData Data;
898
899 public:
900 static bool shouldBindAsLValue(const Expr *expr) {
901 return OpaqueValueMappingData::shouldBindAsLValue(expr);
902 }
903
John McCallc07a0c72011-02-17 10:25:35 +0000904 /// Build the opaque value mapping for the given conditional
905 /// operator if it's the GNU ?: extension. This is a common
906 /// enough pattern that the convenience operator is really
907 /// helpful.
908 ///
909 OpaqueValueMapping(CodeGenFunction &CGF,
910 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000911 if (isa<ConditionalOperator>(op))
912 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000913 return;
John McCallc07a0c72011-02-17 10:25:35 +0000914
915 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000916 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
917 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000918 }
919
John McCall1bf58462011-02-16 08:02:54 +0000920 OpaqueValueMapping(CodeGenFunction &CGF,
921 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000922 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000923 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000924 }
925
926 OpaqueValueMapping(CodeGenFunction &CGF,
927 const OpaqueValueExpr *opaqueValue,
928 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000929 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000930 }
931
932 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000933 Data.unbind(CGF);
934 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000935 }
936
937 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000938 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000939 }
940 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000941
Chris Lattner2da04b32007-08-24 05:35:26 +0000942private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000943 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000944 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000945
John McCall9b382dd2011-05-28 21:13:02 +0000946 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
947 /// calling llvm.stacksave for multiple VLAs in the same scope.
948 bool DidCallStackSave;
949
Mike Stumpe5311b02009-11-30 20:08:49 +0000950 /// IndirectBranch - The first time an indirect goto is seen we create a block
951 /// with an indirect branch. Every time we see the address of a label taken,
952 /// we add the label to the indirect goto. Every subsequent indirect goto is
953 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000954 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000955
Mike Stumpfc496822009-02-08 23:14:22 +0000956 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
957 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000958 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000959
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000960 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
961 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
962 /// parameter.
963 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
964 SizeArguments;
965
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000966 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000967 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000968 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
969
Chris Lattnerac248202007-05-30 00:13:02 +0000970 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000971 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000972
Mike Stumpfc496822009-02-08 23:14:22 +0000973 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000974 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000975 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000976 BreakContinue(JumpDest Break, JumpDest Continue)
977 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000978
John McCallbd309292010-07-06 01:34:17 +0000979 JumpDest BreakBlock;
980 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000981 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000982 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000983
Justin Bogneref512b92014-01-06 22:27:43 +0000984 CodeGenPGO PGO;
985
Justin Bogner65512642015-05-02 05:00:55 +0000986 /// Calculate branch weights appropriate for PGO data
987 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
988 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
989 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
990 uint64_t LoopCount);
991
Justin Bogneref512b92014-01-06 22:27:43 +0000992public:
Justin Bogner66242d62015-04-23 23:06:47 +0000993 /// Increment the profiler's counter for the given statement.
994 void incrementProfileCounter(const Stmt *S) {
Rong Xu9837ef52016-02-04 18:39:09 +0000995 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Justin Bogner66242d62015-04-23 23:06:47 +0000996 PGO.emitCounterIncrement(Builder, S);
997 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +0000998 }
Justin Bogner66242d62015-04-23 23:06:47 +0000999
1000 /// Get the profiler's count for the given statement.
1001 uint64_t getProfileCount(const Stmt *S) {
1002 Optional<uint64_t> Count = PGO.getStmtCount(S);
1003 if (!Count.hasValue())
1004 return 0;
1005 return *Count;
1006 }
1007
1008 /// Set the profiler's current count.
1009 void setCurrentProfileCount(uint64_t Count) {
1010 PGO.setCurrentRegionCount(Count);
1011 }
1012
1013 /// Get the profiler's current count. This is generally the count for the most
1014 /// recently incremented counter.
1015 uint64_t getCurrentProfileCount() {
1016 return PGO.getCurrentRegionCount();
1017 }
1018
Justin Bogneref512b92014-01-06 22:27:43 +00001019private:
1020
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001021 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001022 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001023 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001024 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1025 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001026
Mike Stumpfc496822009-02-08 23:14:22 +00001027 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001028 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001029 llvm::BasicBlock *CaseRangeBlock;
1030
John McCallc07a0c72011-02-17 10:25:35 +00001031 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001032 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001033 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1034 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001035
Mike Stumpfc496822009-02-08 23:14:22 +00001036 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001037 // We track this by the size expression rather than the type itself because
1038 // in certain situations, like a const qualifier applied to an VLA typedef,
1039 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001040 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1041 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001042 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001043
John McCallbd309292010-07-06 01:34:17 +00001044 /// A block containing a single 'unreachable' instruction. Created
1045 /// lazily by getUnreachableBlock().
1046 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001047
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001048 /// Counts of the number return expressions in the function.
1049 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001050
1051 /// Count the number of simple (constant) return expressions in the function.
1052 unsigned NumSimpleReturnExprs;
1053
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001054 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001055 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001056
Richard Smith852c9db2013-04-20 22:23:05 +00001057public:
1058 /// A scope within which we are constructing the fields of an object which
1059 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1060 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1061 class FieldConstructionScope {
1062 public:
John McCall7f416cc2015-09-08 08:05:57 +00001063 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001064 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1065 CGF.CXXDefaultInitExprThis = This;
1066 }
1067 ~FieldConstructionScope() {
1068 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1069 }
1070
1071 private:
1072 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001073 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001074 };
1075
1076 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1077 /// is overridden to be the object under construction.
1078 class CXXDefaultInitExprScope {
1079 public:
1080 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001081 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1082 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1083 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1084 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001085 }
1086 ~CXXDefaultInitExprScope() {
1087 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001088 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001089 }
1090
1091 public:
1092 CodeGenFunction &CGF;
1093 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001094 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001095 };
1096
Richard Smith5179eb72016-06-28 19:03:57 +00001097 class InlinedInheritingConstructorScope {
1098 public:
1099 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1100 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1101 OldCurCodeDecl(CGF.CurCodeDecl),
1102 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1103 OldCXXABIThisValue(CGF.CXXABIThisValue),
1104 OldCXXThisValue(CGF.CXXThisValue),
1105 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1106 OldCXXThisAlignment(CGF.CXXThisAlignment),
1107 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1108 OldCXXInheritedCtorInitExprArgs(
1109 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1110 CGF.CurGD = GD;
1111 CGF.CurFuncDecl = CGF.CurCodeDecl =
1112 cast<CXXConstructorDecl>(GD.getDecl());
1113 CGF.CXXABIThisDecl = nullptr;
1114 CGF.CXXABIThisValue = nullptr;
1115 CGF.CXXThisValue = nullptr;
1116 CGF.CXXABIThisAlignment = CharUnits();
1117 CGF.CXXThisAlignment = CharUnits();
1118 CGF.ReturnValue = Address::invalid();
1119 CGF.FnRetTy = QualType();
1120 CGF.CXXInheritedCtorInitExprArgs.clear();
1121 }
1122 ~InlinedInheritingConstructorScope() {
1123 CGF.CurGD = OldCurGD;
1124 CGF.CurFuncDecl = OldCurFuncDecl;
1125 CGF.CurCodeDecl = OldCurCodeDecl;
1126 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1127 CGF.CXXABIThisValue = OldCXXABIThisValue;
1128 CGF.CXXThisValue = OldCXXThisValue;
1129 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1130 CGF.CXXThisAlignment = OldCXXThisAlignment;
1131 CGF.ReturnValue = OldReturnValue;
1132 CGF.FnRetTy = OldFnRetTy;
1133 CGF.CXXInheritedCtorInitExprArgs =
1134 std::move(OldCXXInheritedCtorInitExprArgs);
1135 }
1136
1137 private:
1138 CodeGenFunction &CGF;
1139 GlobalDecl OldCurGD;
1140 const Decl *OldCurFuncDecl;
1141 const Decl *OldCurCodeDecl;
1142 ImplicitParamDecl *OldCXXABIThisDecl;
1143 llvm::Value *OldCXXABIThisValue;
1144 llvm::Value *OldCXXThisValue;
1145 CharUnits OldCXXABIThisAlignment;
1146 CharUnits OldCXXThisAlignment;
1147 Address OldReturnValue;
1148 QualType OldFnRetTy;
1149 CallArgList OldCXXInheritedCtorInitExprArgs;
1150 };
1151
Richard Smith852c9db2013-04-20 22:23:05 +00001152private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001153 /// CXXThisDecl - When generating code for a C++ member function,
1154 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001155 ImplicitParamDecl *CXXABIThisDecl;
1156 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001157 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001158 CharUnits CXXABIThisAlignment;
1159 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001160
Richard Smith852c9db2013-04-20 22:23:05 +00001161 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1162 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001163 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001164
Richard Smith5179eb72016-06-28 19:03:57 +00001165 /// The values of function arguments to use when evaluating
1166 /// CXXInheritedCtorInitExprs within this context.
1167 CallArgList CXXInheritedCtorInitExprArgs;
1168
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001169 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1170 /// destructor, this will hold the implicit argument (e.g. VTT).
1171 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1172 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001173
John McCallce1de612011-01-26 04:00:11 +00001174 /// OutermostConditional - Points to the outermost active
1175 /// conditional control. This is used so that we know if a
1176 /// temporary should be destroyed conditionally.
1177 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001178
Nadav Rotem1da30942013-03-23 06:43:35 +00001179 /// The current lexical scope.
1180 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001181
Adrian Prantldc237b52013-05-16 00:41:26 +00001182 /// The current source location that should be used for exception
1183 /// handling code.
1184 SourceLocation CurEHLocation;
1185
John McCall7f416cc2015-09-08 08:05:57 +00001186 /// BlockByrefInfos - For each __block variable, contains
1187 /// information about the layout of the variable.
1188 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001189
John McCallbd309292010-07-06 01:34:17 +00001190 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001191 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001192 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001193
Vitaly Buka1c943322016-10-26 01:59:57 +00001194 /// True if we need emit the life-time markers.
1195 const bool ShouldEmitLifetimeMarkers;
1196
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001197 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1198 /// In the kernel metadata node, reference the kernel function and metadata
1199 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001200 /// - A node for the vec_type_hint(<type>) qualifier contains string
1201 /// "vec_type_hint", an undefined value of the <type> data type,
1202 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001203 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1204 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1205 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1206 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1207 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1208 llvm::Function *Fn);
1209
Chris Lattnerbed31442007-05-28 01:07:47 +00001210public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001211 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001212 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001213
John McCall8ed55a52010-09-02 09:58:18 +00001214 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001215 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001216 CGDebugInfo *getDebugInfo() {
1217 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001218 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001219 return DebugInfo;
1220 }
1221 void disableDebugInfo() { DisableDebugInfo = true; }
1222 void enableDebugInfo() { DisableDebugInfo = false; }
1223
John McCall31168b02011-06-15 23:02:42 +00001224 bool shouldUseFusedARCCalls() {
1225 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1226 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001227
David Blaikiebbafb8a2012-03-11 07:00:24 +00001228 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001229
Bill Wendlingf0724e82011-09-19 20:31:14 +00001230 /// Returns a pointer to the function's exception object and selector slot,
1231 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001232 Address getExceptionSlot();
1233 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001234
Bill Wendling79a70e42011-09-15 18:57:19 +00001235 /// Returns the contents of the function's exception object and selector
1236 /// slots.
1237 llvm::Value *getExceptionFromSlot();
1238 llvm::Value *getSelectorFromSlot();
1239
John McCall7f416cc2015-09-08 08:05:57 +00001240 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001241
John McCallbd309292010-07-06 01:34:17 +00001242 llvm::BasicBlock *getUnreachableBlock() {
1243 if (!UnreachableBlock) {
1244 UnreachableBlock = createBasicBlock("unreachable");
1245 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1246 }
1247 return UnreachableBlock;
1248 }
1249
1250 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001251 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001252 return getInvokeDestImpl();
1253 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001254
David Majnemer25eb1652016-03-01 19:42:53 +00001255 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001256
John McCallc8e01702013-04-16 22:48:15 +00001257 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001258 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001259
Daniel Dunbar12347492009-02-23 17:26:39 +00001260 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001261 // Cleanups
1262 //===--------------------------------------------------------------------===//
1263
John McCall7f416cc2015-09-08 08:05:57 +00001264 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001265
John McCall178360e2011-07-11 08:38:19 +00001266 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001267 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001268 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001269 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001270 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001271 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1272 llvm::Value *arrayEnd,
1273 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001274 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001275 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001276
John McCall4bd0fb12011-07-12 16:41:08 +00001277 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001278 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001279 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001280 Address addr, QualType type);
1281 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001282 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001283 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001284 QualType type, Destroyer *destroyer,
1285 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001286 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1287 llvm::Value *CompletePtr,
1288 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001289 void pushStackRestore(CleanupKind kind, Address SPMem);
1290 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001291 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001292 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001293 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001294 bool useEHCleanupForArray,
1295 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001296 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001297 QualType elementType, CharUnits elementAlign,
1298 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001299 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001300
Peter Collingbourne1425b452012-01-26 03:33:36 +00001301 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001302
John McCall82fe67b2011-07-09 01:37:26 +00001303 /// Determines whether an EH cleanup is required to destroy a type
1304 /// with the given destruction kind.
1305 bool needsEHCleanup(QualType::DestructionKind kind) {
1306 switch (kind) {
1307 case QualType::DK_none:
1308 return false;
1309 case QualType::DK_cxx_destructor:
1310 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001311 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001312 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001313 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001314 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1315 }
1316 llvm_unreachable("bad destruction kind");
1317 }
1318
John McCall4bd0fb12011-07-12 16:41:08 +00001319 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1320 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1321 }
1322
John McCall82fe67b2011-07-09 01:37:26 +00001323 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001324 // Objective-C
1325 //===--------------------------------------------------------------------===//
1326
Chris Lattner4bd55962008-03-30 23:03:07 +00001327 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001328
David Blaikief1425802015-01-14 00:04:42 +00001329 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001330
Mike Stumpfc496822009-02-08 23:14:22 +00001331 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001332 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1333 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001334 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001335 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001336 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001337 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001338
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001339 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1340 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001341
Mike Stumpfc496822009-02-08 23:14:22 +00001342 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1343 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001344 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1345 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001346 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001347 const ObjCPropertyImplDecl *propImpl,
1348 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001349
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001350 //===--------------------------------------------------------------------===//
1351 // Block Bits
1352 //===--------------------------------------------------------------------===//
1353
John McCall351762c2011-02-07 10:33:21 +00001354 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001355 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1356 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001357
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001358 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001359 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001360 const DeclMapTy &ldm,
1361 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001362
John McCallad7c5c12011-02-08 08:22:06 +00001363 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1364 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001365 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1366 const ObjCPropertyImplDecl *PID);
1367 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1368 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001369 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001370
John McCallad7c5c12011-02-08 08:22:06 +00001371 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1372
John McCall73064872011-03-31 01:59:53 +00001373 class AutoVarEmission;
1374
1375 void emitByrefStructureInit(const AutoVarEmission &emission);
1376 void enterByrefCleanup(const AutoVarEmission &emission);
1377
John McCall7f416cc2015-09-08 08:05:57 +00001378 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1379 llvm::Value *ptr);
1380
1381 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001382 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1383
1384 /// BuildBlockByrefAddress - Computes the location of the
1385 /// data in a variable which is declared as __block.
1386 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1387 bool followForward = true);
1388 Address emitBlockByrefAddress(Address baseAddr,
1389 const BlockByrefInfo &info,
1390 bool followForward,
1391 const llvm::Twine &name);
1392
1393 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001394
Richard Smith5179eb72016-06-28 19:03:57 +00001395 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1396
John McCalla738c252011-03-09 04:27:21 +00001397 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1398 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001399 /// \brief Emit code for the start of a function.
1400 /// \param Loc The location to be associated with the function.
1401 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001402 void StartFunction(GlobalDecl GD,
1403 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001404 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001405 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001406 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001407 SourceLocation Loc = SourceLocation(),
1408 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001409
John McCallb81884d2010-02-19 09:25:03 +00001410 void EmitConstructorBody(FunctionArgList &Args);
1411 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001412 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001413 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001414 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001415
Faisal Vali571df122013-09-29 08:45:24 +00001416 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001417 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001418 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001419 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001420 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1421 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001422 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001423
David Blaikiea0a1a872015-01-18 02:48:07 +00001424 /// \brief Emit the unified return block, trying to avoid its emission when
1425 /// possible.
1426 /// \return The debug location of the user written return statement if the
1427 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001428 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001429
Mike Stumpfc496822009-02-08 23:14:22 +00001430 /// FinishFunction - Complete IR generation of the current function. It is
1431 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001432 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001433
Nico Weber1bebad12015-02-11 22:33:32 +00001434 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1435 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001436
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001437 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001438
John McCall7f416cc2015-09-08 08:05:57 +00001439 void FinishThunk();
1440
Reid Klecknerab2090d2014-07-26 01:34:32 +00001441 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1442 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1443 llvm::Value *Callee);
1444
Rafael Espindolad6e66942015-07-13 06:07:58 +00001445 /// Generate a thunk for the given method.
1446 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001447 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001448
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001449 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1450 const CGFunctionInfo &FnInfo,
1451 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001452
Douglas Gregor94f9a482010-05-05 05:51:00 +00001453 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1454 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001455
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001456 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001457 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001458
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001459 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1460 struct VPtr {
1461 BaseSubobject Base;
1462 const CXXRecordDecl *NearestVBase;
1463 CharUnits OffsetFromNearestVBase;
1464 const CXXRecordDecl *VTableClass;
1465 };
1466
1467 /// Initialize the vtable pointer of the given subobject.
1468 void InitializeVTablePointer(const VPtr &vptr);
1469
1470 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001471
1472 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001473 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1474
1475 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1476 CharUnits OffsetFromNearestVBase,
1477 bool BaseIsNonVirtualPrimaryBase,
1478 const CXXRecordDecl *VTableClass,
1479 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001480
Anders Carlssond5895932010-03-28 21:07:49 +00001481 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001482
Dan Gohman8fc50c22010-10-26 18:44:08 +00001483 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1484 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001485 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1486 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001487
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001488 enum CFITypeCheckKind {
1489 CFITCK_VCall,
1490 CFITCK_NVCall,
1491 CFITCK_DerivedCast,
1492 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001493 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001494 };
1495
Peter Collingbourned2926c92015-03-14 02:42:25 +00001496 /// \brief Derived is the presumed address of an object of type T after a
1497 /// cast. If T is a polymorphic class type, emit a check that the virtual
1498 /// table for Derived belongs to a class derived from T.
1499 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001500 bool MayBeNull, CFITypeCheckKind TCK,
1501 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001502
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001503 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1504 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001505 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001506 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001507
Peter Collingbourned2926c92015-03-14 02:42:25 +00001508 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001509 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001510 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1511 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001512
Peter Collingbournefb532b92016-02-24 20:46:36 +00001513 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001514 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1515 /// enabled, emit a check that VTable is a member of RD's type identifier.
1516 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1517 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001518
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001519 /// Returns whether we should perform a type checked load when loading a
1520 /// virtual function for virtual calls to members of RD. This is generally
1521 /// true when both vcall CFI and whole-program-vtables are enabled.
1522 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1523
1524 /// Emit a type checked load from the given vtable.
1525 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1526 uint64_t VTableByteOffset);
1527
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001528 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1529 /// expr can be devirtualized.
1530 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1531 const CXXMethodDecl *MD);
1532
John McCallf99a6312010-07-21 05:30:47 +00001533 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1534 /// given phase of destruction for a destructor. The end result
1535 /// should call destructors on members and base classes in reverse
1536 /// order of their construction.
1537 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001538
Chris Lattner3c77a352010-06-22 00:03:40 +00001539 /// ShouldInstrumentFunction - Return true if the current function should be
1540 /// instrumented with __cyg_profile_func_* calls
1541 bool ShouldInstrumentFunction();
1542
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001543 /// ShouldXRayInstrument - Return true if the current function should be
1544 /// instrumented with XRay nop sleds.
1545 bool ShouldXRayInstrumentFunction() const;
1546
Chris Lattner3c77a352010-06-22 00:03:40 +00001547 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1548 /// instrumentation function with the current function and the call site, if
1549 /// function instrumentation is enabled.
1550 void EmitFunctionInstrumentation(const char *Fn);
1551
Roman Divacky178e01602011-02-10 16:52:03 +00001552 /// EmitMCountInstrumentation - Emit call to .mcount.
1553 void EmitMCountInstrumentation();
1554
Mike Stumpfc496822009-02-08 23:14:22 +00001555 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1556 /// arguments for the given function. This is also responsible for naming the
1557 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001558 void EmitFunctionProlog(const CGFunctionInfo &FI,
1559 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001560 const FunctionArgList &Args);
1561
Mike Stumpfc496822009-02-08 23:14:22 +00001562 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1563 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001564 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1565 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001566
Mike Stump1d849212009-12-07 23:38:24 +00001567 /// EmitStartEHSpec - Emit the start of the exception spec.
1568 void EmitStartEHSpec(const Decl *D);
1569
1570 /// EmitEndEHSpec - Emit the end of the exception spec.
1571 void EmitEndEHSpec(const Decl *D);
1572
John McCallbd309292010-07-06 01:34:17 +00001573 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1574 llvm::BasicBlock *getTerminateLandingPad();
1575
1576 /// getTerminateHandler - Return a handler (not a landing pad, just
1577 /// a catch handler) that just calls terminate. This is used when
1578 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001579 llvm::BasicBlock *getTerminateHandler();
1580
Chris Lattnera5f58b02011-07-09 17:41:47 +00001581 llvm::Type *ConvertTypeForMem(QualType T);
1582 llvm::Type *ConvertType(QualType T);
1583 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001584 return ConvertType(getContext().getTypeDeclType(T));
1585 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001586
Mike Stumpfc496822009-02-08 23:14:22 +00001587 /// LoadObjCSelf - Load the value of self. This function is only valid while
1588 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001589 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001590
1591 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001592 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001593
Chris Lattner54fb19e2007-06-22 22:02:34 +00001594 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1595 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001596 static TypeEvaluationKind getEvaluationKind(QualType T);
1597
1598 static bool hasScalarEvaluationKind(QualType T) {
1599 return getEvaluationKind(T) == TEK_Scalar;
1600 }
1601
1602 static bool hasAggregateEvaluationKind(QualType T) {
1603 return getEvaluationKind(T) == TEK_Aggregate;
1604 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001605
1606 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001607 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001608 llvm::Function *parent = nullptr,
1609 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001610#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001611 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001612#else
John McCallad7c5c12011-02-08 08:22:06 +00001613 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001614#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001615 }
Mike Stumpfc496822009-02-08 23:14:22 +00001616
Chris Lattnerac248202007-05-30 00:13:02 +00001617 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1618 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001619 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001620
Mike Stumpe5311b02009-11-30 20:08:49 +00001621 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1622 /// another basic block, simplify it. This assumes that no other code could
1623 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001624 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1625
Mike Stumpfc496822009-02-08 23:14:22 +00001626 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1627 /// adding a fall-through branch from the current insert block if
1628 /// necessary. It is legal to call this function even if there is no current
1629 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001630 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001631 /// IsFinished - If true, indicates that the caller has finished emitting
1632 /// branches to the given block and does not expect to emit code into it. This
1633 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001634 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001635
John McCall8e4c74b2011-08-11 02:22:43 +00001636 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1637 /// near its uses, and leave the insertion point in it.
1638 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1639
Mike Stumpfc496822009-02-08 23:14:22 +00001640 /// EmitBranch - Emit a branch to the specified basic block from the current
1641 /// insert block, taking care to avoid creation of branches from dummy
1642 /// blocks. It is legal to call this function even if there is no current
1643 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001644 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001645 /// This function clears the current insertion point. The caller should follow
1646 /// calls to this function with calls to Emit*Block prior to generation new
1647 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001648 void EmitBranch(llvm::BasicBlock *Block);
1649
Mike Stumpfc496822009-02-08 23:14:22 +00001650 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1651 /// indicates that the current code being emitted is unreachable.
1652 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001653 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001654 }
1655
Mike Stumpfc496822009-02-08 23:14:22 +00001656 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1657 /// emitted IR has a place to go. Note that by definition, if this function
1658 /// creates a block then that block is unreachable; callers may do better to
1659 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001660 void EnsureInsertPoint() {
1661 if (!HaveInsertPoint())
1662 EmitBlock(createBasicBlock());
1663 }
Mike Stumpfc496822009-02-08 23:14:22 +00001664
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001665 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001666 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001667 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001668
Chris Lattnere9a64532007-06-22 21:44:33 +00001669 //===--------------------------------------------------------------------===//
1670 // Helpers
1671 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001672
John McCall7f416cc2015-09-08 08:05:57 +00001673 LValue MakeAddrLValue(Address Addr, QualType T,
1674 AlignmentSource AlignSource = AlignmentSource::Type) {
1675 return LValue::MakeAddr(Addr, T, getContext(), AlignSource,
Dan Gohman947c9af2010-10-14 23:06:10 +00001676 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001677 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001678
John McCall7f416cc2015-09-08 08:05:57 +00001679 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1680 AlignmentSource AlignSource = AlignmentSource::Type) {
1681 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1682 AlignSource, CGM.getTBAAInfo(T));
1683 }
1684
1685 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001686 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001687 CharUnits getNaturalTypeAlignment(QualType T,
1688 AlignmentSource *Source = nullptr,
1689 bool forPointeeType = false);
1690 CharUnits getNaturalPointeeTypeAlignment(QualType T,
1691 AlignmentSource *Source = nullptr);
1692
1693 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
1694 AlignmentSource *Source = nullptr);
1695 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001696
Alexey Bataev31300ed2016-02-04 11:27:03 +00001697 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
1698 AlignmentSource *Source = nullptr);
1699 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1700
Chris Lattnere9a64532007-06-22 21:44:33 +00001701 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001702 /// block. The caller is responsible for setting an appropriate alignment on
1703 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001704 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001705 const Twine &Name = "tmp");
John McCall7f416cc2015-09-08 08:05:57 +00001706 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
1707 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001708
John McCall7f416cc2015-09-08 08:05:57 +00001709 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1710 /// default ABI alignment of the given LLVM type.
1711 ///
1712 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1713 /// any given AST type that happens to have been lowered to the
1714 /// given IR type. This should only ever be used for function-local,
1715 /// IR-driven manipulations like saving and restoring a value. Do
1716 /// not hand this address off to arbitrary IRGen routines, and especially
1717 /// do not pass it as an argument to a function that might expect a
1718 /// properly ABI-aligned value.
1719 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1720 const Twine &Name = "tmp");
1721
1722 /// InitTempAlloca - Provide an initial value for the given alloca which
1723 /// will be observable at all locations in the function.
1724 ///
1725 /// The address should be something that was returned from one of
1726 /// the CreateTempAlloca or CreateMemTemp routines, and the
1727 /// initializer must be valid in the entry block (i.e. it must
1728 /// either be a constant or an argument value).
1729 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001730
Daniel Dunbard0049182010-02-16 19:44:13 +00001731 /// CreateIRTemp - Create a temporary IR object of the given type, with
1732 /// appropriate alignment. This routine should only be used when an temporary
1733 /// value needs to be stored into an alloca (for example, to avoid explicit
1734 /// PHI construction), but the type is the IR type, not the type appropriate
1735 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001736 ///
1737 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1738 /// ConvertType instead of ConvertTypeForMem.
1739 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001740
Daniel Dunbara7566f12010-02-09 02:48:28 +00001741 /// CreateMemTemp - Create a temporary memory object of the given type, with
1742 /// appropriate alignment.
John McCall7f416cc2015-09-08 08:05:57 +00001743 Address CreateMemTemp(QualType T, const Twine &Name = "tmp");
1744 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001745
John McCall7a626f62010-09-15 10:14:12 +00001746 /// CreateAggTemp - Create a temporary memory object for the given
1747 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001748 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00001749 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001750 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001751 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001752 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001753 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001754 }
1755
John McCallad7c5c12011-02-08 08:22:06 +00001756 /// Emit a cast to void* in the appropriate address space.
1757 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1758
Chris Lattner8394d792007-06-05 20:53:16 +00001759 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1760 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001761 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001762
John McCalla2342eb2010-12-05 02:00:02 +00001763 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1764 void EmitIgnoredExpr(const Expr *E);
1765
Chris Lattner4647a212007-08-31 22:49:20 +00001766 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1767 /// any type. The result is returned as an RValue struct. If this is an
1768 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1769 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001770 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001771 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001772 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001773 AggValueSlot aggSlot = AggValueSlot::ignored(),
1774 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001775
Mike Stumpfc496822009-02-08 23:14:22 +00001776 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1777 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00001778 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001779
Charles Davisc7d5c942015-09-17 20:55:33 +00001780 /// Emit a "reference" to a __builtin_ms_va_list; this is
1781 /// always the value of the expression, because a __builtin_ms_va_list is a
1782 /// pointer to a char.
1783 Address EmitMSVAListRef(const Expr *E);
1784
Mike Stumpfc496822009-02-08 23:14:22 +00001785 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1786 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001787 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001788
John McCall91ca10f2011-03-08 09:11:50 +00001789 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001790 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00001791 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001792 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001793
John McCall7f416cc2015-09-08 08:05:57 +00001794 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00001795
John McCall91ca10f2011-03-08 09:11:50 +00001796 /// EmitExprAsInit - Emits the code necessary to initialize a
1797 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001798 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001799 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001800
Fariborz Jahanian78652202013-01-25 23:57:05 +00001801 /// hasVolatileMember - returns true if aggregate type has a volatile
1802 /// member.
1803 bool hasVolatileMember(QualType T) {
1804 if (const RecordType *RT = T->getAs<RecordType>()) {
1805 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1806 return RD->hasVolatileMember();
1807 }
1808 return false;
1809 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001810 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001811 ///
1812 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1813 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00001814 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001815 QualType EltTy) {
1816 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00001817 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001818 }
1819
John McCall7f416cc2015-09-08 08:05:57 +00001820 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
1821 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00001822 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00001823 /*IsAssignment=*/false);
1824 }
1825
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001826 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001827 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001828 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001829 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001830 /// \param isAssignment - If false, allow padding to be copied. This often
1831 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00001832 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001833 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001834 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001835
Anders Carlsson9396a892008-09-11 09:15:33 +00001836 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00001837 Address GetAddrOfLocalVar(const VarDecl *VD) {
1838 auto it = LocalDeclMap.find(VD);
1839 assert(it != LocalDeclMap.end() &&
1840 "Invalid argument to GetAddrOfLocalVar(), no decl!");
1841 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00001842 }
Mike Stumpfc496822009-02-08 23:14:22 +00001843
John McCallc07a0c72011-02-17 10:25:35 +00001844 /// getOpaqueLValueMapping - Given an opaque value expression (which
1845 /// must be mapped to an l-value), return its mapping.
1846 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1847 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1848
1849 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1850 it = OpaqueLValues.find(e);
1851 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1852 return it->second;
1853 }
1854
1855 /// getOpaqueRValueMapping - Given an opaque value expression (which
1856 /// must be mapped to an r-value), return its mapping.
1857 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1858 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1859
1860 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1861 it = OpaqueRValues.find(e);
1862 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001863 return it->second;
1864 }
1865
Dan Gohman75d69da2008-05-22 00:50:06 +00001866 /// getAccessedFieldNo - Given an encoded value and a result number, return
1867 /// the input field number being accessed.
1868 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1869
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001870 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001871 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001872
Anders Carlssonc0964b62010-05-22 17:35:42 +00001873 /// EmitNullInitialization - Generate code to set a value of the given type to
1874 /// null, If the type contains data member pointers, they will be initialized
1875 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00001876 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001877
Charles Davisc7d5c942015-09-17 20:55:33 +00001878 /// Emits a call to an LLVM variable-argument intrinsic, either
1879 /// \c llvm.va_start or \c llvm.va_end.
1880 /// \param ArgValue A reference to the \c va_list as emitted by either
1881 /// \c EmitVAListRef or \c EmitMSVAListRef.
1882 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
1883 /// calls \c llvm.va_end.
1884 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
1885
1886 /// Generate code to get an argument from the passed in pointer
1887 /// and update it accordingly.
1888 /// \param VE The \c VAArgExpr for which to generate code.
1889 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
1890 /// either \c EmitVAListRef or \c EmitMSVAListRef.
1891 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001892 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001893 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00001894 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001895
John McCall82fe67b2011-07-09 01:37:26 +00001896 /// emitArrayLength - Compute the length of an array, even if it's a
1897 /// VLA, and drill down to the base element type.
1898 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1899 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001900 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00001901
John McCall23c29fe2011-06-24 21:55:10 +00001902 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1903 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001904 ///
1905 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001906 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001907
John McCall23c29fe2011-06-24 21:55:10 +00001908 /// getVLASize - Returns an LLVM value that corresponds to the size,
1909 /// in non-variably-sized elements, of a variable length array type,
1910 /// plus that largest non-variably-sized element type. Assumes that
1911 /// the type has already been emitted with EmitVariablyModifiedType.
1912 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1913 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001914
Anders Carlssona5d077d2009-04-14 16:58:56 +00001915 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1916 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001917 llvm::Value *LoadCXXThis() {
1918 assert(CXXThisValue && "no 'this' value for this function");
1919 return CXXThisValue;
1920 }
John McCall7f416cc2015-09-08 08:05:57 +00001921 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00001922
Anders Carlssone36a6b32010-01-02 01:01:18 +00001923 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1924 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001925 // FIXME: Every place that calls LoadCXXVTT is something
1926 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001927 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001928 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1929 return CXXStructorImplicitParamValue;
1930 }
1931
John McCall6ce74722010-02-16 04:15:37 +00001932 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001933 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00001934 Address
1935 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001936 const CXXRecordDecl *Derived,
1937 const CXXRecordDecl *Base,
1938 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001939
John McCall7f416cc2015-09-08 08:05:57 +00001940 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
1941
Mike Stumpe5311b02009-11-30 20:08:49 +00001942 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1943 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00001944 Address GetAddressOfBaseClass(Address Value,
1945 const CXXRecordDecl *Derived,
1946 CastExpr::path_const_iterator PathBegin,
1947 CastExpr::path_const_iterator PathEnd,
1948 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001949
John McCall7f416cc2015-09-08 08:05:57 +00001950 Address GetAddressOfDerivedClass(Address Value,
1951 const CXXRecordDecl *Derived,
1952 CastExpr::path_const_iterator PathBegin,
1953 CastExpr::path_const_iterator PathEnd,
1954 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00001955
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001956 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1957 /// base constructor/destructor with virtual bases.
1958 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1959 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1960 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1961 bool Delegating);
1962
John McCallf8ff7b92010-02-23 00:48:20 +00001963 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1964 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001965 const FunctionArgList &Args,
1966 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001967 // It's important not to confuse this and the previous function. Delegating
1968 // constructors are the C++0x feature. The constructor delegate optimization
1969 // is used to reduce duplication in the base and complete consturctors where
1970 // they are substantially the same.
1971 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1972 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001973
Richard Smith5179eb72016-06-28 19:03:57 +00001974 /// Emit a call to an inheriting constructor (that is, one that invokes a
1975 /// constructor inherited from a base class) by inlining its definition. This
1976 /// is necessary if the ABI does not support forwarding the arguments to the
1977 /// base class constructor (because they're variadic or similar).
1978 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1979 CXXCtorType CtorType,
1980 bool ForVirtualBase,
1981 bool Delegating,
1982 CallArgList &Args);
1983
1984 /// Emit a call to a constructor inherited from a base class, passing the
1985 /// current constructor's arguments along unmodified (without even making
1986 /// a copy).
1987 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
1988 bool ForVirtualBase, Address This,
1989 bool InheritedFromVBase,
1990 const CXXInheritedCtorInitExpr *E);
1991
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001992 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001993 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001994 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001995
Richard Smith5179eb72016-06-28 19:03:57 +00001996 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
1997 bool ForVirtualBase, bool Delegating,
1998 Address This, CallArgList &Args);
1999
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002000 /// Emit assumption load for all bases. Requires to be be called only on
2001 /// most-derived class and not under construction of the object.
2002 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2003
2004 /// Emit assumption that vptr load == global vtable.
2005 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2006
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002007 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002008 Address This, Address Src,
2009 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002010
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002011 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002012 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002013 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002014 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002015 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002016
Anders Carlssond49844b2009-09-23 02:45:36 +00002017 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2018 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002019 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002020 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002021 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002022
John McCall82fe67b2011-07-09 01:37:26 +00002023 static Destroyer destroyCXXObject;
2024
Anders Carlsson0a637412009-05-29 21:03:38 +00002025 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002026 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002027 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002028
John McCall99210dc2011-09-15 06:49:18 +00002029 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002030 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002031 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002032 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002033
Peter Collingbourne702b2842011-11-27 22:09:22 +00002034 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002035 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002036
David Majnemerdc012fa2015-04-22 21:38:15 +00002037 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2038 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2039
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002040 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002041 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002042
Eli Friedman24f55432009-11-18 00:57:03 +00002043 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002044 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2045 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002046
Richard Smith760520b2014-06-03 23:27:44 +00002047 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2048 const Expr *Arg, bool IsDelete);
2049
John McCall7f416cc2015-09-08 08:05:57 +00002050 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2051 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2052 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002053
Richard Smith69d0d262012-08-24 00:54:33 +00002054 /// \brief Situations in which we might emit a check for the suitability of a
2055 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002056 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002057 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002058 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002059 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002060 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002061 /// Checking the bound value in a reference binding. Must be suitably sized
2062 /// and aligned, but is not required to refer to an object (until the
2063 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002064 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002065 /// Checking the object expression in a non-static data member access. Must
2066 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002067 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002068 /// Checking the 'this' pointer for a call to a non-static member function.
2069 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002070 TCK_MemberCall,
2071 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002072 TCK_ConstructorCall,
2073 /// Checking the operand of a static_cast to a derived pointer type. Must be
2074 /// null or an object within its lifetime.
2075 TCK_DowncastPointer,
2076 /// Checking the operand of a static_cast to a derived reference type. Must
2077 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002078 TCK_DowncastReference,
2079 /// Checking the operand of a cast to a base object. Must be suitably sized
2080 /// and aligned.
2081 TCK_Upcast,
2082 /// Checking the operand of a cast to a virtual base object. Must be an
2083 /// object within its lifetime.
2084 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00002085 };
2086
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002087 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2088 /// calls to EmitTypeCheck can be skipped.
2089 bool sanitizePerformTypeCheck() const;
2090
Richard Smith4d1458e2012-09-08 02:08:36 +00002091 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002092 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002093 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002094 QualType Type, CharUnits Alignment = CharUnits::Zero(),
2095 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002096
Richard Smith539e4a72013-02-23 02:53:19 +00002097 /// \brief Emit a check that \p Base points into an array object, which
2098 /// we can access at index \p Index. \p Accessed should be \c false if we
2099 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2100 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2101 QualType IndexType, bool Accessed);
2102
Chris Lattner116ce8f2010-01-09 21:40:03 +00002103 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2104 bool isInc, bool isPre);
2105 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2106 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002107
2108 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002109 llvm::Value *OffsetValue = nullptr) {
2110 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2111 OffsetValue);
2112 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002113
Chris Lattner8394d792007-06-05 20:53:16 +00002114 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002115 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002116 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002117
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002118 /// EmitDecl - Emit a declaration.
2119 ///
2120 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002121 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002122
John McCall1c9c3fd2010-10-15 04:57:14 +00002123 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002124 ///
2125 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002126 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002127
David Blaikie73ca5692014-12-09 00:32:22 +00002128 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002129 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002130
John McCallbd309292010-07-06 01:34:17 +00002131 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2132 llvm::Value *Address);
2133
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002134 /// \brief Determine whether the given initializer is trivial in the sense
2135 /// that it requires no code to be generated.
2136 bool isTrivialInitializer(const Expr *Init);
2137
John McCall1c9c3fd2010-10-15 04:57:14 +00002138 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002139 ///
2140 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002141 void EmitAutoVarDecl(const VarDecl &D);
2142
2143 class AutoVarEmission {
2144 friend class CodeGenFunction;
2145
John McCall9e2e22f2011-02-22 07:16:58 +00002146 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002147
John McCall7f416cc2015-09-08 08:05:57 +00002148 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002149 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002150 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002151
2152 llvm::Value *NRVOFlag;
2153
2154 /// True if the variable is a __block variable.
2155 bool IsByRef;
2156
2157 /// True if the variable is of aggregate type and has a constant
2158 /// initializer.
2159 bool IsConstantAggregate;
2160
Nadav Rotem1da30942013-03-23 06:43:35 +00002161 /// Non-null if we should use lifetime annotations.
2162 llvm::Value *SizeForLifetimeMarkers;
2163
John McCall9e2e22f2011-02-22 07:16:58 +00002164 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002165 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002166
John McCallc533cb72011-02-22 06:44:22 +00002167 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002168 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002169 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002170 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002171
John McCall7f416cc2015-09-08 08:05:57 +00002172 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002173
2174 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002175 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2176
Craig Topper8a13c412014-05-21 05:09:00 +00002177 bool useLifetimeMarkers() const {
2178 return SizeForLifetimeMarkers != nullptr;
2179 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002180 llvm::Value *getSizeForLifetimeMarkers() const {
2181 assert(useLifetimeMarkers());
2182 return SizeForLifetimeMarkers;
2183 }
2184
2185 /// Returns the raw, allocated address, which is not necessarily
2186 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002187 Address getAllocatedAddress() const {
2188 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002189 }
2190
John McCallc533cb72011-02-22 06:44:22 +00002191 /// Returns the address of the object within this declaration.
2192 /// Note that this does not chase the forwarding pointer for
2193 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002194 Address getObjectAddress(CodeGenFunction &CGF) const {
2195 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002196
John McCall7f416cc2015-09-08 08:05:57 +00002197 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002198 }
2199 };
2200 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2201 void EmitAutoVarInit(const AutoVarEmission &emission);
2202 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002203 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2204 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002205
John McCall1c9c3fd2010-10-15 04:57:14 +00002206 void EmitStaticVarDecl(const VarDecl &D,
2207 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002208
John McCall7f416cc2015-09-08 08:05:57 +00002209 class ParamValue {
2210 llvm::Value *Value;
2211 unsigned Alignment;
2212 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2213 public:
2214 static ParamValue forDirect(llvm::Value *value) {
2215 return ParamValue(value, 0);
2216 }
2217 static ParamValue forIndirect(Address addr) {
2218 assert(!addr.getAlignment().isZero());
2219 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2220 }
2221
2222 bool isIndirect() const { return Alignment != 0; }
2223 llvm::Value *getAnyValue() const { return Value; }
2224
2225 llvm::Value *getDirectValue() const {
2226 assert(!isIndirect());
2227 return Value;
2228 }
2229
2230 Address getIndirectAddress() const {
2231 assert(isIndirect());
2232 return Address(Value, CharUnits::fromQuantity(Alignment));
2233 }
2234 };
2235
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002236 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002237 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002238
John McCallc07a0c72011-02-17 10:25:35 +00002239 /// protectFromPeepholes - Protect a value that we're intending to
2240 /// store to the side, but which will probably be used later, from
2241 /// aggressive peepholing optimizations that might delete it.
2242 ///
2243 /// Pass the result to unprotectFromPeepholes to declare that
2244 /// protection is no longer required.
2245 ///
2246 /// There's no particular reason why this shouldn't apply to
2247 /// l-values, it's just that no existing peepholes work on pointers.
2248 PeepholeProtection protectFromPeepholes(RValue rvalue);
2249 void unprotectFromPeepholes(PeepholeProtection protection);
2250
Chris Lattner84915fa2007-06-02 04:16:21 +00002251 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002252 // Statement Emission
2253 //===--------------------------------------------------------------------===//
2254
Mike Stumpfc496822009-02-08 23:14:22 +00002255 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002256 void EmitStopPoint(const Stmt *S);
2257
Mike Stumpfc496822009-02-08 23:14:22 +00002258 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2259 /// this function even if there is no current insertion point.
2260 ///
2261 /// This function may clear the current insertion point; callers should use
2262 /// EnsureInsertPoint if they wish to subsequently generate code without first
2263 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002264 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002265
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002266 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002267 /// necessarily require an insertion point or debug information; typically
2268 /// because the statement amounts to a jump or a container of other
2269 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002270 ///
2271 /// \return True if the statement was handled.
2272 bool EmitSimpleStmt(const Stmt *S);
2273
John McCall7f416cc2015-09-08 08:05:57 +00002274 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2275 AggValueSlot AVS = AggValueSlot::ignored());
2276 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2277 bool GetLast = false,
2278 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002279 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002280
Mike Stumpfc496822009-02-08 23:14:22 +00002281 /// EmitLabel - Emit the block for the given label. It is legal to call this
2282 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002283 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002284
Chris Lattnerac248202007-05-30 00:13:02 +00002285 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002286 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002287 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002288 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002289 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002290
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002291 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002292 ArrayRef<const Attr *> Attrs = None);
2293 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002294 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002295 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002296 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002297 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002298 void EmitBreakStmt(const BreakStmt &S);
2299 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002300 void EmitSwitchStmt(const SwitchStmt &S);
2301 void EmitDefaultStmt(const DefaultStmt &S);
2302 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002303 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002304 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002305
Anders Carlsson2e744e82008-08-30 19:51:14 +00002306 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002307 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2308 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002309 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002310 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002311
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002312 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2313
John McCallb609d3f2010-07-07 06:56:46 +00002314 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2315 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002316
Anders Carlsson52d78a52009-09-27 18:58:34 +00002317 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002318 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002319 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002320 void EnterSEHTryStmt(const SEHTryStmt &S);
2321 void ExitSEHTryStmt(const SEHTryStmt &S);
2322
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002323 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002324 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002325
2326 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2327 const SEHExceptStmt &Except);
2328
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002329 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2330 const SEHFinallyStmt &Finally);
2331
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002332 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2333 llvm::Value *ParentFP,
2334 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002335 llvm::Value *EmitSEHExceptionCode();
2336 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002337 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002338
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002339 /// Scan the outlined statement for captures from the parent function. For
2340 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002341 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002342 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002343 bool IsFilter);
2344
2345 /// Recovers the address of a local in a parent function. ParentVar is the
2346 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002347 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002348 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2349 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002350 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2351 Address ParentVar,
2352 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002353
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002354 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002355 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002356
Alexey Bataev1189bd02016-01-26 12:20:39 +00002357 /// Returns calculated size of the specified type.
2358 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002359 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002360 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002361 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002362 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002363 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002364 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002365 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002366 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2367 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002368 /// \brief Perform element by element copying of arrays with type \a
2369 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2370 /// generated by \a CopyGen.
2371 ///
2372 /// \param DestAddr Address of the destination array.
2373 /// \param SrcAddr Address of the source array.
2374 /// \param OriginalType Type of destination and source arrays.
2375 /// \param CopyGen Copying procedure that copies value of single array element
2376 /// to another single array element.
2377 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002378 Address DestAddr, Address SrcAddr, QualType OriginalType,
2379 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002380 /// \brief Emit proper copying of data from one variable to another.
2381 ///
2382 /// \param OriginalType Original type of the copied variables.
2383 /// \param DestAddr Destination address.
2384 /// \param SrcAddr Source address.
2385 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2386 /// type of the base array element).
2387 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2388 /// the base array element).
2389 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2390 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002391 void EmitOMPCopy(QualType OriginalType,
2392 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002393 const VarDecl *DestVD, const VarDecl *SrcVD,
2394 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002395 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2396 /// \a X = \a E \a BO \a E.
2397 ///
2398 /// \param X Value to be updated.
2399 /// \param E Update value.
2400 /// \param BO Binary operation for update operation.
2401 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2402 /// expression, false otherwise.
2403 /// \param AO Atomic ordering of the generated atomic instructions.
2404 /// \param CommonGen Code generator for complex expressions that cannot be
2405 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002406 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2407 /// generated, <false, RValue::get(nullptr)> otherwise.
2408 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002409 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2410 llvm::AtomicOrdering AO, SourceLocation Loc,
2411 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002412 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002413 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002414 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2415 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002416 void EmitOMPUseDevicePtrClause(
2417 const OMPClause &C, OMPPrivateScope &PrivateScope,
2418 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002419 /// \brief Emit code for copyin clause in \a D directive. The next code is
2420 /// generated at the start of outlined functions for directives:
2421 /// \code
2422 /// threadprivate_var1 = master_threadprivate_var1;
2423 /// operator=(threadprivate_var2, master_threadprivate_var2);
2424 /// ...
2425 /// __kmpc_barrier(&loc, global_tid);
2426 /// \endcode
2427 ///
2428 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2429 /// \returns true if at least one copyin variable is found, false otherwise.
2430 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002431 /// \brief Emit initial code for lastprivate variables. If some variable is
2432 /// not also firstprivate, then the default initialization is used. Otherwise
2433 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2434 /// method.
2435 ///
2436 /// \param D Directive that may have 'lastprivate' directives.
2437 /// \param PrivateScope Private scope for capturing lastprivate variables for
2438 /// proper codegen in internal captured statement.
2439 ///
2440 /// \returns true if there is at least one lastprivate variable, false
2441 /// otherwise.
2442 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2443 OMPPrivateScope &PrivateScope);
2444 /// \brief Emit final copying of lastprivate values to original variables at
2445 /// the end of the worksharing or simd directive.
2446 ///
2447 /// \param D Directive that has at least one 'lastprivate' directives.
2448 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2449 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002450 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002451 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002452 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002453 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002454 /// Emit initial code for linear clauses.
2455 void EmitOMPLinearClause(const OMPLoopDirective &D,
2456 CodeGenFunction::OMPPrivateScope &PrivateScope);
2457 /// Emit final code for linear clauses.
2458 /// \param CondGen Optional conditional code for final part of codegen for
2459 /// linear clause.
2460 void EmitOMPLinearClauseFinal(
2461 const OMPLoopDirective &D,
2462 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002463 /// \brief Emit initial code for reduction variables. Creates reduction copies
2464 /// and initializes them with the values according to OpenMP standard.
2465 ///
2466 /// \param D Directive (possibly) with the 'reduction' clause.
2467 /// \param PrivateScope Private scope for capturing reduction variables for
2468 /// proper codegen in internal captured statement.
2469 ///
2470 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2471 OMPPrivateScope &PrivateScope);
2472 /// \brief Emit final update of reduction values to original variables at
2473 /// the end of the directive.
2474 ///
2475 /// \param D Directive that has at least one 'reduction' directives.
2476 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002477 /// \brief Emit initial code for linear variables. Creates private copies
2478 /// and initializes them with the values according to OpenMP standard.
2479 ///
2480 /// \param D Directive (possibly) with the 'linear' clause.
2481 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002482
Alexey Bataev7292c292016-04-25 12:22:29 +00002483 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2484 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002485 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002486 TaskGenTy;
2487 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2488 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002489 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00002490
Alexey Bataev9959db52014-05-06 10:08:46 +00002491 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002492 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002493 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002494 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002495 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002496 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002497 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002498 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002499 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002500 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002501 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002502 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002503 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002504 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002505 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002506 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002507 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002508 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002509 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002510 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002511 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002512 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002513 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002514 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002515 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002516 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002517 void
2518 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002519 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002520 void
2521 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002522 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002523 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002524 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002525 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002526 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002527 void EmitOMPDistributeLoop(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002528 void EmitOMPDistributeParallelForDirective(
2529 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002530 void EmitOMPDistributeParallelForSimdDirective(
2531 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002532 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002533 void EmitOMPTargetParallelForSimdDirective(
2534 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002535 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002536 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00002537 void
2538 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002539
Alexey Bataev14fa1c62016-03-29 05:34:15 +00002540 /// Emit outlined function for the target directive.
2541 static std::pair<llvm::Function * /*OutlinedFn*/,
2542 llvm::Constant * /*OutlinedFnID*/>
2543 EmitOMPTargetDirectiveOutlinedFunction(CodeGenModule &CGM,
2544 const OMPTargetDirective &S,
2545 StringRef ParentName,
2546 bool IsOffloadEntry);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002547 /// \brief Emit inner loop of the worksharing/simd construct.
2548 ///
2549 /// \param S Directive, for which the inner loop must be emitted.
2550 /// \param RequiresCleanup true, if directive has some associated private
2551 /// variables.
2552 /// \param LoopCond Bollean condition for loop continuation.
2553 /// \param IncExpr Increment expression for loop control variable.
2554 /// \param BodyGen Generator for the inner body of the inner loop.
2555 /// \param PostIncGen Genrator for post-increment code (required for ordered
2556 /// loop directvies).
2557 void EmitOMPInnerLoop(
2558 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2559 const Expr *IncExpr,
2560 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2561 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002562
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002563 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002564 /// Emit initial code for loop counters of loop-based directives.
2565 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2566 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002567
Alexander Musmanc6388682014-12-15 07:07:06 +00002568private:
Alexander Musmanc6388682014-12-15 07:07:06 +00002569 /// Helpers for the OpenMP loop directives.
Alexey Bataev0f34da12015-07-02 04:17:07 +00002570 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002571 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002572 void EmitOMPSimdFinal(
2573 const OMPLoopDirective &D,
2574 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev38e89532015-04-16 04:54:05 +00002575 /// \brief Emit code for the worksharing loop-based directive.
2576 /// \return true, if this construct has any lastprivate clause, false -
2577 /// otherwise.
2578 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002579 void EmitOMPOuterLoop(bool IsMonotonic, bool DynamicOrOrdered,
2580 const OMPLoopDirective &S, OMPPrivateScope &LoopScope, bool Ordered,
2581 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00002582 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002583 bool IsMonotonic, const OMPLoopDirective &S,
2584 OMPPrivateScope &LoopScope, bool Ordered, Address LB,
2585 Address UB, Address ST, Address IL,
2586 llvm::Value *Chunk);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002587 void EmitOMPDistributeOuterLoop(
2588 OpenMPDistScheduleClauseKind ScheduleKind,
2589 const OMPDistributeDirective &S, OMPPrivateScope &LoopScope,
2590 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002591 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002592 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002593
2594public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002595
Chris Lattner208ae962007-05-30 17:57:17 +00002596 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002597 // LValue Expression Emission
2598 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002599
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002600 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2601 RValue GetUndefRValue(QualType Ty);
2602
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002603 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2604 /// and issue an ErrorUnsupported style diagnostic (using the
2605 /// provided Name).
2606 RValue EmitUnsupportedRValue(const Expr *E,
2607 const char *Name);
2608
Mike Stumpfc496822009-02-08 23:14:22 +00002609 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2610 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002611 LValue EmitUnsupportedLValue(const Expr *E,
2612 const char *Name);
2613
Chris Lattner8394d792007-06-05 20:53:16 +00002614 /// EmitLValue - Emit code to compute a designator that specifies the location
2615 /// of the expression.
2616 ///
2617 /// This can return one of two things: a simple address or a bitfield
2618 /// reference. In either case, the LLVM Value* in the LValue structure is
2619 /// guaranteed to be an LLVM pointer type.
2620 ///
2621 /// If this returns a bitfield reference, nothing about the pointee type of
2622 /// the LLVM value is known: For example, it may not be a pointer to an
2623 /// integer.
2624 ///
2625 /// If this returns a normal address, and if the lvalue's C type is fixed
2626 /// size, this method guarantees that the returned pointer type will point to
2627 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2628 /// variable length type, this is not possible.
2629 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002630 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002631
Richard Smith4d1458e2012-09-08 02:08:36 +00002632 /// \brief Same as EmitLValue but additionally we generate checking code to
2633 /// guard against undefined behavior. This is only suitable when we know
2634 /// that the address will be used to access the object.
2635 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002636
John McCall7f416cc2015-09-08 08:05:57 +00002637 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002638 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002639
John McCalla8ec7eb2013-03-07 21:37:17 +00002640 void EmitAtomicInit(Expr *E, LValue lvalue);
2641
David Majnemera5b195a2015-02-14 01:35:12 +00002642 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00002643
2644 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2645 AggValueSlot Slot = AggValueSlot::ignored());
2646
Nick Lewycky2d84e842013-10-02 02:29:49 +00002647 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002648 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002649 AggValueSlot slot = AggValueSlot::ignored());
2650
2651 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2652
David Majnemera5b195a2015-02-14 01:35:12 +00002653 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2654 bool IsVolatile, bool isInit);
2655
Alexey Bataevb4505a72015-03-30 05:20:59 +00002656 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002657 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00002658 llvm::AtomicOrdering Success =
2659 llvm::AtomicOrdering::SequentiallyConsistent,
2660 llvm::AtomicOrdering Failure =
2661 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00002662 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2663
Alexey Bataevb4505a72015-03-30 05:20:59 +00002664 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002665 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002666 bool IsVolatile);
2667
John McCall3a7f6922010-10-27 20:58:56 +00002668 /// EmitToMemory - Change a scalar value from its value
2669 /// representation to its in-memory representation.
2670 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2671
2672 /// EmitFromMemory - Change a scalar value from its memory
2673 /// representation to its value representation.
2674 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2675
Daniel Dunbar1d425462009-02-10 00:57:50 +00002676 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2677 /// care to appropriately convert from the memory representation to
2678 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002679 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002680 SourceLocation Loc,
John McCall7f416cc2015-09-08 08:05:57 +00002681 AlignmentSource AlignSource =
2682 AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002683 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002684 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002685 uint64_t TBAAOffset = 0,
2686 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002687
2688 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2689 /// care to appropriately convert from the memory representation to
2690 /// the LLVM value representation. The l-value must be a simple
2691 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002692 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002693
2694 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2695 /// care to appropriately convert from the memory representation to
2696 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002697 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
2698 bool Volatile, QualType Ty,
2699 AlignmentSource AlignSource = AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002700 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002701 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002702 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002703
2704 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2705 /// care to appropriately convert from the memory representation to
2706 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002707 /// l-value. The isInit flag indicates whether this is an initialization.
2708 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2709 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002710
Chris Lattner8394d792007-06-05 20:53:16 +00002711 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2712 /// this method emits the address of the lvalue, then loads the result as an
2713 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002714 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002715 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2716 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002717 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002718
Chris Lattner8394d792007-06-05 20:53:16 +00002719 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2720 /// lvalue, where both are guaranteed to the have the same type, and that type
2721 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002722 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002723 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002724 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002725
Nick Lewycky2d84e842013-10-02 02:29:49 +00002726 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2727 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002728 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002729 /// \param Result [out] - If non-null, this will be set to a Value* for the
2730 /// bit-field contents after the store, appropriate for use as the result of
2731 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002732 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002733 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002734
John McCall4f29b492010-11-16 23:07:28 +00002735 /// Emit an l-value for an assignment (simple or compound) of complex type.
2736 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002737 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002738 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2739 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002740
Chris Lattner57540c52011-04-15 05:22:18 +00002741 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002742 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002743 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002744 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002745 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002746 // Note: only available for agg return types
2747 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002748 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002749 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002750 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002751 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002752 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002753 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2754 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00002755 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
2756 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002757 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002758 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002759 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002760 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002761 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002762 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002763 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002764 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002765 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002766
John McCall7f416cc2015-09-08 08:05:57 +00002767 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002768
Nick Lewycky2d84e842013-10-02 02:29:49 +00002769 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002770
John McCall7f416cc2015-09-08 08:05:57 +00002771 Address EmitArrayToPointerDecay(const Expr *Array,
2772 AlignmentSource *AlignSource = nullptr);
2773
John McCall71335052012-03-10 03:05:10 +00002774 class ConstantEmission {
2775 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2776 ConstantEmission(llvm::Constant *C, bool isReference)
2777 : ValueAndIsReference(C, isReference) {}
2778 public:
2779 ConstantEmission() {}
2780 static ConstantEmission forReference(llvm::Constant *C) {
2781 return ConstantEmission(C, true);
2782 }
2783 static ConstantEmission forValue(llvm::Constant *C) {
2784 return ConstantEmission(C, false);
2785 }
2786
Aaron Ballman67347662015-02-15 22:00:28 +00002787 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002788 return ValueAndIsReference.getOpaqueValue() != nullptr;
2789 }
John McCall71335052012-03-10 03:05:10 +00002790
2791 bool isReference() const { return ValueAndIsReference.getInt(); }
2792 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2793 assert(isReference());
2794 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2795 refExpr->getType());
2796 }
2797
2798 llvm::Constant *getValue() const {
2799 assert(!isReference());
2800 return ValueAndIsReference.getPointer();
2801 }
2802 };
2803
John McCall113bee02012-03-10 09:33:50 +00002804 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002805
John McCallfe96e0b2011-11-06 09:01:30 +00002806 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2807 AggValueSlot slot = AggValueSlot::ignored());
2808 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2809
Daniel Dunbar722f4242009-04-22 05:08:15 +00002810 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002811 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002812 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002813 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002814
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002815 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2816 /// if the Field is a reference, this will return the address of the reference
2817 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002818 LValue EmitLValueForFieldInitialization(LValue Base,
2819 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002820
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002821 LValue EmitLValueForIvar(QualType ObjectTy,
2822 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002823 unsigned CVRQualifiers);
2824
Anders Carlsson3be22e22009-05-30 23:23:33 +00002825 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002826 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002827 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002828 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002829 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002830
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002831 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002832 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002833 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002834 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002835 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00002836 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00002837
Chris Lattnerd7f58862007-06-02 05:24:33 +00002838 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002839 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002840 //===--------------------------------------------------------------------===//
2841
Mike Stumpfc496822009-02-08 23:14:22 +00002842 /// EmitCall - Generate a call of the given function, expecting the given
2843 /// result type, and using the given argument list which specifies both the
2844 /// LLVM arguments and the types they were derived from.
Samuel Antao798f11c2015-11-23 22:04:44 +00002845 RValue EmitCall(const CGFunctionInfo &FnInfo, llvm::Value *Callee,
2846 ReturnValueSlot ReturnValue, const CallArgList &Args,
2847 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Craig Topper8a13c412014-05-21 05:09:00 +00002848 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002849
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002850 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002851 ReturnValueSlot ReturnValue,
Samuel Antao798f11c2015-11-23 22:04:44 +00002852 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Peter Collingbournef7706832014-12-12 23:41:25 +00002853 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002854 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002855 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002856
Eric Christopherc7e79db2015-11-12 00:44:04 +00002857 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00002858
John McCall882987f2013-02-28 19:01:20 +00002859 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2860 const Twine &name = "");
2861 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2862 ArrayRef<llvm::Value*> args,
2863 const Twine &name = "");
2864 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2865 const Twine &name = "");
2866 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2867 ArrayRef<llvm::Value*> args,
2868 const Twine &name = "");
2869
John McCallbd309292010-07-06 01:34:17 +00002870 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002871 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002872 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002873 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2874 ArrayRef<llvm::Value*> args,
2875 const Twine &name = "");
2876 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2877 const Twine &name = "");
2878 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2879 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002880
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002881 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2882 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002883 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002884
2885 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2886 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002887 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002888
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002889 RValue
2890 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2891 ReturnValueSlot ReturnValue, llvm::Value *This,
2892 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00002893 QualType ImplicitParamTy, const CallExpr *E,
2894 CallArgList *RtlArgs);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00002895 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD, llvm::Value *Callee,
2896 llvm::Value *This, llvm::Value *ImplicitParam,
2897 QualType ImplicitParamTy, const CallExpr *E,
2898 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002899 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2900 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002901 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2902 const CXXMethodDecl *MD,
2903 ReturnValueSlot ReturnValue,
2904 bool HasQualifier,
2905 NestedNameSpecifier *Qualifier,
2906 bool IsArrow, const Expr *Base);
2907 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002908 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
2909 llvm::Value *memberPtr,
2910 const MemberPointerType *memberPtrType,
2911 AlignmentSource *AlignSource = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002912 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2913 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002914
Anders Carlsson4034a952009-05-27 04:18:27 +00002915 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002916 const CXXMethodDecl *MD,
2917 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002918
Peter Collingbournefe883422011-10-06 18:29:37 +00002919 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2920 ReturnValueSlot ReturnValue);
2921
Justin Lebar3039a592016-01-23 21:28:14 +00002922 RValue EmitCUDADevicePrintfCallExpr(const CallExpr *E,
2923 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002924
Mike Stump11289f42009-09-09 15:08:12 +00002925 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002926 unsigned BuiltinID, const CallExpr *E,
2927 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002928
Anders Carlssonbfb36712009-12-24 21:13:40 +00002929 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002930
Mike Stumpfc496822009-02-08 23:14:22 +00002931 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2932 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002933 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2934
Kevin Qin1718af62013-11-14 02:45:18 +00002935 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2936 const llvm::CmpInst::Predicate Fp,
2937 const llvm::CmpInst::Predicate Ip,
2938 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002939 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002940
2941 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2942 unsigned LLVMIntrinsic,
2943 unsigned AltLLVMIntrinsic,
2944 const char *NameHint,
2945 unsigned Modifier,
2946 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002947 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00002948 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00002949 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2950 unsigned Modifier, llvm::Type *ArgTy,
2951 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002952 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002953 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002954 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002955 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002956 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002957 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002958 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002959 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2960 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00002961 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00002962 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002963
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002964 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002965 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2966 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00002967 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00002968 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00002969 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00002970 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
2971 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002972
Albert Gutowski2a0621e2016-10-12 22:01:05 +00002973private:
2974 enum class MSVCIntrin;
2975
2976public:
2977 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
2978
Daniel Dunbar66912a12008-08-20 00:28:19 +00002979 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002980 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002981 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002982 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2983 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2984 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002985 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002986 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002987 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2988 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002989
John McCall31168b02011-06-15 23:02:42 +00002990 /// Retrieves the default cleanup kind for an ARC cleanup.
2991 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2992 CleanupKind getARCCleanupKind() {
2993 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2994 ? NormalAndEHCleanup : NormalCleanup;
2995 }
2996
2997 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00002998 void EmitARCInitWeak(Address addr, llvm::Value *value);
2999 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003000 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003001 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3002 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3003 void EmitARCCopyWeak(Address dst, Address src);
3004 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003005 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3006 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003007 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003008 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003009 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003010 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003011 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003012 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003013 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003014 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003015 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003016 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003017 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3018 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3019 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003020 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003021
3022 std::pair<LValue,llvm::Value*>
3023 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3024 std::pair<LValue,llvm::Value*>
3025 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003026 std::pair<LValue,llvm::Value*>
3027 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003028
John McCall248512a2011-10-01 10:32:24 +00003029 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003030 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3031 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3032
John McCallff613032011-10-04 06:23:45 +00003033 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003034 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3035 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003036 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3037 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003038 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003039
Craig Topper00bbdcf2014-06-28 23:22:23 +00003040 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003041
John McCall82fe67b2011-07-09 01:37:26 +00003042 static Destroyer destroyARCStrongImprecise;
3043 static Destroyer destroyARCStrongPrecise;
3044 static Destroyer destroyARCWeak;
3045
John McCall31168b02011-06-15 23:02:42 +00003046 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3047 llvm::Value *EmitObjCAutoreleasePoolPush();
3048 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3049 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3050 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3051
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003052 /// \brief Emits a reference binding to the passed in expression.
3053 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003054
Chris Lattner6278e6a2007-08-11 00:04:45 +00003055 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003056 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003057 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003058
3059 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003060
3061 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3062 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003063 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003064
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003065 /// Emit a conversion from the specified type to the specified destination
3066 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003067 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003068 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003069
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003070 /// Emit a conversion from the specified complex type to the specified
3071 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003072 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003073 QualType DstTy,
3074 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003075
John McCall7a626f62010-09-15 10:14:12 +00003076 /// EmitAggExpr - Emit the computation of the specified expression
3077 /// of aggregate type. The result is computed into the given slot,
3078 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003079 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003080
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003081 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3082 /// aggregate type into a temporary LValue.
3083 LValue EmitAggExprToLValue(const Expr *E);
3084
John McCall1bd25562011-06-24 23:21:27 +00003085 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3086 /// make sure it survives garbage collection until this point.
3087 void EmitExtendGCLifetime(llvm::Value *object);
3088
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003089 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003090 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003091 ComplexPairTy EmitComplexExpr(const Expr *E,
3092 bool IgnoreReal = false,
3093 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003094
John McCall47fb9502013-03-07 21:37:08 +00003095 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3096 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003097 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003098
John McCall47fb9502013-03-07 21:37:08 +00003099 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003100 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003101
3102 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003103 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003104
John McCall7f416cc2015-09-08 08:05:57 +00003105 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3106 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3107
Chandler Carruth84537952012-03-30 19:44:53 +00003108 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3109 /// global variable that has already been created for it. If the initializer
3110 /// has a different type than GV does, this may free GV and return a different
3111 /// one. Otherwise it just returns GV.
3112 llvm::GlobalVariable *
3113 AddInitializerToStaticVarDecl(const VarDecl &D,
3114 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003115
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003116
Anders Carlssonf40886a2009-08-08 21:45:14 +00003117 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3118 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003119 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3120 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003121
David Majnemerb3341ea2014-10-05 05:05:40 +00003122 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3123 llvm::Constant *Addr);
3124
John McCallc84ed6a2012-05-01 06:13:13 +00003125 /// Call atexit() with a function that passes the given argument to
3126 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003127 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3128 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003129
John McCallcdf7ef52010-11-06 09:44:32 +00003130 /// Emit code in this function to perform a guarded variable
3131 /// initialization. Guarded initializations are used when it's not
3132 /// possible to prove that an initialization will be done exactly
3133 /// once, e.g. with a static local variable or a static data member
3134 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003135 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003136 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003137
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003138 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3139 /// variables.
3140 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003141 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003142 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003143
John McCallee08c532012-04-06 18:21:03 +00003144 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003145 /// variables.
John McCallee08c532012-04-06 18:21:03 +00003146 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
3147 const std::vector<std::pair<llvm::WeakVH,
3148 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003149
John McCalla738c252011-03-09 04:27:21 +00003150 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3151 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003152 llvm::GlobalVariable *Addr,
3153 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003154
John McCall7a626f62010-09-15 10:14:12 +00003155 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00003156
John McCall7f416cc2015-09-08 08:05:57 +00003157 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003158
John McCall08ef4662011-11-10 08:15:53 +00003159 void enterFullExpression(const ExprWithCleanups *E) {
3160 if (E->getNumObjects() == 0) return;
3161 enterNonTrivialFullExpression(E);
3162 }
3163 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003164
Richard Smithea852322013-05-07 21:53:22 +00003165 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003166
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003167 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3168
Tim Northovercc2a6e02015-11-09 19:56:35 +00003169 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003170
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003171 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003172 // Annotations Emission
3173 //===--------------------------------------------------------------------===//
3174
3175 /// Emit an annotation call (intrinsic or builtin).
3176 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3177 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003178 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003179 SourceLocation Location);
3180
3181 /// Emit local annotations for the local variable V, declared by D.
3182 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3183
3184 /// Emit field annotations for the given field & value. Returns the
3185 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003186 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003187
3188 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003189 // Internal Helpers
3190 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003191
Chris Lattner5b1964b2008-11-11 07:41:27 +00003192 /// ContainsLabel - Return true if the statement contains a label in it. If
3193 /// this statement is not executed normally, it not containing a label means
3194 /// that we can just remove the code.
3195 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003196
Chris Lattner29911cc2011-02-28 00:18:40 +00003197 /// containsBreak - Return true if the statement contains a break out of it.
3198 /// If the statement (recursively) contains a switch or loop with a break
3199 /// inside of it, this is fine.
3200 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003201
3202 /// Determine if the given statement might introduce a declaration into the
3203 /// current scope, by being a (possibly-labelled) DeclStmt.
3204 static bool mightAddDeclToScope(const Stmt *S);
Chris Lattner29911cc2011-02-28 00:18:40 +00003205
Daniel Dunbar682712c2008-11-12 10:12:14 +00003206 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003207 /// to a constant, or if it does but contains a label, return false. If it
3208 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003209 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3210 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003211
Chris Lattner29911cc2011-02-28 00:18:40 +00003212 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3213 /// to a constant, or if it does but contains a label, return false. If it
3214 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003215 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3216 bool AllowLabels = false);
3217
Chris Lattnercd439292008-11-12 08:04:58 +00003218 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3219 /// if statement) to the specified blocks. Based on the condition, this might
3220 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003221 /// TrueCount should be the number of times we expect the condition to
3222 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003223 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003224 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003225
Richard Smithe30752c2012-10-09 19:52:38 +00003226 /// \brief Emit a description of a type in a format suitable for passing to
3227 /// a runtime sanitizer handler.
3228 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3229
3230 /// \brief Convert a value into a format suitable for passing to a runtime
3231 /// sanitizer handler.
3232 llvm::Value *EmitCheckValue(llvm::Value *V);
3233
3234 /// \brief Emit a description of a source location in a format suitable for
3235 /// passing to a runtime sanitizer handler.
3236 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3237
Richard Smithde670682012-11-01 22:15:34 +00003238 /// \brief Create a basic block that will call a handler function in a
3239 /// sanitizer runtime with the provided arguments, and create a conditional
3240 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003241 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003242 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
3243 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003244
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003245 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3246 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003247 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3248 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3249 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003250
Richard Smithde670682012-11-01 22:15:34 +00003251 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3252 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003253 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003254
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003255 /// \brief Emit a call to trap or debugtrap and attach function attribute
3256 /// "trap-func-name" if specified.
3257 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3258
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003259 /// \brief Emit a cross-DSO CFI failure handling function.
3260 void EmitCfiCheckFail();
3261
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003262 /// \brief Create a check for a function parameter that may potentially be
3263 /// declared as non-null.
3264 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
3265 const FunctionDecl *FD, unsigned ParmNum);
3266
Anders Carlsson093bdff2010-03-30 03:27:09 +00003267 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003268 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003269
John McCall23f66262010-05-26 22:34:26 +00003270 /// EmitDelegateCallArg - We are performing a delegate call; that
3271 /// is, the current function is delegating to another one. Produce
3272 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003273 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3274 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003275
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003276 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3277 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003278 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003279
Chris Lattnercd439292008-11-12 08:04:58 +00003280private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003281 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003282 void EmitReturnOfRValue(RValue RV, QualType Ty);
3283
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003284 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3285
3286 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3287 DeferredReplacements;
3288
John McCall7f416cc2015-09-08 08:05:57 +00003289 /// Set the address of a local variable.
3290 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3291 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3292 LocalDeclMap.insert({VD, Addr});
3293 }
3294
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003295 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3296 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3297 ///
3298 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003299 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003300 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003301
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003302 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3303 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3304 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3305 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3306 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3307 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003308
Chad Rosier59df25b2012-08-23 20:00:18 +00003309 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003310 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003311
Chad Rosier59df25b2012-08-23 20:00:18 +00003312 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003313 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003314 std::string &ConstraintStr,
3315 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003316
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003317 /// \brief Attempts to statically evaluate the object size of E. If that
3318 /// fails, emits code to figure the size of E out for us. This is
3319 /// pass_object_size aware.
3320 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
3321 llvm::IntegerType *ResType);
3322
3323 /// \brief Emits the size of E, as required by __builtin_object_size. This
3324 /// function is aware of pass_object_size parameters, and will act accordingly
3325 /// if E is a parameter with the pass_object_size attribute.
3326 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
3327 llvm::IntegerType *ResType);
3328
Reid Kleckner89077a12013-12-17 19:46:40 +00003329public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003330#ifndef NDEBUG
3331 // Determine whether the given argument is an Objective-C method
3332 // that may have type parameters in its signature.
3333 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3334 const DeclContext *dc = method->getDeclContext();
3335 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3336 return classDecl->getTypeParamListAsWritten();
3337 }
3338
3339 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3340 return catDecl->getTypeParamList();
3341 }
3342
3343 return false;
3344 }
3345
3346 template<typename T>
3347 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3348#endif
3349
Richard Smitha560ccf2016-09-29 21:30:12 +00003350 enum class EvaluationOrder {
3351 ///! No language constraints on evaluation order.
3352 Default,
3353 ///! Language semantics require left-to-right evaluation.
3354 ForceLeftToRight,
3355 ///! Language semantics require right-to-left evaluation.
3356 ForceRightToLeft
3357 };
3358
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003359 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003360 template <typename T>
3361 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003362 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003363 const FunctionDecl *CalleeDecl = nullptr,
Richard Smith762672a2016-09-28 19:09:10 +00003364 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003365 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003366 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003367 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003368
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003369 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3370 "Can't skip parameters if type info is not provided");
3371 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003372#ifndef NDEBUG
3373 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3374#endif
3375
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003376 // First, use the argument types that the type info knows about
3377 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3378 E = CallArgTypeInfo->param_type_end();
3379 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003380 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003381 assert((isGenericMethod ||
3382 ((*I)->isVariablyModifiedType() ||
3383 (*I).getNonReferenceType()->isObjCRetainableType() ||
3384 getContext()
3385 .getCanonicalType((*I).getNonReferenceType())
3386 .getTypePtr() ==
3387 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003388 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003389 .getTypePtr())) &&
3390 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003391 ArgTypes.push_back(*I);
3392 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003393 }
Mike Stump11289f42009-09-09 15:08:12 +00003394
Reid Kleckner739756c2013-12-04 19:23:12 +00003395 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003396 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003397 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3398 CallArgTypeInfo->isVariadic()) &&
3399 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003400
Anders Carlsson603d6af2009-04-18 20:20:22 +00003401 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003402 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
3403 ArgTypes.push_back(getVarArgType(A));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003404
Richard Smitha560ccf2016-09-29 21:30:12 +00003405 EmitCallArgs(Args, ArgTypes, ArgRange, CalleeDecl, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003406 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003407
Reid Kleckner739756c2013-12-04 19:23:12 +00003408 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003409 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003410 const FunctionDecl *CalleeDecl = nullptr,
Richard Smith762672a2016-09-28 19:09:10 +00003411 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003412 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00003413
John McCall7f416cc2015-09-08 08:05:57 +00003414 /// EmitPointerWithAlignment - Given an expression with a pointer
3415 /// type, emit the value and compute our best estimate of the
3416 /// alignment of the pointee.
3417 ///
3418 /// Note that this function will conservatively fall back on the type
3419 /// when it doesn't
3420 ///
3421 /// \param Source - If non-null, this will be initialized with
3422 /// information about the source of the alignment. Note that this
3423 /// function will conservatively fall back on the type when it
3424 /// doesn't recognize the expression, which means that sometimes
3425 ///
3426 /// a worst-case One
3427 /// reasonable way to use this information is when there's a
3428 /// language guarantee that the pointer must be aligned to some
3429 /// stricter value, and we're simply trying to ensure that
3430 /// sufficiently obvious uses of under-aligned objects don't get
3431 /// miscompiled; for example, a placement new into the address of
3432 /// a local variable. In such a case, it's quite reasonable to
3433 /// just ignore the returned alignment when it isn't from an
3434 /// explicit source.
3435 Address EmitPointerWithAlignment(const Expr *Addr,
3436 AlignmentSource *Source = nullptr);
3437
Peter Collingbournedc134532016-01-16 00:31:22 +00003438 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3439
Reid Kleckner89077a12013-12-17 19:46:40 +00003440private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003441 QualType getVarArgType(const Expr *Arg);
3442
John McCalld4f4b7f2010-03-03 04:15:11 +00003443 const TargetCodeGenInfo &getTargetHooks() const {
3444 return CGM.getTargetCodeGenInfo();
3445 }
John McCall09ae0322010-07-06 23:57:41 +00003446
3447 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003448
John McCall7f416cc2015-09-08 08:05:57 +00003449 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3450 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003451
3452 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003453
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003454 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003455};
Mike Stump11289f42009-09-09 15:08:12 +00003456
John McCallce1de612011-01-26 04:00:11 +00003457/// Helper class with most of the code for saving a value for a
3458/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003459struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003460 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3461
3462 /// Answer whether the given value needs extra work to be saved.
3463 static bool needsSaving(llvm::Value *value) {
3464 // If it's not an instruction, we don't need to save.
3465 if (!isa<llvm::Instruction>(value)) return false;
3466
3467 // If it's an instruction in the entry block, we don't need to save.
3468 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3469 return (block != &block->getParent()->getEntryBlock());
3470 }
3471
3472 /// Try to save the given value.
3473 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3474 if (!needsSaving(value)) return saved_type(value, false);
3475
John McCall7f416cc2015-09-08 08:05:57 +00003476 // Otherwise, we need an alloca.
3477 auto align = CharUnits::fromQuantity(
3478 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3479 Address alloca =
3480 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003481 CGF.Builder.CreateStore(value, alloca);
3482
John McCall7f416cc2015-09-08 08:05:57 +00003483 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003484 }
3485
3486 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003487 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003488 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003489
3490 // Otherwise, it should be an alloca instruction, as set up in save().
3491 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3492 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003493 }
3494};
3495
John McCallcb5f77f2011-01-28 10:53:53 +00003496/// A partial specialization of DominatingValue for llvm::Values that
3497/// might be llvm::Instructions.
3498template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3499 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003500 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003501 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3502 }
3503};
3504
John McCall7f416cc2015-09-08 08:05:57 +00003505/// A specialization of DominatingValue for Address.
3506template <> struct DominatingValue<Address> {
3507 typedef Address type;
3508
3509 struct saved_type {
3510 DominatingLLVMValue::saved_type SavedValue;
3511 CharUnits Alignment;
3512 };
3513
3514 static bool needsSaving(type value) {
3515 return DominatingLLVMValue::needsSaving(value.getPointer());
3516 }
3517 static saved_type save(CodeGenFunction &CGF, type value) {
3518 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3519 value.getAlignment() };
3520 }
3521 static type restore(CodeGenFunction &CGF, saved_type value) {
3522 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3523 value.Alignment);
3524 }
3525};
3526
John McCallcb5f77f2011-01-28 10:53:53 +00003527/// A specialization of DominatingValue for RValue.
3528template <> struct DominatingValue<RValue> {
3529 typedef RValue type;
3530 class saved_type {
3531 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3532 AggregateAddress, ComplexAddress };
3533
3534 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003535 unsigned K : 3;
3536 unsigned Align : 29;
3537 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3538 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003539
3540 public:
3541 static bool needsSaving(RValue value);
3542 static saved_type save(CodeGenFunction &CGF, RValue value);
3543 RValue restore(CodeGenFunction &CGF);
3544
John McCall7f416cc2015-09-08 08:05:57 +00003545 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003546 };
3547
3548 static bool needsSaving(type value) {
3549 return saved_type::needsSaving(value);
3550 }
3551 static saved_type save(CodeGenFunction &CGF, type value) {
3552 return saved_type::save(CGF, value);
3553 }
3554 static type restore(CodeGenFunction &CGF, saved_type value) {
3555 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003556 }
3557};
3558
Chris Lattnerbed31442007-05-28 01:07:47 +00003559} // end namespace CodeGen
3560} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003561
Chris Lattnerbed31442007-05-28 01:07:47 +00003562#endif