blob: dade4612ce7e8e5c95486e122f744a2252ce5b17 [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;
John McCallb92ab1a2016-10-26 23:46:34 +000081class CGCallee;
Rafael Espindola42ae7452014-05-09 00:57:59 +000082class CGFunctionInfo;
83class CGRecordLayout;
84class CGBlockInfo;
85class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000086class BlockByrefHelpers;
87class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000088class BlockFlags;
89class BlockFieldFlags;
Alexey Bataev7292c292016-04-25 12:22:29 +000090class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000091class TargetCodeGenInfo;
Alexey Bataev24b5bae2016-04-28 09:23:51 +000092struct OMPTaskDataTy;
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000093struct CGCoroData;
Mike Stumpfc496822009-02-08 23:14:22 +000094
John McCall47fb9502013-03-07 21:37:08 +000095/// The kind of evaluation to perform on values of a particular
96/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
97/// CGExprAgg?
98///
99/// TODO: should vectors maybe be split out into their own thing?
100enum TypeEvaluationKind {
101 TEK_Scalar,
102 TEK_Complex,
103 TEK_Aggregate
104};
105
Chris Lattnerbed31442007-05-28 01:07:47 +0000106/// CodeGenFunction - This class organizes the per-function state that is used
107/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000108class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000109 CodeGenFunction(const CodeGenFunction &) = delete;
110 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000111
112 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000113public:
John McCallad5d61e2010-07-23 21:56:41 +0000114 /// A jump destination is an abstract label, branching to which may
115 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000116 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000117 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000118 JumpDest(llvm::BasicBlock *Block,
119 EHScopeStack::stable_iterator Depth,
120 unsigned Index)
121 : Block(Block), ScopeDepth(Depth), Index(Index) {}
122
Craig Topper8a13c412014-05-21 05:09:00 +0000123 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000124 llvm::BasicBlock *getBlock() const { return Block; }
125 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
126 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000127
Nadav Rotem1da30942013-03-23 06:43:35 +0000128 // This should be used cautiously.
129 void setScopeDepth(EHScopeStack::stable_iterator depth) {
130 ScopeDepth = depth;
131 }
132
John McCallad5d61e2010-07-23 21:56:41 +0000133 private:
John McCallbd309292010-07-06 01:34:17 +0000134 llvm::BasicBlock *Block;
135 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000136 unsigned Index;
137 };
138
Chris Lattnerbed31442007-05-28 01:07:47 +0000139 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000140 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000141
Chris Lattner96d72562007-08-21 16:57:55 +0000142 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000143 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000144 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000145
Vitaly Buka64c80b42016-10-26 05:42:30 +0000146 // Stores variables for which we can't generate correct lifetime markers
147 // because of jumps.
148 VarBypassDetector Bypasses;
149
Alexander Musman515ad8c2014-05-22 08:54:05 +0000150 /// \brief CGBuilder insert helper. This function is called after an
151 /// instruction is created using Builder.
152 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
153 llvm::BasicBlock *BB,
154 llvm::BasicBlock::iterator InsertPt) const;
155
John McCalldec348f72013-05-03 07:33:41 +0000156 /// CurFuncDecl - Holds the Decl for the current outermost
157 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000158 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000159 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
160 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000161 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000162 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000163 llvm::Function *CurFn;
164
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000165 // Holds coroutine data if the current function is a coroutine. We use a
166 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
167 // in this header.
168 struct CGCoroInfo {
169 std::unique_ptr<CGCoroData> Data;
170 CGCoroInfo();
171 ~CGCoroInfo();
172 };
173 CGCoroInfo CurCoro;
174
Mike Stumpbee78dd2009-12-04 23:26:17 +0000175 /// CurGD - The GlobalDecl for the current function being compiled.
176 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000177
John McCall31168b02011-06-15 23:02:42 +0000178 /// PrologueCleanupDepth - The cleanup depth enclosing all the
179 /// cleanups associated with the parameters.
180 EHScopeStack::stable_iterator PrologueCleanupDepth;
181
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000182 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000183 JumpDest ReturnBlock;
184
John McCall7f416cc2015-09-08 08:05:57 +0000185 /// ReturnValue - The temporary alloca to hold the return
186 /// value. This is invalid iff the function has no return value.
187 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000188
Chris Lattner03df1222007-06-02 04:53:11 +0000189 /// AllocaInsertPoint - This is an instruction in the entry block before which
190 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000191 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000192
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000193 /// \brief API for captured statement code generation.
194 class CGCapturedStmtInfo {
195 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000196 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
197 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000198 explicit CGCapturedStmtInfo(const CapturedStmt &S,
199 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000200 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000201
202 RecordDecl::field_iterator Field =
203 S.getCapturedRecordDecl()->field_begin();
204 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
205 E = S.capture_end();
206 I != E; ++I, ++Field) {
207 if (I->capturesThis())
208 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000209 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000210 CaptureFields[I->getCapturedVar()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000211 else if (I->capturesVariableByCopy())
212 CaptureFields[I->getCapturedVar()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000213 }
214 }
215
216 virtual ~CGCapturedStmtInfo();
217
218 CapturedRegionKind getKind() const { return Kind; }
219
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000220 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000221 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000222 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000223
224 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000225 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000226 return CaptureFields.lookup(VD);
227 }
228
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000229 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
230 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000231
Alexey Bataev18095712014-10-10 12:19:54 +0000232 static bool classof(const CGCapturedStmtInfo *) {
233 return true;
234 }
235
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000236 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000237 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000238 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000239 CGF.EmitStmt(S);
240 }
241
242 /// \brief Get the name of the capture helper.
243 virtual StringRef getHelperName() const { return "__captured_stmt"; }
244
245 private:
246 /// \brief The kind of captured statement being generated.
247 CapturedRegionKind Kind;
248
249 /// \brief Keep the map between VarDecl and FieldDecl.
250 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
251
252 /// \brief The base address of the captured record, passed in as the first
253 /// argument of the parallel region function.
254 llvm::Value *ThisValue;
255
256 /// \brief Captured 'this' type.
257 FieldDecl *CXXThisFieldDecl;
258 };
259 CGCapturedStmtInfo *CapturedStmtInfo;
260
Alexey Bataevd157d472015-06-24 03:35:38 +0000261 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
262 class CGCapturedStmtRAII {
263 private:
264 CodeGenFunction &CGF;
265 CGCapturedStmtInfo *PrevCapturedStmtInfo;
266 public:
267 CGCapturedStmtRAII(CodeGenFunction &CGF,
268 CGCapturedStmtInfo *NewCapturedStmtInfo)
269 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
270 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
271 }
272 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
273 };
274
Alexey Samsonova0416102014-11-11 01:26:14 +0000275 /// \brief Sanitizers enabled for this function.
276 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000277
Alexey Samsonov24cad992014-07-17 18:46:27 +0000278 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
279 bool IsSanitizerScope;
280
281 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
282 class SanitizerScope {
283 CodeGenFunction *CGF;
284 public:
285 SanitizerScope(CodeGenFunction *CGF);
286 ~SanitizerScope();
287 };
288
Reid Kleckner19819442014-07-25 21:39:46 +0000289 /// In C++, whether we are code generating a thunk. This controls whether we
290 /// should emit cleanups.
291 bool CurFuncIsThunk;
292
John McCall31168b02011-06-15 23:02:42 +0000293 /// In ARC, whether we should autorelease the return value.
294 bool AutoreleaseResult;
295
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000296 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
297 /// potentially set the return value.
298 bool SawAsmBlock;
299
David Majnemer25eb1652016-03-01 19:42:53 +0000300 const FunctionDecl *CurSEHParent = nullptr;
301
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000302 /// True if the current function is an outlined SEH helper. This can be a
303 /// finally block or filter expression.
304 bool IsOutlinedSEHHelper;
305
John McCallad7c5c12011-02-08 08:22:06 +0000306 const CodeGen::CGBlockInfo *BlockInfo;
307 llvm::Value *BlockPointer;
308
Eli Friedman9fbeba02012-02-11 02:57:39 +0000309 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
310 FieldDecl *LambdaThisCaptureField;
311
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000312 /// \brief A mapping from NRVO variables to the flags used to indicate
313 /// when the NRVO has been applied to this variable.
314 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000315
John McCallbd309292010-07-06 01:34:17 +0000316 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000317 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000318 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000319
David Majnemer4e52d6f2015-12-12 05:39:21 +0000320 llvm::Instruction *CurrentFuncletPad = nullptr;
321
Tim Shen421119f2016-07-01 21:08:47 +0000322 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
323 llvm::Value *Addr;
324 llvm::Value *Size;
325
326 public:
327 CallLifetimeEnd(Address addr, llvm::Value *size)
328 : Addr(addr.getPointer()), Size(size) {}
329
330 void Emit(CodeGenFunction &CGF, Flags flags) override {
331 CGF.EmitLifetimeEnd(Size, Addr);
332 }
333 };
334
Richard Smith736a9472013-06-12 20:42:33 +0000335 /// Header for data within LifetimeExtendedCleanupStack.
336 struct LifetimeExtendedCleanupHeader {
337 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000338 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000339 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000340 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000341
Justin Bognerbdff2192015-07-01 00:59:27 +0000342 size_t getSize() const { return Size; }
343 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000344 };
John McCallbd309292010-07-06 01:34:17 +0000345
John McCallad5d61e2010-07-23 21:56:41 +0000346 /// i32s containing the indexes of the cleanup destinations.
347 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000348
349 unsigned NextCleanupDestIndex;
350
John McCall08ef4662011-11-10 08:15:53 +0000351 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
352 CGBlockInfo *FirstBlockInfo;
353
John McCall8e4c74b2011-08-11 02:22:43 +0000354 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
355 llvm::BasicBlock *EHResumeBlock;
356
Bill Wendlingf0724e82011-09-19 20:31:14 +0000357 /// The exception slot. All landing pads write the current exception pointer
358 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000359 llvm::Value *ExceptionSlot;
360
Bill Wendlingf0724e82011-09-19 20:31:14 +0000361 /// The selector slot. Under the MandatoryCleanup model, all landing pads
362 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000363 llvm::AllocaInst *EHSelectorSlot;
364
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000365 /// A stack of exception code slots. Entering an __except block pushes a slot
366 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
367 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000368 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000369
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000370 /// Value returned by __exception_info intrinsic.
371 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000372
John McCallbd309292010-07-06 01:34:17 +0000373 /// Emits a landing pad for the current EH stack.
374 llvm::BasicBlock *EmitLandingPad();
375
376 llvm::BasicBlock *getInvokeDestImpl();
377
John McCallce1de612011-01-26 04:00:11 +0000378 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000379 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
380 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000381 }
382
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000383public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000384 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
385 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000386 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000387
John McCall6b0feb72011-06-22 02:32:12 +0000388 /// A class controlling the emission of a finally block.
389 class FinallyInfo {
390 /// Where the catchall's edge through the cleanup should go.
391 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000392
John McCall6b0feb72011-06-22 02:32:12 +0000393 /// A function to call to enter the catch.
394 llvm::Constant *BeginCatchFn;
395
396 /// An i1 variable indicating whether or not the @finally is
397 /// running for an exception.
398 llvm::AllocaInst *ForEHVar;
399
400 /// An i8* variable into which the exception pointer to rethrow
401 /// has been saved.
402 llvm::AllocaInst *SavedExnVar;
403
404 public:
405 void enter(CodeGenFunction &CGF, const Stmt *Finally,
406 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
407 llvm::Constant *rethrowFn);
408 void exit(CodeGenFunction &CGF);
409 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000410
Reid Kleckner11c033e2015-02-12 23:40:45 +0000411 /// Returns true inside SEH __try blocks.
412 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
413
Reid Klecknera002bd52015-10-28 23:06:42 +0000414 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000415 bool isCleanupPadScope() const {
416 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
417 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000418
John McCallce1de612011-01-26 04:00:11 +0000419 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
420 /// current full-expression. Safe against the possibility that
421 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000422 template <class T, class... As>
423 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000424 // If we're not in a conditional branch, or if none of the
425 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000426 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000427 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000428
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000429 // Stash values in a tuple so we can guarantee the order of saves.
430 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
431 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000432
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000433 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000434 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000435 initFullExprCleanup();
436 }
437
Richard Smith736a9472013-06-12 20:42:33 +0000438 /// \brief Queue a cleanup to be pushed after finishing the current
439 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000440 template <class T, class... As>
441 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000442 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
443
444 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
445
446 size_t OldSize = LifetimeExtendedCleanupStack.size();
447 LifetimeExtendedCleanupStack.resize(
448 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
449
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000450 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000451 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000452 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
453 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000454 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000455 }
456
John McCallf4beacd2011-11-10 10:43:54 +0000457 /// Set up the last cleaup that was pushed as a conditional
458 /// full-expression cleanup.
459 void initFullExprCleanup();
460
John McCallbd309292010-07-06 01:34:17 +0000461 /// PushDestructorCleanup - Push a cleanup to call the
462 /// complete-object destructor of an object of the given type at the
463 /// given address. Does nothing if T is not a C++ class type with a
464 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000465 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000466
John McCall8680f872010-07-21 06:29:51 +0000467 /// PushDestructorCleanup - Push a cleanup to call the
468 /// complete-object variant of the given destructor on the object at
469 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000470 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000471
John McCallbd309292010-07-06 01:34:17 +0000472 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
473 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000474 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000475
John McCall824c2f52010-09-14 07:57:04 +0000476 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
477 /// The block cannot be reactivated. Pops it if it's the top of the
478 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000479 ///
480 /// \param DominatingIP - An instruction which is known to
481 /// dominate the current IP (if set) and which lies along
482 /// all paths of execution between the current IP and the
483 /// the point at which the cleanup comes into scope.
484 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
485 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000486
487 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
488 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000489 ///
490 /// \param DominatingIP - An instruction which is known to
491 /// dominate the current IP (if set) and which lies along
492 /// all paths of execution between the current IP and the
493 /// the point at which the cleanup comes into scope.
494 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
495 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000496
John McCallbd309292010-07-06 01:34:17 +0000497 /// \brief Enters a new scope for capturing cleanups, all of which
498 /// will be executed once the scope is exited.
499 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000500 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000501 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000502 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000503 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000504 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000505 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000506
Aaron Ballmanabc18922015-02-15 22:54:08 +0000507 RunCleanupsScope(const RunCleanupsScope &) = delete;
508 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000509
Eric Christophera9d34972011-10-19 00:43:52 +0000510 protected:
511 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000512
Douglas Gregor965f4502009-11-24 16:43:22 +0000513 public:
514 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000515 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000516 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000517 {
John McCallbd309292010-07-06 01:34:17 +0000518 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000519 LifetimeExtendedCleanupStackSize =
520 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000521 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000522 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000523 }
524
525 /// \brief Exit this cleanup scope, emitting any accumulated
526 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000527 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000528 if (PerformCleanup) {
529 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000530 CGF.PopCleanupBlocks(CleanupStackDepth,
531 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000532 }
533 }
534
535 /// \brief Determine whether this scope requires any cleanups.
536 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000537 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000538 }
539
540 /// \brief Force the emission of cleanups now, instead of waiting
541 /// until this object is destroyed.
542 void ForceCleanup() {
543 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000544 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000545 CGF.PopCleanupBlocks(CleanupStackDepth,
546 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000547 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000548 }
549 };
550
David Blaikie93be0b22014-08-22 21:37:04 +0000551 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000552 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000553 SmallVector<const LabelDecl*, 4> Labels;
554 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000555
Aaron Ballmanabc18922015-02-15 22:54:08 +0000556 LexicalScope(const LexicalScope &) = delete;
557 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000558
559 public:
560 /// \brief Enter a new cleanup scope.
561 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000562 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
563 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000564 if (CGDebugInfo *DI = CGF.getDebugInfo())
565 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
566 }
567
Nadav Rotem1da30942013-03-23 06:43:35 +0000568 void addLabel(const LabelDecl *label) {
569 assert(PerformCleanup && "adding label to dead scope?");
570 Labels.push_back(label);
571 }
572
Eric Christophera9d34972011-10-19 00:43:52 +0000573 /// \brief Exit this cleanup scope, emitting any accumulated
574 /// cleanups.
575 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000576 if (CGDebugInfo *DI = CGF.getDebugInfo())
577 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
578
Nadav Rotem1da30942013-03-23 06:43:35 +0000579 // If we should perform a cleanup, force them now. Note that
580 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000581 if (PerformCleanup) {
582 ApplyDebugLocation DL(CGF, Range.getEnd());
583 ForceCleanup();
584 }
Eric Christophera9d34972011-10-19 00:43:52 +0000585 }
586
587 /// \brief Force the emission of cleanups now, instead of waiting
588 /// until this object is destroyed.
589 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000590 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000591 RunCleanupsScope::ForceCleanup();
592
Nadav Rotem1da30942013-03-23 06:43:35 +0000593 if (!Labels.empty())
594 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000595 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000596
597 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000598 };
599
John McCall7f416cc2015-09-08 08:05:57 +0000600 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
601
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000602 /// \brief The scope used to remap some variables as private in the OpenMP
603 /// loop body (or other captured region emitted without outlining), and to
604 /// restore old vars back on exit.
605 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000606 DeclMapTy SavedLocals;
607 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000608
609 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000610 OMPPrivateScope(const OMPPrivateScope &) = delete;
611 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000612
613 public:
614 /// \brief Enter a new OpenMP private scope.
615 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
616
617 /// \brief Registers \a LocalVD variable as a private and apply \a
618 /// PrivateGen function for it to generate corresponding private variable.
619 /// \a PrivateGen returns an address of the generated private variable.
620 /// \return true if the variable is registered as private, false if it has
621 /// been privatized already.
622 bool
623 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000624 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000625 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000626
627 // Only save it once.
628 if (SavedLocals.count(LocalVD)) return false;
629
630 // Copy the existing local entry to SavedLocals.
631 auto it = CGF.LocalDeclMap.find(LocalVD);
632 if (it != CGF.LocalDeclMap.end()) {
633 SavedLocals.insert({LocalVD, it->second});
634 } else {
635 SavedLocals.insert({LocalVD, Address::invalid()});
636 }
637
638 // Generate the private entry.
639 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000640 QualType VarTy = LocalVD->getType();
641 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000642 Address Temp = CGF.CreateMemTemp(VarTy);
643 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
644 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000645 }
John McCall7f416cc2015-09-08 08:05:57 +0000646 SavedPrivates.insert({LocalVD, Addr});
647
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000648 return true;
649 }
650
651 /// \brief Privatizes local variables previously registered as private.
652 /// Registration is separate from the actual privatization to allow
653 /// initializers use values of the original variables, not the private one.
654 /// This is important, for example, if the private variable is a class
655 /// variable initialized by a constructor that references other private
656 /// variables. But at initialization original variables must be used, not
657 /// private copies.
658 /// \return true if at least one variable was privatized, false otherwise.
659 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000660 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000661 SavedPrivates.clear();
662 return !SavedLocals.empty();
663 }
664
665 void ForceCleanup() {
666 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000667 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000668 SavedLocals.clear();
669 }
670
671 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000672 ~OMPPrivateScope() {
673 if (PerformCleanup)
674 ForceCleanup();
675 }
John McCall7f416cc2015-09-08 08:05:57 +0000676
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000677 /// Checks if the global variable is captured in current function.
678 bool isGlobalVarCaptured(const VarDecl *VD) const {
679 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
680 }
681
John McCall7f416cc2015-09-08 08:05:57 +0000682 private:
683 /// Copy all the entries in the source map over the corresponding
684 /// entries in the destination, which must exist.
685 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
686 for (auto &pair : src) {
687 if (!pair.second.isValid()) {
688 dest.erase(pair.first);
689 continue;
690 }
691
692 auto it = dest.find(pair.first);
693 if (it != dest.end()) {
694 it->second = pair.second;
695 } else {
696 dest.insert(pair);
697 }
698 }
699 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000700 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000701
Richard Smith736a9472013-06-12 20:42:33 +0000702 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
703 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000704 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000705
Richard Smith736a9472013-06-12 20:42:33 +0000706 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
707 /// that have been added, then adds all lifetime-extended cleanups from
708 /// the given position to the stack.
709 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
710 size_t OldLifetimeExtendedStackSize);
711
John McCallad5d61e2010-07-23 21:56:41 +0000712 void ResolveBranchFixups(llvm::BasicBlock *Target);
713
John McCallbd309292010-07-06 01:34:17 +0000714 /// The given basic block lies in the current EH scope, but may be a
715 /// target of a potentially scope-crossing jump; get a stable handle
716 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000717 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000718 return JumpDest(Target,
719 EHStack.getInnermostNormalCleanup(),
720 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000721 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000722
John McCallbd309292010-07-06 01:34:17 +0000723 /// The given basic block lies in the current EH scope, but may be a
724 /// target of a potentially scope-crossing jump; get a stable handle
725 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000726 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000727 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000728 }
729
730 /// EmitBranchThroughCleanup - Emit a branch from the current insert
731 /// block through the normal cleanup handling code (if any) and then
732 /// on to \arg Dest.
733 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000734
Justin Bognere25ffdf2014-01-21 00:35:11 +0000735 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
736 /// specified destination obviously has no cleanups to run. 'false' is always
737 /// a conservatively correct answer for this method.
738 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
739
John McCall8e4c74b2011-08-11 02:22:43 +0000740 /// popCatchScope - Pops the catch scope at the top of the EHScope
741 /// stack, emitting any required code (other than the catch handlers
742 /// themselves).
743 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000744
David Chisnall9a837be2012-11-07 16:50:40 +0000745 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000746 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000747 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000748
John McCallce1de612011-01-26 04:00:11 +0000749 /// An object to manage conditionally-evaluated expressions.
750 class ConditionalEvaluation {
751 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000752
John McCallce1de612011-01-26 04:00:11 +0000753 public:
754 ConditionalEvaluation(CodeGenFunction &CGF)
755 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000756
John McCallce1de612011-01-26 04:00:11 +0000757 void begin(CodeGenFunction &CGF) {
758 assert(CGF.OutermostConditional != this);
759 if (!CGF.OutermostConditional)
760 CGF.OutermostConditional = this;
761 }
762
763 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000764 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000765 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000766 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000767 }
768
769 /// Returns a block which will be executed prior to each
770 /// evaluation of the conditional code.
771 llvm::BasicBlock *getStartingBlock() const {
772 return StartBB;
773 }
774 };
Mike Stump11289f42009-09-09 15:08:12 +0000775
John McCall7f9c92a2010-09-17 00:50:28 +0000776 /// isInConditionalBranch - Return true if we're currently emitting
777 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000778 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000779
John McCall7f416cc2015-09-08 08:05:57 +0000780 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000781 assert(isInConditionalBranch());
782 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000783 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
784 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000785 }
786
John McCallce1de612011-01-26 04:00:11 +0000787 /// An RAII object to record that we're evaluating a statement
788 /// expression.
789 class StmtExprEvaluation {
790 CodeGenFunction &CGF;
791
792 /// We have to save the outermost conditional: cleanups in a
793 /// statement expression aren't conditional just because the
794 /// StmtExpr is.
795 ConditionalEvaluation *SavedOutermostConditional;
796
797 public:
798 StmtExprEvaluation(CodeGenFunction &CGF)
799 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000800 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000801 }
802
803 ~StmtExprEvaluation() {
804 CGF.OutermostConditional = SavedOutermostConditional;
805 CGF.EnsureInsertPoint();
806 }
807 };
John McCall1bf58462011-02-16 08:02:54 +0000808
John McCallc07a0c72011-02-17 10:25:35 +0000809 /// An object which temporarily prevents a value from being
810 /// destroyed by aggressive peephole optimizations that assume that
811 /// all uses of a value have been realized in the IR.
812 class PeepholeProtection {
813 llvm::Instruction *Inst;
814 friend class CodeGenFunction;
815
816 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000817 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000818 };
John McCallc07a0c72011-02-17 10:25:35 +0000819
John McCallfe96e0b2011-11-06 09:01:30 +0000820 /// A non-RAII class containing all the information about a bound
821 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
822 /// this which makes individual mappings very simple; using this
823 /// class directly is useful when you have a variable number of
824 /// opaque values or don't want the RAII functionality for some
825 /// reason.
826 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000827 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000828 bool BoundLValue;
829 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000830
John McCallfe96e0b2011-11-06 09:01:30 +0000831 OpaqueValueMappingData(const OpaqueValueExpr *ov,
832 bool boundLValue)
833 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000834 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000835 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000836
John McCallc07a0c72011-02-17 10:25:35 +0000837 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000838 // gl-values should be bound as l-values for obvious reasons.
839 // Records should be bound as l-values because IR generation
840 // always keeps them in memory. Expressions of function type
841 // act exactly like l-values but are formally required to be
842 // r-values in C.
843 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000844 expr->getType()->isFunctionType() ||
845 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000846 }
847
John McCallfe96e0b2011-11-06 09:01:30 +0000848 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
849 const OpaqueValueExpr *ov,
850 const Expr *e) {
851 if (shouldBindAsLValue(ov))
852 return bind(CGF, ov, CGF.EmitLValue(e));
853 return bind(CGF, ov, CGF.EmitAnyExpr(e));
854 }
855
856 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
857 const OpaqueValueExpr *ov,
858 const LValue &lv) {
859 assert(shouldBindAsLValue(ov));
860 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
861 return OpaqueValueMappingData(ov, true);
862 }
863
864 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
865 const OpaqueValueExpr *ov,
866 const RValue &rv) {
867 assert(!shouldBindAsLValue(ov));
868 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
869
870 OpaqueValueMappingData data(ov, false);
871
872 // Work around an extremely aggressive peephole optimization in
873 // EmitScalarConversion which assumes that all other uses of a
874 // value are extant.
875 data.Protection = CGF.protectFromPeepholes(rv);
876
877 return data;
878 }
879
Craig Topper8a13c412014-05-21 05:09:00 +0000880 bool isValid() const { return OpaqueValue != nullptr; }
881 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000882
883 void unbind(CodeGenFunction &CGF) {
884 assert(OpaqueValue && "no data to unbind!");
885
886 if (BoundLValue) {
887 CGF.OpaqueLValues.erase(OpaqueValue);
888 } else {
889 CGF.OpaqueRValues.erase(OpaqueValue);
890 CGF.unprotectFromPeepholes(Protection);
891 }
892 }
893 };
894
895 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
896 class OpaqueValueMapping {
897 CodeGenFunction &CGF;
898 OpaqueValueMappingData Data;
899
900 public:
901 static bool shouldBindAsLValue(const Expr *expr) {
902 return OpaqueValueMappingData::shouldBindAsLValue(expr);
903 }
904
John McCallc07a0c72011-02-17 10:25:35 +0000905 /// Build the opaque value mapping for the given conditional
906 /// operator if it's the GNU ?: extension. This is a common
907 /// enough pattern that the convenience operator is really
908 /// helpful.
909 ///
910 OpaqueValueMapping(CodeGenFunction &CGF,
911 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000912 if (isa<ConditionalOperator>(op))
913 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000914 return;
John McCallc07a0c72011-02-17 10:25:35 +0000915
916 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000917 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
918 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000919 }
920
John McCall1bf58462011-02-16 08:02:54 +0000921 OpaqueValueMapping(CodeGenFunction &CGF,
922 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000923 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000924 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000925 }
926
927 OpaqueValueMapping(CodeGenFunction &CGF,
928 const OpaqueValueExpr *opaqueValue,
929 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000930 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000931 }
932
933 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000934 Data.unbind(CGF);
935 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000936 }
937
938 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000939 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000940 }
941 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000942
Chris Lattner2da04b32007-08-24 05:35:26 +0000943private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000944 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000945 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000946
John McCall9b382dd2011-05-28 21:13:02 +0000947 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
948 /// calling llvm.stacksave for multiple VLAs in the same scope.
949 bool DidCallStackSave;
950
Mike Stumpe5311b02009-11-30 20:08:49 +0000951 /// IndirectBranch - The first time an indirect goto is seen we create a block
952 /// with an indirect branch. Every time we see the address of a label taken,
953 /// we add the label to the indirect goto. Every subsequent indirect goto is
954 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000955 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000956
Mike Stumpfc496822009-02-08 23:14:22 +0000957 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
958 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000959 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000960
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000961 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
962 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
963 /// parameter.
964 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
965 SizeArguments;
966
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000967 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000968 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000969 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
970
Chris Lattnerac248202007-05-30 00:13:02 +0000971 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000972 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000973
Mike Stumpfc496822009-02-08 23:14:22 +0000974 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000975 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000976 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000977 BreakContinue(JumpDest Break, JumpDest Continue)
978 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000979
John McCallbd309292010-07-06 01:34:17 +0000980 JumpDest BreakBlock;
981 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000982 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000983 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000984
Justin Bogneref512b92014-01-06 22:27:43 +0000985 CodeGenPGO PGO;
986
Justin Bogner65512642015-05-02 05:00:55 +0000987 /// Calculate branch weights appropriate for PGO data
988 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
989 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
990 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
991 uint64_t LoopCount);
992
Justin Bogneref512b92014-01-06 22:27:43 +0000993public:
Justin Bogner66242d62015-04-23 23:06:47 +0000994 /// Increment the profiler's counter for the given statement.
995 void incrementProfileCounter(const Stmt *S) {
Rong Xu9837ef52016-02-04 18:39:09 +0000996 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Justin Bogner66242d62015-04-23 23:06:47 +0000997 PGO.emitCounterIncrement(Builder, S);
998 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +0000999 }
Justin Bogner66242d62015-04-23 23:06:47 +00001000
1001 /// Get the profiler's count for the given statement.
1002 uint64_t getProfileCount(const Stmt *S) {
1003 Optional<uint64_t> Count = PGO.getStmtCount(S);
1004 if (!Count.hasValue())
1005 return 0;
1006 return *Count;
1007 }
1008
1009 /// Set the profiler's current count.
1010 void setCurrentProfileCount(uint64_t Count) {
1011 PGO.setCurrentRegionCount(Count);
1012 }
1013
1014 /// Get the profiler's current count. This is generally the count for the most
1015 /// recently incremented counter.
1016 uint64_t getCurrentProfileCount() {
1017 return PGO.getCurrentRegionCount();
1018 }
1019
Justin Bogneref512b92014-01-06 22:27:43 +00001020private:
1021
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001022 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001023 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001024 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001025 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1026 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001027
Mike Stumpfc496822009-02-08 23:14:22 +00001028 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001029 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001030 llvm::BasicBlock *CaseRangeBlock;
1031
John McCallc07a0c72011-02-17 10:25:35 +00001032 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001033 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001034 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1035 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001036
Mike Stumpfc496822009-02-08 23:14:22 +00001037 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001038 // We track this by the size expression rather than the type itself because
1039 // in certain situations, like a const qualifier applied to an VLA typedef,
1040 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001041 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1042 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001043 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001044
John McCallbd309292010-07-06 01:34:17 +00001045 /// A block containing a single 'unreachable' instruction. Created
1046 /// lazily by getUnreachableBlock().
1047 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001048
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001049 /// Counts of the number return expressions in the function.
1050 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001051
1052 /// Count the number of simple (constant) return expressions in the function.
1053 unsigned NumSimpleReturnExprs;
1054
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001055 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001056 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001057
Richard Smith852c9db2013-04-20 22:23:05 +00001058public:
1059 /// A scope within which we are constructing the fields of an object which
1060 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1061 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1062 class FieldConstructionScope {
1063 public:
John McCall7f416cc2015-09-08 08:05:57 +00001064 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001065 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1066 CGF.CXXDefaultInitExprThis = This;
1067 }
1068 ~FieldConstructionScope() {
1069 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1070 }
1071
1072 private:
1073 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001074 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001075 };
1076
1077 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1078 /// is overridden to be the object under construction.
1079 class CXXDefaultInitExprScope {
1080 public:
1081 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001082 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1083 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1084 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1085 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001086 }
1087 ~CXXDefaultInitExprScope() {
1088 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001089 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001090 }
1091
1092 public:
1093 CodeGenFunction &CGF;
1094 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001095 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001096 };
1097
Richard Smith5179eb72016-06-28 19:03:57 +00001098 class InlinedInheritingConstructorScope {
1099 public:
1100 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1101 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1102 OldCurCodeDecl(CGF.CurCodeDecl),
1103 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1104 OldCXXABIThisValue(CGF.CXXABIThisValue),
1105 OldCXXThisValue(CGF.CXXThisValue),
1106 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1107 OldCXXThisAlignment(CGF.CXXThisAlignment),
1108 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1109 OldCXXInheritedCtorInitExprArgs(
1110 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1111 CGF.CurGD = GD;
1112 CGF.CurFuncDecl = CGF.CurCodeDecl =
1113 cast<CXXConstructorDecl>(GD.getDecl());
1114 CGF.CXXABIThisDecl = nullptr;
1115 CGF.CXXABIThisValue = nullptr;
1116 CGF.CXXThisValue = nullptr;
1117 CGF.CXXABIThisAlignment = CharUnits();
1118 CGF.CXXThisAlignment = CharUnits();
1119 CGF.ReturnValue = Address::invalid();
1120 CGF.FnRetTy = QualType();
1121 CGF.CXXInheritedCtorInitExprArgs.clear();
1122 }
1123 ~InlinedInheritingConstructorScope() {
1124 CGF.CurGD = OldCurGD;
1125 CGF.CurFuncDecl = OldCurFuncDecl;
1126 CGF.CurCodeDecl = OldCurCodeDecl;
1127 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1128 CGF.CXXABIThisValue = OldCXXABIThisValue;
1129 CGF.CXXThisValue = OldCXXThisValue;
1130 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1131 CGF.CXXThisAlignment = OldCXXThisAlignment;
1132 CGF.ReturnValue = OldReturnValue;
1133 CGF.FnRetTy = OldFnRetTy;
1134 CGF.CXXInheritedCtorInitExprArgs =
1135 std::move(OldCXXInheritedCtorInitExprArgs);
1136 }
1137
1138 private:
1139 CodeGenFunction &CGF;
1140 GlobalDecl OldCurGD;
1141 const Decl *OldCurFuncDecl;
1142 const Decl *OldCurCodeDecl;
1143 ImplicitParamDecl *OldCXXABIThisDecl;
1144 llvm::Value *OldCXXABIThisValue;
1145 llvm::Value *OldCXXThisValue;
1146 CharUnits OldCXXABIThisAlignment;
1147 CharUnits OldCXXThisAlignment;
1148 Address OldReturnValue;
1149 QualType OldFnRetTy;
1150 CallArgList OldCXXInheritedCtorInitExprArgs;
1151 };
1152
Richard Smith852c9db2013-04-20 22:23:05 +00001153private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001154 /// CXXThisDecl - When generating code for a C++ member function,
1155 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001156 ImplicitParamDecl *CXXABIThisDecl;
1157 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001158 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001159 CharUnits CXXABIThisAlignment;
1160 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001161
Richard Smith852c9db2013-04-20 22:23:05 +00001162 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1163 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001164 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001165
Richard Smith5179eb72016-06-28 19:03:57 +00001166 /// The values of function arguments to use when evaluating
1167 /// CXXInheritedCtorInitExprs within this context.
1168 CallArgList CXXInheritedCtorInitExprArgs;
1169
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001170 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1171 /// destructor, this will hold the implicit argument (e.g. VTT).
1172 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1173 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001174
John McCallce1de612011-01-26 04:00:11 +00001175 /// OutermostConditional - Points to the outermost active
1176 /// conditional control. This is used so that we know if a
1177 /// temporary should be destroyed conditionally.
1178 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001179
Nadav Rotem1da30942013-03-23 06:43:35 +00001180 /// The current lexical scope.
1181 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001182
Adrian Prantldc237b52013-05-16 00:41:26 +00001183 /// The current source location that should be used for exception
1184 /// handling code.
1185 SourceLocation CurEHLocation;
1186
John McCall7f416cc2015-09-08 08:05:57 +00001187 /// BlockByrefInfos - For each __block variable, contains
1188 /// information about the layout of the variable.
1189 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001190
John McCallbd309292010-07-06 01:34:17 +00001191 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001192 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001193 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001194
Vitaly Buka1c943322016-10-26 01:59:57 +00001195 /// True if we need emit the life-time markers.
1196 const bool ShouldEmitLifetimeMarkers;
1197
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001198 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1199 /// In the kernel metadata node, reference the kernel function and metadata
1200 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001201 /// - A node for the vec_type_hint(<type>) qualifier contains string
1202 /// "vec_type_hint", an undefined value of the <type> data type,
1203 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001204 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1205 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1206 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1207 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1208 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1209 llvm::Function *Fn);
1210
Chris Lattnerbed31442007-05-28 01:07:47 +00001211public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001212 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001213 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001214
John McCall8ed55a52010-09-02 09:58:18 +00001215 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001216 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001217 CGDebugInfo *getDebugInfo() {
1218 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001219 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001220 return DebugInfo;
1221 }
1222 void disableDebugInfo() { DisableDebugInfo = true; }
1223 void enableDebugInfo() { DisableDebugInfo = false; }
1224
John McCall31168b02011-06-15 23:02:42 +00001225 bool shouldUseFusedARCCalls() {
1226 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1227 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001228
David Blaikiebbafb8a2012-03-11 07:00:24 +00001229 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001230
Bill Wendlingf0724e82011-09-19 20:31:14 +00001231 /// Returns a pointer to the function's exception object and selector slot,
1232 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001233 Address getExceptionSlot();
1234 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001235
Bill Wendling79a70e42011-09-15 18:57:19 +00001236 /// Returns the contents of the function's exception object and selector
1237 /// slots.
1238 llvm::Value *getExceptionFromSlot();
1239 llvm::Value *getSelectorFromSlot();
1240
John McCall7f416cc2015-09-08 08:05:57 +00001241 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001242
John McCallbd309292010-07-06 01:34:17 +00001243 llvm::BasicBlock *getUnreachableBlock() {
1244 if (!UnreachableBlock) {
1245 UnreachableBlock = createBasicBlock("unreachable");
1246 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1247 }
1248 return UnreachableBlock;
1249 }
1250
1251 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001252 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001253 return getInvokeDestImpl();
1254 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001255
David Majnemer25eb1652016-03-01 19:42:53 +00001256 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001257
John McCallc8e01702013-04-16 22:48:15 +00001258 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001259 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001260
Daniel Dunbar12347492009-02-23 17:26:39 +00001261 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001262 // Cleanups
1263 //===--------------------------------------------------------------------===//
1264
John McCall7f416cc2015-09-08 08:05:57 +00001265 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001266
John McCall178360e2011-07-11 08:38:19 +00001267 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001268 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001269 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001270 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001271 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001272 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1273 llvm::Value *arrayEnd,
1274 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001275 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001276 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001277
John McCall4bd0fb12011-07-12 16:41:08 +00001278 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001279 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001280 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001281 Address addr, QualType type);
1282 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001283 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001284 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001285 QualType type, Destroyer *destroyer,
1286 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001287 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1288 llvm::Value *CompletePtr,
1289 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001290 void pushStackRestore(CleanupKind kind, Address SPMem);
1291 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001292 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001293 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001294 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001295 bool useEHCleanupForArray,
1296 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001297 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001298 QualType elementType, CharUnits elementAlign,
1299 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001300 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001301
Peter Collingbourne1425b452012-01-26 03:33:36 +00001302 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001303
John McCall82fe67b2011-07-09 01:37:26 +00001304 /// Determines whether an EH cleanup is required to destroy a type
1305 /// with the given destruction kind.
1306 bool needsEHCleanup(QualType::DestructionKind kind) {
1307 switch (kind) {
1308 case QualType::DK_none:
1309 return false;
1310 case QualType::DK_cxx_destructor:
1311 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001312 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001313 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001314 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001315 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1316 }
1317 llvm_unreachable("bad destruction kind");
1318 }
1319
John McCall4bd0fb12011-07-12 16:41:08 +00001320 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1321 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1322 }
1323
John McCall82fe67b2011-07-09 01:37:26 +00001324 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001325 // Objective-C
1326 //===--------------------------------------------------------------------===//
1327
Chris Lattner4bd55962008-03-30 23:03:07 +00001328 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001329
David Blaikief1425802015-01-14 00:04:42 +00001330 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001331
Mike Stumpfc496822009-02-08 23:14:22 +00001332 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001333 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1334 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001335 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001336 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001337 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001338 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001339
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001340 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1341 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001342
Mike Stumpfc496822009-02-08 23:14:22 +00001343 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1344 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001345 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1346 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001347 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001348 const ObjCPropertyImplDecl *propImpl,
1349 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001350
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001351 //===--------------------------------------------------------------------===//
1352 // Block Bits
1353 //===--------------------------------------------------------------------===//
1354
John McCall351762c2011-02-07 10:33:21 +00001355 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001356 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1357 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001358
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001359 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001360 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001361 const DeclMapTy &ldm,
1362 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001363
John McCallad7c5c12011-02-08 08:22:06 +00001364 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1365 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001366 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1367 const ObjCPropertyImplDecl *PID);
1368 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1369 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001370 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001371
John McCallad7c5c12011-02-08 08:22:06 +00001372 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1373
John McCall73064872011-03-31 01:59:53 +00001374 class AutoVarEmission;
1375
1376 void emitByrefStructureInit(const AutoVarEmission &emission);
1377 void enterByrefCleanup(const AutoVarEmission &emission);
1378
John McCall7f416cc2015-09-08 08:05:57 +00001379 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1380 llvm::Value *ptr);
1381
1382 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001383 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1384
1385 /// BuildBlockByrefAddress - Computes the location of the
1386 /// data in a variable which is declared as __block.
1387 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1388 bool followForward = true);
1389 Address emitBlockByrefAddress(Address baseAddr,
1390 const BlockByrefInfo &info,
1391 bool followForward,
1392 const llvm::Twine &name);
1393
1394 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001395
Richard Smith5179eb72016-06-28 19:03:57 +00001396 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1397
John McCalla738c252011-03-09 04:27:21 +00001398 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1399 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001400 /// \brief Emit code for the start of a function.
1401 /// \param Loc The location to be associated with the function.
1402 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001403 void StartFunction(GlobalDecl GD,
1404 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001405 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001406 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001407 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001408 SourceLocation Loc = SourceLocation(),
1409 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001410
John McCallb81884d2010-02-19 09:25:03 +00001411 void EmitConstructorBody(FunctionArgList &Args);
1412 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001413 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001414 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001415 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001416
Faisal Vali571df122013-09-29 08:45:24 +00001417 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001418 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001419 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001420 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001421 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1422 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001423 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001424
David Blaikiea0a1a872015-01-18 02:48:07 +00001425 /// \brief Emit the unified return block, trying to avoid its emission when
1426 /// possible.
1427 /// \return The debug location of the user written return statement if the
1428 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001429 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001430
Mike Stumpfc496822009-02-08 23:14:22 +00001431 /// FinishFunction - Complete IR generation of the current function. It is
1432 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001433 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001434
Nico Weber1bebad12015-02-11 22:33:32 +00001435 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1436 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001437
John McCallb92ab1a2016-10-26 23:46:34 +00001438 void EmitCallAndReturnForThunk(llvm::Constant *Callee,
1439 const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001440
John McCall7f416cc2015-09-08 08:05:57 +00001441 void FinishThunk();
1442
Reid Klecknerab2090d2014-07-26 01:34:32 +00001443 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1444 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1445 llvm::Value *Callee);
1446
Rafael Espindolad6e66942015-07-13 06:07:58 +00001447 /// Generate a thunk for the given method.
1448 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001449 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001450
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001451 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1452 const CGFunctionInfo &FnInfo,
1453 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001454
Douglas Gregor94f9a482010-05-05 05:51:00 +00001455 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1456 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001457
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001458 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001459 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001460
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001461 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1462 struct VPtr {
1463 BaseSubobject Base;
1464 const CXXRecordDecl *NearestVBase;
1465 CharUnits OffsetFromNearestVBase;
1466 const CXXRecordDecl *VTableClass;
1467 };
1468
1469 /// Initialize the vtable pointer of the given subobject.
1470 void InitializeVTablePointer(const VPtr &vptr);
1471
1472 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001473
1474 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001475 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1476
1477 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1478 CharUnits OffsetFromNearestVBase,
1479 bool BaseIsNonVirtualPrimaryBase,
1480 const CXXRecordDecl *VTableClass,
1481 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001482
Anders Carlssond5895932010-03-28 21:07:49 +00001483 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001484
Dan Gohman8fc50c22010-10-26 18:44:08 +00001485 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1486 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001487 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1488 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001489
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001490 enum CFITypeCheckKind {
1491 CFITCK_VCall,
1492 CFITCK_NVCall,
1493 CFITCK_DerivedCast,
1494 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001495 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001496 };
1497
Peter Collingbourned2926c92015-03-14 02:42:25 +00001498 /// \brief Derived is the presumed address of an object of type T after a
1499 /// cast. If T is a polymorphic class type, emit a check that the virtual
1500 /// table for Derived belongs to a class derived from T.
1501 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001502 bool MayBeNull, CFITypeCheckKind TCK,
1503 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001504
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001505 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1506 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001507 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001508 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001509
Peter Collingbourned2926c92015-03-14 02:42:25 +00001510 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001511 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001512 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1513 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001514
Peter Collingbournefb532b92016-02-24 20:46:36 +00001515 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001516 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1517 /// enabled, emit a check that VTable is a member of RD's type identifier.
1518 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1519 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001520
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001521 /// Returns whether we should perform a type checked load when loading a
1522 /// virtual function for virtual calls to members of RD. This is generally
1523 /// true when both vcall CFI and whole-program-vtables are enabled.
1524 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1525
1526 /// Emit a type checked load from the given vtable.
1527 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1528 uint64_t VTableByteOffset);
1529
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001530 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1531 /// expr can be devirtualized.
1532 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1533 const CXXMethodDecl *MD);
1534
John McCallf99a6312010-07-21 05:30:47 +00001535 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1536 /// given phase of destruction for a destructor. The end result
1537 /// should call destructors on members and base classes in reverse
1538 /// order of their construction.
1539 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001540
Chris Lattner3c77a352010-06-22 00:03:40 +00001541 /// ShouldInstrumentFunction - Return true if the current function should be
1542 /// instrumented with __cyg_profile_func_* calls
1543 bool ShouldInstrumentFunction();
1544
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001545 /// ShouldXRayInstrument - Return true if the current function should be
1546 /// instrumented with XRay nop sleds.
1547 bool ShouldXRayInstrumentFunction() const;
1548
Chris Lattner3c77a352010-06-22 00:03:40 +00001549 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1550 /// instrumentation function with the current function and the call site, if
1551 /// function instrumentation is enabled.
1552 void EmitFunctionInstrumentation(const char *Fn);
1553
Roman Divacky178e01602011-02-10 16:52:03 +00001554 /// EmitMCountInstrumentation - Emit call to .mcount.
1555 void EmitMCountInstrumentation();
1556
Mike Stumpfc496822009-02-08 23:14:22 +00001557 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1558 /// arguments for the given function. This is also responsible for naming the
1559 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001560 void EmitFunctionProlog(const CGFunctionInfo &FI,
1561 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001562 const FunctionArgList &Args);
1563
Mike Stumpfc496822009-02-08 23:14:22 +00001564 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1565 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001566 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1567 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001568
Mike Stump1d849212009-12-07 23:38:24 +00001569 /// EmitStartEHSpec - Emit the start of the exception spec.
1570 void EmitStartEHSpec(const Decl *D);
1571
1572 /// EmitEndEHSpec - Emit the end of the exception spec.
1573 void EmitEndEHSpec(const Decl *D);
1574
John McCallbd309292010-07-06 01:34:17 +00001575 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1576 llvm::BasicBlock *getTerminateLandingPad();
1577
1578 /// getTerminateHandler - Return a handler (not a landing pad, just
1579 /// a catch handler) that just calls terminate. This is used when
1580 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001581 llvm::BasicBlock *getTerminateHandler();
1582
Chris Lattnera5f58b02011-07-09 17:41:47 +00001583 llvm::Type *ConvertTypeForMem(QualType T);
1584 llvm::Type *ConvertType(QualType T);
1585 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001586 return ConvertType(getContext().getTypeDeclType(T));
1587 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001588
Mike Stumpfc496822009-02-08 23:14:22 +00001589 /// LoadObjCSelf - Load the value of self. This function is only valid while
1590 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001591 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001592
1593 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001594 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001595
Chris Lattner54fb19e2007-06-22 22:02:34 +00001596 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1597 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001598 static TypeEvaluationKind getEvaluationKind(QualType T);
1599
1600 static bool hasScalarEvaluationKind(QualType T) {
1601 return getEvaluationKind(T) == TEK_Scalar;
1602 }
1603
1604 static bool hasAggregateEvaluationKind(QualType T) {
1605 return getEvaluationKind(T) == TEK_Aggregate;
1606 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001607
1608 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001609 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001610 llvm::Function *parent = nullptr,
1611 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001612#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001613 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001614#else
John McCallad7c5c12011-02-08 08:22:06 +00001615 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001616#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001617 }
Mike Stumpfc496822009-02-08 23:14:22 +00001618
Chris Lattnerac248202007-05-30 00:13:02 +00001619 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1620 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001621 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001622
Mike Stumpe5311b02009-11-30 20:08:49 +00001623 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1624 /// another basic block, simplify it. This assumes that no other code could
1625 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001626 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1627
Mike Stumpfc496822009-02-08 23:14:22 +00001628 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1629 /// adding a fall-through branch from the current insert block if
1630 /// necessary. It is legal to call this function even if there is no current
1631 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001632 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001633 /// IsFinished - If true, indicates that the caller has finished emitting
1634 /// branches to the given block and does not expect to emit code into it. This
1635 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001636 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001637
John McCall8e4c74b2011-08-11 02:22:43 +00001638 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1639 /// near its uses, and leave the insertion point in it.
1640 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1641
Mike Stumpfc496822009-02-08 23:14:22 +00001642 /// EmitBranch - Emit a branch to the specified basic block from the current
1643 /// insert block, taking care to avoid creation of branches from dummy
1644 /// blocks. It is legal to call this function even if there is no current
1645 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001646 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001647 /// This function clears the current insertion point. The caller should follow
1648 /// calls to this function with calls to Emit*Block prior to generation new
1649 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001650 void EmitBranch(llvm::BasicBlock *Block);
1651
Mike Stumpfc496822009-02-08 23:14:22 +00001652 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1653 /// indicates that the current code being emitted is unreachable.
1654 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001655 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001656 }
1657
Mike Stumpfc496822009-02-08 23:14:22 +00001658 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1659 /// emitted IR has a place to go. Note that by definition, if this function
1660 /// creates a block then that block is unreachable; callers may do better to
1661 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001662 void EnsureInsertPoint() {
1663 if (!HaveInsertPoint())
1664 EmitBlock(createBasicBlock());
1665 }
Mike Stumpfc496822009-02-08 23:14:22 +00001666
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001667 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001668 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001669 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001670
Chris Lattnere9a64532007-06-22 21:44:33 +00001671 //===--------------------------------------------------------------------===//
1672 // Helpers
1673 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001674
John McCall7f416cc2015-09-08 08:05:57 +00001675 LValue MakeAddrLValue(Address Addr, QualType T,
1676 AlignmentSource AlignSource = AlignmentSource::Type) {
1677 return LValue::MakeAddr(Addr, T, getContext(), AlignSource,
Dan Gohman947c9af2010-10-14 23:06:10 +00001678 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001679 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001680
John McCall7f416cc2015-09-08 08:05:57 +00001681 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1682 AlignmentSource AlignSource = AlignmentSource::Type) {
1683 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1684 AlignSource, CGM.getTBAAInfo(T));
1685 }
1686
1687 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001688 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001689 CharUnits getNaturalTypeAlignment(QualType T,
1690 AlignmentSource *Source = nullptr,
1691 bool forPointeeType = false);
1692 CharUnits getNaturalPointeeTypeAlignment(QualType T,
1693 AlignmentSource *Source = nullptr);
1694
1695 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
1696 AlignmentSource *Source = nullptr);
1697 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001698
Alexey Bataev31300ed2016-02-04 11:27:03 +00001699 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
1700 AlignmentSource *Source = nullptr);
1701 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1702
Chris Lattnere9a64532007-06-22 21:44:33 +00001703 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001704 /// block. The caller is responsible for setting an appropriate alignment on
1705 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001706 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001707 const Twine &Name = "tmp");
John McCall7f416cc2015-09-08 08:05:57 +00001708 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
1709 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001710
John McCall7f416cc2015-09-08 08:05:57 +00001711 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1712 /// default ABI alignment of the given LLVM type.
1713 ///
1714 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1715 /// any given AST type that happens to have been lowered to the
1716 /// given IR type. This should only ever be used for function-local,
1717 /// IR-driven manipulations like saving and restoring a value. Do
1718 /// not hand this address off to arbitrary IRGen routines, and especially
1719 /// do not pass it as an argument to a function that might expect a
1720 /// properly ABI-aligned value.
1721 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1722 const Twine &Name = "tmp");
1723
1724 /// InitTempAlloca - Provide an initial value for the given alloca which
1725 /// will be observable at all locations in the function.
1726 ///
1727 /// The address should be something that was returned from one of
1728 /// the CreateTempAlloca or CreateMemTemp routines, and the
1729 /// initializer must be valid in the entry block (i.e. it must
1730 /// either be a constant or an argument value).
1731 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001732
Daniel Dunbard0049182010-02-16 19:44:13 +00001733 /// CreateIRTemp - Create a temporary IR object of the given type, with
1734 /// appropriate alignment. This routine should only be used when an temporary
1735 /// value needs to be stored into an alloca (for example, to avoid explicit
1736 /// PHI construction), but the type is the IR type, not the type appropriate
1737 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001738 ///
1739 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1740 /// ConvertType instead of ConvertTypeForMem.
1741 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001742
Daniel Dunbara7566f12010-02-09 02:48:28 +00001743 /// CreateMemTemp - Create a temporary memory object of the given type, with
1744 /// appropriate alignment.
John McCall7f416cc2015-09-08 08:05:57 +00001745 Address CreateMemTemp(QualType T, const Twine &Name = "tmp");
1746 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001747
John McCall7a626f62010-09-15 10:14:12 +00001748 /// CreateAggTemp - Create a temporary memory object for the given
1749 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001750 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00001751 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001752 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001753 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001754 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001755 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001756 }
1757
John McCallad7c5c12011-02-08 08:22:06 +00001758 /// Emit a cast to void* in the appropriate address space.
1759 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1760
Chris Lattner8394d792007-06-05 20:53:16 +00001761 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1762 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001763 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001764
John McCalla2342eb2010-12-05 02:00:02 +00001765 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1766 void EmitIgnoredExpr(const Expr *E);
1767
Chris Lattner4647a212007-08-31 22:49:20 +00001768 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1769 /// any type. The result is returned as an RValue struct. If this is an
1770 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1771 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001772 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001773 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001774 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001775 AggValueSlot aggSlot = AggValueSlot::ignored(),
1776 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001777
Mike Stumpfc496822009-02-08 23:14:22 +00001778 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1779 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00001780 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001781
Charles Davisc7d5c942015-09-17 20:55:33 +00001782 /// Emit a "reference" to a __builtin_ms_va_list; this is
1783 /// always the value of the expression, because a __builtin_ms_va_list is a
1784 /// pointer to a char.
1785 Address EmitMSVAListRef(const Expr *E);
1786
Mike Stumpfc496822009-02-08 23:14:22 +00001787 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1788 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001789 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001790
John McCall91ca10f2011-03-08 09:11:50 +00001791 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001792 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00001793 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001794 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001795
John McCall7f416cc2015-09-08 08:05:57 +00001796 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00001797
John McCall91ca10f2011-03-08 09:11:50 +00001798 /// EmitExprAsInit - Emits the code necessary to initialize a
1799 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001800 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001801 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001802
Fariborz Jahanian78652202013-01-25 23:57:05 +00001803 /// hasVolatileMember - returns true if aggregate type has a volatile
1804 /// member.
1805 bool hasVolatileMember(QualType T) {
1806 if (const RecordType *RT = T->getAs<RecordType>()) {
1807 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1808 return RD->hasVolatileMember();
1809 }
1810 return false;
1811 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001812 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001813 ///
1814 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1815 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00001816 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001817 QualType EltTy) {
1818 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00001819 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001820 }
1821
John McCall7f416cc2015-09-08 08:05:57 +00001822 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
1823 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00001824 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00001825 /*IsAssignment=*/false);
1826 }
1827
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001828 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001829 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001830 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001831 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001832 /// \param isAssignment - If false, allow padding to be copied. This often
1833 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00001834 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001835 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001836 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001837
Anders Carlsson9396a892008-09-11 09:15:33 +00001838 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00001839 Address GetAddrOfLocalVar(const VarDecl *VD) {
1840 auto it = LocalDeclMap.find(VD);
1841 assert(it != LocalDeclMap.end() &&
1842 "Invalid argument to GetAddrOfLocalVar(), no decl!");
1843 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00001844 }
Mike Stumpfc496822009-02-08 23:14:22 +00001845
John McCallc07a0c72011-02-17 10:25:35 +00001846 /// getOpaqueLValueMapping - Given an opaque value expression (which
1847 /// must be mapped to an l-value), return its mapping.
1848 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1849 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1850
1851 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1852 it = OpaqueLValues.find(e);
1853 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1854 return it->second;
1855 }
1856
1857 /// getOpaqueRValueMapping - Given an opaque value expression (which
1858 /// must be mapped to an r-value), return its mapping.
1859 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1860 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1861
1862 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1863 it = OpaqueRValues.find(e);
1864 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001865 return it->second;
1866 }
1867
Dan Gohman75d69da2008-05-22 00:50:06 +00001868 /// getAccessedFieldNo - Given an encoded value and a result number, return
1869 /// the input field number being accessed.
1870 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1871
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001872 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001873 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001874
Anders Carlssonc0964b62010-05-22 17:35:42 +00001875 /// EmitNullInitialization - Generate code to set a value of the given type to
1876 /// null, If the type contains data member pointers, they will be initialized
1877 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00001878 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001879
Charles Davisc7d5c942015-09-17 20:55:33 +00001880 /// Emits a call to an LLVM variable-argument intrinsic, either
1881 /// \c llvm.va_start or \c llvm.va_end.
1882 /// \param ArgValue A reference to the \c va_list as emitted by either
1883 /// \c EmitVAListRef or \c EmitMSVAListRef.
1884 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
1885 /// calls \c llvm.va_end.
1886 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
1887
1888 /// Generate code to get an argument from the passed in pointer
1889 /// and update it accordingly.
1890 /// \param VE The \c VAArgExpr for which to generate code.
1891 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
1892 /// either \c EmitVAListRef or \c EmitMSVAListRef.
1893 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001894 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001895 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00001896 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001897
John McCall82fe67b2011-07-09 01:37:26 +00001898 /// emitArrayLength - Compute the length of an array, even if it's a
1899 /// VLA, and drill down to the base element type.
1900 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1901 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001902 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00001903
John McCall23c29fe2011-06-24 21:55:10 +00001904 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1905 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001906 ///
1907 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001908 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001909
John McCall23c29fe2011-06-24 21:55:10 +00001910 /// getVLASize - Returns an LLVM value that corresponds to the size,
1911 /// in non-variably-sized elements, of a variable length array type,
1912 /// plus that largest non-variably-sized element type. Assumes that
1913 /// the type has already been emitted with EmitVariablyModifiedType.
1914 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1915 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001916
Anders Carlssona5d077d2009-04-14 16:58:56 +00001917 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1918 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001919 llvm::Value *LoadCXXThis() {
1920 assert(CXXThisValue && "no 'this' value for this function");
1921 return CXXThisValue;
1922 }
John McCall7f416cc2015-09-08 08:05:57 +00001923 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00001924
Anders Carlssone36a6b32010-01-02 01:01:18 +00001925 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1926 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001927 // FIXME: Every place that calls LoadCXXVTT is something
1928 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001929 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001930 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1931 return CXXStructorImplicitParamValue;
1932 }
1933
John McCall6ce74722010-02-16 04:15:37 +00001934 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001935 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00001936 Address
1937 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001938 const CXXRecordDecl *Derived,
1939 const CXXRecordDecl *Base,
1940 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001941
John McCall7f416cc2015-09-08 08:05:57 +00001942 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
1943
Mike Stumpe5311b02009-11-30 20:08:49 +00001944 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1945 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00001946 Address GetAddressOfBaseClass(Address Value,
1947 const CXXRecordDecl *Derived,
1948 CastExpr::path_const_iterator PathBegin,
1949 CastExpr::path_const_iterator PathEnd,
1950 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001951
John McCall7f416cc2015-09-08 08:05:57 +00001952 Address GetAddressOfDerivedClass(Address Value,
1953 const CXXRecordDecl *Derived,
1954 CastExpr::path_const_iterator PathBegin,
1955 CastExpr::path_const_iterator PathEnd,
1956 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00001957
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001958 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1959 /// base constructor/destructor with virtual bases.
1960 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1961 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1962 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1963 bool Delegating);
1964
John McCallf8ff7b92010-02-23 00:48:20 +00001965 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1966 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001967 const FunctionArgList &Args,
1968 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001969 // It's important not to confuse this and the previous function. Delegating
1970 // constructors are the C++0x feature. The constructor delegate optimization
1971 // is used to reduce duplication in the base and complete consturctors where
1972 // they are substantially the same.
1973 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1974 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001975
Richard Smith5179eb72016-06-28 19:03:57 +00001976 /// Emit a call to an inheriting constructor (that is, one that invokes a
1977 /// constructor inherited from a base class) by inlining its definition. This
1978 /// is necessary if the ABI does not support forwarding the arguments to the
1979 /// base class constructor (because they're variadic or similar).
1980 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1981 CXXCtorType CtorType,
1982 bool ForVirtualBase,
1983 bool Delegating,
1984 CallArgList &Args);
1985
1986 /// Emit a call to a constructor inherited from a base class, passing the
1987 /// current constructor's arguments along unmodified (without even making
1988 /// a copy).
1989 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
1990 bool ForVirtualBase, Address This,
1991 bool InheritedFromVBase,
1992 const CXXInheritedCtorInitExpr *E);
1993
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001994 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001995 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001996 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001997
Richard Smith5179eb72016-06-28 19:03:57 +00001998 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
1999 bool ForVirtualBase, bool Delegating,
2000 Address This, CallArgList &Args);
2001
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002002 /// Emit assumption load for all bases. Requires to be be called only on
2003 /// most-derived class and not under construction of the object.
2004 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2005
2006 /// Emit assumption that vptr load == global vtable.
2007 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2008
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002009 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002010 Address This, Address Src,
2011 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002012
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002013 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002014 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002015 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002016 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002017 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002018
Anders Carlssond49844b2009-09-23 02:45:36 +00002019 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2020 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002021 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002022 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002023 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002024
John McCall82fe67b2011-07-09 01:37:26 +00002025 static Destroyer destroyCXXObject;
2026
Anders Carlsson0a637412009-05-29 21:03:38 +00002027 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002028 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002029 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002030
John McCall99210dc2011-09-15 06:49:18 +00002031 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002032 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002033 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002034 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002035
Peter Collingbourne702b2842011-11-27 22:09:22 +00002036 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002037 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002038
David Majnemerdc012fa2015-04-22 21:38:15 +00002039 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2040 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2041
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002042 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002043 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002044
Eli Friedman24f55432009-11-18 00:57:03 +00002045 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002046 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2047 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002048
Richard Smith760520b2014-06-03 23:27:44 +00002049 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2050 const Expr *Arg, bool IsDelete);
2051
John McCall7f416cc2015-09-08 08:05:57 +00002052 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2053 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2054 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002055
Richard Smith69d0d262012-08-24 00:54:33 +00002056 /// \brief Situations in which we might emit a check for the suitability of a
2057 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002058 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002059 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002060 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002061 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002062 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002063 /// Checking the bound value in a reference binding. Must be suitably sized
2064 /// and aligned, but is not required to refer to an object (until the
2065 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002066 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002067 /// Checking the object expression in a non-static data member access. Must
2068 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002069 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002070 /// Checking the 'this' pointer for a call to a non-static member function.
2071 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002072 TCK_MemberCall,
2073 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002074 TCK_ConstructorCall,
2075 /// Checking the operand of a static_cast to a derived pointer type. Must be
2076 /// null or an object within its lifetime.
2077 TCK_DowncastPointer,
2078 /// Checking the operand of a static_cast to a derived reference type. Must
2079 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002080 TCK_DowncastReference,
2081 /// Checking the operand of a cast to a base object. Must be suitably sized
2082 /// and aligned.
2083 TCK_Upcast,
2084 /// Checking the operand of a cast to a virtual base object. Must be an
2085 /// object within its lifetime.
2086 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00002087 };
2088
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002089 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2090 /// calls to EmitTypeCheck can be skipped.
2091 bool sanitizePerformTypeCheck() const;
2092
Richard Smith4d1458e2012-09-08 02:08:36 +00002093 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002094 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002095 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002096 QualType Type, CharUnits Alignment = CharUnits::Zero(),
2097 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002098
Richard Smith539e4a72013-02-23 02:53:19 +00002099 /// \brief Emit a check that \p Base points into an array object, which
2100 /// we can access at index \p Index. \p Accessed should be \c false if we
2101 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2102 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2103 QualType IndexType, bool Accessed);
2104
Chris Lattner116ce8f2010-01-09 21:40:03 +00002105 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2106 bool isInc, bool isPre);
2107 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2108 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002109
2110 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002111 llvm::Value *OffsetValue = nullptr) {
2112 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2113 OffsetValue);
2114 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002115
Chris Lattner8394d792007-06-05 20:53:16 +00002116 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002117 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002118 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002119
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002120 /// EmitDecl - Emit a declaration.
2121 ///
2122 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002123 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002124
John McCall1c9c3fd2010-10-15 04:57:14 +00002125 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002126 ///
2127 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002128 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002129
David Blaikie73ca5692014-12-09 00:32:22 +00002130 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002131 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002132
John McCallbd309292010-07-06 01:34:17 +00002133 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2134 llvm::Value *Address);
2135
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002136 /// \brief Determine whether the given initializer is trivial in the sense
2137 /// that it requires no code to be generated.
2138 bool isTrivialInitializer(const Expr *Init);
2139
John McCall1c9c3fd2010-10-15 04:57:14 +00002140 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002141 ///
2142 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002143 void EmitAutoVarDecl(const VarDecl &D);
2144
2145 class AutoVarEmission {
2146 friend class CodeGenFunction;
2147
John McCall9e2e22f2011-02-22 07:16:58 +00002148 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002149
John McCall7f416cc2015-09-08 08:05:57 +00002150 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002151 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002152 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002153
2154 llvm::Value *NRVOFlag;
2155
2156 /// True if the variable is a __block variable.
2157 bool IsByRef;
2158
2159 /// True if the variable is of aggregate type and has a constant
2160 /// initializer.
2161 bool IsConstantAggregate;
2162
Nadav Rotem1da30942013-03-23 06:43:35 +00002163 /// Non-null if we should use lifetime annotations.
2164 llvm::Value *SizeForLifetimeMarkers;
2165
John McCall9e2e22f2011-02-22 07:16:58 +00002166 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002167 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002168
John McCallc533cb72011-02-22 06:44:22 +00002169 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002170 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002171 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002172 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002173
John McCall7f416cc2015-09-08 08:05:57 +00002174 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002175
2176 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002177 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2178
Craig Topper8a13c412014-05-21 05:09:00 +00002179 bool useLifetimeMarkers() const {
2180 return SizeForLifetimeMarkers != nullptr;
2181 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002182 llvm::Value *getSizeForLifetimeMarkers() const {
2183 assert(useLifetimeMarkers());
2184 return SizeForLifetimeMarkers;
2185 }
2186
2187 /// Returns the raw, allocated address, which is not necessarily
2188 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002189 Address getAllocatedAddress() const {
2190 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002191 }
2192
John McCallc533cb72011-02-22 06:44:22 +00002193 /// Returns the address of the object within this declaration.
2194 /// Note that this does not chase the forwarding pointer for
2195 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002196 Address getObjectAddress(CodeGenFunction &CGF) const {
2197 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002198
John McCall7f416cc2015-09-08 08:05:57 +00002199 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002200 }
2201 };
2202 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2203 void EmitAutoVarInit(const AutoVarEmission &emission);
2204 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002205 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2206 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002207
John McCall1c9c3fd2010-10-15 04:57:14 +00002208 void EmitStaticVarDecl(const VarDecl &D,
2209 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002210
John McCall7f416cc2015-09-08 08:05:57 +00002211 class ParamValue {
2212 llvm::Value *Value;
2213 unsigned Alignment;
2214 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2215 public:
2216 static ParamValue forDirect(llvm::Value *value) {
2217 return ParamValue(value, 0);
2218 }
2219 static ParamValue forIndirect(Address addr) {
2220 assert(!addr.getAlignment().isZero());
2221 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2222 }
2223
2224 bool isIndirect() const { return Alignment != 0; }
2225 llvm::Value *getAnyValue() const { return Value; }
2226
2227 llvm::Value *getDirectValue() const {
2228 assert(!isIndirect());
2229 return Value;
2230 }
2231
2232 Address getIndirectAddress() const {
2233 assert(isIndirect());
2234 return Address(Value, CharUnits::fromQuantity(Alignment));
2235 }
2236 };
2237
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002238 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002239 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002240
John McCallc07a0c72011-02-17 10:25:35 +00002241 /// protectFromPeepholes - Protect a value that we're intending to
2242 /// store to the side, but which will probably be used later, from
2243 /// aggressive peepholing optimizations that might delete it.
2244 ///
2245 /// Pass the result to unprotectFromPeepholes to declare that
2246 /// protection is no longer required.
2247 ///
2248 /// There's no particular reason why this shouldn't apply to
2249 /// l-values, it's just that no existing peepholes work on pointers.
2250 PeepholeProtection protectFromPeepholes(RValue rvalue);
2251 void unprotectFromPeepholes(PeepholeProtection protection);
2252
Chris Lattner84915fa2007-06-02 04:16:21 +00002253 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002254 // Statement Emission
2255 //===--------------------------------------------------------------------===//
2256
Mike Stumpfc496822009-02-08 23:14:22 +00002257 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002258 void EmitStopPoint(const Stmt *S);
2259
Mike Stumpfc496822009-02-08 23:14:22 +00002260 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2261 /// this function even if there is no current insertion point.
2262 ///
2263 /// This function may clear the current insertion point; callers should use
2264 /// EnsureInsertPoint if they wish to subsequently generate code without first
2265 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002266 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002267
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002268 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002269 /// necessarily require an insertion point or debug information; typically
2270 /// because the statement amounts to a jump or a container of other
2271 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002272 ///
2273 /// \return True if the statement was handled.
2274 bool EmitSimpleStmt(const Stmt *S);
2275
John McCall7f416cc2015-09-08 08:05:57 +00002276 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2277 AggValueSlot AVS = AggValueSlot::ignored());
2278 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2279 bool GetLast = false,
2280 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002281 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002282
Mike Stumpfc496822009-02-08 23:14:22 +00002283 /// EmitLabel - Emit the block for the given label. It is legal to call this
2284 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002285 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002286
Chris Lattnerac248202007-05-30 00:13:02 +00002287 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002288 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002289 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002290 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002291 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002292
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002293 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002294 ArrayRef<const Attr *> Attrs = None);
2295 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002296 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002297 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002298 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002299 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002300 void EmitBreakStmt(const BreakStmt &S);
2301 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002302 void EmitSwitchStmt(const SwitchStmt &S);
2303 void EmitDefaultStmt(const DefaultStmt &S);
2304 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002305 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002306 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002307
Anders Carlsson2e744e82008-08-30 19:51:14 +00002308 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002309 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2310 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002311 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002312 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002313
Gor Nishanov8df64e92016-10-27 16:28:31 +00002314 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002315 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2316
John McCallb609d3f2010-07-07 06:56:46 +00002317 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2318 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002319
Anders Carlsson52d78a52009-09-27 18:58:34 +00002320 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002321 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002322 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002323 void EnterSEHTryStmt(const SEHTryStmt &S);
2324 void ExitSEHTryStmt(const SEHTryStmt &S);
2325
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002326 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002327 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002328
2329 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2330 const SEHExceptStmt &Except);
2331
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002332 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2333 const SEHFinallyStmt &Finally);
2334
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002335 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2336 llvm::Value *ParentFP,
2337 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002338 llvm::Value *EmitSEHExceptionCode();
2339 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002340 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002341
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002342 /// Scan the outlined statement for captures from the parent function. For
2343 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002344 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002345 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002346 bool IsFilter);
2347
2348 /// Recovers the address of a local in a parent function. ParentVar is the
2349 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002350 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002351 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2352 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002353 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2354 Address ParentVar,
2355 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002356
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002357 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002358 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002359
Alexey Bataev1189bd02016-01-26 12:20:39 +00002360 /// Returns calculated size of the specified type.
2361 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002362 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002363 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002364 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002365 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002366 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002367 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002368 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002369 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2370 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002371 /// \brief Perform element by element copying of arrays with type \a
2372 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2373 /// generated by \a CopyGen.
2374 ///
2375 /// \param DestAddr Address of the destination array.
2376 /// \param SrcAddr Address of the source array.
2377 /// \param OriginalType Type of destination and source arrays.
2378 /// \param CopyGen Copying procedure that copies value of single array element
2379 /// to another single array element.
2380 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002381 Address DestAddr, Address SrcAddr, QualType OriginalType,
2382 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002383 /// \brief Emit proper copying of data from one variable to another.
2384 ///
2385 /// \param OriginalType Original type of the copied variables.
2386 /// \param DestAddr Destination address.
2387 /// \param SrcAddr Source address.
2388 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2389 /// type of the base array element).
2390 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2391 /// the base array element).
2392 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2393 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002394 void EmitOMPCopy(QualType OriginalType,
2395 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002396 const VarDecl *DestVD, const VarDecl *SrcVD,
2397 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002398 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2399 /// \a X = \a E \a BO \a E.
2400 ///
2401 /// \param X Value to be updated.
2402 /// \param E Update value.
2403 /// \param BO Binary operation for update operation.
2404 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2405 /// expression, false otherwise.
2406 /// \param AO Atomic ordering of the generated atomic instructions.
2407 /// \param CommonGen Code generator for complex expressions that cannot be
2408 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002409 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2410 /// generated, <false, RValue::get(nullptr)> otherwise.
2411 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002412 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2413 llvm::AtomicOrdering AO, SourceLocation Loc,
2414 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002415 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002416 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002417 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2418 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002419 void EmitOMPUseDevicePtrClause(
2420 const OMPClause &C, OMPPrivateScope &PrivateScope,
2421 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002422 /// \brief Emit code for copyin clause in \a D directive. The next code is
2423 /// generated at the start of outlined functions for directives:
2424 /// \code
2425 /// threadprivate_var1 = master_threadprivate_var1;
2426 /// operator=(threadprivate_var2, master_threadprivate_var2);
2427 /// ...
2428 /// __kmpc_barrier(&loc, global_tid);
2429 /// \endcode
2430 ///
2431 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2432 /// \returns true if at least one copyin variable is found, false otherwise.
2433 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002434 /// \brief Emit initial code for lastprivate variables. If some variable is
2435 /// not also firstprivate, then the default initialization is used. Otherwise
2436 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2437 /// method.
2438 ///
2439 /// \param D Directive that may have 'lastprivate' directives.
2440 /// \param PrivateScope Private scope for capturing lastprivate variables for
2441 /// proper codegen in internal captured statement.
2442 ///
2443 /// \returns true if there is at least one lastprivate variable, false
2444 /// otherwise.
2445 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2446 OMPPrivateScope &PrivateScope);
2447 /// \brief Emit final copying of lastprivate values to original variables at
2448 /// the end of the worksharing or simd directive.
2449 ///
2450 /// \param D Directive that has at least one 'lastprivate' directives.
2451 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2452 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002453 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002454 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002455 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002456 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002457 /// Emit initial code for linear clauses.
2458 void EmitOMPLinearClause(const OMPLoopDirective &D,
2459 CodeGenFunction::OMPPrivateScope &PrivateScope);
2460 /// Emit final code for linear clauses.
2461 /// \param CondGen Optional conditional code for final part of codegen for
2462 /// linear clause.
2463 void EmitOMPLinearClauseFinal(
2464 const OMPLoopDirective &D,
2465 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002466 /// \brief Emit initial code for reduction variables. Creates reduction copies
2467 /// and initializes them with the values according to OpenMP standard.
2468 ///
2469 /// \param D Directive (possibly) with the 'reduction' clause.
2470 /// \param PrivateScope Private scope for capturing reduction variables for
2471 /// proper codegen in internal captured statement.
2472 ///
2473 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2474 OMPPrivateScope &PrivateScope);
2475 /// \brief Emit final update of reduction values to original variables at
2476 /// the end of the directive.
2477 ///
2478 /// \param D Directive that has at least one 'reduction' directives.
2479 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002480 /// \brief Emit initial code for linear variables. Creates private copies
2481 /// and initializes them with the values according to OpenMP standard.
2482 ///
2483 /// \param D Directive (possibly) with the 'linear' clause.
2484 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002485
Alexey Bataev7292c292016-04-25 12:22:29 +00002486 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2487 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002488 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002489 TaskGenTy;
2490 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2491 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002492 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00002493
Alexey Bataev9959db52014-05-06 10:08:46 +00002494 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002495 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002496 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002497 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002498 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002499 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002500 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002501 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002502 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002503 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002504 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002505 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002506 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002507 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002508 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002509 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002510 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002511 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002512 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002513 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002514 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002515 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002516 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002517 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002518 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002519 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002520 void
2521 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002522 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002523 void
2524 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002525 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002526 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002527 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002528 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002529 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002530 void EmitOMPDistributeLoop(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002531 void EmitOMPDistributeParallelForDirective(
2532 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002533 void EmitOMPDistributeParallelForSimdDirective(
2534 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002535 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002536 void EmitOMPTargetParallelForSimdDirective(
2537 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002538 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002539 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00002540 void
2541 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002542
Alexey Bataev14fa1c62016-03-29 05:34:15 +00002543 /// Emit outlined function for the target directive.
2544 static std::pair<llvm::Function * /*OutlinedFn*/,
2545 llvm::Constant * /*OutlinedFnID*/>
2546 EmitOMPTargetDirectiveOutlinedFunction(CodeGenModule &CGM,
2547 const OMPTargetDirective &S,
2548 StringRef ParentName,
2549 bool IsOffloadEntry);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002550 /// \brief Emit inner loop of the worksharing/simd construct.
2551 ///
2552 /// \param S Directive, for which the inner loop must be emitted.
2553 /// \param RequiresCleanup true, if directive has some associated private
2554 /// variables.
2555 /// \param LoopCond Bollean condition for loop continuation.
2556 /// \param IncExpr Increment expression for loop control variable.
2557 /// \param BodyGen Generator for the inner body of the inner loop.
2558 /// \param PostIncGen Genrator for post-increment code (required for ordered
2559 /// loop directvies).
2560 void EmitOMPInnerLoop(
2561 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2562 const Expr *IncExpr,
2563 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2564 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002565
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002566 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002567 /// Emit initial code for loop counters of loop-based directives.
2568 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2569 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002570
Alexander Musmanc6388682014-12-15 07:07:06 +00002571private:
Alexander Musmanc6388682014-12-15 07:07:06 +00002572 /// Helpers for the OpenMP loop directives.
Alexey Bataev0f34da12015-07-02 04:17:07 +00002573 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002574 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002575 void EmitOMPSimdFinal(
2576 const OMPLoopDirective &D,
2577 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev38e89532015-04-16 04:54:05 +00002578 /// \brief Emit code for the worksharing loop-based directive.
2579 /// \return true, if this construct has any lastprivate clause, false -
2580 /// otherwise.
2581 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002582 void EmitOMPOuterLoop(bool IsMonotonic, bool DynamicOrOrdered,
2583 const OMPLoopDirective &S, OMPPrivateScope &LoopScope, bool Ordered,
2584 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00002585 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002586 bool IsMonotonic, const OMPLoopDirective &S,
2587 OMPPrivateScope &LoopScope, bool Ordered, Address LB,
2588 Address UB, Address ST, Address IL,
2589 llvm::Value *Chunk);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002590 void EmitOMPDistributeOuterLoop(
2591 OpenMPDistScheduleClauseKind ScheduleKind,
2592 const OMPDistributeDirective &S, OMPPrivateScope &LoopScope,
2593 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002594 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002595 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002596
2597public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002598
Chris Lattner208ae962007-05-30 17:57:17 +00002599 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002600 // LValue Expression Emission
2601 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002602
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002603 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2604 RValue GetUndefRValue(QualType Ty);
2605
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002606 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2607 /// and issue an ErrorUnsupported style diagnostic (using the
2608 /// provided Name).
2609 RValue EmitUnsupportedRValue(const Expr *E,
2610 const char *Name);
2611
Mike Stumpfc496822009-02-08 23:14:22 +00002612 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2613 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002614 LValue EmitUnsupportedLValue(const Expr *E,
2615 const char *Name);
2616
Chris Lattner8394d792007-06-05 20:53:16 +00002617 /// EmitLValue - Emit code to compute a designator that specifies the location
2618 /// of the expression.
2619 ///
2620 /// This can return one of two things: a simple address or a bitfield
2621 /// reference. In either case, the LLVM Value* in the LValue structure is
2622 /// guaranteed to be an LLVM pointer type.
2623 ///
2624 /// If this returns a bitfield reference, nothing about the pointee type of
2625 /// the LLVM value is known: For example, it may not be a pointer to an
2626 /// integer.
2627 ///
2628 /// If this returns a normal address, and if the lvalue's C type is fixed
2629 /// size, this method guarantees that the returned pointer type will point to
2630 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2631 /// variable length type, this is not possible.
2632 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002633 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002634
Richard Smith4d1458e2012-09-08 02:08:36 +00002635 /// \brief Same as EmitLValue but additionally we generate checking code to
2636 /// guard against undefined behavior. This is only suitable when we know
2637 /// that the address will be used to access the object.
2638 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002639
John McCall7f416cc2015-09-08 08:05:57 +00002640 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002641 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002642
John McCalla8ec7eb2013-03-07 21:37:17 +00002643 void EmitAtomicInit(Expr *E, LValue lvalue);
2644
David Majnemera5b195a2015-02-14 01:35:12 +00002645 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00002646
2647 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2648 AggValueSlot Slot = AggValueSlot::ignored());
2649
Nick Lewycky2d84e842013-10-02 02:29:49 +00002650 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002651 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002652 AggValueSlot slot = AggValueSlot::ignored());
2653
2654 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2655
David Majnemera5b195a2015-02-14 01:35:12 +00002656 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2657 bool IsVolatile, bool isInit);
2658
Alexey Bataevb4505a72015-03-30 05:20:59 +00002659 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002660 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00002661 llvm::AtomicOrdering Success =
2662 llvm::AtomicOrdering::SequentiallyConsistent,
2663 llvm::AtomicOrdering Failure =
2664 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00002665 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2666
Alexey Bataevb4505a72015-03-30 05:20:59 +00002667 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002668 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002669 bool IsVolatile);
2670
John McCall3a7f6922010-10-27 20:58:56 +00002671 /// EmitToMemory - Change a scalar value from its value
2672 /// representation to its in-memory representation.
2673 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2674
2675 /// EmitFromMemory - Change a scalar value from its memory
2676 /// representation to its value representation.
2677 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2678
Daniel Dunbar1d425462009-02-10 00:57:50 +00002679 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2680 /// care to appropriately convert from the memory representation to
2681 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002682 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002683 SourceLocation Loc,
John McCall7f416cc2015-09-08 08:05:57 +00002684 AlignmentSource AlignSource =
2685 AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002686 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002687 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002688 uint64_t TBAAOffset = 0,
2689 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002690
2691 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2692 /// care to appropriately convert from the memory representation to
2693 /// the LLVM value representation. The l-value must be a simple
2694 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002695 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002696
2697 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2698 /// care to appropriately convert from the memory representation to
2699 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002700 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
2701 bool Volatile, QualType Ty,
2702 AlignmentSource AlignSource = AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002703 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002704 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002705 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002706
2707 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2708 /// care to appropriately convert from the memory representation to
2709 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002710 /// l-value. The isInit flag indicates whether this is an initialization.
2711 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2712 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002713
Chris Lattner8394d792007-06-05 20:53:16 +00002714 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2715 /// this method emits the address of the lvalue, then loads the result as an
2716 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002717 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002718 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2719 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002720 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002721
Chris Lattner8394d792007-06-05 20:53:16 +00002722 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2723 /// lvalue, where both are guaranteed to the have the same type, and that type
2724 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002725 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002726 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002727 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002728
Nick Lewycky2d84e842013-10-02 02:29:49 +00002729 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2730 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002731 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002732 /// \param Result [out] - If non-null, this will be set to a Value* for the
2733 /// bit-field contents after the store, appropriate for use as the result of
2734 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002735 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002736 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002737
John McCall4f29b492010-11-16 23:07:28 +00002738 /// Emit an l-value for an assignment (simple or compound) of complex type.
2739 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002740 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002741 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2742 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002743
Chris Lattner57540c52011-04-15 05:22:18 +00002744 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002745 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002746 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002747 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002748 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002749 // Note: only available for agg return types
2750 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002751 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002752 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002753 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002754 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002755 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002756 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2757 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00002758 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
2759 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002760 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002761 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002762 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002763 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002764 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002765 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002766 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002767 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002768 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002769
John McCall7f416cc2015-09-08 08:05:57 +00002770 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002771
Nick Lewycky2d84e842013-10-02 02:29:49 +00002772 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002773
John McCall7f416cc2015-09-08 08:05:57 +00002774 Address EmitArrayToPointerDecay(const Expr *Array,
2775 AlignmentSource *AlignSource = nullptr);
2776
John McCall71335052012-03-10 03:05:10 +00002777 class ConstantEmission {
2778 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2779 ConstantEmission(llvm::Constant *C, bool isReference)
2780 : ValueAndIsReference(C, isReference) {}
2781 public:
2782 ConstantEmission() {}
2783 static ConstantEmission forReference(llvm::Constant *C) {
2784 return ConstantEmission(C, true);
2785 }
2786 static ConstantEmission forValue(llvm::Constant *C) {
2787 return ConstantEmission(C, false);
2788 }
2789
Aaron Ballman67347662015-02-15 22:00:28 +00002790 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002791 return ValueAndIsReference.getOpaqueValue() != nullptr;
2792 }
John McCall71335052012-03-10 03:05:10 +00002793
2794 bool isReference() const { return ValueAndIsReference.getInt(); }
2795 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2796 assert(isReference());
2797 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2798 refExpr->getType());
2799 }
2800
2801 llvm::Constant *getValue() const {
2802 assert(!isReference());
2803 return ValueAndIsReference.getPointer();
2804 }
2805 };
2806
John McCall113bee02012-03-10 09:33:50 +00002807 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002808
John McCallfe96e0b2011-11-06 09:01:30 +00002809 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2810 AggValueSlot slot = AggValueSlot::ignored());
2811 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2812
Daniel Dunbar722f4242009-04-22 05:08:15 +00002813 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002814 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002815 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002816 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002817
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002818 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2819 /// if the Field is a reference, this will return the address of the reference
2820 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002821 LValue EmitLValueForFieldInitialization(LValue Base,
2822 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002823
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002824 LValue EmitLValueForIvar(QualType ObjectTy,
2825 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002826 unsigned CVRQualifiers);
2827
Anders Carlsson3be22e22009-05-30 23:23:33 +00002828 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002829 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002830 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002831 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002832 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002833
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002834 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002835 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002836 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002837 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002838 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00002839 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00002840
Chris Lattnerd7f58862007-06-02 05:24:33 +00002841 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002842 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002843 //===--------------------------------------------------------------------===//
2844
Mike Stumpfc496822009-02-08 23:14:22 +00002845 /// EmitCall - Generate a call of the given function, expecting the given
2846 /// result type, and using the given argument list which specifies both the
2847 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00002848 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00002849 ReturnValueSlot ReturnValue, const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00002850 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002851
John McCallb92ab1a2016-10-26 23:46:34 +00002852 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002853 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00002854 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002855 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002856 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00002857 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
2858 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002859
Eric Christopherc7e79db2015-11-12 00:44:04 +00002860 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00002861
John McCall882987f2013-02-28 19:01:20 +00002862 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2863 const Twine &name = "");
2864 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2865 ArrayRef<llvm::Value*> args,
2866 const Twine &name = "");
2867 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2868 const Twine &name = "");
2869 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2870 ArrayRef<llvm::Value*> args,
2871 const Twine &name = "");
2872
John McCallbd309292010-07-06 01:34:17 +00002873 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002874 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002875 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002876 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2877 ArrayRef<llvm::Value*> args,
2878 const Twine &name = "");
2879 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2880 const Twine &name = "");
2881 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2882 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002883
John McCallb92ab1a2016-10-26 23:46:34 +00002884 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2885 NestedNameSpecifier *Qual,
2886 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002887
John McCallb92ab1a2016-10-26 23:46:34 +00002888 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2889 CXXDtorType Type,
2890 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002891
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002892 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00002893 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
2894 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002895 ReturnValueSlot ReturnValue, llvm::Value *This,
2896 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00002897 QualType ImplicitParamTy, const CallExpr *E,
2898 CallArgList *RtlArgs);
John McCallb92ab1a2016-10-26 23:46:34 +00002899 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
2900 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00002901 llvm::Value *This, llvm::Value *ImplicitParam,
2902 QualType ImplicitParamTy, const CallExpr *E,
2903 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002904 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2905 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002906 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2907 const CXXMethodDecl *MD,
2908 ReturnValueSlot ReturnValue,
2909 bool HasQualifier,
2910 NestedNameSpecifier *Qualifier,
2911 bool IsArrow, const Expr *Base);
2912 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002913 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
2914 llvm::Value *memberPtr,
2915 const MemberPointerType *memberPtrType,
2916 AlignmentSource *AlignSource = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002917 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2918 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002919
Anders Carlsson4034a952009-05-27 04:18:27 +00002920 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002921 const CXXMethodDecl *MD,
2922 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00002923 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002924
Peter Collingbournefe883422011-10-06 18:29:37 +00002925 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2926 ReturnValueSlot ReturnValue);
2927
Justin Lebar3039a592016-01-23 21:28:14 +00002928 RValue EmitCUDADevicePrintfCallExpr(const CallExpr *E,
2929 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002930
Mike Stump11289f42009-09-09 15:08:12 +00002931 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002932 unsigned BuiltinID, const CallExpr *E,
2933 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002934
Anders Carlssonbfb36712009-12-24 21:13:40 +00002935 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002936
Mike Stumpfc496822009-02-08 23:14:22 +00002937 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2938 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002939 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2940
Kevin Qin1718af62013-11-14 02:45:18 +00002941 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2942 const llvm::CmpInst::Predicate Fp,
2943 const llvm::CmpInst::Predicate Ip,
2944 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002945 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002946
2947 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2948 unsigned LLVMIntrinsic,
2949 unsigned AltLLVMIntrinsic,
2950 const char *NameHint,
2951 unsigned Modifier,
2952 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002953 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00002954 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00002955 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2956 unsigned Modifier, llvm::Type *ArgTy,
2957 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002958 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002959 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002960 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002961 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002962 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002963 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002964 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002965 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2966 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00002967 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00002968 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002969
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002970 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002971 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2972 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00002973 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00002974 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00002975 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00002976 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
2977 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002978
Albert Gutowski2a0621e2016-10-12 22:01:05 +00002979private:
2980 enum class MSVCIntrin;
2981
2982public:
2983 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
2984
Daniel Dunbar66912a12008-08-20 00:28:19 +00002985 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002986 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002987 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002988 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2989 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2990 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002991 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002992 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002993 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2994 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002995
John McCall31168b02011-06-15 23:02:42 +00002996 /// Retrieves the default cleanup kind for an ARC cleanup.
2997 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2998 CleanupKind getARCCleanupKind() {
2999 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3000 ? NormalAndEHCleanup : NormalCleanup;
3001 }
3002
3003 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003004 void EmitARCInitWeak(Address addr, llvm::Value *value);
3005 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003006 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003007 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3008 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3009 void EmitARCCopyWeak(Address dst, Address src);
3010 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003011 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3012 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003013 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003014 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003015 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003016 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003017 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003018 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003019 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003020 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003021 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003022 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003023 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3024 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3025 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003026 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003027
3028 std::pair<LValue,llvm::Value*>
3029 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3030 std::pair<LValue,llvm::Value*>
3031 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003032 std::pair<LValue,llvm::Value*>
3033 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003034
John McCall248512a2011-10-01 10:32:24 +00003035 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003036 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3037 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3038
John McCallff613032011-10-04 06:23:45 +00003039 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003040 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3041 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003042 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3043 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003044 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003045
Craig Topper00bbdcf2014-06-28 23:22:23 +00003046 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003047
John McCall82fe67b2011-07-09 01:37:26 +00003048 static Destroyer destroyARCStrongImprecise;
3049 static Destroyer destroyARCStrongPrecise;
3050 static Destroyer destroyARCWeak;
3051
John McCall31168b02011-06-15 23:02:42 +00003052 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3053 llvm::Value *EmitObjCAutoreleasePoolPush();
3054 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3055 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3056 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3057
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003058 /// \brief Emits a reference binding to the passed in expression.
3059 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003060
Chris Lattner6278e6a2007-08-11 00:04:45 +00003061 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003062 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003063 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003064
3065 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003066
3067 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3068 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003069 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003070
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003071 /// Emit a conversion from the specified type to the specified destination
3072 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003073 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003074 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003075
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003076 /// Emit a conversion from the specified complex type to the specified
3077 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003078 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003079 QualType DstTy,
3080 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003081
John McCall7a626f62010-09-15 10:14:12 +00003082 /// EmitAggExpr - Emit the computation of the specified expression
3083 /// of aggregate type. The result is computed into the given slot,
3084 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003085 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003086
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003087 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3088 /// aggregate type into a temporary LValue.
3089 LValue EmitAggExprToLValue(const Expr *E);
3090
John McCall1bd25562011-06-24 23:21:27 +00003091 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3092 /// make sure it survives garbage collection until this point.
3093 void EmitExtendGCLifetime(llvm::Value *object);
3094
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003095 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003096 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003097 ComplexPairTy EmitComplexExpr(const Expr *E,
3098 bool IgnoreReal = false,
3099 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003100
John McCall47fb9502013-03-07 21:37:08 +00003101 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3102 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003103 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003104
John McCall47fb9502013-03-07 21:37:08 +00003105 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003106 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003107
3108 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003109 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003110
John McCall7f416cc2015-09-08 08:05:57 +00003111 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3112 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3113
Chandler Carruth84537952012-03-30 19:44:53 +00003114 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3115 /// global variable that has already been created for it. If the initializer
3116 /// has a different type than GV does, this may free GV and return a different
3117 /// one. Otherwise it just returns GV.
3118 llvm::GlobalVariable *
3119 AddInitializerToStaticVarDecl(const VarDecl &D,
3120 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003121
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003122
Anders Carlssonf40886a2009-08-08 21:45:14 +00003123 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3124 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003125 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3126 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003127
David Majnemerb3341ea2014-10-05 05:05:40 +00003128 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3129 llvm::Constant *Addr);
3130
John McCallc84ed6a2012-05-01 06:13:13 +00003131 /// Call atexit() with a function that passes the given argument to
3132 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003133 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3134 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003135
John McCallcdf7ef52010-11-06 09:44:32 +00003136 /// Emit code in this function to perform a guarded variable
3137 /// initialization. Guarded initializations are used when it's not
3138 /// possible to prove that an initialization will be done exactly
3139 /// once, e.g. with a static local variable or a static data member
3140 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003141 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003142 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003143
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003144 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3145 /// variables.
3146 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003147 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003148 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003149
John McCallee08c532012-04-06 18:21:03 +00003150 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003151 /// variables.
John McCallee08c532012-04-06 18:21:03 +00003152 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
3153 const std::vector<std::pair<llvm::WeakVH,
3154 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003155
John McCalla738c252011-03-09 04:27:21 +00003156 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3157 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003158 llvm::GlobalVariable *Addr,
3159 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003160
John McCall7a626f62010-09-15 10:14:12 +00003161 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00003162
John McCall7f416cc2015-09-08 08:05:57 +00003163 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003164
John McCall08ef4662011-11-10 08:15:53 +00003165 void enterFullExpression(const ExprWithCleanups *E) {
3166 if (E->getNumObjects() == 0) return;
3167 enterNonTrivialFullExpression(E);
3168 }
3169 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003170
Richard Smithea852322013-05-07 21:53:22 +00003171 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003172
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003173 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3174
Tim Northovercc2a6e02015-11-09 19:56:35 +00003175 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003176
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003177 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003178 // Annotations Emission
3179 //===--------------------------------------------------------------------===//
3180
3181 /// Emit an annotation call (intrinsic or builtin).
3182 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3183 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003184 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003185 SourceLocation Location);
3186
3187 /// Emit local annotations for the local variable V, declared by D.
3188 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3189
3190 /// Emit field annotations for the given field & value. Returns the
3191 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003192 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003193
3194 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003195 // Internal Helpers
3196 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003197
Chris Lattner5b1964b2008-11-11 07:41:27 +00003198 /// ContainsLabel - Return true if the statement contains a label in it. If
3199 /// this statement is not executed normally, it not containing a label means
3200 /// that we can just remove the code.
3201 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003202
Chris Lattner29911cc2011-02-28 00:18:40 +00003203 /// containsBreak - Return true if the statement contains a break out of it.
3204 /// If the statement (recursively) contains a switch or loop with a break
3205 /// inside of it, this is fine.
3206 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003207
3208 /// Determine if the given statement might introduce a declaration into the
3209 /// current scope, by being a (possibly-labelled) DeclStmt.
3210 static bool mightAddDeclToScope(const Stmt *S);
Chris Lattner29911cc2011-02-28 00:18:40 +00003211
Daniel Dunbar682712c2008-11-12 10:12:14 +00003212 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003213 /// to a constant, or if it does but contains a label, return false. If it
3214 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003215 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3216 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003217
Chris Lattner29911cc2011-02-28 00:18:40 +00003218 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3219 /// to a constant, or if it does but contains a label, return false. If it
3220 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003221 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3222 bool AllowLabels = false);
3223
Chris Lattnercd439292008-11-12 08:04:58 +00003224 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3225 /// if statement) to the specified blocks. Based on the condition, this might
3226 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003227 /// TrueCount should be the number of times we expect the condition to
3228 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003229 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003230 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003231
Richard Smithe30752c2012-10-09 19:52:38 +00003232 /// \brief Emit a description of a type in a format suitable for passing to
3233 /// a runtime sanitizer handler.
3234 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3235
3236 /// \brief Convert a value into a format suitable for passing to a runtime
3237 /// sanitizer handler.
3238 llvm::Value *EmitCheckValue(llvm::Value *V);
3239
3240 /// \brief Emit a description of a source location in a format suitable for
3241 /// passing to a runtime sanitizer handler.
3242 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3243
Richard Smithde670682012-11-01 22:15:34 +00003244 /// \brief Create a basic block that will call a handler function in a
3245 /// sanitizer runtime with the provided arguments, and create a conditional
3246 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003247 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003248 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
3249 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003250
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003251 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3252 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003253 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3254 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3255 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003256
Richard Smithde670682012-11-01 22:15:34 +00003257 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3258 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003259 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003260
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003261 /// \brief Emit a call to trap or debugtrap and attach function attribute
3262 /// "trap-func-name" if specified.
3263 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3264
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003265 /// \brief Emit a cross-DSO CFI failure handling function.
3266 void EmitCfiCheckFail();
3267
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003268 /// \brief Create a check for a function parameter that may potentially be
3269 /// declared as non-null.
3270 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
3271 const FunctionDecl *FD, unsigned ParmNum);
3272
Anders Carlsson093bdff2010-03-30 03:27:09 +00003273 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003274 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003275
John McCall23f66262010-05-26 22:34:26 +00003276 /// EmitDelegateCallArg - We are performing a delegate call; that
3277 /// is, the current function is delegating to another one. Produce
3278 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003279 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3280 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003281
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003282 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3283 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003284 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003285
Chris Lattnercd439292008-11-12 08:04:58 +00003286private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003287 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003288 void EmitReturnOfRValue(RValue RV, QualType Ty);
3289
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003290 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3291
3292 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3293 DeferredReplacements;
3294
John McCall7f416cc2015-09-08 08:05:57 +00003295 /// Set the address of a local variable.
3296 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3297 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3298 LocalDeclMap.insert({VD, Addr});
3299 }
3300
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003301 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3302 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3303 ///
3304 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003305 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003306 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003307
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003308 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3309 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3310 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3311 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3312 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3313 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003314
Chad Rosier59df25b2012-08-23 20:00:18 +00003315 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003316 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003317
Chad Rosier59df25b2012-08-23 20:00:18 +00003318 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003319 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003320 std::string &ConstraintStr,
3321 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003322
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003323 /// \brief Attempts to statically evaluate the object size of E. If that
3324 /// fails, emits code to figure the size of E out for us. This is
3325 /// pass_object_size aware.
3326 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
3327 llvm::IntegerType *ResType);
3328
3329 /// \brief Emits the size of E, as required by __builtin_object_size. This
3330 /// function is aware of pass_object_size parameters, and will act accordingly
3331 /// if E is a parameter with the pass_object_size attribute.
3332 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
3333 llvm::IntegerType *ResType);
3334
Reid Kleckner89077a12013-12-17 19:46:40 +00003335public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003336#ifndef NDEBUG
3337 // Determine whether the given argument is an Objective-C method
3338 // that may have type parameters in its signature.
3339 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3340 const DeclContext *dc = method->getDeclContext();
3341 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3342 return classDecl->getTypeParamListAsWritten();
3343 }
3344
3345 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3346 return catDecl->getTypeParamList();
3347 }
3348
3349 return false;
3350 }
3351
3352 template<typename T>
3353 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3354#endif
3355
Richard Smitha560ccf2016-09-29 21:30:12 +00003356 enum class EvaluationOrder {
3357 ///! No language constraints on evaluation order.
3358 Default,
3359 ///! Language semantics require left-to-right evaluation.
3360 ForceLeftToRight,
3361 ///! Language semantics require right-to-left evaluation.
3362 ForceRightToLeft
3363 };
3364
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003365 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003366 template <typename T>
3367 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003368 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003369 const FunctionDecl *CalleeDecl = nullptr,
Richard Smith762672a2016-09-28 19:09:10 +00003370 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003371 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003372 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003373 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003374
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003375 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3376 "Can't skip parameters if type info is not provided");
3377 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003378#ifndef NDEBUG
3379 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3380#endif
3381
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003382 // First, use the argument types that the type info knows about
3383 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3384 E = CallArgTypeInfo->param_type_end();
3385 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003386 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003387 assert((isGenericMethod ||
3388 ((*I)->isVariablyModifiedType() ||
3389 (*I).getNonReferenceType()->isObjCRetainableType() ||
3390 getContext()
3391 .getCanonicalType((*I).getNonReferenceType())
3392 .getTypePtr() ==
3393 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003394 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003395 .getTypePtr())) &&
3396 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003397 ArgTypes.push_back(*I);
3398 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003399 }
Mike Stump11289f42009-09-09 15:08:12 +00003400
Reid Kleckner739756c2013-12-04 19:23:12 +00003401 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003402 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003403 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3404 CallArgTypeInfo->isVariadic()) &&
3405 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003406
Anders Carlsson603d6af2009-04-18 20:20:22 +00003407 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003408 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
3409 ArgTypes.push_back(getVarArgType(A));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003410
Richard Smitha560ccf2016-09-29 21:30:12 +00003411 EmitCallArgs(Args, ArgTypes, ArgRange, CalleeDecl, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003412 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003413
Reid Kleckner739756c2013-12-04 19:23:12 +00003414 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003415 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003416 const FunctionDecl *CalleeDecl = nullptr,
Richard Smith762672a2016-09-28 19:09:10 +00003417 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003418 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00003419
John McCall7f416cc2015-09-08 08:05:57 +00003420 /// EmitPointerWithAlignment - Given an expression with a pointer
3421 /// type, emit the value and compute our best estimate of the
3422 /// alignment of the pointee.
3423 ///
3424 /// Note that this function will conservatively fall back on the type
3425 /// when it doesn't
3426 ///
3427 /// \param Source - If non-null, this will be initialized with
3428 /// information about the source of the alignment. Note that this
3429 /// function will conservatively fall back on the type when it
3430 /// doesn't recognize the expression, which means that sometimes
3431 ///
3432 /// a worst-case One
3433 /// reasonable way to use this information is when there's a
3434 /// language guarantee that the pointer must be aligned to some
3435 /// stricter value, and we're simply trying to ensure that
3436 /// sufficiently obvious uses of under-aligned objects don't get
3437 /// miscompiled; for example, a placement new into the address of
3438 /// a local variable. In such a case, it's quite reasonable to
3439 /// just ignore the returned alignment when it isn't from an
3440 /// explicit source.
3441 Address EmitPointerWithAlignment(const Expr *Addr,
3442 AlignmentSource *Source = nullptr);
3443
Peter Collingbournedc134532016-01-16 00:31:22 +00003444 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3445
Reid Kleckner89077a12013-12-17 19:46:40 +00003446private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003447 QualType getVarArgType(const Expr *Arg);
3448
John McCalld4f4b7f2010-03-03 04:15:11 +00003449 const TargetCodeGenInfo &getTargetHooks() const {
3450 return CGM.getTargetCodeGenInfo();
3451 }
John McCall09ae0322010-07-06 23:57:41 +00003452
3453 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003454
John McCall7f416cc2015-09-08 08:05:57 +00003455 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3456 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003457
3458 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003459
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003460 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003461};
Mike Stump11289f42009-09-09 15:08:12 +00003462
John McCallce1de612011-01-26 04:00:11 +00003463/// Helper class with most of the code for saving a value for a
3464/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003465struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003466 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3467
3468 /// Answer whether the given value needs extra work to be saved.
3469 static bool needsSaving(llvm::Value *value) {
3470 // If it's not an instruction, we don't need to save.
3471 if (!isa<llvm::Instruction>(value)) return false;
3472
3473 // If it's an instruction in the entry block, we don't need to save.
3474 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3475 return (block != &block->getParent()->getEntryBlock());
3476 }
3477
3478 /// Try to save the given value.
3479 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3480 if (!needsSaving(value)) return saved_type(value, false);
3481
John McCall7f416cc2015-09-08 08:05:57 +00003482 // Otherwise, we need an alloca.
3483 auto align = CharUnits::fromQuantity(
3484 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3485 Address alloca =
3486 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003487 CGF.Builder.CreateStore(value, alloca);
3488
John McCall7f416cc2015-09-08 08:05:57 +00003489 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003490 }
3491
3492 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003493 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003494 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003495
3496 // Otherwise, it should be an alloca instruction, as set up in save().
3497 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3498 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003499 }
3500};
3501
John McCallcb5f77f2011-01-28 10:53:53 +00003502/// A partial specialization of DominatingValue for llvm::Values that
3503/// might be llvm::Instructions.
3504template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3505 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003506 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003507 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3508 }
3509};
3510
John McCall7f416cc2015-09-08 08:05:57 +00003511/// A specialization of DominatingValue for Address.
3512template <> struct DominatingValue<Address> {
3513 typedef Address type;
3514
3515 struct saved_type {
3516 DominatingLLVMValue::saved_type SavedValue;
3517 CharUnits Alignment;
3518 };
3519
3520 static bool needsSaving(type value) {
3521 return DominatingLLVMValue::needsSaving(value.getPointer());
3522 }
3523 static saved_type save(CodeGenFunction &CGF, type value) {
3524 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3525 value.getAlignment() };
3526 }
3527 static type restore(CodeGenFunction &CGF, saved_type value) {
3528 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3529 value.Alignment);
3530 }
3531};
3532
John McCallcb5f77f2011-01-28 10:53:53 +00003533/// A specialization of DominatingValue for RValue.
3534template <> struct DominatingValue<RValue> {
3535 typedef RValue type;
3536 class saved_type {
3537 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3538 AggregateAddress, ComplexAddress };
3539
3540 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003541 unsigned K : 3;
3542 unsigned Align : 29;
3543 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3544 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003545
3546 public:
3547 static bool needsSaving(RValue value);
3548 static saved_type save(CodeGenFunction &CGF, RValue value);
3549 RValue restore(CodeGenFunction &CGF);
3550
John McCall7f416cc2015-09-08 08:05:57 +00003551 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003552 };
3553
3554 static bool needsSaving(type value) {
3555 return saved_type::needsSaving(value);
3556 }
3557 static saved_type save(CodeGenFunction &CGF, type value) {
3558 return saved_type::save(CGF, value);
3559 }
3560 static type restore(CodeGenFunction &CGF, saved_type value) {
3561 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003562 }
3563};
3564
Chris Lattnerbed31442007-05-28 01:07:47 +00003565} // end namespace CodeGen
3566} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003567
Chris Lattnerbed31442007-05-28 01:07:47 +00003568#endif