blob: bfef0c9a8d60eb90fd66c1a9ba89d5dee918df70 [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"
Chandler Carruth3a022472012-12-04 09:13:33 +000030#include "clang/Basic/TargetInfo.h"
31#include "clang/Frontend/CodeGenOptions.h"
32#include "llvm/ADT/ArrayRef.h"
33#include "llvm/ADT/DenseMap.h"
34#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000035#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000036#include "llvm/Support/Debug.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000037
Chris Lattnerbed31442007-05-28 01:07:47 +000038namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000039class BasicBlock;
40class LLVMContext;
41class MDNode;
42class Module;
43class SwitchInst;
44class Twine;
45class Value;
46class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000047}
48
Chris Lattnerbed31442007-05-28 01:07:47 +000049namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000050class ASTContext;
51class BlockDecl;
52class CXXDestructorDecl;
53class CXXForRangeStmt;
54class CXXTryStmt;
55class Decl;
56class LabelDecl;
57class EnumConstantDecl;
58class FunctionDecl;
59class FunctionProtoType;
60class LabelStmt;
61class ObjCContainerDecl;
62class ObjCInterfaceDecl;
63class ObjCIvarDecl;
64class ObjCMethodDecl;
65class ObjCImplementationDecl;
66class ObjCPropertyImplDecl;
67class TargetInfo;
68class TargetCodeGenInfo;
69class VarDecl;
70class ObjCForCollectionStmt;
71class ObjCAtTryStmt;
72class ObjCAtThrowStmt;
73class ObjCAtSynchronizedStmt;
74class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000075
Chris Lattnerbed31442007-05-28 01:07:47 +000076namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000077class CodeGenTypes;
78class CGFunctionInfo;
79class CGRecordLayout;
80class CGBlockInfo;
81class CGCXXABI;
82class BlockFlags;
83class BlockFieldFlags;
Mike Stumpfc496822009-02-08 23:14:22 +000084
John McCall47fb9502013-03-07 21:37:08 +000085/// The kind of evaluation to perform on values of a particular
86/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
87/// CGExprAgg?
88///
89/// TODO: should vectors maybe be split out into their own thing?
90enum TypeEvaluationKind {
91 TEK_Scalar,
92 TEK_Complex,
93 TEK_Aggregate
94};
95
David Blaikie1b5adb82014-07-10 20:42:59 +000096class SuppressDebugLocation {
97 llvm::DebugLoc CurLoc;
98 llvm::IRBuilderBase &Builder;
99public:
100 SuppressDebugLocation(llvm::IRBuilderBase &Builder)
101 : CurLoc(Builder.getCurrentDebugLocation()), Builder(Builder) {
102 Builder.SetCurrentDebugLocation(llvm::DebugLoc());
103 }
104 ~SuppressDebugLocation() {
105 Builder.SetCurrentDebugLocation(CurLoc);
106 }
107};
108
Chris Lattnerbed31442007-05-28 01:07:47 +0000109/// CodeGenFunction - This class organizes the per-function state that is used
110/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000111class CodeGenFunction : public CodeGenTypeCache {
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000112 CodeGenFunction(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
113 void operator=(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
John McCall5d865c322010-08-31 07:33:07 +0000114
115 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000116public:
John McCallad5d61e2010-07-23 21:56:41 +0000117 /// A jump destination is an abstract label, branching to which may
118 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000119 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000120 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000121 JumpDest(llvm::BasicBlock *Block,
122 EHScopeStack::stable_iterator Depth,
123 unsigned Index)
124 : Block(Block), ScopeDepth(Depth), Index(Index) {}
125
Craig Topper8a13c412014-05-21 05:09:00 +0000126 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000127 llvm::BasicBlock *getBlock() const { return Block; }
128 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
129 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000130
Nadav Rotem1da30942013-03-23 06:43:35 +0000131 // This should be used cautiously.
132 void setScopeDepth(EHScopeStack::stable_iterator depth) {
133 ScopeDepth = depth;
134 }
135
John McCallad5d61e2010-07-23 21:56:41 +0000136 private:
John McCallbd309292010-07-06 01:34:17 +0000137 llvm::BasicBlock *Block;
138 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000139 unsigned Index;
140 };
141
Chris Lattnerbed31442007-05-28 01:07:47 +0000142 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000143 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000144
Chris Lattner96d72562007-08-21 16:57:55 +0000145 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000146 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000147 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000148
Alexander Musman515ad8c2014-05-22 08:54:05 +0000149 /// \brief CGBuilder insert helper. This function is called after an
150 /// instruction is created using Builder.
151 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
152 llvm::BasicBlock *BB,
153 llvm::BasicBlock::iterator InsertPt) const;
154
John McCalldec348f72013-05-03 07:33:41 +0000155 /// CurFuncDecl - Holds the Decl for the current outermost
156 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000157 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000158 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
159 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000160 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000161 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000162 llvm::Function *CurFn;
163
Mike Stumpbee78dd2009-12-04 23:26:17 +0000164 /// CurGD - The GlobalDecl for the current function being compiled.
165 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000166
John McCall31168b02011-06-15 23:02:42 +0000167 /// PrologueCleanupDepth - The cleanup depth enclosing all the
168 /// cleanups associated with the parameters.
169 EHScopeStack::stable_iterator PrologueCleanupDepth;
170
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000171 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000172 JumpDest ReturnBlock;
173
Mike Stumpfc496822009-02-08 23:14:22 +0000174 /// ReturnValue - The temporary alloca to hold the return value. This is null
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +0000175 /// iff the function has no return value.
Eli Friedman4b1942c2009-12-04 02:43:40 +0000176 llvm::Value *ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000177
Chris Lattner03df1222007-06-02 04:53:11 +0000178 /// AllocaInsertPoint - This is an instruction in the entry block before which
179 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000180 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000181
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000182 /// \brief API for captured statement code generation.
183 class CGCapturedStmtInfo {
184 public:
185 explicit CGCapturedStmtInfo(const CapturedStmt &S,
186 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000187 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000188
189 RecordDecl::field_iterator Field =
190 S.getCapturedRecordDecl()->field_begin();
191 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
192 E = S.capture_end();
193 I != E; ++I, ++Field) {
194 if (I->capturesThis())
195 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000196 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000197 CaptureFields[I->getCapturedVar()] = *Field;
198 }
199 }
200
201 virtual ~CGCapturedStmtInfo();
202
203 CapturedRegionKind getKind() const { return Kind; }
204
205 void setContextValue(llvm::Value *V) { ThisValue = V; }
206 // \brief Retrieve the value of the context parameter.
207 llvm::Value *getContextValue() const { return ThisValue; }
208
209 /// \brief Lookup the captured field decl for a variable.
210 const FieldDecl *lookup(const VarDecl *VD) const {
211 return CaptureFields.lookup(VD);
212 }
213
Craig Topper8a13c412014-05-21 05:09:00 +0000214 bool isCXXThisExprCaptured() const { return CXXThisFieldDecl != nullptr; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000215 FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
216
Alexey Bataev18095712014-10-10 12:19:54 +0000217 static bool classof(const CGCapturedStmtInfo *) {
218 return true;
219 }
220
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000221 /// \brief Emit the captured statement body.
222 virtual void EmitBody(CodeGenFunction &CGF, Stmt *S) {
Justin Bogner81ab90f2014-04-15 00:50:54 +0000223 RegionCounter Cnt = CGF.getPGORegionCounter(S);
224 Cnt.beginRegion(CGF.Builder);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000225 CGF.EmitStmt(S);
226 }
227
228 /// \brief Get the name of the capture helper.
229 virtual StringRef getHelperName() const { return "__captured_stmt"; }
230
231 private:
232 /// \brief The kind of captured statement being generated.
233 CapturedRegionKind Kind;
234
235 /// \brief Keep the map between VarDecl and FieldDecl.
236 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
237
238 /// \brief The base address of the captured record, passed in as the first
239 /// argument of the parallel region function.
240 llvm::Value *ThisValue;
241
242 /// \brief Captured 'this' type.
243 FieldDecl *CXXThisFieldDecl;
244 };
245 CGCapturedStmtInfo *CapturedStmtInfo;
246
Nuno Lopes3d6311d2012-05-08 22:10:46 +0000247 /// BoundsChecking - Emit run-time bounds checks. Higher values mean
248 /// potentially higher performance penalties.
249 unsigned char BoundsChecking;
250
Alexey Samsonova0416102014-11-11 01:26:14 +0000251 /// \brief Sanitizers enabled for this function.
252 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000253
Alexey Samsonov24cad992014-07-17 18:46:27 +0000254 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
255 bool IsSanitizerScope;
256
257 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
258 class SanitizerScope {
259 CodeGenFunction *CGF;
260 public:
261 SanitizerScope(CodeGenFunction *CGF);
262 ~SanitizerScope();
263 };
264
Reid Kleckner19819442014-07-25 21:39:46 +0000265 /// In C++, whether we are code generating a thunk. This controls whether we
266 /// should emit cleanups.
267 bool CurFuncIsThunk;
268
John McCall31168b02011-06-15 23:02:42 +0000269 /// In ARC, whether we should autorelease the return value.
270 bool AutoreleaseResult;
271
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000272 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
273 /// potentially set the return value.
274 bool SawAsmBlock;
275
John McCallad7c5c12011-02-08 08:22:06 +0000276 const CodeGen::CGBlockInfo *BlockInfo;
277 llvm::Value *BlockPointer;
278
Eli Friedman9fbeba02012-02-11 02:57:39 +0000279 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
280 FieldDecl *LambdaThisCaptureField;
281
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000282 /// \brief A mapping from NRVO variables to the flags used to indicate
283 /// when the NRVO has been applied to this variable.
284 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000285
John McCallbd309292010-07-06 01:34:17 +0000286 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000287 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
288
289 /// Header for data within LifetimeExtendedCleanupStack.
290 struct LifetimeExtendedCleanupHeader {
291 /// The size of the following cleanup object.
Reid Klecknerc311aba2014-10-31 23:33:56 +0000292 unsigned Size : 29;
Richard Smith736a9472013-06-12 20:42:33 +0000293 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
294 unsigned Kind : 3;
295
Reid Klecknerc311aba2014-10-31 23:33:56 +0000296 size_t getSize() const { return size_t(Size); }
Richard Smith736a9472013-06-12 20:42:33 +0000297 CleanupKind getKind() const { return static_cast<CleanupKind>(Kind); }
298 };
John McCallbd309292010-07-06 01:34:17 +0000299
John McCallad5d61e2010-07-23 21:56:41 +0000300 /// i32s containing the indexes of the cleanup destinations.
301 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000302
303 unsigned NextCleanupDestIndex;
304
John McCall08ef4662011-11-10 08:15:53 +0000305 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
306 CGBlockInfo *FirstBlockInfo;
307
John McCall8e4c74b2011-08-11 02:22:43 +0000308 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
309 llvm::BasicBlock *EHResumeBlock;
310
Bill Wendlingf0724e82011-09-19 20:31:14 +0000311 /// The exception slot. All landing pads write the current exception pointer
312 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000313 llvm::Value *ExceptionSlot;
314
Bill Wendlingf0724e82011-09-19 20:31:14 +0000315 /// The selector slot. Under the MandatoryCleanup model, all landing pads
316 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000317 llvm::AllocaInst *EHSelectorSlot;
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
John McCallce1de612011-01-26 04:00:11 +0000357 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
358 /// current full-expression. Safe against the possibility that
359 /// we're currently inside a conditionally-evaluated expression.
John McCalle4df6c82011-01-28 08:37:24 +0000360 template <class T, class A0>
361 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
362 // If we're not in a conditional branch, or if none of the
363 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000364 if (!isInConditionalBranch())
365 return EHStack.pushCleanup<T>(kind, a0);
John McCalle4df6c82011-01-28 08:37:24 +0000366
John McCallcb5f77f2011-01-28 10:53:53 +0000367 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCalle4df6c82011-01-28 08:37:24 +0000368
369 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
370 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
371 initFullExprCleanup();
372 }
373
374 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
375 /// current full-expression. Safe against the possibility that
376 /// we're currently inside a conditionally-evaluated expression.
John McCallce1de612011-01-26 04:00:11 +0000377 template <class T, class A0, class A1>
378 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
379 // If we're not in a conditional branch, or if none of the
380 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000381 if (!isInConditionalBranch())
382 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCallce1de612011-01-26 04:00:11 +0000383
John McCallcb5f77f2011-01-28 10:53:53 +0000384 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
385 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCallce1de612011-01-26 04:00:11 +0000386
387 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCalle4df6c82011-01-28 08:37:24 +0000388 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
389 initFullExprCleanup();
John McCallce1de612011-01-26 04:00:11 +0000390 }
391
Douglas Gregor58df5092011-06-22 16:12:01 +0000392 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
393 /// current full-expression. Safe against the possibility that
394 /// we're currently inside a conditionally-evaluated expression.
395 template <class T, class A0, class A1, class A2>
396 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
397 // If we're not in a conditional branch, or if none of the
398 // arguments requires saving, then use the unconditional cleanup.
399 if (!isInConditionalBranch()) {
John McCall5fcf8da2011-07-12 00:15:30 +0000400 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregor58df5092011-06-22 16:12:01 +0000401 }
402
403 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
404 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
405 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
406
407 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
408 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
409 initFullExprCleanup();
410 }
411
John McCall4bd0fb12011-07-12 16:41:08 +0000412 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
413 /// current full-expression. Safe against the possibility that
414 /// we're currently inside a conditionally-evaluated expression.
415 template <class T, class A0, class A1, class A2, class A3>
416 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
417 // If we're not in a conditional branch, or if none of the
418 // arguments requires saving, then use the unconditional cleanup.
419 if (!isInConditionalBranch()) {
420 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
421 }
422
423 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
424 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
425 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
426 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
427
428 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
429 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
430 a2_saved, a3_saved);
431 initFullExprCleanup();
432 }
433
Richard Smith736a9472013-06-12 20:42:33 +0000434 /// \brief Queue a cleanup to be pushed after finishing the current
435 /// full-expression.
436 template <class T, class A0, class A1, class A2, class A3>
437 void pushCleanupAfterFullExpr(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
438 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
439
440 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
441
442 size_t OldSize = LifetimeExtendedCleanupStack.size();
443 LifetimeExtendedCleanupStack.resize(
444 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
445
446 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
447 new (Buffer) LifetimeExtendedCleanupHeader(Header);
448 new (Buffer + sizeof(Header)) T(a0, a1, a2, a3);
449 }
450
John McCallf4beacd2011-11-10 10:43:54 +0000451 /// Set up the last cleaup that was pushed as a conditional
452 /// full-expression cleanup.
453 void initFullExprCleanup();
454
John McCallbd309292010-07-06 01:34:17 +0000455 /// PushDestructorCleanup - Push a cleanup to call the
456 /// complete-object destructor of an object of the given type at the
457 /// given address. Does nothing if T is not a C++ class type with a
458 /// non-trivial destructor.
459 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
460
John McCall8680f872010-07-21 06:29:51 +0000461 /// PushDestructorCleanup - Push a cleanup to call the
462 /// complete-object variant of the given destructor on the object at
463 /// the given address.
464 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
465 llvm::Value *Addr);
466
John McCallbd309292010-07-06 01:34:17 +0000467 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
468 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000469 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000470
John McCall824c2f52010-09-14 07:57:04 +0000471 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
472 /// The block cannot be reactivated. Pops it if it's the top of the
473 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000474 ///
475 /// \param DominatingIP - An instruction which is known to
476 /// dominate the current IP (if set) and which lies along
477 /// all paths of execution between the current IP and the
478 /// the point at which the cleanup comes into scope.
479 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
480 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000481
482 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
483 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000484 ///
485 /// \param DominatingIP - An instruction which is known to
486 /// dominate the current IP (if set) and which lies along
487 /// all paths of execution between the current IP and the
488 /// the point at which the cleanup comes into scope.
489 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
490 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000491
John McCallbd309292010-07-06 01:34:17 +0000492 /// \brief Enters a new scope for capturing cleanups, all of which
493 /// will be executed once the scope is exited.
494 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000495 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000496 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000497 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000498 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000499 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000500 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000501
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000502 RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
503 void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
Douglas Gregor965f4502009-11-24 16:43:22 +0000504
Eric Christophera9d34972011-10-19 00:43:52 +0000505 protected:
506 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000507
Douglas Gregor965f4502009-11-24 16:43:22 +0000508 public:
509 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000510 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000511 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000512 {
John McCallbd309292010-07-06 01:34:17 +0000513 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000514 LifetimeExtendedCleanupStackSize =
515 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000516 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000517 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000518 }
519
520 /// \brief Exit this cleanup scope, emitting any accumulated
521 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000522 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000523 if (PerformCleanup) {
524 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000525 CGF.PopCleanupBlocks(CleanupStackDepth,
526 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000527 }
528 }
529
530 /// \brief Determine whether this scope requires any cleanups.
531 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000532 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000533 }
534
535 /// \brief Force the emission of cleanups now, instead of waiting
536 /// until this object is destroyed.
537 void ForceCleanup() {
538 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000539 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000540 CGF.PopCleanupBlocks(CleanupStackDepth,
541 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000542 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000543 }
544 };
545
David Blaikie93be0b22014-08-22 21:37:04 +0000546 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000547 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000548 SmallVector<const LabelDecl*, 4> Labels;
549 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000550
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000551 LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
552 void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
Eric Christophera9d34972011-10-19 00:43:52 +0000553
554 public:
555 /// \brief Enter a new cleanup scope.
556 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000557 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
558 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000559 if (CGDebugInfo *DI = CGF.getDebugInfo())
560 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
561 }
562
Nadav Rotem1da30942013-03-23 06:43:35 +0000563 void addLabel(const LabelDecl *label) {
564 assert(PerformCleanup && "adding label to dead scope?");
565 Labels.push_back(label);
566 }
567
Eric Christophera9d34972011-10-19 00:43:52 +0000568 /// \brief Exit this cleanup scope, emitting any accumulated
569 /// cleanups.
570 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000571 if (CGDebugInfo *DI = CGF.getDebugInfo())
572 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
573
Nadav Rotem1da30942013-03-23 06:43:35 +0000574 // If we should perform a cleanup, force them now. Note that
575 // this ends the cleanup scope before rescoping any labels.
576 if (PerformCleanup) ForceCleanup();
Eric Christophera9d34972011-10-19 00:43:52 +0000577 }
578
579 /// \brief Force the emission of cleanups now, instead of waiting
580 /// until this object is destroyed.
581 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000582 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000583 RunCleanupsScope::ForceCleanup();
584
Nadav Rotem1da30942013-03-23 06:43:35 +0000585 if (!Labels.empty())
586 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000587 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000588
589 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000590 };
591
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000592 /// \brief The scope used to remap some variables as private in the OpenMP
593 /// loop body (or other captured region emitted without outlining), and to
594 /// restore old vars back on exit.
595 class OMPPrivateScope : public RunCleanupsScope {
596 typedef llvm::DenseMap<const VarDecl *, llvm::Value *> VarDeclMapTy;
597 VarDeclMapTy SavedLocals;
598 VarDeclMapTy SavedPrivates;
599
600 private:
601 OMPPrivateScope(const OMPPrivateScope &) LLVM_DELETED_FUNCTION;
602 void operator=(const OMPPrivateScope &) LLVM_DELETED_FUNCTION;
603
604 public:
605 /// \brief Enter a new OpenMP private scope.
606 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
607
608 /// \brief Registers \a LocalVD variable as a private and apply \a
609 /// PrivateGen function for it to generate corresponding private variable.
610 /// \a PrivateGen returns an address of the generated private variable.
611 /// \return true if the variable is registered as private, false if it has
612 /// been privatized already.
613 bool
614 addPrivate(const VarDecl *LocalVD,
615 const std::function<llvm::Value *()> &PrivateGen) {
616 assert(PerformCleanup && "adding private to dead scope");
617 assert(LocalVD->isLocalVarDecl() && "privatizing non-local variable");
618 if (SavedLocals.count(LocalVD) > 0) return false;
619 SavedLocals[LocalVD] = CGF.LocalDeclMap.lookup(LocalVD);
620 CGF.LocalDeclMap.erase(LocalVD);
621 SavedPrivates[LocalVD] = PrivateGen();
622 CGF.LocalDeclMap[LocalVD] = SavedLocals[LocalVD];
623 return true;
624 }
625
626 /// \brief Privatizes local variables previously registered as private.
627 /// Registration is separate from the actual privatization to allow
628 /// initializers use values of the original variables, not the private one.
629 /// This is important, for example, if the private variable is a class
630 /// variable initialized by a constructor that references other private
631 /// variables. But at initialization original variables must be used, not
632 /// private copies.
633 /// \return true if at least one variable was privatized, false otherwise.
634 bool Privatize() {
635 for (auto VDPair : SavedPrivates) {
636 CGF.LocalDeclMap[VDPair.first] = VDPair.second;
637 }
638 SavedPrivates.clear();
639 return !SavedLocals.empty();
640 }
641
642 void ForceCleanup() {
643 RunCleanupsScope::ForceCleanup();
644 // Remap vars back to the original values.
645 for (auto I : SavedLocals) {
646 CGF.LocalDeclMap[I.first] = I.second;
647 }
648 SavedLocals.clear();
649 }
650
651 /// \brief Exit scope - all the mapped variables are restored.
652 ~OMPPrivateScope() { ForceCleanup(); }
653 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000654
Richard Smith736a9472013-06-12 20:42:33 +0000655 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
656 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000657 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000658
Richard Smith736a9472013-06-12 20:42:33 +0000659 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
660 /// that have been added, then adds all lifetime-extended cleanups from
661 /// the given position to the stack.
662 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
663 size_t OldLifetimeExtendedStackSize);
664
John McCallad5d61e2010-07-23 21:56:41 +0000665 void ResolveBranchFixups(llvm::BasicBlock *Target);
666
John McCallbd309292010-07-06 01:34:17 +0000667 /// The given basic block lies in the current EH scope, but may be a
668 /// target of a potentially scope-crossing jump; get a stable handle
669 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000670 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000671 return JumpDest(Target,
672 EHStack.getInnermostNormalCleanup(),
673 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000674 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000675
John McCallbd309292010-07-06 01:34:17 +0000676 /// The given basic block lies in the current EH scope, but may be a
677 /// target of a potentially scope-crossing jump; get a stable handle
678 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000679 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000680 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000681 }
682
683 /// EmitBranchThroughCleanup - Emit a branch from the current insert
684 /// block through the normal cleanup handling code (if any) and then
685 /// on to \arg Dest.
686 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000687
Justin Bognere25ffdf2014-01-21 00:35:11 +0000688 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
689 /// specified destination obviously has no cleanups to run. 'false' is always
690 /// a conservatively correct answer for this method.
691 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
692
John McCall8e4c74b2011-08-11 02:22:43 +0000693 /// popCatchScope - Pops the catch scope at the top of the EHScope
694 /// stack, emitting any required code (other than the catch handlers
695 /// themselves).
696 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000697
David Chisnall9a837be2012-11-07 16:50:40 +0000698 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000699 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000700
John McCallce1de612011-01-26 04:00:11 +0000701 /// An object to manage conditionally-evaluated expressions.
702 class ConditionalEvaluation {
703 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000704
John McCallce1de612011-01-26 04:00:11 +0000705 public:
706 ConditionalEvaluation(CodeGenFunction &CGF)
707 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000708
John McCallce1de612011-01-26 04:00:11 +0000709 void begin(CodeGenFunction &CGF) {
710 assert(CGF.OutermostConditional != this);
711 if (!CGF.OutermostConditional)
712 CGF.OutermostConditional = this;
713 }
714
715 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000716 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000717 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000718 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000719 }
720
721 /// Returns a block which will be executed prior to each
722 /// evaluation of the conditional code.
723 llvm::BasicBlock *getStartingBlock() const {
724 return StartBB;
725 }
726 };
Mike Stump11289f42009-09-09 15:08:12 +0000727
John McCall7f9c92a2010-09-17 00:50:28 +0000728 /// isInConditionalBranch - Return true if we're currently emitting
729 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000730 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000731
John McCallf4beacd2011-11-10 10:43:54 +0000732 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
733 assert(isInConditionalBranch());
734 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
735 new llvm::StoreInst(value, addr, &block->back());
736 }
737
John McCallce1de612011-01-26 04:00:11 +0000738 /// An RAII object to record that we're evaluating a statement
739 /// expression.
740 class StmtExprEvaluation {
741 CodeGenFunction &CGF;
742
743 /// We have to save the outermost conditional: cleanups in a
744 /// statement expression aren't conditional just because the
745 /// StmtExpr is.
746 ConditionalEvaluation *SavedOutermostConditional;
747
748 public:
749 StmtExprEvaluation(CodeGenFunction &CGF)
750 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000751 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000752 }
753
754 ~StmtExprEvaluation() {
755 CGF.OutermostConditional = SavedOutermostConditional;
756 CGF.EnsureInsertPoint();
757 }
758 };
John McCall1bf58462011-02-16 08:02:54 +0000759
John McCallc07a0c72011-02-17 10:25:35 +0000760 /// An object which temporarily prevents a value from being
761 /// destroyed by aggressive peephole optimizations that assume that
762 /// all uses of a value have been realized in the IR.
763 class PeepholeProtection {
764 llvm::Instruction *Inst;
765 friend class CodeGenFunction;
766
767 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000768 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000769 };
John McCallc07a0c72011-02-17 10:25:35 +0000770
John McCallfe96e0b2011-11-06 09:01:30 +0000771 /// A non-RAII class containing all the information about a bound
772 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
773 /// this which makes individual mappings very simple; using this
774 /// class directly is useful when you have a variable number of
775 /// opaque values or don't want the RAII functionality for some
776 /// reason.
777 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000778 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000779 bool BoundLValue;
780 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000781
John McCallfe96e0b2011-11-06 09:01:30 +0000782 OpaqueValueMappingData(const OpaqueValueExpr *ov,
783 bool boundLValue)
784 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000785 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000786 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000787
John McCallc07a0c72011-02-17 10:25:35 +0000788 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000789 // gl-values should be bound as l-values for obvious reasons.
790 // Records should be bound as l-values because IR generation
791 // always keeps them in memory. Expressions of function type
792 // act exactly like l-values but are formally required to be
793 // r-values in C.
794 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000795 expr->getType()->isFunctionType() ||
796 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000797 }
798
John McCallfe96e0b2011-11-06 09:01:30 +0000799 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
800 const OpaqueValueExpr *ov,
801 const Expr *e) {
802 if (shouldBindAsLValue(ov))
803 return bind(CGF, ov, CGF.EmitLValue(e));
804 return bind(CGF, ov, CGF.EmitAnyExpr(e));
805 }
806
807 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
808 const OpaqueValueExpr *ov,
809 const LValue &lv) {
810 assert(shouldBindAsLValue(ov));
811 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
812 return OpaqueValueMappingData(ov, true);
813 }
814
815 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
816 const OpaqueValueExpr *ov,
817 const RValue &rv) {
818 assert(!shouldBindAsLValue(ov));
819 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
820
821 OpaqueValueMappingData data(ov, false);
822
823 // Work around an extremely aggressive peephole optimization in
824 // EmitScalarConversion which assumes that all other uses of a
825 // value are extant.
826 data.Protection = CGF.protectFromPeepholes(rv);
827
828 return data;
829 }
830
Craig Topper8a13c412014-05-21 05:09:00 +0000831 bool isValid() const { return OpaqueValue != nullptr; }
832 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000833
834 void unbind(CodeGenFunction &CGF) {
835 assert(OpaqueValue && "no data to unbind!");
836
837 if (BoundLValue) {
838 CGF.OpaqueLValues.erase(OpaqueValue);
839 } else {
840 CGF.OpaqueRValues.erase(OpaqueValue);
841 CGF.unprotectFromPeepholes(Protection);
842 }
843 }
844 };
845
846 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
847 class OpaqueValueMapping {
848 CodeGenFunction &CGF;
849 OpaqueValueMappingData Data;
850
851 public:
852 static bool shouldBindAsLValue(const Expr *expr) {
853 return OpaqueValueMappingData::shouldBindAsLValue(expr);
854 }
855
John McCallc07a0c72011-02-17 10:25:35 +0000856 /// Build the opaque value mapping for the given conditional
857 /// operator if it's the GNU ?: extension. This is a common
858 /// enough pattern that the convenience operator is really
859 /// helpful.
860 ///
861 OpaqueValueMapping(CodeGenFunction &CGF,
862 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000863 if (isa<ConditionalOperator>(op))
864 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000865 return;
John McCallc07a0c72011-02-17 10:25:35 +0000866
867 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000868 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
869 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000870 }
871
John McCall1bf58462011-02-16 08:02:54 +0000872 OpaqueValueMapping(CodeGenFunction &CGF,
873 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000874 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000875 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000876 }
877
878 OpaqueValueMapping(CodeGenFunction &CGF,
879 const OpaqueValueExpr *opaqueValue,
880 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000881 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000882 }
883
884 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000885 Data.unbind(CGF);
886 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000887 }
888
889 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000890 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000891 }
892 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000893
894 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
895 /// number that holds the value.
896 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian2f2fa722011-01-26 23:08:27 +0000897
898 /// BuildBlockByrefAddress - Computes address location of the
899 /// variable which is declared as __block.
900 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
901 const VarDecl *V);
Chris Lattner2da04b32007-08-24 05:35:26 +0000902private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000903 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000904 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000905
John McCall9b382dd2011-05-28 21:13:02 +0000906 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
907 /// calling llvm.stacksave for multiple VLAs in the same scope.
908 bool DidCallStackSave;
909
Mike Stumpe5311b02009-11-30 20:08:49 +0000910 /// IndirectBranch - The first time an indirect goto is seen we create a block
911 /// with an indirect branch. Every time we see the address of a label taken,
912 /// we add the label to the indirect goto. Every subsequent indirect goto is
913 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000914 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000915
Mike Stumpfc496822009-02-08 23:14:22 +0000916 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
917 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000918 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
919 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000920
Chris Lattnerac248202007-05-30 00:13:02 +0000921 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000922 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000923
Mike Stumpfc496822009-02-08 23:14:22 +0000924 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000925 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000926 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000927 BreakContinue(JumpDest Break, JumpDest Continue)
928 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000929
John McCallbd309292010-07-06 01:34:17 +0000930 JumpDest BreakBlock;
931 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000932 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000933 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000934
Justin Bogneref512b92014-01-06 22:27:43 +0000935 CodeGenPGO PGO;
936
937public:
938 /// Get a counter for instrumentation of the region associated with the given
939 /// statement.
940 RegionCounter getPGORegionCounter(const Stmt *S) {
941 return RegionCounter(PGO, S);
942 }
943private:
944
Zhongxing Xu82846ea2012-01-14 09:08:15 +0000945 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +0000946 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000947 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +0000948 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
949 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +0000950
Mike Stumpfc496822009-02-08 23:14:22 +0000951 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000952 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000953 llvm::BasicBlock *CaseRangeBlock;
954
John McCallc07a0c72011-02-17 10:25:35 +0000955 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +0000956 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +0000957 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
958 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +0000959
Mike Stumpfc496822009-02-08 23:14:22 +0000960 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +0000961 // We track this by the size expression rather than the type itself because
962 // in certain situations, like a const qualifier applied to an VLA typedef,
963 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +0000964 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
965 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +0000966 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000967
John McCallbd309292010-07-06 01:34:17 +0000968 /// A block containing a single 'unreachable' instruction. Created
969 /// lazily by getUnreachableBlock().
970 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000971
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000972 /// Counts of the number return expressions in the function.
973 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +0000974
975 /// Count the number of simple (constant) return expressions in the function.
976 unsigned NumSimpleReturnExprs;
977
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000978 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +0000979 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +0000980
Richard Smith852c9db2013-04-20 22:23:05 +0000981public:
982 /// A scope within which we are constructing the fields of an object which
983 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
984 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
985 class FieldConstructionScope {
986 public:
987 FieldConstructionScope(CodeGenFunction &CGF, llvm::Value *This)
988 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
989 CGF.CXXDefaultInitExprThis = This;
990 }
991 ~FieldConstructionScope() {
992 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
993 }
994
995 private:
996 CodeGenFunction &CGF;
997 llvm::Value *OldCXXDefaultInitExprThis;
998 };
999
1000 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1001 /// is overridden to be the object under construction.
1002 class CXXDefaultInitExprScope {
1003 public:
1004 CXXDefaultInitExprScope(CodeGenFunction &CGF)
1005 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue) {
1006 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis;
1007 }
1008 ~CXXDefaultInitExprScope() {
1009 CGF.CXXThisValue = OldCXXThisValue;
1010 }
1011
1012 public:
1013 CodeGenFunction &CGF;
1014 llvm::Value *OldCXXThisValue;
1015 };
1016
1017private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001018 /// CXXThisDecl - When generating code for a C++ member function,
1019 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001020 ImplicitParamDecl *CXXABIThisDecl;
1021 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001022 llvm::Value *CXXThisValue;
Mike Stump11289f42009-09-09 15:08:12 +00001023
Richard Smith852c9db2013-04-20 22:23:05 +00001024 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1025 /// this expression.
1026 llvm::Value *CXXDefaultInitExprThis;
1027
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001028 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1029 /// destructor, this will hold the implicit argument (e.g. VTT).
1030 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1031 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001032
John McCallce1de612011-01-26 04:00:11 +00001033 /// OutermostConditional - Points to the outermost active
1034 /// conditional control. This is used so that we know if a
1035 /// temporary should be destroyed conditionally.
1036 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001037
Nadav Rotem1da30942013-03-23 06:43:35 +00001038 /// The current lexical scope.
1039 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001040
Adrian Prantldc237b52013-05-16 00:41:26 +00001041 /// The current source location that should be used for exception
1042 /// handling code.
1043 SourceLocation CurEHLocation;
1044
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001045 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1046 /// type as well as the field number that contains the actual data.
Chris Lattner2192fe52011-07-18 04:24:23 +00001047 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001048 unsigned> > ByRefValueInfo;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001049
John McCallbd309292010-07-06 01:34:17 +00001050 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001051 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001052 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001053
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001054 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1055 /// In the kernel metadata node, reference the kernel function and metadata
1056 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001057 /// - A node for the vec_type_hint(<type>) qualifier contains string
1058 /// "vec_type_hint", an undefined value of the <type> data type,
1059 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001060 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1061 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1062 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1063 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1064 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1065 llvm::Function *Fn);
1066
Chris Lattnerbed31442007-05-28 01:07:47 +00001067public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001068 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001069 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001070
John McCall8ed55a52010-09-02 09:58:18 +00001071 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001072 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001073 CGDebugInfo *getDebugInfo() {
1074 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001075 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001076 return DebugInfo;
1077 }
1078 void disableDebugInfo() { DisableDebugInfo = true; }
1079 void enableDebugInfo() { DisableDebugInfo = false; }
1080
John McCall31168b02011-06-15 23:02:42 +00001081 bool shouldUseFusedARCCalls() {
1082 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1083 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001084
David Blaikiebbafb8a2012-03-11 07:00:24 +00001085 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001086
Bill Wendlingf0724e82011-09-19 20:31:14 +00001087 /// Returns a pointer to the function's exception object and selector slot,
1088 /// which is assigned in every landing pad.
John McCallbd309292010-07-06 01:34:17 +00001089 llvm::Value *getExceptionSlot();
John McCall9b382dd2011-05-28 21:13:02 +00001090 llvm::Value *getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001091
Bill Wendling79a70e42011-09-15 18:57:19 +00001092 /// Returns the contents of the function's exception object and selector
1093 /// slots.
1094 llvm::Value *getExceptionFromSlot();
1095 llvm::Value *getSelectorFromSlot();
1096
John McCallad5d61e2010-07-23 21:56:41 +00001097 llvm::Value *getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001098
John McCallbd309292010-07-06 01:34:17 +00001099 llvm::BasicBlock *getUnreachableBlock() {
1100 if (!UnreachableBlock) {
1101 UnreachableBlock = createBasicBlock("unreachable");
1102 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1103 }
1104 return UnreachableBlock;
1105 }
1106
1107 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001108 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001109 return getInvokeDestImpl();
1110 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001111
John McCallc8e01702013-04-16 22:48:15 +00001112 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001113 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001114
Daniel Dunbar12347492009-02-23 17:26:39 +00001115 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001116 // Cleanups
1117 //===--------------------------------------------------------------------===//
1118
1119 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1120
John McCall178360e2011-07-11 08:38:19 +00001121 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1122 llvm::Value *arrayEndPointer,
1123 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001124 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001125 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1126 llvm::Value *arrayEnd,
1127 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001128 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001129
John McCall4bd0fb12011-07-12 16:41:08 +00001130 void pushDestroy(QualType::DestructionKind dtorKind,
1131 llvm::Value *addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001132 void pushEHDestroy(QualType::DestructionKind dtorKind,
1133 llvm::Value *addr, QualType type);
John McCall82fe67b2011-07-09 01:37:26 +00001134 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001135 Destroyer *destroyer, bool useEHCleanupForArray);
Richard Smith736a9472013-06-12 20:42:33 +00001136 void pushLifetimeExtendedDestroy(CleanupKind kind, llvm::Value *addr,
1137 QualType type, Destroyer *destroyer,
1138 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001139 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1140 llvm::Value *CompletePtr,
1141 QualType ElementType);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001142 void pushStackRestore(CleanupKind kind, llvm::Value *SPMem);
Peter Collingbourne1425b452012-01-26 03:33:36 +00001143 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001144 bool useEHCleanupForArray);
David Blaikieebe87e12013-08-27 23:57:18 +00001145 llvm::Function *generateDestroyHelper(llvm::Constant *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001146 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001147 bool useEHCleanupForArray,
1148 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001149 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001150 QualType type, Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001151 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001152
Peter Collingbourne1425b452012-01-26 03:33:36 +00001153 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001154
John McCall82fe67b2011-07-09 01:37:26 +00001155 /// Determines whether an EH cleanup is required to destroy a type
1156 /// with the given destruction kind.
1157 bool needsEHCleanup(QualType::DestructionKind kind) {
1158 switch (kind) {
1159 case QualType::DK_none:
1160 return false;
1161 case QualType::DK_cxx_destructor:
1162 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001163 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001164 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001165 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001166 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1167 }
1168 llvm_unreachable("bad destruction kind");
1169 }
1170
John McCall4bd0fb12011-07-12 16:41:08 +00001171 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1172 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1173 }
1174
John McCall82fe67b2011-07-09 01:37:26 +00001175 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001176 // Objective-C
1177 //===--------------------------------------------------------------------===//
1178
Chris Lattner4bd55962008-03-30 23:03:07 +00001179 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001180
Mike Stumpfc496822009-02-08 23:14:22 +00001181 void StartObjCMethod(const ObjCMethodDecl *MD,
Devang Patele7ce5402011-05-19 23:37:41 +00001182 const ObjCContainerDecl *CD,
1183 SourceLocation StartLoc);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001184
Mike Stumpfc496822009-02-08 23:14:22 +00001185 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001186 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1187 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001188 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001189 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001190 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001191 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001192
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001193 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1194 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001195
Mike Stumpfc496822009-02-08 23:14:22 +00001196 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1197 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001198 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1199 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001200 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001201 const ObjCPropertyImplDecl *propImpl,
1202 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian08b0f662010-04-13 00:38:05 +00001203 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001204 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001205
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001206 //===--------------------------------------------------------------------===//
1207 // Block Bits
1208 //===--------------------------------------------------------------------===//
1209
John McCall351762c2011-02-07 10:33:21 +00001210 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001211 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1212 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garstfc83aa02010-02-23 21:51:17 +00001213 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001214 const CGBlockInfo &Info,
Chris Lattner2192fe52011-07-18 04:24:23 +00001215 llvm::StructType *,
John McCallad7c5c12011-02-08 08:22:06 +00001216 llvm::Constant *BlockVarLayout);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001217
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001218 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001219 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001220 const DeclMapTy &ldm,
1221 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001222
John McCallad7c5c12011-02-08 08:22:06 +00001223 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1224 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001225 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1226 const ObjCPropertyImplDecl *PID);
1227 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1228 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001229 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001230
John McCallad7c5c12011-02-08 08:22:06 +00001231 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1232
John McCall73064872011-03-31 01:59:53 +00001233 class AutoVarEmission;
1234
1235 void emitByrefStructureInit(const AutoVarEmission &emission);
1236 void enterByrefCleanup(const AutoVarEmission &emission);
1237
John McCall351762c2011-02-07 10:33:21 +00001238 llvm::Value *LoadBlockStruct() {
1239 assert(BlockPointer && "no block pointer set!");
1240 return BlockPointer;
1241 }
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001242
John McCall87fe5d52010-05-20 01:18:31 +00001243 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCall113bee02012-03-10 09:33:50 +00001244 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall351762c2011-02-07 10:33:21 +00001245 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2192fe52011-07-18 04:24:23 +00001246 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001247
John McCalla738c252011-03-09 04:27:21 +00001248 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1249 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001250 /// \brief Emit code for the start of a function.
1251 /// \param Loc The location to be associated with the function.
1252 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001253 void StartFunction(GlobalDecl GD,
1254 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001255 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001256 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001257 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001258 SourceLocation Loc = SourceLocation(),
1259 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001260
John McCallb81884d2010-02-19 09:25:03 +00001261 void EmitConstructorBody(FunctionArgList &Args);
1262 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001263 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001264 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Bob Wilsonbf854f02014-02-17 19:21:09 +00001265 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, RegionCounter &Cnt);
John McCall89b12b32010-02-18 03:17:58 +00001266
Faisal Vali571df122013-09-29 08:45:24 +00001267 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001268 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001269 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001270 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001271 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1272 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001273 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001274
Mike Stumpfc496822009-02-08 23:14:22 +00001275 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1276 /// emission when possible.
David Blaikie357aafb2013-02-01 19:09:49 +00001277 void EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001278
Mike Stumpfc496822009-02-08 23:14:22 +00001279 /// FinishFunction - Complete IR generation of the current function. It is
1280 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001281 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001282
Hans Wennborg88497d62013-11-15 17:24:45 +00001283 void StartThunk(llvm::Function *Fn, GlobalDecl GD, const CGFunctionInfo &FnInfo);
1284
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001285 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001286
Reid Klecknerab2090d2014-07-26 01:34:32 +00001287 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1288 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1289 llvm::Value *Callee);
1290
Anders Carlssonbad991d2010-03-24 00:39:18 +00001291 /// GenerateThunk - Generate a thunk for the given method.
John McCalla738c252011-03-09 04:27:21 +00001292 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1293 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001294
Eli Friedman49a94b12011-05-06 17:27:27 +00001295 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1296 GlobalDecl GD, const ThunkInfo &Thunk);
1297
Douglas Gregor94f9a482010-05-05 05:51:00 +00001298 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1299 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001300
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001301 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie73ca5692014-12-09 00:32:22 +00001302 ArrayRef<VarDecl *> ArrayIndexes,
1303 SourceLocation DbgLoc = SourceLocation());
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001304
Anders Carlssone87fae92010-03-28 19:40:00 +00001305 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1306 /// subobject.
1307 ///
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001308 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001309 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001310 CharUnits OffsetFromNearestVBase,
Anders Carlssone87fae92010-03-28 19:40:00 +00001311 const CXXRecordDecl *VTableClass);
1312
1313 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001314 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001315 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001316 CharUnits OffsetFromNearestVBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001317 bool BaseIsNonVirtualPrimaryBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001318 const CXXRecordDecl *VTableClass,
1319 VisitedVirtualBasesSetTy& VBases);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001320
Anders Carlssond5895932010-03-28 21:07:49 +00001321 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001322
Dan Gohman8fc50c22010-10-26 18:44:08 +00001323 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1324 /// to by This.
Chris Lattner2192fe52011-07-18 04:24:23 +00001325 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssone87fae92010-03-28 19:40:00 +00001326
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001327
1328 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1329 /// expr can be devirtualized.
1330 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1331 const CXXMethodDecl *MD);
1332
John McCallf99a6312010-07-21 05:30:47 +00001333 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1334 /// given phase of destruction for a destructor. The end result
1335 /// should call destructors on members and base classes in reverse
1336 /// order of their construction.
1337 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001338
Chris Lattner3c77a352010-06-22 00:03:40 +00001339 /// ShouldInstrumentFunction - Return true if the current function should be
1340 /// instrumented with __cyg_profile_func_* calls
1341 bool ShouldInstrumentFunction();
1342
1343 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1344 /// instrumentation function with the current function and the call site, if
1345 /// function instrumentation is enabled.
1346 void EmitFunctionInstrumentation(const char *Fn);
1347
Roman Divacky178e01602011-02-10 16:52:03 +00001348 /// EmitMCountInstrumentation - Emit call to .mcount.
1349 void EmitMCountInstrumentation();
1350
Mike Stumpfc496822009-02-08 23:14:22 +00001351 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1352 /// arguments for the given function. This is also responsible for naming the
1353 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001354 void EmitFunctionProlog(const CGFunctionInfo &FI,
1355 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001356 const FunctionArgList &Args);
1357
Mike Stumpfc496822009-02-08 23:14:22 +00001358 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1359 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001360 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1361 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001362
Mike Stump1d849212009-12-07 23:38:24 +00001363 /// EmitStartEHSpec - Emit the start of the exception spec.
1364 void EmitStartEHSpec(const Decl *D);
1365
1366 /// EmitEndEHSpec - Emit the end of the exception spec.
1367 void EmitEndEHSpec(const Decl *D);
1368
John McCallbd309292010-07-06 01:34:17 +00001369 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1370 llvm::BasicBlock *getTerminateLandingPad();
1371
1372 /// getTerminateHandler - Return a handler (not a landing pad, just
1373 /// a catch handler) that just calls terminate. This is used when
1374 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001375 llvm::BasicBlock *getTerminateHandler();
1376
Chris Lattnera5f58b02011-07-09 17:41:47 +00001377 llvm::Type *ConvertTypeForMem(QualType T);
1378 llvm::Type *ConvertType(QualType T);
1379 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001380 return ConvertType(getContext().getTypeDeclType(T));
1381 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001382
Mike Stumpfc496822009-02-08 23:14:22 +00001383 /// LoadObjCSelf - Load the value of self. This function is only valid while
1384 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001385 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001386
1387 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001388 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001389
Chris Lattner54fb19e2007-06-22 22:02:34 +00001390 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1391 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001392 static TypeEvaluationKind getEvaluationKind(QualType T);
1393
1394 static bool hasScalarEvaluationKind(QualType T) {
1395 return getEvaluationKind(T) == TEK_Scalar;
1396 }
1397
1398 static bool hasAggregateEvaluationKind(QualType T) {
1399 return getEvaluationKind(T) == TEK_Aggregate;
1400 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001401
1402 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001403 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001404 llvm::Function *parent = nullptr,
1405 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001406#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001407 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001408#else
John McCallad7c5c12011-02-08 08:22:06 +00001409 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001410#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001411 }
Mike Stumpfc496822009-02-08 23:14:22 +00001412
Chris Lattnerac248202007-05-30 00:13:02 +00001413 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1414 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001415 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001416
Mike Stumpe5311b02009-11-30 20:08:49 +00001417 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1418 /// another basic block, simplify it. This assumes that no other code could
1419 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001420 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1421
Mike Stumpfc496822009-02-08 23:14:22 +00001422 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1423 /// adding a fall-through branch from the current insert block if
1424 /// necessary. It is legal to call this function even if there is no current
1425 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001426 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001427 /// IsFinished - If true, indicates that the caller has finished emitting
1428 /// branches to the given block and does not expect to emit code into it. This
1429 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001430 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001431
John McCall8e4c74b2011-08-11 02:22:43 +00001432 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1433 /// near its uses, and leave the insertion point in it.
1434 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1435
Mike Stumpfc496822009-02-08 23:14:22 +00001436 /// EmitBranch - Emit a branch to the specified basic block from the current
1437 /// insert block, taking care to avoid creation of branches from dummy
1438 /// blocks. It is legal to call this function even if there is no current
1439 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001440 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001441 /// This function clears the current insertion point. The caller should follow
1442 /// calls to this function with calls to Emit*Block prior to generation new
1443 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001444 void EmitBranch(llvm::BasicBlock *Block);
1445
Mike Stumpfc496822009-02-08 23:14:22 +00001446 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1447 /// indicates that the current code being emitted is unreachable.
1448 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001449 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001450 }
1451
Mike Stumpfc496822009-02-08 23:14:22 +00001452 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1453 /// emitted IR has a place to go. Note that by definition, if this function
1454 /// creates a block then that block is unreachable; callers may do better to
1455 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001456 void EnsureInsertPoint() {
1457 if (!HaveInsertPoint())
1458 EmitBlock(createBasicBlock());
1459 }
Mike Stumpfc496822009-02-08 23:14:22 +00001460
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001461 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001462 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001463 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001464
Chris Lattnere9a64532007-06-22 21:44:33 +00001465 //===--------------------------------------------------------------------===//
1466 // Helpers
1467 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001468
Eli Friedmana0544d62011-12-03 04:14:32 +00001469 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1470 CharUnits Alignment = CharUnits()) {
Dan Gohman947c9af2010-10-14 23:06:10 +00001471 return LValue::MakeAddr(V, T, Alignment, getContext(),
1472 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001473 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001474
David Majnemer99281062014-09-18 22:05:54 +00001475 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001476
Chris Lattnere9a64532007-06-22 21:44:33 +00001477 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001478 /// block. The caller is responsible for setting an appropriate alignment on
1479 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001480 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001481 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001482
John McCall2e6567a2010-04-22 01:10:34 +00001483 /// InitTempAlloca - Provide an initial value for the given alloca.
1484 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1485
Daniel Dunbard0049182010-02-16 19:44:13 +00001486 /// CreateIRTemp - Create a temporary IR object of the given type, with
1487 /// appropriate alignment. This routine should only be used when an temporary
1488 /// value needs to be stored into an alloca (for example, to avoid explicit
1489 /// PHI construction), but the type is the IR type, not the type appropriate
1490 /// for storing in memory.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001491 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001492
Daniel Dunbara7566f12010-02-09 02:48:28 +00001493 /// CreateMemTemp - Create a temporary memory object of the given type, with
1494 /// appropriate alignment.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001495 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001496
John McCall7a626f62010-09-15 10:14:12 +00001497 /// CreateAggTemp - Create a temporary memory object for the given
1498 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001499 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedman38cd36d2011-12-03 02:13:40 +00001500 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001501 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1502 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001503 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001504 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001505 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001506 }
1507
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001508 /// CreateInAllocaTmp - Create a temporary memory object for the given
1509 /// aggregate type.
1510 AggValueSlot CreateInAllocaTmp(QualType T, const Twine &Name = "inalloca");
1511
John McCallad7c5c12011-02-08 08:22:06 +00001512 /// Emit a cast to void* in the appropriate address space.
1513 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1514
Chris Lattner8394d792007-06-05 20:53:16 +00001515 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1516 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001517 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001518
John McCalla2342eb2010-12-05 02:00:02 +00001519 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1520 void EmitIgnoredExpr(const Expr *E);
1521
Chris Lattner4647a212007-08-31 22:49:20 +00001522 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1523 /// any type. The result is returned as an RValue struct. If this is an
1524 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1525 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001526 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001527 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001528 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001529 AggValueSlot aggSlot = AggValueSlot::ignored(),
1530 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001531
Mike Stumpfc496822009-02-08 23:14:22 +00001532 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1533 // or the value of the expression, depending on how va_list is defined.
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001534 llvm::Value *EmitVAListRef(const Expr *E);
1535
Mike Stumpfc496822009-02-08 23:14:22 +00001536 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1537 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001538 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001539
John McCall91ca10f2011-03-08 09:11:50 +00001540 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001541 /// arbitrary expression into the given memory location.
John McCall21886962010-04-21 10:05:39 +00001542 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001543 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001544
John McCall91ca10f2011-03-08 09:11:50 +00001545 /// EmitExprAsInit - Emits the code necessary to initialize a
1546 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001547 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie7f138812014-12-09 22:04:13 +00001548 bool capturedByInit, SourceLocation DbgLoc);
John McCall91ca10f2011-03-08 09:11:50 +00001549
Fariborz Jahanian78652202013-01-25 23:57:05 +00001550 /// hasVolatileMember - returns true if aggregate type has a volatile
1551 /// member.
1552 bool hasVolatileMember(QualType T) {
1553 if (const RecordType *RT = T->getAs<RecordType>()) {
1554 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1555 return RD->hasVolatileMember();
1556 }
1557 return false;
1558 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001559 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001560 ///
1561 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1562 /// This is required for correctness when assigning non-POD structures in C++.
1563 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001564 QualType EltTy) {
1565 bool IsVolatile = hasVolatileMember(EltTy);
1566 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1567 true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001568 }
1569
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001570 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001571 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001572 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001573 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001574 /// \param isAssignment - If false, allow padding to be copied. This often
1575 /// yields more efficient.
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001576 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001577 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001578 CharUnits Alignment = CharUnits::Zero(),
1579 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001580
Devang Patelda5d6bb2007-10-04 23:45:31 +00001581 /// StartBlock - Start new block named N. If insert block is a dummy block
1582 /// then reuse it.
1583 void StartBlock(const char *N);
1584
Anders Carlsson9396a892008-09-11 09:15:33 +00001585 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall5d865c322010-08-31 07:33:07 +00001586 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1587 llvm::Value *Res = LocalDeclMap[VD];
1588 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1589 return Res;
1590 }
Mike Stumpfc496822009-02-08 23:14:22 +00001591
John McCallc07a0c72011-02-17 10:25:35 +00001592 /// getOpaqueLValueMapping - Given an opaque value expression (which
1593 /// must be mapped to an l-value), return its mapping.
1594 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1595 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1596
1597 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1598 it = OpaqueLValues.find(e);
1599 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1600 return it->second;
1601 }
1602
1603 /// getOpaqueRValueMapping - Given an opaque value expression (which
1604 /// must be mapped to an r-value), return its mapping.
1605 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1606 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1607
1608 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1609 it = OpaqueRValues.find(e);
1610 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001611 return it->second;
1612 }
1613
Dan Gohman75d69da2008-05-22 00:50:06 +00001614 /// getAccessedFieldNo - Given an encoded value and a result number, return
1615 /// the input field number being accessed.
1616 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1617
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001618 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001619 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001620
Anders Carlssonc0964b62010-05-22 17:35:42 +00001621 /// EmitNullInitialization - Generate code to set a value of the given type to
1622 /// null, If the type contains data member pointers, they will be initialized
1623 /// to -1 in accordance with the Itanium C++ ABI.
1624 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001625
1626 // EmitVAArg - Generate code to get an argument from the passed in pointer
1627 // and update it accordingly. The return value is a pointer to the argument.
1628 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001629 // instruction in LLVM instead once it works well enough.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001630 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001631
John McCall82fe67b2011-07-09 01:37:26 +00001632 /// emitArrayLength - Compute the length of an array, even if it's a
1633 /// VLA, and drill down to the base element type.
1634 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1635 QualType &baseType,
1636 llvm::Value *&addr);
1637
John McCall23c29fe2011-06-24 21:55:10 +00001638 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1639 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001640 ///
1641 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001642 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001643
John McCall23c29fe2011-06-24 21:55:10 +00001644 /// getVLASize - Returns an LLVM value that corresponds to the size,
1645 /// in non-variably-sized elements, of a variable length array type,
1646 /// plus that largest non-variably-sized element type. Assumes that
1647 /// the type has already been emitted with EmitVariablyModifiedType.
1648 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1649 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001650
Anders Carlssona5d077d2009-04-14 16:58:56 +00001651 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1652 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001653 llvm::Value *LoadCXXThis() {
1654 assert(CXXThisValue && "no 'this' value for this function");
1655 return CXXThisValue;
1656 }
Mike Stump11289f42009-09-09 15:08:12 +00001657
Anders Carlssone36a6b32010-01-02 01:01:18 +00001658 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1659 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001660 // FIXME: Every place that calls LoadCXXVTT is something
1661 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001662 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001663 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1664 return CXXStructorImplicitParamValue;
1665 }
1666
1667 /// LoadCXXStructorImplicitParam - Load the implicit parameter
1668 /// for a constructor/destructor.
1669 llvm::Value *LoadCXXStructorImplicitParam() {
1670 assert(CXXStructorImplicitParamValue &&
1671 "no implicit argument value for this function");
1672 return CXXStructorImplicitParamValue;
John McCall347132b2010-02-16 22:04:33 +00001673 }
John McCall6ce74722010-02-16 04:15:37 +00001674
1675 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001676 /// complete class to the given direct base.
1677 llvm::Value *
1678 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1679 const CXXRecordDecl *Derived,
1680 const CXXRecordDecl *Base,
1681 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001682
Mike Stumpe5311b02009-11-30 20:08:49 +00001683 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1684 /// load of 'this' and returns address of the base class.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001685 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001686 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001687 CastExpr::path_const_iterator PathBegin,
1688 CastExpr::path_const_iterator PathEnd,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001689 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001690
Anders Carlsson8c793172009-11-23 17:57:54 +00001691 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001692 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001693 CastExpr::path_const_iterator PathBegin,
1694 CastExpr::path_const_iterator PathEnd,
Anders Carlsson8c793172009-11-23 17:57:54 +00001695 bool NullCheckValue);
1696
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001697 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1698 /// base constructor/destructor with virtual bases.
1699 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1700 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1701 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1702 bool Delegating);
1703
John McCallf8ff7b92010-02-23 00:48:20 +00001704 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1705 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001706 const FunctionArgList &Args,
1707 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001708 // It's important not to confuse this and the previous function. Delegating
1709 // constructors are the C++0x feature. The constructor delegate optimization
1710 // is used to reduce duplication in the base and complete consturctors where
1711 // they are substantially the same.
1712 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1713 const FunctionArgList &Args);
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001714 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001715 bool ForVirtualBase, bool Delegating,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001716 llvm::Value *This, const CXXConstructExpr *E);
1717
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001718 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1719 llvm::Value *This, llvm::Value *Src,
Alexey Samsonov525bf652014-08-25 21:58:56 +00001720 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001721
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001722 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001723 const ConstantArrayType *ArrayTy,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001724 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001725 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001726 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001727
Anders Carlssond49844b2009-09-23 02:45:36 +00001728 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1729 llvm::Value *NumElements,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001730 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001731 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001732 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001733
John McCall82fe67b2011-07-09 01:37:26 +00001734 static Destroyer destroyCXXObject;
1735
Anders Carlsson0a637412009-05-29 21:03:38 +00001736 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001737 bool ForVirtualBase, bool Delegating,
1738 llvm::Value *This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001739
John McCall99210dc2011-09-15 06:49:18 +00001740 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
Richard Smith06a67e22014-06-03 06:58:52 +00001741 llvm::Value *NewPtr, llvm::Value *NumElements,
1742 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00001743
Peter Collingbourne702b2842011-11-27 22:09:22 +00001744 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1745 llvm::Value *Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001746
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001747 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001748 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001749
Eli Friedman24f55432009-11-18 00:57:03 +00001750 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1751 QualType DeleteTy);
1752
Richard Smith760520b2014-06-03 23:27:44 +00001753 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1754 const Expr *Arg, bool IsDelete);
1755
Mike Stumpc9b231c2009-11-15 08:09:41 +00001756 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stump65511702009-11-16 06:50:58 +00001757 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Nico Webercf4ff5862012-10-11 10:13:44 +00001758 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001759
Richard Smith69d0d262012-08-24 00:54:33 +00001760 /// \brief Situations in which we might emit a check for the suitability of a
1761 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001762 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001763 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001764 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001765 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001766 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001767 /// Checking the bound value in a reference binding. Must be suitably sized
1768 /// and aligned, but is not required to refer to an object (until the
1769 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001770 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001771 /// Checking the object expression in a non-static data member access. Must
1772 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001773 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001774 /// Checking the 'this' pointer for a call to a non-static member function.
1775 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001776 TCK_MemberCall,
1777 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001778 TCK_ConstructorCall,
1779 /// Checking the operand of a static_cast to a derived pointer type. Must be
1780 /// null or an object within its lifetime.
1781 TCK_DowncastPointer,
1782 /// Checking the operand of a static_cast to a derived reference type. Must
1783 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001784 TCK_DowncastReference,
1785 /// Checking the operand of a cast to a base object. Must be suitably sized
1786 /// and aligned.
1787 TCK_Upcast,
1788 /// Checking the operand of a cast to a virtual base object. Must be an
1789 /// object within its lifetime.
1790 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00001791 };
1792
Alexey Samsonovac4afe42014-07-07 23:59:57 +00001793 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
1794 /// calls to EmitTypeCheck can be skipped.
1795 bool sanitizePerformTypeCheck() const;
1796
Richard Smith4d1458e2012-09-08 02:08:36 +00001797 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001798 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001799 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001800 QualType Type, CharUnits Alignment = CharUnits::Zero(),
1801 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001802
Richard Smith539e4a72013-02-23 02:53:19 +00001803 /// \brief Emit a check that \p Base points into an array object, which
1804 /// we can access at index \p Index. \p Accessed should be \c false if we
1805 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1806 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1807 QualType IndexType, bool Accessed);
1808
Chris Lattner116ce8f2010-01-09 21:40:03 +00001809 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1810 bool isInc, bool isPre);
1811 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1812 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00001813
1814 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00001815 llvm::Value *OffsetValue = nullptr) {
1816 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
1817 OffsetValue);
1818 }
Hal Finkelbcc06082014-09-07 22:58:14 +00001819
Chris Lattner8394d792007-06-05 20:53:16 +00001820 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001821 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001822 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001823
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001824 /// EmitDecl - Emit a declaration.
1825 ///
1826 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001827 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001828
John McCall1c9c3fd2010-10-15 04:57:14 +00001829 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001830 ///
1831 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001832 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001833
David Blaikie73ca5692014-12-09 00:32:22 +00001834 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
1835 bool capturedByInit,
1836 SourceLocation DbgLoc = SourceLocation());
John McCalld4631322011-06-17 06:42:21 +00001837 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001838
John McCallbd309292010-07-06 01:34:17 +00001839 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1840 llvm::Value *Address);
1841
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001842 /// \brief Determine whether the given initializer is trivial in the sense
1843 /// that it requires no code to be generated.
1844 bool isTrivialInitializer(const Expr *Init);
1845
John McCall1c9c3fd2010-10-15 04:57:14 +00001846 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001847 ///
1848 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00001849 void EmitAutoVarDecl(const VarDecl &D);
1850
1851 class AutoVarEmission {
1852 friend class CodeGenFunction;
1853
John McCall9e2e22f2011-02-22 07:16:58 +00001854 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00001855
1856 /// The alignment of the variable.
1857 CharUnits Alignment;
1858
1859 /// The address of the alloca. Null if the variable was emitted
1860 /// as a global constant.
1861 llvm::Value *Address;
1862
1863 llvm::Value *NRVOFlag;
1864
1865 /// True if the variable is a __block variable.
1866 bool IsByRef;
1867
1868 /// True if the variable is of aggregate type and has a constant
1869 /// initializer.
1870 bool IsConstantAggregate;
1871
Nadav Rotem1da30942013-03-23 06:43:35 +00001872 /// Non-null if we should use lifetime annotations.
1873 llvm::Value *SizeForLifetimeMarkers;
1874
John McCall9e2e22f2011-02-22 07:16:58 +00001875 struct Invalid {};
Craig Topper8a13c412014-05-21 05:09:00 +00001876 AutoVarEmission(Invalid) : Variable(nullptr) {}
John McCall9e2e22f2011-02-22 07:16:58 +00001877
John McCallc533cb72011-02-22 06:44:22 +00001878 AutoVarEmission(const VarDecl &variable)
Craig Topper8a13c412014-05-21 05:09:00 +00001879 : Variable(&variable), Address(nullptr), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00001880 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00001881 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00001882
Craig Topper8a13c412014-05-21 05:09:00 +00001883 bool wasEmittedAsGlobal() const { return Address == nullptr; }
John McCallc533cb72011-02-22 06:44:22 +00001884
1885 public:
John McCall9e2e22f2011-02-22 07:16:58 +00001886 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1887
Craig Topper8a13c412014-05-21 05:09:00 +00001888 bool useLifetimeMarkers() const {
1889 return SizeForLifetimeMarkers != nullptr;
1890 }
Nadav Rotem1da30942013-03-23 06:43:35 +00001891 llvm::Value *getSizeForLifetimeMarkers() const {
1892 assert(useLifetimeMarkers());
1893 return SizeForLifetimeMarkers;
1894 }
1895
1896 /// Returns the raw, allocated address, which is not necessarily
1897 /// the address of the object itself.
1898 llvm::Value *getAllocatedAddress() const {
1899 return Address;
1900 }
1901
John McCallc533cb72011-02-22 06:44:22 +00001902 /// Returns the address of the object within this declaration.
1903 /// Note that this does not chase the forwarding pointer for
1904 /// __block decls.
1905 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1906 if (!IsByRef) return Address;
1907
1908 return CGF.Builder.CreateStructGEP(Address,
John McCall9e2e22f2011-02-22 07:16:58 +00001909 CGF.getByRefValueLLVMField(Variable),
1910 Variable->getNameAsString());
John McCallc533cb72011-02-22 06:44:22 +00001911 }
1912 };
1913 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1914 void EmitAutoVarInit(const AutoVarEmission &emission);
1915 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00001916 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1917 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001918
John McCall1c9c3fd2010-10-15 04:57:14 +00001919 void EmitStaticVarDecl(const VarDecl &D,
1920 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001921
1922 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001923 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, bool ArgIsPointer,
1924 unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00001925
John McCallc07a0c72011-02-17 10:25:35 +00001926 /// protectFromPeepholes - Protect a value that we're intending to
1927 /// store to the side, but which will probably be used later, from
1928 /// aggressive peepholing optimizations that might delete it.
1929 ///
1930 /// Pass the result to unprotectFromPeepholes to declare that
1931 /// protection is no longer required.
1932 ///
1933 /// There's no particular reason why this shouldn't apply to
1934 /// l-values, it's just that no existing peepholes work on pointers.
1935 PeepholeProtection protectFromPeepholes(RValue rvalue);
1936 void unprotectFromPeepholes(PeepholeProtection protection);
1937
Chris Lattner84915fa2007-06-02 04:16:21 +00001938 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00001939 // Statement Emission
1940 //===--------------------------------------------------------------------===//
1941
Mike Stumpfc496822009-02-08 23:14:22 +00001942 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001943 void EmitStopPoint(const Stmt *S);
1944
Mike Stumpfc496822009-02-08 23:14:22 +00001945 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1946 /// this function even if there is no current insertion point.
1947 ///
1948 /// This function may clear the current insertion point; callers should use
1949 /// EnsureInsertPoint if they wish to subsequently generate code without first
1950 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00001951 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001952
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001953 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00001954 /// necessarily require an insertion point or debug information; typically
1955 /// because the statement amounts to a jump or a container of other
1956 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001957 ///
1958 /// \return True if the statement was handled.
1959 bool EmitSimpleStmt(const Stmt *S);
1960
Eli Friedman4871a462013-06-10 22:04:49 +00001961 llvm::Value *EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
1962 AggValueSlot AVS = AggValueSlot::ignored());
1963 llvm::Value *EmitCompoundStmtWithoutScope(const CompoundStmt &S,
1964 bool GetLast = false,
1965 AggValueSlot AVS =
1966 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001967
Mike Stumpfc496822009-02-08 23:14:22 +00001968 /// EmitLabel - Emit the block for the given label. It is legal to call this
1969 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001970 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001971
Chris Lattnerac248202007-05-30 00:13:02 +00001972 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00001973 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00001974 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001975 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00001976 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001977
1978 void EmitCondBrHints(llvm::LLVMContext &Context, llvm::BranchInst *CondBr,
Craig Topper3cb91b22014-08-27 06:28:16 +00001979 ArrayRef<const Attr *> Attrs);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001980 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00001981 ArrayRef<const Attr *> Attrs = None);
1982 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001983 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00001984 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00001985 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00001986 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001987 void EmitBreakStmt(const BreakStmt &S);
1988 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00001989 void EmitSwitchStmt(const SwitchStmt &S);
1990 void EmitDefaultStmt(const DefaultStmt &S);
1991 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00001992 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00001993 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00001994
Anders Carlsson2e744e82008-08-30 19:51:14 +00001995 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001996 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
1997 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00001998 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00001999 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002000
John McCallb609d3f2010-07-07 06:56:46 +00002001 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2002 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002003
Anders Carlsson52d78a52009-09-27 18:58:34 +00002004 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002005 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002006 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002007 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002008 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002009
Alexey Bataev330de032014-10-29 12:21:55 +00002010 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002011 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002012 void GenerateCapturedStmtFunctionProlog(const CapturedStmt &S);
2013 llvm::Function *GenerateCapturedStmtFunctionEpilog(const CapturedStmt &S);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002014 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev9959db52014-05-06 10:08:46 +00002015 llvm::Value *GenerateCapturedStmtArgument(const CapturedStmt &S);
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002016 void EmitOMPAggregateAssign(LValue OriginalAddr, llvm::Value *PrivateAddr,
2017 const Expr *AssignExpr, QualType Type,
2018 const VarDecl *VDInit);
2019 void EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002020 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002021 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2022 OMPPrivateScope &PrivateScope);
Alexey Bataev9959db52014-05-06 10:08:46 +00002023
2024 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002025 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002026 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002027 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002028 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002029 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002030 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002031 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002032 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002033 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002034 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002035 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002036 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002037 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002038 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002039 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002040 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002041 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002042 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002043 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002044 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002045
Alexander Musmana5f070a2014-10-01 06:03:56 +00002046 /// Helpers for 'omp simd' directive.
Alexander Musmand196ef22014-10-07 08:57:09 +00002047 void EmitOMPLoopBody(const OMPLoopDirective &Directive,
2048 bool SeparateIter = false);
2049 void EmitOMPInnerLoop(const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
2050 bool SeparateIter = false);
Alexander Musmana5f070a2014-10-01 06:03:56 +00002051 void EmitOMPSimdFinal(const OMPLoopDirective &S);
2052
Chris Lattner208ae962007-05-30 17:57:17 +00002053 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002054 // LValue Expression Emission
2055 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002056
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002057 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2058 RValue GetUndefRValue(QualType Ty);
2059
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002060 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2061 /// and issue an ErrorUnsupported style diagnostic (using the
2062 /// provided Name).
2063 RValue EmitUnsupportedRValue(const Expr *E,
2064 const char *Name);
2065
Mike Stumpfc496822009-02-08 23:14:22 +00002066 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2067 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002068 LValue EmitUnsupportedLValue(const Expr *E,
2069 const char *Name);
2070
Chris Lattner8394d792007-06-05 20:53:16 +00002071 /// EmitLValue - Emit code to compute a designator that specifies the location
2072 /// of the expression.
2073 ///
2074 /// This can return one of two things: a simple address or a bitfield
2075 /// reference. In either case, the LLVM Value* in the LValue structure is
2076 /// guaranteed to be an LLVM pointer type.
2077 ///
2078 /// If this returns a bitfield reference, nothing about the pointee type of
2079 /// the LLVM value is known: For example, it may not be a pointer to an
2080 /// integer.
2081 ///
2082 /// If this returns a normal address, and if the lvalue's C type is fixed
2083 /// size, this method guarantees that the returned pointer type will point to
2084 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2085 /// variable length type, this is not possible.
2086 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002087 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002088
Richard Smith4d1458e2012-09-08 02:08:36 +00002089 /// \brief Same as EmitLValue but additionally we generate checking code to
2090 /// guard against undefined behavior. This is only suitable when we know
2091 /// that the address will be used to access the object.
2092 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002093
Nick Lewycky2d84e842013-10-02 02:29:49 +00002094 RValue convertTempToRValue(llvm::Value *addr, QualType type,
2095 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002096
John McCalla8ec7eb2013-03-07 21:37:17 +00002097 void EmitAtomicInit(Expr *E, LValue lvalue);
2098
Nick Lewycky2d84e842013-10-02 02:29:49 +00002099 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
John McCalla8ec7eb2013-03-07 21:37:17 +00002100 AggValueSlot slot = AggValueSlot::ignored());
2101
2102 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2103
John McCall3a7f6922010-10-27 20:58:56 +00002104 /// EmitToMemory - Change a scalar value from its value
2105 /// representation to its in-memory representation.
2106 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2107
2108 /// EmitFromMemory - Change a scalar value from its memory
2109 /// representation to its value representation.
2110 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2111
Daniel Dunbar1d425462009-02-10 00:57:50 +00002112 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2113 /// care to appropriately convert from the memory representation to
2114 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002115 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman947c9af2010-10-14 23:06:10 +00002116 unsigned Alignment, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002117 SourceLocation Loc,
Craig Topper8a13c412014-05-21 05:09:00 +00002118 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002119 QualType TBAABaseTy = QualType(),
2120 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002121
2122 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2123 /// care to appropriately convert from the memory representation to
2124 /// the LLVM value representation. The l-value must be a simple
2125 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002126 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002127
2128 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2129 /// care to appropriately convert from the memory representation to
2130 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002131 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman947c9af2010-10-14 23:06:10 +00002132 bool Volatile, unsigned Alignment, QualType Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00002133 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002134 QualType TBAABaseTy = QualType(),
2135 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002136
2137 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2138 /// care to appropriately convert from the memory representation to
2139 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002140 /// l-value. The isInit flag indicates whether this is an initialization.
2141 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2142 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002143
Chris Lattner8394d792007-06-05 20:53:16 +00002144 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2145 /// this method emits the address of the lvalue, then loads the result as an
2146 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002147 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002148 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2149 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002150 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002151
Chris Lattner8394d792007-06-05 20:53:16 +00002152 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2153 /// lvalue, where both are guaranteed to the have the same type, and that type
2154 /// is 'Ty'.
David Blaikie73ca5692014-12-09 00:32:22 +00002155 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false,
2156 SourceLocation DbgLoc = SourceLocation());
John McCall55e1fbc2011-06-25 02:11:03 +00002157 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002158 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002159
Nick Lewycky2d84e842013-10-02 02:29:49 +00002160 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2161 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002162 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002163 /// \param Result [out] - If non-null, this will be set to a Value* for the
2164 /// bit-field contents after the store, appropriate for use as the result of
2165 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002166 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002167 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002168
John McCall4f29b492010-11-16 23:07:28 +00002169 /// Emit an l-value for an assignment (simple or compound) of complex type.
2170 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002171 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Eli Friedmanf0450072013-06-12 01:40:06 +00002172 LValue EmitScalarCompooundAssignWithComplex(const CompoundAssignOperator *E,
2173 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002174
Chris Lattner57540c52011-04-15 05:22:18 +00002175 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002176 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002177 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002178 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002179 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002180 // Note: only available for agg return types
2181 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002182 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Renato Golin230c5eb2014-05-19 18:15:42 +00002183 LValue EmitReadRegister(const VarDecl *VD);
Chris Lattner4347e3692007-06-06 04:54:52 +00002184 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002185 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002186 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002187 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002188 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2189 bool Accessed = false);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002190 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002191 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002192 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002193 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002194 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002195 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002196 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002197 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002198 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002199
2200 llvm::Value *EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002201
Nick Lewycky2d84e842013-10-02 02:29:49 +00002202 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002203
John McCall71335052012-03-10 03:05:10 +00002204 class ConstantEmission {
2205 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2206 ConstantEmission(llvm::Constant *C, bool isReference)
2207 : ValueAndIsReference(C, isReference) {}
2208 public:
2209 ConstantEmission() {}
2210 static ConstantEmission forReference(llvm::Constant *C) {
2211 return ConstantEmission(C, true);
2212 }
2213 static ConstantEmission forValue(llvm::Constant *C) {
2214 return ConstantEmission(C, false);
2215 }
2216
Craig Topper8a13c412014-05-21 05:09:00 +00002217 LLVM_EXPLICIT operator bool() const {
2218 return ValueAndIsReference.getOpaqueValue() != nullptr;
2219 }
John McCall71335052012-03-10 03:05:10 +00002220
2221 bool isReference() const { return ValueAndIsReference.getInt(); }
2222 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2223 assert(isReference());
2224 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2225 refExpr->getType());
2226 }
2227
2228 llvm::Constant *getValue() const {
2229 assert(!isReference());
2230 return ValueAndIsReference.getPointer();
2231 }
2232 };
2233
John McCall113bee02012-03-10 09:33:50 +00002234 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002235
John McCallfe96e0b2011-11-06 09:01:30 +00002236 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2237 AggValueSlot slot = AggValueSlot::ignored());
2238 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2239
Daniel Dunbar722f4242009-04-22 05:08:15 +00002240 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002241 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002242 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002243 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002244
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002245 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2246 /// if the Field is a reference, this will return the address of the reference
2247 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002248 LValue EmitLValueForFieldInitialization(LValue Base,
2249 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002250
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002251 LValue EmitLValueForIvar(QualType ObjectTy,
2252 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002253 unsigned CVRQualifiers);
2254
Anders Carlsson3be22e22009-05-30 23:23:33 +00002255 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002256 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002257 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002258 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002259 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002260
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002261 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002262 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002263 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002264 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002265 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002266 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002267
Chris Lattnerd7f58862007-06-02 05:24:33 +00002268 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002269 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002270 //===--------------------------------------------------------------------===//
2271
Mike Stumpfc496822009-02-08 23:14:22 +00002272 /// EmitCall - Generate a call of the given function, expecting the given
2273 /// result type, and using the given argument list which specifies both the
2274 /// LLVM arguments and the types they were derived from.
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002275 ///
Mike Stumpe5311b02009-11-30 20:08:49 +00002276 /// \param TargetDecl - If given, the decl of the function in a direct call;
2277 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbard931a872009-02-02 22:03:45 +00002278 RValue EmitCall(const CGFunctionInfo &FnInfo,
2279 llvm::Value *Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00002280 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002281 const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00002282 const Decl *TargetDecl = nullptr,
2283 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002284
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002285 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002286 ReturnValueSlot ReturnValue,
Craig Topper8a13c412014-05-21 05:09:00 +00002287 const Decl *TargetDecl = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002288 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002289 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002290
John McCall882987f2013-02-28 19:01:20 +00002291 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2292 const Twine &name = "");
2293 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2294 ArrayRef<llvm::Value*> args,
2295 const Twine &name = "");
2296 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2297 const Twine &name = "");
2298 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2299 ArrayRef<llvm::Value*> args,
2300 const Twine &name = "");
2301
John McCallbd309292010-07-06 01:34:17 +00002302 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002303 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002304 const Twine &Name = "");
Jay Foad5bd375a2011-07-15 08:37:34 +00002305 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002306 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002307 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2308 ArrayRef<llvm::Value*> args,
2309 const Twine &name = "");
2310 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2311 const Twine &name = "");
2312 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2313 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002314
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002315 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2316 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002317 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002318
2319 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2320 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002321 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002322
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002323 RValue
2324 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2325 ReturnValueSlot ReturnValue, llvm::Value *This,
2326 llvm::Value *ImplicitParam,
2327 QualType ImplicitParamTy, const CallExpr *E);
David Majnemer0c0b6d92014-10-31 20:09:12 +00002328 RValue EmitCXXStructorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2329 ReturnValueSlot ReturnValue, llvm::Value *This,
2330 llvm::Value *ImplicitParam,
2331 QualType ImplicitParamTy, const CallExpr *E,
2332 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002333 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2334 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002335 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2336 const CXXMethodDecl *MD,
2337 ReturnValueSlot ReturnValue,
2338 bool HasQualifier,
2339 NestedNameSpecifier *Qualifier,
2340 bool IsArrow, const Expr *Base);
2341 // Compute the object pointer.
Anders Carlssonbfb36712009-12-24 21:13:40 +00002342 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2343 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002344
Anders Carlsson4034a952009-05-27 04:18:27 +00002345 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002346 const CXXMethodDecl *MD,
2347 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002348
Peter Collingbournefe883422011-10-06 18:29:37 +00002349 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2350 ReturnValueSlot ReturnValue);
2351
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002352
Mike Stump11289f42009-09-09 15:08:12 +00002353 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Daniel Dunbar8eb018a2009-02-16 22:43:43 +00002354 unsigned BuiltinID, const CallExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002355
Anders Carlssonbfb36712009-12-24 21:13:40 +00002356 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002357
Mike Stumpfc496822009-02-08 23:14:22 +00002358 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2359 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002360 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2361
Kevin Qin1718af62013-11-14 02:45:18 +00002362 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2363 const llvm::CmpInst::Predicate Fp,
2364 const llvm::CmpInst::Predicate Ip,
2365 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002366 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002367
2368 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2369 unsigned LLVMIntrinsic,
2370 unsigned AltLLVMIntrinsic,
2371 const char *NameHint,
2372 unsigned Modifier,
2373 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002374 SmallVectorImpl<llvm::Value *> &Ops,
Craig Topper8a13c412014-05-21 05:09:00 +00002375 llvm::Value *Align = nullptr);
Tim Northover8fe03d62014-02-21 11:57:24 +00002376 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2377 unsigned Modifier, llvm::Type *ArgTy,
2378 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002379 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002380 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002381 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002382 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002383 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002384 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002385 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002386 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2387 llvm::Type *Ty, bool usgn, const char *name);
Tim Northover573cbee2014-05-24 12:52:07 +00002388 // Helper functions for EmitAArch64BuiltinExpr.
Tim Northovera2ee4332014-03-29 15:09:45 +00002389 llvm::Value *vectorWrapScalar8(llvm::Value *Op);
2390 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
2391 llvm::Value *emitVectorWrappedScalar8Intrinsic(
2392 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
2393 llvm::Value *emitVectorWrappedScalar16Intrinsic(
2394 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
Tim Northover573cbee2014-05-24 12:52:07 +00002395 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northovera2ee4332014-03-29 15:09:45 +00002396 llvm::Value *EmitNeon64Call(llvm::Function *F,
2397 llvm::SmallVectorImpl<llvm::Value *> &O,
2398 const char *name);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002399
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002400 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002401 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2402 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault56f008d2014-06-24 20:45:01 +00002403 llvm::Value *EmitR600BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002404
Daniel Dunbar66912a12008-08-20 00:28:19 +00002405 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002406 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002407 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002408 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2409 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2410 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002411 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002412 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002413 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2414 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002415
John McCall31168b02011-06-15 23:02:42 +00002416 /// Retrieves the default cleanup kind for an ARC cleanup.
2417 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2418 CleanupKind getARCCleanupKind() {
2419 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2420 ? NormalAndEHCleanup : NormalCleanup;
2421 }
2422
2423 // ARC primitives.
2424 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2425 void EmitARCDestroyWeak(llvm::Value *addr);
2426 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2427 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2428 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2429 bool ignored);
2430 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2431 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2432 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2433 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002434 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002435 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002436 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002437 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002438 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2439 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002440 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCallcdda29c2013-03-13 03:10:54 +00002441 void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise);
2442 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCall31168b02011-06-15 23:02:42 +00002443 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2444 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2445 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2446 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2447
2448 std::pair<LValue,llvm::Value*>
2449 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2450 std::pair<LValue,llvm::Value*>
2451 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2452
John McCall248512a2011-10-01 10:32:24 +00002453 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2454
John McCall31168b02011-06-15 23:02:42 +00002455 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2456 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2457 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2458
John McCallff613032011-10-04 06:23:45 +00002459 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002460 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2461 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2462
Craig Topper00bbdcf2014-06-28 23:22:23 +00002463 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002464
John McCall82fe67b2011-07-09 01:37:26 +00002465 static Destroyer destroyARCStrongImprecise;
2466 static Destroyer destroyARCStrongPrecise;
2467 static Destroyer destroyARCWeak;
2468
John McCall31168b02011-06-15 23:02:42 +00002469 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2470 llvm::Value *EmitObjCAutoreleasePoolPush();
2471 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2472 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2473 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2474
Richard Smitha1c9d4d2013-06-12 23:38:09 +00002475 /// \brief Emits a reference binding to the passed in expression.
2476 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002477
Chris Lattner6278e6a2007-08-11 00:04:45 +00002478 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002479 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002480 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002481
2482 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002483
2484 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2485 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002486 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002487
Chris Lattner3474c202007-08-26 06:48:56 +00002488 /// EmitScalarConversion - Emit a conversion from the specified type to the
2489 /// specified destination type, both of which are LLVM scalar types.
2490 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2491 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002492
Chris Lattner42e6b812007-08-26 16:34:22 +00002493 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stumpfc496822009-02-08 23:14:22 +00002494 /// complex type to the specified destination type, where the destination type
2495 /// is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002496 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2497 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002498
2499
John McCall7a626f62010-09-15 10:14:12 +00002500 /// EmitAggExpr - Emit the computation of the specified expression
2501 /// of aggregate type. The result is computed into the given slot,
2502 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002503 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002504
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002505 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2506 /// aggregate type into a temporary LValue.
2507 LValue EmitAggExprToLValue(const Expr *E);
2508
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002509 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2510 /// pointers.
2511 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian879d7262009-08-31 19:33:16 +00002512 QualType Ty);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002513
John McCall1bd25562011-06-24 23:21:27 +00002514 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2515 /// make sure it survives garbage collection until this point.
2516 void EmitExtendGCLifetime(llvm::Value *object);
2517
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002518 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002519 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002520 ComplexPairTy EmitComplexExpr(const Expr *E,
2521 bool IgnoreReal = false,
2522 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002523
John McCall47fb9502013-03-07 21:37:08 +00002524 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2525 /// type and place its result into the specified l-value.
David Blaikie538deff2014-12-09 20:52:24 +00002526 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit,
2527 SourceLocation DbgLoc = SourceLocation());
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002528
John McCall47fb9502013-03-07 21:37:08 +00002529 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie538deff2014-12-09 20:52:24 +00002530 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit,
2531 SourceLocation DbgLoc = SourceLocation());
John McCall47fb9502013-03-07 21:37:08 +00002532
2533 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002534 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002535
Chandler Carruth84537952012-03-30 19:44:53 +00002536 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2537 /// global variable that has already been created for it. If the initializer
2538 /// has a different type than GV does, this may free GV and return a different
2539 /// one. Otherwise it just returns GV.
2540 llvm::GlobalVariable *
2541 AddInitializerToStaticVarDecl(const VarDecl &D,
2542 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002543
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002544
Anders Carlssonf40886a2009-08-08 21:45:14 +00002545 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2546 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002547 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2548 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002549
David Majnemerb3341ea2014-10-05 05:05:40 +00002550 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
2551 llvm::Constant *Addr);
2552
John McCallc84ed6a2012-05-01 06:13:13 +00002553 /// Call atexit() with a function that passes the given argument to
2554 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00002555 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2556 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002557
John McCallcdf7ef52010-11-06 09:44:32 +00002558 /// Emit code in this function to perform a guarded variable
2559 /// initialization. Guarded initializations are used when it's not
2560 /// possible to prove that an initialization will be done exactly
2561 /// once, e.g. with a static local variable or a static data member
2562 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002563 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002564 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002565
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002566 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2567 /// variables.
2568 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00002569 ArrayRef<llvm::Function *> CXXThreadLocals,
Craig Topper8a13c412014-05-21 05:09:00 +00002570 llvm::GlobalVariable *Guard = nullptr);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002571
John McCallee08c532012-04-06 18:21:03 +00002572 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002573 /// variables.
John McCallee08c532012-04-06 18:21:03 +00002574 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2575 const std::vector<std::pair<llvm::WeakVH,
2576 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002577
John McCalla738c252011-03-09 04:27:21 +00002578 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2579 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00002580 llvm::GlobalVariable *Addr,
2581 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002582
John McCall7a626f62010-09-15 10:14:12 +00002583 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002584
2585 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian50198092010-12-02 17:02:11 +00002586 const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00002587
John McCall08ef4662011-11-10 08:15:53 +00002588 void enterFullExpression(const ExprWithCleanups *E) {
2589 if (E->getNumObjects() == 0) return;
2590 enterNonTrivialFullExpression(E);
2591 }
2592 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00002593
Richard Smithea852322013-05-07 21:53:22 +00002594 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00002595
Eli Friedmanc370a7e2012-02-09 03:32:31 +00002596 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2597
Craig Topper8a13c412014-05-21 05:09:00 +00002598 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = nullptr);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00002599
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002600 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002601 // Annotations Emission
2602 //===--------------------------------------------------------------------===//
2603
2604 /// Emit an annotation call (intrinsic or builtin).
2605 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2606 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002607 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002608 SourceLocation Location);
2609
2610 /// Emit local annotations for the local variable V, declared by D.
2611 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2612
2613 /// Emit field annotations for the given field & value. Returns the
2614 /// annotation result.
2615 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2616
2617 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002618 // Internal Helpers
2619 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002620
Chris Lattner5b1964b2008-11-11 07:41:27 +00002621 /// ContainsLabel - Return true if the statement contains a label in it. If
2622 /// this statement is not executed normally, it not containing a label means
2623 /// that we can just remove the code.
2624 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002625
Chris Lattner29911cc2011-02-28 00:18:40 +00002626 /// containsBreak - Return true if the statement contains a break out of it.
2627 /// If the statement (recursively) contains a switch or loop with a break
2628 /// inside of it, this is fine.
2629 static bool containsBreak(const Stmt *S);
2630
Daniel Dunbar682712c2008-11-12 10:12:14 +00002631 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00002632 /// to a constant, or if it does but contains a label, return false. If it
2633 /// constant folds return true and set the boolean result in Result.
2634 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00002635
Chris Lattner29911cc2011-02-28 00:18:40 +00002636 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2637 /// to a constant, or if it does but contains a label, return false. If it
2638 /// constant folds return true and set the folded value.
Richard Trieuc320c742012-07-23 20:21:35 +00002639 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattner29911cc2011-02-28 00:18:40 +00002640
Chris Lattnercd439292008-11-12 08:04:58 +00002641 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2642 /// if statement) to the specified blocks. Based on the condition, this might
2643 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00002644 /// TrueCount should be the number of times we expect the condition to
2645 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00002646 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00002647 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00002648
Richard Smithe30752c2012-10-09 19:52:38 +00002649 /// \brief Emit a description of a type in a format suitable for passing to
2650 /// a runtime sanitizer handler.
2651 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2652
2653 /// \brief Convert a value into a format suitable for passing to a runtime
2654 /// sanitizer handler.
2655 llvm::Value *EmitCheckValue(llvm::Value *V);
2656
2657 /// \brief Emit a description of a source location in a format suitable for
2658 /// passing to a runtime sanitizer handler.
2659 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2660
Richard Smithde670682012-11-01 22:15:34 +00002661 /// \brief Create a basic block that will call a handler function in a
2662 /// sanitizer runtime with the provided arguments, and create a conditional
2663 /// branch to it.
Alexey Samsonove396bfc2014-11-11 22:03:54 +00002664 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerKind>> Checked,
2665 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
2666 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002667
Richard Smithde670682012-11-01 22:15:34 +00002668 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2669 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00002670 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00002671
Anders Carlsson093bdff2010-03-30 03:27:09 +00002672 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00002673 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00002674
John McCall23f66262010-05-26 22:34:26 +00002675 /// EmitDelegateCallArg - We are performing a delegate call; that
2676 /// is, the current function is delegating to another one. Produce
2677 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002678 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
2679 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00002680
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002681 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2682 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00002683 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002684
Chris Lattnercd439292008-11-12 08:04:58 +00002685private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00002686 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002687 void EmitReturnOfRValue(RValue RV, QualType Ty);
2688
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002689 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
2690
2691 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
2692 DeferredReplacements;
2693
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002694 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2695 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2696 ///
2697 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002698 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
2699 SmallVectorImpl<llvm::Argument *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002700
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002701 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
2702 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
2703 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
2704 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
2705 SmallVectorImpl<llvm::Value *> &IRCallArgs,
2706 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00002707
Chad Rosier59df25b2012-08-23 20:00:18 +00002708 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00002709 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00002710
Chad Rosier59df25b2012-08-23 20:00:18 +00002711 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00002712 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002713 std::string &ConstraintStr,
2714 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00002715
Reid Kleckner89077a12013-12-17 19:46:40 +00002716public:
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002717 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00002718 template <typename T>
2719 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002720 CallExpr::const_arg_iterator ArgBeg,
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002721 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002722 const FunctionDecl *CalleeDecl = nullptr,
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002723 unsigned ParamsToSkip = 0, bool ForceColumnInfo = false) {
Reid Kleckner739756c2013-12-04 19:23:12 +00002724 SmallVector<QualType, 16> ArgTypes;
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002725 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002726
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002727 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
2728 "Can't skip parameters if type info is not provided");
2729 if (CallArgTypeInfo) {
2730 // First, use the argument types that the type info knows about
2731 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
2732 E = CallArgTypeInfo->param_type_end();
2733 I != E; ++I, ++Arg) {
2734 assert(Arg != ArgEnd && "Running over edge of argument list!");
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002735#ifndef NDEBUG
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002736 QualType ArgType = *I;
2737 QualType ActualArgType = Arg->getType();
2738 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
2739 QualType ActualBaseType =
2740 ActualArgType->getAs<PointerType>()->getPointeeType();
2741 QualType ArgBaseType =
2742 ArgType->getAs<PointerType>()->getPointeeType();
2743 if (ArgBaseType->isVariableArrayType()) {
2744 if (const VariableArrayType *VAT =
2745 getContext().getAsVariableArrayType(ActualBaseType)) {
2746 if (!VAT->getSizeExpr())
2747 ActualArgType = ArgType;
2748 }
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002749 }
2750 }
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002751 assert(getContext()
2752 .getCanonicalType(ArgType.getNonReferenceType())
2753 .getTypePtr() ==
2754 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
2755 "type mismatch in call argument!");
Reid Kleckner739756c2013-12-04 19:23:12 +00002756#endif
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002757 ArgTypes.push_back(*I);
2758 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00002759 }
Mike Stump11289f42009-09-09 15:08:12 +00002760
Reid Kleckner739756c2013-12-04 19:23:12 +00002761 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002762 // function.
2763 assert(
2764 (Arg == ArgEnd || !CallArgTypeInfo || CallArgTypeInfo->isVariadic()) &&
2765 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00002766
Anders Carlsson603d6af2009-04-18 20:20:22 +00002767 // If we still have any arguments, emit them using the type of the argument.
Reid Kleckner739756c2013-12-04 19:23:12 +00002768 for (; Arg != ArgEnd; ++Arg)
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002769 ArgTypes.push_back(getVarArgType(*Arg));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002770
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002771 EmitCallArgs(Args, ArgTypes, ArgBeg, ArgEnd, CalleeDecl, ParamsToSkip,
2772 ForceColumnInfo);
Anders Carlsson603d6af2009-04-18 20:20:22 +00002773 }
John McCalld4f4b7f2010-03-03 04:15:11 +00002774
Reid Kleckner739756c2013-12-04 19:23:12 +00002775 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
2776 CallExpr::const_arg_iterator ArgBeg,
Richard Smith760520b2014-06-03 23:27:44 +00002777 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002778 const FunctionDecl *CalleeDecl = nullptr,
2779 unsigned ParamsToSkip = 0, bool ForceColumnInfo = false);
Reid Kleckner739756c2013-12-04 19:23:12 +00002780
Reid Kleckner89077a12013-12-17 19:46:40 +00002781private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002782 QualType getVarArgType(const Expr *Arg);
2783
John McCalld4f4b7f2010-03-03 04:15:11 +00002784 const TargetCodeGenInfo &getTargetHooks() const {
2785 return CGM.getTargetCodeGenInfo();
2786 }
John McCall09ae0322010-07-06 23:57:41 +00002787
2788 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00002789
2790 CodeGenModule::ByrefHelpers *
Chris Lattner2192fe52011-07-18 04:24:23 +00002791 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf9b056b2011-03-31 08:03:29 +00002792 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00002793
2794 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00002795
Eli Friedmana5dd5682012-08-23 03:10:17 +00002796 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2797 /// value and compute our best estimate of the alignment of the pointee.
2798 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00002799
2800 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00002801};
Mike Stump11289f42009-09-09 15:08:12 +00002802
John McCallce1de612011-01-26 04:00:11 +00002803/// Helper class with most of the code for saving a value for a
2804/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00002805struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00002806 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2807
2808 /// Answer whether the given value needs extra work to be saved.
2809 static bool needsSaving(llvm::Value *value) {
2810 // If it's not an instruction, we don't need to save.
2811 if (!isa<llvm::Instruction>(value)) return false;
2812
2813 // If it's an instruction in the entry block, we don't need to save.
2814 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2815 return (block != &block->getParent()->getEntryBlock());
2816 }
2817
2818 /// Try to save the given value.
2819 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2820 if (!needsSaving(value)) return saved_type(value, false);
2821
2822 // Otherwise we need an alloca.
2823 llvm::Value *alloca =
2824 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2825 CGF.Builder.CreateStore(value, alloca);
2826
2827 return saved_type(alloca, true);
2828 }
2829
2830 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2831 if (!value.getInt()) return value.getPointer();
2832 return CGF.Builder.CreateLoad(value.getPointer());
2833 }
2834};
2835
John McCallcb5f77f2011-01-28 10:53:53 +00002836/// A partial specialization of DominatingValue for llvm::Values that
2837/// might be llvm::Instructions.
2838template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2839 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00002840 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00002841 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2842 }
2843};
2844
2845/// A specialization of DominatingValue for RValue.
2846template <> struct DominatingValue<RValue> {
2847 typedef RValue type;
2848 class saved_type {
2849 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2850 AggregateAddress, ComplexAddress };
2851
2852 llvm::Value *Value;
2853 Kind K;
2854 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2855
2856 public:
2857 static bool needsSaving(RValue value);
2858 static saved_type save(CodeGenFunction &CGF, RValue value);
2859 RValue restore(CodeGenFunction &CGF);
2860
2861 // implementations in CGExprCXX.cpp
2862 };
2863
2864 static bool needsSaving(type value) {
2865 return saved_type::needsSaving(value);
2866 }
2867 static saved_type save(CodeGenFunction &CGF, type value) {
2868 return saved_type::save(CGF, value);
2869 }
2870 static type restore(CodeGenFunction &CGF, saved_type value) {
2871 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00002872 }
2873};
2874
Chris Lattnerbed31442007-05-28 01:07:47 +00002875} // end namespace CodeGen
2876} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00002877
Chris Lattnerbed31442007-05-28 01:07:47 +00002878#endif