blob: 8c725e267df8e0db8ce226f8d1bb79f20c5aa2e6 [file] [log] [blame]
Daniel Dunbar9c426522008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Chris Lattnerbed31442007-05-28 01:07:47 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattnerbed31442007-05-28 01:07:47 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stumpfc496822009-02-08 23:14:22 +000010// This is the internal per-function state used for llvm translation.
Chris Lattnerbed31442007-05-28 01:07:47 +000011//
12//===----------------------------------------------------------------------===//
13
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000014#ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
15#define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
Chris Lattnerbed31442007-05-28 01:07:47 +000016
Daniel Dunbarcb463852008-11-01 01:53:16 +000017#include "CGBuilder.h"
Eric Christophera9d34972011-10-19 00:43:52 +000018#include "CGDebugInfo.h"
Alexander Musman515ad8c2014-05-22 08:54:05 +000019#include "CGLoopInfo.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000020#include "CGValue.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "CodeGenModule.h"
Justin Bogneref512b92014-01-06 22:27:43 +000022#include "CodeGenPGO.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000023#include "EHScopeStack.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000024#include "clang/AST/CharUnits.h"
25#include "clang/AST/ExprCXX.h"
26#include "clang/AST/ExprObjC.h"
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +000027#include "clang/AST/ExprOpenMP.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000028#include "clang/AST/Type.h"
29#include "clang/Basic/ABI.h"
Ben Langmuir3b4c30b2013-05-09 19:17:11 +000030#include "clang/Basic/CapturedStmt.h"
Alexander Musmandf7a8e22015-01-22 08:49:35 +000031#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000032#include "clang/Basic/TargetInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000033#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000034#include "llvm/ADT/ArrayRef.h"
35#include "llvm/ADT/DenseMap.h"
36#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000037#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000038#include "llvm/Support/Debug.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000039#include "llvm/Transforms/Utils/SanitizerStats.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000040
Chris Lattnerbed31442007-05-28 01:07:47 +000041namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000042class BasicBlock;
43class LLVMContext;
44class MDNode;
45class Module;
46class SwitchInst;
47class Twine;
48class Value;
49class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000050}
51
Chris Lattnerbed31442007-05-28 01:07:47 +000052namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000053class ASTContext;
54class BlockDecl;
55class CXXDestructorDecl;
56class CXXForRangeStmt;
57class CXXTryStmt;
58class Decl;
59class LabelDecl;
60class EnumConstantDecl;
61class FunctionDecl;
62class FunctionProtoType;
63class LabelStmt;
64class ObjCContainerDecl;
65class ObjCInterfaceDecl;
66class ObjCIvarDecl;
67class ObjCMethodDecl;
68class ObjCImplementationDecl;
69class ObjCPropertyImplDecl;
70class TargetInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000071class VarDecl;
72class ObjCForCollectionStmt;
73class ObjCAtTryStmt;
74class ObjCAtThrowStmt;
75class ObjCAtSynchronizedStmt;
76class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000077
Chris Lattnerbed31442007-05-28 01:07:47 +000078namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000079class CodeGenTypes;
80class CGFunctionInfo;
81class CGRecordLayout;
82class CGBlockInfo;
83class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000084class BlockByrefHelpers;
85class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000086class BlockFlags;
87class BlockFieldFlags;
Alexey Bataev7292c292016-04-25 12:22:29 +000088class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000089class TargetCodeGenInfo;
Mike Stumpfc496822009-02-08 23:14:22 +000090
John McCall47fb9502013-03-07 21:37:08 +000091/// The kind of evaluation to perform on values of a particular
92/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
93/// CGExprAgg?
94///
95/// TODO: should vectors maybe be split out into their own thing?
96enum TypeEvaluationKind {
97 TEK_Scalar,
98 TEK_Complex,
99 TEK_Aggregate
100};
101
Chris Lattnerbed31442007-05-28 01:07:47 +0000102/// CodeGenFunction - This class organizes the per-function state that is used
103/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000104class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000105 CodeGenFunction(const CodeGenFunction &) = delete;
106 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000107
108 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000109public:
John McCallad5d61e2010-07-23 21:56:41 +0000110 /// A jump destination is an abstract label, branching to which may
111 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000112 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000113 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000114 JumpDest(llvm::BasicBlock *Block,
115 EHScopeStack::stable_iterator Depth,
116 unsigned Index)
117 : Block(Block), ScopeDepth(Depth), Index(Index) {}
118
Craig Topper8a13c412014-05-21 05:09:00 +0000119 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000120 llvm::BasicBlock *getBlock() const { return Block; }
121 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
122 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000123
Nadav Rotem1da30942013-03-23 06:43:35 +0000124 // This should be used cautiously.
125 void setScopeDepth(EHScopeStack::stable_iterator depth) {
126 ScopeDepth = depth;
127 }
128
John McCallad5d61e2010-07-23 21:56:41 +0000129 private:
John McCallbd309292010-07-06 01:34:17 +0000130 llvm::BasicBlock *Block;
131 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000132 unsigned Index;
133 };
134
Chris Lattnerbed31442007-05-28 01:07:47 +0000135 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000136 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000137
Chris Lattner96d72562007-08-21 16:57:55 +0000138 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000139 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000140 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000141
Alexander Musman515ad8c2014-05-22 08:54:05 +0000142 /// \brief CGBuilder insert helper. This function is called after an
143 /// instruction is created using Builder.
144 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
145 llvm::BasicBlock *BB,
146 llvm::BasicBlock::iterator InsertPt) const;
147
John McCalldec348f72013-05-03 07:33:41 +0000148 /// CurFuncDecl - Holds the Decl for the current outermost
149 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000150 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000151 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
152 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000153 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000154 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000155 llvm::Function *CurFn;
156
Mike Stumpbee78dd2009-12-04 23:26:17 +0000157 /// CurGD - The GlobalDecl for the current function being compiled.
158 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000159
John McCall31168b02011-06-15 23:02:42 +0000160 /// PrologueCleanupDepth - The cleanup depth enclosing all the
161 /// cleanups associated with the parameters.
162 EHScopeStack::stable_iterator PrologueCleanupDepth;
163
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000164 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000165 JumpDest ReturnBlock;
166
John McCall7f416cc2015-09-08 08:05:57 +0000167 /// ReturnValue - The temporary alloca to hold the return
168 /// value. This is invalid iff the function has no return value.
169 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000170
Chris Lattner03df1222007-06-02 04:53:11 +0000171 /// AllocaInsertPoint - This is an instruction in the entry block before which
172 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000173 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000174
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000175 /// \brief API for captured statement code generation.
176 class CGCapturedStmtInfo {
177 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000178 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
179 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000180 explicit CGCapturedStmtInfo(const CapturedStmt &S,
181 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000182 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000183
184 RecordDecl::field_iterator Field =
185 S.getCapturedRecordDecl()->field_begin();
186 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
187 E = S.capture_end();
188 I != E; ++I, ++Field) {
189 if (I->capturesThis())
190 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000191 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000192 CaptureFields[I->getCapturedVar()] = *Field;
193 }
194 }
195
196 virtual ~CGCapturedStmtInfo();
197
198 CapturedRegionKind getKind() const { return Kind; }
199
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000200 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000201 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000202 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000203
204 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000205 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000206 return CaptureFields.lookup(VD);
207 }
208
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000209 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
210 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000211
Alexey Bataev18095712014-10-10 12:19:54 +0000212 static bool classof(const CGCapturedStmtInfo *) {
213 return true;
214 }
215
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000216 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000217 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000218 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000219 CGF.EmitStmt(S);
220 }
221
222 /// \brief Get the name of the capture helper.
223 virtual StringRef getHelperName() const { return "__captured_stmt"; }
224
225 private:
226 /// \brief The kind of captured statement being generated.
227 CapturedRegionKind Kind;
228
229 /// \brief Keep the map between VarDecl and FieldDecl.
230 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
231
232 /// \brief The base address of the captured record, passed in as the first
233 /// argument of the parallel region function.
234 llvm::Value *ThisValue;
235
236 /// \brief Captured 'this' type.
237 FieldDecl *CXXThisFieldDecl;
238 };
239 CGCapturedStmtInfo *CapturedStmtInfo;
240
Alexey Bataevd157d472015-06-24 03:35:38 +0000241 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
242 class CGCapturedStmtRAII {
243 private:
244 CodeGenFunction &CGF;
245 CGCapturedStmtInfo *PrevCapturedStmtInfo;
246 public:
247 CGCapturedStmtRAII(CodeGenFunction &CGF,
248 CGCapturedStmtInfo *NewCapturedStmtInfo)
249 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
250 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
251 }
252 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
253 };
254
Alexey Samsonova0416102014-11-11 01:26:14 +0000255 /// \brief Sanitizers enabled for this function.
256 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000257
Alexey Samsonov24cad992014-07-17 18:46:27 +0000258 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
259 bool IsSanitizerScope;
260
261 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
262 class SanitizerScope {
263 CodeGenFunction *CGF;
264 public:
265 SanitizerScope(CodeGenFunction *CGF);
266 ~SanitizerScope();
267 };
268
Reid Kleckner19819442014-07-25 21:39:46 +0000269 /// In C++, whether we are code generating a thunk. This controls whether we
270 /// should emit cleanups.
271 bool CurFuncIsThunk;
272
John McCall31168b02011-06-15 23:02:42 +0000273 /// In ARC, whether we should autorelease the return value.
274 bool AutoreleaseResult;
275
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000276 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
277 /// potentially set the return value.
278 bool SawAsmBlock;
279
David Majnemer25eb1652016-03-01 19:42:53 +0000280 const FunctionDecl *CurSEHParent = nullptr;
281
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000282 /// True if the current function is an outlined SEH helper. This can be a
283 /// finally block or filter expression.
284 bool IsOutlinedSEHHelper;
285
John McCallad7c5c12011-02-08 08:22:06 +0000286 const CodeGen::CGBlockInfo *BlockInfo;
287 llvm::Value *BlockPointer;
288
Eli Friedman9fbeba02012-02-11 02:57:39 +0000289 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
290 FieldDecl *LambdaThisCaptureField;
291
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000292 /// \brief A mapping from NRVO variables to the flags used to indicate
293 /// when the NRVO has been applied to this variable.
294 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000295
John McCallbd309292010-07-06 01:34:17 +0000296 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000297 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000298 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000299
David Majnemer4e52d6f2015-12-12 05:39:21 +0000300 llvm::Instruction *CurrentFuncletPad = nullptr;
301
Richard Smith736a9472013-06-12 20:42:33 +0000302 /// Header for data within LifetimeExtendedCleanupStack.
303 struct LifetimeExtendedCleanupHeader {
304 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000305 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000306 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000307 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000308
Justin Bognerbdff2192015-07-01 00:59:27 +0000309 size_t getSize() const { return Size; }
310 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000311 };
John McCallbd309292010-07-06 01:34:17 +0000312
John McCallad5d61e2010-07-23 21:56:41 +0000313 /// i32s containing the indexes of the cleanup destinations.
314 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000315
316 unsigned NextCleanupDestIndex;
317
John McCall08ef4662011-11-10 08:15:53 +0000318 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
319 CGBlockInfo *FirstBlockInfo;
320
John McCall8e4c74b2011-08-11 02:22:43 +0000321 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
322 llvm::BasicBlock *EHResumeBlock;
323
Bill Wendlingf0724e82011-09-19 20:31:14 +0000324 /// The exception slot. All landing pads write the current exception pointer
325 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000326 llvm::Value *ExceptionSlot;
327
Bill Wendlingf0724e82011-09-19 20:31:14 +0000328 /// The selector slot. Under the MandatoryCleanup model, all landing pads
329 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000330 llvm::AllocaInst *EHSelectorSlot;
331
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000332 /// A stack of exception code slots. Entering an __except block pushes a slot
333 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
334 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000335 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000336
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000337 /// Value returned by __exception_info intrinsic.
338 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000339
John McCallbd309292010-07-06 01:34:17 +0000340 /// Emits a landing pad for the current EH stack.
341 llvm::BasicBlock *EmitLandingPad();
342
343 llvm::BasicBlock *getInvokeDestImpl();
344
John McCallce1de612011-01-26 04:00:11 +0000345 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000346 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
347 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000348 }
349
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000350public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000351 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
352 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000353 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000354
John McCall6b0feb72011-06-22 02:32:12 +0000355 /// A class controlling the emission of a finally block.
356 class FinallyInfo {
357 /// Where the catchall's edge through the cleanup should go.
358 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000359
John McCall6b0feb72011-06-22 02:32:12 +0000360 /// A function to call to enter the catch.
361 llvm::Constant *BeginCatchFn;
362
363 /// An i1 variable indicating whether or not the @finally is
364 /// running for an exception.
365 llvm::AllocaInst *ForEHVar;
366
367 /// An i8* variable into which the exception pointer to rethrow
368 /// has been saved.
369 llvm::AllocaInst *SavedExnVar;
370
371 public:
372 void enter(CodeGenFunction &CGF, const Stmt *Finally,
373 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
374 llvm::Constant *rethrowFn);
375 void exit(CodeGenFunction &CGF);
376 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000377
Reid Kleckner11c033e2015-02-12 23:40:45 +0000378 /// Returns true inside SEH __try blocks.
379 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
380
Reid Klecknera002bd52015-10-28 23:06:42 +0000381 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000382 bool isCleanupPadScope() const {
383 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
384 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000385
John McCallce1de612011-01-26 04:00:11 +0000386 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
387 /// current full-expression. Safe against the possibility that
388 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000389 template <class T, class... As>
390 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000391 // If we're not in a conditional branch, or if none of the
392 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000393 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000394 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000395
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000396 // Stash values in a tuple so we can guarantee the order of saves.
397 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
398 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000399
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000400 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000401 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000402 initFullExprCleanup();
403 }
404
Richard Smith736a9472013-06-12 20:42:33 +0000405 /// \brief Queue a cleanup to be pushed after finishing the current
406 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000407 template <class T, class... As>
408 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000409 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
410
411 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
412
413 size_t OldSize = LifetimeExtendedCleanupStack.size();
414 LifetimeExtendedCleanupStack.resize(
415 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
416
Justin Bognerbdff2192015-07-01 00:59:27 +0000417 static_assert(sizeof(Header) % llvm::AlignOf<T>::Alignment == 0,
418 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000419 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
420 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000421 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000422 }
423
John McCallf4beacd2011-11-10 10:43:54 +0000424 /// Set up the last cleaup that was pushed as a conditional
425 /// full-expression cleanup.
426 void initFullExprCleanup();
427
John McCallbd309292010-07-06 01:34:17 +0000428 /// PushDestructorCleanup - Push a cleanup to call the
429 /// complete-object destructor of an object of the given type at the
430 /// given address. Does nothing if T is not a C++ class type with a
431 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000432 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000433
John McCall8680f872010-07-21 06:29:51 +0000434 /// PushDestructorCleanup - Push a cleanup to call the
435 /// complete-object variant of the given destructor on the object at
436 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000437 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000438
John McCallbd309292010-07-06 01:34:17 +0000439 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
440 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000441 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000442
John McCall824c2f52010-09-14 07:57:04 +0000443 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
444 /// The block cannot be reactivated. Pops it if it's the top of the
445 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000446 ///
447 /// \param DominatingIP - An instruction which is known to
448 /// dominate the current IP (if set) and which lies along
449 /// all paths of execution between the current IP and the
450 /// the point at which the cleanup comes into scope.
451 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
452 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000453
454 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
455 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000456 ///
457 /// \param DominatingIP - An instruction which is known to
458 /// dominate the current IP (if set) and which lies along
459 /// all paths of execution between the current IP and the
460 /// the point at which the cleanup comes into scope.
461 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
462 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000463
John McCallbd309292010-07-06 01:34:17 +0000464 /// \brief Enters a new scope for capturing cleanups, all of which
465 /// will be executed once the scope is exited.
466 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000467 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000468 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000469 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000470 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000471 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000472 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000473
Aaron Ballmanabc18922015-02-15 22:54:08 +0000474 RunCleanupsScope(const RunCleanupsScope &) = delete;
475 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000476
Eric Christophera9d34972011-10-19 00:43:52 +0000477 protected:
478 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000479
Douglas Gregor965f4502009-11-24 16:43:22 +0000480 public:
481 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000482 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000483 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000484 {
John McCallbd309292010-07-06 01:34:17 +0000485 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000486 LifetimeExtendedCleanupStackSize =
487 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000488 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000489 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000490 }
491
492 /// \brief Exit this cleanup scope, emitting any accumulated
493 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000494 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000495 if (PerformCleanup) {
496 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000497 CGF.PopCleanupBlocks(CleanupStackDepth,
498 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000499 }
500 }
501
502 /// \brief Determine whether this scope requires any cleanups.
503 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000504 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000505 }
506
507 /// \brief Force the emission of cleanups now, instead of waiting
508 /// until this object is destroyed.
509 void ForceCleanup() {
510 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000511 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000512 CGF.PopCleanupBlocks(CleanupStackDepth,
513 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000514 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000515 }
516 };
517
David Blaikie93be0b22014-08-22 21:37:04 +0000518 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000519 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000520 SmallVector<const LabelDecl*, 4> Labels;
521 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000522
Aaron Ballmanabc18922015-02-15 22:54:08 +0000523 LexicalScope(const LexicalScope &) = delete;
524 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000525
526 public:
527 /// \brief Enter a new cleanup scope.
528 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000529 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
530 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000531 if (CGDebugInfo *DI = CGF.getDebugInfo())
532 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
533 }
534
Nadav Rotem1da30942013-03-23 06:43:35 +0000535 void addLabel(const LabelDecl *label) {
536 assert(PerformCleanup && "adding label to dead scope?");
537 Labels.push_back(label);
538 }
539
Eric Christophera9d34972011-10-19 00:43:52 +0000540 /// \brief Exit this cleanup scope, emitting any accumulated
541 /// cleanups.
542 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000543 if (CGDebugInfo *DI = CGF.getDebugInfo())
544 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
545
Nadav Rotem1da30942013-03-23 06:43:35 +0000546 // If we should perform a cleanup, force them now. Note that
547 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000548 if (PerformCleanup) {
549 ApplyDebugLocation DL(CGF, Range.getEnd());
550 ForceCleanup();
551 }
Eric Christophera9d34972011-10-19 00:43:52 +0000552 }
553
554 /// \brief Force the emission of cleanups now, instead of waiting
555 /// until this object is destroyed.
556 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000557 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000558 RunCleanupsScope::ForceCleanup();
559
Nadav Rotem1da30942013-03-23 06:43:35 +0000560 if (!Labels.empty())
561 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000562 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000563
564 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000565 };
566
John McCall7f416cc2015-09-08 08:05:57 +0000567 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
568
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000569 /// \brief The scope used to remap some variables as private in the OpenMP
570 /// loop body (or other captured region emitted without outlining), and to
571 /// restore old vars back on exit.
572 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000573 DeclMapTy SavedLocals;
574 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000575
576 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000577 OMPPrivateScope(const OMPPrivateScope &) = delete;
578 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000579
580 public:
581 /// \brief Enter a new OpenMP private scope.
582 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
583
584 /// \brief Registers \a LocalVD variable as a private and apply \a
585 /// PrivateGen function for it to generate corresponding private variable.
586 /// \a PrivateGen returns an address of the generated private variable.
587 /// \return true if the variable is registered as private, false if it has
588 /// been privatized already.
589 bool
590 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000591 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000592 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000593
594 // Only save it once.
595 if (SavedLocals.count(LocalVD)) return false;
596
597 // Copy the existing local entry to SavedLocals.
598 auto it = CGF.LocalDeclMap.find(LocalVD);
599 if (it != CGF.LocalDeclMap.end()) {
600 SavedLocals.insert({LocalVD, it->second});
601 } else {
602 SavedLocals.insert({LocalVD, Address::invalid()});
603 }
604
605 // Generate the private entry.
606 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000607 QualType VarTy = LocalVD->getType();
608 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000609 Address Temp = CGF.CreateMemTemp(VarTy);
610 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
611 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000612 }
John McCall7f416cc2015-09-08 08:05:57 +0000613 SavedPrivates.insert({LocalVD, Addr});
614
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000615 return true;
616 }
617
618 /// \brief Privatizes local variables previously registered as private.
619 /// Registration is separate from the actual privatization to allow
620 /// initializers use values of the original variables, not the private one.
621 /// This is important, for example, if the private variable is a class
622 /// variable initialized by a constructor that references other private
623 /// variables. But at initialization original variables must be used, not
624 /// private copies.
625 /// \return true if at least one variable was privatized, false otherwise.
626 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000627 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000628 SavedPrivates.clear();
629 return !SavedLocals.empty();
630 }
631
632 void ForceCleanup() {
633 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000634 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000635 SavedLocals.clear();
636 }
637
638 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000639 ~OMPPrivateScope() {
640 if (PerformCleanup)
641 ForceCleanup();
642 }
John McCall7f416cc2015-09-08 08:05:57 +0000643
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000644 /// Checks if the global variable is captured in current function.
645 bool isGlobalVarCaptured(const VarDecl *VD) const {
646 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
647 }
648
John McCall7f416cc2015-09-08 08:05:57 +0000649 private:
650 /// Copy all the entries in the source map over the corresponding
651 /// entries in the destination, which must exist.
652 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
653 for (auto &pair : src) {
654 if (!pair.second.isValid()) {
655 dest.erase(pair.first);
656 continue;
657 }
658
659 auto it = dest.find(pair.first);
660 if (it != dest.end()) {
661 it->second = pair.second;
662 } else {
663 dest.insert(pair);
664 }
665 }
666 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000667 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000668
Richard Smith736a9472013-06-12 20:42:33 +0000669 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
670 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000671 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000672
Richard Smith736a9472013-06-12 20:42:33 +0000673 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
674 /// that have been added, then adds all lifetime-extended cleanups from
675 /// the given position to the stack.
676 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
677 size_t OldLifetimeExtendedStackSize);
678
John McCallad5d61e2010-07-23 21:56:41 +0000679 void ResolveBranchFixups(llvm::BasicBlock *Target);
680
John McCallbd309292010-07-06 01:34:17 +0000681 /// The given basic block lies in the current EH scope, but may be a
682 /// target of a potentially scope-crossing jump; get a stable handle
683 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000684 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000685 return JumpDest(Target,
686 EHStack.getInnermostNormalCleanup(),
687 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000688 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000689
John McCallbd309292010-07-06 01:34:17 +0000690 /// The given basic block lies in the current EH scope, but may be a
691 /// target of a potentially scope-crossing jump; get a stable handle
692 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000693 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000694 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000695 }
696
697 /// EmitBranchThroughCleanup - Emit a branch from the current insert
698 /// block through the normal cleanup handling code (if any) and then
699 /// on to \arg Dest.
700 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000701
Justin Bognere25ffdf2014-01-21 00:35:11 +0000702 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
703 /// specified destination obviously has no cleanups to run. 'false' is always
704 /// a conservatively correct answer for this method.
705 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
706
John McCall8e4c74b2011-08-11 02:22:43 +0000707 /// popCatchScope - Pops the catch scope at the top of the EHScope
708 /// stack, emitting any required code (other than the catch handlers
709 /// themselves).
710 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000711
David Chisnall9a837be2012-11-07 16:50:40 +0000712 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000713 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000714 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000715
John McCallce1de612011-01-26 04:00:11 +0000716 /// An object to manage conditionally-evaluated expressions.
717 class ConditionalEvaluation {
718 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000719
John McCallce1de612011-01-26 04:00:11 +0000720 public:
721 ConditionalEvaluation(CodeGenFunction &CGF)
722 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000723
John McCallce1de612011-01-26 04:00:11 +0000724 void begin(CodeGenFunction &CGF) {
725 assert(CGF.OutermostConditional != this);
726 if (!CGF.OutermostConditional)
727 CGF.OutermostConditional = this;
728 }
729
730 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000731 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000732 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000733 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000734 }
735
736 /// Returns a block which will be executed prior to each
737 /// evaluation of the conditional code.
738 llvm::BasicBlock *getStartingBlock() const {
739 return StartBB;
740 }
741 };
Mike Stump11289f42009-09-09 15:08:12 +0000742
John McCall7f9c92a2010-09-17 00:50:28 +0000743 /// isInConditionalBranch - Return true if we're currently emitting
744 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000745 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000746
John McCall7f416cc2015-09-08 08:05:57 +0000747 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000748 assert(isInConditionalBranch());
749 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000750 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
751 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000752 }
753
John McCallce1de612011-01-26 04:00:11 +0000754 /// An RAII object to record that we're evaluating a statement
755 /// expression.
756 class StmtExprEvaluation {
757 CodeGenFunction &CGF;
758
759 /// We have to save the outermost conditional: cleanups in a
760 /// statement expression aren't conditional just because the
761 /// StmtExpr is.
762 ConditionalEvaluation *SavedOutermostConditional;
763
764 public:
765 StmtExprEvaluation(CodeGenFunction &CGF)
766 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000767 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000768 }
769
770 ~StmtExprEvaluation() {
771 CGF.OutermostConditional = SavedOutermostConditional;
772 CGF.EnsureInsertPoint();
773 }
774 };
John McCall1bf58462011-02-16 08:02:54 +0000775
John McCallc07a0c72011-02-17 10:25:35 +0000776 /// An object which temporarily prevents a value from being
777 /// destroyed by aggressive peephole optimizations that assume that
778 /// all uses of a value have been realized in the IR.
779 class PeepholeProtection {
780 llvm::Instruction *Inst;
781 friend class CodeGenFunction;
782
783 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000784 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000785 };
John McCallc07a0c72011-02-17 10:25:35 +0000786
John McCallfe96e0b2011-11-06 09:01:30 +0000787 /// A non-RAII class containing all the information about a bound
788 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
789 /// this which makes individual mappings very simple; using this
790 /// class directly is useful when you have a variable number of
791 /// opaque values or don't want the RAII functionality for some
792 /// reason.
793 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000794 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000795 bool BoundLValue;
796 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000797
John McCallfe96e0b2011-11-06 09:01:30 +0000798 OpaqueValueMappingData(const OpaqueValueExpr *ov,
799 bool boundLValue)
800 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000801 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000802 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000803
John McCallc07a0c72011-02-17 10:25:35 +0000804 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000805 // gl-values should be bound as l-values for obvious reasons.
806 // Records should be bound as l-values because IR generation
807 // always keeps them in memory. Expressions of function type
808 // act exactly like l-values but are formally required to be
809 // r-values in C.
810 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000811 expr->getType()->isFunctionType() ||
812 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000813 }
814
John McCallfe96e0b2011-11-06 09:01:30 +0000815 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
816 const OpaqueValueExpr *ov,
817 const Expr *e) {
818 if (shouldBindAsLValue(ov))
819 return bind(CGF, ov, CGF.EmitLValue(e));
820 return bind(CGF, ov, CGF.EmitAnyExpr(e));
821 }
822
823 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
824 const OpaqueValueExpr *ov,
825 const LValue &lv) {
826 assert(shouldBindAsLValue(ov));
827 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
828 return OpaqueValueMappingData(ov, true);
829 }
830
831 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
832 const OpaqueValueExpr *ov,
833 const RValue &rv) {
834 assert(!shouldBindAsLValue(ov));
835 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
836
837 OpaqueValueMappingData data(ov, false);
838
839 // Work around an extremely aggressive peephole optimization in
840 // EmitScalarConversion which assumes that all other uses of a
841 // value are extant.
842 data.Protection = CGF.protectFromPeepholes(rv);
843
844 return data;
845 }
846
Craig Topper8a13c412014-05-21 05:09:00 +0000847 bool isValid() const { return OpaqueValue != nullptr; }
848 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000849
850 void unbind(CodeGenFunction &CGF) {
851 assert(OpaqueValue && "no data to unbind!");
852
853 if (BoundLValue) {
854 CGF.OpaqueLValues.erase(OpaqueValue);
855 } else {
856 CGF.OpaqueRValues.erase(OpaqueValue);
857 CGF.unprotectFromPeepholes(Protection);
858 }
859 }
860 };
861
862 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
863 class OpaqueValueMapping {
864 CodeGenFunction &CGF;
865 OpaqueValueMappingData Data;
866
867 public:
868 static bool shouldBindAsLValue(const Expr *expr) {
869 return OpaqueValueMappingData::shouldBindAsLValue(expr);
870 }
871
John McCallc07a0c72011-02-17 10:25:35 +0000872 /// Build the opaque value mapping for the given conditional
873 /// operator if it's the GNU ?: extension. This is a common
874 /// enough pattern that the convenience operator is really
875 /// helpful.
876 ///
877 OpaqueValueMapping(CodeGenFunction &CGF,
878 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000879 if (isa<ConditionalOperator>(op))
880 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000881 return;
John McCallc07a0c72011-02-17 10:25:35 +0000882
883 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000884 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
885 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000886 }
887
John McCall1bf58462011-02-16 08:02:54 +0000888 OpaqueValueMapping(CodeGenFunction &CGF,
889 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000890 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000891 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000892 }
893
894 OpaqueValueMapping(CodeGenFunction &CGF,
895 const OpaqueValueExpr *opaqueValue,
896 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000897 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000898 }
899
900 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000901 Data.unbind(CGF);
902 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000903 }
904
905 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000906 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000907 }
908 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000909
Chris Lattner2da04b32007-08-24 05:35:26 +0000910private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000911 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000912 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000913
John McCall9b382dd2011-05-28 21:13:02 +0000914 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
915 /// calling llvm.stacksave for multiple VLAs in the same scope.
916 bool DidCallStackSave;
917
Mike Stumpe5311b02009-11-30 20:08:49 +0000918 /// IndirectBranch - The first time an indirect goto is seen we create a block
919 /// with an indirect branch. Every time we see the address of a label taken,
920 /// we add the label to the indirect goto. Every subsequent indirect goto is
921 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000922 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000923
Mike Stumpfc496822009-02-08 23:14:22 +0000924 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
925 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000926 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000927
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000928 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
929 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
930 /// parameter.
931 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
932 SizeArguments;
933
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000934 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000935 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000936 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
937
Chris Lattnerac248202007-05-30 00:13:02 +0000938 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000939 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000940
Mike Stumpfc496822009-02-08 23:14:22 +0000941 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000942 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000943 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000944 BreakContinue(JumpDest Break, JumpDest Continue)
945 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000946
John McCallbd309292010-07-06 01:34:17 +0000947 JumpDest BreakBlock;
948 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000949 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000950 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000951
Justin Bogneref512b92014-01-06 22:27:43 +0000952 CodeGenPGO PGO;
953
Justin Bogner65512642015-05-02 05:00:55 +0000954 /// Calculate branch weights appropriate for PGO data
955 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
956 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
957 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
958 uint64_t LoopCount);
959
Justin Bogneref512b92014-01-06 22:27:43 +0000960public:
Justin Bogner66242d62015-04-23 23:06:47 +0000961 /// Increment the profiler's counter for the given statement.
962 void incrementProfileCounter(const Stmt *S) {
Rong Xu9837ef52016-02-04 18:39:09 +0000963 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Justin Bogner66242d62015-04-23 23:06:47 +0000964 PGO.emitCounterIncrement(Builder, S);
965 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +0000966 }
Justin Bogner66242d62015-04-23 23:06:47 +0000967
968 /// Get the profiler's count for the given statement.
969 uint64_t getProfileCount(const Stmt *S) {
970 Optional<uint64_t> Count = PGO.getStmtCount(S);
971 if (!Count.hasValue())
972 return 0;
973 return *Count;
974 }
975
976 /// Set the profiler's current count.
977 void setCurrentProfileCount(uint64_t Count) {
978 PGO.setCurrentRegionCount(Count);
979 }
980
981 /// Get the profiler's current count. This is generally the count for the most
982 /// recently incremented counter.
983 uint64_t getCurrentProfileCount() {
984 return PGO.getCurrentRegionCount();
985 }
986
Justin Bogneref512b92014-01-06 22:27:43 +0000987private:
988
Zhongxing Xu82846ea2012-01-14 09:08:15 +0000989 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +0000990 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000991 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +0000992 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
993 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +0000994
Mike Stumpfc496822009-02-08 23:14:22 +0000995 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000996 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000997 llvm::BasicBlock *CaseRangeBlock;
998
John McCallc07a0c72011-02-17 10:25:35 +0000999 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001000 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001001 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1002 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001003
Mike Stumpfc496822009-02-08 23:14:22 +00001004 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001005 // We track this by the size expression rather than the type itself because
1006 // in certain situations, like a const qualifier applied to an VLA typedef,
1007 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001008 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1009 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001010 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001011
John McCallbd309292010-07-06 01:34:17 +00001012 /// A block containing a single 'unreachable' instruction. Created
1013 /// lazily by getUnreachableBlock().
1014 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001015
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001016 /// Counts of the number return expressions in the function.
1017 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001018
1019 /// Count the number of simple (constant) return expressions in the function.
1020 unsigned NumSimpleReturnExprs;
1021
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001022 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001023 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001024
Richard Smith852c9db2013-04-20 22:23:05 +00001025public:
1026 /// A scope within which we are constructing the fields of an object which
1027 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1028 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1029 class FieldConstructionScope {
1030 public:
John McCall7f416cc2015-09-08 08:05:57 +00001031 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001032 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1033 CGF.CXXDefaultInitExprThis = This;
1034 }
1035 ~FieldConstructionScope() {
1036 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1037 }
1038
1039 private:
1040 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001041 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001042 };
1043
1044 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1045 /// is overridden to be the object under construction.
1046 class CXXDefaultInitExprScope {
1047 public:
1048 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001049 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1050 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1051 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1052 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001053 }
1054 ~CXXDefaultInitExprScope() {
1055 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001056 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001057 }
1058
1059 public:
1060 CodeGenFunction &CGF;
1061 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001062 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001063 };
1064
1065private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001066 /// CXXThisDecl - When generating code for a C++ member function,
1067 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001068 ImplicitParamDecl *CXXABIThisDecl;
1069 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001070 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001071 CharUnits CXXABIThisAlignment;
1072 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001073
Richard Smith852c9db2013-04-20 22:23:05 +00001074 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1075 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001076 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001077
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001078 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1079 /// destructor, this will hold the implicit argument (e.g. VTT).
1080 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1081 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001082
John McCallce1de612011-01-26 04:00:11 +00001083 /// OutermostConditional - Points to the outermost active
1084 /// conditional control. This is used so that we know if a
1085 /// temporary should be destroyed conditionally.
1086 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001087
Nadav Rotem1da30942013-03-23 06:43:35 +00001088 /// The current lexical scope.
1089 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001090
Adrian Prantldc237b52013-05-16 00:41:26 +00001091 /// The current source location that should be used for exception
1092 /// handling code.
1093 SourceLocation CurEHLocation;
1094
John McCall7f416cc2015-09-08 08:05:57 +00001095 /// BlockByrefInfos - For each __block variable, contains
1096 /// information about the layout of the variable.
1097 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001098
John McCallbd309292010-07-06 01:34:17 +00001099 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001100 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001101 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001102
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001103 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1104 /// In the kernel metadata node, reference the kernel function and metadata
1105 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001106 /// - A node for the vec_type_hint(<type>) qualifier contains string
1107 /// "vec_type_hint", an undefined value of the <type> data type,
1108 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001109 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1110 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1111 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1112 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1113 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1114 llvm::Function *Fn);
1115
Chris Lattnerbed31442007-05-28 01:07:47 +00001116public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001117 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001118 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001119
John McCall8ed55a52010-09-02 09:58:18 +00001120 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001121 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001122 CGDebugInfo *getDebugInfo() {
1123 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001124 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001125 return DebugInfo;
1126 }
1127 void disableDebugInfo() { DisableDebugInfo = true; }
1128 void enableDebugInfo() { DisableDebugInfo = false; }
1129
John McCall31168b02011-06-15 23:02:42 +00001130 bool shouldUseFusedARCCalls() {
1131 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1132 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001133
David Blaikiebbafb8a2012-03-11 07:00:24 +00001134 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001135
Bill Wendlingf0724e82011-09-19 20:31:14 +00001136 /// Returns a pointer to the function's exception object and selector slot,
1137 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001138 Address getExceptionSlot();
1139 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001140
Bill Wendling79a70e42011-09-15 18:57:19 +00001141 /// Returns the contents of the function's exception object and selector
1142 /// slots.
1143 llvm::Value *getExceptionFromSlot();
1144 llvm::Value *getSelectorFromSlot();
1145
John McCall7f416cc2015-09-08 08:05:57 +00001146 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001147
John McCallbd309292010-07-06 01:34:17 +00001148 llvm::BasicBlock *getUnreachableBlock() {
1149 if (!UnreachableBlock) {
1150 UnreachableBlock = createBasicBlock("unreachable");
1151 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1152 }
1153 return UnreachableBlock;
1154 }
1155
1156 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001157 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001158 return getInvokeDestImpl();
1159 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001160
David Majnemer25eb1652016-03-01 19:42:53 +00001161 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001162
John McCallc8e01702013-04-16 22:48:15 +00001163 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001164 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001165
Daniel Dunbar12347492009-02-23 17:26:39 +00001166 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001167 // Cleanups
1168 //===--------------------------------------------------------------------===//
1169
John McCall7f416cc2015-09-08 08:05:57 +00001170 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001171
John McCall178360e2011-07-11 08:38:19 +00001172 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001173 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001174 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001175 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001176 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001177 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1178 llvm::Value *arrayEnd,
1179 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001180 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001181 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001182
John McCall4bd0fb12011-07-12 16:41:08 +00001183 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001184 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001185 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001186 Address addr, QualType type);
1187 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001188 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001189 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001190 QualType type, Destroyer *destroyer,
1191 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001192 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1193 llvm::Value *CompletePtr,
1194 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001195 void pushStackRestore(CleanupKind kind, Address SPMem);
1196 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001197 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001198 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001199 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001200 bool useEHCleanupForArray,
1201 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001202 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001203 QualType elementType, CharUnits elementAlign,
1204 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001205 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001206
Peter Collingbourne1425b452012-01-26 03:33:36 +00001207 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001208
John McCall82fe67b2011-07-09 01:37:26 +00001209 /// Determines whether an EH cleanup is required to destroy a type
1210 /// with the given destruction kind.
1211 bool needsEHCleanup(QualType::DestructionKind kind) {
1212 switch (kind) {
1213 case QualType::DK_none:
1214 return false;
1215 case QualType::DK_cxx_destructor:
1216 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001217 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001218 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001219 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001220 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1221 }
1222 llvm_unreachable("bad destruction kind");
1223 }
1224
John McCall4bd0fb12011-07-12 16:41:08 +00001225 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1226 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1227 }
1228
John McCall82fe67b2011-07-09 01:37:26 +00001229 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001230 // Objective-C
1231 //===--------------------------------------------------------------------===//
1232
Chris Lattner4bd55962008-03-30 23:03:07 +00001233 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001234
David Blaikief1425802015-01-14 00:04:42 +00001235 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001236
Mike Stumpfc496822009-02-08 23:14:22 +00001237 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001238 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1239 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001240 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001241 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001242 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001243 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001244
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001245 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1246 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001247
Mike Stumpfc496822009-02-08 23:14:22 +00001248 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1249 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001250 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1251 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001252 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001253 const ObjCPropertyImplDecl *propImpl,
1254 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001255
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001256 //===--------------------------------------------------------------------===//
1257 // Block Bits
1258 //===--------------------------------------------------------------------===//
1259
John McCall351762c2011-02-07 10:33:21 +00001260 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001261 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1262 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001263
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001264 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001265 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001266 const DeclMapTy &ldm,
1267 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001268
John McCallad7c5c12011-02-08 08:22:06 +00001269 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1270 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001271 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1272 const ObjCPropertyImplDecl *PID);
1273 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1274 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001275 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001276
John McCallad7c5c12011-02-08 08:22:06 +00001277 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1278
John McCall73064872011-03-31 01:59:53 +00001279 class AutoVarEmission;
1280
1281 void emitByrefStructureInit(const AutoVarEmission &emission);
1282 void enterByrefCleanup(const AutoVarEmission &emission);
1283
John McCall7f416cc2015-09-08 08:05:57 +00001284 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1285 llvm::Value *ptr);
1286
1287 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001288 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1289
1290 /// BuildBlockByrefAddress - Computes the location of the
1291 /// data in a variable which is declared as __block.
1292 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1293 bool followForward = true);
1294 Address emitBlockByrefAddress(Address baseAddr,
1295 const BlockByrefInfo &info,
1296 bool followForward,
1297 const llvm::Twine &name);
1298
1299 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001300
John McCalla738c252011-03-09 04:27:21 +00001301 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1302 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001303 /// \brief Emit code for the start of a function.
1304 /// \param Loc The location to be associated with the function.
1305 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001306 void StartFunction(GlobalDecl GD,
1307 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001308 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001309 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001310 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001311 SourceLocation Loc = SourceLocation(),
1312 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001313
John McCallb81884d2010-02-19 09:25:03 +00001314 void EmitConstructorBody(FunctionArgList &Args);
1315 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001316 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001317 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001318 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001319
Faisal Vali571df122013-09-29 08:45:24 +00001320 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001321 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001322 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001323 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001324 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1325 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001326 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001327
David Blaikiea0a1a872015-01-18 02:48:07 +00001328 /// \brief Emit the unified return block, trying to avoid its emission when
1329 /// possible.
1330 /// \return The debug location of the user written return statement if the
1331 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001332 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001333
Mike Stumpfc496822009-02-08 23:14:22 +00001334 /// FinishFunction - Complete IR generation of the current function. It is
1335 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001336 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001337
Nico Weber1bebad12015-02-11 22:33:32 +00001338 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1339 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001340
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001341 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001342
John McCall7f416cc2015-09-08 08:05:57 +00001343 void FinishThunk();
1344
Reid Klecknerab2090d2014-07-26 01:34:32 +00001345 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1346 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1347 llvm::Value *Callee);
1348
Rafael Espindolad6e66942015-07-13 06:07:58 +00001349 /// Generate a thunk for the given method.
1350 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001351 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001352
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001353 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1354 const CGFunctionInfo &FnInfo,
1355 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001356
Douglas Gregor94f9a482010-05-05 05:51:00 +00001357 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1358 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001359
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001360 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001361 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001362
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001363 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1364 struct VPtr {
1365 BaseSubobject Base;
1366 const CXXRecordDecl *NearestVBase;
1367 CharUnits OffsetFromNearestVBase;
1368 const CXXRecordDecl *VTableClass;
1369 };
1370
1371 /// Initialize the vtable pointer of the given subobject.
1372 void InitializeVTablePointer(const VPtr &vptr);
1373
1374 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001375
1376 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001377 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1378
1379 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1380 CharUnits OffsetFromNearestVBase,
1381 bool BaseIsNonVirtualPrimaryBase,
1382 const CXXRecordDecl *VTableClass,
1383 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001384
Anders Carlssond5895932010-03-28 21:07:49 +00001385 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001386
Dan Gohman8fc50c22010-10-26 18:44:08 +00001387 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1388 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001389 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1390 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001391
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001392 enum CFITypeCheckKind {
1393 CFITCK_VCall,
1394 CFITCK_NVCall,
1395 CFITCK_DerivedCast,
1396 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001397 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001398 };
1399
Peter Collingbourned2926c92015-03-14 02:42:25 +00001400 /// \brief Derived is the presumed address of an object of type T after a
1401 /// cast. If T is a polymorphic class type, emit a check that the virtual
1402 /// table for Derived belongs to a class derived from T.
1403 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001404 bool MayBeNull, CFITypeCheckKind TCK,
1405 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001406
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001407 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1408 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001409 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001410 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001411
Peter Collingbourned2926c92015-03-14 02:42:25 +00001412 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
1413 /// RD using llvm.bitset.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001414 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1415 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001416
Peter Collingbournefb532b92016-02-24 20:46:36 +00001417 /// If whole-program virtual table optimization is enabled, emit an assumption
1418 /// that VTable is a member of the type's bitset. Or, if vptr CFI is enabled,
1419 /// emit a check that VTable is a member of the type's bitset.
1420 void EmitBitSetCodeForVCall(const CXXRecordDecl *RD, llvm::Value *VTable,
1421 SourceLocation Loc);
1422
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001423 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1424 /// expr can be devirtualized.
1425 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1426 const CXXMethodDecl *MD);
1427
John McCallf99a6312010-07-21 05:30:47 +00001428 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1429 /// given phase of destruction for a destructor. The end result
1430 /// should call destructors on members and base classes in reverse
1431 /// order of their construction.
1432 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001433
Chris Lattner3c77a352010-06-22 00:03:40 +00001434 /// ShouldInstrumentFunction - Return true if the current function should be
1435 /// instrumented with __cyg_profile_func_* calls
1436 bool ShouldInstrumentFunction();
1437
1438 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1439 /// instrumentation function with the current function and the call site, if
1440 /// function instrumentation is enabled.
1441 void EmitFunctionInstrumentation(const char *Fn);
1442
Roman Divacky178e01602011-02-10 16:52:03 +00001443 /// EmitMCountInstrumentation - Emit call to .mcount.
1444 void EmitMCountInstrumentation();
1445
Mike Stumpfc496822009-02-08 23:14:22 +00001446 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1447 /// arguments for the given function. This is also responsible for naming the
1448 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001449 void EmitFunctionProlog(const CGFunctionInfo &FI,
1450 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001451 const FunctionArgList &Args);
1452
Mike Stumpfc496822009-02-08 23:14:22 +00001453 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1454 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001455 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1456 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001457
Mike Stump1d849212009-12-07 23:38:24 +00001458 /// EmitStartEHSpec - Emit the start of the exception spec.
1459 void EmitStartEHSpec(const Decl *D);
1460
1461 /// EmitEndEHSpec - Emit the end of the exception spec.
1462 void EmitEndEHSpec(const Decl *D);
1463
John McCallbd309292010-07-06 01:34:17 +00001464 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1465 llvm::BasicBlock *getTerminateLandingPad();
1466
1467 /// getTerminateHandler - Return a handler (not a landing pad, just
1468 /// a catch handler) that just calls terminate. This is used when
1469 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001470 llvm::BasicBlock *getTerminateHandler();
1471
Chris Lattnera5f58b02011-07-09 17:41:47 +00001472 llvm::Type *ConvertTypeForMem(QualType T);
1473 llvm::Type *ConvertType(QualType T);
1474 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001475 return ConvertType(getContext().getTypeDeclType(T));
1476 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001477
Mike Stumpfc496822009-02-08 23:14:22 +00001478 /// LoadObjCSelf - Load the value of self. This function is only valid while
1479 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001480 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001481
1482 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001483 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001484
Chris Lattner54fb19e2007-06-22 22:02:34 +00001485 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1486 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001487 static TypeEvaluationKind getEvaluationKind(QualType T);
1488
1489 static bool hasScalarEvaluationKind(QualType T) {
1490 return getEvaluationKind(T) == TEK_Scalar;
1491 }
1492
1493 static bool hasAggregateEvaluationKind(QualType T) {
1494 return getEvaluationKind(T) == TEK_Aggregate;
1495 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001496
1497 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001498 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001499 llvm::Function *parent = nullptr,
1500 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001501#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001502 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001503#else
John McCallad7c5c12011-02-08 08:22:06 +00001504 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001505#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001506 }
Mike Stumpfc496822009-02-08 23:14:22 +00001507
Chris Lattnerac248202007-05-30 00:13:02 +00001508 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1509 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001510 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001511
Mike Stumpe5311b02009-11-30 20:08:49 +00001512 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1513 /// another basic block, simplify it. This assumes that no other code could
1514 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001515 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1516
Mike Stumpfc496822009-02-08 23:14:22 +00001517 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1518 /// adding a fall-through branch from the current insert block if
1519 /// necessary. It is legal to call this function even if there is no current
1520 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001521 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001522 /// IsFinished - If true, indicates that the caller has finished emitting
1523 /// branches to the given block and does not expect to emit code into it. This
1524 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001525 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001526
John McCall8e4c74b2011-08-11 02:22:43 +00001527 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1528 /// near its uses, and leave the insertion point in it.
1529 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1530
Mike Stumpfc496822009-02-08 23:14:22 +00001531 /// EmitBranch - Emit a branch to the specified basic block from the current
1532 /// insert block, taking care to avoid creation of branches from dummy
1533 /// blocks. It is legal to call this function even if there is no current
1534 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001535 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001536 /// This function clears the current insertion point. The caller should follow
1537 /// calls to this function with calls to Emit*Block prior to generation new
1538 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001539 void EmitBranch(llvm::BasicBlock *Block);
1540
Mike Stumpfc496822009-02-08 23:14:22 +00001541 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1542 /// indicates that the current code being emitted is unreachable.
1543 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001544 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001545 }
1546
Mike Stumpfc496822009-02-08 23:14:22 +00001547 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1548 /// emitted IR has a place to go. Note that by definition, if this function
1549 /// creates a block then that block is unreachable; callers may do better to
1550 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001551 void EnsureInsertPoint() {
1552 if (!HaveInsertPoint())
1553 EmitBlock(createBasicBlock());
1554 }
Mike Stumpfc496822009-02-08 23:14:22 +00001555
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001556 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001557 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001558 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001559
Chris Lattnere9a64532007-06-22 21:44:33 +00001560 //===--------------------------------------------------------------------===//
1561 // Helpers
1562 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001563
John McCall7f416cc2015-09-08 08:05:57 +00001564 LValue MakeAddrLValue(Address Addr, QualType T,
1565 AlignmentSource AlignSource = AlignmentSource::Type) {
1566 return LValue::MakeAddr(Addr, T, getContext(), AlignSource,
Dan Gohman947c9af2010-10-14 23:06:10 +00001567 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001568 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001569
John McCall7f416cc2015-09-08 08:05:57 +00001570 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1571 AlignmentSource AlignSource = AlignmentSource::Type) {
1572 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1573 AlignSource, CGM.getTBAAInfo(T));
1574 }
1575
1576 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001577 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001578 CharUnits getNaturalTypeAlignment(QualType T,
1579 AlignmentSource *Source = nullptr,
1580 bool forPointeeType = false);
1581 CharUnits getNaturalPointeeTypeAlignment(QualType T,
1582 AlignmentSource *Source = nullptr);
1583
1584 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
1585 AlignmentSource *Source = nullptr);
1586 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001587
Alexey Bataev31300ed2016-02-04 11:27:03 +00001588 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
1589 AlignmentSource *Source = nullptr);
1590 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1591
Chris Lattnere9a64532007-06-22 21:44:33 +00001592 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001593 /// block. The caller is responsible for setting an appropriate alignment on
1594 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001595 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001596 const Twine &Name = "tmp");
John McCall7f416cc2015-09-08 08:05:57 +00001597 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
1598 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001599
John McCall7f416cc2015-09-08 08:05:57 +00001600 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1601 /// default ABI alignment of the given LLVM type.
1602 ///
1603 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1604 /// any given AST type that happens to have been lowered to the
1605 /// given IR type. This should only ever be used for function-local,
1606 /// IR-driven manipulations like saving and restoring a value. Do
1607 /// not hand this address off to arbitrary IRGen routines, and especially
1608 /// do not pass it as an argument to a function that might expect a
1609 /// properly ABI-aligned value.
1610 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1611 const Twine &Name = "tmp");
1612
1613 /// InitTempAlloca - Provide an initial value for the given alloca which
1614 /// will be observable at all locations in the function.
1615 ///
1616 /// The address should be something that was returned from one of
1617 /// the CreateTempAlloca or CreateMemTemp routines, and the
1618 /// initializer must be valid in the entry block (i.e. it must
1619 /// either be a constant or an argument value).
1620 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001621
Daniel Dunbard0049182010-02-16 19:44:13 +00001622 /// CreateIRTemp - Create a temporary IR object of the given type, with
1623 /// appropriate alignment. This routine should only be used when an temporary
1624 /// value needs to be stored into an alloca (for example, to avoid explicit
1625 /// PHI construction), but the type is the IR type, not the type appropriate
1626 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001627 ///
1628 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1629 /// ConvertType instead of ConvertTypeForMem.
1630 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001631
Daniel Dunbara7566f12010-02-09 02:48:28 +00001632 /// CreateMemTemp - Create a temporary memory object of the given type, with
1633 /// appropriate alignment.
John McCall7f416cc2015-09-08 08:05:57 +00001634 Address CreateMemTemp(QualType T, const Twine &Name = "tmp");
1635 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001636
John McCall7a626f62010-09-15 10:14:12 +00001637 /// CreateAggTemp - Create a temporary memory object for the given
1638 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001639 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00001640 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001641 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001642 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001643 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001644 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001645 }
1646
John McCallad7c5c12011-02-08 08:22:06 +00001647 /// Emit a cast to void* in the appropriate address space.
1648 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1649
Chris Lattner8394d792007-06-05 20:53:16 +00001650 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1651 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001652 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001653
John McCalla2342eb2010-12-05 02:00:02 +00001654 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1655 void EmitIgnoredExpr(const Expr *E);
1656
Chris Lattner4647a212007-08-31 22:49:20 +00001657 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1658 /// any type. The result is returned as an RValue struct. If this is an
1659 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1660 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001661 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001662 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001663 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001664 AggValueSlot aggSlot = AggValueSlot::ignored(),
1665 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001666
Mike Stumpfc496822009-02-08 23:14:22 +00001667 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1668 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00001669 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001670
Charles Davisc7d5c942015-09-17 20:55:33 +00001671 /// Emit a "reference" to a __builtin_ms_va_list; this is
1672 /// always the value of the expression, because a __builtin_ms_va_list is a
1673 /// pointer to a char.
1674 Address EmitMSVAListRef(const Expr *E);
1675
Mike Stumpfc496822009-02-08 23:14:22 +00001676 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1677 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001678 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001679
John McCall91ca10f2011-03-08 09:11:50 +00001680 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001681 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00001682 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001683 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001684
John McCall7f416cc2015-09-08 08:05:57 +00001685 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00001686
John McCall91ca10f2011-03-08 09:11:50 +00001687 /// EmitExprAsInit - Emits the code necessary to initialize a
1688 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001689 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001690 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001691
Fariborz Jahanian78652202013-01-25 23:57:05 +00001692 /// hasVolatileMember - returns true if aggregate type has a volatile
1693 /// member.
1694 bool hasVolatileMember(QualType T) {
1695 if (const RecordType *RT = T->getAs<RecordType>()) {
1696 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1697 return RD->hasVolatileMember();
1698 }
1699 return false;
1700 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001701 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001702 ///
1703 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1704 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00001705 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001706 QualType EltTy) {
1707 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00001708 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001709 }
1710
John McCall7f416cc2015-09-08 08:05:57 +00001711 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
1712 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00001713 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00001714 /*IsAssignment=*/false);
1715 }
1716
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001717 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001718 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001719 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001720 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001721 /// \param isAssignment - If false, allow padding to be copied. This often
1722 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00001723 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001724 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001725 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001726
Anders Carlsson9396a892008-09-11 09:15:33 +00001727 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00001728 Address GetAddrOfLocalVar(const VarDecl *VD) {
1729 auto it = LocalDeclMap.find(VD);
1730 assert(it != LocalDeclMap.end() &&
1731 "Invalid argument to GetAddrOfLocalVar(), no decl!");
1732 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00001733 }
Mike Stumpfc496822009-02-08 23:14:22 +00001734
John McCallc07a0c72011-02-17 10:25:35 +00001735 /// getOpaqueLValueMapping - Given an opaque value expression (which
1736 /// must be mapped to an l-value), return its mapping.
1737 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1738 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1739
1740 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1741 it = OpaqueLValues.find(e);
1742 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1743 return it->second;
1744 }
1745
1746 /// getOpaqueRValueMapping - Given an opaque value expression (which
1747 /// must be mapped to an r-value), return its mapping.
1748 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1749 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1750
1751 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1752 it = OpaqueRValues.find(e);
1753 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001754 return it->second;
1755 }
1756
Dan Gohman75d69da2008-05-22 00:50:06 +00001757 /// getAccessedFieldNo - Given an encoded value and a result number, return
1758 /// the input field number being accessed.
1759 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1760
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001761 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001762 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001763
Anders Carlssonc0964b62010-05-22 17:35:42 +00001764 /// EmitNullInitialization - Generate code to set a value of the given type to
1765 /// null, If the type contains data member pointers, they will be initialized
1766 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00001767 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001768
Charles Davisc7d5c942015-09-17 20:55:33 +00001769 /// Emits a call to an LLVM variable-argument intrinsic, either
1770 /// \c llvm.va_start or \c llvm.va_end.
1771 /// \param ArgValue A reference to the \c va_list as emitted by either
1772 /// \c EmitVAListRef or \c EmitMSVAListRef.
1773 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
1774 /// calls \c llvm.va_end.
1775 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
1776
1777 /// Generate code to get an argument from the passed in pointer
1778 /// and update it accordingly.
1779 /// \param VE The \c VAArgExpr for which to generate code.
1780 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
1781 /// either \c EmitVAListRef or \c EmitMSVAListRef.
1782 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001783 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001784 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00001785 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001786
John McCall82fe67b2011-07-09 01:37:26 +00001787 /// emitArrayLength - Compute the length of an array, even if it's a
1788 /// VLA, and drill down to the base element type.
1789 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1790 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001791 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00001792
John McCall23c29fe2011-06-24 21:55:10 +00001793 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1794 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001795 ///
1796 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001797 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001798
John McCall23c29fe2011-06-24 21:55:10 +00001799 /// getVLASize - Returns an LLVM value that corresponds to the size,
1800 /// in non-variably-sized elements, of a variable length array type,
1801 /// plus that largest non-variably-sized element type. Assumes that
1802 /// the type has already been emitted with EmitVariablyModifiedType.
1803 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1804 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001805
Anders Carlssona5d077d2009-04-14 16:58:56 +00001806 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1807 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001808 llvm::Value *LoadCXXThis() {
1809 assert(CXXThisValue && "no 'this' value for this function");
1810 return CXXThisValue;
1811 }
John McCall7f416cc2015-09-08 08:05:57 +00001812 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00001813
Anders Carlssone36a6b32010-01-02 01:01:18 +00001814 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1815 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001816 // FIXME: Every place that calls LoadCXXVTT is something
1817 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001818 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001819 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1820 return CXXStructorImplicitParamValue;
1821 }
1822
John McCall6ce74722010-02-16 04:15:37 +00001823 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001824 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00001825 Address
1826 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001827 const CXXRecordDecl *Derived,
1828 const CXXRecordDecl *Base,
1829 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001830
John McCall7f416cc2015-09-08 08:05:57 +00001831 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
1832
Mike Stumpe5311b02009-11-30 20:08:49 +00001833 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1834 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00001835 Address GetAddressOfBaseClass(Address Value,
1836 const CXXRecordDecl *Derived,
1837 CastExpr::path_const_iterator PathBegin,
1838 CastExpr::path_const_iterator PathEnd,
1839 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001840
John McCall7f416cc2015-09-08 08:05:57 +00001841 Address GetAddressOfDerivedClass(Address Value,
1842 const CXXRecordDecl *Derived,
1843 CastExpr::path_const_iterator PathBegin,
1844 CastExpr::path_const_iterator PathEnd,
1845 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00001846
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001847 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1848 /// base constructor/destructor with virtual bases.
1849 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1850 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1851 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1852 bool Delegating);
1853
John McCallf8ff7b92010-02-23 00:48:20 +00001854 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1855 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001856 const FunctionArgList &Args,
1857 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001858 // It's important not to confuse this and the previous function. Delegating
1859 // constructors are the C++0x feature. The constructor delegate optimization
1860 // is used to reduce duplication in the base and complete consturctors where
1861 // they are substantially the same.
1862 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1863 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001864
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001865 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001866 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001867 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001868
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001869 /// Emit assumption load for all bases. Requires to be be called only on
1870 /// most-derived class and not under construction of the object.
1871 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
1872
1873 /// Emit assumption that vptr load == global vtable.
1874 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
1875
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001876 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00001877 Address This, Address Src,
1878 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001879
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001880 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001881 const ConstantArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00001882 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001883 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001884 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001885
Anders Carlssond49844b2009-09-23 02:45:36 +00001886 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1887 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00001888 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001889 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001890 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001891
John McCall82fe67b2011-07-09 01:37:26 +00001892 static Destroyer destroyCXXObject;
1893
Anders Carlsson0a637412009-05-29 21:03:38 +00001894 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001895 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001896 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001897
John McCall99210dc2011-09-15 06:49:18 +00001898 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001899 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00001900 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00001901 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00001902
Peter Collingbourne702b2842011-11-27 22:09:22 +00001903 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00001904 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001905
David Majnemerdc012fa2015-04-22 21:38:15 +00001906 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
1907 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
1908
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001909 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001910 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001911
Eli Friedman24f55432009-11-18 00:57:03 +00001912 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1913 QualType DeleteTy);
1914
Richard Smith760520b2014-06-03 23:27:44 +00001915 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1916 const Expr *Arg, bool IsDelete);
1917
John McCall7f416cc2015-09-08 08:05:57 +00001918 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
1919 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
1920 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001921
Richard Smith69d0d262012-08-24 00:54:33 +00001922 /// \brief Situations in which we might emit a check for the suitability of a
1923 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001924 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001925 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001926 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001927 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001928 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001929 /// Checking the bound value in a reference binding. Must be suitably sized
1930 /// and aligned, but is not required to refer to an object (until the
1931 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001932 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001933 /// Checking the object expression in a non-static data member access. Must
1934 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001935 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001936 /// Checking the 'this' pointer for a call to a non-static member function.
1937 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001938 TCK_MemberCall,
1939 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001940 TCK_ConstructorCall,
1941 /// Checking the operand of a static_cast to a derived pointer type. Must be
1942 /// null or an object within its lifetime.
1943 TCK_DowncastPointer,
1944 /// Checking the operand of a static_cast to a derived reference type. Must
1945 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001946 TCK_DowncastReference,
1947 /// Checking the operand of a cast to a base object. Must be suitably sized
1948 /// and aligned.
1949 TCK_Upcast,
1950 /// Checking the operand of a cast to a virtual base object. Must be an
1951 /// object within its lifetime.
1952 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00001953 };
1954
Alexey Samsonovac4afe42014-07-07 23:59:57 +00001955 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
1956 /// calls to EmitTypeCheck can be skipped.
1957 bool sanitizePerformTypeCheck() const;
1958
Richard Smith4d1458e2012-09-08 02:08:36 +00001959 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001960 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001961 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001962 QualType Type, CharUnits Alignment = CharUnits::Zero(),
1963 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001964
Richard Smith539e4a72013-02-23 02:53:19 +00001965 /// \brief Emit a check that \p Base points into an array object, which
1966 /// we can access at index \p Index. \p Accessed should be \c false if we
1967 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1968 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1969 QualType IndexType, bool Accessed);
1970
Chris Lattner116ce8f2010-01-09 21:40:03 +00001971 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1972 bool isInc, bool isPre);
1973 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1974 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00001975
1976 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00001977 llvm::Value *OffsetValue = nullptr) {
1978 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
1979 OffsetValue);
1980 }
Hal Finkelbcc06082014-09-07 22:58:14 +00001981
Chris Lattner8394d792007-06-05 20:53:16 +00001982 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001983 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001984 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001985
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001986 /// EmitDecl - Emit a declaration.
1987 ///
1988 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001989 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001990
John McCall1c9c3fd2010-10-15 04:57:14 +00001991 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001992 ///
1993 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001994 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001995
David Blaikie73ca5692014-12-09 00:32:22 +00001996 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001997 bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00001998 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001999
John McCallbd309292010-07-06 01:34:17 +00002000 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2001 llvm::Value *Address);
2002
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002003 /// \brief Determine whether the given initializer is trivial in the sense
2004 /// that it requires no code to be generated.
2005 bool isTrivialInitializer(const Expr *Init);
2006
John McCall1c9c3fd2010-10-15 04:57:14 +00002007 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002008 ///
2009 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002010 void EmitAutoVarDecl(const VarDecl &D);
2011
2012 class AutoVarEmission {
2013 friend class CodeGenFunction;
2014
John McCall9e2e22f2011-02-22 07:16:58 +00002015 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002016
John McCall7f416cc2015-09-08 08:05:57 +00002017 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002018 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002019 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002020
2021 llvm::Value *NRVOFlag;
2022
2023 /// True if the variable is a __block variable.
2024 bool IsByRef;
2025
2026 /// True if the variable is of aggregate type and has a constant
2027 /// initializer.
2028 bool IsConstantAggregate;
2029
Nadav Rotem1da30942013-03-23 06:43:35 +00002030 /// Non-null if we should use lifetime annotations.
2031 llvm::Value *SizeForLifetimeMarkers;
2032
John McCall9e2e22f2011-02-22 07:16:58 +00002033 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002034 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002035
John McCallc533cb72011-02-22 06:44:22 +00002036 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002037 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002038 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002039 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002040
John McCall7f416cc2015-09-08 08:05:57 +00002041 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002042
2043 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002044 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2045
Craig Topper8a13c412014-05-21 05:09:00 +00002046 bool useLifetimeMarkers() const {
2047 return SizeForLifetimeMarkers != nullptr;
2048 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002049 llvm::Value *getSizeForLifetimeMarkers() const {
2050 assert(useLifetimeMarkers());
2051 return SizeForLifetimeMarkers;
2052 }
2053
2054 /// Returns the raw, allocated address, which is not necessarily
2055 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002056 Address getAllocatedAddress() const {
2057 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002058 }
2059
John McCallc533cb72011-02-22 06:44:22 +00002060 /// Returns the address of the object within this declaration.
2061 /// Note that this does not chase the forwarding pointer for
2062 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002063 Address getObjectAddress(CodeGenFunction &CGF) const {
2064 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002065
John McCall7f416cc2015-09-08 08:05:57 +00002066 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002067 }
2068 };
2069 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2070 void EmitAutoVarInit(const AutoVarEmission &emission);
2071 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002072 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2073 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002074
John McCall1c9c3fd2010-10-15 04:57:14 +00002075 void EmitStaticVarDecl(const VarDecl &D,
2076 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002077
John McCall7f416cc2015-09-08 08:05:57 +00002078 class ParamValue {
2079 llvm::Value *Value;
2080 unsigned Alignment;
2081 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2082 public:
2083 static ParamValue forDirect(llvm::Value *value) {
2084 return ParamValue(value, 0);
2085 }
2086 static ParamValue forIndirect(Address addr) {
2087 assert(!addr.getAlignment().isZero());
2088 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2089 }
2090
2091 bool isIndirect() const { return Alignment != 0; }
2092 llvm::Value *getAnyValue() const { return Value; }
2093
2094 llvm::Value *getDirectValue() const {
2095 assert(!isIndirect());
2096 return Value;
2097 }
2098
2099 Address getIndirectAddress() const {
2100 assert(isIndirect());
2101 return Address(Value, CharUnits::fromQuantity(Alignment));
2102 }
2103 };
2104
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002105 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002106 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002107
John McCallc07a0c72011-02-17 10:25:35 +00002108 /// protectFromPeepholes - Protect a value that we're intending to
2109 /// store to the side, but which will probably be used later, from
2110 /// aggressive peepholing optimizations that might delete it.
2111 ///
2112 /// Pass the result to unprotectFromPeepholes to declare that
2113 /// protection is no longer required.
2114 ///
2115 /// There's no particular reason why this shouldn't apply to
2116 /// l-values, it's just that no existing peepholes work on pointers.
2117 PeepholeProtection protectFromPeepholes(RValue rvalue);
2118 void unprotectFromPeepholes(PeepholeProtection protection);
2119
Chris Lattner84915fa2007-06-02 04:16:21 +00002120 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002121 // Statement Emission
2122 //===--------------------------------------------------------------------===//
2123
Mike Stumpfc496822009-02-08 23:14:22 +00002124 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002125 void EmitStopPoint(const Stmt *S);
2126
Mike Stumpfc496822009-02-08 23:14:22 +00002127 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2128 /// this function even if there is no current insertion point.
2129 ///
2130 /// This function may clear the current insertion point; callers should use
2131 /// EnsureInsertPoint if they wish to subsequently generate code without first
2132 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002133 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002134
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002135 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002136 /// necessarily require an insertion point or debug information; typically
2137 /// because the statement amounts to a jump or a container of other
2138 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002139 ///
2140 /// \return True if the statement was handled.
2141 bool EmitSimpleStmt(const Stmt *S);
2142
John McCall7f416cc2015-09-08 08:05:57 +00002143 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2144 AggValueSlot AVS = AggValueSlot::ignored());
2145 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2146 bool GetLast = false,
2147 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002148 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002149
Mike Stumpfc496822009-02-08 23:14:22 +00002150 /// EmitLabel - Emit the block for the given label. It is legal to call this
2151 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002152 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002153
Chris Lattnerac248202007-05-30 00:13:02 +00002154 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002155 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002156 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002157 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002158 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002159
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002160 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002161 ArrayRef<const Attr *> Attrs = None);
2162 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002163 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002164 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002165 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002166 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002167 void EmitBreakStmt(const BreakStmt &S);
2168 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002169 void EmitSwitchStmt(const SwitchStmt &S);
2170 void EmitDefaultStmt(const DefaultStmt &S);
2171 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002172 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002173 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002174
Anders Carlsson2e744e82008-08-30 19:51:14 +00002175 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002176 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2177 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002178 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002179 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002180
John McCallb609d3f2010-07-07 06:56:46 +00002181 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2182 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002183
Anders Carlsson52d78a52009-09-27 18:58:34 +00002184 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002185 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002186 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002187 void EnterSEHTryStmt(const SEHTryStmt &S);
2188 void ExitSEHTryStmt(const SEHTryStmt &S);
2189
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002190 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002191 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002192
2193 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2194 const SEHExceptStmt &Except);
2195
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002196 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2197 const SEHFinallyStmt &Finally);
2198
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002199 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2200 llvm::Value *ParentFP,
2201 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002202 llvm::Value *EmitSEHExceptionCode();
2203 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002204 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002205
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002206 /// Scan the outlined statement for captures from the parent function. For
2207 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002208 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002209 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002210 bool IsFilter);
2211
2212 /// Recovers the address of a local in a parent function. ParentVar is the
2213 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002214 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002215 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2216 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002217 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2218 Address ParentVar,
2219 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002220
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002221 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002222 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002223
Alexey Bataev1189bd02016-01-26 12:20:39 +00002224 /// Returns calculated size of the specified type.
2225 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002226 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002227 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002228 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002229 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Carlo Bertolli430d8ec2016-03-03 20:34:23 +00002230 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S,
2231 QualType ReturnQTy);
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002232 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002233 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002234 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002235 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2236 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002237 /// \brief Perform element by element copying of arrays with type \a
2238 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2239 /// generated by \a CopyGen.
2240 ///
2241 /// \param DestAddr Address of the destination array.
2242 /// \param SrcAddr Address of the source array.
2243 /// \param OriginalType Type of destination and source arrays.
2244 /// \param CopyGen Copying procedure that copies value of single array element
2245 /// to another single array element.
2246 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002247 Address DestAddr, Address SrcAddr, QualType OriginalType,
2248 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002249 /// \brief Emit proper copying of data from one variable to another.
2250 ///
2251 /// \param OriginalType Original type of the copied variables.
2252 /// \param DestAddr Destination address.
2253 /// \param SrcAddr Source address.
2254 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2255 /// type of the base array element).
2256 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2257 /// the base array element).
2258 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2259 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002260 void EmitOMPCopy(QualType OriginalType,
2261 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002262 const VarDecl *DestVD, const VarDecl *SrcVD,
2263 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002264 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2265 /// \a X = \a E \a BO \a E.
2266 ///
2267 /// \param X Value to be updated.
2268 /// \param E Update value.
2269 /// \param BO Binary operation for update operation.
2270 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2271 /// expression, false otherwise.
2272 /// \param AO Atomic ordering of the generated atomic instructions.
2273 /// \param CommonGen Code generator for complex expressions that cannot be
2274 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002275 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2276 /// generated, <false, RValue::get(nullptr)> otherwise.
2277 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002278 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2279 llvm::AtomicOrdering AO, SourceLocation Loc,
2280 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002281 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002282 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002283 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2284 OMPPrivateScope &PrivateScope);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002285 /// \brief Emit code for copyin clause in \a D directive. The next code is
2286 /// generated at the start of outlined functions for directives:
2287 /// \code
2288 /// threadprivate_var1 = master_threadprivate_var1;
2289 /// operator=(threadprivate_var2, master_threadprivate_var2);
2290 /// ...
2291 /// __kmpc_barrier(&loc, global_tid);
2292 /// \endcode
2293 ///
2294 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2295 /// \returns true if at least one copyin variable is found, false otherwise.
2296 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002297 /// \brief Emit initial code for lastprivate variables. If some variable is
2298 /// not also firstprivate, then the default initialization is used. Otherwise
2299 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2300 /// method.
2301 ///
2302 /// \param D Directive that may have 'lastprivate' directives.
2303 /// \param PrivateScope Private scope for capturing lastprivate variables for
2304 /// proper codegen in internal captured statement.
2305 ///
2306 /// \returns true if there is at least one lastprivate variable, false
2307 /// otherwise.
2308 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2309 OMPPrivateScope &PrivateScope);
2310 /// \brief Emit final copying of lastprivate values to original variables at
2311 /// the end of the worksharing or simd directive.
2312 ///
2313 /// \param D Directive that has at least one 'lastprivate' directives.
2314 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2315 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002316 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002317 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002318 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002319 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002320 /// Emit initial code for linear clauses.
2321 void EmitOMPLinearClause(const OMPLoopDirective &D,
2322 CodeGenFunction::OMPPrivateScope &PrivateScope);
2323 /// Emit final code for linear clauses.
2324 /// \param CondGen Optional conditional code for final part of codegen for
2325 /// linear clause.
2326 void EmitOMPLinearClauseFinal(
2327 const OMPLoopDirective &D,
2328 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002329 /// \brief Emit initial code for reduction variables. Creates reduction copies
2330 /// and initializes them with the values according to OpenMP standard.
2331 ///
2332 /// \param D Directive (possibly) with the 'reduction' clause.
2333 /// \param PrivateScope Private scope for capturing reduction variables for
2334 /// proper codegen in internal captured statement.
2335 ///
2336 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2337 OMPPrivateScope &PrivateScope);
2338 /// \brief Emit final update of reduction values to original variables at
2339 /// the end of the directive.
2340 ///
2341 /// \param D Directive that has at least one 'reduction' directives.
2342 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002343 /// \brief Emit initial code for linear variables. Creates private copies
2344 /// and initializes them with the values according to OpenMP standard.
2345 ///
2346 /// \param D Directive (possibly) with the 'linear' clause.
2347 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002348
Alexey Bataev7292c292016-04-25 12:22:29 +00002349 struct OMPPrivateDataTy {
2350 bool Tied;
2351 unsigned NumberOfParts;
2352 SmallVector<const Expr *, 4> PrivateVars;
2353 SmallVector<const Expr *, 4> PrivateCopies;
2354 SmallVector<const Expr *, 4> FirstprivateVars;
2355 SmallVector<const Expr *, 4> FirstprivateCopies;
2356 SmallVector<const Expr *, 4> FirstprivateInits;
2357 SmallVector<std::pair<OpenMPDependClauseKind, const Expr *>, 4> Dependences;
2358 };
2359 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2360 llvm::Value * /*OutlinedFn*/,
2361 const OMPPrivateDataTy & /*Data*/)>
2362 TaskGenTy;
2363 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2364 const RegionCodeGenTy &BodyGen,
2365 const TaskGenTy &TaskGen, bool Tied);
2366
Alexey Bataev9959db52014-05-06 10:08:46 +00002367 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002368 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002369 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002370 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002371 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002372 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002373 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002374 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002375 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002376 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002377 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002378 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002379 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002380 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002381 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002382 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002383 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002384 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002385 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002386 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002387 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002388 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002389 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002390 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002391 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002392 void
2393 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002394 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002395 void
2396 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002397 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002398 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002399 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002400 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002401 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002402 void EmitOMPDistributeLoop(const OMPDistributeDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002403
Alexey Bataev14fa1c62016-03-29 05:34:15 +00002404 /// Emit outlined function for the target directive.
2405 static std::pair<llvm::Function * /*OutlinedFn*/,
2406 llvm::Constant * /*OutlinedFnID*/>
2407 EmitOMPTargetDirectiveOutlinedFunction(CodeGenModule &CGM,
2408 const OMPTargetDirective &S,
2409 StringRef ParentName,
2410 bool IsOffloadEntry);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002411 /// \brief Emit inner loop of the worksharing/simd construct.
2412 ///
2413 /// \param S Directive, for which the inner loop must be emitted.
2414 /// \param RequiresCleanup true, if directive has some associated private
2415 /// variables.
2416 /// \param LoopCond Bollean condition for loop continuation.
2417 /// \param IncExpr Increment expression for loop control variable.
2418 /// \param BodyGen Generator for the inner body of the inner loop.
2419 /// \param PostIncGen Genrator for post-increment code (required for ordered
2420 /// loop directvies).
2421 void EmitOMPInnerLoop(
2422 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2423 const Expr *IncExpr,
2424 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2425 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002426
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002427 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002428 /// Emit initial code for loop counters of loop-based directives.
2429 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2430 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002431
Alexander Musmanc6388682014-12-15 07:07:06 +00002432private:
Alexander Musmanc6388682014-12-15 07:07:06 +00002433 /// Helpers for the OpenMP loop directives.
Alexey Bataev0f34da12015-07-02 04:17:07 +00002434 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002435 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002436 void EmitOMPSimdFinal(
2437 const OMPLoopDirective &D,
2438 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev38e89532015-04-16 04:54:05 +00002439 /// \brief Emit code for the worksharing loop-based directive.
2440 /// \return true, if this construct has any lastprivate clause, false -
2441 /// otherwise.
2442 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002443 void EmitOMPOuterLoop(bool IsMonotonic, bool DynamicOrOrdered,
2444 const OMPLoopDirective &S, OMPPrivateScope &LoopScope, bool Ordered,
2445 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexander Musmandf7a8e22015-01-22 08:49:35 +00002446 void EmitOMPForOuterLoop(OpenMPScheduleClauseKind ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002447 bool IsMonotonic, const OMPLoopDirective &S,
2448 OMPPrivateScope &LoopScope, bool Ordered, Address LB,
2449 Address UB, Address ST, Address IL,
2450 llvm::Value *Chunk);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002451 void EmitOMPDistributeOuterLoop(
2452 OpenMPDistScheduleClauseKind ScheduleKind,
2453 const OMPDistributeDirective &S, OMPPrivateScope &LoopScope,
2454 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002455 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002456 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002457
2458public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002459
Chris Lattner208ae962007-05-30 17:57:17 +00002460 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002461 // LValue Expression Emission
2462 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002463
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002464 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2465 RValue GetUndefRValue(QualType Ty);
2466
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002467 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2468 /// and issue an ErrorUnsupported style diagnostic (using the
2469 /// provided Name).
2470 RValue EmitUnsupportedRValue(const Expr *E,
2471 const char *Name);
2472
Mike Stumpfc496822009-02-08 23:14:22 +00002473 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2474 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002475 LValue EmitUnsupportedLValue(const Expr *E,
2476 const char *Name);
2477
Chris Lattner8394d792007-06-05 20:53:16 +00002478 /// EmitLValue - Emit code to compute a designator that specifies the location
2479 /// of the expression.
2480 ///
2481 /// This can return one of two things: a simple address or a bitfield
2482 /// reference. In either case, the LLVM Value* in the LValue structure is
2483 /// guaranteed to be an LLVM pointer type.
2484 ///
2485 /// If this returns a bitfield reference, nothing about the pointee type of
2486 /// the LLVM value is known: For example, it may not be a pointer to an
2487 /// integer.
2488 ///
2489 /// If this returns a normal address, and if the lvalue's C type is fixed
2490 /// size, this method guarantees that the returned pointer type will point to
2491 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2492 /// variable length type, this is not possible.
2493 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002494 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002495
Richard Smith4d1458e2012-09-08 02:08:36 +00002496 /// \brief Same as EmitLValue but additionally we generate checking code to
2497 /// guard against undefined behavior. This is only suitable when we know
2498 /// that the address will be used to access the object.
2499 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002500
John McCall7f416cc2015-09-08 08:05:57 +00002501 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002502 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002503
John McCalla8ec7eb2013-03-07 21:37:17 +00002504 void EmitAtomicInit(Expr *E, LValue lvalue);
2505
David Majnemera5b195a2015-02-14 01:35:12 +00002506 bool LValueIsSuitableForInlineAtomic(LValue Src);
2507 bool typeIsSuitableForInlineAtomic(QualType Ty, bool IsVolatile) const;
2508
2509 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2510 AggValueSlot Slot = AggValueSlot::ignored());
2511
Nick Lewycky2d84e842013-10-02 02:29:49 +00002512 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002513 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002514 AggValueSlot slot = AggValueSlot::ignored());
2515
2516 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2517
David Majnemera5b195a2015-02-14 01:35:12 +00002518 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2519 bool IsVolatile, bool isInit);
2520
Alexey Bataevb4505a72015-03-30 05:20:59 +00002521 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002522 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00002523 llvm::AtomicOrdering Success =
2524 llvm::AtomicOrdering::SequentiallyConsistent,
2525 llvm::AtomicOrdering Failure =
2526 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00002527 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2528
Alexey Bataevb4505a72015-03-30 05:20:59 +00002529 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002530 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002531 bool IsVolatile);
2532
John McCall3a7f6922010-10-27 20:58:56 +00002533 /// EmitToMemory - Change a scalar value from its value
2534 /// representation to its in-memory representation.
2535 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2536
2537 /// EmitFromMemory - Change a scalar value from its memory
2538 /// representation to its value representation.
2539 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2540
Daniel Dunbar1d425462009-02-10 00:57:50 +00002541 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2542 /// care to appropriately convert from the memory representation to
2543 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002544 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002545 SourceLocation Loc,
John McCall7f416cc2015-09-08 08:05:57 +00002546 AlignmentSource AlignSource =
2547 AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002548 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002549 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002550 uint64_t TBAAOffset = 0,
2551 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002552
2553 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2554 /// care to appropriately convert from the memory representation to
2555 /// the LLVM value representation. The l-value must be a simple
2556 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002557 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002558
2559 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2560 /// care to appropriately convert from the memory representation to
2561 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002562 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
2563 bool Volatile, QualType Ty,
2564 AlignmentSource AlignSource = AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002565 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002566 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002567 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002568
2569 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2570 /// care to appropriately convert from the memory representation to
2571 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002572 /// l-value. The isInit flag indicates whether this is an initialization.
2573 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2574 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002575
Chris Lattner8394d792007-06-05 20:53:16 +00002576 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2577 /// this method emits the address of the lvalue, then loads the result as an
2578 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002579 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002580 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2581 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002582 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002583
Chris Lattner8394d792007-06-05 20:53:16 +00002584 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2585 /// lvalue, where both are guaranteed to the have the same type, and that type
2586 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002587 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002588 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002589 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002590
Nick Lewycky2d84e842013-10-02 02:29:49 +00002591 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2592 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002593 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002594 /// \param Result [out] - If non-null, this will be set to a Value* for the
2595 /// bit-field contents after the store, appropriate for use as the result of
2596 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002597 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002598 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002599
John McCall4f29b492010-11-16 23:07:28 +00002600 /// Emit an l-value for an assignment (simple or compound) of complex type.
2601 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002602 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002603 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2604 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002605
Chris Lattner57540c52011-04-15 05:22:18 +00002606 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002607 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002608 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002609 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002610 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002611 // Note: only available for agg return types
2612 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002613 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002614 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002615 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002616 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002617 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002618 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2619 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00002620 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
2621 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002622 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002623 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002624 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002625 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002626 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002627 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002628 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002629 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002630 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002631
John McCall7f416cc2015-09-08 08:05:57 +00002632 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002633
Nick Lewycky2d84e842013-10-02 02:29:49 +00002634 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002635
John McCall7f416cc2015-09-08 08:05:57 +00002636 Address EmitArrayToPointerDecay(const Expr *Array,
2637 AlignmentSource *AlignSource = nullptr);
2638
John McCall71335052012-03-10 03:05:10 +00002639 class ConstantEmission {
2640 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2641 ConstantEmission(llvm::Constant *C, bool isReference)
2642 : ValueAndIsReference(C, isReference) {}
2643 public:
2644 ConstantEmission() {}
2645 static ConstantEmission forReference(llvm::Constant *C) {
2646 return ConstantEmission(C, true);
2647 }
2648 static ConstantEmission forValue(llvm::Constant *C) {
2649 return ConstantEmission(C, false);
2650 }
2651
Aaron Ballman67347662015-02-15 22:00:28 +00002652 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002653 return ValueAndIsReference.getOpaqueValue() != nullptr;
2654 }
John McCall71335052012-03-10 03:05:10 +00002655
2656 bool isReference() const { return ValueAndIsReference.getInt(); }
2657 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2658 assert(isReference());
2659 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2660 refExpr->getType());
2661 }
2662
2663 llvm::Constant *getValue() const {
2664 assert(!isReference());
2665 return ValueAndIsReference.getPointer();
2666 }
2667 };
2668
John McCall113bee02012-03-10 09:33:50 +00002669 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002670
John McCallfe96e0b2011-11-06 09:01:30 +00002671 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2672 AggValueSlot slot = AggValueSlot::ignored());
2673 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2674
Daniel Dunbar722f4242009-04-22 05:08:15 +00002675 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002676 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002677 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002678 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002679
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002680 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2681 /// if the Field is a reference, this will return the address of the reference
2682 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002683 LValue EmitLValueForFieldInitialization(LValue Base,
2684 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002685
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002686 LValue EmitLValueForIvar(QualType ObjectTy,
2687 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002688 unsigned CVRQualifiers);
2689
Anders Carlsson3be22e22009-05-30 23:23:33 +00002690 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002691 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002692 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002693 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002694 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002695
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002696 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002697 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002698 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002699 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002700 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002701 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002702
Chris Lattnerd7f58862007-06-02 05:24:33 +00002703 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002704 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002705 //===--------------------------------------------------------------------===//
2706
Mike Stumpfc496822009-02-08 23:14:22 +00002707 /// EmitCall - Generate a call of the given function, expecting the given
2708 /// result type, and using the given argument list which specifies both the
2709 /// LLVM arguments and the types they were derived from.
Samuel Antao798f11c2015-11-23 22:04:44 +00002710 RValue EmitCall(const CGFunctionInfo &FnInfo, llvm::Value *Callee,
2711 ReturnValueSlot ReturnValue, const CallArgList &Args,
2712 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Craig Topper8a13c412014-05-21 05:09:00 +00002713 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002714
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002715 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002716 ReturnValueSlot ReturnValue,
Samuel Antao798f11c2015-11-23 22:04:44 +00002717 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Peter Collingbournef7706832014-12-12 23:41:25 +00002718 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002719 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002720 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002721
Eric Christopherc7e79db2015-11-12 00:44:04 +00002722 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00002723
John McCall882987f2013-02-28 19:01:20 +00002724 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2725 const Twine &name = "");
2726 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2727 ArrayRef<llvm::Value*> args,
2728 const Twine &name = "");
2729 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2730 const Twine &name = "");
2731 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2732 ArrayRef<llvm::Value*> args,
2733 const Twine &name = "");
2734
John McCallbd309292010-07-06 01:34:17 +00002735 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002736 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002737 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002738 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2739 ArrayRef<llvm::Value*> args,
2740 const Twine &name = "");
2741 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2742 const Twine &name = "");
2743 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2744 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002745
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002746 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2747 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002748 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002749
2750 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2751 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002752 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002753
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002754 RValue
2755 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2756 ReturnValueSlot ReturnValue, llvm::Value *This,
2757 llvm::Value *ImplicitParam,
2758 QualType ImplicitParamTy, const CallExpr *E);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00002759 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD, llvm::Value *Callee,
2760 llvm::Value *This, llvm::Value *ImplicitParam,
2761 QualType ImplicitParamTy, const CallExpr *E,
2762 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002763 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2764 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002765 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2766 const CXXMethodDecl *MD,
2767 ReturnValueSlot ReturnValue,
2768 bool HasQualifier,
2769 NestedNameSpecifier *Qualifier,
2770 bool IsArrow, const Expr *Base);
2771 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002772 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
2773 llvm::Value *memberPtr,
2774 const MemberPointerType *memberPtrType,
2775 AlignmentSource *AlignSource = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002776 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2777 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002778
Anders Carlsson4034a952009-05-27 04:18:27 +00002779 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002780 const CXXMethodDecl *MD,
2781 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002782
Peter Collingbournefe883422011-10-06 18:29:37 +00002783 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2784 ReturnValueSlot ReturnValue);
2785
Justin Lebar3039a592016-01-23 21:28:14 +00002786 RValue EmitCUDADevicePrintfCallExpr(const CallExpr *E,
2787 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002788
Mike Stump11289f42009-09-09 15:08:12 +00002789 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002790 unsigned BuiltinID, const CallExpr *E,
2791 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002792
Anders Carlssonbfb36712009-12-24 21:13:40 +00002793 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002794
Mike Stumpfc496822009-02-08 23:14:22 +00002795 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2796 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002797 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2798
Kevin Qin1718af62013-11-14 02:45:18 +00002799 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2800 const llvm::CmpInst::Predicate Fp,
2801 const llvm::CmpInst::Predicate Ip,
2802 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002803 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002804
2805 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2806 unsigned LLVMIntrinsic,
2807 unsigned AltLLVMIntrinsic,
2808 const char *NameHint,
2809 unsigned Modifier,
2810 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002811 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00002812 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00002813 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2814 unsigned Modifier, llvm::Type *ArgTy,
2815 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002816 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002817 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002818 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002819 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002820 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002821 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002822 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002823 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2824 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00002825 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00002826 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002827
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002828 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002829 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2830 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00002831 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00002832 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00002833 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00002834 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
2835 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002836
Daniel Dunbar66912a12008-08-20 00:28:19 +00002837 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002838 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002839 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002840 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2841 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2842 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002843 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002844 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002845 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2846 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002847
John McCall31168b02011-06-15 23:02:42 +00002848 /// Retrieves the default cleanup kind for an ARC cleanup.
2849 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2850 CleanupKind getARCCleanupKind() {
2851 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2852 ? NormalAndEHCleanup : NormalCleanup;
2853 }
2854
2855 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00002856 void EmitARCInitWeak(Address addr, llvm::Value *value);
2857 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00002858 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00002859 llvm::Value *EmitARCLoadWeakRetained(Address addr);
2860 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
2861 void EmitARCCopyWeak(Address dst, Address src);
2862 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00002863 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2864 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002865 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002866 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00002867 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002868 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002869 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00002870 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002871 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00002872 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00002873 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00002874 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00002875 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2876 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2877 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00002878 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00002879
2880 std::pair<LValue,llvm::Value*>
2881 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2882 std::pair<LValue,llvm::Value*>
2883 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00002884 std::pair<LValue,llvm::Value*>
2885 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00002886
John McCall248512a2011-10-01 10:32:24 +00002887 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002888 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2889 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2890
John McCallff613032011-10-04 06:23:45 +00002891 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00002892 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
2893 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00002894 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2895 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00002896 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002897
Craig Topper00bbdcf2014-06-28 23:22:23 +00002898 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002899
John McCall82fe67b2011-07-09 01:37:26 +00002900 static Destroyer destroyARCStrongImprecise;
2901 static Destroyer destroyARCStrongPrecise;
2902 static Destroyer destroyARCWeak;
2903
John McCall31168b02011-06-15 23:02:42 +00002904 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2905 llvm::Value *EmitObjCAutoreleasePoolPush();
2906 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2907 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2908 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2909
Richard Smitha1c9d4d2013-06-12 23:38:09 +00002910 /// \brief Emits a reference binding to the passed in expression.
2911 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002912
Chris Lattner6278e6a2007-08-11 00:04:45 +00002913 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002914 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002915 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002916
2917 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002918
2919 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2920 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002921 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002922
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00002923 /// Emit a conversion from the specified type to the specified destination
2924 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00002925 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00002926 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00002927
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00002928 /// Emit a conversion from the specified complex type to the specified
2929 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002930 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00002931 QualType DstTy,
2932 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00002933
John McCall7a626f62010-09-15 10:14:12 +00002934 /// EmitAggExpr - Emit the computation of the specified expression
2935 /// of aggregate type. The result is computed into the given slot,
2936 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002937 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002938
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002939 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2940 /// aggregate type into a temporary LValue.
2941 LValue EmitAggExprToLValue(const Expr *E);
2942
John McCall1bd25562011-06-24 23:21:27 +00002943 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2944 /// make sure it survives garbage collection until this point.
2945 void EmitExtendGCLifetime(llvm::Value *object);
2946
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002947 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002948 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002949 ComplexPairTy EmitComplexExpr(const Expr *E,
2950 bool IgnoreReal = false,
2951 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002952
John McCall47fb9502013-03-07 21:37:08 +00002953 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2954 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002955 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002956
John McCall47fb9502013-03-07 21:37:08 +00002957 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002958 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00002959
2960 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002961 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002962
John McCall7f416cc2015-09-08 08:05:57 +00002963 Address emitAddrOfRealComponent(Address complex, QualType complexType);
2964 Address emitAddrOfImagComponent(Address complex, QualType complexType);
2965
Chandler Carruth84537952012-03-30 19:44:53 +00002966 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2967 /// global variable that has already been created for it. If the initializer
2968 /// has a different type than GV does, this may free GV and return a different
2969 /// one. Otherwise it just returns GV.
2970 llvm::GlobalVariable *
2971 AddInitializerToStaticVarDecl(const VarDecl &D,
2972 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002973
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002974
Anders Carlssonf40886a2009-08-08 21:45:14 +00002975 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2976 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002977 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2978 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002979
David Majnemerb3341ea2014-10-05 05:05:40 +00002980 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
2981 llvm::Constant *Addr);
2982
John McCallc84ed6a2012-05-01 06:13:13 +00002983 /// Call atexit() with a function that passes the given argument to
2984 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00002985 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2986 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002987
John McCallcdf7ef52010-11-06 09:44:32 +00002988 /// Emit code in this function to perform a guarded variable
2989 /// initialization. Guarded initializations are used when it's not
2990 /// possible to prove that an initialization will be done exactly
2991 /// once, e.g. with a static local variable or a static data member
2992 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002993 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002994 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002995
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002996 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2997 /// variables.
2998 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00002999 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003000 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003001
John McCallee08c532012-04-06 18:21:03 +00003002 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003003 /// variables.
John McCallee08c532012-04-06 18:21:03 +00003004 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
3005 const std::vector<std::pair<llvm::WeakVH,
3006 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003007
John McCalla738c252011-03-09 04:27:21 +00003008 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3009 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003010 llvm::GlobalVariable *Addr,
3011 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003012
John McCall7a626f62010-09-15 10:14:12 +00003013 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00003014
John McCall7f416cc2015-09-08 08:05:57 +00003015 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003016
John McCall08ef4662011-11-10 08:15:53 +00003017 void enterFullExpression(const ExprWithCleanups *E) {
3018 if (E->getNumObjects() == 0) return;
3019 enterNonTrivialFullExpression(E);
3020 }
3021 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003022
Richard Smithea852322013-05-07 21:53:22 +00003023 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003024
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003025 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3026
Tim Northovercc2a6e02015-11-09 19:56:35 +00003027 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003028
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003029 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003030 // Annotations Emission
3031 //===--------------------------------------------------------------------===//
3032
3033 /// Emit an annotation call (intrinsic or builtin).
3034 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3035 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003036 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003037 SourceLocation Location);
3038
3039 /// Emit local annotations for the local variable V, declared by D.
3040 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3041
3042 /// Emit field annotations for the given field & value. Returns the
3043 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003044 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003045
3046 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003047 // Internal Helpers
3048 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003049
Chris Lattner5b1964b2008-11-11 07:41:27 +00003050 /// ContainsLabel - Return true if the statement contains a label in it. If
3051 /// this statement is not executed normally, it not containing a label means
3052 /// that we can just remove the code.
3053 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003054
Chris Lattner29911cc2011-02-28 00:18:40 +00003055 /// containsBreak - Return true if the statement contains a break out of it.
3056 /// If the statement (recursively) contains a switch or loop with a break
3057 /// inside of it, this is fine.
3058 static bool containsBreak(const Stmt *S);
3059
Daniel Dunbar682712c2008-11-12 10:12:14 +00003060 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003061 /// to a constant, or if it does but contains a label, return false. If it
3062 /// constant folds return true and set the boolean result in Result.
3063 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00003064
Chris Lattner29911cc2011-02-28 00:18:40 +00003065 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3066 /// to a constant, or if it does but contains a label, return false. If it
3067 /// constant folds return true and set the folded value.
Richard Trieuc320c742012-07-23 20:21:35 +00003068 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattner29911cc2011-02-28 00:18:40 +00003069
Chris Lattnercd439292008-11-12 08:04:58 +00003070 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3071 /// if statement) to the specified blocks. Based on the condition, this might
3072 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003073 /// TrueCount should be the number of times we expect the condition to
3074 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003075 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003076 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003077
Richard Smithe30752c2012-10-09 19:52:38 +00003078 /// \brief Emit a description of a type in a format suitable for passing to
3079 /// a runtime sanitizer handler.
3080 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3081
3082 /// \brief Convert a value into a format suitable for passing to a runtime
3083 /// sanitizer handler.
3084 llvm::Value *EmitCheckValue(llvm::Value *V);
3085
3086 /// \brief Emit a description of a source location in a format suitable for
3087 /// passing to a runtime sanitizer handler.
3088 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3089
Richard Smithde670682012-11-01 22:15:34 +00003090 /// \brief Create a basic block that will call a handler function in a
3091 /// sanitizer runtime with the provided arguments, and create a conditional
3092 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003093 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003094 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
3095 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003096
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003097 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3098 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003099 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3100 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3101 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003102
Richard Smithde670682012-11-01 22:15:34 +00003103 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3104 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003105 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003106
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003107 /// \brief Emit a call to trap or debugtrap and attach function attribute
3108 /// "trap-func-name" if specified.
3109 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3110
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003111 /// \brief Emit a cross-DSO CFI failure handling function.
3112 void EmitCfiCheckFail();
3113
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003114 /// \brief Create a check for a function parameter that may potentially be
3115 /// declared as non-null.
3116 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
3117 const FunctionDecl *FD, unsigned ParmNum);
3118
Anders Carlsson093bdff2010-03-30 03:27:09 +00003119 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003120 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003121
John McCall23f66262010-05-26 22:34:26 +00003122 /// EmitDelegateCallArg - We are performing a delegate call; that
3123 /// is, the current function is delegating to another one. Produce
3124 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003125 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3126 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003127
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003128 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3129 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003130 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003131
Chris Lattnercd439292008-11-12 08:04:58 +00003132private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003133 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003134 void EmitReturnOfRValue(RValue RV, QualType Ty);
3135
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003136 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3137
3138 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3139 DeferredReplacements;
3140
John McCall7f416cc2015-09-08 08:05:57 +00003141 /// Set the address of a local variable.
3142 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3143 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3144 LocalDeclMap.insert({VD, Addr});
3145 }
3146
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003147 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3148 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3149 ///
3150 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003151 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003152 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003153
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003154 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3155 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3156 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3157 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3158 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3159 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003160
Chad Rosier59df25b2012-08-23 20:00:18 +00003161 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003162 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003163
Chad Rosier59df25b2012-08-23 20:00:18 +00003164 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003165 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003166 std::string &ConstraintStr,
3167 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003168
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003169 /// \brief Attempts to statically evaluate the object size of E. If that
3170 /// fails, emits code to figure the size of E out for us. This is
3171 /// pass_object_size aware.
3172 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
3173 llvm::IntegerType *ResType);
3174
3175 /// \brief Emits the size of E, as required by __builtin_object_size. This
3176 /// function is aware of pass_object_size parameters, and will act accordingly
3177 /// if E is a parameter with the pass_object_size attribute.
3178 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
3179 llvm::IntegerType *ResType);
3180
Reid Kleckner89077a12013-12-17 19:46:40 +00003181public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003182#ifndef NDEBUG
3183 // Determine whether the given argument is an Objective-C method
3184 // that may have type parameters in its signature.
3185 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3186 const DeclContext *dc = method->getDeclContext();
3187 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3188 return classDecl->getTypeParamListAsWritten();
3189 }
3190
3191 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3192 return catDecl->getTypeParamList();
3193 }
3194
3195 return false;
3196 }
3197
3198 template<typename T>
3199 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3200#endif
3201
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003202 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003203 template <typename T>
3204 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003205 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003206 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00003207 unsigned ParamsToSkip = 0) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003208 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003209 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003210
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003211 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3212 "Can't skip parameters if type info is not provided");
3213 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003214#ifndef NDEBUG
3215 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3216#endif
3217
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003218 // First, use the argument types that the type info knows about
3219 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3220 E = CallArgTypeInfo->param_type_end();
3221 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003222 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003223 assert((isGenericMethod ||
3224 ((*I)->isVariablyModifiedType() ||
3225 (*I).getNonReferenceType()->isObjCRetainableType() ||
3226 getContext()
3227 .getCanonicalType((*I).getNonReferenceType())
3228 .getTypePtr() ==
3229 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003230 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003231 .getTypePtr())) &&
3232 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003233 ArgTypes.push_back(*I);
3234 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003235 }
Mike Stump11289f42009-09-09 15:08:12 +00003236
Reid Kleckner739756c2013-12-04 19:23:12 +00003237 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003238 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003239 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3240 CallArgTypeInfo->isVariadic()) &&
3241 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003242
Anders Carlsson603d6af2009-04-18 20:20:22 +00003243 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003244 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
3245 ArgTypes.push_back(getVarArgType(A));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003246
David Blaikief05779e2015-07-21 18:37:18 +00003247 EmitCallArgs(Args, ArgTypes, ArgRange, CalleeDecl, ParamsToSkip);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003248 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003249
Reid Kleckner739756c2013-12-04 19:23:12 +00003250 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003251 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003252 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00003253 unsigned ParamsToSkip = 0);
Reid Kleckner739756c2013-12-04 19:23:12 +00003254
John McCall7f416cc2015-09-08 08:05:57 +00003255 /// EmitPointerWithAlignment - Given an expression with a pointer
3256 /// type, emit the value and compute our best estimate of the
3257 /// alignment of the pointee.
3258 ///
3259 /// Note that this function will conservatively fall back on the type
3260 /// when it doesn't
3261 ///
3262 /// \param Source - If non-null, this will be initialized with
3263 /// information about the source of the alignment. Note that this
3264 /// function will conservatively fall back on the type when it
3265 /// doesn't recognize the expression, which means that sometimes
3266 ///
3267 /// a worst-case One
3268 /// reasonable way to use this information is when there's a
3269 /// language guarantee that the pointer must be aligned to some
3270 /// stricter value, and we're simply trying to ensure that
3271 /// sufficiently obvious uses of under-aligned objects don't get
3272 /// miscompiled; for example, a placement new into the address of
3273 /// a local variable. In such a case, it's quite reasonable to
3274 /// just ignore the returned alignment when it isn't from an
3275 /// explicit source.
3276 Address EmitPointerWithAlignment(const Expr *Addr,
3277 AlignmentSource *Source = nullptr);
3278
Peter Collingbournedc134532016-01-16 00:31:22 +00003279 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3280
Reid Kleckner89077a12013-12-17 19:46:40 +00003281private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003282 QualType getVarArgType(const Expr *Arg);
3283
John McCalld4f4b7f2010-03-03 04:15:11 +00003284 const TargetCodeGenInfo &getTargetHooks() const {
3285 return CGM.getTargetCodeGenInfo();
3286 }
John McCall09ae0322010-07-06 23:57:41 +00003287
3288 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003289
John McCall7f416cc2015-09-08 08:05:57 +00003290 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3291 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003292
3293 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003294
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003295 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003296};
Mike Stump11289f42009-09-09 15:08:12 +00003297
John McCallce1de612011-01-26 04:00:11 +00003298/// Helper class with most of the code for saving a value for a
3299/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003300struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003301 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3302
3303 /// Answer whether the given value needs extra work to be saved.
3304 static bool needsSaving(llvm::Value *value) {
3305 // If it's not an instruction, we don't need to save.
3306 if (!isa<llvm::Instruction>(value)) return false;
3307
3308 // If it's an instruction in the entry block, we don't need to save.
3309 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3310 return (block != &block->getParent()->getEntryBlock());
3311 }
3312
3313 /// Try to save the given value.
3314 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3315 if (!needsSaving(value)) return saved_type(value, false);
3316
John McCall7f416cc2015-09-08 08:05:57 +00003317 // Otherwise, we need an alloca.
3318 auto align = CharUnits::fromQuantity(
3319 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3320 Address alloca =
3321 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003322 CGF.Builder.CreateStore(value, alloca);
3323
John McCall7f416cc2015-09-08 08:05:57 +00003324 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003325 }
3326
3327 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003328 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003329 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003330
3331 // Otherwise, it should be an alloca instruction, as set up in save().
3332 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3333 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003334 }
3335};
3336
John McCallcb5f77f2011-01-28 10:53:53 +00003337/// A partial specialization of DominatingValue for llvm::Values that
3338/// might be llvm::Instructions.
3339template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3340 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003341 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003342 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3343 }
3344};
3345
John McCall7f416cc2015-09-08 08:05:57 +00003346/// A specialization of DominatingValue for Address.
3347template <> struct DominatingValue<Address> {
3348 typedef Address type;
3349
3350 struct saved_type {
3351 DominatingLLVMValue::saved_type SavedValue;
3352 CharUnits Alignment;
3353 };
3354
3355 static bool needsSaving(type value) {
3356 return DominatingLLVMValue::needsSaving(value.getPointer());
3357 }
3358 static saved_type save(CodeGenFunction &CGF, type value) {
3359 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3360 value.getAlignment() };
3361 }
3362 static type restore(CodeGenFunction &CGF, saved_type value) {
3363 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3364 value.Alignment);
3365 }
3366};
3367
John McCallcb5f77f2011-01-28 10:53:53 +00003368/// A specialization of DominatingValue for RValue.
3369template <> struct DominatingValue<RValue> {
3370 typedef RValue type;
3371 class saved_type {
3372 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3373 AggregateAddress, ComplexAddress };
3374
3375 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003376 unsigned K : 3;
3377 unsigned Align : 29;
3378 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3379 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003380
3381 public:
3382 static bool needsSaving(RValue value);
3383 static saved_type save(CodeGenFunction &CGF, RValue value);
3384 RValue restore(CodeGenFunction &CGF);
3385
John McCall7f416cc2015-09-08 08:05:57 +00003386 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003387 };
3388
3389 static bool needsSaving(type value) {
3390 return saved_type::needsSaving(value);
3391 }
3392 static saved_type save(CodeGenFunction &CGF, type value) {
3393 return saved_type::save(CGF, value);
3394 }
3395 static type restore(CodeGenFunction &CGF, saved_type value) {
3396 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003397 }
3398};
3399
Chris Lattnerbed31442007-05-28 01:07:47 +00003400} // end namespace CodeGen
3401} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003402
Chris Lattnerbed31442007-05-28 01:07:47 +00003403#endif