blob: 67188dfa0a135b45c6eebc6e3b29934696afbe0a [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
Reid Klecknera5930002015-02-11 21:40:48 +0000266 /// Codegen is currently inside an SEH try block.
267 bool IsSEHTryScope;
268
John McCallad7c5c12011-02-08 08:22:06 +0000269 const CodeGen::CGBlockInfo *BlockInfo;
270 llvm::Value *BlockPointer;
271
Eli Friedman9fbeba02012-02-11 02:57:39 +0000272 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
273 FieldDecl *LambdaThisCaptureField;
274
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000275 /// \brief A mapping from NRVO variables to the flags used to indicate
276 /// when the NRVO has been applied to this variable.
277 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000278
John McCallbd309292010-07-06 01:34:17 +0000279 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000280 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000281 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000282
283 /// Header for data within LifetimeExtendedCleanupStack.
284 struct LifetimeExtendedCleanupHeader {
285 /// The size of the following cleanup object.
Reid Klecknerc311aba2014-10-31 23:33:56 +0000286 unsigned Size : 29;
Richard Smith736a9472013-06-12 20:42:33 +0000287 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
288 unsigned Kind : 3;
289
Reid Klecknerc311aba2014-10-31 23:33:56 +0000290 size_t getSize() const { return size_t(Size); }
Richard Smith736a9472013-06-12 20:42:33 +0000291 CleanupKind getKind() const { return static_cast<CleanupKind>(Kind); }
292 };
John McCallbd309292010-07-06 01:34:17 +0000293
John McCallad5d61e2010-07-23 21:56:41 +0000294 /// i32s containing the indexes of the cleanup destinations.
295 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000296
297 unsigned NextCleanupDestIndex;
298
John McCall08ef4662011-11-10 08:15:53 +0000299 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
300 CGBlockInfo *FirstBlockInfo;
301
John McCall8e4c74b2011-08-11 02:22:43 +0000302 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
303 llvm::BasicBlock *EHResumeBlock;
304
Bill Wendlingf0724e82011-09-19 20:31:14 +0000305 /// The exception slot. All landing pads write the current exception pointer
306 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000307 llvm::Value *ExceptionSlot;
308
Bill Wendlingf0724e82011-09-19 20:31:14 +0000309 /// The selector slot. Under the MandatoryCleanup model, all landing pads
310 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000311 llvm::AllocaInst *EHSelectorSlot;
312
Reid Kleckneraca01db2015-02-04 22:37:07 +0000313 llvm::AllocaInst *AbnormalTerminationSlot;
314
Reid Kleckner1d59f992015-01-22 01:36:17 +0000315 /// The implicit parameter to SEH filter functions of type
316 /// 'EXCEPTION_POINTERS*'.
317 ImplicitParamDecl *SEHPointersDecl;
318
John McCallbd309292010-07-06 01:34:17 +0000319 /// Emits a landing pad for the current EH stack.
320 llvm::BasicBlock *EmitLandingPad();
321
322 llvm::BasicBlock *getInvokeDestImpl();
323
John McCallce1de612011-01-26 04:00:11 +0000324 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000325 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
326 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000327 }
328
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000329public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000330 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
331 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000332 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000333
John McCall6b0feb72011-06-22 02:32:12 +0000334 /// A class controlling the emission of a finally block.
335 class FinallyInfo {
336 /// Where the catchall's edge through the cleanup should go.
337 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000338
John McCall6b0feb72011-06-22 02:32:12 +0000339 /// A function to call to enter the catch.
340 llvm::Constant *BeginCatchFn;
341
342 /// An i1 variable indicating whether or not the @finally is
343 /// running for an exception.
344 llvm::AllocaInst *ForEHVar;
345
346 /// An i8* variable into which the exception pointer to rethrow
347 /// has been saved.
348 llvm::AllocaInst *SavedExnVar;
349
350 public:
351 void enter(CodeGenFunction &CGF, const Stmt *Finally,
352 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
353 llvm::Constant *rethrowFn);
354 void exit(CodeGenFunction &CGF);
355 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000356
Reid Kleckneraca01db2015-02-04 22:37:07 +0000357 /// Cleanups can be emitted for two reasons: normal control leaving a region
358 /// exceptional control flow leaving a region.
359 struct SEHFinallyInfo {
360 SEHFinallyInfo()
361 : FinallyBB(nullptr), ContBB(nullptr), ResumeBB(nullptr) {}
362
363 llvm::BasicBlock *FinallyBB;
364 llvm::BasicBlock *ContBB;
365 llvm::BasicBlock *ResumeBB;
366 };
367
John McCallce1de612011-01-26 04:00:11 +0000368 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
369 /// current full-expression. Safe against the possibility that
370 /// we're currently inside a conditionally-evaluated expression.
John McCalle4df6c82011-01-28 08:37:24 +0000371 template <class T, class A0>
372 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
373 // If we're not in a conditional branch, or if none of the
374 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000375 if (!isInConditionalBranch())
376 return EHStack.pushCleanup<T>(kind, a0);
John McCalle4df6c82011-01-28 08:37:24 +0000377
John McCallcb5f77f2011-01-28 10:53:53 +0000378 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCalle4df6c82011-01-28 08:37:24 +0000379
380 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
381 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
382 initFullExprCleanup();
383 }
384
385 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
386 /// current full-expression. Safe against the possibility that
387 /// we're currently inside a conditionally-evaluated expression.
John McCallce1de612011-01-26 04:00:11 +0000388 template <class T, class A0, class A1>
389 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
390 // If we're not in a conditional branch, or if none of the
391 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000392 if (!isInConditionalBranch())
393 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCallce1de612011-01-26 04:00:11 +0000394
John McCallcb5f77f2011-01-28 10:53:53 +0000395 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
396 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCallce1de612011-01-26 04:00:11 +0000397
398 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCalle4df6c82011-01-28 08:37:24 +0000399 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
400 initFullExprCleanup();
John McCallce1de612011-01-26 04:00:11 +0000401 }
402
Douglas Gregor58df5092011-06-22 16:12:01 +0000403 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
404 /// current full-expression. Safe against the possibility that
405 /// we're currently inside a conditionally-evaluated expression.
406 template <class T, class A0, class A1, class A2>
407 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
408 // If we're not in a conditional branch, or if none of the
409 // arguments requires saving, then use the unconditional cleanup.
410 if (!isInConditionalBranch()) {
John McCall5fcf8da2011-07-12 00:15:30 +0000411 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregor58df5092011-06-22 16:12:01 +0000412 }
413
414 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
415 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
416 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
417
418 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
419 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
420 initFullExprCleanup();
421 }
422
John McCall4bd0fb12011-07-12 16:41:08 +0000423 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
424 /// current full-expression. Safe against the possibility that
425 /// we're currently inside a conditionally-evaluated expression.
426 template <class T, class A0, class A1, class A2, class A3>
427 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
428 // If we're not in a conditional branch, or if none of the
429 // arguments requires saving, then use the unconditional cleanup.
430 if (!isInConditionalBranch()) {
431 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
432 }
433
434 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
435 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
436 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
437 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
438
439 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
440 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
441 a2_saved, a3_saved);
442 initFullExprCleanup();
443 }
444
Richard Smith736a9472013-06-12 20:42:33 +0000445 /// \brief Queue a cleanup to be pushed after finishing the current
446 /// full-expression.
447 template <class T, class A0, class A1, class A2, class A3>
448 void pushCleanupAfterFullExpr(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
449 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
450
451 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
452
453 size_t OldSize = LifetimeExtendedCleanupStack.size();
454 LifetimeExtendedCleanupStack.resize(
455 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
456
457 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
458 new (Buffer) LifetimeExtendedCleanupHeader(Header);
459 new (Buffer + sizeof(Header)) T(a0, a1, a2, a3);
460 }
461
John McCallf4beacd2011-11-10 10:43:54 +0000462 /// Set up the last cleaup that was pushed as a conditional
463 /// full-expression cleanup.
464 void initFullExprCleanup();
465
John McCallbd309292010-07-06 01:34:17 +0000466 /// PushDestructorCleanup - Push a cleanup to call the
467 /// complete-object destructor of an object of the given type at the
468 /// given address. Does nothing if T is not a C++ class type with a
469 /// non-trivial destructor.
470 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
471
John McCall8680f872010-07-21 06:29:51 +0000472 /// PushDestructorCleanup - Push a cleanup to call the
473 /// complete-object variant of the given destructor on the object at
474 /// the given address.
475 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
476 llvm::Value *Addr);
477
John McCallbd309292010-07-06 01:34:17 +0000478 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
479 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000480 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000481
John McCall824c2f52010-09-14 07:57:04 +0000482 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
483 /// The block cannot be reactivated. Pops it if it's the top of the
484 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000485 ///
486 /// \param DominatingIP - An instruction which is known to
487 /// dominate the current IP (if set) and which lies along
488 /// all paths of execution between the current IP and the
489 /// the point at which the cleanup comes into scope.
490 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
491 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000492
493 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
494 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000495 ///
496 /// \param DominatingIP - An instruction which is known to
497 /// dominate the current IP (if set) and which lies along
498 /// all paths of execution between the current IP and the
499 /// the point at which the cleanup comes into scope.
500 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
501 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000502
John McCallbd309292010-07-06 01:34:17 +0000503 /// \brief Enters a new scope for capturing cleanups, all of which
504 /// will be executed once the scope is exited.
505 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000506 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000507 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000508 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000509 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000510 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000511 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000512
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000513 RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
514 void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
Douglas Gregor965f4502009-11-24 16:43:22 +0000515
Eric Christophera9d34972011-10-19 00:43:52 +0000516 protected:
517 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000518
Douglas Gregor965f4502009-11-24 16:43:22 +0000519 public:
520 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000521 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000522 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000523 {
John McCallbd309292010-07-06 01:34:17 +0000524 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000525 LifetimeExtendedCleanupStackSize =
526 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000527 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000528 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000529 }
530
531 /// \brief Exit this cleanup scope, emitting any accumulated
532 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000533 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000534 if (PerformCleanup) {
535 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000536 CGF.PopCleanupBlocks(CleanupStackDepth,
537 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000538 }
539 }
540
541 /// \brief Determine whether this scope requires any cleanups.
542 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000543 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000544 }
545
546 /// \brief Force the emission of cleanups now, instead of waiting
547 /// until this object is destroyed.
548 void ForceCleanup() {
549 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000550 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000551 CGF.PopCleanupBlocks(CleanupStackDepth,
552 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000553 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000554 }
555 };
556
David Blaikie93be0b22014-08-22 21:37:04 +0000557 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000558 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000559 SmallVector<const LabelDecl*, 4> Labels;
560 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000561
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000562 LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
563 void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
Eric Christophera9d34972011-10-19 00:43:52 +0000564
565 public:
566 /// \brief Enter a new cleanup scope.
567 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000568 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
569 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000570 if (CGDebugInfo *DI = CGF.getDebugInfo())
571 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
572 }
573
Nadav Rotem1da30942013-03-23 06:43:35 +0000574 void addLabel(const LabelDecl *label) {
575 assert(PerformCleanup && "adding label to dead scope?");
576 Labels.push_back(label);
577 }
578
Eric Christophera9d34972011-10-19 00:43:52 +0000579 /// \brief Exit this cleanup scope, emitting any accumulated
580 /// cleanups.
581 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000582 if (CGDebugInfo *DI = CGF.getDebugInfo())
583 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
584
Nadav Rotem1da30942013-03-23 06:43:35 +0000585 // If we should perform a cleanup, force them now. Note that
586 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000587 if (PerformCleanup) {
588 ApplyDebugLocation DL(CGF, Range.getEnd());
589 ForceCleanup();
590 }
Eric Christophera9d34972011-10-19 00:43:52 +0000591 }
592
593 /// \brief Force the emission of cleanups now, instead of waiting
594 /// until this object is destroyed.
595 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000596 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000597 RunCleanupsScope::ForceCleanup();
598
Nadav Rotem1da30942013-03-23 06:43:35 +0000599 if (!Labels.empty())
600 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000601 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000602
603 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000604 };
605
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000606 /// \brief The scope used to remap some variables as private in the OpenMP
607 /// loop body (or other captured region emitted without outlining), and to
608 /// restore old vars back on exit.
609 class OMPPrivateScope : public RunCleanupsScope {
610 typedef llvm::DenseMap<const VarDecl *, llvm::Value *> VarDeclMapTy;
611 VarDeclMapTy SavedLocals;
612 VarDeclMapTy SavedPrivates;
613
614 private:
615 OMPPrivateScope(const OMPPrivateScope &) LLVM_DELETED_FUNCTION;
616 void operator=(const OMPPrivateScope &) LLVM_DELETED_FUNCTION;
617
618 public:
619 /// \brief Enter a new OpenMP private scope.
620 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
621
622 /// \brief Registers \a LocalVD variable as a private and apply \a
623 /// PrivateGen function for it to generate corresponding private variable.
624 /// \a PrivateGen returns an address of the generated private variable.
625 /// \return true if the variable is registered as private, false if it has
626 /// been privatized already.
627 bool
628 addPrivate(const VarDecl *LocalVD,
629 const std::function<llvm::Value *()> &PrivateGen) {
630 assert(PerformCleanup && "adding private to dead scope");
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000631 if (SavedLocals.count(LocalVD) > 0) return false;
632 SavedLocals[LocalVD] = CGF.LocalDeclMap.lookup(LocalVD);
633 CGF.LocalDeclMap.erase(LocalVD);
634 SavedPrivates[LocalVD] = PrivateGen();
635 CGF.LocalDeclMap[LocalVD] = SavedLocals[LocalVD];
636 return true;
637 }
638
639 /// \brief Privatizes local variables previously registered as private.
640 /// Registration is separate from the actual privatization to allow
641 /// initializers use values of the original variables, not the private one.
642 /// This is important, for example, if the private variable is a class
643 /// variable initialized by a constructor that references other private
644 /// variables. But at initialization original variables must be used, not
645 /// private copies.
646 /// \return true if at least one variable was privatized, false otherwise.
647 bool Privatize() {
648 for (auto VDPair : SavedPrivates) {
649 CGF.LocalDeclMap[VDPair.first] = VDPair.second;
650 }
651 SavedPrivates.clear();
652 return !SavedLocals.empty();
653 }
654
655 void ForceCleanup() {
656 RunCleanupsScope::ForceCleanup();
657 // Remap vars back to the original values.
658 for (auto I : SavedLocals) {
659 CGF.LocalDeclMap[I.first] = I.second;
660 }
661 SavedLocals.clear();
662 }
663
664 /// \brief Exit scope - all the mapped variables are restored.
665 ~OMPPrivateScope() { ForceCleanup(); }
666 };
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.
Adrian Prantldc237b52013-05-16 00:41:26 +0000670 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000671
Richard Smith736a9472013-06-12 20:42:33 +0000672 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
673 /// that have been added, then adds all lifetime-extended cleanups from
674 /// the given position to the stack.
675 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
676 size_t OldLifetimeExtendedStackSize);
677
John McCallad5d61e2010-07-23 21:56:41 +0000678 void ResolveBranchFixups(llvm::BasicBlock *Target);
679
John McCallbd309292010-07-06 01:34:17 +0000680 /// The given basic block lies in the current EH scope, but may be a
681 /// target of a potentially scope-crossing jump; get a stable handle
682 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000683 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000684 return JumpDest(Target,
685 EHStack.getInnermostNormalCleanup(),
686 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000687 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000688
John McCallbd309292010-07-06 01:34:17 +0000689 /// The given basic block lies in the current EH scope, but may be a
690 /// target of a potentially scope-crossing jump; get a stable handle
691 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000692 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000693 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000694 }
695
696 /// EmitBranchThroughCleanup - Emit a branch from the current insert
697 /// block through the normal cleanup handling code (if any) and then
698 /// on to \arg Dest.
699 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000700
Justin Bognere25ffdf2014-01-21 00:35:11 +0000701 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
702 /// specified destination obviously has no cleanups to run. 'false' is always
703 /// a conservatively correct answer for this method.
704 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
705
John McCall8e4c74b2011-08-11 02:22:43 +0000706 /// popCatchScope - Pops the catch scope at the top of the EHScope
707 /// stack, emitting any required code (other than the catch handlers
708 /// themselves).
709 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000710
David Chisnall9a837be2012-11-07 16:50:40 +0000711 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000712 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000713
John McCallce1de612011-01-26 04:00:11 +0000714 /// An object to manage conditionally-evaluated expressions.
715 class ConditionalEvaluation {
716 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000717
John McCallce1de612011-01-26 04:00:11 +0000718 public:
719 ConditionalEvaluation(CodeGenFunction &CGF)
720 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000721
John McCallce1de612011-01-26 04:00:11 +0000722 void begin(CodeGenFunction &CGF) {
723 assert(CGF.OutermostConditional != this);
724 if (!CGF.OutermostConditional)
725 CGF.OutermostConditional = this;
726 }
727
728 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000729 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000730 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000731 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000732 }
733
734 /// Returns a block which will be executed prior to each
735 /// evaluation of the conditional code.
736 llvm::BasicBlock *getStartingBlock() const {
737 return StartBB;
738 }
739 };
Mike Stump11289f42009-09-09 15:08:12 +0000740
John McCall7f9c92a2010-09-17 00:50:28 +0000741 /// isInConditionalBranch - Return true if we're currently emitting
742 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000743 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000744
John McCallf4beacd2011-11-10 10:43:54 +0000745 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
746 assert(isInConditionalBranch());
747 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
748 new llvm::StoreInst(value, addr, &block->back());
749 }
750
John McCallce1de612011-01-26 04:00:11 +0000751 /// An RAII object to record that we're evaluating a statement
752 /// expression.
753 class StmtExprEvaluation {
754 CodeGenFunction &CGF;
755
756 /// We have to save the outermost conditional: cleanups in a
757 /// statement expression aren't conditional just because the
758 /// StmtExpr is.
759 ConditionalEvaluation *SavedOutermostConditional;
760
761 public:
762 StmtExprEvaluation(CodeGenFunction &CGF)
763 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000764 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000765 }
766
767 ~StmtExprEvaluation() {
768 CGF.OutermostConditional = SavedOutermostConditional;
769 CGF.EnsureInsertPoint();
770 }
771 };
John McCall1bf58462011-02-16 08:02:54 +0000772
John McCallc07a0c72011-02-17 10:25:35 +0000773 /// An object which temporarily prevents a value from being
774 /// destroyed by aggressive peephole optimizations that assume that
775 /// all uses of a value have been realized in the IR.
776 class PeepholeProtection {
777 llvm::Instruction *Inst;
778 friend class CodeGenFunction;
779
780 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000781 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000782 };
John McCallc07a0c72011-02-17 10:25:35 +0000783
John McCallfe96e0b2011-11-06 09:01:30 +0000784 /// A non-RAII class containing all the information about a bound
785 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
786 /// this which makes individual mappings very simple; using this
787 /// class directly is useful when you have a variable number of
788 /// opaque values or don't want the RAII functionality for some
789 /// reason.
790 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000791 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000792 bool BoundLValue;
793 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000794
John McCallfe96e0b2011-11-06 09:01:30 +0000795 OpaqueValueMappingData(const OpaqueValueExpr *ov,
796 bool boundLValue)
797 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000798 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000799 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000800
John McCallc07a0c72011-02-17 10:25:35 +0000801 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000802 // gl-values should be bound as l-values for obvious reasons.
803 // Records should be bound as l-values because IR generation
804 // always keeps them in memory. Expressions of function type
805 // act exactly like l-values but are formally required to be
806 // r-values in C.
807 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000808 expr->getType()->isFunctionType() ||
809 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000810 }
811
John McCallfe96e0b2011-11-06 09:01:30 +0000812 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
813 const OpaqueValueExpr *ov,
814 const Expr *e) {
815 if (shouldBindAsLValue(ov))
816 return bind(CGF, ov, CGF.EmitLValue(e));
817 return bind(CGF, ov, CGF.EmitAnyExpr(e));
818 }
819
820 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
821 const OpaqueValueExpr *ov,
822 const LValue &lv) {
823 assert(shouldBindAsLValue(ov));
824 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
825 return OpaqueValueMappingData(ov, true);
826 }
827
828 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
829 const OpaqueValueExpr *ov,
830 const RValue &rv) {
831 assert(!shouldBindAsLValue(ov));
832 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
833
834 OpaqueValueMappingData data(ov, false);
835
836 // Work around an extremely aggressive peephole optimization in
837 // EmitScalarConversion which assumes that all other uses of a
838 // value are extant.
839 data.Protection = CGF.protectFromPeepholes(rv);
840
841 return data;
842 }
843
Craig Topper8a13c412014-05-21 05:09:00 +0000844 bool isValid() const { return OpaqueValue != nullptr; }
845 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000846
847 void unbind(CodeGenFunction &CGF) {
848 assert(OpaqueValue && "no data to unbind!");
849
850 if (BoundLValue) {
851 CGF.OpaqueLValues.erase(OpaqueValue);
852 } else {
853 CGF.OpaqueRValues.erase(OpaqueValue);
854 CGF.unprotectFromPeepholes(Protection);
855 }
856 }
857 };
858
859 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
860 class OpaqueValueMapping {
861 CodeGenFunction &CGF;
862 OpaqueValueMappingData Data;
863
864 public:
865 static bool shouldBindAsLValue(const Expr *expr) {
866 return OpaqueValueMappingData::shouldBindAsLValue(expr);
867 }
868
John McCallc07a0c72011-02-17 10:25:35 +0000869 /// Build the opaque value mapping for the given conditional
870 /// operator if it's the GNU ?: extension. This is a common
871 /// enough pattern that the convenience operator is really
872 /// helpful.
873 ///
874 OpaqueValueMapping(CodeGenFunction &CGF,
875 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000876 if (isa<ConditionalOperator>(op))
877 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000878 return;
John McCallc07a0c72011-02-17 10:25:35 +0000879
880 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000881 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
882 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000883 }
884
John McCall1bf58462011-02-16 08:02:54 +0000885 OpaqueValueMapping(CodeGenFunction &CGF,
886 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000887 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000888 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000889 }
890
891 OpaqueValueMapping(CodeGenFunction &CGF,
892 const OpaqueValueExpr *opaqueValue,
893 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000894 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000895 }
896
897 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000898 Data.unbind(CGF);
899 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000900 }
901
902 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000903 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000904 }
905 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000906
907 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
908 /// number that holds the value.
909 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian2f2fa722011-01-26 23:08:27 +0000910
911 /// BuildBlockByrefAddress - Computes address location of the
912 /// variable which is declared as __block.
913 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
914 const VarDecl *V);
Chris Lattner2da04b32007-08-24 05:35:26 +0000915private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000916 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000917 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000918
John McCall9b382dd2011-05-28 21:13:02 +0000919 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
920 /// calling llvm.stacksave for multiple VLAs in the same scope.
921 bool DidCallStackSave;
922
Mike Stumpe5311b02009-11-30 20:08:49 +0000923 /// IndirectBranch - The first time an indirect goto is seen we create a block
924 /// with an indirect branch. Every time we see the address of a label taken,
925 /// we add the label to the indirect goto. Every subsequent indirect goto is
926 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000927 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000928
Mike Stumpfc496822009-02-08 23:14:22 +0000929 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
930 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000931 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
932 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000933
Chris Lattnerac248202007-05-30 00:13:02 +0000934 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000935 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000936
Mike Stumpfc496822009-02-08 23:14:22 +0000937 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000938 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000939 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000940 BreakContinue(JumpDest Break, JumpDest Continue)
941 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000942
John McCallbd309292010-07-06 01:34:17 +0000943 JumpDest BreakBlock;
944 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000945 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000946 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000947
Justin Bogneref512b92014-01-06 22:27:43 +0000948 CodeGenPGO PGO;
949
950public:
951 /// Get a counter for instrumentation of the region associated with the given
952 /// statement.
953 RegionCounter getPGORegionCounter(const Stmt *S) {
954 return RegionCounter(PGO, S);
955 }
956private:
957
Zhongxing Xu82846ea2012-01-14 09:08:15 +0000958 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +0000959 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000960 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +0000961 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
962 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +0000963
Mike Stumpfc496822009-02-08 23:14:22 +0000964 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000965 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000966 llvm::BasicBlock *CaseRangeBlock;
967
John McCallc07a0c72011-02-17 10:25:35 +0000968 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +0000969 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +0000970 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
971 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +0000972
Mike Stumpfc496822009-02-08 23:14:22 +0000973 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +0000974 // We track this by the size expression rather than the type itself because
975 // in certain situations, like a const qualifier applied to an VLA typedef,
976 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +0000977 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
978 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +0000979 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000980
John McCallbd309292010-07-06 01:34:17 +0000981 /// A block containing a single 'unreachable' instruction. Created
982 /// lazily by getUnreachableBlock().
983 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000984
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000985 /// Counts of the number return expressions in the function.
986 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +0000987
988 /// Count the number of simple (constant) return expressions in the function.
989 unsigned NumSimpleReturnExprs;
990
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000991 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +0000992 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +0000993
Richard Smith852c9db2013-04-20 22:23:05 +0000994public:
995 /// A scope within which we are constructing the fields of an object which
996 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
997 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
998 class FieldConstructionScope {
999 public:
1000 FieldConstructionScope(CodeGenFunction &CGF, llvm::Value *This)
1001 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1002 CGF.CXXDefaultInitExprThis = This;
1003 }
1004 ~FieldConstructionScope() {
1005 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1006 }
1007
1008 private:
1009 CodeGenFunction &CGF;
1010 llvm::Value *OldCXXDefaultInitExprThis;
1011 };
1012
1013 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1014 /// is overridden to be the object under construction.
1015 class CXXDefaultInitExprScope {
1016 public:
1017 CXXDefaultInitExprScope(CodeGenFunction &CGF)
1018 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue) {
1019 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis;
1020 }
1021 ~CXXDefaultInitExprScope() {
1022 CGF.CXXThisValue = OldCXXThisValue;
1023 }
1024
1025 public:
1026 CodeGenFunction &CGF;
1027 llvm::Value *OldCXXThisValue;
1028 };
1029
1030private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001031 /// CXXThisDecl - When generating code for a C++ member function,
1032 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001033 ImplicitParamDecl *CXXABIThisDecl;
1034 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001035 llvm::Value *CXXThisValue;
Mike Stump11289f42009-09-09 15:08:12 +00001036
Richard Smith852c9db2013-04-20 22:23:05 +00001037 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1038 /// this expression.
1039 llvm::Value *CXXDefaultInitExprThis;
1040
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001041 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1042 /// destructor, this will hold the implicit argument (e.g. VTT).
1043 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1044 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001045
John McCallce1de612011-01-26 04:00:11 +00001046 /// OutermostConditional - Points to the outermost active
1047 /// conditional control. This is used so that we know if a
1048 /// temporary should be destroyed conditionally.
1049 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001050
Nadav Rotem1da30942013-03-23 06:43:35 +00001051 /// The current lexical scope.
1052 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001053
Adrian Prantldc237b52013-05-16 00:41:26 +00001054 /// The current source location that should be used for exception
1055 /// handling code.
1056 SourceLocation CurEHLocation;
1057
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001058 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1059 /// type as well as the field number that contains the actual data.
Chris Lattner2192fe52011-07-18 04:24:23 +00001060 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001061 unsigned> > ByRefValueInfo;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001062
John McCallbd309292010-07-06 01:34:17 +00001063 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001064 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001065 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001066
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001067 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1068 /// In the kernel metadata node, reference the kernel function and metadata
1069 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001070 /// - A node for the vec_type_hint(<type>) qualifier contains string
1071 /// "vec_type_hint", an undefined value of the <type> data type,
1072 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001073 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1074 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1075 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1076 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1077 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1078 llvm::Function *Fn);
1079
Chris Lattnerbed31442007-05-28 01:07:47 +00001080public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001081 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001082 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001083
John McCall8ed55a52010-09-02 09:58:18 +00001084 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001085 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001086 CGDebugInfo *getDebugInfo() {
1087 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001088 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001089 return DebugInfo;
1090 }
1091 void disableDebugInfo() { DisableDebugInfo = true; }
1092 void enableDebugInfo() { DisableDebugInfo = false; }
1093
John McCall31168b02011-06-15 23:02:42 +00001094 bool shouldUseFusedARCCalls() {
1095 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1096 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001097
David Blaikiebbafb8a2012-03-11 07:00:24 +00001098 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001099
Bill Wendlingf0724e82011-09-19 20:31:14 +00001100 /// Returns a pointer to the function's exception object and selector slot,
1101 /// which is assigned in every landing pad.
John McCallbd309292010-07-06 01:34:17 +00001102 llvm::Value *getExceptionSlot();
John McCall9b382dd2011-05-28 21:13:02 +00001103 llvm::Value *getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001104
Reid Kleckneraca01db2015-02-04 22:37:07 +00001105 /// Stack slot that contains whether a __finally block is being executed as an
1106 /// EH cleanup or as a normal cleanup.
1107 llvm::Value *getAbnormalTerminationSlot();
1108
Bill Wendling79a70e42011-09-15 18:57:19 +00001109 /// Returns the contents of the function's exception object and selector
1110 /// slots.
1111 llvm::Value *getExceptionFromSlot();
1112 llvm::Value *getSelectorFromSlot();
1113
John McCallad5d61e2010-07-23 21:56:41 +00001114 llvm::Value *getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001115
John McCallbd309292010-07-06 01:34:17 +00001116 llvm::BasicBlock *getUnreachableBlock() {
1117 if (!UnreachableBlock) {
1118 UnreachableBlock = createBasicBlock("unreachable");
1119 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1120 }
1121 return UnreachableBlock;
1122 }
1123
1124 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001125 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001126 return getInvokeDestImpl();
1127 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001128
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001129 bool currentFunctionUsesSEHTry() const {
1130 const auto *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl);
1131 return FD && FD->usesSEHTry();
1132 }
1133
John McCallc8e01702013-04-16 22:48:15 +00001134 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001135 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001136
Daniel Dunbar12347492009-02-23 17:26:39 +00001137 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001138 // Cleanups
1139 //===--------------------------------------------------------------------===//
1140
1141 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1142
John McCall178360e2011-07-11 08:38:19 +00001143 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1144 llvm::Value *arrayEndPointer,
1145 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001146 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001147 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1148 llvm::Value *arrayEnd,
1149 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001150 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001151
John McCall4bd0fb12011-07-12 16:41:08 +00001152 void pushDestroy(QualType::DestructionKind dtorKind,
1153 llvm::Value *addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001154 void pushEHDestroy(QualType::DestructionKind dtorKind,
1155 llvm::Value *addr, QualType type);
John McCall82fe67b2011-07-09 01:37:26 +00001156 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001157 Destroyer *destroyer, bool useEHCleanupForArray);
Richard Smith736a9472013-06-12 20:42:33 +00001158 void pushLifetimeExtendedDestroy(CleanupKind kind, llvm::Value *addr,
1159 QualType type, Destroyer *destroyer,
1160 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001161 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1162 llvm::Value *CompletePtr,
1163 QualType ElementType);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001164 void pushStackRestore(CleanupKind kind, llvm::Value *SPMem);
Peter Collingbourne1425b452012-01-26 03:33:36 +00001165 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001166 bool useEHCleanupForArray);
David Blaikieebe87e12013-08-27 23:57:18 +00001167 llvm::Function *generateDestroyHelper(llvm::Constant *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001168 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001169 bool useEHCleanupForArray,
1170 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001171 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001172 QualType type, Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001173 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001174
Peter Collingbourne1425b452012-01-26 03:33:36 +00001175 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001176
John McCall82fe67b2011-07-09 01:37:26 +00001177 /// Determines whether an EH cleanup is required to destroy a type
1178 /// with the given destruction kind.
1179 bool needsEHCleanup(QualType::DestructionKind kind) {
1180 switch (kind) {
1181 case QualType::DK_none:
1182 return false;
1183 case QualType::DK_cxx_destructor:
1184 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001185 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001186 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001187 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001188 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1189 }
1190 llvm_unreachable("bad destruction kind");
1191 }
1192
John McCall4bd0fb12011-07-12 16:41:08 +00001193 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1194 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1195 }
1196
John McCall82fe67b2011-07-09 01:37:26 +00001197 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001198 // Objective-C
1199 //===--------------------------------------------------------------------===//
1200
Chris Lattner4bd55962008-03-30 23:03:07 +00001201 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001202
David Blaikief1425802015-01-14 00:04:42 +00001203 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001204
Mike Stumpfc496822009-02-08 23:14:22 +00001205 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001206 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1207 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001208 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001209 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001210 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001211 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001212
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001213 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1214 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001215
Mike Stumpfc496822009-02-08 23:14:22 +00001216 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1217 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001218 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1219 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001220 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001221 const ObjCPropertyImplDecl *propImpl,
1222 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian08b0f662010-04-13 00:38:05 +00001223 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001224 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001225
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001226 //===--------------------------------------------------------------------===//
1227 // Block Bits
1228 //===--------------------------------------------------------------------===//
1229
John McCall351762c2011-02-07 10:33:21 +00001230 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001231 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1232 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garstfc83aa02010-02-23 21:51:17 +00001233 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001234 const CGBlockInfo &Info,
Chris Lattner2192fe52011-07-18 04:24:23 +00001235 llvm::StructType *,
John McCallad7c5c12011-02-08 08:22:06 +00001236 llvm::Constant *BlockVarLayout);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001237
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001238 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001239 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001240 const DeclMapTy &ldm,
1241 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001242
John McCallad7c5c12011-02-08 08:22:06 +00001243 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1244 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001245 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1246 const ObjCPropertyImplDecl *PID);
1247 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1248 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001249 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001250
John McCallad7c5c12011-02-08 08:22:06 +00001251 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1252
John McCall73064872011-03-31 01:59:53 +00001253 class AutoVarEmission;
1254
1255 void emitByrefStructureInit(const AutoVarEmission &emission);
1256 void enterByrefCleanup(const AutoVarEmission &emission);
1257
John McCall351762c2011-02-07 10:33:21 +00001258 llvm::Value *LoadBlockStruct() {
1259 assert(BlockPointer && "no block pointer set!");
1260 return BlockPointer;
1261 }
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001262
John McCall87fe5d52010-05-20 01:18:31 +00001263 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCall113bee02012-03-10 09:33:50 +00001264 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall351762c2011-02-07 10:33:21 +00001265 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2192fe52011-07-18 04:24:23 +00001266 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001267
John McCalla738c252011-03-09 04:27:21 +00001268 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1269 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001270 /// \brief Emit code for the start of a function.
1271 /// \param Loc The location to be associated with the function.
1272 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001273 void StartFunction(GlobalDecl GD,
1274 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001275 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001276 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001277 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001278 SourceLocation Loc = SourceLocation(),
1279 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001280
John McCallb81884d2010-02-19 09:25:03 +00001281 void EmitConstructorBody(FunctionArgList &Args);
1282 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001283 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001284 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Bob Wilsonbf854f02014-02-17 19:21:09 +00001285 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, RegionCounter &Cnt);
John McCall89b12b32010-02-18 03:17:58 +00001286
Faisal Vali571df122013-09-29 08:45:24 +00001287 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001288 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001289 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001290 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001291 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1292 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001293 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001294
David Blaikiea0a1a872015-01-18 02:48:07 +00001295 /// \brief Emit the unified return block, trying to avoid its emission when
1296 /// possible.
1297 /// \return The debug location of the user written return statement if the
1298 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001299 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001300
Mike Stumpfc496822009-02-08 23:14:22 +00001301 /// FinishFunction - Complete IR generation of the current function. It is
1302 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001303 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001304
Nico Weber1bebad12015-02-11 22:33:32 +00001305 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1306 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001307
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001308 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001309
Reid Klecknerab2090d2014-07-26 01:34:32 +00001310 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1311 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1312 llvm::Value *Callee);
1313
Anders Carlssonbad991d2010-03-24 00:39:18 +00001314 /// GenerateThunk - Generate a thunk for the given method.
John McCalla738c252011-03-09 04:27:21 +00001315 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1316 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001317
Eli Friedman49a94b12011-05-06 17:27:27 +00001318 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1319 GlobalDecl GD, const ThunkInfo &Thunk);
1320
Douglas Gregor94f9a482010-05-05 05:51:00 +00001321 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1322 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001323
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001324 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001325 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001326
Anders Carlssone87fae92010-03-28 19:40:00 +00001327 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1328 /// subobject.
1329 ///
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001330 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001331 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001332 CharUnits OffsetFromNearestVBase,
Anders Carlssone87fae92010-03-28 19:40:00 +00001333 const CXXRecordDecl *VTableClass);
1334
1335 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001336 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001337 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001338 CharUnits OffsetFromNearestVBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001339 bool BaseIsNonVirtualPrimaryBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001340 const CXXRecordDecl *VTableClass,
1341 VisitedVirtualBasesSetTy& VBases);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001342
Anders Carlssond5895932010-03-28 21:07:49 +00001343 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001344
Dan Gohman8fc50c22010-10-26 18:44:08 +00001345 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1346 /// to by This.
Chris Lattner2192fe52011-07-18 04:24:23 +00001347 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssone87fae92010-03-28 19:40:00 +00001348
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001349
1350 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1351 /// expr can be devirtualized.
1352 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1353 const CXXMethodDecl *MD);
1354
John McCallf99a6312010-07-21 05:30:47 +00001355 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1356 /// given phase of destruction for a destructor. The end result
1357 /// should call destructors on members and base classes in reverse
1358 /// order of their construction.
1359 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001360
Chris Lattner3c77a352010-06-22 00:03:40 +00001361 /// ShouldInstrumentFunction - Return true if the current function should be
1362 /// instrumented with __cyg_profile_func_* calls
1363 bool ShouldInstrumentFunction();
1364
1365 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1366 /// instrumentation function with the current function and the call site, if
1367 /// function instrumentation is enabled.
1368 void EmitFunctionInstrumentation(const char *Fn);
1369
Roman Divacky178e01602011-02-10 16:52:03 +00001370 /// EmitMCountInstrumentation - Emit call to .mcount.
1371 void EmitMCountInstrumentation();
1372
Mike Stumpfc496822009-02-08 23:14:22 +00001373 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1374 /// arguments for the given function. This is also responsible for naming the
1375 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001376 void EmitFunctionProlog(const CGFunctionInfo &FI,
1377 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001378 const FunctionArgList &Args);
1379
Mike Stumpfc496822009-02-08 23:14:22 +00001380 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1381 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001382 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1383 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001384
Mike Stump1d849212009-12-07 23:38:24 +00001385 /// EmitStartEHSpec - Emit the start of the exception spec.
1386 void EmitStartEHSpec(const Decl *D);
1387
1388 /// EmitEndEHSpec - Emit the end of the exception spec.
1389 void EmitEndEHSpec(const Decl *D);
1390
John McCallbd309292010-07-06 01:34:17 +00001391 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1392 llvm::BasicBlock *getTerminateLandingPad();
1393
1394 /// getTerminateHandler - Return a handler (not a landing pad, just
1395 /// a catch handler) that just calls terminate. This is used when
1396 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001397 llvm::BasicBlock *getTerminateHandler();
1398
Chris Lattnera5f58b02011-07-09 17:41:47 +00001399 llvm::Type *ConvertTypeForMem(QualType T);
1400 llvm::Type *ConvertType(QualType T);
1401 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001402 return ConvertType(getContext().getTypeDeclType(T));
1403 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001404
Mike Stumpfc496822009-02-08 23:14:22 +00001405 /// LoadObjCSelf - Load the value of self. This function is only valid while
1406 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001407 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001408
1409 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001410 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001411
Chris Lattner54fb19e2007-06-22 22:02:34 +00001412 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1413 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001414 static TypeEvaluationKind getEvaluationKind(QualType T);
1415
1416 static bool hasScalarEvaluationKind(QualType T) {
1417 return getEvaluationKind(T) == TEK_Scalar;
1418 }
1419
1420 static bool hasAggregateEvaluationKind(QualType T) {
1421 return getEvaluationKind(T) == TEK_Aggregate;
1422 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001423
1424 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001425 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001426 llvm::Function *parent = nullptr,
1427 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001428#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001429 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001430#else
John McCallad7c5c12011-02-08 08:22:06 +00001431 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001432#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001433 }
Mike Stumpfc496822009-02-08 23:14:22 +00001434
Chris Lattnerac248202007-05-30 00:13:02 +00001435 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1436 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001437 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001438
Mike Stumpe5311b02009-11-30 20:08:49 +00001439 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1440 /// another basic block, simplify it. This assumes that no other code could
1441 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001442 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1443
Mike Stumpfc496822009-02-08 23:14:22 +00001444 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1445 /// adding a fall-through branch from the current insert block if
1446 /// necessary. It is legal to call this function even if there is no current
1447 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001448 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001449 /// IsFinished - If true, indicates that the caller has finished emitting
1450 /// branches to the given block and does not expect to emit code into it. This
1451 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001452 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001453
John McCall8e4c74b2011-08-11 02:22:43 +00001454 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1455 /// near its uses, and leave the insertion point in it.
1456 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1457
Mike Stumpfc496822009-02-08 23:14:22 +00001458 /// EmitBranch - Emit a branch to the specified basic block from the current
1459 /// insert block, taking care to avoid creation of branches from dummy
1460 /// blocks. It is legal to call this function even if there is no current
1461 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001462 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001463 /// This function clears the current insertion point. The caller should follow
1464 /// calls to this function with calls to Emit*Block prior to generation new
1465 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001466 void EmitBranch(llvm::BasicBlock *Block);
1467
Mike Stumpfc496822009-02-08 23:14:22 +00001468 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1469 /// indicates that the current code being emitted is unreachable.
1470 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001471 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001472 }
1473
Mike Stumpfc496822009-02-08 23:14:22 +00001474 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1475 /// emitted IR has a place to go. Note that by definition, if this function
1476 /// creates a block then that block is unreachable; callers may do better to
1477 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001478 void EnsureInsertPoint() {
1479 if (!HaveInsertPoint())
1480 EmitBlock(createBasicBlock());
1481 }
Mike Stumpfc496822009-02-08 23:14:22 +00001482
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001483 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001484 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001485 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001486
Chris Lattnere9a64532007-06-22 21:44:33 +00001487 //===--------------------------------------------------------------------===//
1488 // Helpers
1489 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001490
Eli Friedmana0544d62011-12-03 04:14:32 +00001491 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1492 CharUnits Alignment = CharUnits()) {
Dan Gohman947c9af2010-10-14 23:06:10 +00001493 return LValue::MakeAddr(V, T, Alignment, getContext(),
1494 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001495 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001496
David Majnemer99281062014-09-18 22:05:54 +00001497 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001498
Chris Lattnere9a64532007-06-22 21:44:33 +00001499 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001500 /// block. The caller is responsible for setting an appropriate alignment on
1501 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001502 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001503 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001504
John McCall2e6567a2010-04-22 01:10:34 +00001505 /// InitTempAlloca - Provide an initial value for the given alloca.
1506 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1507
Daniel Dunbard0049182010-02-16 19:44:13 +00001508 /// CreateIRTemp - Create a temporary IR object of the given type, with
1509 /// appropriate alignment. This routine should only be used when an temporary
1510 /// value needs to be stored into an alloca (for example, to avoid explicit
1511 /// PHI construction), but the type is the IR type, not the type appropriate
1512 /// for storing in memory.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001513 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001514
Daniel Dunbara7566f12010-02-09 02:48:28 +00001515 /// CreateMemTemp - Create a temporary memory object of the given type, with
1516 /// appropriate alignment.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001517 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001518
John McCall7a626f62010-09-15 10:14:12 +00001519 /// CreateAggTemp - Create a temporary memory object for the given
1520 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001521 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedman38cd36d2011-12-03 02:13:40 +00001522 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001523 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1524 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001525 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001526 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001527 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001528 }
1529
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001530 /// CreateInAllocaTmp - Create a temporary memory object for the given
1531 /// aggregate type.
1532 AggValueSlot CreateInAllocaTmp(QualType T, const Twine &Name = "inalloca");
1533
John McCallad7c5c12011-02-08 08:22:06 +00001534 /// Emit a cast to void* in the appropriate address space.
1535 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1536
Chris Lattner8394d792007-06-05 20:53:16 +00001537 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1538 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001539 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001540
John McCalla2342eb2010-12-05 02:00:02 +00001541 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1542 void EmitIgnoredExpr(const Expr *E);
1543
Chris Lattner4647a212007-08-31 22:49:20 +00001544 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1545 /// any type. The result is returned as an RValue struct. If this is an
1546 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1547 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001548 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001549 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001550 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001551 AggValueSlot aggSlot = AggValueSlot::ignored(),
1552 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001553
Mike Stumpfc496822009-02-08 23:14:22 +00001554 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1555 // or the value of the expression, depending on how va_list is defined.
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001556 llvm::Value *EmitVAListRef(const Expr *E);
1557
Mike Stumpfc496822009-02-08 23:14:22 +00001558 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1559 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001560 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001561
John McCall91ca10f2011-03-08 09:11:50 +00001562 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001563 /// arbitrary expression into the given memory location.
John McCall21886962010-04-21 10:05:39 +00001564 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001565 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001566
John McCall91ca10f2011-03-08 09:11:50 +00001567 /// EmitExprAsInit - Emits the code necessary to initialize a
1568 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001569 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001570 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001571
Fariborz Jahanian78652202013-01-25 23:57:05 +00001572 /// hasVolatileMember - returns true if aggregate type has a volatile
1573 /// member.
1574 bool hasVolatileMember(QualType T) {
1575 if (const RecordType *RT = T->getAs<RecordType>()) {
1576 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1577 return RD->hasVolatileMember();
1578 }
1579 return false;
1580 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001581 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001582 ///
1583 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1584 /// This is required for correctness when assigning non-POD structures in C++.
1585 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001586 QualType EltTy) {
1587 bool IsVolatile = hasVolatileMember(EltTy);
1588 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1589 true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001590 }
1591
David Majnemerfd1e7392015-02-03 23:04:06 +00001592 void EmitAggregateCopyCtor(llvm::Value *DestPtr, llvm::Value *SrcPtr,
1593 QualType DestTy, QualType SrcTy) {
1594 CharUnits DestTypeAlign = getContext().getTypeAlignInChars(DestTy);
1595 CharUnits SrcTypeAlign = getContext().getTypeAlignInChars(SrcTy);
1596 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
1597 std::min(DestTypeAlign, SrcTypeAlign),
1598 /*IsAssignment=*/false);
1599 }
1600
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001601 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001602 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001603 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001604 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001605 /// \param isAssignment - If false, allow padding to be copied. This often
1606 /// yields more efficient.
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001607 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001608 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001609 CharUnits Alignment = CharUnits::Zero(),
1610 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001611
Devang Patelda5d6bb2007-10-04 23:45:31 +00001612 /// StartBlock - Start new block named N. If insert block is a dummy block
1613 /// then reuse it.
1614 void StartBlock(const char *N);
1615
Anders Carlsson9396a892008-09-11 09:15:33 +00001616 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall5d865c322010-08-31 07:33:07 +00001617 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1618 llvm::Value *Res = LocalDeclMap[VD];
1619 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1620 return Res;
1621 }
Mike Stumpfc496822009-02-08 23:14:22 +00001622
John McCallc07a0c72011-02-17 10:25:35 +00001623 /// getOpaqueLValueMapping - Given an opaque value expression (which
1624 /// must be mapped to an l-value), return its mapping.
1625 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1626 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1627
1628 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1629 it = OpaqueLValues.find(e);
1630 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1631 return it->second;
1632 }
1633
1634 /// getOpaqueRValueMapping - Given an opaque value expression (which
1635 /// must be mapped to an r-value), return its mapping.
1636 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1637 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1638
1639 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1640 it = OpaqueRValues.find(e);
1641 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001642 return it->second;
1643 }
1644
Dan Gohman75d69da2008-05-22 00:50:06 +00001645 /// getAccessedFieldNo - Given an encoded value and a result number, return
1646 /// the input field number being accessed.
1647 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1648
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001649 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001650 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001651
Anders Carlssonc0964b62010-05-22 17:35:42 +00001652 /// EmitNullInitialization - Generate code to set a value of the given type to
1653 /// null, If the type contains data member pointers, they will be initialized
1654 /// to -1 in accordance with the Itanium C++ ABI.
1655 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001656
1657 // EmitVAArg - Generate code to get an argument from the passed in pointer
1658 // and update it accordingly. The return value is a pointer to the argument.
1659 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001660 // instruction in LLVM instead once it works well enough.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001661 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001662
John McCall82fe67b2011-07-09 01:37:26 +00001663 /// emitArrayLength - Compute the length of an array, even if it's a
1664 /// VLA, and drill down to the base element type.
1665 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1666 QualType &baseType,
1667 llvm::Value *&addr);
1668
John McCall23c29fe2011-06-24 21:55:10 +00001669 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1670 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001671 ///
1672 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001673 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001674
John McCall23c29fe2011-06-24 21:55:10 +00001675 /// getVLASize - Returns an LLVM value that corresponds to the size,
1676 /// in non-variably-sized elements, of a variable length array type,
1677 /// plus that largest non-variably-sized element type. Assumes that
1678 /// the type has already been emitted with EmitVariablyModifiedType.
1679 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1680 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001681
Anders Carlssona5d077d2009-04-14 16:58:56 +00001682 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1683 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001684 llvm::Value *LoadCXXThis() {
1685 assert(CXXThisValue && "no 'this' value for this function");
1686 return CXXThisValue;
1687 }
Mike Stump11289f42009-09-09 15:08:12 +00001688
Anders Carlssone36a6b32010-01-02 01:01:18 +00001689 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1690 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001691 // FIXME: Every place that calls LoadCXXVTT is something
1692 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001693 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001694 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1695 return CXXStructorImplicitParamValue;
1696 }
1697
1698 /// LoadCXXStructorImplicitParam - Load the implicit parameter
1699 /// for a constructor/destructor.
1700 llvm::Value *LoadCXXStructorImplicitParam() {
1701 assert(CXXStructorImplicitParamValue &&
1702 "no implicit argument value for this function");
1703 return CXXStructorImplicitParamValue;
John McCall347132b2010-02-16 22:04:33 +00001704 }
John McCall6ce74722010-02-16 04:15:37 +00001705
1706 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001707 /// complete class to the given direct base.
1708 llvm::Value *
1709 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1710 const CXXRecordDecl *Derived,
1711 const CXXRecordDecl *Base,
1712 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001713
Mike Stumpe5311b02009-11-30 20:08:49 +00001714 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1715 /// load of 'this' and returns address of the base class.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001716 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001717 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001718 CastExpr::path_const_iterator PathBegin,
1719 CastExpr::path_const_iterator PathEnd,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001720 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001721
Anders Carlsson8c793172009-11-23 17:57:54 +00001722 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001723 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001724 CastExpr::path_const_iterator PathBegin,
1725 CastExpr::path_const_iterator PathEnd,
Anders Carlsson8c793172009-11-23 17:57:54 +00001726 bool NullCheckValue);
1727
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001728 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1729 /// base constructor/destructor with virtual bases.
1730 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1731 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1732 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1733 bool Delegating);
1734
John McCallf8ff7b92010-02-23 00:48:20 +00001735 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1736 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001737 const FunctionArgList &Args,
1738 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001739 // It's important not to confuse this and the previous function. Delegating
1740 // constructors are the C++0x feature. The constructor delegate optimization
1741 // is used to reduce duplication in the base and complete consturctors where
1742 // they are substantially the same.
1743 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1744 const FunctionArgList &Args);
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001745 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001746 bool ForVirtualBase, bool Delegating,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001747 llvm::Value *This, const CXXConstructExpr *E);
1748
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001749 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1750 llvm::Value *This, llvm::Value *Src,
Alexey Samsonov525bf652014-08-25 21:58:56 +00001751 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001752
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001753 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001754 const ConstantArrayType *ArrayTy,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001755 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001756 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001757 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001758
Anders Carlssond49844b2009-09-23 02:45:36 +00001759 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1760 llvm::Value *NumElements,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001761 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001762 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001763 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001764
John McCall82fe67b2011-07-09 01:37:26 +00001765 static Destroyer destroyCXXObject;
1766
Anders Carlsson0a637412009-05-29 21:03:38 +00001767 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001768 bool ForVirtualBase, bool Delegating,
1769 llvm::Value *This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001770
John McCall99210dc2011-09-15 06:49:18 +00001771 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
Richard Smith06a67e22014-06-03 06:58:52 +00001772 llvm::Value *NewPtr, llvm::Value *NumElements,
1773 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00001774
Peter Collingbourne702b2842011-11-27 22:09:22 +00001775 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1776 llvm::Value *Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001777
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001778 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001779 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001780
Eli Friedman24f55432009-11-18 00:57:03 +00001781 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1782 QualType DeleteTy);
1783
Richard Smith760520b2014-06-03 23:27:44 +00001784 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1785 const Expr *Arg, bool IsDelete);
1786
Mike Stumpc9b231c2009-11-15 08:09:41 +00001787 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stump65511702009-11-16 06:50:58 +00001788 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Nico Webercf4ff5862012-10-11 10:13:44 +00001789 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001790
Richard Smith69d0d262012-08-24 00:54:33 +00001791 /// \brief Situations in which we might emit a check for the suitability of a
1792 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001793 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001794 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001795 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001796 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001797 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001798 /// Checking the bound value in a reference binding. Must be suitably sized
1799 /// and aligned, but is not required to refer to an object (until the
1800 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001801 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001802 /// Checking the object expression in a non-static data member access. Must
1803 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001804 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001805 /// Checking the 'this' pointer for a call to a non-static member function.
1806 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001807 TCK_MemberCall,
1808 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001809 TCK_ConstructorCall,
1810 /// Checking the operand of a static_cast to a derived pointer type. Must be
1811 /// null or an object within its lifetime.
1812 TCK_DowncastPointer,
1813 /// Checking the operand of a static_cast to a derived reference type. Must
1814 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001815 TCK_DowncastReference,
1816 /// Checking the operand of a cast to a base object. Must be suitably sized
1817 /// and aligned.
1818 TCK_Upcast,
1819 /// Checking the operand of a cast to a virtual base object. Must be an
1820 /// object within its lifetime.
1821 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00001822 };
1823
Alexey Samsonovac4afe42014-07-07 23:59:57 +00001824 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
1825 /// calls to EmitTypeCheck can be skipped.
1826 bool sanitizePerformTypeCheck() const;
1827
Richard Smith4d1458e2012-09-08 02:08:36 +00001828 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001829 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001830 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001831 QualType Type, CharUnits Alignment = CharUnits::Zero(),
1832 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001833
Richard Smith539e4a72013-02-23 02:53:19 +00001834 /// \brief Emit a check that \p Base points into an array object, which
1835 /// we can access at index \p Index. \p Accessed should be \c false if we
1836 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1837 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1838 QualType IndexType, bool Accessed);
1839
Chris Lattner116ce8f2010-01-09 21:40:03 +00001840 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1841 bool isInc, bool isPre);
1842 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1843 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00001844
1845 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00001846 llvm::Value *OffsetValue = nullptr) {
1847 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
1848 OffsetValue);
1849 }
Hal Finkelbcc06082014-09-07 22:58:14 +00001850
Chris Lattner8394d792007-06-05 20:53:16 +00001851 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001852 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001853 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001854
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001855 /// EmitDecl - Emit a declaration.
1856 ///
1857 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001858 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001859
John McCall1c9c3fd2010-10-15 04:57:14 +00001860 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001861 ///
1862 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001863 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001864
David Blaikie73ca5692014-12-09 00:32:22 +00001865 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001866 bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00001867 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001868
John McCallbd309292010-07-06 01:34:17 +00001869 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1870 llvm::Value *Address);
1871
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001872 /// \brief Determine whether the given initializer is trivial in the sense
1873 /// that it requires no code to be generated.
1874 bool isTrivialInitializer(const Expr *Init);
1875
John McCall1c9c3fd2010-10-15 04:57:14 +00001876 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001877 ///
1878 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00001879 void EmitAutoVarDecl(const VarDecl &D);
1880
1881 class AutoVarEmission {
1882 friend class CodeGenFunction;
1883
John McCall9e2e22f2011-02-22 07:16:58 +00001884 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00001885
1886 /// The alignment of the variable.
1887 CharUnits Alignment;
1888
1889 /// The address of the alloca. Null if the variable was emitted
1890 /// as a global constant.
1891 llvm::Value *Address;
1892
1893 llvm::Value *NRVOFlag;
1894
1895 /// True if the variable is a __block variable.
1896 bool IsByRef;
1897
1898 /// True if the variable is of aggregate type and has a constant
1899 /// initializer.
1900 bool IsConstantAggregate;
1901
Nadav Rotem1da30942013-03-23 06:43:35 +00001902 /// Non-null if we should use lifetime annotations.
1903 llvm::Value *SizeForLifetimeMarkers;
1904
John McCall9e2e22f2011-02-22 07:16:58 +00001905 struct Invalid {};
Craig Topper8a13c412014-05-21 05:09:00 +00001906 AutoVarEmission(Invalid) : Variable(nullptr) {}
John McCall9e2e22f2011-02-22 07:16:58 +00001907
John McCallc533cb72011-02-22 06:44:22 +00001908 AutoVarEmission(const VarDecl &variable)
Craig Topper8a13c412014-05-21 05:09:00 +00001909 : Variable(&variable), Address(nullptr), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00001910 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00001911 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00001912
Craig Topper8a13c412014-05-21 05:09:00 +00001913 bool wasEmittedAsGlobal() const { return Address == nullptr; }
John McCallc533cb72011-02-22 06:44:22 +00001914
1915 public:
John McCall9e2e22f2011-02-22 07:16:58 +00001916 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1917
Craig Topper8a13c412014-05-21 05:09:00 +00001918 bool useLifetimeMarkers() const {
1919 return SizeForLifetimeMarkers != nullptr;
1920 }
Nadav Rotem1da30942013-03-23 06:43:35 +00001921 llvm::Value *getSizeForLifetimeMarkers() const {
1922 assert(useLifetimeMarkers());
1923 return SizeForLifetimeMarkers;
1924 }
1925
1926 /// Returns the raw, allocated address, which is not necessarily
1927 /// the address of the object itself.
1928 llvm::Value *getAllocatedAddress() const {
1929 return Address;
1930 }
1931
John McCallc533cb72011-02-22 06:44:22 +00001932 /// Returns the address of the object within this declaration.
1933 /// Note that this does not chase the forwarding pointer for
1934 /// __block decls.
1935 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1936 if (!IsByRef) return Address;
1937
1938 return CGF.Builder.CreateStructGEP(Address,
John McCall9e2e22f2011-02-22 07:16:58 +00001939 CGF.getByRefValueLLVMField(Variable),
1940 Variable->getNameAsString());
John McCallc533cb72011-02-22 06:44:22 +00001941 }
1942 };
1943 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1944 void EmitAutoVarInit(const AutoVarEmission &emission);
1945 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00001946 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1947 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001948
John McCall1c9c3fd2010-10-15 04:57:14 +00001949 void EmitStaticVarDecl(const VarDecl &D,
1950 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001951
1952 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001953 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, bool ArgIsPointer,
1954 unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00001955
John McCallc07a0c72011-02-17 10:25:35 +00001956 /// protectFromPeepholes - Protect a value that we're intending to
1957 /// store to the side, but which will probably be used later, from
1958 /// aggressive peepholing optimizations that might delete it.
1959 ///
1960 /// Pass the result to unprotectFromPeepholes to declare that
1961 /// protection is no longer required.
1962 ///
1963 /// There's no particular reason why this shouldn't apply to
1964 /// l-values, it's just that no existing peepholes work on pointers.
1965 PeepholeProtection protectFromPeepholes(RValue rvalue);
1966 void unprotectFromPeepholes(PeepholeProtection protection);
1967
Chris Lattner84915fa2007-06-02 04:16:21 +00001968 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00001969 // Statement Emission
1970 //===--------------------------------------------------------------------===//
1971
Mike Stumpfc496822009-02-08 23:14:22 +00001972 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001973 void EmitStopPoint(const Stmt *S);
1974
Mike Stumpfc496822009-02-08 23:14:22 +00001975 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1976 /// this function even if there is no current insertion point.
1977 ///
1978 /// This function may clear the current insertion point; callers should use
1979 /// EnsureInsertPoint if they wish to subsequently generate code without first
1980 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00001981 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001982
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001983 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00001984 /// necessarily require an insertion point or debug information; typically
1985 /// because the statement amounts to a jump or a container of other
1986 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001987 ///
1988 /// \return True if the statement was handled.
1989 bool EmitSimpleStmt(const Stmt *S);
1990
Eli Friedman4871a462013-06-10 22:04:49 +00001991 llvm::Value *EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
1992 AggValueSlot AVS = AggValueSlot::ignored());
1993 llvm::Value *EmitCompoundStmtWithoutScope(const CompoundStmt &S,
1994 bool GetLast = false,
1995 AggValueSlot AVS =
1996 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001997
Mike Stumpfc496822009-02-08 23:14:22 +00001998 /// EmitLabel - Emit the block for the given label. It is legal to call this
1999 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002000 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002001
Chris Lattnerac248202007-05-30 00:13:02 +00002002 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002003 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002004 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002005 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002006 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002007
2008 void EmitCondBrHints(llvm::LLVMContext &Context, llvm::BranchInst *CondBr,
Craig Topper3cb91b22014-08-27 06:28:16 +00002009 ArrayRef<const Attr *> Attrs);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002010 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002011 ArrayRef<const Attr *> Attrs = None);
2012 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002013 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002014 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002015 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002016 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002017 void EmitBreakStmt(const BreakStmt &S);
2018 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002019 void EmitSwitchStmt(const SwitchStmt &S);
2020 void EmitDefaultStmt(const DefaultStmt &S);
2021 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002022 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002023 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002024
Anders Carlsson2e744e82008-08-30 19:51:14 +00002025 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002026 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2027 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002028 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002029 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002030
John McCallb609d3f2010-07-07 06:56:46 +00002031 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2032 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002033
Anders Carlsson52d78a52009-09-27 18:58:34 +00002034 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002035 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002036 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Kleckneraca01db2015-02-04 22:37:07 +00002037 void EnterSEHTryStmt(const SEHTryStmt &S, SEHFinallyInfo &FI);
2038 void ExitSEHTryStmt(const SEHTryStmt &S, SEHFinallyInfo &FI);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002039
2040 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2041 const SEHExceptStmt &Except);
2042
2043 void EmitSEHExceptionCodeSave();
2044 llvm::Value *EmitSEHExceptionCode();
2045 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002046 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002047
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002048 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002049 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002050
Alexey Bataev330de032014-10-29 12:21:55 +00002051 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002052 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002053 void GenerateCapturedStmtFunctionProlog(const CapturedStmt &S);
2054 llvm::Function *GenerateCapturedStmtFunctionEpilog(const CapturedStmt &S);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002055 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev9959db52014-05-06 10:08:46 +00002056 llvm::Value *GenerateCapturedStmtArgument(const CapturedStmt &S);
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002057 void EmitOMPAggregateAssign(LValue OriginalAddr, llvm::Value *PrivateAddr,
2058 const Expr *AssignExpr, QualType Type,
2059 const VarDecl *VDInit);
2060 void EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002061 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002062 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2063 OMPPrivateScope &PrivateScope);
Alexey Bataev9959db52014-05-06 10:08:46 +00002064
2065 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002066 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002067 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002068 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002069 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002070 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002071 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002072 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002073 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002074 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002075 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002076 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002077 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002078 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002079 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002080 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002081 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002082 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002083 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002084 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002085 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002086
Alexander Musmanc6388682014-12-15 07:07:06 +00002087private:
2088
2089 /// Helpers for the OpenMP loop directives.
Alexander Musmand196ef22014-10-07 08:57:09 +00002090 void EmitOMPLoopBody(const OMPLoopDirective &Directive,
2091 bool SeparateIter = false);
2092 void EmitOMPInnerLoop(const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
2093 bool SeparateIter = false);
Alexander Musmana5f070a2014-10-01 06:03:56 +00002094 void EmitOMPSimdFinal(const OMPLoopDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002095 void EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Alexander Musmandf7a8e22015-01-22 08:49:35 +00002096 void EmitOMPForOuterLoop(OpenMPScheduleClauseKind ScheduleKind,
2097 const OMPLoopDirective &S,
2098 OMPPrivateScope &LoopScope, llvm::Value *LB,
2099 llvm::Value *UB, llvm::Value *ST, llvm::Value *IL,
2100 llvm::Value *Chunk);
Alexander Musmanc6388682014-12-15 07:07:06 +00002101
2102public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002103
Chris Lattner208ae962007-05-30 17:57:17 +00002104 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002105 // LValue Expression Emission
2106 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002107
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002108 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2109 RValue GetUndefRValue(QualType Ty);
2110
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002111 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2112 /// and issue an ErrorUnsupported style diagnostic (using the
2113 /// provided Name).
2114 RValue EmitUnsupportedRValue(const Expr *E,
2115 const char *Name);
2116
Mike Stumpfc496822009-02-08 23:14:22 +00002117 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2118 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002119 LValue EmitUnsupportedLValue(const Expr *E,
2120 const char *Name);
2121
Chris Lattner8394d792007-06-05 20:53:16 +00002122 /// EmitLValue - Emit code to compute a designator that specifies the location
2123 /// of the expression.
2124 ///
2125 /// This can return one of two things: a simple address or a bitfield
2126 /// reference. In either case, the LLVM Value* in the LValue structure is
2127 /// guaranteed to be an LLVM pointer type.
2128 ///
2129 /// If this returns a bitfield reference, nothing about the pointee type of
2130 /// the LLVM value is known: For example, it may not be a pointer to an
2131 /// integer.
2132 ///
2133 /// If this returns a normal address, and if the lvalue's C type is fixed
2134 /// size, this method guarantees that the returned pointer type will point to
2135 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2136 /// variable length type, this is not possible.
2137 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002138 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002139
Richard Smith4d1458e2012-09-08 02:08:36 +00002140 /// \brief Same as EmitLValue but additionally we generate checking code to
2141 /// guard against undefined behavior. This is only suitable when we know
2142 /// that the address will be used to access the object.
2143 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002144
Nick Lewycky2d84e842013-10-02 02:29:49 +00002145 RValue convertTempToRValue(llvm::Value *addr, QualType type,
2146 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002147
John McCalla8ec7eb2013-03-07 21:37:17 +00002148 void EmitAtomicInit(Expr *E, LValue lvalue);
2149
Nick Lewycky2d84e842013-10-02 02:29:49 +00002150 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
John McCalla8ec7eb2013-03-07 21:37:17 +00002151 AggValueSlot slot = AggValueSlot::ignored());
2152
2153 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2154
Alexey Bataev452d8e12014-12-15 05:25:25 +00002155 std::pair<RValue, RValue> EmitAtomicCompareExchange(
2156 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
2157 llvm::AtomicOrdering Success = llvm::SequentiallyConsistent,
2158 llvm::AtomicOrdering Failure = llvm::SequentiallyConsistent,
2159 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2160
John McCall3a7f6922010-10-27 20:58:56 +00002161 /// EmitToMemory - Change a scalar value from its value
2162 /// representation to its in-memory representation.
2163 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2164
2165 /// EmitFromMemory - Change a scalar value from its memory
2166 /// representation to its value representation.
2167 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2168
Daniel Dunbar1d425462009-02-10 00:57:50 +00002169 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2170 /// care to appropriately convert from the memory representation to
2171 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002172 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman947c9af2010-10-14 23:06:10 +00002173 unsigned Alignment, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002174 SourceLocation Loc,
Craig Topper8a13c412014-05-21 05:09:00 +00002175 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002176 QualType TBAABaseTy = QualType(),
2177 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002178
2179 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2180 /// care to appropriately convert from the memory representation to
2181 /// the LLVM value representation. The l-value must be a simple
2182 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002183 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002184
2185 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2186 /// care to appropriately convert from the memory representation to
2187 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002188 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman947c9af2010-10-14 23:06:10 +00002189 bool Volatile, unsigned Alignment, QualType Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00002190 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002191 QualType TBAABaseTy = QualType(),
2192 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002193
2194 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2195 /// care to appropriately convert from the memory representation to
2196 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002197 /// l-value. The isInit flag indicates whether this is an initialization.
2198 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2199 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002200
Chris Lattner8394d792007-06-05 20:53:16 +00002201 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2202 /// this method emits the address of the lvalue, then loads the result as an
2203 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002204 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002205 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2206 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002207 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002208
Chris Lattner8394d792007-06-05 20:53:16 +00002209 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2210 /// lvalue, where both are guaranteed to the have the same type, and that type
2211 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002212 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002213 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002214 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002215
Nick Lewycky2d84e842013-10-02 02:29:49 +00002216 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2217 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002218 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002219 /// \param Result [out] - If non-null, this will be set to a Value* for the
2220 /// bit-field contents after the store, appropriate for use as the result of
2221 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002222 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002223 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002224
John McCall4f29b492010-11-16 23:07:28 +00002225 /// Emit an l-value for an assignment (simple or compound) of complex type.
2226 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002227 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002228 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2229 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002230
Chris Lattner57540c52011-04-15 05:22:18 +00002231 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002232 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002233 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002234 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002235 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002236 // Note: only available for agg return types
2237 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002238 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Renato Golin230c5eb2014-05-19 18:15:42 +00002239 LValue EmitReadRegister(const VarDecl *VD);
Chris Lattner4347e3692007-06-06 04:54:52 +00002240 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002241 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002242 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002243 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002244 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2245 bool Accessed = false);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002246 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002247 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002248 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002249 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002250 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002251 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002252 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002253 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002254 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002255
2256 llvm::Value *EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002257
Nick Lewycky2d84e842013-10-02 02:29:49 +00002258 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002259
John McCall71335052012-03-10 03:05:10 +00002260 class ConstantEmission {
2261 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2262 ConstantEmission(llvm::Constant *C, bool isReference)
2263 : ValueAndIsReference(C, isReference) {}
2264 public:
2265 ConstantEmission() {}
2266 static ConstantEmission forReference(llvm::Constant *C) {
2267 return ConstantEmission(C, true);
2268 }
2269 static ConstantEmission forValue(llvm::Constant *C) {
2270 return ConstantEmission(C, false);
2271 }
2272
Craig Topper8a13c412014-05-21 05:09:00 +00002273 LLVM_EXPLICIT operator bool() const {
2274 return ValueAndIsReference.getOpaqueValue() != nullptr;
2275 }
John McCall71335052012-03-10 03:05:10 +00002276
2277 bool isReference() const { return ValueAndIsReference.getInt(); }
2278 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2279 assert(isReference());
2280 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2281 refExpr->getType());
2282 }
2283
2284 llvm::Constant *getValue() const {
2285 assert(!isReference());
2286 return ValueAndIsReference.getPointer();
2287 }
2288 };
2289
John McCall113bee02012-03-10 09:33:50 +00002290 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002291
John McCallfe96e0b2011-11-06 09:01:30 +00002292 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2293 AggValueSlot slot = AggValueSlot::ignored());
2294 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2295
Daniel Dunbar722f4242009-04-22 05:08:15 +00002296 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002297 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002298 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002299 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002300
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002301 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2302 /// if the Field is a reference, this will return the address of the reference
2303 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002304 LValue EmitLValueForFieldInitialization(LValue Base,
2305 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002306
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002307 LValue EmitLValueForIvar(QualType ObjectTy,
2308 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002309 unsigned CVRQualifiers);
2310
Anders Carlsson3be22e22009-05-30 23:23:33 +00002311 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002312 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002313 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002314 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002315 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002316
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002317 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002318 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002319 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002320 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002321 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002322 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002323
Chris Lattnerd7f58862007-06-02 05:24:33 +00002324 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002325 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002326 //===--------------------------------------------------------------------===//
2327
Mike Stumpfc496822009-02-08 23:14:22 +00002328 /// EmitCall - Generate a call of the given function, expecting the given
2329 /// result type, and using the given argument list which specifies both the
2330 /// LLVM arguments and the types they were derived from.
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002331 ///
Mike Stumpe5311b02009-11-30 20:08:49 +00002332 /// \param TargetDecl - If given, the decl of the function in a direct call;
2333 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbard931a872009-02-02 22:03:45 +00002334 RValue EmitCall(const CGFunctionInfo &FnInfo,
2335 llvm::Value *Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00002336 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002337 const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00002338 const Decl *TargetDecl = nullptr,
2339 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002340
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002341 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002342 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00002343 const Decl *TargetDecl = nullptr,
2344 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002345 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002346 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002347
John McCall882987f2013-02-28 19:01:20 +00002348 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2349 const Twine &name = "");
2350 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2351 ArrayRef<llvm::Value*> args,
2352 const Twine &name = "");
2353 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2354 const Twine &name = "");
2355 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2356 ArrayRef<llvm::Value*> args,
2357 const Twine &name = "");
2358
John McCallbd309292010-07-06 01:34:17 +00002359 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002360 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002361 const Twine &Name = "");
Jay Foad5bd375a2011-07-15 08:37:34 +00002362 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002363 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002364 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2365 ArrayRef<llvm::Value*> args,
2366 const Twine &name = "");
2367 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2368 const Twine &name = "");
2369 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2370 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002371
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002372 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2373 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002374 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002375
2376 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2377 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002378 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002379
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002380 RValue
2381 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2382 ReturnValueSlot ReturnValue, llvm::Value *This,
2383 llvm::Value *ImplicitParam,
2384 QualType ImplicitParamTy, const CallExpr *E);
David Majnemer0c0b6d92014-10-31 20:09:12 +00002385 RValue EmitCXXStructorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2386 ReturnValueSlot ReturnValue, llvm::Value *This,
2387 llvm::Value *ImplicitParam,
2388 QualType ImplicitParamTy, const CallExpr *E,
2389 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002390 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2391 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002392 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2393 const CXXMethodDecl *MD,
2394 ReturnValueSlot ReturnValue,
2395 bool HasQualifier,
2396 NestedNameSpecifier *Qualifier,
2397 bool IsArrow, const Expr *Base);
2398 // Compute the object pointer.
Anders Carlssonbfb36712009-12-24 21:13:40 +00002399 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2400 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002401
Anders Carlsson4034a952009-05-27 04:18:27 +00002402 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002403 const CXXMethodDecl *MD,
2404 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002405
Peter Collingbournefe883422011-10-06 18:29:37 +00002406 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2407 ReturnValueSlot ReturnValue);
2408
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002409
Mike Stump11289f42009-09-09 15:08:12 +00002410 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002411 unsigned BuiltinID, const CallExpr *E,
2412 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002413
Anders Carlssonbfb36712009-12-24 21:13:40 +00002414 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002415
Mike Stumpfc496822009-02-08 23:14:22 +00002416 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2417 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002418 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2419
Kevin Qin1718af62013-11-14 02:45:18 +00002420 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2421 const llvm::CmpInst::Predicate Fp,
2422 const llvm::CmpInst::Predicate Ip,
2423 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002424 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002425
2426 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2427 unsigned LLVMIntrinsic,
2428 unsigned AltLLVMIntrinsic,
2429 const char *NameHint,
2430 unsigned Modifier,
2431 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002432 SmallVectorImpl<llvm::Value *> &Ops,
Craig Topper8a13c412014-05-21 05:09:00 +00002433 llvm::Value *Align = nullptr);
Tim Northover8fe03d62014-02-21 11:57:24 +00002434 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2435 unsigned Modifier, llvm::Type *ArgTy,
2436 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002437 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002438 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002439 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002440 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002441 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002442 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002443 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002444 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2445 llvm::Type *Ty, bool usgn, const char *name);
Tim Northover573cbee2014-05-24 12:52:07 +00002446 // Helper functions for EmitAArch64BuiltinExpr.
Tim Northovera2ee4332014-03-29 15:09:45 +00002447 llvm::Value *vectorWrapScalar8(llvm::Value *Op);
2448 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
2449 llvm::Value *emitVectorWrappedScalar8Intrinsic(
2450 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
2451 llvm::Value *emitVectorWrappedScalar16Intrinsic(
2452 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
Tim Northover573cbee2014-05-24 12:52:07 +00002453 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northovera2ee4332014-03-29 15:09:45 +00002454 llvm::Value *EmitNeon64Call(llvm::Function *F,
2455 llvm::SmallVectorImpl<llvm::Value *> &O,
2456 const char *name);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002457
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002458 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002459 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2460 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault56f008d2014-06-24 20:45:01 +00002461 llvm::Value *EmitR600BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002462
Daniel Dunbar66912a12008-08-20 00:28:19 +00002463 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002464 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002465 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002466 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2467 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2468 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002469 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002470 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002471 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2472 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002473
John McCall31168b02011-06-15 23:02:42 +00002474 /// Retrieves the default cleanup kind for an ARC cleanup.
2475 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2476 CleanupKind getARCCleanupKind() {
2477 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2478 ? NormalAndEHCleanup : NormalCleanup;
2479 }
2480
2481 // ARC primitives.
2482 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2483 void EmitARCDestroyWeak(llvm::Value *addr);
2484 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2485 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2486 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2487 bool ignored);
2488 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2489 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2490 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2491 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002492 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002493 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002494 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002495 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002496 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2497 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002498 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCallcdda29c2013-03-13 03:10:54 +00002499 void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise);
2500 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCall31168b02011-06-15 23:02:42 +00002501 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2502 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2503 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2504 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2505
2506 std::pair<LValue,llvm::Value*>
2507 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2508 std::pair<LValue,llvm::Value*>
2509 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2510
John McCall248512a2011-10-01 10:32:24 +00002511 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2512
John McCall31168b02011-06-15 23:02:42 +00002513 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2514 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2515 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2516
John McCallff613032011-10-04 06:23:45 +00002517 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002518 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2519 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2520
Craig Topper00bbdcf2014-06-28 23:22:23 +00002521 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002522
John McCall82fe67b2011-07-09 01:37:26 +00002523 static Destroyer destroyARCStrongImprecise;
2524 static Destroyer destroyARCStrongPrecise;
2525 static Destroyer destroyARCWeak;
2526
John McCall31168b02011-06-15 23:02:42 +00002527 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2528 llvm::Value *EmitObjCAutoreleasePoolPush();
2529 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2530 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2531 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2532
Richard Smitha1c9d4d2013-06-12 23:38:09 +00002533 /// \brief Emits a reference binding to the passed in expression.
2534 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002535
Chris Lattner6278e6a2007-08-11 00:04:45 +00002536 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002537 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002538 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002539
2540 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002541
2542 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2543 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002544 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002545
Chris Lattner3474c202007-08-26 06:48:56 +00002546 /// EmitScalarConversion - Emit a conversion from the specified type to the
2547 /// specified destination type, both of which are LLVM scalar types.
2548 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2549 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002550
Chris Lattner42e6b812007-08-26 16:34:22 +00002551 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stumpfc496822009-02-08 23:14:22 +00002552 /// complex type to the specified destination type, where the destination type
2553 /// is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002554 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2555 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002556
2557
John McCall7a626f62010-09-15 10:14:12 +00002558 /// EmitAggExpr - Emit the computation of the specified expression
2559 /// of aggregate type. The result is computed into the given slot,
2560 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002561 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002562
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002563 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2564 /// aggregate type into a temporary LValue.
2565 LValue EmitAggExprToLValue(const Expr *E);
2566
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002567 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2568 /// pointers.
2569 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian879d7262009-08-31 19:33:16 +00002570 QualType Ty);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002571
John McCall1bd25562011-06-24 23:21:27 +00002572 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2573 /// make sure it survives garbage collection until this point.
2574 void EmitExtendGCLifetime(llvm::Value *object);
2575
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002576 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002577 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002578 ComplexPairTy EmitComplexExpr(const Expr *E,
2579 bool IgnoreReal = false,
2580 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002581
John McCall47fb9502013-03-07 21:37:08 +00002582 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2583 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002584 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002585
John McCall47fb9502013-03-07 21:37:08 +00002586 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002587 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00002588
2589 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002590 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002591
Chandler Carruth84537952012-03-30 19:44:53 +00002592 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2593 /// global variable that has already been created for it. If the initializer
2594 /// has a different type than GV does, this may free GV and return a different
2595 /// one. Otherwise it just returns GV.
2596 llvm::GlobalVariable *
2597 AddInitializerToStaticVarDecl(const VarDecl &D,
2598 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002599
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002600
Anders Carlssonf40886a2009-08-08 21:45:14 +00002601 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2602 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002603 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2604 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002605
David Majnemerb3341ea2014-10-05 05:05:40 +00002606 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
2607 llvm::Constant *Addr);
2608
John McCallc84ed6a2012-05-01 06:13:13 +00002609 /// Call atexit() with a function that passes the given argument to
2610 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00002611 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2612 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002613
John McCallcdf7ef52010-11-06 09:44:32 +00002614 /// Emit code in this function to perform a guarded variable
2615 /// initialization. Guarded initializations are used when it's not
2616 /// possible to prove that an initialization will be done exactly
2617 /// once, e.g. with a static local variable or a static data member
2618 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002619 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002620 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002621
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002622 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2623 /// variables.
2624 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00002625 ArrayRef<llvm::Function *> CXXThreadLocals,
Craig Topper8a13c412014-05-21 05:09:00 +00002626 llvm::GlobalVariable *Guard = nullptr);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002627
John McCallee08c532012-04-06 18:21:03 +00002628 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002629 /// variables.
John McCallee08c532012-04-06 18:21:03 +00002630 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2631 const std::vector<std::pair<llvm::WeakVH,
2632 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002633
John McCalla738c252011-03-09 04:27:21 +00002634 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2635 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00002636 llvm::GlobalVariable *Addr,
2637 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002638
John McCall7a626f62010-09-15 10:14:12 +00002639 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002640
2641 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian50198092010-12-02 17:02:11 +00002642 const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00002643
John McCall08ef4662011-11-10 08:15:53 +00002644 void enterFullExpression(const ExprWithCleanups *E) {
2645 if (E->getNumObjects() == 0) return;
2646 enterNonTrivialFullExpression(E);
2647 }
2648 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00002649
Richard Smithea852322013-05-07 21:53:22 +00002650 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00002651
Eli Friedmanc370a7e2012-02-09 03:32:31 +00002652 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2653
Craig Topper8a13c412014-05-21 05:09:00 +00002654 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = nullptr);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00002655
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002656 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002657 // Annotations Emission
2658 //===--------------------------------------------------------------------===//
2659
2660 /// Emit an annotation call (intrinsic or builtin).
2661 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2662 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002663 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002664 SourceLocation Location);
2665
2666 /// Emit local annotations for the local variable V, declared by D.
2667 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2668
2669 /// Emit field annotations for the given field & value. Returns the
2670 /// annotation result.
2671 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2672
2673 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002674 // Internal Helpers
2675 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002676
Chris Lattner5b1964b2008-11-11 07:41:27 +00002677 /// ContainsLabel - Return true if the statement contains a label in it. If
2678 /// this statement is not executed normally, it not containing a label means
2679 /// that we can just remove the code.
2680 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002681
Chris Lattner29911cc2011-02-28 00:18:40 +00002682 /// containsBreak - Return true if the statement contains a break out of it.
2683 /// If the statement (recursively) contains a switch or loop with a break
2684 /// inside of it, this is fine.
2685 static bool containsBreak(const Stmt *S);
2686
Daniel Dunbar682712c2008-11-12 10:12:14 +00002687 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00002688 /// to a constant, or if it does but contains a label, return false. If it
2689 /// constant folds return true and set the boolean result in Result.
2690 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00002691
Chris Lattner29911cc2011-02-28 00:18:40 +00002692 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2693 /// to a constant, or if it does but contains a label, return false. If it
2694 /// constant folds return true and set the folded value.
Richard Trieuc320c742012-07-23 20:21:35 +00002695 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattner29911cc2011-02-28 00:18:40 +00002696
Chris Lattnercd439292008-11-12 08:04:58 +00002697 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2698 /// if statement) to the specified blocks. Based on the condition, this might
2699 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00002700 /// TrueCount should be the number of times we expect the condition to
2701 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00002702 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00002703 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00002704
Richard Smithe30752c2012-10-09 19:52:38 +00002705 /// \brief Emit a description of a type in a format suitable for passing to
2706 /// a runtime sanitizer handler.
2707 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2708
2709 /// \brief Convert a value into a format suitable for passing to a runtime
2710 /// sanitizer handler.
2711 llvm::Value *EmitCheckValue(llvm::Value *V);
2712
2713 /// \brief Emit a description of a source location in a format suitable for
2714 /// passing to a runtime sanitizer handler.
2715 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2716
Richard Smithde670682012-11-01 22:15:34 +00002717 /// \brief Create a basic block that will call a handler function in a
2718 /// sanitizer runtime with the provided arguments, and create a conditional
2719 /// branch to it.
Alexey Samsonove396bfc2014-11-11 22:03:54 +00002720 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerKind>> Checked,
2721 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
2722 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002723
Richard Smithde670682012-11-01 22:15:34 +00002724 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2725 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00002726 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00002727
Anders Carlsson093bdff2010-03-30 03:27:09 +00002728 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00002729 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00002730
John McCall23f66262010-05-26 22:34:26 +00002731 /// EmitDelegateCallArg - We are performing a delegate call; that
2732 /// is, the current function is delegating to another one. Produce
2733 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002734 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
2735 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00002736
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002737 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2738 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00002739 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002740
Chris Lattnercd439292008-11-12 08:04:58 +00002741private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00002742 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002743 void EmitReturnOfRValue(RValue RV, QualType Ty);
2744
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002745 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
2746
2747 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
2748 DeferredReplacements;
2749
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002750 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2751 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2752 ///
2753 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002754 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
2755 SmallVectorImpl<llvm::Argument *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002756
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002757 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
2758 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
2759 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
2760 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
2761 SmallVectorImpl<llvm::Value *> &IRCallArgs,
2762 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00002763
Chad Rosier59df25b2012-08-23 20:00:18 +00002764 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00002765 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00002766
Chad Rosier59df25b2012-08-23 20:00:18 +00002767 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00002768 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002769 std::string &ConstraintStr,
2770 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00002771
Reid Kleckner89077a12013-12-17 19:46:40 +00002772public:
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002773 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00002774 template <typename T>
2775 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002776 CallExpr::const_arg_iterator ArgBeg,
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002777 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002778 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00002779 unsigned ParamsToSkip = 0) {
Reid Kleckner739756c2013-12-04 19:23:12 +00002780 SmallVector<QualType, 16> ArgTypes;
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002781 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002782
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002783 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
2784 "Can't skip parameters if type info is not provided");
2785 if (CallArgTypeInfo) {
2786 // First, use the argument types that the type info knows about
2787 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
2788 E = CallArgTypeInfo->param_type_end();
2789 I != E; ++I, ++Arg) {
2790 assert(Arg != ArgEnd && "Running over edge of argument list!");
Alexey Bataev7cb17892014-12-18 06:54:53 +00002791 assert(
2792 ((*I)->isVariablyModifiedType() ||
2793 getContext()
2794 .getCanonicalType((*I).getNonReferenceType())
2795 .getTypePtr() ==
2796 getContext().getCanonicalType(Arg->getType()).getTypePtr()) &&
2797 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002798 ArgTypes.push_back(*I);
2799 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00002800 }
Mike Stump11289f42009-09-09 15:08:12 +00002801
Reid Kleckner739756c2013-12-04 19:23:12 +00002802 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002803 // function.
2804 assert(
2805 (Arg == ArgEnd || !CallArgTypeInfo || CallArgTypeInfo->isVariadic()) &&
2806 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00002807
Anders Carlsson603d6af2009-04-18 20:20:22 +00002808 // If we still have any arguments, emit them using the type of the argument.
Reid Kleckner739756c2013-12-04 19:23:12 +00002809 for (; Arg != ArgEnd; ++Arg)
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002810 ArgTypes.push_back(getVarArgType(*Arg));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002811
David Blaikie835afb22015-01-21 23:08:17 +00002812 EmitCallArgs(Args, ArgTypes, ArgBeg, ArgEnd, CalleeDecl, ParamsToSkip);
Anders Carlsson603d6af2009-04-18 20:20:22 +00002813 }
John McCalld4f4b7f2010-03-03 04:15:11 +00002814
Reid Kleckner739756c2013-12-04 19:23:12 +00002815 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
2816 CallExpr::const_arg_iterator ArgBeg,
Richard Smith760520b2014-06-03 23:27:44 +00002817 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002818 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00002819 unsigned ParamsToSkip = 0);
Reid Kleckner739756c2013-12-04 19:23:12 +00002820
Reid Kleckner89077a12013-12-17 19:46:40 +00002821private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002822 QualType getVarArgType(const Expr *Arg);
2823
John McCalld4f4b7f2010-03-03 04:15:11 +00002824 const TargetCodeGenInfo &getTargetHooks() const {
2825 return CGM.getTargetCodeGenInfo();
2826 }
John McCall09ae0322010-07-06 23:57:41 +00002827
2828 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00002829
2830 CodeGenModule::ByrefHelpers *
Chris Lattner2192fe52011-07-18 04:24:23 +00002831 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf9b056b2011-03-31 08:03:29 +00002832 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00002833
2834 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00002835
Eli Friedmana5dd5682012-08-23 03:10:17 +00002836 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2837 /// value and compute our best estimate of the alignment of the pointee.
2838 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00002839
2840 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00002841};
Mike Stump11289f42009-09-09 15:08:12 +00002842
John McCallce1de612011-01-26 04:00:11 +00002843/// Helper class with most of the code for saving a value for a
2844/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00002845struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00002846 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2847
2848 /// Answer whether the given value needs extra work to be saved.
2849 static bool needsSaving(llvm::Value *value) {
2850 // If it's not an instruction, we don't need to save.
2851 if (!isa<llvm::Instruction>(value)) return false;
2852
2853 // If it's an instruction in the entry block, we don't need to save.
2854 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2855 return (block != &block->getParent()->getEntryBlock());
2856 }
2857
2858 /// Try to save the given value.
2859 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2860 if (!needsSaving(value)) return saved_type(value, false);
2861
2862 // Otherwise we need an alloca.
2863 llvm::Value *alloca =
2864 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2865 CGF.Builder.CreateStore(value, alloca);
2866
2867 return saved_type(alloca, true);
2868 }
2869
2870 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2871 if (!value.getInt()) return value.getPointer();
2872 return CGF.Builder.CreateLoad(value.getPointer());
2873 }
2874};
2875
John McCallcb5f77f2011-01-28 10:53:53 +00002876/// A partial specialization of DominatingValue for llvm::Values that
2877/// might be llvm::Instructions.
2878template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2879 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00002880 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00002881 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2882 }
2883};
2884
2885/// A specialization of DominatingValue for RValue.
2886template <> struct DominatingValue<RValue> {
2887 typedef RValue type;
2888 class saved_type {
2889 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2890 AggregateAddress, ComplexAddress };
2891
2892 llvm::Value *Value;
2893 Kind K;
2894 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2895
2896 public:
2897 static bool needsSaving(RValue value);
2898 static saved_type save(CodeGenFunction &CGF, RValue value);
2899 RValue restore(CodeGenFunction &CGF);
2900
2901 // implementations in CGExprCXX.cpp
2902 };
2903
2904 static bool needsSaving(type value) {
2905 return saved_type::needsSaving(value);
2906 }
2907 static saved_type save(CodeGenFunction &CGF, type value) {
2908 return saved_type::save(CGF, value);
2909 }
2910 static type restore(CodeGenFunction &CGF, saved_type value) {
2911 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00002912 }
2913};
2914
Chris Lattnerbed31442007-05-28 01:07:47 +00002915} // end namespace CodeGen
2916} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00002917
Chris Lattnerbed31442007-05-28 01:07:47 +00002918#endif