blob: eac759fc8264f605ba6ce9424fafa8e303fc5e54 [file] [log] [blame]
Daniel Dunbar9c426522008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Chris Lattnerbed31442007-05-28 01:07:47 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattnerbed31442007-05-28 01:07:47 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stumpfc496822009-02-08 23:14:22 +000010// This is the internal per-function state used for llvm translation.
Chris Lattnerbed31442007-05-28 01:07:47 +000011//
12//===----------------------------------------------------------------------===//
13
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000014#ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
15#define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
Chris Lattnerbed31442007-05-28 01:07:47 +000016
Daniel Dunbarcb463852008-11-01 01:53:16 +000017#include "CGBuilder.h"
Eric Christophera9d34972011-10-19 00:43:52 +000018#include "CGDebugInfo.h"
Alexander Musman515ad8c2014-05-22 08:54:05 +000019#include "CGLoopInfo.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000020#include "CGValue.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "CodeGenModule.h"
Justin Bogneref512b92014-01-06 22:27:43 +000022#include "CodeGenPGO.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000023#include "EHScopeStack.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000024#include "clang/AST/CharUnits.h"
25#include "clang/AST/ExprCXX.h"
26#include "clang/AST/ExprObjC.h"
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +000027#include "clang/AST/ExprOpenMP.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000028#include "clang/AST/Type.h"
29#include "clang/Basic/ABI.h"
Ben Langmuir3b4c30b2013-05-09 19:17:11 +000030#include "clang/Basic/CapturedStmt.h"
Alexander Musmandf7a8e22015-01-22 08:49:35 +000031#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000032#include "clang/Basic/TargetInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000033#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000034#include "llvm/ADT/ArrayRef.h"
35#include "llvm/ADT/DenseMap.h"
36#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000037#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000038#include "llvm/Support/Debug.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000039#include "llvm/Transforms/Utils/SanitizerStats.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000040
Chris Lattnerbed31442007-05-28 01:07:47 +000041namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000042class BasicBlock;
43class LLVMContext;
44class MDNode;
45class Module;
46class SwitchInst;
47class Twine;
48class Value;
49class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000050}
51
Chris Lattnerbed31442007-05-28 01:07:47 +000052namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000053class ASTContext;
54class BlockDecl;
55class CXXDestructorDecl;
56class CXXForRangeStmt;
57class CXXTryStmt;
58class Decl;
59class LabelDecl;
60class EnumConstantDecl;
61class FunctionDecl;
62class FunctionProtoType;
63class LabelStmt;
64class ObjCContainerDecl;
65class ObjCInterfaceDecl;
66class ObjCIvarDecl;
67class ObjCMethodDecl;
68class ObjCImplementationDecl;
69class ObjCPropertyImplDecl;
70class TargetInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000071class VarDecl;
72class ObjCForCollectionStmt;
73class ObjCAtTryStmt;
74class ObjCAtThrowStmt;
75class ObjCAtSynchronizedStmt;
76class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000077
Chris Lattnerbed31442007-05-28 01:07:47 +000078namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000079class CodeGenTypes;
80class CGFunctionInfo;
81class CGRecordLayout;
82class CGBlockInfo;
83class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000084class BlockByrefHelpers;
85class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000086class BlockFlags;
87class BlockFieldFlags;
Alexey Bataev7292c292016-04-25 12:22:29 +000088class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000089class TargetCodeGenInfo;
Alexey Bataev24b5bae2016-04-28 09:23:51 +000090struct OMPTaskDataTy;
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000091struct CGCoroData;
Mike Stumpfc496822009-02-08 23:14:22 +000092
John McCall47fb9502013-03-07 21:37:08 +000093/// The kind of evaluation to perform on values of a particular
94/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
95/// CGExprAgg?
96///
97/// TODO: should vectors maybe be split out into their own thing?
98enum TypeEvaluationKind {
99 TEK_Scalar,
100 TEK_Complex,
101 TEK_Aggregate
102};
103
Chris Lattnerbed31442007-05-28 01:07:47 +0000104/// CodeGenFunction - This class organizes the per-function state that is used
105/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000106class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000107 CodeGenFunction(const CodeGenFunction &) = delete;
108 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000109
110 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000111public:
John McCallad5d61e2010-07-23 21:56:41 +0000112 /// A jump destination is an abstract label, branching to which may
113 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000114 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000115 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000116 JumpDest(llvm::BasicBlock *Block,
117 EHScopeStack::stable_iterator Depth,
118 unsigned Index)
119 : Block(Block), ScopeDepth(Depth), Index(Index) {}
120
Craig Topper8a13c412014-05-21 05:09:00 +0000121 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000122 llvm::BasicBlock *getBlock() const { return Block; }
123 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
124 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000125
Nadav Rotem1da30942013-03-23 06:43:35 +0000126 // This should be used cautiously.
127 void setScopeDepth(EHScopeStack::stable_iterator depth) {
128 ScopeDepth = depth;
129 }
130
John McCallad5d61e2010-07-23 21:56:41 +0000131 private:
John McCallbd309292010-07-06 01:34:17 +0000132 llvm::BasicBlock *Block;
133 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000134 unsigned Index;
135 };
136
Chris Lattnerbed31442007-05-28 01:07:47 +0000137 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000138 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000139
Chris Lattner96d72562007-08-21 16:57:55 +0000140 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000141 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000142 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000143
Alexander Musman515ad8c2014-05-22 08:54:05 +0000144 /// \brief CGBuilder insert helper. This function is called after an
145 /// instruction is created using Builder.
146 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
147 llvm::BasicBlock *BB,
148 llvm::BasicBlock::iterator InsertPt) const;
149
John McCalldec348f72013-05-03 07:33:41 +0000150 /// CurFuncDecl - Holds the Decl for the current outermost
151 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000152 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000153 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
154 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000155 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000156 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000157 llvm::Function *CurFn;
158
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000159 // Holds coroutine data if the current function is a coroutine. We use a
160 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
161 // in this header.
162 struct CGCoroInfo {
163 std::unique_ptr<CGCoroData> Data;
164 CGCoroInfo();
165 ~CGCoroInfo();
166 };
167 CGCoroInfo CurCoro;
168
Mike Stumpbee78dd2009-12-04 23:26:17 +0000169 /// CurGD - The GlobalDecl for the current function being compiled.
170 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000171
John McCall31168b02011-06-15 23:02:42 +0000172 /// PrologueCleanupDepth - The cleanup depth enclosing all the
173 /// cleanups associated with the parameters.
174 EHScopeStack::stable_iterator PrologueCleanupDepth;
175
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000176 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000177 JumpDest ReturnBlock;
178
John McCall7f416cc2015-09-08 08:05:57 +0000179 /// ReturnValue - The temporary alloca to hold the return
180 /// value. This is invalid iff the function has no return value.
181 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000182
Chris Lattner03df1222007-06-02 04:53:11 +0000183 /// AllocaInsertPoint - This is an instruction in the entry block before which
184 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000185 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000186
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000187 /// \brief API for captured statement code generation.
188 class CGCapturedStmtInfo {
189 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000190 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
191 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000192 explicit CGCapturedStmtInfo(const CapturedStmt &S,
193 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000194 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000195
196 RecordDecl::field_iterator Field =
197 S.getCapturedRecordDecl()->field_begin();
198 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
199 E = S.capture_end();
200 I != E; ++I, ++Field) {
201 if (I->capturesThis())
202 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000203 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000204 CaptureFields[I->getCapturedVar()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000205 else if (I->capturesVariableByCopy())
206 CaptureFields[I->getCapturedVar()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000207 }
208 }
209
210 virtual ~CGCapturedStmtInfo();
211
212 CapturedRegionKind getKind() const { return Kind; }
213
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000214 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000215 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000216 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000217
218 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000219 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000220 return CaptureFields.lookup(VD);
221 }
222
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000223 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
224 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000225
Alexey Bataev18095712014-10-10 12:19:54 +0000226 static bool classof(const CGCapturedStmtInfo *) {
227 return true;
228 }
229
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000230 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000231 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000232 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000233 CGF.EmitStmt(S);
234 }
235
236 /// \brief Get the name of the capture helper.
237 virtual StringRef getHelperName() const { return "__captured_stmt"; }
238
239 private:
240 /// \brief The kind of captured statement being generated.
241 CapturedRegionKind Kind;
242
243 /// \brief Keep the map between VarDecl and FieldDecl.
244 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
245
246 /// \brief The base address of the captured record, passed in as the first
247 /// argument of the parallel region function.
248 llvm::Value *ThisValue;
249
250 /// \brief Captured 'this' type.
251 FieldDecl *CXXThisFieldDecl;
252 };
253 CGCapturedStmtInfo *CapturedStmtInfo;
254
Alexey Bataevd157d472015-06-24 03:35:38 +0000255 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
256 class CGCapturedStmtRAII {
257 private:
258 CodeGenFunction &CGF;
259 CGCapturedStmtInfo *PrevCapturedStmtInfo;
260 public:
261 CGCapturedStmtRAII(CodeGenFunction &CGF,
262 CGCapturedStmtInfo *NewCapturedStmtInfo)
263 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
264 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
265 }
266 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
267 };
268
Alexey Samsonova0416102014-11-11 01:26:14 +0000269 /// \brief Sanitizers enabled for this function.
270 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000271
Alexey Samsonov24cad992014-07-17 18:46:27 +0000272 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
273 bool IsSanitizerScope;
274
275 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
276 class SanitizerScope {
277 CodeGenFunction *CGF;
278 public:
279 SanitizerScope(CodeGenFunction *CGF);
280 ~SanitizerScope();
281 };
282
Reid Kleckner19819442014-07-25 21:39:46 +0000283 /// In C++, whether we are code generating a thunk. This controls whether we
284 /// should emit cleanups.
285 bool CurFuncIsThunk;
286
John McCall31168b02011-06-15 23:02:42 +0000287 /// In ARC, whether we should autorelease the return value.
288 bool AutoreleaseResult;
289
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000290 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
291 /// potentially set the return value.
292 bool SawAsmBlock;
293
David Majnemer25eb1652016-03-01 19:42:53 +0000294 const FunctionDecl *CurSEHParent = nullptr;
295
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000296 /// True if the current function is an outlined SEH helper. This can be a
297 /// finally block or filter expression.
298 bool IsOutlinedSEHHelper;
299
John McCallad7c5c12011-02-08 08:22:06 +0000300 const CodeGen::CGBlockInfo *BlockInfo;
301 llvm::Value *BlockPointer;
302
Eli Friedman9fbeba02012-02-11 02:57:39 +0000303 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
304 FieldDecl *LambdaThisCaptureField;
305
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000306 /// \brief A mapping from NRVO variables to the flags used to indicate
307 /// when the NRVO has been applied to this variable.
308 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000309
John McCallbd309292010-07-06 01:34:17 +0000310 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000311 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000312 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000313
David Majnemer4e52d6f2015-12-12 05:39:21 +0000314 llvm::Instruction *CurrentFuncletPad = nullptr;
315
Tim Shen421119f2016-07-01 21:08:47 +0000316 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
317 llvm::Value *Addr;
318 llvm::Value *Size;
319
320 public:
321 CallLifetimeEnd(Address addr, llvm::Value *size)
322 : Addr(addr.getPointer()), Size(size) {}
323
324 void Emit(CodeGenFunction &CGF, Flags flags) override {
325 CGF.EmitLifetimeEnd(Size, Addr);
326 }
327 };
328
Richard Smith736a9472013-06-12 20:42:33 +0000329 /// Header for data within LifetimeExtendedCleanupStack.
330 struct LifetimeExtendedCleanupHeader {
331 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000332 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000333 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000334 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000335
Justin Bognerbdff2192015-07-01 00:59:27 +0000336 size_t getSize() const { return Size; }
337 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000338 };
John McCallbd309292010-07-06 01:34:17 +0000339
John McCallad5d61e2010-07-23 21:56:41 +0000340 /// i32s containing the indexes of the cleanup destinations.
341 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000342
343 unsigned NextCleanupDestIndex;
344
John McCall08ef4662011-11-10 08:15:53 +0000345 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
346 CGBlockInfo *FirstBlockInfo;
347
John McCall8e4c74b2011-08-11 02:22:43 +0000348 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
349 llvm::BasicBlock *EHResumeBlock;
350
Bill Wendlingf0724e82011-09-19 20:31:14 +0000351 /// The exception slot. All landing pads write the current exception pointer
352 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000353 llvm::Value *ExceptionSlot;
354
Bill Wendlingf0724e82011-09-19 20:31:14 +0000355 /// The selector slot. Under the MandatoryCleanup model, all landing pads
356 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000357 llvm::AllocaInst *EHSelectorSlot;
358
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000359 /// A stack of exception code slots. Entering an __except block pushes a slot
360 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
361 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000362 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000363
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000364 /// Value returned by __exception_info intrinsic.
365 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000366
John McCallbd309292010-07-06 01:34:17 +0000367 /// Emits a landing pad for the current EH stack.
368 llvm::BasicBlock *EmitLandingPad();
369
370 llvm::BasicBlock *getInvokeDestImpl();
371
John McCallce1de612011-01-26 04:00:11 +0000372 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000373 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
374 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000375 }
376
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000377public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000378 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
379 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000380 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000381
John McCall6b0feb72011-06-22 02:32:12 +0000382 /// A class controlling the emission of a finally block.
383 class FinallyInfo {
384 /// Where the catchall's edge through the cleanup should go.
385 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000386
John McCall6b0feb72011-06-22 02:32:12 +0000387 /// A function to call to enter the catch.
388 llvm::Constant *BeginCatchFn;
389
390 /// An i1 variable indicating whether or not the @finally is
391 /// running for an exception.
392 llvm::AllocaInst *ForEHVar;
393
394 /// An i8* variable into which the exception pointer to rethrow
395 /// has been saved.
396 llvm::AllocaInst *SavedExnVar;
397
398 public:
399 void enter(CodeGenFunction &CGF, const Stmt *Finally,
400 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
401 llvm::Constant *rethrowFn);
402 void exit(CodeGenFunction &CGF);
403 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000404
Reid Kleckner11c033e2015-02-12 23:40:45 +0000405 /// Returns true inside SEH __try blocks.
406 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
407
Reid Klecknera002bd52015-10-28 23:06:42 +0000408 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000409 bool isCleanupPadScope() const {
410 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
411 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000412
John McCallce1de612011-01-26 04:00:11 +0000413 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
414 /// current full-expression. Safe against the possibility that
415 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000416 template <class T, class... As>
417 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000418 // If we're not in a conditional branch, or if none of the
419 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000420 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000421 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000422
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000423 // Stash values in a tuple so we can guarantee the order of saves.
424 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
425 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000426
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000427 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000428 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000429 initFullExprCleanup();
430 }
431
Richard Smith736a9472013-06-12 20:42:33 +0000432 /// \brief Queue a cleanup to be pushed after finishing the current
433 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000434 template <class T, class... As>
435 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000436 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
437
438 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
439
440 size_t OldSize = LifetimeExtendedCleanupStack.size();
441 LifetimeExtendedCleanupStack.resize(
442 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
443
Justin Bognerbdff2192015-07-01 00:59:27 +0000444 static_assert(sizeof(Header) % llvm::AlignOf<T>::Alignment == 0,
445 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000446 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
447 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000448 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000449 }
450
John McCallf4beacd2011-11-10 10:43:54 +0000451 /// Set up the last cleaup that was pushed as a conditional
452 /// full-expression cleanup.
453 void initFullExprCleanup();
454
John McCallbd309292010-07-06 01:34:17 +0000455 /// PushDestructorCleanup - Push a cleanup to call the
456 /// complete-object destructor of an object of the given type at the
457 /// given address. Does nothing if T is not a C++ class type with a
458 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000459 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000460
John McCall8680f872010-07-21 06:29:51 +0000461 /// PushDestructorCleanup - Push a cleanup to call the
462 /// complete-object variant of the given destructor on the object at
463 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000464 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000465
John McCallbd309292010-07-06 01:34:17 +0000466 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
467 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000468 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000469
John McCall824c2f52010-09-14 07:57:04 +0000470 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
471 /// The block cannot be reactivated. Pops it if it's the top of the
472 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000473 ///
474 /// \param DominatingIP - An instruction which is known to
475 /// dominate the current IP (if set) and which lies along
476 /// all paths of execution between the current IP and the
477 /// the point at which the cleanup comes into scope.
478 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
479 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000480
481 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
482 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000483 ///
484 /// \param DominatingIP - An instruction which is known to
485 /// dominate the current IP (if set) and which lies along
486 /// all paths of execution between the current IP and the
487 /// the point at which the cleanup comes into scope.
488 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
489 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000490
John McCallbd309292010-07-06 01:34:17 +0000491 /// \brief Enters a new scope for capturing cleanups, all of which
492 /// will be executed once the scope is exited.
493 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000494 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000495 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000496 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000497 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000498 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000499 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000500
Aaron Ballmanabc18922015-02-15 22:54:08 +0000501 RunCleanupsScope(const RunCleanupsScope &) = delete;
502 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000503
Eric Christophera9d34972011-10-19 00:43:52 +0000504 protected:
505 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000506
Douglas Gregor965f4502009-11-24 16:43:22 +0000507 public:
508 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000509 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000510 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000511 {
John McCallbd309292010-07-06 01:34:17 +0000512 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000513 LifetimeExtendedCleanupStackSize =
514 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000515 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000516 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000517 }
518
519 /// \brief Exit this cleanup scope, emitting any accumulated
520 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000521 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000522 if (PerformCleanup) {
523 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000524 CGF.PopCleanupBlocks(CleanupStackDepth,
525 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000526 }
527 }
528
529 /// \brief Determine whether this scope requires any cleanups.
530 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000531 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000532 }
533
534 /// \brief Force the emission of cleanups now, instead of waiting
535 /// until this object is destroyed.
536 void ForceCleanup() {
537 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000538 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000539 CGF.PopCleanupBlocks(CleanupStackDepth,
540 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000541 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000542 }
543 };
544
David Blaikie93be0b22014-08-22 21:37:04 +0000545 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000546 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000547 SmallVector<const LabelDecl*, 4> Labels;
548 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000549
Aaron Ballmanabc18922015-02-15 22:54:08 +0000550 LexicalScope(const LexicalScope &) = delete;
551 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000552
553 public:
554 /// \brief Enter a new cleanup scope.
555 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000556 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
557 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000558 if (CGDebugInfo *DI = CGF.getDebugInfo())
559 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
560 }
561
Nadav Rotem1da30942013-03-23 06:43:35 +0000562 void addLabel(const LabelDecl *label) {
563 assert(PerformCleanup && "adding label to dead scope?");
564 Labels.push_back(label);
565 }
566
Eric Christophera9d34972011-10-19 00:43:52 +0000567 /// \brief Exit this cleanup scope, emitting any accumulated
568 /// cleanups.
569 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000570 if (CGDebugInfo *DI = CGF.getDebugInfo())
571 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
572
Nadav Rotem1da30942013-03-23 06:43:35 +0000573 // If we should perform a cleanup, force them now. Note that
574 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000575 if (PerformCleanup) {
576 ApplyDebugLocation DL(CGF, Range.getEnd());
577 ForceCleanup();
578 }
Eric Christophera9d34972011-10-19 00:43:52 +0000579 }
580
581 /// \brief Force the emission of cleanups now, instead of waiting
582 /// until this object is destroyed.
583 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000584 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000585 RunCleanupsScope::ForceCleanup();
586
Nadav Rotem1da30942013-03-23 06:43:35 +0000587 if (!Labels.empty())
588 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000589 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000590
591 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000592 };
593
John McCall7f416cc2015-09-08 08:05:57 +0000594 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
595
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000596 /// \brief The scope used to remap some variables as private in the OpenMP
597 /// loop body (or other captured region emitted without outlining), and to
598 /// restore old vars back on exit.
599 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000600 DeclMapTy SavedLocals;
601 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000602
603 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000604 OMPPrivateScope(const OMPPrivateScope &) = delete;
605 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000606
607 public:
608 /// \brief Enter a new OpenMP private scope.
609 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
610
611 /// \brief Registers \a LocalVD variable as a private and apply \a
612 /// PrivateGen function for it to generate corresponding private variable.
613 /// \a PrivateGen returns an address of the generated private variable.
614 /// \return true if the variable is registered as private, false if it has
615 /// been privatized already.
616 bool
617 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000618 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000619 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000620
621 // Only save it once.
622 if (SavedLocals.count(LocalVD)) return false;
623
624 // Copy the existing local entry to SavedLocals.
625 auto it = CGF.LocalDeclMap.find(LocalVD);
626 if (it != CGF.LocalDeclMap.end()) {
627 SavedLocals.insert({LocalVD, it->second});
628 } else {
629 SavedLocals.insert({LocalVD, Address::invalid()});
630 }
631
632 // Generate the private entry.
633 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000634 QualType VarTy = LocalVD->getType();
635 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000636 Address Temp = CGF.CreateMemTemp(VarTy);
637 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
638 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000639 }
John McCall7f416cc2015-09-08 08:05:57 +0000640 SavedPrivates.insert({LocalVD, Addr});
641
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000642 return true;
643 }
644
645 /// \brief Privatizes local variables previously registered as private.
646 /// Registration is separate from the actual privatization to allow
647 /// initializers use values of the original variables, not the private one.
648 /// This is important, for example, if the private variable is a class
649 /// variable initialized by a constructor that references other private
650 /// variables. But at initialization original variables must be used, not
651 /// private copies.
652 /// \return true if at least one variable was privatized, false otherwise.
653 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000654 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000655 SavedPrivates.clear();
656 return !SavedLocals.empty();
657 }
658
659 void ForceCleanup() {
660 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000661 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000662 SavedLocals.clear();
663 }
664
665 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000666 ~OMPPrivateScope() {
667 if (PerformCleanup)
668 ForceCleanup();
669 }
John McCall7f416cc2015-09-08 08:05:57 +0000670
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000671 /// Checks if the global variable is captured in current function.
672 bool isGlobalVarCaptured(const VarDecl *VD) const {
673 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
674 }
675
John McCall7f416cc2015-09-08 08:05:57 +0000676 private:
677 /// Copy all the entries in the source map over the corresponding
678 /// entries in the destination, which must exist.
679 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
680 for (auto &pair : src) {
681 if (!pair.second.isValid()) {
682 dest.erase(pair.first);
683 continue;
684 }
685
686 auto it = dest.find(pair.first);
687 if (it != dest.end()) {
688 it->second = pair.second;
689 } else {
690 dest.insert(pair);
691 }
692 }
693 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000694 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000695
Richard Smith736a9472013-06-12 20:42:33 +0000696 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
697 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000698 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000699
Richard Smith736a9472013-06-12 20:42:33 +0000700 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
701 /// that have been added, then adds all lifetime-extended cleanups from
702 /// the given position to the stack.
703 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
704 size_t OldLifetimeExtendedStackSize);
705
John McCallad5d61e2010-07-23 21:56:41 +0000706 void ResolveBranchFixups(llvm::BasicBlock *Target);
707
John McCallbd309292010-07-06 01:34:17 +0000708 /// The given basic block lies in the current EH scope, but may be a
709 /// target of a potentially scope-crossing jump; get a stable handle
710 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000711 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000712 return JumpDest(Target,
713 EHStack.getInnermostNormalCleanup(),
714 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000715 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000716
John McCallbd309292010-07-06 01:34:17 +0000717 /// The given basic block lies in the current EH scope, but may be a
718 /// target of a potentially scope-crossing jump; get a stable handle
719 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000720 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000721 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000722 }
723
724 /// EmitBranchThroughCleanup - Emit a branch from the current insert
725 /// block through the normal cleanup handling code (if any) and then
726 /// on to \arg Dest.
727 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000728
Justin Bognere25ffdf2014-01-21 00:35:11 +0000729 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
730 /// specified destination obviously has no cleanups to run. 'false' is always
731 /// a conservatively correct answer for this method.
732 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
733
John McCall8e4c74b2011-08-11 02:22:43 +0000734 /// popCatchScope - Pops the catch scope at the top of the EHScope
735 /// stack, emitting any required code (other than the catch handlers
736 /// themselves).
737 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000738
David Chisnall9a837be2012-11-07 16:50:40 +0000739 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000740 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000741 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000742
John McCallce1de612011-01-26 04:00:11 +0000743 /// An object to manage conditionally-evaluated expressions.
744 class ConditionalEvaluation {
745 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000746
John McCallce1de612011-01-26 04:00:11 +0000747 public:
748 ConditionalEvaluation(CodeGenFunction &CGF)
749 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000750
John McCallce1de612011-01-26 04:00:11 +0000751 void begin(CodeGenFunction &CGF) {
752 assert(CGF.OutermostConditional != this);
753 if (!CGF.OutermostConditional)
754 CGF.OutermostConditional = this;
755 }
756
757 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000758 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000759 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000760 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000761 }
762
763 /// Returns a block which will be executed prior to each
764 /// evaluation of the conditional code.
765 llvm::BasicBlock *getStartingBlock() const {
766 return StartBB;
767 }
768 };
Mike Stump11289f42009-09-09 15:08:12 +0000769
John McCall7f9c92a2010-09-17 00:50:28 +0000770 /// isInConditionalBranch - Return true if we're currently emitting
771 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000772 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000773
John McCall7f416cc2015-09-08 08:05:57 +0000774 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000775 assert(isInConditionalBranch());
776 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000777 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
778 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000779 }
780
John McCallce1de612011-01-26 04:00:11 +0000781 /// An RAII object to record that we're evaluating a statement
782 /// expression.
783 class StmtExprEvaluation {
784 CodeGenFunction &CGF;
785
786 /// We have to save the outermost conditional: cleanups in a
787 /// statement expression aren't conditional just because the
788 /// StmtExpr is.
789 ConditionalEvaluation *SavedOutermostConditional;
790
791 public:
792 StmtExprEvaluation(CodeGenFunction &CGF)
793 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000794 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000795 }
796
797 ~StmtExprEvaluation() {
798 CGF.OutermostConditional = SavedOutermostConditional;
799 CGF.EnsureInsertPoint();
800 }
801 };
John McCall1bf58462011-02-16 08:02:54 +0000802
John McCallc07a0c72011-02-17 10:25:35 +0000803 /// An object which temporarily prevents a value from being
804 /// destroyed by aggressive peephole optimizations that assume that
805 /// all uses of a value have been realized in the IR.
806 class PeepholeProtection {
807 llvm::Instruction *Inst;
808 friend class CodeGenFunction;
809
810 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000811 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000812 };
John McCallc07a0c72011-02-17 10:25:35 +0000813
John McCallfe96e0b2011-11-06 09:01:30 +0000814 /// A non-RAII class containing all the information about a bound
815 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
816 /// this which makes individual mappings very simple; using this
817 /// class directly is useful when you have a variable number of
818 /// opaque values or don't want the RAII functionality for some
819 /// reason.
820 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000821 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000822 bool BoundLValue;
823 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000824
John McCallfe96e0b2011-11-06 09:01:30 +0000825 OpaqueValueMappingData(const OpaqueValueExpr *ov,
826 bool boundLValue)
827 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000828 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000829 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000830
John McCallc07a0c72011-02-17 10:25:35 +0000831 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000832 // gl-values should be bound as l-values for obvious reasons.
833 // Records should be bound as l-values because IR generation
834 // always keeps them in memory. Expressions of function type
835 // act exactly like l-values but are formally required to be
836 // r-values in C.
837 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000838 expr->getType()->isFunctionType() ||
839 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000840 }
841
John McCallfe96e0b2011-11-06 09:01:30 +0000842 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
843 const OpaqueValueExpr *ov,
844 const Expr *e) {
845 if (shouldBindAsLValue(ov))
846 return bind(CGF, ov, CGF.EmitLValue(e));
847 return bind(CGF, ov, CGF.EmitAnyExpr(e));
848 }
849
850 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
851 const OpaqueValueExpr *ov,
852 const LValue &lv) {
853 assert(shouldBindAsLValue(ov));
854 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
855 return OpaqueValueMappingData(ov, true);
856 }
857
858 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
859 const OpaqueValueExpr *ov,
860 const RValue &rv) {
861 assert(!shouldBindAsLValue(ov));
862 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
863
864 OpaqueValueMappingData data(ov, false);
865
866 // Work around an extremely aggressive peephole optimization in
867 // EmitScalarConversion which assumes that all other uses of a
868 // value are extant.
869 data.Protection = CGF.protectFromPeepholes(rv);
870
871 return data;
872 }
873
Craig Topper8a13c412014-05-21 05:09:00 +0000874 bool isValid() const { return OpaqueValue != nullptr; }
875 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000876
877 void unbind(CodeGenFunction &CGF) {
878 assert(OpaqueValue && "no data to unbind!");
879
880 if (BoundLValue) {
881 CGF.OpaqueLValues.erase(OpaqueValue);
882 } else {
883 CGF.OpaqueRValues.erase(OpaqueValue);
884 CGF.unprotectFromPeepholes(Protection);
885 }
886 }
887 };
888
889 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
890 class OpaqueValueMapping {
891 CodeGenFunction &CGF;
892 OpaqueValueMappingData Data;
893
894 public:
895 static bool shouldBindAsLValue(const Expr *expr) {
896 return OpaqueValueMappingData::shouldBindAsLValue(expr);
897 }
898
John McCallc07a0c72011-02-17 10:25:35 +0000899 /// Build the opaque value mapping for the given conditional
900 /// operator if it's the GNU ?: extension. This is a common
901 /// enough pattern that the convenience operator is really
902 /// helpful.
903 ///
904 OpaqueValueMapping(CodeGenFunction &CGF,
905 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000906 if (isa<ConditionalOperator>(op))
907 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000908 return;
John McCallc07a0c72011-02-17 10:25:35 +0000909
910 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000911 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
912 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000913 }
914
John McCall1bf58462011-02-16 08:02:54 +0000915 OpaqueValueMapping(CodeGenFunction &CGF,
916 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000917 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000918 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000919 }
920
921 OpaqueValueMapping(CodeGenFunction &CGF,
922 const OpaqueValueExpr *opaqueValue,
923 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000924 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000925 }
926
927 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000928 Data.unbind(CGF);
929 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000930 }
931
932 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000933 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000934 }
935 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000936
Chris Lattner2da04b32007-08-24 05:35:26 +0000937private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000938 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000939 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000940
John McCall9b382dd2011-05-28 21:13:02 +0000941 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
942 /// calling llvm.stacksave for multiple VLAs in the same scope.
943 bool DidCallStackSave;
944
Mike Stumpe5311b02009-11-30 20:08:49 +0000945 /// IndirectBranch - The first time an indirect goto is seen we create a block
946 /// with an indirect branch. Every time we see the address of a label taken,
947 /// we add the label to the indirect goto. Every subsequent indirect goto is
948 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000949 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000950
Mike Stumpfc496822009-02-08 23:14:22 +0000951 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
952 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000953 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000954
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000955 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
956 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
957 /// parameter.
958 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
959 SizeArguments;
960
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000961 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000962 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000963 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
964
Chris Lattnerac248202007-05-30 00:13:02 +0000965 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000966 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000967
Mike Stumpfc496822009-02-08 23:14:22 +0000968 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000969 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000970 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000971 BreakContinue(JumpDest Break, JumpDest Continue)
972 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000973
John McCallbd309292010-07-06 01:34:17 +0000974 JumpDest BreakBlock;
975 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000976 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000977 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000978
Justin Bogneref512b92014-01-06 22:27:43 +0000979 CodeGenPGO PGO;
980
Justin Bogner65512642015-05-02 05:00:55 +0000981 /// Calculate branch weights appropriate for PGO data
982 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
983 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
984 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
985 uint64_t LoopCount);
986
Justin Bogneref512b92014-01-06 22:27:43 +0000987public:
Justin Bogner66242d62015-04-23 23:06:47 +0000988 /// Increment the profiler's counter for the given statement.
989 void incrementProfileCounter(const Stmt *S) {
Rong Xu9837ef52016-02-04 18:39:09 +0000990 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Justin Bogner66242d62015-04-23 23:06:47 +0000991 PGO.emitCounterIncrement(Builder, S);
992 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +0000993 }
Justin Bogner66242d62015-04-23 23:06:47 +0000994
995 /// Get the profiler's count for the given statement.
996 uint64_t getProfileCount(const Stmt *S) {
997 Optional<uint64_t> Count = PGO.getStmtCount(S);
998 if (!Count.hasValue())
999 return 0;
1000 return *Count;
1001 }
1002
1003 /// Set the profiler's current count.
1004 void setCurrentProfileCount(uint64_t Count) {
1005 PGO.setCurrentRegionCount(Count);
1006 }
1007
1008 /// Get the profiler's current count. This is generally the count for the most
1009 /// recently incremented counter.
1010 uint64_t getCurrentProfileCount() {
1011 return PGO.getCurrentRegionCount();
1012 }
1013
Justin Bogneref512b92014-01-06 22:27:43 +00001014private:
1015
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001016 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001017 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001018 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001019 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1020 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001021
Mike Stumpfc496822009-02-08 23:14:22 +00001022 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001023 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001024 llvm::BasicBlock *CaseRangeBlock;
1025
John McCallc07a0c72011-02-17 10:25:35 +00001026 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001027 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001028 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1029 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001030
Mike Stumpfc496822009-02-08 23:14:22 +00001031 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001032 // We track this by the size expression rather than the type itself because
1033 // in certain situations, like a const qualifier applied to an VLA typedef,
1034 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001035 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1036 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001037 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001038
John McCallbd309292010-07-06 01:34:17 +00001039 /// A block containing a single 'unreachable' instruction. Created
1040 /// lazily by getUnreachableBlock().
1041 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001042
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001043 /// Counts of the number return expressions in the function.
1044 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001045
1046 /// Count the number of simple (constant) return expressions in the function.
1047 unsigned NumSimpleReturnExprs;
1048
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001049 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001050 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001051
Richard Smith852c9db2013-04-20 22:23:05 +00001052public:
1053 /// A scope within which we are constructing the fields of an object which
1054 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1055 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1056 class FieldConstructionScope {
1057 public:
John McCall7f416cc2015-09-08 08:05:57 +00001058 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001059 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1060 CGF.CXXDefaultInitExprThis = This;
1061 }
1062 ~FieldConstructionScope() {
1063 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1064 }
1065
1066 private:
1067 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001068 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001069 };
1070
1071 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1072 /// is overridden to be the object under construction.
1073 class CXXDefaultInitExprScope {
1074 public:
1075 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001076 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1077 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1078 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1079 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001080 }
1081 ~CXXDefaultInitExprScope() {
1082 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001083 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001084 }
1085
1086 public:
1087 CodeGenFunction &CGF;
1088 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001089 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001090 };
1091
Richard Smith5179eb72016-06-28 19:03:57 +00001092 class InlinedInheritingConstructorScope {
1093 public:
1094 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1095 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1096 OldCurCodeDecl(CGF.CurCodeDecl),
1097 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1098 OldCXXABIThisValue(CGF.CXXABIThisValue),
1099 OldCXXThisValue(CGF.CXXThisValue),
1100 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1101 OldCXXThisAlignment(CGF.CXXThisAlignment),
1102 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1103 OldCXXInheritedCtorInitExprArgs(
1104 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1105 CGF.CurGD = GD;
1106 CGF.CurFuncDecl = CGF.CurCodeDecl =
1107 cast<CXXConstructorDecl>(GD.getDecl());
1108 CGF.CXXABIThisDecl = nullptr;
1109 CGF.CXXABIThisValue = nullptr;
1110 CGF.CXXThisValue = nullptr;
1111 CGF.CXXABIThisAlignment = CharUnits();
1112 CGF.CXXThisAlignment = CharUnits();
1113 CGF.ReturnValue = Address::invalid();
1114 CGF.FnRetTy = QualType();
1115 CGF.CXXInheritedCtorInitExprArgs.clear();
1116 }
1117 ~InlinedInheritingConstructorScope() {
1118 CGF.CurGD = OldCurGD;
1119 CGF.CurFuncDecl = OldCurFuncDecl;
1120 CGF.CurCodeDecl = OldCurCodeDecl;
1121 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1122 CGF.CXXABIThisValue = OldCXXABIThisValue;
1123 CGF.CXXThisValue = OldCXXThisValue;
1124 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1125 CGF.CXXThisAlignment = OldCXXThisAlignment;
1126 CGF.ReturnValue = OldReturnValue;
1127 CGF.FnRetTy = OldFnRetTy;
1128 CGF.CXXInheritedCtorInitExprArgs =
1129 std::move(OldCXXInheritedCtorInitExprArgs);
1130 }
1131
1132 private:
1133 CodeGenFunction &CGF;
1134 GlobalDecl OldCurGD;
1135 const Decl *OldCurFuncDecl;
1136 const Decl *OldCurCodeDecl;
1137 ImplicitParamDecl *OldCXXABIThisDecl;
1138 llvm::Value *OldCXXABIThisValue;
1139 llvm::Value *OldCXXThisValue;
1140 CharUnits OldCXXABIThisAlignment;
1141 CharUnits OldCXXThisAlignment;
1142 Address OldReturnValue;
1143 QualType OldFnRetTy;
1144 CallArgList OldCXXInheritedCtorInitExprArgs;
1145 };
1146
Richard Smith852c9db2013-04-20 22:23:05 +00001147private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001148 /// CXXThisDecl - When generating code for a C++ member function,
1149 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001150 ImplicitParamDecl *CXXABIThisDecl;
1151 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001152 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001153 CharUnits CXXABIThisAlignment;
1154 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001155
Richard Smith852c9db2013-04-20 22:23:05 +00001156 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1157 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001158 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001159
Richard Smith5179eb72016-06-28 19:03:57 +00001160 /// The values of function arguments to use when evaluating
1161 /// CXXInheritedCtorInitExprs within this context.
1162 CallArgList CXXInheritedCtorInitExprArgs;
1163
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001164 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1165 /// destructor, this will hold the implicit argument (e.g. VTT).
1166 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1167 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001168
John McCallce1de612011-01-26 04:00:11 +00001169 /// OutermostConditional - Points to the outermost active
1170 /// conditional control. This is used so that we know if a
1171 /// temporary should be destroyed conditionally.
1172 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001173
Nadav Rotem1da30942013-03-23 06:43:35 +00001174 /// The current lexical scope.
1175 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001176
Adrian Prantldc237b52013-05-16 00:41:26 +00001177 /// The current source location that should be used for exception
1178 /// handling code.
1179 SourceLocation CurEHLocation;
1180
John McCall7f416cc2015-09-08 08:05:57 +00001181 /// BlockByrefInfos - For each __block variable, contains
1182 /// information about the layout of the variable.
1183 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001184
John McCallbd309292010-07-06 01:34:17 +00001185 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001186 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001187 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001188
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001189 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1190 /// In the kernel metadata node, reference the kernel function and metadata
1191 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001192 /// - A node for the vec_type_hint(<type>) qualifier contains string
1193 /// "vec_type_hint", an undefined value of the <type> data type,
1194 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001195 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1196 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1197 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1198 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1199 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1200 llvm::Function *Fn);
1201
Chris Lattnerbed31442007-05-28 01:07:47 +00001202public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001203 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001204 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001205
John McCall8ed55a52010-09-02 09:58:18 +00001206 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001207 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001208 CGDebugInfo *getDebugInfo() {
1209 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001210 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001211 return DebugInfo;
1212 }
1213 void disableDebugInfo() { DisableDebugInfo = true; }
1214 void enableDebugInfo() { DisableDebugInfo = false; }
1215
John McCall31168b02011-06-15 23:02:42 +00001216 bool shouldUseFusedARCCalls() {
1217 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1218 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001219
David Blaikiebbafb8a2012-03-11 07:00:24 +00001220 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001221
Bill Wendlingf0724e82011-09-19 20:31:14 +00001222 /// Returns a pointer to the function's exception object and selector slot,
1223 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001224 Address getExceptionSlot();
1225 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001226
Bill Wendling79a70e42011-09-15 18:57:19 +00001227 /// Returns the contents of the function's exception object and selector
1228 /// slots.
1229 llvm::Value *getExceptionFromSlot();
1230 llvm::Value *getSelectorFromSlot();
1231
John McCall7f416cc2015-09-08 08:05:57 +00001232 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001233
John McCallbd309292010-07-06 01:34:17 +00001234 llvm::BasicBlock *getUnreachableBlock() {
1235 if (!UnreachableBlock) {
1236 UnreachableBlock = createBasicBlock("unreachable");
1237 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1238 }
1239 return UnreachableBlock;
1240 }
1241
1242 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001243 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001244 return getInvokeDestImpl();
1245 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001246
David Majnemer25eb1652016-03-01 19:42:53 +00001247 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001248
John McCallc8e01702013-04-16 22:48:15 +00001249 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001250 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001251
Daniel Dunbar12347492009-02-23 17:26:39 +00001252 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001253 // Cleanups
1254 //===--------------------------------------------------------------------===//
1255
John McCall7f416cc2015-09-08 08:05:57 +00001256 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001257
John McCall178360e2011-07-11 08:38:19 +00001258 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001259 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001260 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001261 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001262 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001263 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1264 llvm::Value *arrayEnd,
1265 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001266 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001267 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001268
John McCall4bd0fb12011-07-12 16:41:08 +00001269 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001270 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001271 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001272 Address addr, QualType type);
1273 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001274 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001275 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001276 QualType type, Destroyer *destroyer,
1277 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001278 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1279 llvm::Value *CompletePtr,
1280 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001281 void pushStackRestore(CleanupKind kind, Address SPMem);
1282 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001283 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001284 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001285 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001286 bool useEHCleanupForArray,
1287 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001288 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001289 QualType elementType, CharUnits elementAlign,
1290 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001291 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001292
Peter Collingbourne1425b452012-01-26 03:33:36 +00001293 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001294
John McCall82fe67b2011-07-09 01:37:26 +00001295 /// Determines whether an EH cleanup is required to destroy a type
1296 /// with the given destruction kind.
1297 bool needsEHCleanup(QualType::DestructionKind kind) {
1298 switch (kind) {
1299 case QualType::DK_none:
1300 return false;
1301 case QualType::DK_cxx_destructor:
1302 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001303 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001304 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001305 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001306 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1307 }
1308 llvm_unreachable("bad destruction kind");
1309 }
1310
John McCall4bd0fb12011-07-12 16:41:08 +00001311 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1312 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1313 }
1314
John McCall82fe67b2011-07-09 01:37:26 +00001315 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001316 // Objective-C
1317 //===--------------------------------------------------------------------===//
1318
Chris Lattner4bd55962008-03-30 23:03:07 +00001319 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001320
David Blaikief1425802015-01-14 00:04:42 +00001321 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001322
Mike Stumpfc496822009-02-08 23:14:22 +00001323 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001324 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1325 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001326 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001327 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001328 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001329 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001330
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001331 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1332 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001333
Mike Stumpfc496822009-02-08 23:14:22 +00001334 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1335 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001336 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1337 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001338 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001339 const ObjCPropertyImplDecl *propImpl,
1340 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001341
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001342 //===--------------------------------------------------------------------===//
1343 // Block Bits
1344 //===--------------------------------------------------------------------===//
1345
John McCall351762c2011-02-07 10:33:21 +00001346 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001347 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1348 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001349
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001350 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001351 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001352 const DeclMapTy &ldm,
1353 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001354
John McCallad7c5c12011-02-08 08:22:06 +00001355 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1356 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001357 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1358 const ObjCPropertyImplDecl *PID);
1359 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1360 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001361 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001362
John McCallad7c5c12011-02-08 08:22:06 +00001363 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1364
John McCall73064872011-03-31 01:59:53 +00001365 class AutoVarEmission;
1366
1367 void emitByrefStructureInit(const AutoVarEmission &emission);
1368 void enterByrefCleanup(const AutoVarEmission &emission);
1369
John McCall7f416cc2015-09-08 08:05:57 +00001370 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1371 llvm::Value *ptr);
1372
1373 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001374 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1375
1376 /// BuildBlockByrefAddress - Computes the location of the
1377 /// data in a variable which is declared as __block.
1378 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1379 bool followForward = true);
1380 Address emitBlockByrefAddress(Address baseAddr,
1381 const BlockByrefInfo &info,
1382 bool followForward,
1383 const llvm::Twine &name);
1384
1385 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001386
Richard Smith5179eb72016-06-28 19:03:57 +00001387 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1388
John McCalla738c252011-03-09 04:27:21 +00001389 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1390 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001391 /// \brief Emit code for the start of a function.
1392 /// \param Loc The location to be associated with the function.
1393 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001394 void StartFunction(GlobalDecl GD,
1395 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001396 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001397 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001398 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001399 SourceLocation Loc = SourceLocation(),
1400 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001401
John McCallb81884d2010-02-19 09:25:03 +00001402 void EmitConstructorBody(FunctionArgList &Args);
1403 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001404 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001405 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001406 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001407
Faisal Vali571df122013-09-29 08:45:24 +00001408 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001409 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001410 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001411 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001412 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1413 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001414 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001415
David Blaikiea0a1a872015-01-18 02:48:07 +00001416 /// \brief Emit the unified return block, trying to avoid its emission when
1417 /// possible.
1418 /// \return The debug location of the user written return statement if the
1419 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001420 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001421
Mike Stumpfc496822009-02-08 23:14:22 +00001422 /// FinishFunction - Complete IR generation of the current function. It is
1423 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001424 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001425
Nico Weber1bebad12015-02-11 22:33:32 +00001426 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1427 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001428
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001429 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001430
John McCall7f416cc2015-09-08 08:05:57 +00001431 void FinishThunk();
1432
Reid Klecknerab2090d2014-07-26 01:34:32 +00001433 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1434 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1435 llvm::Value *Callee);
1436
Rafael Espindolad6e66942015-07-13 06:07:58 +00001437 /// Generate a thunk for the given method.
1438 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001439 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001440
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001441 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1442 const CGFunctionInfo &FnInfo,
1443 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001444
Douglas Gregor94f9a482010-05-05 05:51:00 +00001445 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1446 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001447
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001448 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001449 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001450
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001451 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1452 struct VPtr {
1453 BaseSubobject Base;
1454 const CXXRecordDecl *NearestVBase;
1455 CharUnits OffsetFromNearestVBase;
1456 const CXXRecordDecl *VTableClass;
1457 };
1458
1459 /// Initialize the vtable pointer of the given subobject.
1460 void InitializeVTablePointer(const VPtr &vptr);
1461
1462 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001463
1464 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001465 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1466
1467 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1468 CharUnits OffsetFromNearestVBase,
1469 bool BaseIsNonVirtualPrimaryBase,
1470 const CXXRecordDecl *VTableClass,
1471 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001472
Anders Carlssond5895932010-03-28 21:07:49 +00001473 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001474
Dan Gohman8fc50c22010-10-26 18:44:08 +00001475 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1476 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001477 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1478 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001479
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001480 enum CFITypeCheckKind {
1481 CFITCK_VCall,
1482 CFITCK_NVCall,
1483 CFITCK_DerivedCast,
1484 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001485 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001486 };
1487
Peter Collingbourned2926c92015-03-14 02:42:25 +00001488 /// \brief Derived is the presumed address of an object of type T after a
1489 /// cast. If T is a polymorphic class type, emit a check that the virtual
1490 /// table for Derived belongs to a class derived from T.
1491 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001492 bool MayBeNull, CFITypeCheckKind TCK,
1493 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001494
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001495 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1496 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001497 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001498 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001499
Peter Collingbourned2926c92015-03-14 02:42:25 +00001500 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001501 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001502 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1503 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001504
Peter Collingbournefb532b92016-02-24 20:46:36 +00001505 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001506 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1507 /// enabled, emit a check that VTable is a member of RD's type identifier.
1508 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1509 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001510
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001511 /// Returns whether we should perform a type checked load when loading a
1512 /// virtual function for virtual calls to members of RD. This is generally
1513 /// true when both vcall CFI and whole-program-vtables are enabled.
1514 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1515
1516 /// Emit a type checked load from the given vtable.
1517 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1518 uint64_t VTableByteOffset);
1519
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001520 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1521 /// expr can be devirtualized.
1522 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1523 const CXXMethodDecl *MD);
1524
John McCallf99a6312010-07-21 05:30:47 +00001525 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1526 /// given phase of destruction for a destructor. The end result
1527 /// should call destructors on members and base classes in reverse
1528 /// order of their construction.
1529 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001530
Chris Lattner3c77a352010-06-22 00:03:40 +00001531 /// ShouldInstrumentFunction - Return true if the current function should be
1532 /// instrumented with __cyg_profile_func_* calls
1533 bool ShouldInstrumentFunction();
1534
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001535 /// ShouldXRayInstrument - Return true if the current function should be
1536 /// instrumented with XRay nop sleds.
1537 bool ShouldXRayInstrumentFunction() const;
1538
Chris Lattner3c77a352010-06-22 00:03:40 +00001539 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1540 /// instrumentation function with the current function and the call site, if
1541 /// function instrumentation is enabled.
1542 void EmitFunctionInstrumentation(const char *Fn);
1543
Roman Divacky178e01602011-02-10 16:52:03 +00001544 /// EmitMCountInstrumentation - Emit call to .mcount.
1545 void EmitMCountInstrumentation();
1546
Mike Stumpfc496822009-02-08 23:14:22 +00001547 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1548 /// arguments for the given function. This is also responsible for naming the
1549 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001550 void EmitFunctionProlog(const CGFunctionInfo &FI,
1551 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001552 const FunctionArgList &Args);
1553
Mike Stumpfc496822009-02-08 23:14:22 +00001554 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1555 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001556 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1557 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001558
Mike Stump1d849212009-12-07 23:38:24 +00001559 /// EmitStartEHSpec - Emit the start of the exception spec.
1560 void EmitStartEHSpec(const Decl *D);
1561
1562 /// EmitEndEHSpec - Emit the end of the exception spec.
1563 void EmitEndEHSpec(const Decl *D);
1564
John McCallbd309292010-07-06 01:34:17 +00001565 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1566 llvm::BasicBlock *getTerminateLandingPad();
1567
1568 /// getTerminateHandler - Return a handler (not a landing pad, just
1569 /// a catch handler) that just calls terminate. This is used when
1570 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001571 llvm::BasicBlock *getTerminateHandler();
1572
Chris Lattnera5f58b02011-07-09 17:41:47 +00001573 llvm::Type *ConvertTypeForMem(QualType T);
1574 llvm::Type *ConvertType(QualType T);
1575 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001576 return ConvertType(getContext().getTypeDeclType(T));
1577 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001578
Mike Stumpfc496822009-02-08 23:14:22 +00001579 /// LoadObjCSelf - Load the value of self. This function is only valid while
1580 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001581 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001582
1583 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001584 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001585
Chris Lattner54fb19e2007-06-22 22:02:34 +00001586 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1587 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001588 static TypeEvaluationKind getEvaluationKind(QualType T);
1589
1590 static bool hasScalarEvaluationKind(QualType T) {
1591 return getEvaluationKind(T) == TEK_Scalar;
1592 }
1593
1594 static bool hasAggregateEvaluationKind(QualType T) {
1595 return getEvaluationKind(T) == TEK_Aggregate;
1596 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001597
1598 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001599 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001600 llvm::Function *parent = nullptr,
1601 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001602#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001603 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001604#else
John McCallad7c5c12011-02-08 08:22:06 +00001605 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001606#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001607 }
Mike Stumpfc496822009-02-08 23:14:22 +00001608
Chris Lattnerac248202007-05-30 00:13:02 +00001609 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1610 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001611 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001612
Mike Stumpe5311b02009-11-30 20:08:49 +00001613 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1614 /// another basic block, simplify it. This assumes that no other code could
1615 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001616 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1617
Mike Stumpfc496822009-02-08 23:14:22 +00001618 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1619 /// adding a fall-through branch from the current insert block if
1620 /// necessary. It is legal to call this function even if there is no current
1621 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001622 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001623 /// IsFinished - If true, indicates that the caller has finished emitting
1624 /// branches to the given block and does not expect to emit code into it. This
1625 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001626 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001627
John McCall8e4c74b2011-08-11 02:22:43 +00001628 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1629 /// near its uses, and leave the insertion point in it.
1630 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1631
Mike Stumpfc496822009-02-08 23:14:22 +00001632 /// EmitBranch - Emit a branch to the specified basic block from the current
1633 /// insert block, taking care to avoid creation of branches from dummy
1634 /// blocks. It is legal to call this function even if there is no current
1635 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001636 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001637 /// This function clears the current insertion point. The caller should follow
1638 /// calls to this function with calls to Emit*Block prior to generation new
1639 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001640 void EmitBranch(llvm::BasicBlock *Block);
1641
Mike Stumpfc496822009-02-08 23:14:22 +00001642 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1643 /// indicates that the current code being emitted is unreachable.
1644 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001645 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001646 }
1647
Mike Stumpfc496822009-02-08 23:14:22 +00001648 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1649 /// emitted IR has a place to go. Note that by definition, if this function
1650 /// creates a block then that block is unreachable; callers may do better to
1651 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001652 void EnsureInsertPoint() {
1653 if (!HaveInsertPoint())
1654 EmitBlock(createBasicBlock());
1655 }
Mike Stumpfc496822009-02-08 23:14:22 +00001656
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001657 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001658 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001659 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001660
Chris Lattnere9a64532007-06-22 21:44:33 +00001661 //===--------------------------------------------------------------------===//
1662 // Helpers
1663 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001664
John McCall7f416cc2015-09-08 08:05:57 +00001665 LValue MakeAddrLValue(Address Addr, QualType T,
1666 AlignmentSource AlignSource = AlignmentSource::Type) {
1667 return LValue::MakeAddr(Addr, T, getContext(), AlignSource,
Dan Gohman947c9af2010-10-14 23:06:10 +00001668 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001669 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001670
John McCall7f416cc2015-09-08 08:05:57 +00001671 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1672 AlignmentSource AlignSource = AlignmentSource::Type) {
1673 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1674 AlignSource, CGM.getTBAAInfo(T));
1675 }
1676
1677 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001678 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001679 CharUnits getNaturalTypeAlignment(QualType T,
1680 AlignmentSource *Source = nullptr,
1681 bool forPointeeType = false);
1682 CharUnits getNaturalPointeeTypeAlignment(QualType T,
1683 AlignmentSource *Source = nullptr);
1684
1685 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
1686 AlignmentSource *Source = nullptr);
1687 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001688
Alexey Bataev31300ed2016-02-04 11:27:03 +00001689 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
1690 AlignmentSource *Source = nullptr);
1691 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1692
Chris Lattnere9a64532007-06-22 21:44:33 +00001693 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001694 /// block. The caller is responsible for setting an appropriate alignment on
1695 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001696 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001697 const Twine &Name = "tmp");
John McCall7f416cc2015-09-08 08:05:57 +00001698 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
1699 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001700
John McCall7f416cc2015-09-08 08:05:57 +00001701 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1702 /// default ABI alignment of the given LLVM type.
1703 ///
1704 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1705 /// any given AST type that happens to have been lowered to the
1706 /// given IR type. This should only ever be used for function-local,
1707 /// IR-driven manipulations like saving and restoring a value. Do
1708 /// not hand this address off to arbitrary IRGen routines, and especially
1709 /// do not pass it as an argument to a function that might expect a
1710 /// properly ABI-aligned value.
1711 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1712 const Twine &Name = "tmp");
1713
1714 /// InitTempAlloca - Provide an initial value for the given alloca which
1715 /// will be observable at all locations in the function.
1716 ///
1717 /// The address should be something that was returned from one of
1718 /// the CreateTempAlloca or CreateMemTemp routines, and the
1719 /// initializer must be valid in the entry block (i.e. it must
1720 /// either be a constant or an argument value).
1721 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001722
Daniel Dunbard0049182010-02-16 19:44:13 +00001723 /// CreateIRTemp - Create a temporary IR object of the given type, with
1724 /// appropriate alignment. This routine should only be used when an temporary
1725 /// value needs to be stored into an alloca (for example, to avoid explicit
1726 /// PHI construction), but the type is the IR type, not the type appropriate
1727 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001728 ///
1729 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1730 /// ConvertType instead of ConvertTypeForMem.
1731 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001732
Daniel Dunbara7566f12010-02-09 02:48:28 +00001733 /// CreateMemTemp - Create a temporary memory object of the given type, with
1734 /// appropriate alignment.
John McCall7f416cc2015-09-08 08:05:57 +00001735 Address CreateMemTemp(QualType T, const Twine &Name = "tmp");
1736 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001737
John McCall7a626f62010-09-15 10:14:12 +00001738 /// CreateAggTemp - Create a temporary memory object for the given
1739 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001740 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00001741 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001742 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001743 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001744 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001745 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001746 }
1747
John McCallad7c5c12011-02-08 08:22:06 +00001748 /// Emit a cast to void* in the appropriate address space.
1749 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1750
Chris Lattner8394d792007-06-05 20:53:16 +00001751 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1752 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001753 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001754
John McCalla2342eb2010-12-05 02:00:02 +00001755 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1756 void EmitIgnoredExpr(const Expr *E);
1757
Chris Lattner4647a212007-08-31 22:49:20 +00001758 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1759 /// any type. The result is returned as an RValue struct. If this is an
1760 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1761 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001762 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001763 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001764 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001765 AggValueSlot aggSlot = AggValueSlot::ignored(),
1766 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001767
Mike Stumpfc496822009-02-08 23:14:22 +00001768 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1769 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00001770 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001771
Charles Davisc7d5c942015-09-17 20:55:33 +00001772 /// Emit a "reference" to a __builtin_ms_va_list; this is
1773 /// always the value of the expression, because a __builtin_ms_va_list is a
1774 /// pointer to a char.
1775 Address EmitMSVAListRef(const Expr *E);
1776
Mike Stumpfc496822009-02-08 23:14:22 +00001777 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1778 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001779 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001780
John McCall91ca10f2011-03-08 09:11:50 +00001781 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001782 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00001783 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001784 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001785
John McCall7f416cc2015-09-08 08:05:57 +00001786 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00001787
John McCall91ca10f2011-03-08 09:11:50 +00001788 /// EmitExprAsInit - Emits the code necessary to initialize a
1789 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001790 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001791 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001792
Fariborz Jahanian78652202013-01-25 23:57:05 +00001793 /// hasVolatileMember - returns true if aggregate type has a volatile
1794 /// member.
1795 bool hasVolatileMember(QualType T) {
1796 if (const RecordType *RT = T->getAs<RecordType>()) {
1797 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1798 return RD->hasVolatileMember();
1799 }
1800 return false;
1801 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001802 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001803 ///
1804 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1805 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00001806 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001807 QualType EltTy) {
1808 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00001809 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001810 }
1811
John McCall7f416cc2015-09-08 08:05:57 +00001812 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
1813 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00001814 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00001815 /*IsAssignment=*/false);
1816 }
1817
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001818 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001819 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001820 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001821 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001822 /// \param isAssignment - If false, allow padding to be copied. This often
1823 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00001824 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001825 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001826 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001827
Anders Carlsson9396a892008-09-11 09:15:33 +00001828 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00001829 Address GetAddrOfLocalVar(const VarDecl *VD) {
1830 auto it = LocalDeclMap.find(VD);
1831 assert(it != LocalDeclMap.end() &&
1832 "Invalid argument to GetAddrOfLocalVar(), no decl!");
1833 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00001834 }
Mike Stumpfc496822009-02-08 23:14:22 +00001835
John McCallc07a0c72011-02-17 10:25:35 +00001836 /// getOpaqueLValueMapping - Given an opaque value expression (which
1837 /// must be mapped to an l-value), return its mapping.
1838 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1839 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1840
1841 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1842 it = OpaqueLValues.find(e);
1843 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1844 return it->second;
1845 }
1846
1847 /// getOpaqueRValueMapping - Given an opaque value expression (which
1848 /// must be mapped to an r-value), return its mapping.
1849 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1850 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1851
1852 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1853 it = OpaqueRValues.find(e);
1854 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001855 return it->second;
1856 }
1857
Dan Gohman75d69da2008-05-22 00:50:06 +00001858 /// getAccessedFieldNo - Given an encoded value and a result number, return
1859 /// the input field number being accessed.
1860 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1861
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001862 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001863 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001864
Anders Carlssonc0964b62010-05-22 17:35:42 +00001865 /// EmitNullInitialization - Generate code to set a value of the given type to
1866 /// null, If the type contains data member pointers, they will be initialized
1867 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00001868 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001869
Charles Davisc7d5c942015-09-17 20:55:33 +00001870 /// Emits a call to an LLVM variable-argument intrinsic, either
1871 /// \c llvm.va_start or \c llvm.va_end.
1872 /// \param ArgValue A reference to the \c va_list as emitted by either
1873 /// \c EmitVAListRef or \c EmitMSVAListRef.
1874 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
1875 /// calls \c llvm.va_end.
1876 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
1877
1878 /// Generate code to get an argument from the passed in pointer
1879 /// and update it accordingly.
1880 /// \param VE The \c VAArgExpr for which to generate code.
1881 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
1882 /// either \c EmitVAListRef or \c EmitMSVAListRef.
1883 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001884 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001885 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00001886 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001887
John McCall82fe67b2011-07-09 01:37:26 +00001888 /// emitArrayLength - Compute the length of an array, even if it's a
1889 /// VLA, and drill down to the base element type.
1890 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1891 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001892 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00001893
John McCall23c29fe2011-06-24 21:55:10 +00001894 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1895 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001896 ///
1897 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001898 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001899
John McCall23c29fe2011-06-24 21:55:10 +00001900 /// getVLASize - Returns an LLVM value that corresponds to the size,
1901 /// in non-variably-sized elements, of a variable length array type,
1902 /// plus that largest non-variably-sized element type. Assumes that
1903 /// the type has already been emitted with EmitVariablyModifiedType.
1904 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1905 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001906
Anders Carlssona5d077d2009-04-14 16:58:56 +00001907 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1908 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001909 llvm::Value *LoadCXXThis() {
1910 assert(CXXThisValue && "no 'this' value for this function");
1911 return CXXThisValue;
1912 }
John McCall7f416cc2015-09-08 08:05:57 +00001913 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00001914
Anders Carlssone36a6b32010-01-02 01:01:18 +00001915 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1916 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001917 // FIXME: Every place that calls LoadCXXVTT is something
1918 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001919 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001920 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1921 return CXXStructorImplicitParamValue;
1922 }
1923
John McCall6ce74722010-02-16 04:15:37 +00001924 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001925 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00001926 Address
1927 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001928 const CXXRecordDecl *Derived,
1929 const CXXRecordDecl *Base,
1930 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001931
John McCall7f416cc2015-09-08 08:05:57 +00001932 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
1933
Mike Stumpe5311b02009-11-30 20:08:49 +00001934 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1935 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00001936 Address GetAddressOfBaseClass(Address Value,
1937 const CXXRecordDecl *Derived,
1938 CastExpr::path_const_iterator PathBegin,
1939 CastExpr::path_const_iterator PathEnd,
1940 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001941
John McCall7f416cc2015-09-08 08:05:57 +00001942 Address GetAddressOfDerivedClass(Address Value,
1943 const CXXRecordDecl *Derived,
1944 CastExpr::path_const_iterator PathBegin,
1945 CastExpr::path_const_iterator PathEnd,
1946 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00001947
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001948 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1949 /// base constructor/destructor with virtual bases.
1950 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1951 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1952 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1953 bool Delegating);
1954
John McCallf8ff7b92010-02-23 00:48:20 +00001955 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1956 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001957 const FunctionArgList &Args,
1958 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001959 // It's important not to confuse this and the previous function. Delegating
1960 // constructors are the C++0x feature. The constructor delegate optimization
1961 // is used to reduce duplication in the base and complete consturctors where
1962 // they are substantially the same.
1963 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1964 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001965
Richard Smith5179eb72016-06-28 19:03:57 +00001966 /// Emit a call to an inheriting constructor (that is, one that invokes a
1967 /// constructor inherited from a base class) by inlining its definition. This
1968 /// is necessary if the ABI does not support forwarding the arguments to the
1969 /// base class constructor (because they're variadic or similar).
1970 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1971 CXXCtorType CtorType,
1972 bool ForVirtualBase,
1973 bool Delegating,
1974 CallArgList &Args);
1975
1976 /// Emit a call to a constructor inherited from a base class, passing the
1977 /// current constructor's arguments along unmodified (without even making
1978 /// a copy).
1979 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
1980 bool ForVirtualBase, Address This,
1981 bool InheritedFromVBase,
1982 const CXXInheritedCtorInitExpr *E);
1983
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001984 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001985 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00001986 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001987
Richard Smith5179eb72016-06-28 19:03:57 +00001988 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
1989 bool ForVirtualBase, bool Delegating,
1990 Address This, CallArgList &Args);
1991
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001992 /// Emit assumption load for all bases. Requires to be be called only on
1993 /// most-derived class and not under construction of the object.
1994 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
1995
1996 /// Emit assumption that vptr load == global vtable.
1997 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
1998
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001999 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002000 Address This, Address Src,
2001 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002002
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002003 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002004 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002005 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002006 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002007 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002008
Anders Carlssond49844b2009-09-23 02:45:36 +00002009 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2010 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002011 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002012 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002013 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002014
John McCall82fe67b2011-07-09 01:37:26 +00002015 static Destroyer destroyCXXObject;
2016
Anders Carlsson0a637412009-05-29 21:03:38 +00002017 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002018 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002019 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002020
John McCall99210dc2011-09-15 06:49:18 +00002021 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002022 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002023 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002024 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002025
Peter Collingbourne702b2842011-11-27 22:09:22 +00002026 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002027 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002028
David Majnemerdc012fa2015-04-22 21:38:15 +00002029 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2030 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2031
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002032 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002033 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002034
Eli Friedman24f55432009-11-18 00:57:03 +00002035 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002036 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2037 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002038
Richard Smith760520b2014-06-03 23:27:44 +00002039 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2040 const Expr *Arg, bool IsDelete);
2041
John McCall7f416cc2015-09-08 08:05:57 +00002042 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2043 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2044 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002045
Richard Smith69d0d262012-08-24 00:54:33 +00002046 /// \brief Situations in which we might emit a check for the suitability of a
2047 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002048 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002049 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002050 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002051 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002052 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002053 /// Checking the bound value in a reference binding. Must be suitably sized
2054 /// and aligned, but is not required to refer to an object (until the
2055 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002056 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002057 /// Checking the object expression in a non-static data member access. Must
2058 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002059 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002060 /// Checking the 'this' pointer for a call to a non-static member function.
2061 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002062 TCK_MemberCall,
2063 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002064 TCK_ConstructorCall,
2065 /// Checking the operand of a static_cast to a derived pointer type. Must be
2066 /// null or an object within its lifetime.
2067 TCK_DowncastPointer,
2068 /// Checking the operand of a static_cast to a derived reference type. Must
2069 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002070 TCK_DowncastReference,
2071 /// Checking the operand of a cast to a base object. Must be suitably sized
2072 /// and aligned.
2073 TCK_Upcast,
2074 /// Checking the operand of a cast to a virtual base object. Must be an
2075 /// object within its lifetime.
2076 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00002077 };
2078
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002079 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2080 /// calls to EmitTypeCheck can be skipped.
2081 bool sanitizePerformTypeCheck() const;
2082
Richard Smith4d1458e2012-09-08 02:08:36 +00002083 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002084 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002085 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002086 QualType Type, CharUnits Alignment = CharUnits::Zero(),
2087 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002088
Richard Smith539e4a72013-02-23 02:53:19 +00002089 /// \brief Emit a check that \p Base points into an array object, which
2090 /// we can access at index \p Index. \p Accessed should be \c false if we
2091 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2092 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2093 QualType IndexType, bool Accessed);
2094
Chris Lattner116ce8f2010-01-09 21:40:03 +00002095 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2096 bool isInc, bool isPre);
2097 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2098 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002099
2100 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002101 llvm::Value *OffsetValue = nullptr) {
2102 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2103 OffsetValue);
2104 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002105
Chris Lattner8394d792007-06-05 20:53:16 +00002106 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002107 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002108 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002109
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002110 /// EmitDecl - Emit a declaration.
2111 ///
2112 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002113 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002114
John McCall1c9c3fd2010-10-15 04:57:14 +00002115 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002116 ///
2117 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002118 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002119
David Blaikie73ca5692014-12-09 00:32:22 +00002120 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002121 bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00002122 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00002123
John McCallbd309292010-07-06 01:34:17 +00002124 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2125 llvm::Value *Address);
2126
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002127 /// \brief Determine whether the given initializer is trivial in the sense
2128 /// that it requires no code to be generated.
2129 bool isTrivialInitializer(const Expr *Init);
2130
John McCall1c9c3fd2010-10-15 04:57:14 +00002131 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002132 ///
2133 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002134 void EmitAutoVarDecl(const VarDecl &D);
2135
2136 class AutoVarEmission {
2137 friend class CodeGenFunction;
2138
John McCall9e2e22f2011-02-22 07:16:58 +00002139 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002140
John McCall7f416cc2015-09-08 08:05:57 +00002141 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002142 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002143 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002144
2145 llvm::Value *NRVOFlag;
2146
2147 /// True if the variable is a __block variable.
2148 bool IsByRef;
2149
2150 /// True if the variable is of aggregate type and has a constant
2151 /// initializer.
2152 bool IsConstantAggregate;
2153
Nadav Rotem1da30942013-03-23 06:43:35 +00002154 /// Non-null if we should use lifetime annotations.
2155 llvm::Value *SizeForLifetimeMarkers;
2156
John McCall9e2e22f2011-02-22 07:16:58 +00002157 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002158 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002159
John McCallc533cb72011-02-22 06:44:22 +00002160 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002161 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002162 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002163 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002164
John McCall7f416cc2015-09-08 08:05:57 +00002165 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002166
2167 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002168 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2169
Craig Topper8a13c412014-05-21 05:09:00 +00002170 bool useLifetimeMarkers() const {
2171 return SizeForLifetimeMarkers != nullptr;
2172 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002173 llvm::Value *getSizeForLifetimeMarkers() const {
2174 assert(useLifetimeMarkers());
2175 return SizeForLifetimeMarkers;
2176 }
2177
2178 /// Returns the raw, allocated address, which is not necessarily
2179 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002180 Address getAllocatedAddress() const {
2181 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002182 }
2183
John McCallc533cb72011-02-22 06:44:22 +00002184 /// Returns the address of the object within this declaration.
2185 /// Note that this does not chase the forwarding pointer for
2186 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002187 Address getObjectAddress(CodeGenFunction &CGF) const {
2188 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002189
John McCall7f416cc2015-09-08 08:05:57 +00002190 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002191 }
2192 };
2193 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2194 void EmitAutoVarInit(const AutoVarEmission &emission);
2195 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002196 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2197 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002198
John McCall1c9c3fd2010-10-15 04:57:14 +00002199 void EmitStaticVarDecl(const VarDecl &D,
2200 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002201
John McCall7f416cc2015-09-08 08:05:57 +00002202 class ParamValue {
2203 llvm::Value *Value;
2204 unsigned Alignment;
2205 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2206 public:
2207 static ParamValue forDirect(llvm::Value *value) {
2208 return ParamValue(value, 0);
2209 }
2210 static ParamValue forIndirect(Address addr) {
2211 assert(!addr.getAlignment().isZero());
2212 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2213 }
2214
2215 bool isIndirect() const { return Alignment != 0; }
2216 llvm::Value *getAnyValue() const { return Value; }
2217
2218 llvm::Value *getDirectValue() const {
2219 assert(!isIndirect());
2220 return Value;
2221 }
2222
2223 Address getIndirectAddress() const {
2224 assert(isIndirect());
2225 return Address(Value, CharUnits::fromQuantity(Alignment));
2226 }
2227 };
2228
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002229 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002230 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002231
John McCallc07a0c72011-02-17 10:25:35 +00002232 /// protectFromPeepholes - Protect a value that we're intending to
2233 /// store to the side, but which will probably be used later, from
2234 /// aggressive peepholing optimizations that might delete it.
2235 ///
2236 /// Pass the result to unprotectFromPeepholes to declare that
2237 /// protection is no longer required.
2238 ///
2239 /// There's no particular reason why this shouldn't apply to
2240 /// l-values, it's just that no existing peepholes work on pointers.
2241 PeepholeProtection protectFromPeepholes(RValue rvalue);
2242 void unprotectFromPeepholes(PeepholeProtection protection);
2243
Chris Lattner84915fa2007-06-02 04:16:21 +00002244 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002245 // Statement Emission
2246 //===--------------------------------------------------------------------===//
2247
Mike Stumpfc496822009-02-08 23:14:22 +00002248 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002249 void EmitStopPoint(const Stmt *S);
2250
Mike Stumpfc496822009-02-08 23:14:22 +00002251 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2252 /// this function even if there is no current insertion point.
2253 ///
2254 /// This function may clear the current insertion point; callers should use
2255 /// EnsureInsertPoint if they wish to subsequently generate code without first
2256 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002257 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002258
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002259 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002260 /// necessarily require an insertion point or debug information; typically
2261 /// because the statement amounts to a jump or a container of other
2262 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002263 ///
2264 /// \return True if the statement was handled.
2265 bool EmitSimpleStmt(const Stmt *S);
2266
John McCall7f416cc2015-09-08 08:05:57 +00002267 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2268 AggValueSlot AVS = AggValueSlot::ignored());
2269 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2270 bool GetLast = false,
2271 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002272 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002273
Mike Stumpfc496822009-02-08 23:14:22 +00002274 /// EmitLabel - Emit the block for the given label. It is legal to call this
2275 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002276 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002277
Chris Lattnerac248202007-05-30 00:13:02 +00002278 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002279 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002280 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002281 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002282 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002283
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002284 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002285 ArrayRef<const Attr *> Attrs = None);
2286 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002287 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002288 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002289 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002290 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002291 void EmitBreakStmt(const BreakStmt &S);
2292 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002293 void EmitSwitchStmt(const SwitchStmt &S);
2294 void EmitDefaultStmt(const DefaultStmt &S);
2295 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002296 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002297 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002298
Anders Carlsson2e744e82008-08-30 19:51:14 +00002299 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002300 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2301 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002302 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002303 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002304
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002305 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2306
John McCallb609d3f2010-07-07 06:56:46 +00002307 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2308 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002309
Anders Carlsson52d78a52009-09-27 18:58:34 +00002310 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002311 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002312 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002313 void EnterSEHTryStmt(const SEHTryStmt &S);
2314 void ExitSEHTryStmt(const SEHTryStmt &S);
2315
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002316 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002317 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002318
2319 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2320 const SEHExceptStmt &Except);
2321
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002322 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2323 const SEHFinallyStmt &Finally);
2324
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002325 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2326 llvm::Value *ParentFP,
2327 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002328 llvm::Value *EmitSEHExceptionCode();
2329 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002330 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002331
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002332 /// Scan the outlined statement for captures from the parent function. For
2333 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002334 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002335 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002336 bool IsFilter);
2337
2338 /// Recovers the address of a local in a parent function. ParentVar is the
2339 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002340 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002341 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2342 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002343 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2344 Address ParentVar,
2345 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002346
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002347 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002348 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002349
Alexey Bataev1189bd02016-01-26 12:20:39 +00002350 /// Returns calculated size of the specified type.
2351 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002352 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002353 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002354 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002355 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002356 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002357 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002358 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002359 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2360 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002361 /// \brief Perform element by element copying of arrays with type \a
2362 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2363 /// generated by \a CopyGen.
2364 ///
2365 /// \param DestAddr Address of the destination array.
2366 /// \param SrcAddr Address of the source array.
2367 /// \param OriginalType Type of destination and source arrays.
2368 /// \param CopyGen Copying procedure that copies value of single array element
2369 /// to another single array element.
2370 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002371 Address DestAddr, Address SrcAddr, QualType OriginalType,
2372 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002373 /// \brief Emit proper copying of data from one variable to another.
2374 ///
2375 /// \param OriginalType Original type of the copied variables.
2376 /// \param DestAddr Destination address.
2377 /// \param SrcAddr Source address.
2378 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2379 /// type of the base array element).
2380 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2381 /// the base array element).
2382 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2383 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002384 void EmitOMPCopy(QualType OriginalType,
2385 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002386 const VarDecl *DestVD, const VarDecl *SrcVD,
2387 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002388 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2389 /// \a X = \a E \a BO \a E.
2390 ///
2391 /// \param X Value to be updated.
2392 /// \param E Update value.
2393 /// \param BO Binary operation for update operation.
2394 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2395 /// expression, false otherwise.
2396 /// \param AO Atomic ordering of the generated atomic instructions.
2397 /// \param CommonGen Code generator for complex expressions that cannot be
2398 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002399 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2400 /// generated, <false, RValue::get(nullptr)> otherwise.
2401 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002402 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2403 llvm::AtomicOrdering AO, SourceLocation Loc,
2404 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002405 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002406 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002407 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2408 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002409 void EmitOMPUseDevicePtrClause(
2410 const OMPClause &C, OMPPrivateScope &PrivateScope,
2411 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002412 /// \brief Emit code for copyin clause in \a D directive. The next code is
2413 /// generated at the start of outlined functions for directives:
2414 /// \code
2415 /// threadprivate_var1 = master_threadprivate_var1;
2416 /// operator=(threadprivate_var2, master_threadprivate_var2);
2417 /// ...
2418 /// __kmpc_barrier(&loc, global_tid);
2419 /// \endcode
2420 ///
2421 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2422 /// \returns true if at least one copyin variable is found, false otherwise.
2423 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002424 /// \brief Emit initial code for lastprivate variables. If some variable is
2425 /// not also firstprivate, then the default initialization is used. Otherwise
2426 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2427 /// method.
2428 ///
2429 /// \param D Directive that may have 'lastprivate' directives.
2430 /// \param PrivateScope Private scope for capturing lastprivate variables for
2431 /// proper codegen in internal captured statement.
2432 ///
2433 /// \returns true if there is at least one lastprivate variable, false
2434 /// otherwise.
2435 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2436 OMPPrivateScope &PrivateScope);
2437 /// \brief Emit final copying of lastprivate values to original variables at
2438 /// the end of the worksharing or simd directive.
2439 ///
2440 /// \param D Directive that has at least one 'lastprivate' directives.
2441 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2442 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002443 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002444 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002445 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002446 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002447 /// Emit initial code for linear clauses.
2448 void EmitOMPLinearClause(const OMPLoopDirective &D,
2449 CodeGenFunction::OMPPrivateScope &PrivateScope);
2450 /// Emit final code for linear clauses.
2451 /// \param CondGen Optional conditional code for final part of codegen for
2452 /// linear clause.
2453 void EmitOMPLinearClauseFinal(
2454 const OMPLoopDirective &D,
2455 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002456 /// \brief Emit initial code for reduction variables. Creates reduction copies
2457 /// and initializes them with the values according to OpenMP standard.
2458 ///
2459 /// \param D Directive (possibly) with the 'reduction' clause.
2460 /// \param PrivateScope Private scope for capturing reduction variables for
2461 /// proper codegen in internal captured statement.
2462 ///
2463 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2464 OMPPrivateScope &PrivateScope);
2465 /// \brief Emit final update of reduction values to original variables at
2466 /// the end of the directive.
2467 ///
2468 /// \param D Directive that has at least one 'reduction' directives.
2469 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002470 /// \brief Emit initial code for linear variables. Creates private copies
2471 /// and initializes them with the values according to OpenMP standard.
2472 ///
2473 /// \param D Directive (possibly) with the 'linear' clause.
2474 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002475
Alexey Bataev7292c292016-04-25 12:22:29 +00002476 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2477 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002478 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002479 TaskGenTy;
2480 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2481 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002482 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00002483
Alexey Bataev9959db52014-05-06 10:08:46 +00002484 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002485 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002486 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002487 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002488 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002489 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002490 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002491 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002492 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002493 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002494 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002495 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002496 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002497 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002498 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002499 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002500 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002501 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002502 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002503 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002504 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002505 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002506 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002507 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002508 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002509 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002510 void
2511 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002512 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002513 void
2514 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002515 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002516 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002517 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002518 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002519 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002520 void EmitOMPDistributeLoop(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002521 void EmitOMPDistributeParallelForDirective(
2522 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002523 void EmitOMPDistributeParallelForSimdDirective(
2524 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002525 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002526 void EmitOMPTargetParallelForSimdDirective(
2527 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002528 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002529 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002530
Alexey Bataev14fa1c62016-03-29 05:34:15 +00002531 /// Emit outlined function for the target directive.
2532 static std::pair<llvm::Function * /*OutlinedFn*/,
2533 llvm::Constant * /*OutlinedFnID*/>
2534 EmitOMPTargetDirectiveOutlinedFunction(CodeGenModule &CGM,
2535 const OMPTargetDirective &S,
2536 StringRef ParentName,
2537 bool IsOffloadEntry);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002538 /// \brief Emit inner loop of the worksharing/simd construct.
2539 ///
2540 /// \param S Directive, for which the inner loop must be emitted.
2541 /// \param RequiresCleanup true, if directive has some associated private
2542 /// variables.
2543 /// \param LoopCond Bollean condition for loop continuation.
2544 /// \param IncExpr Increment expression for loop control variable.
2545 /// \param BodyGen Generator for the inner body of the inner loop.
2546 /// \param PostIncGen Genrator for post-increment code (required for ordered
2547 /// loop directvies).
2548 void EmitOMPInnerLoop(
2549 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2550 const Expr *IncExpr,
2551 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2552 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002553
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002554 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002555 /// Emit initial code for loop counters of loop-based directives.
2556 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2557 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002558
Alexander Musmanc6388682014-12-15 07:07:06 +00002559private:
Alexander Musmanc6388682014-12-15 07:07:06 +00002560 /// Helpers for the OpenMP loop directives.
Alexey Bataev0f34da12015-07-02 04:17:07 +00002561 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002562 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002563 void EmitOMPSimdFinal(
2564 const OMPLoopDirective &D,
2565 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev38e89532015-04-16 04:54:05 +00002566 /// \brief Emit code for the worksharing loop-based directive.
2567 /// \return true, if this construct has any lastprivate clause, false -
2568 /// otherwise.
2569 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002570 void EmitOMPOuterLoop(bool IsMonotonic, bool DynamicOrOrdered,
2571 const OMPLoopDirective &S, OMPPrivateScope &LoopScope, bool Ordered,
2572 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00002573 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002574 bool IsMonotonic, const OMPLoopDirective &S,
2575 OMPPrivateScope &LoopScope, bool Ordered, Address LB,
2576 Address UB, Address ST, Address IL,
2577 llvm::Value *Chunk);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002578 void EmitOMPDistributeOuterLoop(
2579 OpenMPDistScheduleClauseKind ScheduleKind,
2580 const OMPDistributeDirective &S, OMPPrivateScope &LoopScope,
2581 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002582 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002583 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002584
2585public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002586
Chris Lattner208ae962007-05-30 17:57:17 +00002587 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002588 // LValue Expression Emission
2589 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002590
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002591 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2592 RValue GetUndefRValue(QualType Ty);
2593
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002594 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2595 /// and issue an ErrorUnsupported style diagnostic (using the
2596 /// provided Name).
2597 RValue EmitUnsupportedRValue(const Expr *E,
2598 const char *Name);
2599
Mike Stumpfc496822009-02-08 23:14:22 +00002600 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2601 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002602 LValue EmitUnsupportedLValue(const Expr *E,
2603 const char *Name);
2604
Chris Lattner8394d792007-06-05 20:53:16 +00002605 /// EmitLValue - Emit code to compute a designator that specifies the location
2606 /// of the expression.
2607 ///
2608 /// This can return one of two things: a simple address or a bitfield
2609 /// reference. In either case, the LLVM Value* in the LValue structure is
2610 /// guaranteed to be an LLVM pointer type.
2611 ///
2612 /// If this returns a bitfield reference, nothing about the pointee type of
2613 /// the LLVM value is known: For example, it may not be a pointer to an
2614 /// integer.
2615 ///
2616 /// If this returns a normal address, and if the lvalue's C type is fixed
2617 /// size, this method guarantees that the returned pointer type will point to
2618 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2619 /// variable length type, this is not possible.
2620 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002621 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002622
Richard Smith4d1458e2012-09-08 02:08:36 +00002623 /// \brief Same as EmitLValue but additionally we generate checking code to
2624 /// guard against undefined behavior. This is only suitable when we know
2625 /// that the address will be used to access the object.
2626 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002627
John McCall7f416cc2015-09-08 08:05:57 +00002628 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002629 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002630
John McCalla8ec7eb2013-03-07 21:37:17 +00002631 void EmitAtomicInit(Expr *E, LValue lvalue);
2632
David Majnemera5b195a2015-02-14 01:35:12 +00002633 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00002634
2635 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2636 AggValueSlot Slot = AggValueSlot::ignored());
2637
Nick Lewycky2d84e842013-10-02 02:29:49 +00002638 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002639 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002640 AggValueSlot slot = AggValueSlot::ignored());
2641
2642 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2643
David Majnemera5b195a2015-02-14 01:35:12 +00002644 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2645 bool IsVolatile, bool isInit);
2646
Alexey Bataevb4505a72015-03-30 05:20:59 +00002647 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002648 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00002649 llvm::AtomicOrdering Success =
2650 llvm::AtomicOrdering::SequentiallyConsistent,
2651 llvm::AtomicOrdering Failure =
2652 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00002653 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2654
Alexey Bataevb4505a72015-03-30 05:20:59 +00002655 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002656 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002657 bool IsVolatile);
2658
John McCall3a7f6922010-10-27 20:58:56 +00002659 /// EmitToMemory - Change a scalar value from its value
2660 /// representation to its in-memory representation.
2661 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2662
2663 /// EmitFromMemory - Change a scalar value from its memory
2664 /// representation to its value representation.
2665 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2666
Daniel Dunbar1d425462009-02-10 00:57:50 +00002667 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2668 /// care to appropriately convert from the memory representation to
2669 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002670 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002671 SourceLocation Loc,
John McCall7f416cc2015-09-08 08:05:57 +00002672 AlignmentSource AlignSource =
2673 AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002674 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002675 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002676 uint64_t TBAAOffset = 0,
2677 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002678
2679 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2680 /// care to appropriately convert from the memory representation to
2681 /// the LLVM value representation. The l-value must be a simple
2682 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002683 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002684
2685 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2686 /// care to appropriately convert from the memory representation to
2687 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002688 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
2689 bool Volatile, QualType Ty,
2690 AlignmentSource AlignSource = AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002691 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002692 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002693 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002694
2695 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2696 /// care to appropriately convert from the memory representation to
2697 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002698 /// l-value. The isInit flag indicates whether this is an initialization.
2699 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2700 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002701
Chris Lattner8394d792007-06-05 20:53:16 +00002702 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2703 /// this method emits the address of the lvalue, then loads the result as an
2704 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002705 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002706 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2707 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002708 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002709
Chris Lattner8394d792007-06-05 20:53:16 +00002710 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2711 /// lvalue, where both are guaranteed to the have the same type, and that type
2712 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002713 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002714 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002715 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002716
Nick Lewycky2d84e842013-10-02 02:29:49 +00002717 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2718 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002719 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002720 /// \param Result [out] - If non-null, this will be set to a Value* for the
2721 /// bit-field contents after the store, appropriate for use as the result of
2722 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002723 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002724 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002725
John McCall4f29b492010-11-16 23:07:28 +00002726 /// Emit an l-value for an assignment (simple or compound) of complex type.
2727 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002728 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002729 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2730 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002731
Chris Lattner57540c52011-04-15 05:22:18 +00002732 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002733 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002734 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002735 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002736 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002737 // Note: only available for agg return types
2738 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002739 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002740 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002741 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002742 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002743 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002744 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2745 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00002746 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
2747 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002748 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002749 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002750 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002751 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002752 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002753 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002754 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002755 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002756 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002757
John McCall7f416cc2015-09-08 08:05:57 +00002758 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002759
Nick Lewycky2d84e842013-10-02 02:29:49 +00002760 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002761
John McCall7f416cc2015-09-08 08:05:57 +00002762 Address EmitArrayToPointerDecay(const Expr *Array,
2763 AlignmentSource *AlignSource = nullptr);
2764
John McCall71335052012-03-10 03:05:10 +00002765 class ConstantEmission {
2766 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2767 ConstantEmission(llvm::Constant *C, bool isReference)
2768 : ValueAndIsReference(C, isReference) {}
2769 public:
2770 ConstantEmission() {}
2771 static ConstantEmission forReference(llvm::Constant *C) {
2772 return ConstantEmission(C, true);
2773 }
2774 static ConstantEmission forValue(llvm::Constant *C) {
2775 return ConstantEmission(C, false);
2776 }
2777
Aaron Ballman67347662015-02-15 22:00:28 +00002778 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002779 return ValueAndIsReference.getOpaqueValue() != nullptr;
2780 }
John McCall71335052012-03-10 03:05:10 +00002781
2782 bool isReference() const { return ValueAndIsReference.getInt(); }
2783 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2784 assert(isReference());
2785 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2786 refExpr->getType());
2787 }
2788
2789 llvm::Constant *getValue() const {
2790 assert(!isReference());
2791 return ValueAndIsReference.getPointer();
2792 }
2793 };
2794
John McCall113bee02012-03-10 09:33:50 +00002795 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002796
John McCallfe96e0b2011-11-06 09:01:30 +00002797 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2798 AggValueSlot slot = AggValueSlot::ignored());
2799 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2800
Daniel Dunbar722f4242009-04-22 05:08:15 +00002801 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002802 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002803 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002804 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002805
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002806 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2807 /// if the Field is a reference, this will return the address of the reference
2808 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002809 LValue EmitLValueForFieldInitialization(LValue Base,
2810 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002811
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002812 LValue EmitLValueForIvar(QualType ObjectTy,
2813 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002814 unsigned CVRQualifiers);
2815
Anders Carlsson3be22e22009-05-30 23:23:33 +00002816 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002817 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002818 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002819 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002820 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002821
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002822 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002823 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002824 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002825 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002826 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00002827 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00002828
Chris Lattnerd7f58862007-06-02 05:24:33 +00002829 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002830 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002831 //===--------------------------------------------------------------------===//
2832
Mike Stumpfc496822009-02-08 23:14:22 +00002833 /// EmitCall - Generate a call of the given function, expecting the given
2834 /// result type, and using the given argument list which specifies both the
2835 /// LLVM arguments and the types they were derived from.
Samuel Antao798f11c2015-11-23 22:04:44 +00002836 RValue EmitCall(const CGFunctionInfo &FnInfo, llvm::Value *Callee,
2837 ReturnValueSlot ReturnValue, const CallArgList &Args,
2838 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Craig Topper8a13c412014-05-21 05:09:00 +00002839 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002840
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002841 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002842 ReturnValueSlot ReturnValue,
Samuel Antao798f11c2015-11-23 22:04:44 +00002843 CGCalleeInfo CalleeInfo = CGCalleeInfo(),
Peter Collingbournef7706832014-12-12 23:41:25 +00002844 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002845 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002846 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002847
Eric Christopherc7e79db2015-11-12 00:44:04 +00002848 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00002849
John McCall882987f2013-02-28 19:01:20 +00002850 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2851 const Twine &name = "");
2852 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2853 ArrayRef<llvm::Value*> args,
2854 const Twine &name = "");
2855 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2856 const Twine &name = "");
2857 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2858 ArrayRef<llvm::Value*> args,
2859 const Twine &name = "");
2860
John McCallbd309292010-07-06 01:34:17 +00002861 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002862 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002863 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002864 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2865 ArrayRef<llvm::Value*> args,
2866 const Twine &name = "");
2867 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2868 const Twine &name = "");
2869 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2870 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002871
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002872 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2873 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002874 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002875
2876 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2877 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002878 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002879
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002880 RValue
2881 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2882 ReturnValueSlot ReturnValue, llvm::Value *This,
2883 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00002884 QualType ImplicitParamTy, const CallExpr *E,
2885 CallArgList *RtlArgs);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00002886 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD, llvm::Value *Callee,
2887 llvm::Value *This, llvm::Value *ImplicitParam,
2888 QualType ImplicitParamTy, const CallExpr *E,
2889 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002890 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2891 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002892 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2893 const CXXMethodDecl *MD,
2894 ReturnValueSlot ReturnValue,
2895 bool HasQualifier,
2896 NestedNameSpecifier *Qualifier,
2897 bool IsArrow, const Expr *Base);
2898 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002899 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
2900 llvm::Value *memberPtr,
2901 const MemberPointerType *memberPtrType,
2902 AlignmentSource *AlignSource = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002903 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2904 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002905
Anders Carlsson4034a952009-05-27 04:18:27 +00002906 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002907 const CXXMethodDecl *MD,
2908 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002909
Peter Collingbournefe883422011-10-06 18:29:37 +00002910 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2911 ReturnValueSlot ReturnValue);
2912
Justin Lebar3039a592016-01-23 21:28:14 +00002913 RValue EmitCUDADevicePrintfCallExpr(const CallExpr *E,
2914 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002915
Mike Stump11289f42009-09-09 15:08:12 +00002916 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002917 unsigned BuiltinID, const CallExpr *E,
2918 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002919
Anders Carlssonbfb36712009-12-24 21:13:40 +00002920 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002921
Mike Stumpfc496822009-02-08 23:14:22 +00002922 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2923 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002924 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2925
Kevin Qin1718af62013-11-14 02:45:18 +00002926 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2927 const llvm::CmpInst::Predicate Fp,
2928 const llvm::CmpInst::Predicate Ip,
2929 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002930 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002931
2932 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2933 unsigned LLVMIntrinsic,
2934 unsigned AltLLVMIntrinsic,
2935 const char *NameHint,
2936 unsigned Modifier,
2937 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002938 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00002939 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00002940 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2941 unsigned Modifier, llvm::Type *ArgTy,
2942 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002943 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002944 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002945 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002946 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002947 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002948 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002949 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002950 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2951 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00002952 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00002953 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002954
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002955 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002956 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2957 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00002958 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00002959 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00002960 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00002961 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
2962 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002963
Daniel Dunbar66912a12008-08-20 00:28:19 +00002964 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002965 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002966 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002967 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2968 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2969 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002970 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002971 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002972 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2973 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002974
John McCall31168b02011-06-15 23:02:42 +00002975 /// Retrieves the default cleanup kind for an ARC cleanup.
2976 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2977 CleanupKind getARCCleanupKind() {
2978 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2979 ? NormalAndEHCleanup : NormalCleanup;
2980 }
2981
2982 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00002983 void EmitARCInitWeak(Address addr, llvm::Value *value);
2984 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00002985 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00002986 llvm::Value *EmitARCLoadWeakRetained(Address addr);
2987 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
2988 void EmitARCCopyWeak(Address dst, Address src);
2989 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00002990 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2991 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002992 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002993 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00002994 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002995 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002996 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00002997 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002998 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00002999 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003000 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003001 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003002 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3003 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3004 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003005 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003006
3007 std::pair<LValue,llvm::Value*>
3008 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3009 std::pair<LValue,llvm::Value*>
3010 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003011 std::pair<LValue,llvm::Value*>
3012 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003013
John McCall248512a2011-10-01 10:32:24 +00003014 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003015 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3016 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3017
John McCallff613032011-10-04 06:23:45 +00003018 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003019 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3020 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003021 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3022 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003023 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003024
Craig Topper00bbdcf2014-06-28 23:22:23 +00003025 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003026
John McCall82fe67b2011-07-09 01:37:26 +00003027 static Destroyer destroyARCStrongImprecise;
3028 static Destroyer destroyARCStrongPrecise;
3029 static Destroyer destroyARCWeak;
3030
John McCall31168b02011-06-15 23:02:42 +00003031 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3032 llvm::Value *EmitObjCAutoreleasePoolPush();
3033 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3034 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3035 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3036
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003037 /// \brief Emits a reference binding to the passed in expression.
3038 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003039
Chris Lattner6278e6a2007-08-11 00:04:45 +00003040 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003041 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003042 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003043
3044 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003045
3046 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3047 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003048 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003049
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003050 /// Emit a conversion from the specified type to the specified destination
3051 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003052 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003053 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003054
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003055 /// Emit a conversion from the specified complex type to the specified
3056 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003057 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003058 QualType DstTy,
3059 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003060
John McCall7a626f62010-09-15 10:14:12 +00003061 /// EmitAggExpr - Emit the computation of the specified expression
3062 /// of aggregate type. The result is computed into the given slot,
3063 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003064 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003065
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003066 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3067 /// aggregate type into a temporary LValue.
3068 LValue EmitAggExprToLValue(const Expr *E);
3069
John McCall1bd25562011-06-24 23:21:27 +00003070 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3071 /// make sure it survives garbage collection until this point.
3072 void EmitExtendGCLifetime(llvm::Value *object);
3073
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003074 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003075 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003076 ComplexPairTy EmitComplexExpr(const Expr *E,
3077 bool IgnoreReal = false,
3078 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003079
John McCall47fb9502013-03-07 21:37:08 +00003080 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3081 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003082 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003083
John McCall47fb9502013-03-07 21:37:08 +00003084 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003085 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003086
3087 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003088 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003089
John McCall7f416cc2015-09-08 08:05:57 +00003090 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3091 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3092
Chandler Carruth84537952012-03-30 19:44:53 +00003093 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3094 /// global variable that has already been created for it. If the initializer
3095 /// has a different type than GV does, this may free GV and return a different
3096 /// one. Otherwise it just returns GV.
3097 llvm::GlobalVariable *
3098 AddInitializerToStaticVarDecl(const VarDecl &D,
3099 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003100
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003101
Anders Carlssonf40886a2009-08-08 21:45:14 +00003102 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3103 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003104 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3105 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003106
David Majnemerb3341ea2014-10-05 05:05:40 +00003107 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3108 llvm::Constant *Addr);
3109
John McCallc84ed6a2012-05-01 06:13:13 +00003110 /// Call atexit() with a function that passes the given argument to
3111 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003112 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3113 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003114
John McCallcdf7ef52010-11-06 09:44:32 +00003115 /// Emit code in this function to perform a guarded variable
3116 /// initialization. Guarded initializations are used when it's not
3117 /// possible to prove that an initialization will be done exactly
3118 /// once, e.g. with a static local variable or a static data member
3119 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003120 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003121 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003122
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003123 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3124 /// variables.
3125 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003126 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003127 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003128
John McCallee08c532012-04-06 18:21:03 +00003129 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003130 /// variables.
John McCallee08c532012-04-06 18:21:03 +00003131 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
3132 const std::vector<std::pair<llvm::WeakVH,
3133 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003134
John McCalla738c252011-03-09 04:27:21 +00003135 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3136 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003137 llvm::GlobalVariable *Addr,
3138 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003139
John McCall7a626f62010-09-15 10:14:12 +00003140 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00003141
John McCall7f416cc2015-09-08 08:05:57 +00003142 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003143
John McCall08ef4662011-11-10 08:15:53 +00003144 void enterFullExpression(const ExprWithCleanups *E) {
3145 if (E->getNumObjects() == 0) return;
3146 enterNonTrivialFullExpression(E);
3147 }
3148 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003149
Richard Smithea852322013-05-07 21:53:22 +00003150 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003151
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003152 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3153
Tim Northovercc2a6e02015-11-09 19:56:35 +00003154 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003155
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003156 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003157 // Annotations Emission
3158 //===--------------------------------------------------------------------===//
3159
3160 /// Emit an annotation call (intrinsic or builtin).
3161 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3162 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003163 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003164 SourceLocation Location);
3165
3166 /// Emit local annotations for the local variable V, declared by D.
3167 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3168
3169 /// Emit field annotations for the given field & value. Returns the
3170 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003171 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003172
3173 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003174 // Internal Helpers
3175 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003176
Chris Lattner5b1964b2008-11-11 07:41:27 +00003177 /// ContainsLabel - Return true if the statement contains a label in it. If
3178 /// this statement is not executed normally, it not containing a label means
3179 /// that we can just remove the code.
3180 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003181
Chris Lattner29911cc2011-02-28 00:18:40 +00003182 /// containsBreak - Return true if the statement contains a break out of it.
3183 /// If the statement (recursively) contains a switch or loop with a break
3184 /// inside of it, this is fine.
3185 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003186
3187 /// Determine if the given statement might introduce a declaration into the
3188 /// current scope, by being a (possibly-labelled) DeclStmt.
3189 static bool mightAddDeclToScope(const Stmt *S);
Chris Lattner29911cc2011-02-28 00:18:40 +00003190
Daniel Dunbar682712c2008-11-12 10:12:14 +00003191 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003192 /// to a constant, or if it does but contains a label, return false. If it
3193 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003194 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3195 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003196
Chris Lattner29911cc2011-02-28 00:18:40 +00003197 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3198 /// to a constant, or if it does but contains a label, return false. If it
3199 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003200 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3201 bool AllowLabels = false);
3202
Chris Lattnercd439292008-11-12 08:04:58 +00003203 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3204 /// if statement) to the specified blocks. Based on the condition, this might
3205 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003206 /// TrueCount should be the number of times we expect the condition to
3207 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003208 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003209 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003210
Richard Smithe30752c2012-10-09 19:52:38 +00003211 /// \brief Emit a description of a type in a format suitable for passing to
3212 /// a runtime sanitizer handler.
3213 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3214
3215 /// \brief Convert a value into a format suitable for passing to a runtime
3216 /// sanitizer handler.
3217 llvm::Value *EmitCheckValue(llvm::Value *V);
3218
3219 /// \brief Emit a description of a source location in a format suitable for
3220 /// passing to a runtime sanitizer handler.
3221 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3222
Richard Smithde670682012-11-01 22:15:34 +00003223 /// \brief Create a basic block that will call a handler function in a
3224 /// sanitizer runtime with the provided arguments, and create a conditional
3225 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003226 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003227 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
3228 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003229
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003230 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3231 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003232 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3233 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3234 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003235
Richard Smithde670682012-11-01 22:15:34 +00003236 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3237 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003238 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003239
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003240 /// \brief Emit a call to trap or debugtrap and attach function attribute
3241 /// "trap-func-name" if specified.
3242 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3243
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003244 /// \brief Emit a cross-DSO CFI failure handling function.
3245 void EmitCfiCheckFail();
3246
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003247 /// \brief Create a check for a function parameter that may potentially be
3248 /// declared as non-null.
3249 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
3250 const FunctionDecl *FD, unsigned ParmNum);
3251
Anders Carlsson093bdff2010-03-30 03:27:09 +00003252 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003253 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003254
John McCall23f66262010-05-26 22:34:26 +00003255 /// EmitDelegateCallArg - We are performing a delegate call; that
3256 /// is, the current function is delegating to another one. Produce
3257 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003258 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3259 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003260
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003261 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3262 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003263 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003264
Chris Lattnercd439292008-11-12 08:04:58 +00003265private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003266 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003267 void EmitReturnOfRValue(RValue RV, QualType Ty);
3268
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003269 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3270
3271 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3272 DeferredReplacements;
3273
John McCall7f416cc2015-09-08 08:05:57 +00003274 /// Set the address of a local variable.
3275 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3276 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3277 LocalDeclMap.insert({VD, Addr});
3278 }
3279
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003280 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3281 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3282 ///
3283 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003284 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003285 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003286
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003287 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3288 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3289 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3290 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3291 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3292 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003293
Chad Rosier59df25b2012-08-23 20:00:18 +00003294 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003295 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003296
Chad Rosier59df25b2012-08-23 20:00:18 +00003297 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003298 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003299 std::string &ConstraintStr,
3300 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003301
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003302 /// \brief Attempts to statically evaluate the object size of E. If that
3303 /// fails, emits code to figure the size of E out for us. This is
3304 /// pass_object_size aware.
3305 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
3306 llvm::IntegerType *ResType);
3307
3308 /// \brief Emits the size of E, as required by __builtin_object_size. This
3309 /// function is aware of pass_object_size parameters, and will act accordingly
3310 /// if E is a parameter with the pass_object_size attribute.
3311 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
3312 llvm::IntegerType *ResType);
3313
Reid Kleckner89077a12013-12-17 19:46:40 +00003314public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003315#ifndef NDEBUG
3316 // Determine whether the given argument is an Objective-C method
3317 // that may have type parameters in its signature.
3318 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3319 const DeclContext *dc = method->getDeclContext();
3320 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3321 return classDecl->getTypeParamListAsWritten();
3322 }
3323
3324 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3325 return catDecl->getTypeParamList();
3326 }
3327
3328 return false;
3329 }
3330
3331 template<typename T>
3332 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3333#endif
3334
Richard Smitha560ccf2016-09-29 21:30:12 +00003335 enum class EvaluationOrder {
3336 ///! No language constraints on evaluation order.
3337 Default,
3338 ///! Language semantics require left-to-right evaluation.
3339 ForceLeftToRight,
3340 ///! Language semantics require right-to-left evaluation.
3341 ForceRightToLeft
3342 };
3343
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003344 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003345 template <typename T>
3346 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003347 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003348 const FunctionDecl *CalleeDecl = nullptr,
Richard Smith762672a2016-09-28 19:09:10 +00003349 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003350 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003351 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003352 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003353
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003354 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3355 "Can't skip parameters if type info is not provided");
3356 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003357#ifndef NDEBUG
3358 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3359#endif
3360
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003361 // First, use the argument types that the type info knows about
3362 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3363 E = CallArgTypeInfo->param_type_end();
3364 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003365 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003366 assert((isGenericMethod ||
3367 ((*I)->isVariablyModifiedType() ||
3368 (*I).getNonReferenceType()->isObjCRetainableType() ||
3369 getContext()
3370 .getCanonicalType((*I).getNonReferenceType())
3371 .getTypePtr() ==
3372 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003373 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003374 .getTypePtr())) &&
3375 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003376 ArgTypes.push_back(*I);
3377 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003378 }
Mike Stump11289f42009-09-09 15:08:12 +00003379
Reid Kleckner739756c2013-12-04 19:23:12 +00003380 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003381 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003382 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3383 CallArgTypeInfo->isVariadic()) &&
3384 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003385
Anders Carlsson603d6af2009-04-18 20:20:22 +00003386 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003387 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
3388 ArgTypes.push_back(getVarArgType(A));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003389
Richard Smitha560ccf2016-09-29 21:30:12 +00003390 EmitCallArgs(Args, ArgTypes, ArgRange, CalleeDecl, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003391 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003392
Reid Kleckner739756c2013-12-04 19:23:12 +00003393 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003394 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003395 const FunctionDecl *CalleeDecl = nullptr,
Richard Smith762672a2016-09-28 19:09:10 +00003396 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003397 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00003398
John McCall7f416cc2015-09-08 08:05:57 +00003399 /// EmitPointerWithAlignment - Given an expression with a pointer
3400 /// type, emit the value and compute our best estimate of the
3401 /// alignment of the pointee.
3402 ///
3403 /// Note that this function will conservatively fall back on the type
3404 /// when it doesn't
3405 ///
3406 /// \param Source - If non-null, this will be initialized with
3407 /// information about the source of the alignment. Note that this
3408 /// function will conservatively fall back on the type when it
3409 /// doesn't recognize the expression, which means that sometimes
3410 ///
3411 /// a worst-case One
3412 /// reasonable way to use this information is when there's a
3413 /// language guarantee that the pointer must be aligned to some
3414 /// stricter value, and we're simply trying to ensure that
3415 /// sufficiently obvious uses of under-aligned objects don't get
3416 /// miscompiled; for example, a placement new into the address of
3417 /// a local variable. In such a case, it's quite reasonable to
3418 /// just ignore the returned alignment when it isn't from an
3419 /// explicit source.
3420 Address EmitPointerWithAlignment(const Expr *Addr,
3421 AlignmentSource *Source = nullptr);
3422
Peter Collingbournedc134532016-01-16 00:31:22 +00003423 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3424
Reid Kleckner89077a12013-12-17 19:46:40 +00003425private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003426 QualType getVarArgType(const Expr *Arg);
3427
John McCalld4f4b7f2010-03-03 04:15:11 +00003428 const TargetCodeGenInfo &getTargetHooks() const {
3429 return CGM.getTargetCodeGenInfo();
3430 }
John McCall09ae0322010-07-06 23:57:41 +00003431
3432 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003433
John McCall7f416cc2015-09-08 08:05:57 +00003434 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3435 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003436
3437 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003438
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003439 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003440};
Mike Stump11289f42009-09-09 15:08:12 +00003441
John McCallce1de612011-01-26 04:00:11 +00003442/// Helper class with most of the code for saving a value for a
3443/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003444struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003445 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3446
3447 /// Answer whether the given value needs extra work to be saved.
3448 static bool needsSaving(llvm::Value *value) {
3449 // If it's not an instruction, we don't need to save.
3450 if (!isa<llvm::Instruction>(value)) return false;
3451
3452 // If it's an instruction in the entry block, we don't need to save.
3453 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3454 return (block != &block->getParent()->getEntryBlock());
3455 }
3456
3457 /// Try to save the given value.
3458 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3459 if (!needsSaving(value)) return saved_type(value, false);
3460
John McCall7f416cc2015-09-08 08:05:57 +00003461 // Otherwise, we need an alloca.
3462 auto align = CharUnits::fromQuantity(
3463 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3464 Address alloca =
3465 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003466 CGF.Builder.CreateStore(value, alloca);
3467
John McCall7f416cc2015-09-08 08:05:57 +00003468 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003469 }
3470
3471 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003472 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003473 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003474
3475 // Otherwise, it should be an alloca instruction, as set up in save().
3476 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3477 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003478 }
3479};
3480
John McCallcb5f77f2011-01-28 10:53:53 +00003481/// A partial specialization of DominatingValue for llvm::Values that
3482/// might be llvm::Instructions.
3483template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3484 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003485 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003486 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3487 }
3488};
3489
John McCall7f416cc2015-09-08 08:05:57 +00003490/// A specialization of DominatingValue for Address.
3491template <> struct DominatingValue<Address> {
3492 typedef Address type;
3493
3494 struct saved_type {
3495 DominatingLLVMValue::saved_type SavedValue;
3496 CharUnits Alignment;
3497 };
3498
3499 static bool needsSaving(type value) {
3500 return DominatingLLVMValue::needsSaving(value.getPointer());
3501 }
3502 static saved_type save(CodeGenFunction &CGF, type value) {
3503 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3504 value.getAlignment() };
3505 }
3506 static type restore(CodeGenFunction &CGF, saved_type value) {
3507 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3508 value.Alignment);
3509 }
3510};
3511
John McCallcb5f77f2011-01-28 10:53:53 +00003512/// A specialization of DominatingValue for RValue.
3513template <> struct DominatingValue<RValue> {
3514 typedef RValue type;
3515 class saved_type {
3516 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3517 AggregateAddress, ComplexAddress };
3518
3519 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003520 unsigned K : 3;
3521 unsigned Align : 29;
3522 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3523 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003524
3525 public:
3526 static bool needsSaving(RValue value);
3527 static saved_type save(CodeGenFunction &CGF, RValue value);
3528 RValue restore(CodeGenFunction &CGF);
3529
John McCall7f416cc2015-09-08 08:05:57 +00003530 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003531 };
3532
3533 static bool needsSaving(type value) {
3534 return saved_type::needsSaving(value);
3535 }
3536 static saved_type save(CodeGenFunction &CGF, type value) {
3537 return saved_type::save(CGF, value);
3538 }
3539 static type restore(CodeGenFunction &CGF, saved_type value) {
3540 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003541 }
3542};
3543
Chris Lattnerbed31442007-05-28 01:07:47 +00003544} // end namespace CodeGen
3545} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003546
Chris Lattnerbed31442007-05-28 01:07:47 +00003547#endif