blob: 998e0676cd27154f4446e3fb42a1ef5e21896645 [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"
27#include "clang/AST/Type.h"
28#include "clang/Basic/ABI.h"
Ben Langmuir3b4c30b2013-05-09 19:17:11 +000029#include "clang/Basic/CapturedStmt.h"
Alexander Musmandf7a8e22015-01-22 08:49:35 +000030#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000031#include "clang/Basic/TargetInfo.h"
32#include "clang/Frontend/CodeGenOptions.h"
33#include "llvm/ADT/ArrayRef.h"
34#include "llvm/ADT/DenseMap.h"
35#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000036#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000037#include "llvm/Support/Debug.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000038
Chris Lattnerbed31442007-05-28 01:07:47 +000039namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000040class BasicBlock;
41class LLVMContext;
42class MDNode;
43class Module;
44class SwitchInst;
45class Twine;
46class Value;
47class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000048}
49
Chris Lattnerbed31442007-05-28 01:07:47 +000050namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000051class ASTContext;
52class BlockDecl;
53class CXXDestructorDecl;
54class CXXForRangeStmt;
55class CXXTryStmt;
56class Decl;
57class LabelDecl;
58class EnumConstantDecl;
59class FunctionDecl;
60class FunctionProtoType;
61class LabelStmt;
62class ObjCContainerDecl;
63class ObjCInterfaceDecl;
64class ObjCIvarDecl;
65class ObjCMethodDecl;
66class ObjCImplementationDecl;
67class ObjCPropertyImplDecl;
68class TargetInfo;
69class TargetCodeGenInfo;
70class VarDecl;
71class ObjCForCollectionStmt;
72class ObjCAtTryStmt;
73class ObjCAtThrowStmt;
74class ObjCAtSynchronizedStmt;
75class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000076
Chris Lattnerbed31442007-05-28 01:07:47 +000077namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000078class CodeGenTypes;
79class CGFunctionInfo;
80class CGRecordLayout;
81class CGBlockInfo;
82class CGCXXABI;
83class BlockFlags;
84class BlockFieldFlags;
Mike Stumpfc496822009-02-08 23:14:22 +000085
John McCall47fb9502013-03-07 21:37:08 +000086/// The kind of evaluation to perform on values of a particular
87/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
88/// CGExprAgg?
89///
90/// TODO: should vectors maybe be split out into their own thing?
91enum TypeEvaluationKind {
92 TEK_Scalar,
93 TEK_Complex,
94 TEK_Aggregate
95};
96
Chris Lattnerbed31442007-05-28 01:07:47 +000097/// CodeGenFunction - This class organizes the per-function state that is used
98/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +000099class CodeGenFunction : public CodeGenTypeCache {
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000100 CodeGenFunction(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
101 void operator=(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
John McCall5d865c322010-08-31 07:33:07 +0000102
103 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000104public:
John McCallad5d61e2010-07-23 21:56:41 +0000105 /// A jump destination is an abstract label, branching to which may
106 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000107 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000108 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000109 JumpDest(llvm::BasicBlock *Block,
110 EHScopeStack::stable_iterator Depth,
111 unsigned Index)
112 : Block(Block), ScopeDepth(Depth), Index(Index) {}
113
Craig Topper8a13c412014-05-21 05:09:00 +0000114 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000115 llvm::BasicBlock *getBlock() const { return Block; }
116 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
117 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000118
Nadav Rotem1da30942013-03-23 06:43:35 +0000119 // This should be used cautiously.
120 void setScopeDepth(EHScopeStack::stable_iterator depth) {
121 ScopeDepth = depth;
122 }
123
John McCallad5d61e2010-07-23 21:56:41 +0000124 private:
John McCallbd309292010-07-06 01:34:17 +0000125 llvm::BasicBlock *Block;
126 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000127 unsigned Index;
128 };
129
Chris Lattnerbed31442007-05-28 01:07:47 +0000130 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000131 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000132
Chris Lattner96d72562007-08-21 16:57:55 +0000133 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000134 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000135 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000136
Alexander Musman515ad8c2014-05-22 08:54:05 +0000137 /// \brief CGBuilder insert helper. This function is called after an
138 /// instruction is created using Builder.
139 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
140 llvm::BasicBlock *BB,
141 llvm::BasicBlock::iterator InsertPt) const;
142
John McCalldec348f72013-05-03 07:33:41 +0000143 /// CurFuncDecl - Holds the Decl for the current outermost
144 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000145 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000146 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
147 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000148 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000149 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000150 llvm::Function *CurFn;
151
Mike Stumpbee78dd2009-12-04 23:26:17 +0000152 /// CurGD - The GlobalDecl for the current function being compiled.
153 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000154
John McCall31168b02011-06-15 23:02:42 +0000155 /// PrologueCleanupDepth - The cleanup depth enclosing all the
156 /// cleanups associated with the parameters.
157 EHScopeStack::stable_iterator PrologueCleanupDepth;
158
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000159 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000160 JumpDest ReturnBlock;
161
Mike Stumpfc496822009-02-08 23:14:22 +0000162 /// ReturnValue - The temporary alloca to hold the return value. This is null
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +0000163 /// iff the function has no return value.
Eli Friedman4b1942c2009-12-04 02:43:40 +0000164 llvm::Value *ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000165
Chris Lattner03df1222007-06-02 04:53:11 +0000166 /// AllocaInsertPoint - This is an instruction in the entry block before which
167 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000168 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000169
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000170 /// \brief API for captured statement code generation.
171 class CGCapturedStmtInfo {
172 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000173 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
174 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000175 explicit CGCapturedStmtInfo(const CapturedStmt &S,
176 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000177 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000178
179 RecordDecl::field_iterator Field =
180 S.getCapturedRecordDecl()->field_begin();
181 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
182 E = S.capture_end();
183 I != E; ++I, ++Field) {
184 if (I->capturesThis())
185 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000186 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000187 CaptureFields[I->getCapturedVar()] = *Field;
188 }
189 }
190
191 virtual ~CGCapturedStmtInfo();
192
193 CapturedRegionKind getKind() const { return Kind; }
194
195 void setContextValue(llvm::Value *V) { ThisValue = V; }
196 // \brief Retrieve the value of the context parameter.
197 llvm::Value *getContextValue() const { return ThisValue; }
198
199 /// \brief Lookup the captured field decl for a variable.
200 const FieldDecl *lookup(const VarDecl *VD) const {
201 return CaptureFields.lookup(VD);
202 }
203
Craig Topper8a13c412014-05-21 05:09:00 +0000204 bool isCXXThisExprCaptured() const { return CXXThisFieldDecl != nullptr; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000205 FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
206
Alexey Bataev18095712014-10-10 12:19:54 +0000207 static bool classof(const CGCapturedStmtInfo *) {
208 return true;
209 }
210
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000211 /// \brief Emit the captured statement body.
212 virtual void EmitBody(CodeGenFunction &CGF, Stmt *S) {
Justin Bogner81ab90f2014-04-15 00:50:54 +0000213 RegionCounter Cnt = CGF.getPGORegionCounter(S);
214 Cnt.beginRegion(CGF.Builder);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000215 CGF.EmitStmt(S);
216 }
217
218 /// \brief Get the name of the capture helper.
219 virtual StringRef getHelperName() const { return "__captured_stmt"; }
220
221 private:
222 /// \brief The kind of captured statement being generated.
223 CapturedRegionKind Kind;
224
225 /// \brief Keep the map between VarDecl and FieldDecl.
226 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
227
228 /// \brief The base address of the captured record, passed in as the first
229 /// argument of the parallel region function.
230 llvm::Value *ThisValue;
231
232 /// \brief Captured 'this' type.
233 FieldDecl *CXXThisFieldDecl;
234 };
235 CGCapturedStmtInfo *CapturedStmtInfo;
236
Nuno Lopes3d6311d2012-05-08 22:10:46 +0000237 /// BoundsChecking - Emit run-time bounds checks. Higher values mean
238 /// potentially higher performance penalties.
239 unsigned char BoundsChecking;
240
Alexey Samsonova0416102014-11-11 01:26:14 +0000241 /// \brief Sanitizers enabled for this function.
242 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000243
Alexey Samsonov24cad992014-07-17 18:46:27 +0000244 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
245 bool IsSanitizerScope;
246
247 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
248 class SanitizerScope {
249 CodeGenFunction *CGF;
250 public:
251 SanitizerScope(CodeGenFunction *CGF);
252 ~SanitizerScope();
253 };
254
Reid Kleckner19819442014-07-25 21:39:46 +0000255 /// In C++, whether we are code generating a thunk. This controls whether we
256 /// should emit cleanups.
257 bool CurFuncIsThunk;
258
John McCall31168b02011-06-15 23:02:42 +0000259 /// In ARC, whether we should autorelease the return value.
260 bool AutoreleaseResult;
261
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000262 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
263 /// potentially set the return value.
264 bool SawAsmBlock;
265
John McCallad7c5c12011-02-08 08:22:06 +0000266 const CodeGen::CGBlockInfo *BlockInfo;
267 llvm::Value *BlockPointer;
268
Eli Friedman9fbeba02012-02-11 02:57:39 +0000269 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
270 FieldDecl *LambdaThisCaptureField;
271
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000272 /// \brief A mapping from NRVO variables to the flags used to indicate
273 /// when the NRVO has been applied to this variable.
274 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000275
John McCallbd309292010-07-06 01:34:17 +0000276 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000277 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
278
279 /// Header for data within LifetimeExtendedCleanupStack.
280 struct LifetimeExtendedCleanupHeader {
281 /// The size of the following cleanup object.
Reid Klecknerc311aba2014-10-31 23:33:56 +0000282 unsigned Size : 29;
Richard Smith736a9472013-06-12 20:42:33 +0000283 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
284 unsigned Kind : 3;
285
Reid Klecknerc311aba2014-10-31 23:33:56 +0000286 size_t getSize() const { return size_t(Size); }
Richard Smith736a9472013-06-12 20:42:33 +0000287 CleanupKind getKind() const { return static_cast<CleanupKind>(Kind); }
288 };
John McCallbd309292010-07-06 01:34:17 +0000289
John McCallad5d61e2010-07-23 21:56:41 +0000290 /// i32s containing the indexes of the cleanup destinations.
291 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000292
293 unsigned NextCleanupDestIndex;
294
John McCall08ef4662011-11-10 08:15:53 +0000295 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
296 CGBlockInfo *FirstBlockInfo;
297
John McCall8e4c74b2011-08-11 02:22:43 +0000298 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
299 llvm::BasicBlock *EHResumeBlock;
300
Bill Wendlingf0724e82011-09-19 20:31:14 +0000301 /// The exception slot. All landing pads write the current exception pointer
302 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000303 llvm::Value *ExceptionSlot;
304
Bill Wendlingf0724e82011-09-19 20:31:14 +0000305 /// The selector slot. Under the MandatoryCleanup model, all landing pads
306 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000307 llvm::AllocaInst *EHSelectorSlot;
308
Reid Kleckneraca01db2015-02-04 22:37:07 +0000309 llvm::AllocaInst *AbnormalTerminationSlot;
310
Reid Kleckner1d59f992015-01-22 01:36:17 +0000311 /// The implicit parameter to SEH filter functions of type
312 /// 'EXCEPTION_POINTERS*'.
313 ImplicitParamDecl *SEHPointersDecl;
314
John McCallbd309292010-07-06 01:34:17 +0000315 /// Emits a landing pad for the current EH stack.
316 llvm::BasicBlock *EmitLandingPad();
317
318 llvm::BasicBlock *getInvokeDestImpl();
319
John McCallce1de612011-01-26 04:00:11 +0000320 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000321 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
322 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000323 }
324
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000325public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000326 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
327 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000328 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000329
John McCall6b0feb72011-06-22 02:32:12 +0000330 /// A class controlling the emission of a finally block.
331 class FinallyInfo {
332 /// Where the catchall's edge through the cleanup should go.
333 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000334
John McCall6b0feb72011-06-22 02:32:12 +0000335 /// A function to call to enter the catch.
336 llvm::Constant *BeginCatchFn;
337
338 /// An i1 variable indicating whether or not the @finally is
339 /// running for an exception.
340 llvm::AllocaInst *ForEHVar;
341
342 /// An i8* variable into which the exception pointer to rethrow
343 /// has been saved.
344 llvm::AllocaInst *SavedExnVar;
345
346 public:
347 void enter(CodeGenFunction &CGF, const Stmt *Finally,
348 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
349 llvm::Constant *rethrowFn);
350 void exit(CodeGenFunction &CGF);
351 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000352
Reid Kleckneraca01db2015-02-04 22:37:07 +0000353 /// Cleanups can be emitted for two reasons: normal control leaving a region
354 /// exceptional control flow leaving a region.
355 struct SEHFinallyInfo {
356 SEHFinallyInfo()
357 : FinallyBB(nullptr), ContBB(nullptr), ResumeBB(nullptr) {}
358
359 llvm::BasicBlock *FinallyBB;
360 llvm::BasicBlock *ContBB;
361 llvm::BasicBlock *ResumeBB;
362 };
363
John McCallce1de612011-01-26 04:00:11 +0000364 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
365 /// current full-expression. Safe against the possibility that
366 /// we're currently inside a conditionally-evaluated expression.
John McCalle4df6c82011-01-28 08:37:24 +0000367 template <class T, class A0>
368 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
369 // If we're not in a conditional branch, or if none of the
370 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000371 if (!isInConditionalBranch())
372 return EHStack.pushCleanup<T>(kind, a0);
John McCalle4df6c82011-01-28 08:37:24 +0000373
John McCallcb5f77f2011-01-28 10:53:53 +0000374 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCalle4df6c82011-01-28 08:37:24 +0000375
376 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
377 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
378 initFullExprCleanup();
379 }
380
381 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
382 /// current full-expression. Safe against the possibility that
383 /// we're currently inside a conditionally-evaluated expression.
John McCallce1de612011-01-26 04:00:11 +0000384 template <class T, class A0, class A1>
385 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
386 // If we're not in a conditional branch, or if none of the
387 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000388 if (!isInConditionalBranch())
389 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCallce1de612011-01-26 04:00:11 +0000390
John McCallcb5f77f2011-01-28 10:53:53 +0000391 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
392 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCallce1de612011-01-26 04:00:11 +0000393
394 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCalle4df6c82011-01-28 08:37:24 +0000395 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
396 initFullExprCleanup();
John McCallce1de612011-01-26 04:00:11 +0000397 }
398
Douglas Gregor58df5092011-06-22 16:12:01 +0000399 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
400 /// current full-expression. Safe against the possibility that
401 /// we're currently inside a conditionally-evaluated expression.
402 template <class T, class A0, class A1, class A2>
403 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
404 // If we're not in a conditional branch, or if none of the
405 // arguments requires saving, then use the unconditional cleanup.
406 if (!isInConditionalBranch()) {
John McCall5fcf8da2011-07-12 00:15:30 +0000407 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregor58df5092011-06-22 16:12:01 +0000408 }
409
410 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
411 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
412 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
413
414 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
415 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
416 initFullExprCleanup();
417 }
418
John McCall4bd0fb12011-07-12 16:41:08 +0000419 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
420 /// current full-expression. Safe against the possibility that
421 /// we're currently inside a conditionally-evaluated expression.
422 template <class T, class A0, class A1, class A2, class A3>
423 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
424 // If we're not in a conditional branch, or if none of the
425 // arguments requires saving, then use the unconditional cleanup.
426 if (!isInConditionalBranch()) {
427 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
428 }
429
430 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
431 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
432 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
433 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
434
435 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
436 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
437 a2_saved, a3_saved);
438 initFullExprCleanup();
439 }
440
Richard Smith736a9472013-06-12 20:42:33 +0000441 /// \brief Queue a cleanup to be pushed after finishing the current
442 /// full-expression.
443 template <class T, class A0, class A1, class A2, class A3>
444 void pushCleanupAfterFullExpr(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
445 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
446
447 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
448
449 size_t OldSize = LifetimeExtendedCleanupStack.size();
450 LifetimeExtendedCleanupStack.resize(
451 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
452
453 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
454 new (Buffer) LifetimeExtendedCleanupHeader(Header);
455 new (Buffer + sizeof(Header)) T(a0, a1, a2, a3);
456 }
457
John McCallf4beacd2011-11-10 10:43:54 +0000458 /// Set up the last cleaup that was pushed as a conditional
459 /// full-expression cleanup.
460 void initFullExprCleanup();
461
John McCallbd309292010-07-06 01:34:17 +0000462 /// PushDestructorCleanup - Push a cleanup to call the
463 /// complete-object destructor of an object of the given type at the
464 /// given address. Does nothing if T is not a C++ class type with a
465 /// non-trivial destructor.
466 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
467
John McCall8680f872010-07-21 06:29:51 +0000468 /// PushDestructorCleanup - Push a cleanup to call the
469 /// complete-object variant of the given destructor on the object at
470 /// the given address.
471 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
472 llvm::Value *Addr);
473
John McCallbd309292010-07-06 01:34:17 +0000474 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
475 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000476 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000477
John McCall824c2f52010-09-14 07:57:04 +0000478 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
479 /// The block cannot be reactivated. Pops it if it's the top of the
480 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000481 ///
482 /// \param DominatingIP - An instruction which is known to
483 /// dominate the current IP (if set) and which lies along
484 /// all paths of execution between the current IP and the
485 /// the point at which the cleanup comes into scope.
486 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
487 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000488
489 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
490 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000491 ///
492 /// \param DominatingIP - An instruction which is known to
493 /// dominate the current IP (if set) and which lies along
494 /// all paths of execution between the current IP and the
495 /// the point at which the cleanup comes into scope.
496 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
497 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000498
John McCallbd309292010-07-06 01:34:17 +0000499 /// \brief Enters a new scope for capturing cleanups, all of which
500 /// will be executed once the scope is exited.
501 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000502 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000503 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000504 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000505 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000506 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000507 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000508
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000509 RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
510 void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
Douglas Gregor965f4502009-11-24 16:43:22 +0000511
Eric Christophera9d34972011-10-19 00:43:52 +0000512 protected:
513 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000514
Douglas Gregor965f4502009-11-24 16:43:22 +0000515 public:
516 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000517 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000518 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000519 {
John McCallbd309292010-07-06 01:34:17 +0000520 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000521 LifetimeExtendedCleanupStackSize =
522 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000523 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000524 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000525 }
526
527 /// \brief Exit this cleanup scope, emitting any accumulated
528 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000529 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000530 if (PerformCleanup) {
531 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000532 CGF.PopCleanupBlocks(CleanupStackDepth,
533 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000534 }
535 }
536
537 /// \brief Determine whether this scope requires any cleanups.
538 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000539 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000540 }
541
542 /// \brief Force the emission of cleanups now, instead of waiting
543 /// until this object is destroyed.
544 void ForceCleanup() {
545 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000546 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000547 CGF.PopCleanupBlocks(CleanupStackDepth,
548 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000549 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000550 }
551 };
552
David Blaikie93be0b22014-08-22 21:37:04 +0000553 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000554 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000555 SmallVector<const LabelDecl*, 4> Labels;
556 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000557
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000558 LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
559 void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
Eric Christophera9d34972011-10-19 00:43:52 +0000560
561 public:
562 /// \brief Enter a new cleanup scope.
563 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000564 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
565 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000566 if (CGDebugInfo *DI = CGF.getDebugInfo())
567 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
568 }
569
Nadav Rotem1da30942013-03-23 06:43:35 +0000570 void addLabel(const LabelDecl *label) {
571 assert(PerformCleanup && "adding label to dead scope?");
572 Labels.push_back(label);
573 }
574
Eric Christophera9d34972011-10-19 00:43:52 +0000575 /// \brief Exit this cleanup scope, emitting any accumulated
576 /// cleanups.
577 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000578 if (CGDebugInfo *DI = CGF.getDebugInfo())
579 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
580
Nadav Rotem1da30942013-03-23 06:43:35 +0000581 // If we should perform a cleanup, force them now. Note that
582 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000583 if (PerformCleanup) {
584 ApplyDebugLocation DL(CGF, Range.getEnd());
585 ForceCleanup();
586 }
Eric Christophera9d34972011-10-19 00:43:52 +0000587 }
588
589 /// \brief Force the emission of cleanups now, instead of waiting
590 /// until this object is destroyed.
591 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000592 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000593 RunCleanupsScope::ForceCleanup();
594
Nadav Rotem1da30942013-03-23 06:43:35 +0000595 if (!Labels.empty())
596 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000597 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000598
599 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000600 };
601
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000602 /// \brief The scope used to remap some variables as private in the OpenMP
603 /// loop body (or other captured region emitted without outlining), and to
604 /// restore old vars back on exit.
605 class OMPPrivateScope : public RunCleanupsScope {
606 typedef llvm::DenseMap<const VarDecl *, llvm::Value *> VarDeclMapTy;
607 VarDeclMapTy SavedLocals;
608 VarDeclMapTy SavedPrivates;
609
610 private:
611 OMPPrivateScope(const OMPPrivateScope &) LLVM_DELETED_FUNCTION;
612 void operator=(const OMPPrivateScope &) LLVM_DELETED_FUNCTION;
613
614 public:
615 /// \brief Enter a new OpenMP private scope.
616 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
617
618 /// \brief Registers \a LocalVD variable as a private and apply \a
619 /// PrivateGen function for it to generate corresponding private variable.
620 /// \a PrivateGen returns an address of the generated private variable.
621 /// \return true if the variable is registered as private, false if it has
622 /// been privatized already.
623 bool
624 addPrivate(const VarDecl *LocalVD,
625 const std::function<llvm::Value *()> &PrivateGen) {
626 assert(PerformCleanup && "adding private to dead scope");
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000627 if (SavedLocals.count(LocalVD) > 0) return false;
628 SavedLocals[LocalVD] = CGF.LocalDeclMap.lookup(LocalVD);
629 CGF.LocalDeclMap.erase(LocalVD);
630 SavedPrivates[LocalVD] = PrivateGen();
631 CGF.LocalDeclMap[LocalVD] = SavedLocals[LocalVD];
632 return true;
633 }
634
635 /// \brief Privatizes local variables previously registered as private.
636 /// Registration is separate from the actual privatization to allow
637 /// initializers use values of the original variables, not the private one.
638 /// This is important, for example, if the private variable is a class
639 /// variable initialized by a constructor that references other private
640 /// variables. But at initialization original variables must be used, not
641 /// private copies.
642 /// \return true if at least one variable was privatized, false otherwise.
643 bool Privatize() {
644 for (auto VDPair : SavedPrivates) {
645 CGF.LocalDeclMap[VDPair.first] = VDPair.second;
646 }
647 SavedPrivates.clear();
648 return !SavedLocals.empty();
649 }
650
651 void ForceCleanup() {
652 RunCleanupsScope::ForceCleanup();
653 // Remap vars back to the original values.
654 for (auto I : SavedLocals) {
655 CGF.LocalDeclMap[I.first] = I.second;
656 }
657 SavedLocals.clear();
658 }
659
660 /// \brief Exit scope - all the mapped variables are restored.
661 ~OMPPrivateScope() { ForceCleanup(); }
662 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000663
Richard Smith736a9472013-06-12 20:42:33 +0000664 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
665 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000666 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000667
Richard Smith736a9472013-06-12 20:42:33 +0000668 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
669 /// that have been added, then adds all lifetime-extended cleanups from
670 /// the given position to the stack.
671 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
672 size_t OldLifetimeExtendedStackSize);
673
John McCallad5d61e2010-07-23 21:56:41 +0000674 void ResolveBranchFixups(llvm::BasicBlock *Target);
675
John McCallbd309292010-07-06 01:34:17 +0000676 /// The given basic block lies in the current EH scope, but may be a
677 /// target of a potentially scope-crossing jump; get a stable handle
678 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000679 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000680 return JumpDest(Target,
681 EHStack.getInnermostNormalCleanup(),
682 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000683 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000684
John McCallbd309292010-07-06 01:34:17 +0000685 /// The given basic block lies in the current EH scope, but may be a
686 /// target of a potentially scope-crossing jump; get a stable handle
687 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000688 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000689 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000690 }
691
692 /// EmitBranchThroughCleanup - Emit a branch from the current insert
693 /// block through the normal cleanup handling code (if any) and then
694 /// on to \arg Dest.
695 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000696
Justin Bognere25ffdf2014-01-21 00:35:11 +0000697 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
698 /// specified destination obviously has no cleanups to run. 'false' is always
699 /// a conservatively correct answer for this method.
700 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
701
John McCall8e4c74b2011-08-11 02:22:43 +0000702 /// popCatchScope - Pops the catch scope at the top of the EHScope
703 /// stack, emitting any required code (other than the catch handlers
704 /// themselves).
705 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000706
David Chisnall9a837be2012-11-07 16:50:40 +0000707 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000708 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000709
John McCallce1de612011-01-26 04:00:11 +0000710 /// An object to manage conditionally-evaluated expressions.
711 class ConditionalEvaluation {
712 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000713
John McCallce1de612011-01-26 04:00:11 +0000714 public:
715 ConditionalEvaluation(CodeGenFunction &CGF)
716 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000717
John McCallce1de612011-01-26 04:00:11 +0000718 void begin(CodeGenFunction &CGF) {
719 assert(CGF.OutermostConditional != this);
720 if (!CGF.OutermostConditional)
721 CGF.OutermostConditional = this;
722 }
723
724 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000725 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000726 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000727 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000728 }
729
730 /// Returns a block which will be executed prior to each
731 /// evaluation of the conditional code.
732 llvm::BasicBlock *getStartingBlock() const {
733 return StartBB;
734 }
735 };
Mike Stump11289f42009-09-09 15:08:12 +0000736
John McCall7f9c92a2010-09-17 00:50:28 +0000737 /// isInConditionalBranch - Return true if we're currently emitting
738 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000739 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000740
John McCallf4beacd2011-11-10 10:43:54 +0000741 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
742 assert(isInConditionalBranch());
743 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
744 new llvm::StoreInst(value, addr, &block->back());
745 }
746
John McCallce1de612011-01-26 04:00:11 +0000747 /// An RAII object to record that we're evaluating a statement
748 /// expression.
749 class StmtExprEvaluation {
750 CodeGenFunction &CGF;
751
752 /// We have to save the outermost conditional: cleanups in a
753 /// statement expression aren't conditional just because the
754 /// StmtExpr is.
755 ConditionalEvaluation *SavedOutermostConditional;
756
757 public:
758 StmtExprEvaluation(CodeGenFunction &CGF)
759 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000760 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000761 }
762
763 ~StmtExprEvaluation() {
764 CGF.OutermostConditional = SavedOutermostConditional;
765 CGF.EnsureInsertPoint();
766 }
767 };
John McCall1bf58462011-02-16 08:02:54 +0000768
John McCallc07a0c72011-02-17 10:25:35 +0000769 /// An object which temporarily prevents a value from being
770 /// destroyed by aggressive peephole optimizations that assume that
771 /// all uses of a value have been realized in the IR.
772 class PeepholeProtection {
773 llvm::Instruction *Inst;
774 friend class CodeGenFunction;
775
776 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000777 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000778 };
John McCallc07a0c72011-02-17 10:25:35 +0000779
John McCallfe96e0b2011-11-06 09:01:30 +0000780 /// A non-RAII class containing all the information about a bound
781 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
782 /// this which makes individual mappings very simple; using this
783 /// class directly is useful when you have a variable number of
784 /// opaque values or don't want the RAII functionality for some
785 /// reason.
786 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000787 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000788 bool BoundLValue;
789 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000790
John McCallfe96e0b2011-11-06 09:01:30 +0000791 OpaqueValueMappingData(const OpaqueValueExpr *ov,
792 bool boundLValue)
793 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000794 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000795 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000796
John McCallc07a0c72011-02-17 10:25:35 +0000797 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000798 // gl-values should be bound as l-values for obvious reasons.
799 // Records should be bound as l-values because IR generation
800 // always keeps them in memory. Expressions of function type
801 // act exactly like l-values but are formally required to be
802 // r-values in C.
803 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000804 expr->getType()->isFunctionType() ||
805 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000806 }
807
John McCallfe96e0b2011-11-06 09:01:30 +0000808 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
809 const OpaqueValueExpr *ov,
810 const Expr *e) {
811 if (shouldBindAsLValue(ov))
812 return bind(CGF, ov, CGF.EmitLValue(e));
813 return bind(CGF, ov, CGF.EmitAnyExpr(e));
814 }
815
816 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
817 const OpaqueValueExpr *ov,
818 const LValue &lv) {
819 assert(shouldBindAsLValue(ov));
820 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
821 return OpaqueValueMappingData(ov, true);
822 }
823
824 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
825 const OpaqueValueExpr *ov,
826 const RValue &rv) {
827 assert(!shouldBindAsLValue(ov));
828 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
829
830 OpaqueValueMappingData data(ov, false);
831
832 // Work around an extremely aggressive peephole optimization in
833 // EmitScalarConversion which assumes that all other uses of a
834 // value are extant.
835 data.Protection = CGF.protectFromPeepholes(rv);
836
837 return data;
838 }
839
Craig Topper8a13c412014-05-21 05:09:00 +0000840 bool isValid() const { return OpaqueValue != nullptr; }
841 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000842
843 void unbind(CodeGenFunction &CGF) {
844 assert(OpaqueValue && "no data to unbind!");
845
846 if (BoundLValue) {
847 CGF.OpaqueLValues.erase(OpaqueValue);
848 } else {
849 CGF.OpaqueRValues.erase(OpaqueValue);
850 CGF.unprotectFromPeepholes(Protection);
851 }
852 }
853 };
854
855 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
856 class OpaqueValueMapping {
857 CodeGenFunction &CGF;
858 OpaqueValueMappingData Data;
859
860 public:
861 static bool shouldBindAsLValue(const Expr *expr) {
862 return OpaqueValueMappingData::shouldBindAsLValue(expr);
863 }
864
John McCallc07a0c72011-02-17 10:25:35 +0000865 /// Build the opaque value mapping for the given conditional
866 /// operator if it's the GNU ?: extension. This is a common
867 /// enough pattern that the convenience operator is really
868 /// helpful.
869 ///
870 OpaqueValueMapping(CodeGenFunction &CGF,
871 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000872 if (isa<ConditionalOperator>(op))
873 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000874 return;
John McCallc07a0c72011-02-17 10:25:35 +0000875
876 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000877 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
878 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000879 }
880
John McCall1bf58462011-02-16 08:02:54 +0000881 OpaqueValueMapping(CodeGenFunction &CGF,
882 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000883 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000884 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000885 }
886
887 OpaqueValueMapping(CodeGenFunction &CGF,
888 const OpaqueValueExpr *opaqueValue,
889 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000890 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000891 }
892
893 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000894 Data.unbind(CGF);
895 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000896 }
897
898 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000899 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000900 }
901 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000902
903 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
904 /// number that holds the value.
905 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian2f2fa722011-01-26 23:08:27 +0000906
907 /// BuildBlockByrefAddress - Computes address location of the
908 /// variable which is declared as __block.
909 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
910 const VarDecl *V);
Chris Lattner2da04b32007-08-24 05:35:26 +0000911private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000912 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000913 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000914
John McCall9b382dd2011-05-28 21:13:02 +0000915 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
916 /// calling llvm.stacksave for multiple VLAs in the same scope.
917 bool DidCallStackSave;
918
Mike Stumpe5311b02009-11-30 20:08:49 +0000919 /// IndirectBranch - The first time an indirect goto is seen we create a block
920 /// with an indirect branch. Every time we see the address of a label taken,
921 /// we add the label to the indirect goto. Every subsequent indirect goto is
922 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000923 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000924
Mike Stumpfc496822009-02-08 23:14:22 +0000925 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
926 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000927 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
928 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000929
Chris Lattnerac248202007-05-30 00:13:02 +0000930 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000931 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000932
Mike Stumpfc496822009-02-08 23:14:22 +0000933 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000934 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000935 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000936 BreakContinue(JumpDest Break, JumpDest Continue)
937 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000938
John McCallbd309292010-07-06 01:34:17 +0000939 JumpDest BreakBlock;
940 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000941 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000942 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000943
Justin Bogneref512b92014-01-06 22:27:43 +0000944 CodeGenPGO PGO;
945
946public:
947 /// Get a counter for instrumentation of the region associated with the given
948 /// statement.
949 RegionCounter getPGORegionCounter(const Stmt *S) {
950 return RegionCounter(PGO, S);
951 }
952private:
953
Zhongxing Xu82846ea2012-01-14 09:08:15 +0000954 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +0000955 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000956 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +0000957 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
958 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +0000959
Mike Stumpfc496822009-02-08 23:14:22 +0000960 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000961 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000962 llvm::BasicBlock *CaseRangeBlock;
963
John McCallc07a0c72011-02-17 10:25:35 +0000964 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +0000965 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +0000966 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
967 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +0000968
Mike Stumpfc496822009-02-08 23:14:22 +0000969 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +0000970 // We track this by the size expression rather than the type itself because
971 // in certain situations, like a const qualifier applied to an VLA typedef,
972 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +0000973 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
974 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +0000975 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000976
John McCallbd309292010-07-06 01:34:17 +0000977 /// A block containing a single 'unreachable' instruction. Created
978 /// lazily by getUnreachableBlock().
979 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000980
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000981 /// Counts of the number return expressions in the function.
982 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +0000983
984 /// Count the number of simple (constant) return expressions in the function.
985 unsigned NumSimpleReturnExprs;
986
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000987 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +0000988 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +0000989
Richard Smith852c9db2013-04-20 22:23:05 +0000990public:
991 /// A scope within which we are constructing the fields of an object which
992 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
993 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
994 class FieldConstructionScope {
995 public:
996 FieldConstructionScope(CodeGenFunction &CGF, llvm::Value *This)
997 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
998 CGF.CXXDefaultInitExprThis = This;
999 }
1000 ~FieldConstructionScope() {
1001 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1002 }
1003
1004 private:
1005 CodeGenFunction &CGF;
1006 llvm::Value *OldCXXDefaultInitExprThis;
1007 };
1008
1009 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1010 /// is overridden to be the object under construction.
1011 class CXXDefaultInitExprScope {
1012 public:
1013 CXXDefaultInitExprScope(CodeGenFunction &CGF)
1014 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue) {
1015 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis;
1016 }
1017 ~CXXDefaultInitExprScope() {
1018 CGF.CXXThisValue = OldCXXThisValue;
1019 }
1020
1021 public:
1022 CodeGenFunction &CGF;
1023 llvm::Value *OldCXXThisValue;
1024 };
1025
1026private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001027 /// CXXThisDecl - When generating code for a C++ member function,
1028 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001029 ImplicitParamDecl *CXXABIThisDecl;
1030 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001031 llvm::Value *CXXThisValue;
Mike Stump11289f42009-09-09 15:08:12 +00001032
Richard Smith852c9db2013-04-20 22:23:05 +00001033 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1034 /// this expression.
1035 llvm::Value *CXXDefaultInitExprThis;
1036
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001037 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1038 /// destructor, this will hold the implicit argument (e.g. VTT).
1039 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1040 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001041
John McCallce1de612011-01-26 04:00:11 +00001042 /// OutermostConditional - Points to the outermost active
1043 /// conditional control. This is used so that we know if a
1044 /// temporary should be destroyed conditionally.
1045 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001046
Nadav Rotem1da30942013-03-23 06:43:35 +00001047 /// The current lexical scope.
1048 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001049
Adrian Prantldc237b52013-05-16 00:41:26 +00001050 /// The current source location that should be used for exception
1051 /// handling code.
1052 SourceLocation CurEHLocation;
1053
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001054 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1055 /// type as well as the field number that contains the actual data.
Chris Lattner2192fe52011-07-18 04:24:23 +00001056 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001057 unsigned> > ByRefValueInfo;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001058
John McCallbd309292010-07-06 01:34:17 +00001059 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001060 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001061 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001062
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001063 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1064 /// In the kernel metadata node, reference the kernel function and metadata
1065 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001066 /// - A node for the vec_type_hint(<type>) qualifier contains string
1067 /// "vec_type_hint", an undefined value of the <type> data type,
1068 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001069 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1070 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1071 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1072 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1073 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1074 llvm::Function *Fn);
1075
Chris Lattnerbed31442007-05-28 01:07:47 +00001076public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001077 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001078 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001079
John McCall8ed55a52010-09-02 09:58:18 +00001080 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001081 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001082 CGDebugInfo *getDebugInfo() {
1083 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001084 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001085 return DebugInfo;
1086 }
1087 void disableDebugInfo() { DisableDebugInfo = true; }
1088 void enableDebugInfo() { DisableDebugInfo = false; }
1089
John McCall31168b02011-06-15 23:02:42 +00001090 bool shouldUseFusedARCCalls() {
1091 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1092 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001093
David Blaikiebbafb8a2012-03-11 07:00:24 +00001094 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001095
Bill Wendlingf0724e82011-09-19 20:31:14 +00001096 /// Returns a pointer to the function's exception object and selector slot,
1097 /// which is assigned in every landing pad.
John McCallbd309292010-07-06 01:34:17 +00001098 llvm::Value *getExceptionSlot();
John McCall9b382dd2011-05-28 21:13:02 +00001099 llvm::Value *getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001100
Reid Kleckneraca01db2015-02-04 22:37:07 +00001101 /// Stack slot that contains whether a __finally block is being executed as an
1102 /// EH cleanup or as a normal cleanup.
1103 llvm::Value *getAbnormalTerminationSlot();
1104
Bill Wendling79a70e42011-09-15 18:57:19 +00001105 /// Returns the contents of the function's exception object and selector
1106 /// slots.
1107 llvm::Value *getExceptionFromSlot();
1108 llvm::Value *getSelectorFromSlot();
1109
John McCallad5d61e2010-07-23 21:56:41 +00001110 llvm::Value *getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001111
John McCallbd309292010-07-06 01:34:17 +00001112 llvm::BasicBlock *getUnreachableBlock() {
1113 if (!UnreachableBlock) {
1114 UnreachableBlock = createBasicBlock("unreachable");
1115 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1116 }
1117 return UnreachableBlock;
1118 }
1119
1120 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001121 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001122 return getInvokeDestImpl();
1123 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001124
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001125 bool currentFunctionUsesSEHTry() const {
1126 const auto *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl);
1127 return FD && FD->usesSEHTry();
1128 }
1129
John McCallc8e01702013-04-16 22:48:15 +00001130 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001131 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001132
Daniel Dunbar12347492009-02-23 17:26:39 +00001133 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001134 // Cleanups
1135 //===--------------------------------------------------------------------===//
1136
1137 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1138
John McCall178360e2011-07-11 08:38:19 +00001139 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1140 llvm::Value *arrayEndPointer,
1141 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001142 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001143 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1144 llvm::Value *arrayEnd,
1145 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001146 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001147
John McCall4bd0fb12011-07-12 16:41:08 +00001148 void pushDestroy(QualType::DestructionKind dtorKind,
1149 llvm::Value *addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001150 void pushEHDestroy(QualType::DestructionKind dtorKind,
1151 llvm::Value *addr, QualType type);
John McCall82fe67b2011-07-09 01:37:26 +00001152 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001153 Destroyer *destroyer, bool useEHCleanupForArray);
Richard Smith736a9472013-06-12 20:42:33 +00001154 void pushLifetimeExtendedDestroy(CleanupKind kind, llvm::Value *addr,
1155 QualType type, Destroyer *destroyer,
1156 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001157 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1158 llvm::Value *CompletePtr,
1159 QualType ElementType);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001160 void pushStackRestore(CleanupKind kind, llvm::Value *SPMem);
Peter Collingbourne1425b452012-01-26 03:33:36 +00001161 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001162 bool useEHCleanupForArray);
David Blaikieebe87e12013-08-27 23:57:18 +00001163 llvm::Function *generateDestroyHelper(llvm::Constant *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001164 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001165 bool useEHCleanupForArray,
1166 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001167 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001168 QualType type, Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001169 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001170
Peter Collingbourne1425b452012-01-26 03:33:36 +00001171 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001172
John McCall82fe67b2011-07-09 01:37:26 +00001173 /// Determines whether an EH cleanup is required to destroy a type
1174 /// with the given destruction kind.
1175 bool needsEHCleanup(QualType::DestructionKind kind) {
1176 switch (kind) {
1177 case QualType::DK_none:
1178 return false;
1179 case QualType::DK_cxx_destructor:
1180 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001181 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001182 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001183 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001184 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1185 }
1186 llvm_unreachable("bad destruction kind");
1187 }
1188
John McCall4bd0fb12011-07-12 16:41:08 +00001189 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1190 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1191 }
1192
John McCall82fe67b2011-07-09 01:37:26 +00001193 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001194 // Objective-C
1195 //===--------------------------------------------------------------------===//
1196
Chris Lattner4bd55962008-03-30 23:03:07 +00001197 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001198
David Blaikief1425802015-01-14 00:04:42 +00001199 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001200
Mike Stumpfc496822009-02-08 23:14:22 +00001201 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001202 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1203 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001204 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001205 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001206 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001207 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001208
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001209 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1210 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001211
Mike Stumpfc496822009-02-08 23:14:22 +00001212 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1213 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001214 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1215 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001216 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001217 const ObjCPropertyImplDecl *propImpl,
1218 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian08b0f662010-04-13 00:38:05 +00001219 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001220 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001221
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001222 //===--------------------------------------------------------------------===//
1223 // Block Bits
1224 //===--------------------------------------------------------------------===//
1225
John McCall351762c2011-02-07 10:33:21 +00001226 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001227 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1228 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garstfc83aa02010-02-23 21:51:17 +00001229 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001230 const CGBlockInfo &Info,
Chris Lattner2192fe52011-07-18 04:24:23 +00001231 llvm::StructType *,
John McCallad7c5c12011-02-08 08:22:06 +00001232 llvm::Constant *BlockVarLayout);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001233
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001234 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001235 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001236 const DeclMapTy &ldm,
1237 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001238
John McCallad7c5c12011-02-08 08:22:06 +00001239 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1240 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001241 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1242 const ObjCPropertyImplDecl *PID);
1243 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1244 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001245 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001246
John McCallad7c5c12011-02-08 08:22:06 +00001247 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1248
John McCall73064872011-03-31 01:59:53 +00001249 class AutoVarEmission;
1250
1251 void emitByrefStructureInit(const AutoVarEmission &emission);
1252 void enterByrefCleanup(const AutoVarEmission &emission);
1253
John McCall351762c2011-02-07 10:33:21 +00001254 llvm::Value *LoadBlockStruct() {
1255 assert(BlockPointer && "no block pointer set!");
1256 return BlockPointer;
1257 }
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001258
John McCall87fe5d52010-05-20 01:18:31 +00001259 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCall113bee02012-03-10 09:33:50 +00001260 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall351762c2011-02-07 10:33:21 +00001261 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2192fe52011-07-18 04:24:23 +00001262 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001263
John McCalla738c252011-03-09 04:27:21 +00001264 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1265 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001266 /// \brief Emit code for the start of a function.
1267 /// \param Loc The location to be associated with the function.
1268 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001269 void StartFunction(GlobalDecl GD,
1270 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001271 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001272 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001273 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001274 SourceLocation Loc = SourceLocation(),
1275 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001276
John McCallb81884d2010-02-19 09:25:03 +00001277 void EmitConstructorBody(FunctionArgList &Args);
1278 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001279 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001280 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Bob Wilsonbf854f02014-02-17 19:21:09 +00001281 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, RegionCounter &Cnt);
John McCall89b12b32010-02-18 03:17:58 +00001282
Faisal Vali571df122013-09-29 08:45:24 +00001283 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001284 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001285 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001286 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001287 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1288 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001289 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001290
David Blaikiea0a1a872015-01-18 02:48:07 +00001291 /// \brief Emit the unified return block, trying to avoid its emission when
1292 /// possible.
1293 /// \return The debug location of the user written return statement if the
1294 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001295 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001296
Mike Stumpfc496822009-02-08 23:14:22 +00001297 /// FinishFunction - Complete IR generation of the current function. It is
1298 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001299 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001300
Hans Wennborg88497d62013-11-15 17:24:45 +00001301 void StartThunk(llvm::Function *Fn, GlobalDecl GD, const CGFunctionInfo &FnInfo);
1302
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001303 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001304
Reid Klecknerab2090d2014-07-26 01:34:32 +00001305 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1306 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1307 llvm::Value *Callee);
1308
Anders Carlssonbad991d2010-03-24 00:39:18 +00001309 /// GenerateThunk - Generate a thunk for the given method.
John McCalla738c252011-03-09 04:27:21 +00001310 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1311 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001312
Eli Friedman49a94b12011-05-06 17:27:27 +00001313 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1314 GlobalDecl GD, const ThunkInfo &Thunk);
1315
Douglas Gregor94f9a482010-05-05 05:51:00 +00001316 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1317 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001318
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001319 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001320 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001321
Anders Carlssone87fae92010-03-28 19:40:00 +00001322 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1323 /// subobject.
1324 ///
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001325 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001326 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001327 CharUnits OffsetFromNearestVBase,
Anders Carlssone87fae92010-03-28 19:40:00 +00001328 const CXXRecordDecl *VTableClass);
1329
1330 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001331 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001332 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001333 CharUnits OffsetFromNearestVBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001334 bool BaseIsNonVirtualPrimaryBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001335 const CXXRecordDecl *VTableClass,
1336 VisitedVirtualBasesSetTy& VBases);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001337
Anders Carlssond5895932010-03-28 21:07:49 +00001338 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001339
Dan Gohman8fc50c22010-10-26 18:44:08 +00001340 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1341 /// to by This.
Chris Lattner2192fe52011-07-18 04:24:23 +00001342 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssone87fae92010-03-28 19:40:00 +00001343
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001344
1345 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1346 /// expr can be devirtualized.
1347 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1348 const CXXMethodDecl *MD);
1349
John McCallf99a6312010-07-21 05:30:47 +00001350 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1351 /// given phase of destruction for a destructor. The end result
1352 /// should call destructors on members and base classes in reverse
1353 /// order of their construction.
1354 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001355
Chris Lattner3c77a352010-06-22 00:03:40 +00001356 /// ShouldInstrumentFunction - Return true if the current function should be
1357 /// instrumented with __cyg_profile_func_* calls
1358 bool ShouldInstrumentFunction();
1359
1360 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1361 /// instrumentation function with the current function and the call site, if
1362 /// function instrumentation is enabled.
1363 void EmitFunctionInstrumentation(const char *Fn);
1364
Roman Divacky178e01602011-02-10 16:52:03 +00001365 /// EmitMCountInstrumentation - Emit call to .mcount.
1366 void EmitMCountInstrumentation();
1367
Mike Stumpfc496822009-02-08 23:14:22 +00001368 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1369 /// arguments for the given function. This is also responsible for naming the
1370 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001371 void EmitFunctionProlog(const CGFunctionInfo &FI,
1372 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001373 const FunctionArgList &Args);
1374
Mike Stumpfc496822009-02-08 23:14:22 +00001375 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1376 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001377 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1378 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001379
Mike Stump1d849212009-12-07 23:38:24 +00001380 /// EmitStartEHSpec - Emit the start of the exception spec.
1381 void EmitStartEHSpec(const Decl *D);
1382
1383 /// EmitEndEHSpec - Emit the end of the exception spec.
1384 void EmitEndEHSpec(const Decl *D);
1385
John McCallbd309292010-07-06 01:34:17 +00001386 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1387 llvm::BasicBlock *getTerminateLandingPad();
1388
1389 /// getTerminateHandler - Return a handler (not a landing pad, just
1390 /// a catch handler) that just calls terminate. This is used when
1391 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001392 llvm::BasicBlock *getTerminateHandler();
1393
Chris Lattnera5f58b02011-07-09 17:41:47 +00001394 llvm::Type *ConvertTypeForMem(QualType T);
1395 llvm::Type *ConvertType(QualType T);
1396 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001397 return ConvertType(getContext().getTypeDeclType(T));
1398 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001399
Mike Stumpfc496822009-02-08 23:14:22 +00001400 /// LoadObjCSelf - Load the value of self. This function is only valid while
1401 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001402 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001403
1404 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001405 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001406
Chris Lattner54fb19e2007-06-22 22:02:34 +00001407 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1408 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001409 static TypeEvaluationKind getEvaluationKind(QualType T);
1410
1411 static bool hasScalarEvaluationKind(QualType T) {
1412 return getEvaluationKind(T) == TEK_Scalar;
1413 }
1414
1415 static bool hasAggregateEvaluationKind(QualType T) {
1416 return getEvaluationKind(T) == TEK_Aggregate;
1417 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001418
1419 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001420 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001421 llvm::Function *parent = nullptr,
1422 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001423#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001424 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001425#else
John McCallad7c5c12011-02-08 08:22:06 +00001426 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001427#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001428 }
Mike Stumpfc496822009-02-08 23:14:22 +00001429
Chris Lattnerac248202007-05-30 00:13:02 +00001430 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1431 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001432 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001433
Mike Stumpe5311b02009-11-30 20:08:49 +00001434 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1435 /// another basic block, simplify it. This assumes that no other code could
1436 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001437 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1438
Mike Stumpfc496822009-02-08 23:14:22 +00001439 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1440 /// adding a fall-through branch from the current insert block if
1441 /// necessary. It is legal to call this function even if there is no current
1442 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001443 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001444 /// IsFinished - If true, indicates that the caller has finished emitting
1445 /// branches to the given block and does not expect to emit code into it. This
1446 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001447 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001448
John McCall8e4c74b2011-08-11 02:22:43 +00001449 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1450 /// near its uses, and leave the insertion point in it.
1451 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1452
Mike Stumpfc496822009-02-08 23:14:22 +00001453 /// EmitBranch - Emit a branch to the specified basic block from the current
1454 /// insert block, taking care to avoid creation of branches from dummy
1455 /// blocks. It is legal to call this function even if there is no current
1456 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001457 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001458 /// This function clears the current insertion point. The caller should follow
1459 /// calls to this function with calls to Emit*Block prior to generation new
1460 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001461 void EmitBranch(llvm::BasicBlock *Block);
1462
Mike Stumpfc496822009-02-08 23:14:22 +00001463 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1464 /// indicates that the current code being emitted is unreachable.
1465 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001466 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001467 }
1468
Mike Stumpfc496822009-02-08 23:14:22 +00001469 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1470 /// emitted IR has a place to go. Note that by definition, if this function
1471 /// creates a block then that block is unreachable; callers may do better to
1472 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001473 void EnsureInsertPoint() {
1474 if (!HaveInsertPoint())
1475 EmitBlock(createBasicBlock());
1476 }
Mike Stumpfc496822009-02-08 23:14:22 +00001477
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001478 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001479 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001480 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001481
Chris Lattnere9a64532007-06-22 21:44:33 +00001482 //===--------------------------------------------------------------------===//
1483 // Helpers
1484 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001485
Eli Friedmana0544d62011-12-03 04:14:32 +00001486 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1487 CharUnits Alignment = CharUnits()) {
Dan Gohman947c9af2010-10-14 23:06:10 +00001488 return LValue::MakeAddr(V, T, Alignment, getContext(),
1489 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001490 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001491
David Majnemer99281062014-09-18 22:05:54 +00001492 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001493
Chris Lattnere9a64532007-06-22 21:44:33 +00001494 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001495 /// block. The caller is responsible for setting an appropriate alignment on
1496 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001497 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001498 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001499
John McCall2e6567a2010-04-22 01:10:34 +00001500 /// InitTempAlloca - Provide an initial value for the given alloca.
1501 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1502
Daniel Dunbard0049182010-02-16 19:44:13 +00001503 /// CreateIRTemp - Create a temporary IR object of the given type, with
1504 /// appropriate alignment. This routine should only be used when an temporary
1505 /// value needs to be stored into an alloca (for example, to avoid explicit
1506 /// PHI construction), but the type is the IR type, not the type appropriate
1507 /// for storing in memory.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001508 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001509
Daniel Dunbara7566f12010-02-09 02:48:28 +00001510 /// CreateMemTemp - Create a temporary memory object of the given type, with
1511 /// appropriate alignment.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001512 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001513
John McCall7a626f62010-09-15 10:14:12 +00001514 /// CreateAggTemp - Create a temporary memory object for the given
1515 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001516 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedman38cd36d2011-12-03 02:13:40 +00001517 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001518 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1519 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001520 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001521 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001522 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001523 }
1524
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001525 /// CreateInAllocaTmp - Create a temporary memory object for the given
1526 /// aggregate type.
1527 AggValueSlot CreateInAllocaTmp(QualType T, const Twine &Name = "inalloca");
1528
John McCallad7c5c12011-02-08 08:22:06 +00001529 /// Emit a cast to void* in the appropriate address space.
1530 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1531
Chris Lattner8394d792007-06-05 20:53:16 +00001532 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1533 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001534 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001535
John McCalla2342eb2010-12-05 02:00:02 +00001536 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1537 void EmitIgnoredExpr(const Expr *E);
1538
Chris Lattner4647a212007-08-31 22:49:20 +00001539 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1540 /// any type. The result is returned as an RValue struct. If this is an
1541 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1542 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001543 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001544 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001545 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001546 AggValueSlot aggSlot = AggValueSlot::ignored(),
1547 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001548
Mike Stumpfc496822009-02-08 23:14:22 +00001549 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1550 // or the value of the expression, depending on how va_list is defined.
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001551 llvm::Value *EmitVAListRef(const Expr *E);
1552
Mike Stumpfc496822009-02-08 23:14:22 +00001553 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1554 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001555 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001556
John McCall91ca10f2011-03-08 09:11:50 +00001557 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001558 /// arbitrary expression into the given memory location.
John McCall21886962010-04-21 10:05:39 +00001559 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001560 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001561
John McCall91ca10f2011-03-08 09:11:50 +00001562 /// EmitExprAsInit - Emits the code necessary to initialize a
1563 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001564 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001565 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001566
Fariborz Jahanian78652202013-01-25 23:57:05 +00001567 /// hasVolatileMember - returns true if aggregate type has a volatile
1568 /// member.
1569 bool hasVolatileMember(QualType T) {
1570 if (const RecordType *RT = T->getAs<RecordType>()) {
1571 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1572 return RD->hasVolatileMember();
1573 }
1574 return false;
1575 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001576 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001577 ///
1578 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1579 /// This is required for correctness when assigning non-POD structures in C++.
1580 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001581 QualType EltTy) {
1582 bool IsVolatile = hasVolatileMember(EltTy);
1583 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1584 true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001585 }
1586
David Majnemerfd1e7392015-02-03 23:04:06 +00001587 void EmitAggregateCopyCtor(llvm::Value *DestPtr, llvm::Value *SrcPtr,
1588 QualType DestTy, QualType SrcTy) {
1589 CharUnits DestTypeAlign = getContext().getTypeAlignInChars(DestTy);
1590 CharUnits SrcTypeAlign = getContext().getTypeAlignInChars(SrcTy);
1591 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
1592 std::min(DestTypeAlign, SrcTypeAlign),
1593 /*IsAssignment=*/false);
1594 }
1595
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001596 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001597 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001598 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001599 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001600 /// \param isAssignment - If false, allow padding to be copied. This often
1601 /// yields more efficient.
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001602 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001603 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001604 CharUnits Alignment = CharUnits::Zero(),
1605 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001606
Devang Patelda5d6bb2007-10-04 23:45:31 +00001607 /// StartBlock - Start new block named N. If insert block is a dummy block
1608 /// then reuse it.
1609 void StartBlock(const char *N);
1610
Anders Carlsson9396a892008-09-11 09:15:33 +00001611 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall5d865c322010-08-31 07:33:07 +00001612 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1613 llvm::Value *Res = LocalDeclMap[VD];
1614 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1615 return Res;
1616 }
Mike Stumpfc496822009-02-08 23:14:22 +00001617
John McCallc07a0c72011-02-17 10:25:35 +00001618 /// getOpaqueLValueMapping - Given an opaque value expression (which
1619 /// must be mapped to an l-value), return its mapping.
1620 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1621 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1622
1623 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1624 it = OpaqueLValues.find(e);
1625 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1626 return it->second;
1627 }
1628
1629 /// getOpaqueRValueMapping - Given an opaque value expression (which
1630 /// must be mapped to an r-value), return its mapping.
1631 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1632 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1633
1634 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1635 it = OpaqueRValues.find(e);
1636 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001637 return it->second;
1638 }
1639
Dan Gohman75d69da2008-05-22 00:50:06 +00001640 /// getAccessedFieldNo - Given an encoded value and a result number, return
1641 /// the input field number being accessed.
1642 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1643
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001644 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001645 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001646
Anders Carlssonc0964b62010-05-22 17:35:42 +00001647 /// EmitNullInitialization - Generate code to set a value of the given type to
1648 /// null, If the type contains data member pointers, they will be initialized
1649 /// to -1 in accordance with the Itanium C++ ABI.
1650 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001651
1652 // EmitVAArg - Generate code to get an argument from the passed in pointer
1653 // and update it accordingly. The return value is a pointer to the argument.
1654 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001655 // instruction in LLVM instead once it works well enough.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001656 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001657
John McCall82fe67b2011-07-09 01:37:26 +00001658 /// emitArrayLength - Compute the length of an array, even if it's a
1659 /// VLA, and drill down to the base element type.
1660 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1661 QualType &baseType,
1662 llvm::Value *&addr);
1663
John McCall23c29fe2011-06-24 21:55:10 +00001664 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1665 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001666 ///
1667 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001668 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001669
John McCall23c29fe2011-06-24 21:55:10 +00001670 /// getVLASize - Returns an LLVM value that corresponds to the size,
1671 /// in non-variably-sized elements, of a variable length array type,
1672 /// plus that largest non-variably-sized element type. Assumes that
1673 /// the type has already been emitted with EmitVariablyModifiedType.
1674 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1675 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001676
Anders Carlssona5d077d2009-04-14 16:58:56 +00001677 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1678 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001679 llvm::Value *LoadCXXThis() {
1680 assert(CXXThisValue && "no 'this' value for this function");
1681 return CXXThisValue;
1682 }
Mike Stump11289f42009-09-09 15:08:12 +00001683
Anders Carlssone36a6b32010-01-02 01:01:18 +00001684 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1685 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001686 // FIXME: Every place that calls LoadCXXVTT is something
1687 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001688 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001689 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1690 return CXXStructorImplicitParamValue;
1691 }
1692
1693 /// LoadCXXStructorImplicitParam - Load the implicit parameter
1694 /// for a constructor/destructor.
1695 llvm::Value *LoadCXXStructorImplicitParam() {
1696 assert(CXXStructorImplicitParamValue &&
1697 "no implicit argument value for this function");
1698 return CXXStructorImplicitParamValue;
John McCall347132b2010-02-16 22:04:33 +00001699 }
John McCall6ce74722010-02-16 04:15:37 +00001700
1701 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001702 /// complete class to the given direct base.
1703 llvm::Value *
1704 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1705 const CXXRecordDecl *Derived,
1706 const CXXRecordDecl *Base,
1707 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001708
Mike Stumpe5311b02009-11-30 20:08:49 +00001709 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1710 /// load of 'this' and returns address of the base class.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001711 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001712 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001713 CastExpr::path_const_iterator PathBegin,
1714 CastExpr::path_const_iterator PathEnd,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001715 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001716
Anders Carlsson8c793172009-11-23 17:57:54 +00001717 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001718 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001719 CastExpr::path_const_iterator PathBegin,
1720 CastExpr::path_const_iterator PathEnd,
Anders Carlsson8c793172009-11-23 17:57:54 +00001721 bool NullCheckValue);
1722
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001723 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1724 /// base constructor/destructor with virtual bases.
1725 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1726 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1727 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1728 bool Delegating);
1729
John McCallf8ff7b92010-02-23 00:48:20 +00001730 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1731 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001732 const FunctionArgList &Args,
1733 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001734 // It's important not to confuse this and the previous function. Delegating
1735 // constructors are the C++0x feature. The constructor delegate optimization
1736 // is used to reduce duplication in the base and complete consturctors where
1737 // they are substantially the same.
1738 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1739 const FunctionArgList &Args);
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001740 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001741 bool ForVirtualBase, bool Delegating,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001742 llvm::Value *This, const CXXConstructExpr *E);
1743
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001744 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1745 llvm::Value *This, llvm::Value *Src,
Alexey Samsonov525bf652014-08-25 21:58:56 +00001746 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001747
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001748 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001749 const ConstantArrayType *ArrayTy,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001750 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001751 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001752 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001753
Anders Carlssond49844b2009-09-23 02:45:36 +00001754 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1755 llvm::Value *NumElements,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001756 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001757 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001758 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001759
John McCall82fe67b2011-07-09 01:37:26 +00001760 static Destroyer destroyCXXObject;
1761
Anders Carlsson0a637412009-05-29 21:03:38 +00001762 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001763 bool ForVirtualBase, bool Delegating,
1764 llvm::Value *This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001765
John McCall99210dc2011-09-15 06:49:18 +00001766 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
Richard Smith06a67e22014-06-03 06:58:52 +00001767 llvm::Value *NewPtr, llvm::Value *NumElements,
1768 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00001769
Peter Collingbourne702b2842011-11-27 22:09:22 +00001770 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1771 llvm::Value *Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001772
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001773 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001774 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001775
Eli Friedman24f55432009-11-18 00:57:03 +00001776 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1777 QualType DeleteTy);
1778
Richard Smith760520b2014-06-03 23:27:44 +00001779 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1780 const Expr *Arg, bool IsDelete);
1781
Mike Stumpc9b231c2009-11-15 08:09:41 +00001782 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stump65511702009-11-16 06:50:58 +00001783 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Nico Webercf4ff5862012-10-11 10:13:44 +00001784 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001785
Richard Smith69d0d262012-08-24 00:54:33 +00001786 /// \brief Situations in which we might emit a check for the suitability of a
1787 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001788 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001789 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001790 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001791 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001792 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001793 /// Checking the bound value in a reference binding. Must be suitably sized
1794 /// and aligned, but is not required to refer to an object (until the
1795 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001796 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001797 /// Checking the object expression in a non-static data member access. Must
1798 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001799 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001800 /// Checking the 'this' pointer for a call to a non-static member function.
1801 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001802 TCK_MemberCall,
1803 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001804 TCK_ConstructorCall,
1805 /// Checking the operand of a static_cast to a derived pointer type. Must be
1806 /// null or an object within its lifetime.
1807 TCK_DowncastPointer,
1808 /// Checking the operand of a static_cast to a derived reference type. Must
1809 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001810 TCK_DowncastReference,
1811 /// Checking the operand of a cast to a base object. Must be suitably sized
1812 /// and aligned.
1813 TCK_Upcast,
1814 /// Checking the operand of a cast to a virtual base object. Must be an
1815 /// object within its lifetime.
1816 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00001817 };
1818
Alexey Samsonovac4afe42014-07-07 23:59:57 +00001819 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
1820 /// calls to EmitTypeCheck can be skipped.
1821 bool sanitizePerformTypeCheck() const;
1822
Richard Smith4d1458e2012-09-08 02:08:36 +00001823 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001824 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001825 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001826 QualType Type, CharUnits Alignment = CharUnits::Zero(),
1827 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001828
Richard Smith539e4a72013-02-23 02:53:19 +00001829 /// \brief Emit a check that \p Base points into an array object, which
1830 /// we can access at index \p Index. \p Accessed should be \c false if we
1831 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1832 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1833 QualType IndexType, bool Accessed);
1834
Chris Lattner116ce8f2010-01-09 21:40:03 +00001835 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1836 bool isInc, bool isPre);
1837 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1838 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00001839
1840 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00001841 llvm::Value *OffsetValue = nullptr) {
1842 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
1843 OffsetValue);
1844 }
Hal Finkelbcc06082014-09-07 22:58:14 +00001845
Chris Lattner8394d792007-06-05 20:53:16 +00001846 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001847 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001848 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001849
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001850 /// EmitDecl - Emit a declaration.
1851 ///
1852 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001853 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001854
John McCall1c9c3fd2010-10-15 04:57:14 +00001855 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001856 ///
1857 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001858 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001859
David Blaikie73ca5692014-12-09 00:32:22 +00001860 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001861 bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00001862 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001863
John McCallbd309292010-07-06 01:34:17 +00001864 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1865 llvm::Value *Address);
1866
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001867 /// \brief Determine whether the given initializer is trivial in the sense
1868 /// that it requires no code to be generated.
1869 bool isTrivialInitializer(const Expr *Init);
1870
John McCall1c9c3fd2010-10-15 04:57:14 +00001871 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001872 ///
1873 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00001874 void EmitAutoVarDecl(const VarDecl &D);
1875
1876 class AutoVarEmission {
1877 friend class CodeGenFunction;
1878
John McCall9e2e22f2011-02-22 07:16:58 +00001879 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00001880
1881 /// The alignment of the variable.
1882 CharUnits Alignment;
1883
1884 /// The address of the alloca. Null if the variable was emitted
1885 /// as a global constant.
1886 llvm::Value *Address;
1887
1888 llvm::Value *NRVOFlag;
1889
1890 /// True if the variable is a __block variable.
1891 bool IsByRef;
1892
1893 /// True if the variable is of aggregate type and has a constant
1894 /// initializer.
1895 bool IsConstantAggregate;
1896
Nadav Rotem1da30942013-03-23 06:43:35 +00001897 /// Non-null if we should use lifetime annotations.
1898 llvm::Value *SizeForLifetimeMarkers;
1899
John McCall9e2e22f2011-02-22 07:16:58 +00001900 struct Invalid {};
Craig Topper8a13c412014-05-21 05:09:00 +00001901 AutoVarEmission(Invalid) : Variable(nullptr) {}
John McCall9e2e22f2011-02-22 07:16:58 +00001902
John McCallc533cb72011-02-22 06:44:22 +00001903 AutoVarEmission(const VarDecl &variable)
Craig Topper8a13c412014-05-21 05:09:00 +00001904 : Variable(&variable), Address(nullptr), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00001905 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00001906 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00001907
Craig Topper8a13c412014-05-21 05:09:00 +00001908 bool wasEmittedAsGlobal() const { return Address == nullptr; }
John McCallc533cb72011-02-22 06:44:22 +00001909
1910 public:
John McCall9e2e22f2011-02-22 07:16:58 +00001911 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1912
Craig Topper8a13c412014-05-21 05:09:00 +00001913 bool useLifetimeMarkers() const {
1914 return SizeForLifetimeMarkers != nullptr;
1915 }
Nadav Rotem1da30942013-03-23 06:43:35 +00001916 llvm::Value *getSizeForLifetimeMarkers() const {
1917 assert(useLifetimeMarkers());
1918 return SizeForLifetimeMarkers;
1919 }
1920
1921 /// Returns the raw, allocated address, which is not necessarily
1922 /// the address of the object itself.
1923 llvm::Value *getAllocatedAddress() const {
1924 return Address;
1925 }
1926
John McCallc533cb72011-02-22 06:44:22 +00001927 /// Returns the address of the object within this declaration.
1928 /// Note that this does not chase the forwarding pointer for
1929 /// __block decls.
1930 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1931 if (!IsByRef) return Address;
1932
1933 return CGF.Builder.CreateStructGEP(Address,
John McCall9e2e22f2011-02-22 07:16:58 +00001934 CGF.getByRefValueLLVMField(Variable),
1935 Variable->getNameAsString());
John McCallc533cb72011-02-22 06:44:22 +00001936 }
1937 };
1938 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1939 void EmitAutoVarInit(const AutoVarEmission &emission);
1940 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00001941 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1942 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001943
John McCall1c9c3fd2010-10-15 04:57:14 +00001944 void EmitStaticVarDecl(const VarDecl &D,
1945 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001946
1947 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001948 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, bool ArgIsPointer,
1949 unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00001950
John McCallc07a0c72011-02-17 10:25:35 +00001951 /// protectFromPeepholes - Protect a value that we're intending to
1952 /// store to the side, but which will probably be used later, from
1953 /// aggressive peepholing optimizations that might delete it.
1954 ///
1955 /// Pass the result to unprotectFromPeepholes to declare that
1956 /// protection is no longer required.
1957 ///
1958 /// There's no particular reason why this shouldn't apply to
1959 /// l-values, it's just that no existing peepholes work on pointers.
1960 PeepholeProtection protectFromPeepholes(RValue rvalue);
1961 void unprotectFromPeepholes(PeepholeProtection protection);
1962
Chris Lattner84915fa2007-06-02 04:16:21 +00001963 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00001964 // Statement Emission
1965 //===--------------------------------------------------------------------===//
1966
Mike Stumpfc496822009-02-08 23:14:22 +00001967 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001968 void EmitStopPoint(const Stmt *S);
1969
Mike Stumpfc496822009-02-08 23:14:22 +00001970 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1971 /// this function even if there is no current insertion point.
1972 ///
1973 /// This function may clear the current insertion point; callers should use
1974 /// EnsureInsertPoint if they wish to subsequently generate code without first
1975 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00001976 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001977
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001978 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00001979 /// necessarily require an insertion point or debug information; typically
1980 /// because the statement amounts to a jump or a container of other
1981 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001982 ///
1983 /// \return True if the statement was handled.
1984 bool EmitSimpleStmt(const Stmt *S);
1985
Eli Friedman4871a462013-06-10 22:04:49 +00001986 llvm::Value *EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
1987 AggValueSlot AVS = AggValueSlot::ignored());
1988 llvm::Value *EmitCompoundStmtWithoutScope(const CompoundStmt &S,
1989 bool GetLast = false,
1990 AggValueSlot AVS =
1991 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001992
Mike Stumpfc496822009-02-08 23:14:22 +00001993 /// EmitLabel - Emit the block for the given label. It is legal to call this
1994 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001995 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001996
Chris Lattnerac248202007-05-30 00:13:02 +00001997 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00001998 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00001999 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002000 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002001 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002002
2003 void EmitCondBrHints(llvm::LLVMContext &Context, llvm::BranchInst *CondBr,
Craig Topper3cb91b22014-08-27 06:28:16 +00002004 ArrayRef<const Attr *> Attrs);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002005 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002006 ArrayRef<const Attr *> Attrs = None);
2007 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002008 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002009 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002010 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002011 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002012 void EmitBreakStmt(const BreakStmt &S);
2013 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002014 void EmitSwitchStmt(const SwitchStmt &S);
2015 void EmitDefaultStmt(const DefaultStmt &S);
2016 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002017 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002018 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002019
Anders Carlsson2e744e82008-08-30 19:51:14 +00002020 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002021 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2022 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002023 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002024 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002025
John McCallb609d3f2010-07-07 06:56:46 +00002026 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2027 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002028
Anders Carlsson52d78a52009-09-27 18:58:34 +00002029 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002030 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002031 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Kleckneraca01db2015-02-04 22:37:07 +00002032 void EnterSEHTryStmt(const SEHTryStmt &S, SEHFinallyInfo &FI);
2033 void ExitSEHTryStmt(const SEHTryStmt &S, SEHFinallyInfo &FI);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002034
2035 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2036 const SEHExceptStmt &Except);
2037
2038 void EmitSEHExceptionCodeSave();
2039 llvm::Value *EmitSEHExceptionCode();
2040 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002041 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002042
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002043 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002044 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002045
Alexey Bataev330de032014-10-29 12:21:55 +00002046 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002047 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002048 void GenerateCapturedStmtFunctionProlog(const CapturedStmt &S);
2049 llvm::Function *GenerateCapturedStmtFunctionEpilog(const CapturedStmt &S);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002050 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev9959db52014-05-06 10:08:46 +00002051 llvm::Value *GenerateCapturedStmtArgument(const CapturedStmt &S);
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002052 void EmitOMPAggregateAssign(LValue OriginalAddr, llvm::Value *PrivateAddr,
2053 const Expr *AssignExpr, QualType Type,
2054 const VarDecl *VDInit);
2055 void EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002056 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002057 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2058 OMPPrivateScope &PrivateScope);
Alexey Bataev9959db52014-05-06 10:08:46 +00002059
2060 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002061 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002062 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002063 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002064 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002065 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002066 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002067 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002068 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002069 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002070 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002071 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002072 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002073 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002074 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002075 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002076 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002077 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002078 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002079 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002080 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002081
Alexander Musmanc6388682014-12-15 07:07:06 +00002082private:
2083
2084 /// Helpers for the OpenMP loop directives.
Alexander Musmand196ef22014-10-07 08:57:09 +00002085 void EmitOMPLoopBody(const OMPLoopDirective &Directive,
2086 bool SeparateIter = false);
2087 void EmitOMPInnerLoop(const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
2088 bool SeparateIter = false);
Alexander Musmana5f070a2014-10-01 06:03:56 +00002089 void EmitOMPSimdFinal(const OMPLoopDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002090 void EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Alexander Musmandf7a8e22015-01-22 08:49:35 +00002091 void EmitOMPForOuterLoop(OpenMPScheduleClauseKind ScheduleKind,
2092 const OMPLoopDirective &S,
2093 OMPPrivateScope &LoopScope, llvm::Value *LB,
2094 llvm::Value *UB, llvm::Value *ST, llvm::Value *IL,
2095 llvm::Value *Chunk);
Alexander Musmanc6388682014-12-15 07:07:06 +00002096
2097public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002098
Chris Lattner208ae962007-05-30 17:57:17 +00002099 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002100 // LValue Expression Emission
2101 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002102
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002103 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2104 RValue GetUndefRValue(QualType Ty);
2105
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002106 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2107 /// and issue an ErrorUnsupported style diagnostic (using the
2108 /// provided Name).
2109 RValue EmitUnsupportedRValue(const Expr *E,
2110 const char *Name);
2111
Mike Stumpfc496822009-02-08 23:14:22 +00002112 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2113 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002114 LValue EmitUnsupportedLValue(const Expr *E,
2115 const char *Name);
2116
Chris Lattner8394d792007-06-05 20:53:16 +00002117 /// EmitLValue - Emit code to compute a designator that specifies the location
2118 /// of the expression.
2119 ///
2120 /// This can return one of two things: a simple address or a bitfield
2121 /// reference. In either case, the LLVM Value* in the LValue structure is
2122 /// guaranteed to be an LLVM pointer type.
2123 ///
2124 /// If this returns a bitfield reference, nothing about the pointee type of
2125 /// the LLVM value is known: For example, it may not be a pointer to an
2126 /// integer.
2127 ///
2128 /// If this returns a normal address, and if the lvalue's C type is fixed
2129 /// size, this method guarantees that the returned pointer type will point to
2130 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2131 /// variable length type, this is not possible.
2132 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002133 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002134
Richard Smith4d1458e2012-09-08 02:08:36 +00002135 /// \brief Same as EmitLValue but additionally we generate checking code to
2136 /// guard against undefined behavior. This is only suitable when we know
2137 /// that the address will be used to access the object.
2138 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002139
Nick Lewycky2d84e842013-10-02 02:29:49 +00002140 RValue convertTempToRValue(llvm::Value *addr, QualType type,
2141 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002142
John McCalla8ec7eb2013-03-07 21:37:17 +00002143 void EmitAtomicInit(Expr *E, LValue lvalue);
2144
Nick Lewycky2d84e842013-10-02 02:29:49 +00002145 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
John McCalla8ec7eb2013-03-07 21:37:17 +00002146 AggValueSlot slot = AggValueSlot::ignored());
2147
2148 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2149
Alexey Bataev452d8e12014-12-15 05:25:25 +00002150 std::pair<RValue, RValue> EmitAtomicCompareExchange(
2151 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
2152 llvm::AtomicOrdering Success = llvm::SequentiallyConsistent,
2153 llvm::AtomicOrdering Failure = llvm::SequentiallyConsistent,
2154 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2155
John McCall3a7f6922010-10-27 20:58:56 +00002156 /// EmitToMemory - Change a scalar value from its value
2157 /// representation to its in-memory representation.
2158 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2159
2160 /// EmitFromMemory - Change a scalar value from its memory
2161 /// representation to its value representation.
2162 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2163
Daniel Dunbar1d425462009-02-10 00:57:50 +00002164 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2165 /// care to appropriately convert from the memory representation to
2166 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002167 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman947c9af2010-10-14 23:06:10 +00002168 unsigned Alignment, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002169 SourceLocation Loc,
Craig Topper8a13c412014-05-21 05:09:00 +00002170 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002171 QualType TBAABaseTy = QualType(),
2172 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002173
2174 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2175 /// care to appropriately convert from the memory representation to
2176 /// the LLVM value representation. The l-value must be a simple
2177 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002178 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002179
2180 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2181 /// care to appropriately convert from the memory representation to
2182 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002183 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman947c9af2010-10-14 23:06:10 +00002184 bool Volatile, unsigned Alignment, QualType Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00002185 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002186 QualType TBAABaseTy = QualType(),
2187 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002188
2189 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2190 /// care to appropriately convert from the memory representation to
2191 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002192 /// l-value. The isInit flag indicates whether this is an initialization.
2193 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2194 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002195
Chris Lattner8394d792007-06-05 20:53:16 +00002196 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2197 /// this method emits the address of the lvalue, then loads the result as an
2198 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002199 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002200 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2201 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002202 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002203
Chris Lattner8394d792007-06-05 20:53:16 +00002204 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2205 /// lvalue, where both are guaranteed to the have the same type, and that type
2206 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002207 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002208 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002209 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002210
Nick Lewycky2d84e842013-10-02 02:29:49 +00002211 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2212 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002213 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002214 /// \param Result [out] - If non-null, this will be set to a Value* for the
2215 /// bit-field contents after the store, appropriate for use as the result of
2216 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002217 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002218 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002219
John McCall4f29b492010-11-16 23:07:28 +00002220 /// Emit an l-value for an assignment (simple or compound) of complex type.
2221 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002222 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Eli Friedmanf0450072013-06-12 01:40:06 +00002223 LValue EmitScalarCompooundAssignWithComplex(const CompoundAssignOperator *E,
2224 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002225
Chris Lattner57540c52011-04-15 05:22:18 +00002226 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002227 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002228 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002229 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002230 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002231 // Note: only available for agg return types
2232 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002233 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Renato Golin230c5eb2014-05-19 18:15:42 +00002234 LValue EmitReadRegister(const VarDecl *VD);
Chris Lattner4347e3692007-06-06 04:54:52 +00002235 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002236 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002237 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002238 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002239 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2240 bool Accessed = false);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002241 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002242 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002243 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002244 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002245 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002246 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002247 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002248 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002249 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002250
2251 llvm::Value *EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002252
Nick Lewycky2d84e842013-10-02 02:29:49 +00002253 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002254
John McCall71335052012-03-10 03:05:10 +00002255 class ConstantEmission {
2256 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2257 ConstantEmission(llvm::Constant *C, bool isReference)
2258 : ValueAndIsReference(C, isReference) {}
2259 public:
2260 ConstantEmission() {}
2261 static ConstantEmission forReference(llvm::Constant *C) {
2262 return ConstantEmission(C, true);
2263 }
2264 static ConstantEmission forValue(llvm::Constant *C) {
2265 return ConstantEmission(C, false);
2266 }
2267
Craig Topper8a13c412014-05-21 05:09:00 +00002268 LLVM_EXPLICIT operator bool() const {
2269 return ValueAndIsReference.getOpaqueValue() != nullptr;
2270 }
John McCall71335052012-03-10 03:05:10 +00002271
2272 bool isReference() const { return ValueAndIsReference.getInt(); }
2273 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2274 assert(isReference());
2275 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2276 refExpr->getType());
2277 }
2278
2279 llvm::Constant *getValue() const {
2280 assert(!isReference());
2281 return ValueAndIsReference.getPointer();
2282 }
2283 };
2284
John McCall113bee02012-03-10 09:33:50 +00002285 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002286
John McCallfe96e0b2011-11-06 09:01:30 +00002287 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2288 AggValueSlot slot = AggValueSlot::ignored());
2289 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2290
Daniel Dunbar722f4242009-04-22 05:08:15 +00002291 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002292 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002293 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002294 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002295
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002296 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2297 /// if the Field is a reference, this will return the address of the reference
2298 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002299 LValue EmitLValueForFieldInitialization(LValue Base,
2300 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002301
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002302 LValue EmitLValueForIvar(QualType ObjectTy,
2303 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002304 unsigned CVRQualifiers);
2305
Anders Carlsson3be22e22009-05-30 23:23:33 +00002306 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002307 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002308 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002309 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002310 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002311
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002312 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002313 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002314 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002315 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002316 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002317 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002318
Chris Lattnerd7f58862007-06-02 05:24:33 +00002319 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002320 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002321 //===--------------------------------------------------------------------===//
2322
Mike Stumpfc496822009-02-08 23:14:22 +00002323 /// EmitCall - Generate a call of the given function, expecting the given
2324 /// result type, and using the given argument list which specifies both the
2325 /// LLVM arguments and the types they were derived from.
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002326 ///
Mike Stumpe5311b02009-11-30 20:08:49 +00002327 /// \param TargetDecl - If given, the decl of the function in a direct call;
2328 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbard931a872009-02-02 22:03:45 +00002329 RValue EmitCall(const CGFunctionInfo &FnInfo,
2330 llvm::Value *Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00002331 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002332 const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00002333 const Decl *TargetDecl = nullptr,
2334 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002335
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002336 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002337 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00002338 const Decl *TargetDecl = nullptr,
2339 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002340 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002341 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002342
John McCall882987f2013-02-28 19:01:20 +00002343 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2344 const Twine &name = "");
2345 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2346 ArrayRef<llvm::Value*> args,
2347 const Twine &name = "");
2348 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2349 const Twine &name = "");
2350 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2351 ArrayRef<llvm::Value*> args,
2352 const Twine &name = "");
2353
John McCallbd309292010-07-06 01:34:17 +00002354 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002355 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002356 const Twine &Name = "");
Jay Foad5bd375a2011-07-15 08:37:34 +00002357 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002358 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002359 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2360 ArrayRef<llvm::Value*> args,
2361 const Twine &name = "");
2362 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2363 const Twine &name = "");
2364 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2365 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002366
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002367 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2368 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002369 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002370
2371 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2372 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002373 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002374
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002375 RValue
2376 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2377 ReturnValueSlot ReturnValue, llvm::Value *This,
2378 llvm::Value *ImplicitParam,
2379 QualType ImplicitParamTy, const CallExpr *E);
David Majnemer0c0b6d92014-10-31 20:09:12 +00002380 RValue EmitCXXStructorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2381 ReturnValueSlot ReturnValue, llvm::Value *This,
2382 llvm::Value *ImplicitParam,
2383 QualType ImplicitParamTy, const CallExpr *E,
2384 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002385 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2386 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002387 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2388 const CXXMethodDecl *MD,
2389 ReturnValueSlot ReturnValue,
2390 bool HasQualifier,
2391 NestedNameSpecifier *Qualifier,
2392 bool IsArrow, const Expr *Base);
2393 // Compute the object pointer.
Anders Carlssonbfb36712009-12-24 21:13:40 +00002394 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2395 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002396
Anders Carlsson4034a952009-05-27 04:18:27 +00002397 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002398 const CXXMethodDecl *MD,
2399 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002400
Peter Collingbournefe883422011-10-06 18:29:37 +00002401 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2402 ReturnValueSlot ReturnValue);
2403
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002404
Mike Stump11289f42009-09-09 15:08:12 +00002405 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002406 unsigned BuiltinID, const CallExpr *E,
2407 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002408
Anders Carlssonbfb36712009-12-24 21:13:40 +00002409 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002410
Mike Stumpfc496822009-02-08 23:14:22 +00002411 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2412 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002413 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2414
Kevin Qin1718af62013-11-14 02:45:18 +00002415 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2416 const llvm::CmpInst::Predicate Fp,
2417 const llvm::CmpInst::Predicate Ip,
2418 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002419 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002420
2421 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2422 unsigned LLVMIntrinsic,
2423 unsigned AltLLVMIntrinsic,
2424 const char *NameHint,
2425 unsigned Modifier,
2426 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002427 SmallVectorImpl<llvm::Value *> &Ops,
Craig Topper8a13c412014-05-21 05:09:00 +00002428 llvm::Value *Align = nullptr);
Tim Northover8fe03d62014-02-21 11:57:24 +00002429 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2430 unsigned Modifier, llvm::Type *ArgTy,
2431 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002432 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002433 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002434 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002435 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002436 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002437 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002438 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002439 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2440 llvm::Type *Ty, bool usgn, const char *name);
Tim Northover573cbee2014-05-24 12:52:07 +00002441 // Helper functions for EmitAArch64BuiltinExpr.
Tim Northovera2ee4332014-03-29 15:09:45 +00002442 llvm::Value *vectorWrapScalar8(llvm::Value *Op);
2443 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
2444 llvm::Value *emitVectorWrappedScalar8Intrinsic(
2445 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
2446 llvm::Value *emitVectorWrappedScalar16Intrinsic(
2447 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
Tim Northover573cbee2014-05-24 12:52:07 +00002448 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northovera2ee4332014-03-29 15:09:45 +00002449 llvm::Value *EmitNeon64Call(llvm::Function *F,
2450 llvm::SmallVectorImpl<llvm::Value *> &O,
2451 const char *name);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002452
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002453 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002454 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2455 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault56f008d2014-06-24 20:45:01 +00002456 llvm::Value *EmitR600BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002457
Daniel Dunbar66912a12008-08-20 00:28:19 +00002458 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002459 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002460 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002461 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2462 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2463 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002464 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002465 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002466 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2467 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002468
John McCall31168b02011-06-15 23:02:42 +00002469 /// Retrieves the default cleanup kind for an ARC cleanup.
2470 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2471 CleanupKind getARCCleanupKind() {
2472 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2473 ? NormalAndEHCleanup : NormalCleanup;
2474 }
2475
2476 // ARC primitives.
2477 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2478 void EmitARCDestroyWeak(llvm::Value *addr);
2479 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2480 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2481 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2482 bool ignored);
2483 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2484 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2485 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2486 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002487 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002488 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002489 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002490 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002491 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2492 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002493 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCallcdda29c2013-03-13 03:10:54 +00002494 void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise);
2495 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCall31168b02011-06-15 23:02:42 +00002496 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2497 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2498 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2499 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2500
2501 std::pair<LValue,llvm::Value*>
2502 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2503 std::pair<LValue,llvm::Value*>
2504 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2505
John McCall248512a2011-10-01 10:32:24 +00002506 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2507
John McCall31168b02011-06-15 23:02:42 +00002508 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2509 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2510 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2511
John McCallff613032011-10-04 06:23:45 +00002512 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002513 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2514 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2515
Craig Topper00bbdcf2014-06-28 23:22:23 +00002516 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002517
John McCall82fe67b2011-07-09 01:37:26 +00002518 static Destroyer destroyARCStrongImprecise;
2519 static Destroyer destroyARCStrongPrecise;
2520 static Destroyer destroyARCWeak;
2521
John McCall31168b02011-06-15 23:02:42 +00002522 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2523 llvm::Value *EmitObjCAutoreleasePoolPush();
2524 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2525 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2526 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2527
Richard Smitha1c9d4d2013-06-12 23:38:09 +00002528 /// \brief Emits a reference binding to the passed in expression.
2529 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002530
Chris Lattner6278e6a2007-08-11 00:04:45 +00002531 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002532 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002533 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002534
2535 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002536
2537 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2538 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002539 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002540
Chris Lattner3474c202007-08-26 06:48:56 +00002541 /// EmitScalarConversion - Emit a conversion from the specified type to the
2542 /// specified destination type, both of which are LLVM scalar types.
2543 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2544 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002545
Chris Lattner42e6b812007-08-26 16:34:22 +00002546 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stumpfc496822009-02-08 23:14:22 +00002547 /// complex type to the specified destination type, where the destination type
2548 /// is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002549 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2550 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002551
2552
John McCall7a626f62010-09-15 10:14:12 +00002553 /// EmitAggExpr - Emit the computation of the specified expression
2554 /// of aggregate type. The result is computed into the given slot,
2555 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002556 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002557
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002558 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2559 /// aggregate type into a temporary LValue.
2560 LValue EmitAggExprToLValue(const Expr *E);
2561
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002562 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2563 /// pointers.
2564 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian879d7262009-08-31 19:33:16 +00002565 QualType Ty);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002566
John McCall1bd25562011-06-24 23:21:27 +00002567 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2568 /// make sure it survives garbage collection until this point.
2569 void EmitExtendGCLifetime(llvm::Value *object);
2570
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002571 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002572 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002573 ComplexPairTy EmitComplexExpr(const Expr *E,
2574 bool IgnoreReal = false,
2575 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002576
John McCall47fb9502013-03-07 21:37:08 +00002577 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2578 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002579 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002580
John McCall47fb9502013-03-07 21:37:08 +00002581 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002582 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00002583
2584 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002585 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002586
Chandler Carruth84537952012-03-30 19:44:53 +00002587 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2588 /// global variable that has already been created for it. If the initializer
2589 /// has a different type than GV does, this may free GV and return a different
2590 /// one. Otherwise it just returns GV.
2591 llvm::GlobalVariable *
2592 AddInitializerToStaticVarDecl(const VarDecl &D,
2593 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002594
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002595
Anders Carlssonf40886a2009-08-08 21:45:14 +00002596 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2597 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002598 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2599 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002600
David Majnemerb3341ea2014-10-05 05:05:40 +00002601 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
2602 llvm::Constant *Addr);
2603
John McCallc84ed6a2012-05-01 06:13:13 +00002604 /// Call atexit() with a function that passes the given argument to
2605 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00002606 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2607 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002608
John McCallcdf7ef52010-11-06 09:44:32 +00002609 /// Emit code in this function to perform a guarded variable
2610 /// initialization. Guarded initializations are used when it's not
2611 /// possible to prove that an initialization will be done exactly
2612 /// once, e.g. with a static local variable or a static data member
2613 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002614 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002615 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002616
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002617 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2618 /// variables.
2619 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00002620 ArrayRef<llvm::Function *> CXXThreadLocals,
Craig Topper8a13c412014-05-21 05:09:00 +00002621 llvm::GlobalVariable *Guard = nullptr);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002622
John McCallee08c532012-04-06 18:21:03 +00002623 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002624 /// variables.
John McCallee08c532012-04-06 18:21:03 +00002625 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2626 const std::vector<std::pair<llvm::WeakVH,
2627 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002628
John McCalla738c252011-03-09 04:27:21 +00002629 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2630 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00002631 llvm::GlobalVariable *Addr,
2632 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002633
John McCall7a626f62010-09-15 10:14:12 +00002634 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002635
2636 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian50198092010-12-02 17:02:11 +00002637 const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00002638
John McCall08ef4662011-11-10 08:15:53 +00002639 void enterFullExpression(const ExprWithCleanups *E) {
2640 if (E->getNumObjects() == 0) return;
2641 enterNonTrivialFullExpression(E);
2642 }
2643 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00002644
Richard Smithea852322013-05-07 21:53:22 +00002645 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00002646
Eli Friedmanc370a7e2012-02-09 03:32:31 +00002647 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2648
Craig Topper8a13c412014-05-21 05:09:00 +00002649 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = nullptr);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00002650
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002651 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002652 // Annotations Emission
2653 //===--------------------------------------------------------------------===//
2654
2655 /// Emit an annotation call (intrinsic or builtin).
2656 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2657 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002658 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002659 SourceLocation Location);
2660
2661 /// Emit local annotations for the local variable V, declared by D.
2662 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2663
2664 /// Emit field annotations for the given field & value. Returns the
2665 /// annotation result.
2666 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2667
2668 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002669 // Internal Helpers
2670 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002671
Chris Lattner5b1964b2008-11-11 07:41:27 +00002672 /// ContainsLabel - Return true if the statement contains a label in it. If
2673 /// this statement is not executed normally, it not containing a label means
2674 /// that we can just remove the code.
2675 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002676
Chris Lattner29911cc2011-02-28 00:18:40 +00002677 /// containsBreak - Return true if the statement contains a break out of it.
2678 /// If the statement (recursively) contains a switch or loop with a break
2679 /// inside of it, this is fine.
2680 static bool containsBreak(const Stmt *S);
2681
Daniel Dunbar682712c2008-11-12 10:12:14 +00002682 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00002683 /// to a constant, or if it does but contains a label, return false. If it
2684 /// constant folds return true and set the boolean result in Result.
2685 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00002686
Chris Lattner29911cc2011-02-28 00:18:40 +00002687 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2688 /// to a constant, or if it does but contains a label, return false. If it
2689 /// constant folds return true and set the folded value.
Richard Trieuc320c742012-07-23 20:21:35 +00002690 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattner29911cc2011-02-28 00:18:40 +00002691
Chris Lattnercd439292008-11-12 08:04:58 +00002692 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2693 /// if statement) to the specified blocks. Based on the condition, this might
2694 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00002695 /// TrueCount should be the number of times we expect the condition to
2696 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00002697 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00002698 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00002699
Richard Smithe30752c2012-10-09 19:52:38 +00002700 /// \brief Emit a description of a type in a format suitable for passing to
2701 /// a runtime sanitizer handler.
2702 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2703
2704 /// \brief Convert a value into a format suitable for passing to a runtime
2705 /// sanitizer handler.
2706 llvm::Value *EmitCheckValue(llvm::Value *V);
2707
2708 /// \brief Emit a description of a source location in a format suitable for
2709 /// passing to a runtime sanitizer handler.
2710 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2711
Richard Smithde670682012-11-01 22:15:34 +00002712 /// \brief Create a basic block that will call a handler function in a
2713 /// sanitizer runtime with the provided arguments, and create a conditional
2714 /// branch to it.
Alexey Samsonove396bfc2014-11-11 22:03:54 +00002715 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerKind>> Checked,
2716 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
2717 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002718
Richard Smithde670682012-11-01 22:15:34 +00002719 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2720 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00002721 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00002722
Anders Carlsson093bdff2010-03-30 03:27:09 +00002723 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00002724 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00002725
John McCall23f66262010-05-26 22:34:26 +00002726 /// EmitDelegateCallArg - We are performing a delegate call; that
2727 /// is, the current function is delegating to another one. Produce
2728 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002729 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
2730 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00002731
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002732 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2733 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00002734 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002735
Chris Lattnercd439292008-11-12 08:04:58 +00002736private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00002737 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002738 void EmitReturnOfRValue(RValue RV, QualType Ty);
2739
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002740 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
2741
2742 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
2743 DeferredReplacements;
2744
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002745 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2746 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2747 ///
2748 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002749 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
2750 SmallVectorImpl<llvm::Argument *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002751
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002752 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
2753 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
2754 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
2755 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
2756 SmallVectorImpl<llvm::Value *> &IRCallArgs,
2757 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00002758
Chad Rosier59df25b2012-08-23 20:00:18 +00002759 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00002760 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00002761
Chad Rosier59df25b2012-08-23 20:00:18 +00002762 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00002763 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002764 std::string &ConstraintStr,
2765 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00002766
Reid Kleckner89077a12013-12-17 19:46:40 +00002767public:
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002768 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00002769 template <typename T>
2770 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002771 CallExpr::const_arg_iterator ArgBeg,
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002772 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002773 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00002774 unsigned ParamsToSkip = 0) {
Reid Kleckner739756c2013-12-04 19:23:12 +00002775 SmallVector<QualType, 16> ArgTypes;
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002776 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002777
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002778 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
2779 "Can't skip parameters if type info is not provided");
2780 if (CallArgTypeInfo) {
2781 // First, use the argument types that the type info knows about
2782 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
2783 E = CallArgTypeInfo->param_type_end();
2784 I != E; ++I, ++Arg) {
2785 assert(Arg != ArgEnd && "Running over edge of argument list!");
Alexey Bataev7cb17892014-12-18 06:54:53 +00002786 assert(
2787 ((*I)->isVariablyModifiedType() ||
2788 getContext()
2789 .getCanonicalType((*I).getNonReferenceType())
2790 .getTypePtr() ==
2791 getContext().getCanonicalType(Arg->getType()).getTypePtr()) &&
2792 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002793 ArgTypes.push_back(*I);
2794 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00002795 }
Mike Stump11289f42009-09-09 15:08:12 +00002796
Reid Kleckner739756c2013-12-04 19:23:12 +00002797 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002798 // function.
2799 assert(
2800 (Arg == ArgEnd || !CallArgTypeInfo || CallArgTypeInfo->isVariadic()) &&
2801 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00002802
Anders Carlsson603d6af2009-04-18 20:20:22 +00002803 // If we still have any arguments, emit them using the type of the argument.
Reid Kleckner739756c2013-12-04 19:23:12 +00002804 for (; Arg != ArgEnd; ++Arg)
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002805 ArgTypes.push_back(getVarArgType(*Arg));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002806
David Blaikie835afb22015-01-21 23:08:17 +00002807 EmitCallArgs(Args, ArgTypes, ArgBeg, ArgEnd, CalleeDecl, ParamsToSkip);
Anders Carlsson603d6af2009-04-18 20:20:22 +00002808 }
John McCalld4f4b7f2010-03-03 04:15:11 +00002809
Reid Kleckner739756c2013-12-04 19:23:12 +00002810 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
2811 CallExpr::const_arg_iterator ArgBeg,
Richard Smith760520b2014-06-03 23:27:44 +00002812 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002813 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00002814 unsigned ParamsToSkip = 0);
Reid Kleckner739756c2013-12-04 19:23:12 +00002815
Reid Kleckner89077a12013-12-17 19:46:40 +00002816private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002817 QualType getVarArgType(const Expr *Arg);
2818
John McCalld4f4b7f2010-03-03 04:15:11 +00002819 const TargetCodeGenInfo &getTargetHooks() const {
2820 return CGM.getTargetCodeGenInfo();
2821 }
John McCall09ae0322010-07-06 23:57:41 +00002822
2823 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00002824
2825 CodeGenModule::ByrefHelpers *
Chris Lattner2192fe52011-07-18 04:24:23 +00002826 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf9b056b2011-03-31 08:03:29 +00002827 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00002828
2829 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00002830
Eli Friedmana5dd5682012-08-23 03:10:17 +00002831 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2832 /// value and compute our best estimate of the alignment of the pointee.
2833 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00002834
2835 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00002836};
Mike Stump11289f42009-09-09 15:08:12 +00002837
John McCallce1de612011-01-26 04:00:11 +00002838/// Helper class with most of the code for saving a value for a
2839/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00002840struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00002841 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2842
2843 /// Answer whether the given value needs extra work to be saved.
2844 static bool needsSaving(llvm::Value *value) {
2845 // If it's not an instruction, we don't need to save.
2846 if (!isa<llvm::Instruction>(value)) return false;
2847
2848 // If it's an instruction in the entry block, we don't need to save.
2849 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2850 return (block != &block->getParent()->getEntryBlock());
2851 }
2852
2853 /// Try to save the given value.
2854 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2855 if (!needsSaving(value)) return saved_type(value, false);
2856
2857 // Otherwise we need an alloca.
2858 llvm::Value *alloca =
2859 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2860 CGF.Builder.CreateStore(value, alloca);
2861
2862 return saved_type(alloca, true);
2863 }
2864
2865 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2866 if (!value.getInt()) return value.getPointer();
2867 return CGF.Builder.CreateLoad(value.getPointer());
2868 }
2869};
2870
John McCallcb5f77f2011-01-28 10:53:53 +00002871/// A partial specialization of DominatingValue for llvm::Values that
2872/// might be llvm::Instructions.
2873template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2874 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00002875 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00002876 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2877 }
2878};
2879
2880/// A specialization of DominatingValue for RValue.
2881template <> struct DominatingValue<RValue> {
2882 typedef RValue type;
2883 class saved_type {
2884 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2885 AggregateAddress, ComplexAddress };
2886
2887 llvm::Value *Value;
2888 Kind K;
2889 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2890
2891 public:
2892 static bool needsSaving(RValue value);
2893 static saved_type save(CodeGenFunction &CGF, RValue value);
2894 RValue restore(CodeGenFunction &CGF);
2895
2896 // implementations in CGExprCXX.cpp
2897 };
2898
2899 static bool needsSaving(type value) {
2900 return saved_type::needsSaving(value);
2901 }
2902 static saved_type save(CodeGenFunction &CGF, type value) {
2903 return saved_type::save(CGF, value);
2904 }
2905 static type restore(CodeGenFunction &CGF, saved_type value) {
2906 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00002907 }
2908};
2909
Chris Lattnerbed31442007-05-28 01:07:47 +00002910} // end namespace CodeGen
2911} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00002912
Chris Lattnerbed31442007-05-28 01:07:47 +00002913#endif