blob: 88eedd5dd3ae2ae31c0f289dc18541dd39695bd2 [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;
196 else
197 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
217 /// \brief Emit the captured statement body.
218 virtual void EmitBody(CodeGenFunction &CGF, Stmt *S) {
Justin Bogner81ab90f2014-04-15 00:50:54 +0000219 RegionCounter Cnt = CGF.getPGORegionCounter(S);
220 Cnt.beginRegion(CGF.Builder);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000221 CGF.EmitStmt(S);
222 }
223
224 /// \brief Get the name of the capture helper.
225 virtual StringRef getHelperName() const { return "__captured_stmt"; }
226
227 private:
228 /// \brief The kind of captured statement being generated.
229 CapturedRegionKind Kind;
230
231 /// \brief Keep the map between VarDecl and FieldDecl.
232 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
233
234 /// \brief The base address of the captured record, passed in as the first
235 /// argument of the parallel region function.
236 llvm::Value *ThisValue;
237
238 /// \brief Captured 'this' type.
239 FieldDecl *CXXThisFieldDecl;
240 };
241 CGCapturedStmtInfo *CapturedStmtInfo;
242
Nuno Lopes3d6311d2012-05-08 22:10:46 +0000243 /// BoundsChecking - Emit run-time bounds checks. Higher values mean
244 /// potentially higher performance penalties.
245 unsigned char BoundsChecking;
246
Will Dietzf54319c2013-01-18 11:30:38 +0000247 /// \brief Sanitizer options to use for this function.
248 const SanitizerOptions *SanOpts;
249
Alexey Samsonov24cad992014-07-17 18:46:27 +0000250 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
251 bool IsSanitizerScope;
252
253 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
254 class SanitizerScope {
255 CodeGenFunction *CGF;
256 public:
257 SanitizerScope(CodeGenFunction *CGF);
258 ~SanitizerScope();
259 };
260
Reid Kleckner19819442014-07-25 21:39:46 +0000261 /// In C++, whether we are code generating a thunk. This controls whether we
262 /// should emit cleanups.
263 bool CurFuncIsThunk;
264
John McCall31168b02011-06-15 23:02:42 +0000265 /// In ARC, whether we should autorelease the return value.
266 bool AutoreleaseResult;
267
John McCallad7c5c12011-02-08 08:22:06 +0000268 const CodeGen::CGBlockInfo *BlockInfo;
269 llvm::Value *BlockPointer;
270
Eli Friedman9fbeba02012-02-11 02:57:39 +0000271 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
272 FieldDecl *LambdaThisCaptureField;
273
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000274 /// \brief A mapping from NRVO variables to the flags used to indicate
275 /// when the NRVO has been applied to this variable.
276 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000277
John McCallbd309292010-07-06 01:34:17 +0000278 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000279 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
280
281 /// Header for data within LifetimeExtendedCleanupStack.
282 struct LifetimeExtendedCleanupHeader {
283 /// The size of the following cleanup object.
284 size_t Size : 29;
285 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
286 unsigned Kind : 3;
287
288 size_t getSize() const { return Size; }
289 CleanupKind getKind() const { return static_cast<CleanupKind>(Kind); }
290 };
John McCallbd309292010-07-06 01:34:17 +0000291
John McCallad5d61e2010-07-23 21:56:41 +0000292 /// i32s containing the indexes of the cleanup destinations.
293 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000294
295 unsigned NextCleanupDestIndex;
296
John McCall08ef4662011-11-10 08:15:53 +0000297 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
298 CGBlockInfo *FirstBlockInfo;
299
John McCall8e4c74b2011-08-11 02:22:43 +0000300 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
301 llvm::BasicBlock *EHResumeBlock;
302
Bill Wendlingf0724e82011-09-19 20:31:14 +0000303 /// The exception slot. All landing pads write the current exception pointer
304 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000305 llvm::Value *ExceptionSlot;
306
Bill Wendlingf0724e82011-09-19 20:31:14 +0000307 /// The selector slot. Under the MandatoryCleanup model, all landing pads
308 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000309 llvm::AllocaInst *EHSelectorSlot;
310
John McCallbd309292010-07-06 01:34:17 +0000311 /// Emits a landing pad for the current EH stack.
312 llvm::BasicBlock *EmitLandingPad();
313
314 llvm::BasicBlock *getInvokeDestImpl();
315
John McCallce1de612011-01-26 04:00:11 +0000316 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000317 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
318 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000319 }
320
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000321public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000322 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
323 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000324 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000325
John McCall6b0feb72011-06-22 02:32:12 +0000326 /// A class controlling the emission of a finally block.
327 class FinallyInfo {
328 /// Where the catchall's edge through the cleanup should go.
329 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000330
John McCall6b0feb72011-06-22 02:32:12 +0000331 /// A function to call to enter the catch.
332 llvm::Constant *BeginCatchFn;
333
334 /// An i1 variable indicating whether or not the @finally is
335 /// running for an exception.
336 llvm::AllocaInst *ForEHVar;
337
338 /// An i8* variable into which the exception pointer to rethrow
339 /// has been saved.
340 llvm::AllocaInst *SavedExnVar;
341
342 public:
343 void enter(CodeGenFunction &CGF, const Stmt *Finally,
344 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
345 llvm::Constant *rethrowFn);
346 void exit(CodeGenFunction &CGF);
347 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000348
John McCallce1de612011-01-26 04:00:11 +0000349 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
350 /// current full-expression. Safe against the possibility that
351 /// we're currently inside a conditionally-evaluated expression.
John McCalle4df6c82011-01-28 08:37:24 +0000352 template <class T, class A0>
353 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
354 // If we're not in a conditional branch, or if none of the
355 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000356 if (!isInConditionalBranch())
357 return EHStack.pushCleanup<T>(kind, a0);
John McCalle4df6c82011-01-28 08:37:24 +0000358
John McCallcb5f77f2011-01-28 10:53:53 +0000359 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCalle4df6c82011-01-28 08:37:24 +0000360
361 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
362 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
363 initFullExprCleanup();
364 }
365
366 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
367 /// current full-expression. Safe against the possibility that
368 /// we're currently inside a conditionally-evaluated expression.
John McCallce1de612011-01-26 04:00:11 +0000369 template <class T, class A0, class A1>
370 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
371 // If we're not in a conditional branch, or if none of the
372 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000373 if (!isInConditionalBranch())
374 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCallce1de612011-01-26 04:00:11 +0000375
John McCallcb5f77f2011-01-28 10:53:53 +0000376 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
377 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCallce1de612011-01-26 04:00:11 +0000378
379 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCalle4df6c82011-01-28 08:37:24 +0000380 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
381 initFullExprCleanup();
John McCallce1de612011-01-26 04:00:11 +0000382 }
383
Douglas Gregor58df5092011-06-22 16:12:01 +0000384 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
385 /// current full-expression. Safe against the possibility that
386 /// we're currently inside a conditionally-evaluated expression.
387 template <class T, class A0, class A1, class A2>
388 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
389 // If we're not in a conditional branch, or if none of the
390 // arguments requires saving, then use the unconditional cleanup.
391 if (!isInConditionalBranch()) {
John McCall5fcf8da2011-07-12 00:15:30 +0000392 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregor58df5092011-06-22 16:12:01 +0000393 }
394
395 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
396 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
397 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
398
399 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
400 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
401 initFullExprCleanup();
402 }
403
John McCall4bd0fb12011-07-12 16:41:08 +0000404 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
405 /// current full-expression. Safe against the possibility that
406 /// we're currently inside a conditionally-evaluated expression.
407 template <class T, class A0, class A1, class A2, class A3>
408 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
409 // If we're not in a conditional branch, or if none of the
410 // arguments requires saving, then use the unconditional cleanup.
411 if (!isInConditionalBranch()) {
412 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
413 }
414
415 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
416 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
417 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
418 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
419
420 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
421 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
422 a2_saved, a3_saved);
423 initFullExprCleanup();
424 }
425
Richard Smith736a9472013-06-12 20:42:33 +0000426 /// \brief Queue a cleanup to be pushed after finishing the current
427 /// full-expression.
428 template <class T, class A0, class A1, class A2, class A3>
429 void pushCleanupAfterFullExpr(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
430 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
431
432 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
433
434 size_t OldSize = LifetimeExtendedCleanupStack.size();
435 LifetimeExtendedCleanupStack.resize(
436 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
437
438 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
439 new (Buffer) LifetimeExtendedCleanupHeader(Header);
440 new (Buffer + sizeof(Header)) T(a0, a1, a2, a3);
441 }
442
John McCallf4beacd2011-11-10 10:43:54 +0000443 /// Set up the last cleaup that was pushed as a conditional
444 /// full-expression cleanup.
445 void initFullExprCleanup();
446
John McCallbd309292010-07-06 01:34:17 +0000447 /// PushDestructorCleanup - Push a cleanup to call the
448 /// complete-object destructor of an object of the given type at the
449 /// given address. Does nothing if T is not a C++ class type with a
450 /// non-trivial destructor.
451 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
452
John McCall8680f872010-07-21 06:29:51 +0000453 /// PushDestructorCleanup - Push a cleanup to call the
454 /// complete-object variant of the given destructor on the object at
455 /// the given address.
456 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
457 llvm::Value *Addr);
458
John McCallbd309292010-07-06 01:34:17 +0000459 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
460 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000461 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000462
John McCall824c2f52010-09-14 07:57:04 +0000463 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
464 /// The block cannot be reactivated. Pops it if it's the top of the
465 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000466 ///
467 /// \param DominatingIP - An instruction which is known to
468 /// dominate the current IP (if set) and which lies along
469 /// all paths of execution between the current IP and the
470 /// the point at which the cleanup comes into scope.
471 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
472 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000473
474 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
475 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000476 ///
477 /// \param DominatingIP - An instruction which is known to
478 /// dominate the current IP (if set) and which lies along
479 /// all paths of execution between the current IP and the
480 /// the point at which the cleanup comes into scope.
481 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
482 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000483
John McCallbd309292010-07-06 01:34:17 +0000484 /// \brief Enters a new scope for capturing cleanups, all of which
485 /// will be executed once the scope is exited.
486 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000487 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000488 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000489 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000490 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000491 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000492 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000493
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000494 RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
495 void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
Douglas Gregor965f4502009-11-24 16:43:22 +0000496
Eric Christophera9d34972011-10-19 00:43:52 +0000497 protected:
498 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000499
Douglas Gregor965f4502009-11-24 16:43:22 +0000500 public:
501 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000502 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000503 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000504 {
John McCallbd309292010-07-06 01:34:17 +0000505 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000506 LifetimeExtendedCleanupStackSize =
507 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000508 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000509 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000510 }
511
512 /// \brief Exit this cleanup scope, emitting any accumulated
513 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000514 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000515 if (PerformCleanup) {
516 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000517 CGF.PopCleanupBlocks(CleanupStackDepth,
518 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000519 }
520 }
521
522 /// \brief Determine whether this scope requires any cleanups.
523 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000524 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000525 }
526
527 /// \brief Force the emission of cleanups now, instead of waiting
528 /// until this object is destroyed.
529 void ForceCleanup() {
530 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000531 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000532 CGF.PopCleanupBlocks(CleanupStackDepth,
533 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000534 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000535 }
536 };
537
Eric Christophera9d34972011-10-19 00:43:52 +0000538 class LexicalScope: protected RunCleanupsScope {
539 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000540 SmallVector<const LabelDecl*, 4> Labels;
541 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000542
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000543 LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
544 void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
Eric Christophera9d34972011-10-19 00:43:52 +0000545
546 public:
547 /// \brief Enter a new cleanup scope.
548 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000549 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
550 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000551 if (CGDebugInfo *DI = CGF.getDebugInfo())
552 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
553 }
554
Nadav Rotem1da30942013-03-23 06:43:35 +0000555 void addLabel(const LabelDecl *label) {
556 assert(PerformCleanup && "adding label to dead scope?");
557 Labels.push_back(label);
558 }
559
Eric Christophera9d34972011-10-19 00:43:52 +0000560 /// \brief Exit this cleanup scope, emitting any accumulated
561 /// cleanups.
562 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000563 if (CGDebugInfo *DI = CGF.getDebugInfo())
564 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
565
Nadav Rotem1da30942013-03-23 06:43:35 +0000566 // If we should perform a cleanup, force them now. Note that
567 // this ends the cleanup scope before rescoping any labels.
568 if (PerformCleanup) ForceCleanup();
Eric Christophera9d34972011-10-19 00:43:52 +0000569 }
570
571 /// \brief Force the emission of cleanups now, instead of waiting
572 /// until this object is destroyed.
573 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000574 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000575 RunCleanupsScope::ForceCleanup();
576
Nadav Rotem1da30942013-03-23 06:43:35 +0000577 if (!Labels.empty())
578 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000579 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000580
581 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000582 };
583
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000584
Richard Smith736a9472013-06-12 20:42:33 +0000585 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
586 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000587 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000588
Richard Smith736a9472013-06-12 20:42:33 +0000589 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
590 /// that have been added, then adds all lifetime-extended cleanups from
591 /// the given position to the stack.
592 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
593 size_t OldLifetimeExtendedStackSize);
594
John McCallad5d61e2010-07-23 21:56:41 +0000595 void ResolveBranchFixups(llvm::BasicBlock *Target);
596
John McCallbd309292010-07-06 01:34:17 +0000597 /// The given basic block lies in the current EH scope, but may be a
598 /// target of a potentially scope-crossing jump; get a stable handle
599 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000600 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000601 return JumpDest(Target,
602 EHStack.getInnermostNormalCleanup(),
603 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000604 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000605
John McCallbd309292010-07-06 01:34:17 +0000606 /// The given basic block lies in the current EH scope, but may be a
607 /// target of a potentially scope-crossing jump; get a stable handle
608 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000609 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000610 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000611 }
612
613 /// EmitBranchThroughCleanup - Emit a branch from the current insert
614 /// block through the normal cleanup handling code (if any) and then
615 /// on to \arg Dest.
616 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000617
Justin Bognere25ffdf2014-01-21 00:35:11 +0000618 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
619 /// specified destination obviously has no cleanups to run. 'false' is always
620 /// a conservatively correct answer for this method.
621 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
622
John McCall8e4c74b2011-08-11 02:22:43 +0000623 /// popCatchScope - Pops the catch scope at the top of the EHScope
624 /// stack, emitting any required code (other than the catch handlers
625 /// themselves).
626 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000627
David Chisnall9a837be2012-11-07 16:50:40 +0000628 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000629 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000630
John McCallce1de612011-01-26 04:00:11 +0000631 /// An object to manage conditionally-evaluated expressions.
632 class ConditionalEvaluation {
633 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000634
John McCallce1de612011-01-26 04:00:11 +0000635 public:
636 ConditionalEvaluation(CodeGenFunction &CGF)
637 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000638
John McCallce1de612011-01-26 04:00:11 +0000639 void begin(CodeGenFunction &CGF) {
640 assert(CGF.OutermostConditional != this);
641 if (!CGF.OutermostConditional)
642 CGF.OutermostConditional = this;
643 }
644
645 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000646 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000647 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000648 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000649 }
650
651 /// Returns a block which will be executed prior to each
652 /// evaluation of the conditional code.
653 llvm::BasicBlock *getStartingBlock() const {
654 return StartBB;
655 }
656 };
Mike Stump11289f42009-09-09 15:08:12 +0000657
John McCall7f9c92a2010-09-17 00:50:28 +0000658 /// isInConditionalBranch - Return true if we're currently emitting
659 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000660 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000661
John McCallf4beacd2011-11-10 10:43:54 +0000662 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
663 assert(isInConditionalBranch());
664 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
665 new llvm::StoreInst(value, addr, &block->back());
666 }
667
John McCallce1de612011-01-26 04:00:11 +0000668 /// An RAII object to record that we're evaluating a statement
669 /// expression.
670 class StmtExprEvaluation {
671 CodeGenFunction &CGF;
672
673 /// We have to save the outermost conditional: cleanups in a
674 /// statement expression aren't conditional just because the
675 /// StmtExpr is.
676 ConditionalEvaluation *SavedOutermostConditional;
677
678 public:
679 StmtExprEvaluation(CodeGenFunction &CGF)
680 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000681 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000682 }
683
684 ~StmtExprEvaluation() {
685 CGF.OutermostConditional = SavedOutermostConditional;
686 CGF.EnsureInsertPoint();
687 }
688 };
John McCall1bf58462011-02-16 08:02:54 +0000689
John McCallc07a0c72011-02-17 10:25:35 +0000690 /// An object which temporarily prevents a value from being
691 /// destroyed by aggressive peephole optimizations that assume that
692 /// all uses of a value have been realized in the IR.
693 class PeepholeProtection {
694 llvm::Instruction *Inst;
695 friend class CodeGenFunction;
696
697 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000698 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000699 };
John McCallc07a0c72011-02-17 10:25:35 +0000700
John McCallfe96e0b2011-11-06 09:01:30 +0000701 /// A non-RAII class containing all the information about a bound
702 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
703 /// this which makes individual mappings very simple; using this
704 /// class directly is useful when you have a variable number of
705 /// opaque values or don't want the RAII functionality for some
706 /// reason.
707 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000708 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000709 bool BoundLValue;
710 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000711
John McCallfe96e0b2011-11-06 09:01:30 +0000712 OpaqueValueMappingData(const OpaqueValueExpr *ov,
713 bool boundLValue)
714 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000715 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000716 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000717
John McCallc07a0c72011-02-17 10:25:35 +0000718 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000719 // gl-values should be bound as l-values for obvious reasons.
720 // Records should be bound as l-values because IR generation
721 // always keeps them in memory. Expressions of function type
722 // act exactly like l-values but are formally required to be
723 // r-values in C.
724 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000725 expr->getType()->isFunctionType() ||
726 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000727 }
728
John McCallfe96e0b2011-11-06 09:01:30 +0000729 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
730 const OpaqueValueExpr *ov,
731 const Expr *e) {
732 if (shouldBindAsLValue(ov))
733 return bind(CGF, ov, CGF.EmitLValue(e));
734 return bind(CGF, ov, CGF.EmitAnyExpr(e));
735 }
736
737 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
738 const OpaqueValueExpr *ov,
739 const LValue &lv) {
740 assert(shouldBindAsLValue(ov));
741 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
742 return OpaqueValueMappingData(ov, true);
743 }
744
745 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
746 const OpaqueValueExpr *ov,
747 const RValue &rv) {
748 assert(!shouldBindAsLValue(ov));
749 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
750
751 OpaqueValueMappingData data(ov, false);
752
753 // Work around an extremely aggressive peephole optimization in
754 // EmitScalarConversion which assumes that all other uses of a
755 // value are extant.
756 data.Protection = CGF.protectFromPeepholes(rv);
757
758 return data;
759 }
760
Craig Topper8a13c412014-05-21 05:09:00 +0000761 bool isValid() const { return OpaqueValue != nullptr; }
762 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000763
764 void unbind(CodeGenFunction &CGF) {
765 assert(OpaqueValue && "no data to unbind!");
766
767 if (BoundLValue) {
768 CGF.OpaqueLValues.erase(OpaqueValue);
769 } else {
770 CGF.OpaqueRValues.erase(OpaqueValue);
771 CGF.unprotectFromPeepholes(Protection);
772 }
773 }
774 };
775
776 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
777 class OpaqueValueMapping {
778 CodeGenFunction &CGF;
779 OpaqueValueMappingData Data;
780
781 public:
782 static bool shouldBindAsLValue(const Expr *expr) {
783 return OpaqueValueMappingData::shouldBindAsLValue(expr);
784 }
785
John McCallc07a0c72011-02-17 10:25:35 +0000786 /// Build the opaque value mapping for the given conditional
787 /// operator if it's the GNU ?: extension. This is a common
788 /// enough pattern that the convenience operator is really
789 /// helpful.
790 ///
791 OpaqueValueMapping(CodeGenFunction &CGF,
792 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000793 if (isa<ConditionalOperator>(op))
794 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000795 return;
John McCallc07a0c72011-02-17 10:25:35 +0000796
797 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000798 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
799 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000800 }
801
John McCall1bf58462011-02-16 08:02:54 +0000802 OpaqueValueMapping(CodeGenFunction &CGF,
803 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000804 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000805 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000806 }
807
808 OpaqueValueMapping(CodeGenFunction &CGF,
809 const OpaqueValueExpr *opaqueValue,
810 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000811 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000812 }
813
814 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000815 Data.unbind(CGF);
816 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000817 }
818
819 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000820 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000821 }
822 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000823
824 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
825 /// number that holds the value.
826 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian2f2fa722011-01-26 23:08:27 +0000827
828 /// BuildBlockByrefAddress - Computes address location of the
829 /// variable which is declared as __block.
830 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
831 const VarDecl *V);
Chris Lattner2da04b32007-08-24 05:35:26 +0000832private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000833 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000834 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000835
John McCall9b382dd2011-05-28 21:13:02 +0000836 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
837 /// calling llvm.stacksave for multiple VLAs in the same scope.
838 bool DidCallStackSave;
839
Mike Stumpe5311b02009-11-30 20:08:49 +0000840 /// IndirectBranch - The first time an indirect goto is seen we create a block
841 /// with an indirect branch. Every time we see the address of a label taken,
842 /// we add the label to the indirect goto. Every subsequent indirect goto is
843 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000844 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000845
Mike Stumpfc496822009-02-08 23:14:22 +0000846 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
847 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000848 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
849 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000850
Chris Lattnerac248202007-05-30 00:13:02 +0000851 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000852 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000853
Mike Stumpfc496822009-02-08 23:14:22 +0000854 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000855 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000856 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000857 BreakContinue(JumpDest Break, JumpDest Continue)
858 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000859
John McCallbd309292010-07-06 01:34:17 +0000860 JumpDest BreakBlock;
861 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000862 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000863 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000864
Justin Bogneref512b92014-01-06 22:27:43 +0000865 CodeGenPGO PGO;
866
867public:
868 /// Get a counter for instrumentation of the region associated with the given
869 /// statement.
870 RegionCounter getPGORegionCounter(const Stmt *S) {
871 return RegionCounter(PGO, S);
872 }
873private:
874
Zhongxing Xu82846ea2012-01-14 09:08:15 +0000875 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +0000876 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000877 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +0000878 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
879 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +0000880
Mike Stumpfc496822009-02-08 23:14:22 +0000881 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000882 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000883 llvm::BasicBlock *CaseRangeBlock;
884
John McCallc07a0c72011-02-17 10:25:35 +0000885 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +0000886 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +0000887 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
888 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +0000889
Mike Stumpfc496822009-02-08 23:14:22 +0000890 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +0000891 // We track this by the size expression rather than the type itself because
892 // in certain situations, like a const qualifier applied to an VLA typedef,
893 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +0000894 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
895 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +0000896 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000897
John McCallbd309292010-07-06 01:34:17 +0000898 /// A block containing a single 'unreachable' instruction. Created
899 /// lazily by getUnreachableBlock().
900 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000901
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000902 /// Counts of the number return expressions in the function.
903 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +0000904
905 /// Count the number of simple (constant) return expressions in the function.
906 unsigned NumSimpleReturnExprs;
907
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000908 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +0000909 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +0000910
Richard Smith852c9db2013-04-20 22:23:05 +0000911public:
912 /// A scope within which we are constructing the fields of an object which
913 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
914 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
915 class FieldConstructionScope {
916 public:
917 FieldConstructionScope(CodeGenFunction &CGF, llvm::Value *This)
918 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
919 CGF.CXXDefaultInitExprThis = This;
920 }
921 ~FieldConstructionScope() {
922 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
923 }
924
925 private:
926 CodeGenFunction &CGF;
927 llvm::Value *OldCXXDefaultInitExprThis;
928 };
929
930 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
931 /// is overridden to be the object under construction.
932 class CXXDefaultInitExprScope {
933 public:
934 CXXDefaultInitExprScope(CodeGenFunction &CGF)
935 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue) {
936 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis;
937 }
938 ~CXXDefaultInitExprScope() {
939 CGF.CXXThisValue = OldCXXThisValue;
940 }
941
942 public:
943 CodeGenFunction &CGF;
944 llvm::Value *OldCXXThisValue;
945 };
946
947private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000948 /// CXXThisDecl - When generating code for a C++ member function,
949 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +0000950 ImplicitParamDecl *CXXABIThisDecl;
951 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +0000952 llvm::Value *CXXThisValue;
Mike Stump11289f42009-09-09 15:08:12 +0000953
Richard Smith852c9db2013-04-20 22:23:05 +0000954 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
955 /// this expression.
956 llvm::Value *CXXDefaultInitExprThis;
957
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000958 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
959 /// destructor, this will hold the implicit argument (e.g. VTT).
960 ImplicitParamDecl *CXXStructorImplicitParamDecl;
961 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000962
John McCallce1de612011-01-26 04:00:11 +0000963 /// OutermostConditional - Points to the outermost active
964 /// conditional control. This is used so that we know if a
965 /// temporary should be destroyed conditionally.
966 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +0000967
Nadav Rotem1da30942013-03-23 06:43:35 +0000968 /// The current lexical scope.
969 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +0000970
Adrian Prantldc237b52013-05-16 00:41:26 +0000971 /// The current source location that should be used for exception
972 /// handling code.
973 SourceLocation CurEHLocation;
974
Anders Carlsson0168f4b2009-09-12 02:14:24 +0000975 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
976 /// type as well as the field number that contains the actual data.
Chris Lattner2192fe52011-07-18 04:24:23 +0000977 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson0168f4b2009-09-12 02:14:24 +0000978 unsigned> > ByRefValueInfo;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000979
John McCallbd309292010-07-06 01:34:17 +0000980 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +0000981 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +0000982 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +0000983
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000984 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
985 /// In the kernel metadata node, reference the kernel function and metadata
986 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +0000987 /// - A node for the vec_type_hint(<type>) qualifier contains string
988 /// "vec_type_hint", an undefined value of the <type> data type,
989 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000990 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
991 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
992 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
993 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
994 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
995 llvm::Function *Fn);
996
Chris Lattnerbed31442007-05-28 01:07:47 +0000997public:
Fariborz Jahanian63628032012-06-26 16:06:38 +0000998 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +0000999 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001000
John McCall8ed55a52010-09-02 09:58:18 +00001001 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001002 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001003 CGDebugInfo *getDebugInfo() {
1004 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001005 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001006 return DebugInfo;
1007 }
1008 void disableDebugInfo() { DisableDebugInfo = true; }
1009 void enableDebugInfo() { DisableDebugInfo = false; }
1010
John McCall31168b02011-06-15 23:02:42 +00001011 bool shouldUseFusedARCCalls() {
1012 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1013 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001014
David Blaikiebbafb8a2012-03-11 07:00:24 +00001015 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001016
Bill Wendlingf0724e82011-09-19 20:31:14 +00001017 /// Returns a pointer to the function's exception object and selector slot,
1018 /// which is assigned in every landing pad.
John McCallbd309292010-07-06 01:34:17 +00001019 llvm::Value *getExceptionSlot();
John McCall9b382dd2011-05-28 21:13:02 +00001020 llvm::Value *getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001021
Bill Wendling79a70e42011-09-15 18:57:19 +00001022 /// Returns the contents of the function's exception object and selector
1023 /// slots.
1024 llvm::Value *getExceptionFromSlot();
1025 llvm::Value *getSelectorFromSlot();
1026
John McCallad5d61e2010-07-23 21:56:41 +00001027 llvm::Value *getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001028
John McCallbd309292010-07-06 01:34:17 +00001029 llvm::BasicBlock *getUnreachableBlock() {
1030 if (!UnreachableBlock) {
1031 UnreachableBlock = createBasicBlock("unreachable");
1032 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1033 }
1034 return UnreachableBlock;
1035 }
1036
1037 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001038 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001039 return getInvokeDestImpl();
1040 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001041
John McCallc8e01702013-04-16 22:48:15 +00001042 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001043 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001044
Daniel Dunbar12347492009-02-23 17:26:39 +00001045 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001046 // Cleanups
1047 //===--------------------------------------------------------------------===//
1048
1049 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1050
John McCall178360e2011-07-11 08:38:19 +00001051 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1052 llvm::Value *arrayEndPointer,
1053 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001054 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001055 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1056 llvm::Value *arrayEnd,
1057 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001058 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001059
John McCall4bd0fb12011-07-12 16:41:08 +00001060 void pushDestroy(QualType::DestructionKind dtorKind,
1061 llvm::Value *addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001062 void pushEHDestroy(QualType::DestructionKind dtorKind,
1063 llvm::Value *addr, QualType type);
John McCall82fe67b2011-07-09 01:37:26 +00001064 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001065 Destroyer *destroyer, bool useEHCleanupForArray);
Richard Smith736a9472013-06-12 20:42:33 +00001066 void pushLifetimeExtendedDestroy(CleanupKind kind, llvm::Value *addr,
1067 QualType type, Destroyer *destroyer,
1068 bool useEHCleanupForArray);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001069 void pushStackRestore(CleanupKind kind, llvm::Value *SPMem);
Peter Collingbourne1425b452012-01-26 03:33:36 +00001070 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001071 bool useEHCleanupForArray);
David Blaikieebe87e12013-08-27 23:57:18 +00001072 llvm::Function *generateDestroyHelper(llvm::Constant *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001073 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001074 bool useEHCleanupForArray,
1075 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001076 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001077 QualType type, Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001078 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001079
Peter Collingbourne1425b452012-01-26 03:33:36 +00001080 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001081
John McCall82fe67b2011-07-09 01:37:26 +00001082 /// Determines whether an EH cleanup is required to destroy a type
1083 /// with the given destruction kind.
1084 bool needsEHCleanup(QualType::DestructionKind kind) {
1085 switch (kind) {
1086 case QualType::DK_none:
1087 return false;
1088 case QualType::DK_cxx_destructor:
1089 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001090 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001091 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001092 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001093 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1094 }
1095 llvm_unreachable("bad destruction kind");
1096 }
1097
John McCall4bd0fb12011-07-12 16:41:08 +00001098 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1099 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1100 }
1101
John McCall82fe67b2011-07-09 01:37:26 +00001102 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001103 // Objective-C
1104 //===--------------------------------------------------------------------===//
1105
Chris Lattner4bd55962008-03-30 23:03:07 +00001106 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001107
Mike Stumpfc496822009-02-08 23:14:22 +00001108 void StartObjCMethod(const ObjCMethodDecl *MD,
Devang Patele7ce5402011-05-19 23:37:41 +00001109 const ObjCContainerDecl *CD,
1110 SourceLocation StartLoc);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001111
Mike Stumpfc496822009-02-08 23:14:22 +00001112 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001113 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1114 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001115 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001116 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001117 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001118 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001119
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001120 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1121 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001122
Mike Stumpfc496822009-02-08 23:14:22 +00001123 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1124 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001125 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1126 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001127 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001128 const ObjCPropertyImplDecl *propImpl,
1129 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian08b0f662010-04-13 00:38:05 +00001130 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001131 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001132
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001133 //===--------------------------------------------------------------------===//
1134 // Block Bits
1135 //===--------------------------------------------------------------------===//
1136
John McCall351762c2011-02-07 10:33:21 +00001137 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001138 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1139 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garstfc83aa02010-02-23 21:51:17 +00001140 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001141 const CGBlockInfo &Info,
Chris Lattner2192fe52011-07-18 04:24:23 +00001142 llvm::StructType *,
John McCallad7c5c12011-02-08 08:22:06 +00001143 llvm::Constant *BlockVarLayout);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001144
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001145 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001146 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001147 const DeclMapTy &ldm,
1148 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001149
John McCallad7c5c12011-02-08 08:22:06 +00001150 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1151 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001152 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1153 const ObjCPropertyImplDecl *PID);
1154 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1155 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001156 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001157
John McCallad7c5c12011-02-08 08:22:06 +00001158 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1159
John McCall73064872011-03-31 01:59:53 +00001160 class AutoVarEmission;
1161
1162 void emitByrefStructureInit(const AutoVarEmission &emission);
1163 void enterByrefCleanup(const AutoVarEmission &emission);
1164
John McCall351762c2011-02-07 10:33:21 +00001165 llvm::Value *LoadBlockStruct() {
1166 assert(BlockPointer && "no block pointer set!");
1167 return BlockPointer;
1168 }
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001169
John McCall87fe5d52010-05-20 01:18:31 +00001170 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCall113bee02012-03-10 09:33:50 +00001171 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall351762c2011-02-07 10:33:21 +00001172 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2192fe52011-07-18 04:24:23 +00001173 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001174
John McCalla738c252011-03-09 04:27:21 +00001175 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1176 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001177 /// \brief Emit code for the start of a function.
1178 /// \param Loc The location to be associated with the function.
1179 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001180 void StartFunction(GlobalDecl GD,
1181 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001182 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001183 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001184 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001185 SourceLocation Loc = SourceLocation(),
1186 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001187
John McCallb81884d2010-02-19 09:25:03 +00001188 void EmitConstructorBody(FunctionArgList &Args);
1189 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001190 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001191 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Bob Wilsonbf854f02014-02-17 19:21:09 +00001192 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, RegionCounter &Cnt);
John McCall89b12b32010-02-18 03:17:58 +00001193
Faisal Vali571df122013-09-29 08:45:24 +00001194 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001195 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001196 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001197 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001198 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1199 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001200
Mike Stumpfc496822009-02-08 23:14:22 +00001201 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1202 /// emission when possible.
David Blaikie357aafb2013-02-01 19:09:49 +00001203 void EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001204
Mike Stumpfc496822009-02-08 23:14:22 +00001205 /// FinishFunction - Complete IR generation of the current function. It is
1206 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001207 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001208
Hans Wennborg88497d62013-11-15 17:24:45 +00001209 void StartThunk(llvm::Function *Fn, GlobalDecl GD, const CGFunctionInfo &FnInfo);
1210
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001211 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001212
Reid Klecknerab2090d2014-07-26 01:34:32 +00001213 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1214 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1215 llvm::Value *Callee);
1216
Anders Carlssonbad991d2010-03-24 00:39:18 +00001217 /// GenerateThunk - Generate a thunk for the given method.
John McCalla738c252011-03-09 04:27:21 +00001218 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1219 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001220
Eli Friedman49a94b12011-05-06 17:27:27 +00001221 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1222 GlobalDecl GD, const ThunkInfo &Thunk);
1223
Douglas Gregor94f9a482010-05-05 05:51:00 +00001224 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1225 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001226
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001227 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
1228 ArrayRef<VarDecl *> ArrayIndexes);
1229
Anders Carlssone87fae92010-03-28 19:40:00 +00001230 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1231 /// subobject.
1232 ///
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001233 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001234 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001235 CharUnits OffsetFromNearestVBase,
Anders Carlssone87fae92010-03-28 19:40:00 +00001236 const CXXRecordDecl *VTableClass);
1237
1238 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001239 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001240 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001241 CharUnits OffsetFromNearestVBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001242 bool BaseIsNonVirtualPrimaryBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001243 const CXXRecordDecl *VTableClass,
1244 VisitedVirtualBasesSetTy& VBases);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001245
Anders Carlssond5895932010-03-28 21:07:49 +00001246 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001247
Dan Gohman8fc50c22010-10-26 18:44:08 +00001248 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1249 /// to by This.
Chris Lattner2192fe52011-07-18 04:24:23 +00001250 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssone87fae92010-03-28 19:40:00 +00001251
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001252
1253 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1254 /// expr can be devirtualized.
1255 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1256 const CXXMethodDecl *MD);
1257
John McCallf99a6312010-07-21 05:30:47 +00001258 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1259 /// given phase of destruction for a destructor. The end result
1260 /// should call destructors on members and base classes in reverse
1261 /// order of their construction.
1262 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001263
Chris Lattner3c77a352010-06-22 00:03:40 +00001264 /// ShouldInstrumentFunction - Return true if the current function should be
1265 /// instrumented with __cyg_profile_func_* calls
1266 bool ShouldInstrumentFunction();
1267
1268 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1269 /// instrumentation function with the current function and the call site, if
1270 /// function instrumentation is enabled.
1271 void EmitFunctionInstrumentation(const char *Fn);
1272
Roman Divacky178e01602011-02-10 16:52:03 +00001273 /// EmitMCountInstrumentation - Emit call to .mcount.
1274 void EmitMCountInstrumentation();
1275
Mike Stumpfc496822009-02-08 23:14:22 +00001276 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1277 /// arguments for the given function. This is also responsible for naming the
1278 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001279 void EmitFunctionProlog(const CGFunctionInfo &FI,
1280 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001281 const FunctionArgList &Args);
1282
Mike Stumpfc496822009-02-08 23:14:22 +00001283 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1284 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001285 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1286 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001287
Mike Stump1d849212009-12-07 23:38:24 +00001288 /// EmitStartEHSpec - Emit the start of the exception spec.
1289 void EmitStartEHSpec(const Decl *D);
1290
1291 /// EmitEndEHSpec - Emit the end of the exception spec.
1292 void EmitEndEHSpec(const Decl *D);
1293
John McCallbd309292010-07-06 01:34:17 +00001294 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1295 llvm::BasicBlock *getTerminateLandingPad();
1296
1297 /// getTerminateHandler - Return a handler (not a landing pad, just
1298 /// a catch handler) that just calls terminate. This is used when
1299 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001300 llvm::BasicBlock *getTerminateHandler();
1301
Chris Lattnera5f58b02011-07-09 17:41:47 +00001302 llvm::Type *ConvertTypeForMem(QualType T);
1303 llvm::Type *ConvertType(QualType T);
1304 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001305 return ConvertType(getContext().getTypeDeclType(T));
1306 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001307
Mike Stumpfc496822009-02-08 23:14:22 +00001308 /// LoadObjCSelf - Load the value of self. This function is only valid while
1309 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001310 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001311
1312 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001313 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001314
Chris Lattner54fb19e2007-06-22 22:02:34 +00001315 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1316 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001317 static TypeEvaluationKind getEvaluationKind(QualType T);
1318
1319 static bool hasScalarEvaluationKind(QualType T) {
1320 return getEvaluationKind(T) == TEK_Scalar;
1321 }
1322
1323 static bool hasAggregateEvaluationKind(QualType T) {
1324 return getEvaluationKind(T) == TEK_Aggregate;
1325 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001326
1327 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001328 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001329 llvm::Function *parent = nullptr,
1330 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001331#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001332 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001333#else
John McCallad7c5c12011-02-08 08:22:06 +00001334 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001335#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001336 }
Mike Stumpfc496822009-02-08 23:14:22 +00001337
Chris Lattnerac248202007-05-30 00:13:02 +00001338 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1339 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001340 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001341
Mike Stumpe5311b02009-11-30 20:08:49 +00001342 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1343 /// another basic block, simplify it. This assumes that no other code could
1344 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001345 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1346
Mike Stumpfc496822009-02-08 23:14:22 +00001347 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1348 /// adding a fall-through branch from the current insert block if
1349 /// necessary. It is legal to call this function even if there is no current
1350 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001351 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001352 /// IsFinished - If true, indicates that the caller has finished emitting
1353 /// branches to the given block and does not expect to emit code into it. This
1354 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001355 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001356
John McCall8e4c74b2011-08-11 02:22:43 +00001357 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1358 /// near its uses, and leave the insertion point in it.
1359 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1360
Mike Stumpfc496822009-02-08 23:14:22 +00001361 /// EmitBranch - Emit a branch to the specified basic block from the current
1362 /// insert block, taking care to avoid creation of branches from dummy
1363 /// blocks. It is legal to call this function even if there is no current
1364 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001365 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001366 /// This function clears the current insertion point. The caller should follow
1367 /// calls to this function with calls to Emit*Block prior to generation new
1368 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001369 void EmitBranch(llvm::BasicBlock *Block);
1370
Mike Stumpfc496822009-02-08 23:14:22 +00001371 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1372 /// indicates that the current code being emitted is unreachable.
1373 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001374 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001375 }
1376
Mike Stumpfc496822009-02-08 23:14:22 +00001377 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1378 /// emitted IR has a place to go. Note that by definition, if this function
1379 /// creates a block then that block is unreachable; callers may do better to
1380 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001381 void EnsureInsertPoint() {
1382 if (!HaveInsertPoint())
1383 EmitBlock(createBasicBlock());
1384 }
Mike Stumpfc496822009-02-08 23:14:22 +00001385
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001386 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001387 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001388 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001389
Chris Lattnere9a64532007-06-22 21:44:33 +00001390 //===--------------------------------------------------------------------===//
1391 // Helpers
1392 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001393
Eli Friedmana0544d62011-12-03 04:14:32 +00001394 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1395 CharUnits Alignment = CharUnits()) {
Dan Gohman947c9af2010-10-14 23:06:10 +00001396 return LValue::MakeAddr(V, T, Alignment, getContext(),
1397 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001398 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001399
Eli Friedmand20adbd2011-11-16 00:42:57 +00001400 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
Eli Friedmana0544d62011-12-03 04:14:32 +00001401 CharUnits Alignment;
Fariborz Jahanianbcd82af2014-08-05 18:37:48 +00001402 if (!T->isIncompleteType()) {
Eli Friedmana0544d62011-12-03 04:14:32 +00001403 Alignment = getContext().getTypeAlignInChars(T);
Fariborz Jahanianbcd82af2014-08-05 18:37:48 +00001404 unsigned MaxAlign = getContext().getLangOpts().MaxTypeAlign;
1405 if (MaxAlign && Alignment.getQuantity() > MaxAlign &&
1406 !getContext().isAlignmentRequired(T))
1407 Alignment = CharUnits::fromQuantity(MaxAlign);
1408 }
Eli Friedmand20adbd2011-11-16 00:42:57 +00001409 return LValue::MakeAddr(V, T, Alignment, getContext(),
1410 CGM.getTBAAInfo(T));
1411 }
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001412
Chris Lattnere9a64532007-06-22 21:44:33 +00001413 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001414 /// block. The caller is responsible for setting an appropriate alignment on
1415 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001416 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001417 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001418
John McCall2e6567a2010-04-22 01:10:34 +00001419 /// InitTempAlloca - Provide an initial value for the given alloca.
1420 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1421
Daniel Dunbard0049182010-02-16 19:44:13 +00001422 /// CreateIRTemp - Create a temporary IR object of the given type, with
1423 /// appropriate alignment. This routine should only be used when an temporary
1424 /// value needs to be stored into an alloca (for example, to avoid explicit
1425 /// PHI construction), but the type is the IR type, not the type appropriate
1426 /// for storing in memory.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001427 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001428
Daniel Dunbara7566f12010-02-09 02:48:28 +00001429 /// CreateMemTemp - Create a temporary memory object of the given type, with
1430 /// appropriate alignment.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001431 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001432
John McCall7a626f62010-09-15 10:14:12 +00001433 /// CreateAggTemp - Create a temporary memory object for the given
1434 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001435 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedman38cd36d2011-12-03 02:13:40 +00001436 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001437 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1438 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001439 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001440 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001441 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001442 }
1443
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001444 /// CreateInAllocaTmp - Create a temporary memory object for the given
1445 /// aggregate type.
1446 AggValueSlot CreateInAllocaTmp(QualType T, const Twine &Name = "inalloca");
1447
John McCallad7c5c12011-02-08 08:22:06 +00001448 /// Emit a cast to void* in the appropriate address space.
1449 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1450
Chris Lattner8394d792007-06-05 20:53:16 +00001451 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1452 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001453 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001454
John McCalla2342eb2010-12-05 02:00:02 +00001455 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1456 void EmitIgnoredExpr(const Expr *E);
1457
Chris Lattner4647a212007-08-31 22:49:20 +00001458 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1459 /// any type. The result is returned as an RValue struct. If this is an
1460 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1461 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001462 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001463 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001464 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001465 AggValueSlot aggSlot = AggValueSlot::ignored(),
1466 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001467
Mike Stumpfc496822009-02-08 23:14:22 +00001468 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1469 // or the value of the expression, depending on how va_list is defined.
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001470 llvm::Value *EmitVAListRef(const Expr *E);
1471
Mike Stumpfc496822009-02-08 23:14:22 +00001472 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1473 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001474 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001475
John McCall91ca10f2011-03-08 09:11:50 +00001476 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001477 /// arbitrary expression into the given memory location.
John McCall21886962010-04-21 10:05:39 +00001478 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001479 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001480
John McCall91ca10f2011-03-08 09:11:50 +00001481 /// EmitExprAsInit - Emits the code necessary to initialize a
1482 /// location in memory with the given initializer.
John McCall31168b02011-06-15 23:02:42 +00001483 void EmitExprAsInit(const Expr *init, const ValueDecl *D,
John McCall1553b192011-06-16 04:16:24 +00001484 LValue lvalue, bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001485
Fariborz Jahanian78652202013-01-25 23:57:05 +00001486 /// hasVolatileMember - returns true if aggregate type has a volatile
1487 /// member.
1488 bool hasVolatileMember(QualType T) {
1489 if (const RecordType *RT = T->getAs<RecordType>()) {
1490 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1491 return RD->hasVolatileMember();
1492 }
1493 return false;
1494 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001495 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001496 ///
1497 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1498 /// This is required for correctness when assigning non-POD structures in C++.
1499 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001500 QualType EltTy) {
1501 bool IsVolatile = hasVolatileMember(EltTy);
1502 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1503 true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001504 }
1505
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001506 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001507 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001508 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001509 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001510 /// \param isAssignment - If false, allow padding to be copied. This often
1511 /// yields more efficient.
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001512 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001513 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001514 CharUnits Alignment = CharUnits::Zero(),
1515 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001516
Devang Patelda5d6bb2007-10-04 23:45:31 +00001517 /// StartBlock - Start new block named N. If insert block is a dummy block
1518 /// then reuse it.
1519 void StartBlock(const char *N);
1520
Anders Carlsson9396a892008-09-11 09:15:33 +00001521 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall5d865c322010-08-31 07:33:07 +00001522 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1523 llvm::Value *Res = LocalDeclMap[VD];
1524 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1525 return Res;
1526 }
Mike Stumpfc496822009-02-08 23:14:22 +00001527
John McCallc07a0c72011-02-17 10:25:35 +00001528 /// getOpaqueLValueMapping - Given an opaque value expression (which
1529 /// must be mapped to an l-value), return its mapping.
1530 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1531 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1532
1533 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1534 it = OpaqueLValues.find(e);
1535 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1536 return it->second;
1537 }
1538
1539 /// getOpaqueRValueMapping - Given an opaque value expression (which
1540 /// must be mapped to an r-value), return its mapping.
1541 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1542 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1543
1544 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1545 it = OpaqueRValues.find(e);
1546 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001547 return it->second;
1548 }
1549
Dan Gohman75d69da2008-05-22 00:50:06 +00001550 /// getAccessedFieldNo - Given an encoded value and a result number, return
1551 /// the input field number being accessed.
1552 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1553
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001554 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001555 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001556
Anders Carlssonc0964b62010-05-22 17:35:42 +00001557 /// EmitNullInitialization - Generate code to set a value of the given type to
1558 /// null, If the type contains data member pointers, they will be initialized
1559 /// to -1 in accordance with the Itanium C++ ABI.
1560 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001561
1562 // EmitVAArg - Generate code to get an argument from the passed in pointer
1563 // and update it accordingly. The return value is a pointer to the argument.
1564 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001565 // instruction in LLVM instead once it works well enough.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001566 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001567
John McCall82fe67b2011-07-09 01:37:26 +00001568 /// emitArrayLength - Compute the length of an array, even if it's a
1569 /// VLA, and drill down to the base element type.
1570 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1571 QualType &baseType,
1572 llvm::Value *&addr);
1573
John McCall23c29fe2011-06-24 21:55:10 +00001574 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1575 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001576 ///
1577 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001578 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001579
John McCall23c29fe2011-06-24 21:55:10 +00001580 /// getVLASize - Returns an LLVM value that corresponds to the size,
1581 /// in non-variably-sized elements, of a variable length array type,
1582 /// plus that largest non-variably-sized element type. Assumes that
1583 /// the type has already been emitted with EmitVariablyModifiedType.
1584 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1585 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001586
Anders Carlssona5d077d2009-04-14 16:58:56 +00001587 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1588 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001589 llvm::Value *LoadCXXThis() {
1590 assert(CXXThisValue && "no 'this' value for this function");
1591 return CXXThisValue;
1592 }
Mike Stump11289f42009-09-09 15:08:12 +00001593
Anders Carlssone36a6b32010-01-02 01:01:18 +00001594 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1595 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001596 // FIXME: Every place that calls LoadCXXVTT is something
1597 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001598 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001599 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1600 return CXXStructorImplicitParamValue;
1601 }
1602
1603 /// LoadCXXStructorImplicitParam - Load the implicit parameter
1604 /// for a constructor/destructor.
1605 llvm::Value *LoadCXXStructorImplicitParam() {
1606 assert(CXXStructorImplicitParamValue &&
1607 "no implicit argument value for this function");
1608 return CXXStructorImplicitParamValue;
John McCall347132b2010-02-16 22:04:33 +00001609 }
John McCall6ce74722010-02-16 04:15:37 +00001610
1611 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001612 /// complete class to the given direct base.
1613 llvm::Value *
1614 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1615 const CXXRecordDecl *Derived,
1616 const CXXRecordDecl *Base,
1617 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001618
Mike Stumpe5311b02009-11-30 20:08:49 +00001619 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1620 /// load of 'this' and returns address of the base class.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001621 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001622 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001623 CastExpr::path_const_iterator PathBegin,
1624 CastExpr::path_const_iterator PathEnd,
Anders Carlssond829a022010-04-24 21:06:20 +00001625 bool NullCheckValue);
1626
Anders Carlsson8c793172009-11-23 17:57:54 +00001627 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001628 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001629 CastExpr::path_const_iterator PathBegin,
1630 CastExpr::path_const_iterator PathEnd,
Anders Carlsson8c793172009-11-23 17:57:54 +00001631 bool NullCheckValue);
1632
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001633 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1634 /// base constructor/destructor with virtual bases.
1635 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1636 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1637 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1638 bool Delegating);
1639
John McCallf8ff7b92010-02-23 00:48:20 +00001640 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1641 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001642 const FunctionArgList &Args,
1643 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001644 // It's important not to confuse this and the previous function. Delegating
1645 // constructors are the C++0x feature. The constructor delegate optimization
1646 // is used to reduce duplication in the base and complete consturctors where
1647 // they are substantially the same.
1648 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1649 const FunctionArgList &Args);
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001650 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001651 bool ForVirtualBase, bool Delegating,
1652 llvm::Value *This,
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001653 CallExpr::const_arg_iterator ArgBeg,
1654 CallExpr::const_arg_iterator ArgEnd);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001655
1656 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1657 llvm::Value *This, llvm::Value *Src,
1658 CallExpr::const_arg_iterator ArgBeg,
1659 CallExpr::const_arg_iterator ArgEnd);
Mike Stump11289f42009-09-09 15:08:12 +00001660
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001661 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001662 const ConstantArrayType *ArrayTy,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001663 llvm::Value *ArrayPtr,
1664 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001665 CallExpr::const_arg_iterator ArgEnd,
1666 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001667
Anders Carlssond49844b2009-09-23 02:45:36 +00001668 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1669 llvm::Value *NumElements,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001670 llvm::Value *ArrayPtr,
1671 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001672 CallExpr::const_arg_iterator ArgEnd,
1673 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001674
John McCall82fe67b2011-07-09 01:37:26 +00001675 static Destroyer destroyCXXObject;
1676
Anders Carlsson0a637412009-05-29 21:03:38 +00001677 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001678 bool ForVirtualBase, bool Delegating,
1679 llvm::Value *This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001680
John McCall99210dc2011-09-15 06:49:18 +00001681 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
Richard Smith06a67e22014-06-03 06:58:52 +00001682 llvm::Value *NewPtr, llvm::Value *NumElements,
1683 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00001684
Peter Collingbourne702b2842011-11-27 22:09:22 +00001685 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1686 llvm::Value *Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001687
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001688 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001689 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001690
Eli Friedman24f55432009-11-18 00:57:03 +00001691 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1692 QualType DeleteTy);
1693
Richard Smith760520b2014-06-03 23:27:44 +00001694 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1695 const Expr *Arg, bool IsDelete);
1696
Mike Stumpc9b231c2009-11-15 08:09:41 +00001697 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stump65511702009-11-16 06:50:58 +00001698 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Nico Webercf4ff5862012-10-11 10:13:44 +00001699 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001700
Richard Smith69d0d262012-08-24 00:54:33 +00001701 /// \brief Situations in which we might emit a check for the suitability of a
1702 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001703 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001704 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001705 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001706 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001707 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001708 /// Checking the bound value in a reference binding. Must be suitably sized
1709 /// and aligned, but is not required to refer to an object (until the
1710 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001711 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001712 /// Checking the object expression in a non-static data member access. Must
1713 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001714 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001715 /// Checking the 'this' pointer for a call to a non-static member function.
1716 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001717 TCK_MemberCall,
1718 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001719 TCK_ConstructorCall,
1720 /// Checking the operand of a static_cast to a derived pointer type. Must be
1721 /// null or an object within its lifetime.
1722 TCK_DowncastPointer,
1723 /// Checking the operand of a static_cast to a derived reference type. Must
1724 /// be an object within its lifetime.
1725 TCK_DowncastReference
Richard Smith69d0d262012-08-24 00:54:33 +00001726 };
1727
Alexey Samsonovac4afe42014-07-07 23:59:57 +00001728 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
1729 /// calls to EmitTypeCheck can be skipped.
1730 bool sanitizePerformTypeCheck() const;
1731
Richard Smith4d1458e2012-09-08 02:08:36 +00001732 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001733 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001734 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Richard Smith4d1458e2012-09-08 02:08:36 +00001735 QualType Type, CharUnits Alignment = CharUnits::Zero());
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001736
Richard Smith539e4a72013-02-23 02:53:19 +00001737 /// \brief Emit a check that \p Base points into an array object, which
1738 /// we can access at index \p Index. \p Accessed should be \c false if we
1739 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1740 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1741 QualType IndexType, bool Accessed);
1742
Chris Lattner116ce8f2010-01-09 21:40:03 +00001743 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1744 bool isInc, bool isPre);
1745 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1746 bool isInc, bool isPre);
Chris Lattner8394d792007-06-05 20:53:16 +00001747 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001748 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001749 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001750
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001751 /// EmitDecl - Emit a declaration.
1752 ///
1753 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001754 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001755
John McCall1c9c3fd2010-10-15 04:57:14 +00001756 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001757 ///
1758 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001759 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001760
John McCall31168b02011-06-15 23:02:42 +00001761 void EmitScalarInit(const Expr *init, const ValueDecl *D,
John McCall1553b192011-06-16 04:16:24 +00001762 LValue lvalue, bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00001763 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001764
John McCallbd309292010-07-06 01:34:17 +00001765 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1766 llvm::Value *Address);
1767
John McCall1c9c3fd2010-10-15 04:57:14 +00001768 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001769 ///
1770 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00001771 void EmitAutoVarDecl(const VarDecl &D);
1772
1773 class AutoVarEmission {
1774 friend class CodeGenFunction;
1775
John McCall9e2e22f2011-02-22 07:16:58 +00001776 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00001777
1778 /// The alignment of the variable.
1779 CharUnits Alignment;
1780
1781 /// The address of the alloca. Null if the variable was emitted
1782 /// as a global constant.
1783 llvm::Value *Address;
1784
1785 llvm::Value *NRVOFlag;
1786
1787 /// True if the variable is a __block variable.
1788 bool IsByRef;
1789
1790 /// True if the variable is of aggregate type and has a constant
1791 /// initializer.
1792 bool IsConstantAggregate;
1793
Nadav Rotem1da30942013-03-23 06:43:35 +00001794 /// Non-null if we should use lifetime annotations.
1795 llvm::Value *SizeForLifetimeMarkers;
1796
John McCall9e2e22f2011-02-22 07:16:58 +00001797 struct Invalid {};
Craig Topper8a13c412014-05-21 05:09:00 +00001798 AutoVarEmission(Invalid) : Variable(nullptr) {}
John McCall9e2e22f2011-02-22 07:16:58 +00001799
John McCallc533cb72011-02-22 06:44:22 +00001800 AutoVarEmission(const VarDecl &variable)
Craig Topper8a13c412014-05-21 05:09:00 +00001801 : Variable(&variable), Address(nullptr), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00001802 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00001803 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00001804
Craig Topper8a13c412014-05-21 05:09:00 +00001805 bool wasEmittedAsGlobal() const { return Address == nullptr; }
John McCallc533cb72011-02-22 06:44:22 +00001806
1807 public:
John McCall9e2e22f2011-02-22 07:16:58 +00001808 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1809
Craig Topper8a13c412014-05-21 05:09:00 +00001810 bool useLifetimeMarkers() const {
1811 return SizeForLifetimeMarkers != nullptr;
1812 }
Nadav Rotem1da30942013-03-23 06:43:35 +00001813 llvm::Value *getSizeForLifetimeMarkers() const {
1814 assert(useLifetimeMarkers());
1815 return SizeForLifetimeMarkers;
1816 }
1817
1818 /// Returns the raw, allocated address, which is not necessarily
1819 /// the address of the object itself.
1820 llvm::Value *getAllocatedAddress() const {
1821 return Address;
1822 }
1823
John McCallc533cb72011-02-22 06:44:22 +00001824 /// Returns the address of the object within this declaration.
1825 /// Note that this does not chase the forwarding pointer for
1826 /// __block decls.
1827 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1828 if (!IsByRef) return Address;
1829
1830 return CGF.Builder.CreateStructGEP(Address,
John McCall9e2e22f2011-02-22 07:16:58 +00001831 CGF.getByRefValueLLVMField(Variable),
1832 Variable->getNameAsString());
John McCallc533cb72011-02-22 06:44:22 +00001833 }
1834 };
1835 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1836 void EmitAutoVarInit(const AutoVarEmission &emission);
1837 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00001838 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1839 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001840
John McCall1c9c3fd2010-10-15 04:57:14 +00001841 void EmitStaticVarDecl(const VarDecl &D,
1842 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001843
1844 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001845 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, bool ArgIsPointer,
1846 unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00001847
John McCallc07a0c72011-02-17 10:25:35 +00001848 /// protectFromPeepholes - Protect a value that we're intending to
1849 /// store to the side, but which will probably be used later, from
1850 /// aggressive peepholing optimizations that might delete it.
1851 ///
1852 /// Pass the result to unprotectFromPeepholes to declare that
1853 /// protection is no longer required.
1854 ///
1855 /// There's no particular reason why this shouldn't apply to
1856 /// l-values, it's just that no existing peepholes work on pointers.
1857 PeepholeProtection protectFromPeepholes(RValue rvalue);
1858 void unprotectFromPeepholes(PeepholeProtection protection);
1859
Chris Lattner84915fa2007-06-02 04:16:21 +00001860 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00001861 // Statement Emission
1862 //===--------------------------------------------------------------------===//
1863
Mike Stumpfc496822009-02-08 23:14:22 +00001864 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001865 void EmitStopPoint(const Stmt *S);
1866
Mike Stumpfc496822009-02-08 23:14:22 +00001867 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1868 /// this function even if there is no current insertion point.
1869 ///
1870 /// This function may clear the current insertion point; callers should use
1871 /// EnsureInsertPoint if they wish to subsequently generate code without first
1872 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00001873 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001874
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001875 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00001876 /// necessarily require an insertion point or debug information; typically
1877 /// because the statement amounts to a jump or a container of other
1878 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001879 ///
1880 /// \return True if the statement was handled.
1881 bool EmitSimpleStmt(const Stmt *S);
1882
Eli Friedman4871a462013-06-10 22:04:49 +00001883 llvm::Value *EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
1884 AggValueSlot AVS = AggValueSlot::ignored());
1885 llvm::Value *EmitCompoundStmtWithoutScope(const CompoundStmt &S,
1886 bool GetLast = false,
1887 AggValueSlot AVS =
1888 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001889
Mike Stumpfc496822009-02-08 23:14:22 +00001890 /// EmitLabel - Emit the block for the given label. It is legal to call this
1891 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001892 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001893
Chris Lattnerac248202007-05-30 00:13:02 +00001894 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00001895 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00001896 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001897 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00001898 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001899
1900 void EmitCondBrHints(llvm::LLVMContext &Context, llvm::BranchInst *CondBr,
1901 const ArrayRef<const Attr *> &Attrs);
1902 void EmitWhileStmt(const WhileStmt &S,
1903 const ArrayRef<const Attr *> &Attrs = None);
1904 void EmitDoStmt(const DoStmt &S, const ArrayRef<const Attr *> &Attrs = None);
1905 void EmitForStmt(const ForStmt &S,
1906 const ArrayRef<const Attr *> &Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00001907 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00001908 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001909 void EmitBreakStmt(const BreakStmt &S);
1910 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00001911 void EmitSwitchStmt(const SwitchStmt &S);
1912 void EmitDefaultStmt(const DefaultStmt &S);
1913 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00001914 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00001915 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00001916
Anders Carlsson2e744e82008-08-30 19:51:14 +00001917 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001918 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
1919 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00001920 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00001921 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00001922
John McCallb609d3f2010-07-07 06:56:46 +00001923 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
1924 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00001925
Anders Carlsson52d78a52009-09-27 18:58:34 +00001926 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00001927 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00001928 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001929 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
1930 const ArrayRef<const Attr *> &Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001931
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00001932 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00001933 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev9959db52014-05-06 10:08:46 +00001934 llvm::Value *GenerateCapturedStmtArgument(const CapturedStmt &S);
1935
1936 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00001937 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00001938 void EmitOMPForDirective(const OMPForDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00001939 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00001940 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00001941 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00001942 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00001943 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00001944 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00001945 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00001946 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00001947 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00001948 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00001949 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00001950 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00001951 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00001952 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00001953
Chris Lattner208ae962007-05-30 17:57:17 +00001954 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00001955 // LValue Expression Emission
1956 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00001957
Daniel Dunbarc79407f2009-02-05 07:09:07 +00001958 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
1959 RValue GetUndefRValue(QualType Ty);
1960
Daniel Dunbarbb197e42009-01-09 16:50:52 +00001961 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
1962 /// and issue an ErrorUnsupported style diagnostic (using the
1963 /// provided Name).
1964 RValue EmitUnsupportedRValue(const Expr *E,
1965 const char *Name);
1966
Mike Stumpfc496822009-02-08 23:14:22 +00001967 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
1968 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00001969 LValue EmitUnsupportedLValue(const Expr *E,
1970 const char *Name);
1971
Chris Lattner8394d792007-06-05 20:53:16 +00001972 /// EmitLValue - Emit code to compute a designator that specifies the location
1973 /// of the expression.
1974 ///
1975 /// This can return one of two things: a simple address or a bitfield
1976 /// reference. In either case, the LLVM Value* in the LValue structure is
1977 /// guaranteed to be an LLVM pointer type.
1978 ///
1979 /// If this returns a bitfield reference, nothing about the pointee type of
1980 /// the LLVM value is known: For example, it may not be a pointer to an
1981 /// integer.
1982 ///
1983 /// If this returns a normal address, and if the lvalue's C type is fixed
1984 /// size, this method guarantees that the returned pointer type will point to
1985 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
1986 /// variable length type, this is not possible.
1987 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00001988 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00001989
Richard Smith4d1458e2012-09-08 02:08:36 +00001990 /// \brief Same as EmitLValue but additionally we generate checking code to
1991 /// guard against undefined behavior. This is only suitable when we know
1992 /// that the address will be used to access the object.
1993 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001994
Nick Lewycky2d84e842013-10-02 02:29:49 +00001995 RValue convertTempToRValue(llvm::Value *addr, QualType type,
1996 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00001997
John McCalla8ec7eb2013-03-07 21:37:17 +00001998 void EmitAtomicInit(Expr *E, LValue lvalue);
1999
Nick Lewycky2d84e842013-10-02 02:29:49 +00002000 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
John McCalla8ec7eb2013-03-07 21:37:17 +00002001 AggValueSlot slot = AggValueSlot::ignored());
2002
2003 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2004
John McCall3a7f6922010-10-27 20:58:56 +00002005 /// EmitToMemory - Change a scalar value from its value
2006 /// representation to its in-memory representation.
2007 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2008
2009 /// EmitFromMemory - Change a scalar value from its memory
2010 /// representation to its value representation.
2011 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2012
Daniel Dunbar1d425462009-02-10 00:57:50 +00002013 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2014 /// care to appropriately convert from the memory representation to
2015 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002016 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman947c9af2010-10-14 23:06:10 +00002017 unsigned Alignment, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002018 SourceLocation Loc,
Craig Topper8a13c412014-05-21 05:09:00 +00002019 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002020 QualType TBAABaseTy = QualType(),
2021 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002022
2023 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2024 /// care to appropriately convert from the memory representation to
2025 /// the LLVM value representation. The l-value must be a simple
2026 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002027 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002028
2029 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2030 /// care to appropriately convert from the memory representation to
2031 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002032 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman947c9af2010-10-14 23:06:10 +00002033 bool Volatile, unsigned Alignment, QualType Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00002034 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002035 QualType TBAABaseTy = QualType(),
2036 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002037
2038 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2039 /// care to appropriately convert from the memory representation to
2040 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002041 /// l-value. The isInit flag indicates whether this is an initialization.
2042 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2043 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002044
Chris Lattner8394d792007-06-05 20:53:16 +00002045 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2046 /// this method emits the address of the lvalue, then loads the result as an
2047 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002048 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002049 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2050 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002051 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002052
Chris Lattner8394d792007-06-05 20:53:16 +00002053 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2054 /// lvalue, where both are guaranteed to the have the same type, and that type
2055 /// is 'Ty'.
David Chisnallfa35df62012-01-16 17:27:18 +00002056 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false);
John McCall55e1fbc2011-06-25 02:11:03 +00002057 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002058 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002059
Nick Lewycky2d84e842013-10-02 02:29:49 +00002060 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2061 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002062 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002063 /// \param Result [out] - If non-null, this will be set to a Value* for the
2064 /// bit-field contents after the store, appropriate for use as the result of
2065 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002066 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002067 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002068
John McCall4f29b492010-11-16 23:07:28 +00002069 /// Emit an l-value for an assignment (simple or compound) of complex type.
2070 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002071 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Eli Friedmanf0450072013-06-12 01:40:06 +00002072 LValue EmitScalarCompooundAssignWithComplex(const CompoundAssignOperator *E,
2073 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002074
Chris Lattner57540c52011-04-15 05:22:18 +00002075 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002076 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002077 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002078 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002079 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002080 // Note: only available for agg return types
2081 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002082 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Renato Golin230c5eb2014-05-19 18:15:42 +00002083 LValue EmitReadRegister(const VarDecl *VD);
Chris Lattner4347e3692007-06-06 04:54:52 +00002084 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002085 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002086 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002087 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002088 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2089 bool Accessed = false);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002090 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002091 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002092 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002093 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002094 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002095 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002096 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002097 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002098 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002099
2100 llvm::Value *EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002101
Nick Lewycky2d84e842013-10-02 02:29:49 +00002102 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002103
John McCall71335052012-03-10 03:05:10 +00002104 class ConstantEmission {
2105 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2106 ConstantEmission(llvm::Constant *C, bool isReference)
2107 : ValueAndIsReference(C, isReference) {}
2108 public:
2109 ConstantEmission() {}
2110 static ConstantEmission forReference(llvm::Constant *C) {
2111 return ConstantEmission(C, true);
2112 }
2113 static ConstantEmission forValue(llvm::Constant *C) {
2114 return ConstantEmission(C, false);
2115 }
2116
Craig Topper8a13c412014-05-21 05:09:00 +00002117 LLVM_EXPLICIT operator bool() const {
2118 return ValueAndIsReference.getOpaqueValue() != nullptr;
2119 }
John McCall71335052012-03-10 03:05:10 +00002120
2121 bool isReference() const { return ValueAndIsReference.getInt(); }
2122 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2123 assert(isReference());
2124 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2125 refExpr->getType());
2126 }
2127
2128 llvm::Constant *getValue() const {
2129 assert(!isReference());
2130 return ValueAndIsReference.getPointer();
2131 }
2132 };
2133
John McCall113bee02012-03-10 09:33:50 +00002134 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002135
John McCallfe96e0b2011-11-06 09:01:30 +00002136 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2137 AggValueSlot slot = AggValueSlot::ignored());
2138 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2139
Daniel Dunbar722f4242009-04-22 05:08:15 +00002140 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002141 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002142 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002143 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002144
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002145 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2146 /// if the Field is a reference, this will return the address of the reference
2147 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002148 LValue EmitLValueForFieldInitialization(LValue Base,
2149 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002150
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002151 LValue EmitLValueForIvar(QualType ObjectTy,
2152 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002153 unsigned CVRQualifiers);
2154
Anders Carlsson3be22e22009-05-30 23:23:33 +00002155 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002156 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002157 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002158 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002159 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002160
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002161 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002162 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002163 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002164 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002165 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002166 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002167
Chris Lattnerd7f58862007-06-02 05:24:33 +00002168 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002169 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002170 //===--------------------------------------------------------------------===//
2171
Mike Stumpfc496822009-02-08 23:14:22 +00002172 /// EmitCall - Generate a call of the given function, expecting the given
2173 /// result type, and using the given argument list which specifies both the
2174 /// LLVM arguments and the types they were derived from.
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002175 ///
Mike Stumpe5311b02009-11-30 20:08:49 +00002176 /// \param TargetDecl - If given, the decl of the function in a direct call;
2177 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbard931a872009-02-02 22:03:45 +00002178 RValue EmitCall(const CGFunctionInfo &FnInfo,
2179 llvm::Value *Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00002180 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002181 const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00002182 const Decl *TargetDecl = nullptr,
2183 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002184
Anders Carlsson0435ed52009-12-24 19:08:58 +00002185 RValue EmitCall(QualType FnType, llvm::Value *Callee,
Peter Collingbourneb453cd62013-10-20 21:29:19 +00002186 SourceLocation CallLoc,
Anders Carlsson17490832009-12-24 20:40:36 +00002187 ReturnValueSlot ReturnValue,
Anders Carlsson3a9463b2009-05-27 01:22:39 +00002188 CallExpr::const_arg_iterator ArgBeg,
2189 CallExpr::const_arg_iterator ArgEnd,
Craig Topper8a13c412014-05-21 05:09:00 +00002190 const Decl *TargetDecl = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002191 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002192 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002193
John McCall882987f2013-02-28 19:01:20 +00002194 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2195 const Twine &name = "");
2196 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2197 ArrayRef<llvm::Value*> args,
2198 const Twine &name = "");
2199 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2200 const Twine &name = "");
2201 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2202 ArrayRef<llvm::Value*> args,
2203 const Twine &name = "");
2204
John McCallbd309292010-07-06 01:34:17 +00002205 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002206 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002207 const Twine &Name = "");
Jay Foad5bd375a2011-07-15 08:37:34 +00002208 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002209 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002210 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2211 ArrayRef<llvm::Value*> args,
2212 const Twine &name = "");
2213 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2214 const Twine &name = "");
2215 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2216 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002217
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002218 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2219 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002220 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002221
2222 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2223 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002224 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002225
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00002226 RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
Richard Smithe30752c2012-10-09 19:52:38 +00002227 SourceLocation CallLoc,
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00002228 llvm::Value *Callee,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002229 ReturnValueSlot ReturnValue,
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00002230 llvm::Value *This,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002231 llvm::Value *ImplicitParam,
2232 QualType ImplicitParamTy,
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00002233 CallExpr::const_arg_iterator ArgBeg,
2234 CallExpr::const_arg_iterator ArgEnd);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002235 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2236 ReturnValueSlot ReturnValue);
2237 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2238 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002239
Anders Carlssonc36783e2011-05-08 20:32:23 +00002240 llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2241 const CXXMethodDecl *MD,
2242 llvm::Value *This);
Anders Carlsson4034a952009-05-27 04:18:27 +00002243 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002244 const CXXMethodDecl *MD,
2245 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002246
Peter Collingbournefe883422011-10-06 18:29:37 +00002247 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2248 ReturnValueSlot ReturnValue);
2249
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002250
Mike Stump11289f42009-09-09 15:08:12 +00002251 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Daniel Dunbar8eb018a2009-02-16 22:43:43 +00002252 unsigned BuiltinID, const CallExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002253
Anders Carlssonbfb36712009-12-24 21:13:40 +00002254 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002255
Mike Stumpfc496822009-02-08 23:14:22 +00002256 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2257 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002258 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2259
Kevin Qin1718af62013-11-14 02:45:18 +00002260 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2261 const llvm::CmpInst::Predicate Fp,
2262 const llvm::CmpInst::Predicate Ip,
2263 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002264 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002265
2266 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2267 unsigned LLVMIntrinsic,
2268 unsigned AltLLVMIntrinsic,
2269 const char *NameHint,
2270 unsigned Modifier,
2271 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002272 SmallVectorImpl<llvm::Value *> &Ops,
Craig Topper8a13c412014-05-21 05:09:00 +00002273 llvm::Value *Align = nullptr);
Tim Northover8fe03d62014-02-21 11:57:24 +00002274 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2275 unsigned Modifier, llvm::Type *ArgTy,
2276 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002277 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002278 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002279 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002280 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002281 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002282 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002283 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002284 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2285 llvm::Type *Ty, bool usgn, const char *name);
Tim Northover573cbee2014-05-24 12:52:07 +00002286 // Helper functions for EmitAArch64BuiltinExpr.
Tim Northovera2ee4332014-03-29 15:09:45 +00002287 llvm::Value *vectorWrapScalar8(llvm::Value *Op);
2288 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
2289 llvm::Value *emitVectorWrappedScalar8Intrinsic(
2290 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
2291 llvm::Value *emitVectorWrappedScalar16Intrinsic(
2292 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
Tim Northover573cbee2014-05-24 12:52:07 +00002293 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northovera2ee4332014-03-29 15:09:45 +00002294 llvm::Value *EmitNeon64Call(llvm::Function *F,
2295 llvm::SmallVectorImpl<llvm::Value *> &O,
2296 const char *name);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002297
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002298 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002299 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2300 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault56f008d2014-06-24 20:45:01 +00002301 llvm::Value *EmitR600BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002302
Daniel Dunbar66912a12008-08-20 00:28:19 +00002303 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002304 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002305 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002306 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2307 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2308 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian413297c2014-08-06 18:13:46 +00002309 const ObjCMethodDecl *MethodWithObjects,
2310 const ObjCMethodDecl *AllocMethod);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002311 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002312 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2313 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002314
John McCall31168b02011-06-15 23:02:42 +00002315 /// Retrieves the default cleanup kind for an ARC cleanup.
2316 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2317 CleanupKind getARCCleanupKind() {
2318 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2319 ? NormalAndEHCleanup : NormalCleanup;
2320 }
2321
2322 // ARC primitives.
2323 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2324 void EmitARCDestroyWeak(llvm::Value *addr);
2325 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2326 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2327 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2328 bool ignored);
2329 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2330 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2331 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2332 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002333 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002334 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002335 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002336 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002337 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2338 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002339 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCallcdda29c2013-03-13 03:10:54 +00002340 void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise);
2341 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCall31168b02011-06-15 23:02:42 +00002342 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2343 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2344 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2345 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2346
2347 std::pair<LValue,llvm::Value*>
2348 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2349 std::pair<LValue,llvm::Value*>
2350 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2351
John McCall248512a2011-10-01 10:32:24 +00002352 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2353
John McCall31168b02011-06-15 23:02:42 +00002354 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2355 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2356 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2357
John McCallff613032011-10-04 06:23:45 +00002358 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002359 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2360 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2361
Craig Topper00bbdcf2014-06-28 23:22:23 +00002362 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002363
John McCall82fe67b2011-07-09 01:37:26 +00002364 static Destroyer destroyARCStrongImprecise;
2365 static Destroyer destroyARCStrongPrecise;
2366 static Destroyer destroyARCWeak;
2367
John McCall31168b02011-06-15 23:02:42 +00002368 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2369 llvm::Value *EmitObjCAutoreleasePoolPush();
2370 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2371 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2372 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2373
Richard Smitha1c9d4d2013-06-12 23:38:09 +00002374 /// \brief Emits a reference binding to the passed in expression.
2375 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002376
Chris Lattner6278e6a2007-08-11 00:04:45 +00002377 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002378 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002379 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002380
2381 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002382
2383 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2384 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002385 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002386
Chris Lattner3474c202007-08-26 06:48:56 +00002387 /// EmitScalarConversion - Emit a conversion from the specified type to the
2388 /// specified destination type, both of which are LLVM scalar types.
2389 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2390 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002391
Chris Lattner42e6b812007-08-26 16:34:22 +00002392 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stumpfc496822009-02-08 23:14:22 +00002393 /// complex type to the specified destination type, where the destination type
2394 /// is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002395 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2396 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002397
2398
John McCall7a626f62010-09-15 10:14:12 +00002399 /// EmitAggExpr - Emit the computation of the specified expression
2400 /// of aggregate type. The result is computed into the given slot,
2401 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002402 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002403
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002404 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2405 /// aggregate type into a temporary LValue.
2406 LValue EmitAggExprToLValue(const Expr *E);
2407
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002408 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2409 /// pointers.
2410 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian879d7262009-08-31 19:33:16 +00002411 QualType Ty);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002412
John McCall1bd25562011-06-24 23:21:27 +00002413 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2414 /// make sure it survives garbage collection until this point.
2415 void EmitExtendGCLifetime(llvm::Value *object);
2416
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002417 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002418 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002419 ComplexPairTy EmitComplexExpr(const Expr *E,
2420 bool IgnoreReal = false,
2421 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002422
John McCall47fb9502013-03-07 21:37:08 +00002423 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2424 /// type and place its result into the specified l-value.
2425 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002426
John McCall47fb9502013-03-07 21:37:08 +00002427 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
2428 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
2429
2430 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002431 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002432
John McCall1c9c3fd2010-10-15 04:57:14 +00002433 /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
2434 /// a static local variable.
Eli Benderskycb399432014-03-24 22:05:38 +00002435 llvm::Constant *CreateStaticVarDecl(const VarDecl &D,
Eli Benderskycb399432014-03-24 22:05:38 +00002436 llvm::GlobalValue::LinkageTypes Linkage);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002437
Chandler Carruth84537952012-03-30 19:44:53 +00002438 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2439 /// global variable that has already been created for it. If the initializer
2440 /// has a different type than GV does, this may free GV and return a different
2441 /// one. Otherwise it just returns GV.
2442 llvm::GlobalVariable *
2443 AddInitializerToStaticVarDecl(const VarDecl &D,
2444 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002445
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002446
Anders Carlssonf40886a2009-08-08 21:45:14 +00002447 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2448 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002449 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2450 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002451
John McCallc84ed6a2012-05-01 06:13:13 +00002452 /// Call atexit() with a function that passes the given argument to
2453 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00002454 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2455 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002456
John McCallcdf7ef52010-11-06 09:44:32 +00002457 /// Emit code in this function to perform a guarded variable
2458 /// initialization. Guarded initializations are used when it's not
2459 /// possible to prove that an initialization will be done exactly
2460 /// once, e.g. with a static local variable or a static data member
2461 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002462 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002463 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002464
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002465 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2466 /// variables.
2467 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
Benjamin Kramer139cfc22013-04-26 21:32:52 +00002468 ArrayRef<llvm::Constant *> Decls,
Craig Topper8a13c412014-05-21 05:09:00 +00002469 llvm::GlobalVariable *Guard = nullptr);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002470
John McCallee08c532012-04-06 18:21:03 +00002471 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002472 /// variables.
John McCallee08c532012-04-06 18:21:03 +00002473 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2474 const std::vector<std::pair<llvm::WeakVH,
2475 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002476
John McCalla738c252011-03-09 04:27:21 +00002477 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2478 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00002479 llvm::GlobalVariable *Addr,
2480 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002481
John McCall7a626f62010-09-15 10:14:12 +00002482 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002483
2484 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian50198092010-12-02 17:02:11 +00002485 const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00002486
John McCall08ef4662011-11-10 08:15:53 +00002487 void enterFullExpression(const ExprWithCleanups *E) {
2488 if (E->getNumObjects() == 0) return;
2489 enterNonTrivialFullExpression(E);
2490 }
2491 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00002492
Richard Smithea852322013-05-07 21:53:22 +00002493 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00002494
Eli Friedmanc370a7e2012-02-09 03:32:31 +00002495 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2496
Craig Topper8a13c412014-05-21 05:09:00 +00002497 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = nullptr);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00002498
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002499 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002500 // Annotations Emission
2501 //===--------------------------------------------------------------------===//
2502
2503 /// Emit an annotation call (intrinsic or builtin).
2504 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2505 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002506 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002507 SourceLocation Location);
2508
2509 /// Emit local annotations for the local variable V, declared by D.
2510 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2511
2512 /// Emit field annotations for the given field & value. Returns the
2513 /// annotation result.
2514 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2515
2516 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002517 // Internal Helpers
2518 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002519
Chris Lattner5b1964b2008-11-11 07:41:27 +00002520 /// ContainsLabel - Return true if the statement contains a label in it. If
2521 /// this statement is not executed normally, it not containing a label means
2522 /// that we can just remove the code.
2523 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002524
Chris Lattner29911cc2011-02-28 00:18:40 +00002525 /// containsBreak - Return true if the statement contains a break out of it.
2526 /// If the statement (recursively) contains a switch or loop with a break
2527 /// inside of it, this is fine.
2528 static bool containsBreak(const Stmt *S);
2529
Daniel Dunbar682712c2008-11-12 10:12:14 +00002530 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00002531 /// to a constant, or if it does but contains a label, return false. If it
2532 /// constant folds return true and set the boolean result in Result.
2533 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00002534
Chris Lattner29911cc2011-02-28 00:18:40 +00002535 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2536 /// to a constant, or if it does but contains a label, return false. If it
2537 /// constant folds return true and set the folded value.
Richard Trieuc320c742012-07-23 20:21:35 +00002538 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattner29911cc2011-02-28 00:18:40 +00002539
Chris Lattnercd439292008-11-12 08:04:58 +00002540 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2541 /// if statement) to the specified blocks. Based on the condition, this might
2542 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00002543 /// TrueCount should be the number of times we expect the condition to
2544 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00002545 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00002546 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00002547
Richard Smithe30752c2012-10-09 19:52:38 +00002548 /// \brief Emit a description of a type in a format suitable for passing to
2549 /// a runtime sanitizer handler.
2550 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2551
2552 /// \brief Convert a value into a format suitable for passing to a runtime
2553 /// sanitizer handler.
2554 llvm::Value *EmitCheckValue(llvm::Value *V);
2555
2556 /// \brief Emit a description of a source location in a format suitable for
2557 /// passing to a runtime sanitizer handler.
2558 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2559
Will Dietz88e02332012-12-02 19:50:33 +00002560 /// \brief Specify under what conditions this check can be recovered
2561 enum CheckRecoverableKind {
2562 /// Always terminate program execution if this check fails
2563 CRK_Unrecoverable,
2564 /// Check supports recovering, allows user to specify which
2565 CRK_Recoverable,
2566 /// Runtime conditionally aborts, always need to support recovery.
2567 CRK_AlwaysRecoverable
2568 };
2569
Richard Smithde670682012-11-01 22:15:34 +00002570 /// \brief Create a basic block that will call a handler function in a
2571 /// sanitizer runtime with the provided arguments, and create a conditional
2572 /// branch to it.
Richard Smithe30752c2012-10-09 19:52:38 +00002573 void EmitCheck(llvm::Value *Checked, StringRef CheckName,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002574 ArrayRef<llvm::Constant *> StaticArgs,
2575 ArrayRef<llvm::Value *> DynamicArgs,
Will Dietz88e02332012-12-02 19:50:33 +00002576 CheckRecoverableKind Recoverable);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002577
Richard Smithde670682012-11-01 22:15:34 +00002578 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2579 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00002580 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00002581
Anders Carlsson093bdff2010-03-30 03:27:09 +00002582 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00002583 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00002584
John McCall23f66262010-05-26 22:34:26 +00002585 /// EmitDelegateCallArg - We are performing a delegate call; that
2586 /// is, the current function is delegating to another one. Produce
2587 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002588 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
2589 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00002590
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002591 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2592 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00002593 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002594
Chris Lattnercd439292008-11-12 08:04:58 +00002595private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00002596 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002597 void EmitReturnOfRValue(RValue RV, QualType Ty);
2598
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002599 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
2600
2601 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
2602 DeferredReplacements;
2603
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002604 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2605 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2606 ///
2607 /// \param AI - The first function argument of the expansion.
2608 /// \return The argument following the last expanded function
2609 /// argument.
Mike Stumpfc496822009-02-08 23:14:22 +00002610 llvm::Function::arg_iterator
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002611 ExpandTypeFromArgs(QualType Ty, LValue Dst,
2612 llvm::Function::arg_iterator AI);
2613
Mike Stumpfc496822009-02-08 23:14:22 +00002614 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
2615 /// Ty, into individual arguments on the provided vector \arg Args. See
2616 /// ABIArgInfo::Expand.
2617 void ExpandTypeToArgs(QualType Ty, RValue Src,
Craig Topper5603df42013-07-05 19:34:19 +00002618 SmallVectorImpl<llvm::Value *> &Args,
Chris Lattnerd59d8672011-07-12 06:29:11 +00002619 llvm::FunctionType *IRFuncTy);
Anders Carlsson03aaf112009-01-11 19:40:10 +00002620
Chad Rosier59df25b2012-08-23 20:00:18 +00002621 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00002622 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00002623
Chad Rosier59df25b2012-08-23 20:00:18 +00002624 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00002625 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002626 std::string &ConstraintStr,
2627 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00002628
Reid Kleckner89077a12013-12-17 19:46:40 +00002629public:
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002630 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00002631 template <typename T>
2632 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002633 CallExpr::const_arg_iterator ArgBeg,
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002634 CallExpr::const_arg_iterator ArgEnd,
2635 bool ForceColumnInfo = false) {
Reid Kleckner739756c2013-12-04 19:23:12 +00002636 if (CallArgTypeInfo) {
2637 EmitCallArgs(Args, CallArgTypeInfo->isVariadic(),
Alp Toker9cacbab2014-01-20 20:26:09 +00002638 CallArgTypeInfo->param_type_begin(),
2639 CallArgTypeInfo->param_type_end(), ArgBeg, ArgEnd,
Reid Kleckner739756c2013-12-04 19:23:12 +00002640 ForceColumnInfo);
2641 } else {
Alp Toker9cacbab2014-01-20 20:26:09 +00002642 // T::param_type_iterator might not have a default ctor.
Craig Topper8a13c412014-05-21 05:09:00 +00002643 const QualType *NoIter = nullptr;
Reid Kleckner739756c2013-12-04 19:23:12 +00002644 EmitCallArgs(Args, /*AllowExtraArguments=*/true, NoIter, NoIter, ArgBeg,
2645 ArgEnd, ForceColumnInfo);
2646 }
2647 }
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002648
Reid Kleckner739756c2013-12-04 19:23:12 +00002649 template<typename ArgTypeIterator>
2650 void EmitCallArgs(CallArgList& Args,
2651 bool AllowExtraArguments,
2652 ArgTypeIterator ArgTypeBeg,
2653 ArgTypeIterator ArgTypeEnd,
2654 CallExpr::const_arg_iterator ArgBeg,
2655 CallExpr::const_arg_iterator ArgEnd,
2656 bool ForceColumnInfo = false) {
2657 SmallVector<QualType, 16> ArgTypes;
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002658 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002659
Anders Carlsson603d6af2009-04-18 20:20:22 +00002660 // First, use the argument types that the type info knows about
Reid Kleckner739756c2013-12-04 19:23:12 +00002661 for (ArgTypeIterator I = ArgTypeBeg, E = ArgTypeEnd; I != E; ++I, ++Arg) {
2662 assert(Arg != ArgEnd && "Running over edge of argument list!");
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002663#ifndef NDEBUG
Reid Kleckner739756c2013-12-04 19:23:12 +00002664 QualType ArgType = *I;
2665 QualType ActualArgType = Arg->getType();
2666 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
2667 QualType ActualBaseType =
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002668 ActualArgType->getAs<PointerType>()->getPointeeType();
Reid Kleckner739756c2013-12-04 19:23:12 +00002669 QualType ArgBaseType =
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002670 ArgType->getAs<PointerType>()->getPointeeType();
Reid Kleckner739756c2013-12-04 19:23:12 +00002671 if (ArgBaseType->isVariableArrayType()) {
2672 if (const VariableArrayType *VAT =
2673 getContext().getAsVariableArrayType(ActualBaseType)) {
2674 if (!VAT->getSizeExpr())
2675 ActualArgType = ArgType;
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002676 }
2677 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00002678 }
Reid Kleckner739756c2013-12-04 19:23:12 +00002679 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
2680 getTypePtr() ==
2681 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
2682 "type mismatch in call argument!");
2683#endif
2684 ArgTypes.push_back(*I);
Anders Carlsson603d6af2009-04-18 20:20:22 +00002685 }
Mike Stump11289f42009-09-09 15:08:12 +00002686
Reid Kleckner739756c2013-12-04 19:23:12 +00002687 // Either we've emitted all the call args, or we have a call to variadic
2688 // function or some other call that allows extra arguments.
2689 assert((Arg == ArgEnd || AllowExtraArguments) &&
2690 "Extra arguments in non-variadic function!");
2691
Anders Carlsson603d6af2009-04-18 20:20:22 +00002692 // If we still have any arguments, emit them using the type of the argument.
Reid Kleckner739756c2013-12-04 19:23:12 +00002693 for (; Arg != ArgEnd; ++Arg)
2694 ArgTypes.push_back(Arg->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002695
Reid Kleckner739756c2013-12-04 19:23:12 +00002696 EmitCallArgs(Args, ArgTypes, ArgBeg, ArgEnd, ForceColumnInfo);
Anders Carlsson603d6af2009-04-18 20:20:22 +00002697 }
John McCalld4f4b7f2010-03-03 04:15:11 +00002698
Reid Kleckner739756c2013-12-04 19:23:12 +00002699 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
2700 CallExpr::const_arg_iterator ArgBeg,
Richard Smith760520b2014-06-03 23:27:44 +00002701 CallExpr::const_arg_iterator ArgEnd,
2702 bool ForceColumnInfo = false);
Reid Kleckner739756c2013-12-04 19:23:12 +00002703
Reid Kleckner89077a12013-12-17 19:46:40 +00002704private:
John McCalld4f4b7f2010-03-03 04:15:11 +00002705 const TargetCodeGenInfo &getTargetHooks() const {
2706 return CGM.getTargetCodeGenInfo();
2707 }
John McCall09ae0322010-07-06 23:57:41 +00002708
2709 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00002710
2711 CodeGenModule::ByrefHelpers *
Chris Lattner2192fe52011-07-18 04:24:23 +00002712 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf9b056b2011-03-31 08:03:29 +00002713 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00002714
2715 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00002716
Eli Friedmana5dd5682012-08-23 03:10:17 +00002717 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2718 /// value and compute our best estimate of the alignment of the pointee.
2719 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
Chris Lattnerbed31442007-05-28 01:07:47 +00002720};
Mike Stump11289f42009-09-09 15:08:12 +00002721
John McCallce1de612011-01-26 04:00:11 +00002722/// Helper class with most of the code for saving a value for a
2723/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00002724struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00002725 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2726
2727 /// Answer whether the given value needs extra work to be saved.
2728 static bool needsSaving(llvm::Value *value) {
2729 // If it's not an instruction, we don't need to save.
2730 if (!isa<llvm::Instruction>(value)) return false;
2731
2732 // If it's an instruction in the entry block, we don't need to save.
2733 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2734 return (block != &block->getParent()->getEntryBlock());
2735 }
2736
2737 /// Try to save the given value.
2738 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2739 if (!needsSaving(value)) return saved_type(value, false);
2740
2741 // Otherwise we need an alloca.
2742 llvm::Value *alloca =
2743 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2744 CGF.Builder.CreateStore(value, alloca);
2745
2746 return saved_type(alloca, true);
2747 }
2748
2749 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2750 if (!value.getInt()) return value.getPointer();
2751 return CGF.Builder.CreateLoad(value.getPointer());
2752 }
2753};
2754
John McCallcb5f77f2011-01-28 10:53:53 +00002755/// A partial specialization of DominatingValue for llvm::Values that
2756/// might be llvm::Instructions.
2757template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2758 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00002759 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00002760 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2761 }
2762};
2763
2764/// A specialization of DominatingValue for RValue.
2765template <> struct DominatingValue<RValue> {
2766 typedef RValue type;
2767 class saved_type {
2768 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2769 AggregateAddress, ComplexAddress };
2770
2771 llvm::Value *Value;
2772 Kind K;
2773 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2774
2775 public:
2776 static bool needsSaving(RValue value);
2777 static saved_type save(CodeGenFunction &CGF, RValue value);
2778 RValue restore(CodeGenFunction &CGF);
2779
2780 // implementations in CGExprCXX.cpp
2781 };
2782
2783 static bool needsSaving(type value) {
2784 return saved_type::needsSaving(value);
2785 }
2786 static saved_type save(CodeGenFunction &CGF, type value) {
2787 return saved_type::save(CGF, value);
2788 }
2789 static type restore(CodeGenFunction &CGF, saved_type value) {
2790 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00002791 }
2792};
2793
Chris Lattnerbed31442007-05-28 01:07:47 +00002794} // end namespace CodeGen
2795} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00002796
Chris Lattnerbed31442007-05-28 01:07:47 +00002797#endif