blob: a31cd1bf7af9f2735c360715a2828556d6aca107 [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;
Alexey Bataev03b340a2014-10-21 03:16:40 +0000116 friend class CGOpenMPRegionInfo;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000117public:
John McCallad5d61e2010-07-23 21:56:41 +0000118 /// A jump destination is an abstract label, branching to which may
119 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000120 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000121 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000122 JumpDest(llvm::BasicBlock *Block,
123 EHScopeStack::stable_iterator Depth,
124 unsigned Index)
125 : Block(Block), ScopeDepth(Depth), Index(Index) {}
126
Craig Topper8a13c412014-05-21 05:09:00 +0000127 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000128 llvm::BasicBlock *getBlock() const { return Block; }
129 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
130 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000131
Nadav Rotem1da30942013-03-23 06:43:35 +0000132 // This should be used cautiously.
133 void setScopeDepth(EHScopeStack::stable_iterator depth) {
134 ScopeDepth = depth;
135 }
136
John McCallad5d61e2010-07-23 21:56:41 +0000137 private:
John McCallbd309292010-07-06 01:34:17 +0000138 llvm::BasicBlock *Block;
139 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000140 unsigned Index;
141 };
142
Chris Lattnerbed31442007-05-28 01:07:47 +0000143 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000144 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000145
Chris Lattner96d72562007-08-21 16:57:55 +0000146 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000147 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000148 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000149
Alexander Musman515ad8c2014-05-22 08:54:05 +0000150 /// \brief CGBuilder insert helper. This function is called after an
151 /// instruction is created using Builder.
152 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
153 llvm::BasicBlock *BB,
154 llvm::BasicBlock::iterator InsertPt) const;
155
John McCalldec348f72013-05-03 07:33:41 +0000156 /// CurFuncDecl - Holds the Decl for the current outermost
157 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000158 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000159 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
160 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000161 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000162 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000163 llvm::Function *CurFn;
164
Mike Stumpbee78dd2009-12-04 23:26:17 +0000165 /// CurGD - The GlobalDecl for the current function being compiled.
166 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000167
John McCall31168b02011-06-15 23:02:42 +0000168 /// PrologueCleanupDepth - The cleanup depth enclosing all the
169 /// cleanups associated with the parameters.
170 EHScopeStack::stable_iterator PrologueCleanupDepth;
171
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000172 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000173 JumpDest ReturnBlock;
174
Mike Stumpfc496822009-02-08 23:14:22 +0000175 /// ReturnValue - The temporary alloca to hold the return value. This is null
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +0000176 /// iff the function has no return value.
Eli Friedman4b1942c2009-12-04 02:43:40 +0000177 llvm::Value *ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000178
Chris Lattner03df1222007-06-02 04:53:11 +0000179 /// AllocaInsertPoint - This is an instruction in the entry block before which
180 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000181 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000182
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000183 /// \brief API for captured statement code generation.
184 class CGCapturedStmtInfo {
185 public:
186 explicit CGCapturedStmtInfo(const CapturedStmt &S,
187 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000188 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000189
190 RecordDecl::field_iterator Field =
191 S.getCapturedRecordDecl()->field_begin();
192 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
193 E = S.capture_end();
194 I != E; ++I, ++Field) {
195 if (I->capturesThis())
196 CXXThisFieldDecl = *Field;
197 else
198 CaptureFields[I->getCapturedVar()] = *Field;
199 }
200 }
201
202 virtual ~CGCapturedStmtInfo();
203
204 CapturedRegionKind getKind() const { return Kind; }
205
206 void setContextValue(llvm::Value *V) { ThisValue = V; }
207 // \brief Retrieve the value of the context parameter.
208 llvm::Value *getContextValue() const { return ThisValue; }
209
210 /// \brief Lookup the captured field decl for a variable.
211 const FieldDecl *lookup(const VarDecl *VD) const {
212 return CaptureFields.lookup(VD);
213 }
214
Craig Topper8a13c412014-05-21 05:09:00 +0000215 bool isCXXThisExprCaptured() const { return CXXThisFieldDecl != nullptr; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000216 FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
217
Alexey Bataev18095712014-10-10 12:19:54 +0000218 static bool classof(const CGCapturedStmtInfo *) {
219 return true;
220 }
221
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000222 /// \brief Emit the captured statement body.
223 virtual void EmitBody(CodeGenFunction &CGF, Stmt *S) {
Justin Bogner81ab90f2014-04-15 00:50:54 +0000224 RegionCounter Cnt = CGF.getPGORegionCounter(S);
225 Cnt.beginRegion(CGF.Builder);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000226 CGF.EmitStmt(S);
227 }
228
229 /// \brief Get the name of the capture helper.
230 virtual StringRef getHelperName() const { return "__captured_stmt"; }
231
232 private:
233 /// \brief The kind of captured statement being generated.
234 CapturedRegionKind Kind;
235
236 /// \brief Keep the map between VarDecl and FieldDecl.
237 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
238
239 /// \brief The base address of the captured record, passed in as the first
240 /// argument of the parallel region function.
241 llvm::Value *ThisValue;
242
243 /// \brief Captured 'this' type.
244 FieldDecl *CXXThisFieldDecl;
245 };
246 CGCapturedStmtInfo *CapturedStmtInfo;
247
Nuno Lopes3d6311d2012-05-08 22:10:46 +0000248 /// BoundsChecking - Emit run-time bounds checks. Higher values mean
249 /// potentially higher performance penalties.
250 unsigned char BoundsChecking;
251
Will Dietzf54319c2013-01-18 11:30:38 +0000252 /// \brief Sanitizer options to use for this function.
253 const SanitizerOptions *SanOpts;
254
Alexey Samsonov24cad992014-07-17 18:46:27 +0000255 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
256 bool IsSanitizerScope;
257
258 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
259 class SanitizerScope {
260 CodeGenFunction *CGF;
261 public:
262 SanitizerScope(CodeGenFunction *CGF);
263 ~SanitizerScope();
264 };
265
Reid Kleckner19819442014-07-25 21:39:46 +0000266 /// In C++, whether we are code generating a thunk. This controls whether we
267 /// should emit cleanups.
268 bool CurFuncIsThunk;
269
John McCall31168b02011-06-15 23:02:42 +0000270 /// In ARC, whether we should autorelease the return value.
271 bool AutoreleaseResult;
272
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000273 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
274 /// potentially set the return value.
275 bool SawAsmBlock;
276
John McCallad7c5c12011-02-08 08:22:06 +0000277 const CodeGen::CGBlockInfo *BlockInfo;
278 llvm::Value *BlockPointer;
279
Eli Friedman9fbeba02012-02-11 02:57:39 +0000280 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
281 FieldDecl *LambdaThisCaptureField;
282
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000283 /// \brief A mapping from NRVO variables to the flags used to indicate
284 /// when the NRVO has been applied to this variable.
285 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000286
John McCallbd309292010-07-06 01:34:17 +0000287 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000288 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
289
290 /// Header for data within LifetimeExtendedCleanupStack.
291 struct LifetimeExtendedCleanupHeader {
292 /// The size of the following cleanup object.
293 size_t Size : 29;
294 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
295 unsigned Kind : 3;
296
297 size_t getSize() const { return Size; }
298 CleanupKind getKind() const { return static_cast<CleanupKind>(Kind); }
299 };
John McCallbd309292010-07-06 01:34:17 +0000300
John McCallad5d61e2010-07-23 21:56:41 +0000301 /// i32s containing the indexes of the cleanup destinations.
302 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000303
304 unsigned NextCleanupDestIndex;
305
John McCall08ef4662011-11-10 08:15:53 +0000306 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
307 CGBlockInfo *FirstBlockInfo;
308
John McCall8e4c74b2011-08-11 02:22:43 +0000309 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
310 llvm::BasicBlock *EHResumeBlock;
311
Bill Wendlingf0724e82011-09-19 20:31:14 +0000312 /// The exception slot. All landing pads write the current exception pointer
313 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000314 llvm::Value *ExceptionSlot;
315
Bill Wendlingf0724e82011-09-19 20:31:14 +0000316 /// The selector slot. Under the MandatoryCleanup model, all landing pads
317 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000318 llvm::AllocaInst *EHSelectorSlot;
319
John McCallbd309292010-07-06 01:34:17 +0000320 /// Emits a landing pad for the current EH stack.
321 llvm::BasicBlock *EmitLandingPad();
322
323 llvm::BasicBlock *getInvokeDestImpl();
324
John McCallce1de612011-01-26 04:00:11 +0000325 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000326 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
327 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000328 }
329
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000330public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000331 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
332 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000333 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000334
John McCall6b0feb72011-06-22 02:32:12 +0000335 /// A class controlling the emission of a finally block.
336 class FinallyInfo {
337 /// Where the catchall's edge through the cleanup should go.
338 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000339
John McCall6b0feb72011-06-22 02:32:12 +0000340 /// A function to call to enter the catch.
341 llvm::Constant *BeginCatchFn;
342
343 /// An i1 variable indicating whether or not the @finally is
344 /// running for an exception.
345 llvm::AllocaInst *ForEHVar;
346
347 /// An i8* variable into which the exception pointer to rethrow
348 /// has been saved.
349 llvm::AllocaInst *SavedExnVar;
350
351 public:
352 void enter(CodeGenFunction &CGF, const Stmt *Finally,
353 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
354 llvm::Constant *rethrowFn);
355 void exit(CodeGenFunction &CGF);
356 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000357
John McCallce1de612011-01-26 04:00:11 +0000358 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
359 /// current full-expression. Safe against the possibility that
360 /// we're currently inside a conditionally-evaluated expression.
John McCalle4df6c82011-01-28 08:37:24 +0000361 template <class T, class A0>
362 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
363 // If we're not in a conditional branch, or if none of the
364 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000365 if (!isInConditionalBranch())
366 return EHStack.pushCleanup<T>(kind, a0);
John McCalle4df6c82011-01-28 08:37:24 +0000367
John McCallcb5f77f2011-01-28 10:53:53 +0000368 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCalle4df6c82011-01-28 08:37:24 +0000369
370 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
371 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
372 initFullExprCleanup();
373 }
374
375 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
376 /// current full-expression. Safe against the possibility that
377 /// we're currently inside a conditionally-evaluated expression.
John McCallce1de612011-01-26 04:00:11 +0000378 template <class T, class A0, class A1>
379 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
380 // If we're not in a conditional branch, or if none of the
381 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000382 if (!isInConditionalBranch())
383 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCallce1de612011-01-26 04:00:11 +0000384
John McCallcb5f77f2011-01-28 10:53:53 +0000385 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
386 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCallce1de612011-01-26 04:00:11 +0000387
388 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCalle4df6c82011-01-28 08:37:24 +0000389 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
390 initFullExprCleanup();
John McCallce1de612011-01-26 04:00:11 +0000391 }
392
Douglas Gregor58df5092011-06-22 16:12:01 +0000393 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
394 /// current full-expression. Safe against the possibility that
395 /// we're currently inside a conditionally-evaluated expression.
396 template <class T, class A0, class A1, class A2>
397 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
398 // If we're not in a conditional branch, or if none of the
399 // arguments requires saving, then use the unconditional cleanup.
400 if (!isInConditionalBranch()) {
John McCall5fcf8da2011-07-12 00:15:30 +0000401 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregor58df5092011-06-22 16:12:01 +0000402 }
403
404 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
405 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
406 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
407
408 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
409 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
410 initFullExprCleanup();
411 }
412
John McCall4bd0fb12011-07-12 16:41:08 +0000413 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
414 /// current full-expression. Safe against the possibility that
415 /// we're currently inside a conditionally-evaluated expression.
416 template <class T, class A0, class A1, class A2, class A3>
417 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
418 // If we're not in a conditional branch, or if none of the
419 // arguments requires saving, then use the unconditional cleanup.
420 if (!isInConditionalBranch()) {
421 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
422 }
423
424 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
425 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
426 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
427 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
428
429 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
430 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
431 a2_saved, a3_saved);
432 initFullExprCleanup();
433 }
434
Richard Smith736a9472013-06-12 20:42:33 +0000435 /// \brief Queue a cleanup to be pushed after finishing the current
436 /// full-expression.
437 template <class T, class A0, class A1, class A2, class A3>
438 void pushCleanupAfterFullExpr(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
439 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
440
441 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
442
443 size_t OldSize = LifetimeExtendedCleanupStack.size();
444 LifetimeExtendedCleanupStack.resize(
445 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
446
447 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
448 new (Buffer) LifetimeExtendedCleanupHeader(Header);
449 new (Buffer + sizeof(Header)) T(a0, a1, a2, a3);
450 }
451
John McCallf4beacd2011-11-10 10:43:54 +0000452 /// Set up the last cleaup that was pushed as a conditional
453 /// full-expression cleanup.
454 void initFullExprCleanup();
455
John McCallbd309292010-07-06 01:34:17 +0000456 /// PushDestructorCleanup - Push a cleanup to call the
457 /// complete-object destructor of an object of the given type at the
458 /// given address. Does nothing if T is not a C++ class type with a
459 /// non-trivial destructor.
460 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
461
John McCall8680f872010-07-21 06:29:51 +0000462 /// PushDestructorCleanup - Push a cleanup to call the
463 /// complete-object variant of the given destructor on the object at
464 /// the given address.
465 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
466 llvm::Value *Addr);
467
John McCallbd309292010-07-06 01:34:17 +0000468 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
469 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000470 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000471
John McCall824c2f52010-09-14 07:57:04 +0000472 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
473 /// The block cannot be reactivated. Pops it if it's the top of the
474 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000475 ///
476 /// \param DominatingIP - An instruction which is known to
477 /// dominate the current IP (if set) and which lies along
478 /// all paths of execution between the current IP and the
479 /// the point at which the cleanup comes into scope.
480 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
481 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000482
483 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
484 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000485 ///
486 /// \param DominatingIP - An instruction which is known to
487 /// dominate the current IP (if set) and which lies along
488 /// all paths of execution between the current IP and the
489 /// the point at which the cleanup comes into scope.
490 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
491 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000492
John McCallbd309292010-07-06 01:34:17 +0000493 /// \brief Enters a new scope for capturing cleanups, all of which
494 /// will be executed once the scope is exited.
495 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000496 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000497 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000498 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000499 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000500 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000501 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000502
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000503 RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
504 void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
Douglas Gregor965f4502009-11-24 16:43:22 +0000505
Eric Christophera9d34972011-10-19 00:43:52 +0000506 protected:
507 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000508
Douglas Gregor965f4502009-11-24 16:43:22 +0000509 public:
510 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000511 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000512 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000513 {
John McCallbd309292010-07-06 01:34:17 +0000514 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000515 LifetimeExtendedCleanupStackSize =
516 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000517 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000518 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000519 }
520
521 /// \brief Exit this cleanup scope, emitting any accumulated
522 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000523 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000524 if (PerformCleanup) {
525 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000526 CGF.PopCleanupBlocks(CleanupStackDepth,
527 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000528 }
529 }
530
531 /// \brief Determine whether this scope requires any cleanups.
532 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000533 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000534 }
535
536 /// \brief Force the emission of cleanups now, instead of waiting
537 /// until this object is destroyed.
538 void ForceCleanup() {
539 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000540 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000541 CGF.PopCleanupBlocks(CleanupStackDepth,
542 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000543 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000544 }
545 };
546
David Blaikie93be0b22014-08-22 21:37:04 +0000547 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000548 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000549 SmallVector<const LabelDecl*, 4> Labels;
550 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000551
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000552 LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
553 void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
Eric Christophera9d34972011-10-19 00:43:52 +0000554
555 public:
556 /// \brief Enter a new cleanup scope.
557 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000558 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
559 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000560 if (CGDebugInfo *DI = CGF.getDebugInfo())
561 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
562 }
563
Nadav Rotem1da30942013-03-23 06:43:35 +0000564 void addLabel(const LabelDecl *label) {
565 assert(PerformCleanup && "adding label to dead scope?");
566 Labels.push_back(label);
567 }
568
Eric Christophera9d34972011-10-19 00:43:52 +0000569 /// \brief Exit this cleanup scope, emitting any accumulated
570 /// cleanups.
571 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000572 if (CGDebugInfo *DI = CGF.getDebugInfo())
573 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
574
Nadav Rotem1da30942013-03-23 06:43:35 +0000575 // If we should perform a cleanup, force them now. Note that
576 // this ends the cleanup scope before rescoping any labels.
577 if (PerformCleanup) ForceCleanup();
Eric Christophera9d34972011-10-19 00:43:52 +0000578 }
579
580 /// \brief Force the emission of cleanups now, instead of waiting
581 /// until this object is destroyed.
582 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000583 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000584 RunCleanupsScope::ForceCleanup();
585
Nadav Rotem1da30942013-03-23 06:43:35 +0000586 if (!Labels.empty())
587 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000588 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000589
590 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000591 };
592
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000593 /// \brief The scope used to remap some variables as private in the OpenMP
594 /// loop body (or other captured region emitted without outlining), and to
595 /// restore old vars back on exit.
596 class OMPPrivateScope : public RunCleanupsScope {
597 typedef llvm::DenseMap<const VarDecl *, llvm::Value *> VarDeclMapTy;
598 VarDeclMapTy SavedLocals;
599 VarDeclMapTy SavedPrivates;
600
601 private:
602 OMPPrivateScope(const OMPPrivateScope &) LLVM_DELETED_FUNCTION;
603 void operator=(const OMPPrivateScope &) LLVM_DELETED_FUNCTION;
604
605 public:
606 /// \brief Enter a new OpenMP private scope.
607 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
608
609 /// \brief Registers \a LocalVD variable as a private and apply \a
610 /// PrivateGen function for it to generate corresponding private variable.
611 /// \a PrivateGen returns an address of the generated private variable.
612 /// \return true if the variable is registered as private, false if it has
613 /// been privatized already.
614 bool
615 addPrivate(const VarDecl *LocalVD,
616 const std::function<llvm::Value *()> &PrivateGen) {
617 assert(PerformCleanup && "adding private to dead scope");
618 assert(LocalVD->isLocalVarDecl() && "privatizing non-local variable");
619 if (SavedLocals.count(LocalVD) > 0) return false;
620 SavedLocals[LocalVD] = CGF.LocalDeclMap.lookup(LocalVD);
621 CGF.LocalDeclMap.erase(LocalVD);
622 SavedPrivates[LocalVD] = PrivateGen();
623 CGF.LocalDeclMap[LocalVD] = SavedLocals[LocalVD];
624 return true;
625 }
626
627 /// \brief Privatizes local variables previously registered as private.
628 /// Registration is separate from the actual privatization to allow
629 /// initializers use values of the original variables, not the private one.
630 /// This is important, for example, if the private variable is a class
631 /// variable initialized by a constructor that references other private
632 /// variables. But at initialization original variables must be used, not
633 /// private copies.
634 /// \return true if at least one variable was privatized, false otherwise.
635 bool Privatize() {
636 for (auto VDPair : SavedPrivates) {
637 CGF.LocalDeclMap[VDPair.first] = VDPair.second;
638 }
639 SavedPrivates.clear();
640 return !SavedLocals.empty();
641 }
642
643 void ForceCleanup() {
644 RunCleanupsScope::ForceCleanup();
645 // Remap vars back to the original values.
646 for (auto I : SavedLocals) {
647 CGF.LocalDeclMap[I.first] = I.second;
648 }
649 SavedLocals.clear();
650 }
651
652 /// \brief Exit scope - all the mapped variables are restored.
653 ~OMPPrivateScope() { ForceCleanup(); }
654 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000655
Richard Smith736a9472013-06-12 20:42:33 +0000656 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
657 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000658 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000659
Richard Smith736a9472013-06-12 20:42:33 +0000660 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
661 /// that have been added, then adds all lifetime-extended cleanups from
662 /// the given position to the stack.
663 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
664 size_t OldLifetimeExtendedStackSize);
665
John McCallad5d61e2010-07-23 21:56:41 +0000666 void ResolveBranchFixups(llvm::BasicBlock *Target);
667
John McCallbd309292010-07-06 01:34:17 +0000668 /// The given basic block lies in the current EH scope, but may be a
669 /// target of a potentially scope-crossing jump; get a stable handle
670 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000671 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000672 return JumpDest(Target,
673 EHStack.getInnermostNormalCleanup(),
674 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000675 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000676
John McCallbd309292010-07-06 01:34:17 +0000677 /// The given basic block lies in the current EH scope, but may be a
678 /// target of a potentially scope-crossing jump; get a stable handle
679 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000680 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000681 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000682 }
683
684 /// EmitBranchThroughCleanup - Emit a branch from the current insert
685 /// block through the normal cleanup handling code (if any) and then
686 /// on to \arg Dest.
687 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000688
Justin Bognere25ffdf2014-01-21 00:35:11 +0000689 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
690 /// specified destination obviously has no cleanups to run. 'false' is always
691 /// a conservatively correct answer for this method.
692 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
693
John McCall8e4c74b2011-08-11 02:22:43 +0000694 /// popCatchScope - Pops the catch scope at the top of the EHScope
695 /// stack, emitting any required code (other than the catch handlers
696 /// themselves).
697 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000698
David Chisnall9a837be2012-11-07 16:50:40 +0000699 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000700 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000701
John McCallce1de612011-01-26 04:00:11 +0000702 /// An object to manage conditionally-evaluated expressions.
703 class ConditionalEvaluation {
704 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000705
John McCallce1de612011-01-26 04:00:11 +0000706 public:
707 ConditionalEvaluation(CodeGenFunction &CGF)
708 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000709
John McCallce1de612011-01-26 04:00:11 +0000710 void begin(CodeGenFunction &CGF) {
711 assert(CGF.OutermostConditional != this);
712 if (!CGF.OutermostConditional)
713 CGF.OutermostConditional = this;
714 }
715
716 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000717 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000718 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000719 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000720 }
721
722 /// Returns a block which will be executed prior to each
723 /// evaluation of the conditional code.
724 llvm::BasicBlock *getStartingBlock() const {
725 return StartBB;
726 }
727 };
Mike Stump11289f42009-09-09 15:08:12 +0000728
John McCall7f9c92a2010-09-17 00:50:28 +0000729 /// isInConditionalBranch - Return true if we're currently emitting
730 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000731 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000732
John McCallf4beacd2011-11-10 10:43:54 +0000733 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
734 assert(isInConditionalBranch());
735 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
736 new llvm::StoreInst(value, addr, &block->back());
737 }
738
John McCallce1de612011-01-26 04:00:11 +0000739 /// An RAII object to record that we're evaluating a statement
740 /// expression.
741 class StmtExprEvaluation {
742 CodeGenFunction &CGF;
743
744 /// We have to save the outermost conditional: cleanups in a
745 /// statement expression aren't conditional just because the
746 /// StmtExpr is.
747 ConditionalEvaluation *SavedOutermostConditional;
748
749 public:
750 StmtExprEvaluation(CodeGenFunction &CGF)
751 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000752 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000753 }
754
755 ~StmtExprEvaluation() {
756 CGF.OutermostConditional = SavedOutermostConditional;
757 CGF.EnsureInsertPoint();
758 }
759 };
John McCall1bf58462011-02-16 08:02:54 +0000760
John McCallc07a0c72011-02-17 10:25:35 +0000761 /// An object which temporarily prevents a value from being
762 /// destroyed by aggressive peephole optimizations that assume that
763 /// all uses of a value have been realized in the IR.
764 class PeepholeProtection {
765 llvm::Instruction *Inst;
766 friend class CodeGenFunction;
767
768 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000769 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000770 };
John McCallc07a0c72011-02-17 10:25:35 +0000771
John McCallfe96e0b2011-11-06 09:01:30 +0000772 /// A non-RAII class containing all the information about a bound
773 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
774 /// this which makes individual mappings very simple; using this
775 /// class directly is useful when you have a variable number of
776 /// opaque values or don't want the RAII functionality for some
777 /// reason.
778 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000779 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000780 bool BoundLValue;
781 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000782
John McCallfe96e0b2011-11-06 09:01:30 +0000783 OpaqueValueMappingData(const OpaqueValueExpr *ov,
784 bool boundLValue)
785 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000786 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000787 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000788
John McCallc07a0c72011-02-17 10:25:35 +0000789 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000790 // gl-values should be bound as l-values for obvious reasons.
791 // Records should be bound as l-values because IR generation
792 // always keeps them in memory. Expressions of function type
793 // act exactly like l-values but are formally required to be
794 // r-values in C.
795 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000796 expr->getType()->isFunctionType() ||
797 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000798 }
799
John McCallfe96e0b2011-11-06 09:01:30 +0000800 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
801 const OpaqueValueExpr *ov,
802 const Expr *e) {
803 if (shouldBindAsLValue(ov))
804 return bind(CGF, ov, CGF.EmitLValue(e));
805 return bind(CGF, ov, CGF.EmitAnyExpr(e));
806 }
807
808 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
809 const OpaqueValueExpr *ov,
810 const LValue &lv) {
811 assert(shouldBindAsLValue(ov));
812 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
813 return OpaqueValueMappingData(ov, true);
814 }
815
816 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
817 const OpaqueValueExpr *ov,
818 const RValue &rv) {
819 assert(!shouldBindAsLValue(ov));
820 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
821
822 OpaqueValueMappingData data(ov, false);
823
824 // Work around an extremely aggressive peephole optimization in
825 // EmitScalarConversion which assumes that all other uses of a
826 // value are extant.
827 data.Protection = CGF.protectFromPeepholes(rv);
828
829 return data;
830 }
831
Craig Topper8a13c412014-05-21 05:09:00 +0000832 bool isValid() const { return OpaqueValue != nullptr; }
833 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000834
835 void unbind(CodeGenFunction &CGF) {
836 assert(OpaqueValue && "no data to unbind!");
837
838 if (BoundLValue) {
839 CGF.OpaqueLValues.erase(OpaqueValue);
840 } else {
841 CGF.OpaqueRValues.erase(OpaqueValue);
842 CGF.unprotectFromPeepholes(Protection);
843 }
844 }
845 };
846
847 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
848 class OpaqueValueMapping {
849 CodeGenFunction &CGF;
850 OpaqueValueMappingData Data;
851
852 public:
853 static bool shouldBindAsLValue(const Expr *expr) {
854 return OpaqueValueMappingData::shouldBindAsLValue(expr);
855 }
856
John McCallc07a0c72011-02-17 10:25:35 +0000857 /// Build the opaque value mapping for the given conditional
858 /// operator if it's the GNU ?: extension. This is a common
859 /// enough pattern that the convenience operator is really
860 /// helpful.
861 ///
862 OpaqueValueMapping(CodeGenFunction &CGF,
863 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000864 if (isa<ConditionalOperator>(op))
865 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000866 return;
John McCallc07a0c72011-02-17 10:25:35 +0000867
868 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000869 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
870 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000871 }
872
John McCall1bf58462011-02-16 08:02:54 +0000873 OpaqueValueMapping(CodeGenFunction &CGF,
874 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000875 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000876 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000877 }
878
879 OpaqueValueMapping(CodeGenFunction &CGF,
880 const OpaqueValueExpr *opaqueValue,
881 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000882 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000883 }
884
885 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000886 Data.unbind(CGF);
887 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000888 }
889
890 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000891 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000892 }
893 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000894
895 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
896 /// number that holds the value.
897 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian2f2fa722011-01-26 23:08:27 +0000898
899 /// BuildBlockByrefAddress - Computes address location of the
900 /// variable which is declared as __block.
901 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
902 const VarDecl *V);
Chris Lattner2da04b32007-08-24 05:35:26 +0000903private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000904 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000905 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000906
John McCall9b382dd2011-05-28 21:13:02 +0000907 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
908 /// calling llvm.stacksave for multiple VLAs in the same scope.
909 bool DidCallStackSave;
910
Mike Stumpe5311b02009-11-30 20:08:49 +0000911 /// IndirectBranch - The first time an indirect goto is seen we create a block
912 /// with an indirect branch. Every time we see the address of a label taken,
913 /// we add the label to the indirect goto. Every subsequent indirect goto is
914 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000915 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000916
Mike Stumpfc496822009-02-08 23:14:22 +0000917 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
918 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000919 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
920 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000921
Chris Lattnerac248202007-05-30 00:13:02 +0000922 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000923 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000924
Mike Stumpfc496822009-02-08 23:14:22 +0000925 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000926 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000927 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000928 BreakContinue(JumpDest Break, JumpDest Continue)
929 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000930
John McCallbd309292010-07-06 01:34:17 +0000931 JumpDest BreakBlock;
932 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000933 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000934 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000935
Justin Bogneref512b92014-01-06 22:27:43 +0000936 CodeGenPGO PGO;
937
938public:
939 /// Get a counter for instrumentation of the region associated with the given
940 /// statement.
941 RegionCounter getPGORegionCounter(const Stmt *S) {
942 return RegionCounter(PGO, S);
943 }
944private:
945
Zhongxing Xu82846ea2012-01-14 09:08:15 +0000946 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +0000947 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000948 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +0000949 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
950 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +0000951
Mike Stumpfc496822009-02-08 23:14:22 +0000952 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000953 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000954 llvm::BasicBlock *CaseRangeBlock;
955
John McCallc07a0c72011-02-17 10:25:35 +0000956 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +0000957 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +0000958 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
959 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +0000960
Mike Stumpfc496822009-02-08 23:14:22 +0000961 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +0000962 // We track this by the size expression rather than the type itself because
963 // in certain situations, like a const qualifier applied to an VLA typedef,
964 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +0000965 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
966 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +0000967 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000968
John McCallbd309292010-07-06 01:34:17 +0000969 /// A block containing a single 'unreachable' instruction. Created
970 /// lazily by getUnreachableBlock().
971 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000972
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000973 /// Counts of the number return expressions in the function.
974 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +0000975
976 /// Count the number of simple (constant) return expressions in the function.
977 unsigned NumSimpleReturnExprs;
978
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000979 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +0000980 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +0000981
Richard Smith852c9db2013-04-20 22:23:05 +0000982public:
983 /// A scope within which we are constructing the fields of an object which
984 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
985 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
986 class FieldConstructionScope {
987 public:
988 FieldConstructionScope(CodeGenFunction &CGF, llvm::Value *This)
989 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
990 CGF.CXXDefaultInitExprThis = This;
991 }
992 ~FieldConstructionScope() {
993 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
994 }
995
996 private:
997 CodeGenFunction &CGF;
998 llvm::Value *OldCXXDefaultInitExprThis;
999 };
1000
1001 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1002 /// is overridden to be the object under construction.
1003 class CXXDefaultInitExprScope {
1004 public:
1005 CXXDefaultInitExprScope(CodeGenFunction &CGF)
1006 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue) {
1007 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis;
1008 }
1009 ~CXXDefaultInitExprScope() {
1010 CGF.CXXThisValue = OldCXXThisValue;
1011 }
1012
1013 public:
1014 CodeGenFunction &CGF;
1015 llvm::Value *OldCXXThisValue;
1016 };
1017
1018private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001019 /// CXXThisDecl - When generating code for a C++ member function,
1020 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001021 ImplicitParamDecl *CXXABIThisDecl;
1022 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001023 llvm::Value *CXXThisValue;
Mike Stump11289f42009-09-09 15:08:12 +00001024
Richard Smith852c9db2013-04-20 22:23:05 +00001025 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1026 /// this expression.
1027 llvm::Value *CXXDefaultInitExprThis;
1028
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001029 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1030 /// destructor, this will hold the implicit argument (e.g. VTT).
1031 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1032 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001033
John McCallce1de612011-01-26 04:00:11 +00001034 /// OutermostConditional - Points to the outermost active
1035 /// conditional control. This is used so that we know if a
1036 /// temporary should be destroyed conditionally.
1037 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001038
Nadav Rotem1da30942013-03-23 06:43:35 +00001039 /// The current lexical scope.
1040 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001041
Adrian Prantldc237b52013-05-16 00:41:26 +00001042 /// The current source location that should be used for exception
1043 /// handling code.
1044 SourceLocation CurEHLocation;
1045
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001046 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1047 /// type as well as the field number that contains the actual data.
Chris Lattner2192fe52011-07-18 04:24:23 +00001048 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001049 unsigned> > ByRefValueInfo;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001050
John McCallbd309292010-07-06 01:34:17 +00001051 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001052 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001053 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001054
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001055 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1056 /// In the kernel metadata node, reference the kernel function and metadata
1057 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001058 /// - A node for the vec_type_hint(<type>) qualifier contains string
1059 /// "vec_type_hint", an undefined value of the <type> data type,
1060 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001061 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1062 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1063 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1064 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1065 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1066 llvm::Function *Fn);
1067
Chris Lattnerbed31442007-05-28 01:07:47 +00001068public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001069 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001070 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001071
John McCall8ed55a52010-09-02 09:58:18 +00001072 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001073 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001074 CGDebugInfo *getDebugInfo() {
1075 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001076 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001077 return DebugInfo;
1078 }
1079 void disableDebugInfo() { DisableDebugInfo = true; }
1080 void enableDebugInfo() { DisableDebugInfo = false; }
1081
John McCall31168b02011-06-15 23:02:42 +00001082 bool shouldUseFusedARCCalls() {
1083 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1084 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001085
David Blaikiebbafb8a2012-03-11 07:00:24 +00001086 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001087
Bill Wendlingf0724e82011-09-19 20:31:14 +00001088 /// Returns a pointer to the function's exception object and selector slot,
1089 /// which is assigned in every landing pad.
John McCallbd309292010-07-06 01:34:17 +00001090 llvm::Value *getExceptionSlot();
John McCall9b382dd2011-05-28 21:13:02 +00001091 llvm::Value *getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001092
Bill Wendling79a70e42011-09-15 18:57:19 +00001093 /// Returns the contents of the function's exception object and selector
1094 /// slots.
1095 llvm::Value *getExceptionFromSlot();
1096 llvm::Value *getSelectorFromSlot();
1097
John McCallad5d61e2010-07-23 21:56:41 +00001098 llvm::Value *getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001099
John McCallbd309292010-07-06 01:34:17 +00001100 llvm::BasicBlock *getUnreachableBlock() {
1101 if (!UnreachableBlock) {
1102 UnreachableBlock = createBasicBlock("unreachable");
1103 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1104 }
1105 return UnreachableBlock;
1106 }
1107
1108 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001109 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001110 return getInvokeDestImpl();
1111 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001112
John McCallc8e01702013-04-16 22:48:15 +00001113 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001114 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001115
Daniel Dunbar12347492009-02-23 17:26:39 +00001116 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001117 // Cleanups
1118 //===--------------------------------------------------------------------===//
1119
1120 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1121
John McCall178360e2011-07-11 08:38:19 +00001122 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1123 llvm::Value *arrayEndPointer,
1124 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001125 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001126 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1127 llvm::Value *arrayEnd,
1128 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001129 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001130
John McCall4bd0fb12011-07-12 16:41:08 +00001131 void pushDestroy(QualType::DestructionKind dtorKind,
1132 llvm::Value *addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001133 void pushEHDestroy(QualType::DestructionKind dtorKind,
1134 llvm::Value *addr, QualType type);
John McCall82fe67b2011-07-09 01:37:26 +00001135 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001136 Destroyer *destroyer, bool useEHCleanupForArray);
Richard Smith736a9472013-06-12 20:42:33 +00001137 void pushLifetimeExtendedDestroy(CleanupKind kind, llvm::Value *addr,
1138 QualType type, Destroyer *destroyer,
1139 bool useEHCleanupForArray);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001140 void pushStackRestore(CleanupKind kind, llvm::Value *SPMem);
Peter Collingbourne1425b452012-01-26 03:33:36 +00001141 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001142 bool useEHCleanupForArray);
David Blaikieebe87e12013-08-27 23:57:18 +00001143 llvm::Function *generateDestroyHelper(llvm::Constant *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001144 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001145 bool useEHCleanupForArray,
1146 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001147 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001148 QualType type, Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001149 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001150
Peter Collingbourne1425b452012-01-26 03:33:36 +00001151 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001152
John McCall82fe67b2011-07-09 01:37:26 +00001153 /// Determines whether an EH cleanup is required to destroy a type
1154 /// with the given destruction kind.
1155 bool needsEHCleanup(QualType::DestructionKind kind) {
1156 switch (kind) {
1157 case QualType::DK_none:
1158 return false;
1159 case QualType::DK_cxx_destructor:
1160 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001161 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001162 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001163 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001164 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1165 }
1166 llvm_unreachable("bad destruction kind");
1167 }
1168
John McCall4bd0fb12011-07-12 16:41:08 +00001169 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1170 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1171 }
1172
John McCall82fe67b2011-07-09 01:37:26 +00001173 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001174 // Objective-C
1175 //===--------------------------------------------------------------------===//
1176
Chris Lattner4bd55962008-03-30 23:03:07 +00001177 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001178
Mike Stumpfc496822009-02-08 23:14:22 +00001179 void StartObjCMethod(const ObjCMethodDecl *MD,
Devang Patele7ce5402011-05-19 23:37:41 +00001180 const ObjCContainerDecl *CD,
1181 SourceLocation StartLoc);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001182
Mike Stumpfc496822009-02-08 23:14:22 +00001183 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001184 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1185 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001186 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001187 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001188 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001189 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001190
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001191 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1192 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001193
Mike Stumpfc496822009-02-08 23:14:22 +00001194 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1195 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001196 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1197 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001198 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001199 const ObjCPropertyImplDecl *propImpl,
1200 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian08b0f662010-04-13 00:38:05 +00001201 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001202 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001203
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001204 //===--------------------------------------------------------------------===//
1205 // Block Bits
1206 //===--------------------------------------------------------------------===//
1207
John McCall351762c2011-02-07 10:33:21 +00001208 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001209 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1210 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garstfc83aa02010-02-23 21:51:17 +00001211 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001212 const CGBlockInfo &Info,
Chris Lattner2192fe52011-07-18 04:24:23 +00001213 llvm::StructType *,
John McCallad7c5c12011-02-08 08:22:06 +00001214 llvm::Constant *BlockVarLayout);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001215
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001216 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001217 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001218 const DeclMapTy &ldm,
1219 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001220
John McCallad7c5c12011-02-08 08:22:06 +00001221 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1222 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001223 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1224 const ObjCPropertyImplDecl *PID);
1225 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1226 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001227 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001228
John McCallad7c5c12011-02-08 08:22:06 +00001229 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1230
John McCall73064872011-03-31 01:59:53 +00001231 class AutoVarEmission;
1232
1233 void emitByrefStructureInit(const AutoVarEmission &emission);
1234 void enterByrefCleanup(const AutoVarEmission &emission);
1235
John McCall351762c2011-02-07 10:33:21 +00001236 llvm::Value *LoadBlockStruct() {
1237 assert(BlockPointer && "no block pointer set!");
1238 return BlockPointer;
1239 }
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001240
John McCall87fe5d52010-05-20 01:18:31 +00001241 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCall113bee02012-03-10 09:33:50 +00001242 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall351762c2011-02-07 10:33:21 +00001243 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2192fe52011-07-18 04:24:23 +00001244 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001245
John McCalla738c252011-03-09 04:27:21 +00001246 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1247 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001248 /// \brief Emit code for the start of a function.
1249 /// \param Loc The location to be associated with the function.
1250 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001251 void StartFunction(GlobalDecl GD,
1252 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001253 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001254 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001255 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001256 SourceLocation Loc = SourceLocation(),
1257 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001258
John McCallb81884d2010-02-19 09:25:03 +00001259 void EmitConstructorBody(FunctionArgList &Args);
1260 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001261 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001262 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Bob Wilsonbf854f02014-02-17 19:21:09 +00001263 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, RegionCounter &Cnt);
John McCall89b12b32010-02-18 03:17:58 +00001264
Faisal Vali571df122013-09-29 08:45:24 +00001265 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001266 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001267 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001268 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001269 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1270 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001271 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001272
Mike Stumpfc496822009-02-08 23:14:22 +00001273 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1274 /// emission when possible.
David Blaikie357aafb2013-02-01 19:09:49 +00001275 void EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001276
Mike Stumpfc496822009-02-08 23:14:22 +00001277 /// FinishFunction - Complete IR generation of the current function. It is
1278 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001279 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001280
Hans Wennborg88497d62013-11-15 17:24:45 +00001281 void StartThunk(llvm::Function *Fn, GlobalDecl GD, const CGFunctionInfo &FnInfo);
1282
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001283 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001284
Reid Klecknerab2090d2014-07-26 01:34:32 +00001285 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1286 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1287 llvm::Value *Callee);
1288
Anders Carlssonbad991d2010-03-24 00:39:18 +00001289 /// GenerateThunk - Generate a thunk for the given method.
John McCalla738c252011-03-09 04:27:21 +00001290 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1291 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001292
Eli Friedman49a94b12011-05-06 17:27:27 +00001293 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1294 GlobalDecl GD, const ThunkInfo &Thunk);
1295
Douglas Gregor94f9a482010-05-05 05:51:00 +00001296 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1297 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001298
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001299 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
1300 ArrayRef<VarDecl *> ArrayIndexes);
1301
Anders Carlssone87fae92010-03-28 19:40:00 +00001302 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1303 /// subobject.
1304 ///
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001305 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001306 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001307 CharUnits OffsetFromNearestVBase,
Anders Carlssone87fae92010-03-28 19:40:00 +00001308 const CXXRecordDecl *VTableClass);
1309
1310 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001311 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001312 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001313 CharUnits OffsetFromNearestVBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001314 bool BaseIsNonVirtualPrimaryBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001315 const CXXRecordDecl *VTableClass,
1316 VisitedVirtualBasesSetTy& VBases);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001317
Anders Carlssond5895932010-03-28 21:07:49 +00001318 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001319
Dan Gohman8fc50c22010-10-26 18:44:08 +00001320 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1321 /// to by This.
Chris Lattner2192fe52011-07-18 04:24:23 +00001322 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssone87fae92010-03-28 19:40:00 +00001323
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001324
1325 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1326 /// expr can be devirtualized.
1327 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1328 const CXXMethodDecl *MD);
1329
John McCallf99a6312010-07-21 05:30:47 +00001330 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1331 /// given phase of destruction for a destructor. The end result
1332 /// should call destructors on members and base classes in reverse
1333 /// order of their construction.
1334 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001335
Chris Lattner3c77a352010-06-22 00:03:40 +00001336 /// ShouldInstrumentFunction - Return true if the current function should be
1337 /// instrumented with __cyg_profile_func_* calls
1338 bool ShouldInstrumentFunction();
1339
1340 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1341 /// instrumentation function with the current function and the call site, if
1342 /// function instrumentation is enabled.
1343 void EmitFunctionInstrumentation(const char *Fn);
1344
Roman Divacky178e01602011-02-10 16:52:03 +00001345 /// EmitMCountInstrumentation - Emit call to .mcount.
1346 void EmitMCountInstrumentation();
1347
Mike Stumpfc496822009-02-08 23:14:22 +00001348 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1349 /// arguments for the given function. This is also responsible for naming the
1350 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001351 void EmitFunctionProlog(const CGFunctionInfo &FI,
1352 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001353 const FunctionArgList &Args);
1354
Mike Stumpfc496822009-02-08 23:14:22 +00001355 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1356 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001357 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1358 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001359
Mike Stump1d849212009-12-07 23:38:24 +00001360 /// EmitStartEHSpec - Emit the start of the exception spec.
1361 void EmitStartEHSpec(const Decl *D);
1362
1363 /// EmitEndEHSpec - Emit the end of the exception spec.
1364 void EmitEndEHSpec(const Decl *D);
1365
John McCallbd309292010-07-06 01:34:17 +00001366 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1367 llvm::BasicBlock *getTerminateLandingPad();
1368
1369 /// getTerminateHandler - Return a handler (not a landing pad, just
1370 /// a catch handler) that just calls terminate. This is used when
1371 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001372 llvm::BasicBlock *getTerminateHandler();
1373
Chris Lattnera5f58b02011-07-09 17:41:47 +00001374 llvm::Type *ConvertTypeForMem(QualType T);
1375 llvm::Type *ConvertType(QualType T);
1376 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001377 return ConvertType(getContext().getTypeDeclType(T));
1378 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001379
Mike Stumpfc496822009-02-08 23:14:22 +00001380 /// LoadObjCSelf - Load the value of self. This function is only valid while
1381 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001382 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001383
1384 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001385 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001386
Chris Lattner54fb19e2007-06-22 22:02:34 +00001387 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1388 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001389 static TypeEvaluationKind getEvaluationKind(QualType T);
1390
1391 static bool hasScalarEvaluationKind(QualType T) {
1392 return getEvaluationKind(T) == TEK_Scalar;
1393 }
1394
1395 static bool hasAggregateEvaluationKind(QualType T) {
1396 return getEvaluationKind(T) == TEK_Aggregate;
1397 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001398
1399 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001400 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001401 llvm::Function *parent = nullptr,
1402 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001403#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001404 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001405#else
John McCallad7c5c12011-02-08 08:22:06 +00001406 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001407#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001408 }
Mike Stumpfc496822009-02-08 23:14:22 +00001409
Chris Lattnerac248202007-05-30 00:13:02 +00001410 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1411 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001412 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001413
Mike Stumpe5311b02009-11-30 20:08:49 +00001414 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1415 /// another basic block, simplify it. This assumes that no other code could
1416 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001417 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1418
Mike Stumpfc496822009-02-08 23:14:22 +00001419 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1420 /// adding a fall-through branch from the current insert block if
1421 /// necessary. It is legal to call this function even if there is no current
1422 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001423 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001424 /// IsFinished - If true, indicates that the caller has finished emitting
1425 /// branches to the given block and does not expect to emit code into it. This
1426 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001427 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001428
John McCall8e4c74b2011-08-11 02:22:43 +00001429 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1430 /// near its uses, and leave the insertion point in it.
1431 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1432
Mike Stumpfc496822009-02-08 23:14:22 +00001433 /// EmitBranch - Emit a branch to the specified basic block from the current
1434 /// insert block, taking care to avoid creation of branches from dummy
1435 /// blocks. It is legal to call this function even if there is no current
1436 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001437 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001438 /// This function clears the current insertion point. The caller should follow
1439 /// calls to this function with calls to Emit*Block prior to generation new
1440 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001441 void EmitBranch(llvm::BasicBlock *Block);
1442
Mike Stumpfc496822009-02-08 23:14:22 +00001443 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1444 /// indicates that the current code being emitted is unreachable.
1445 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001446 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001447 }
1448
Mike Stumpfc496822009-02-08 23:14:22 +00001449 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1450 /// emitted IR has a place to go. Note that by definition, if this function
1451 /// creates a block then that block is unreachable; callers may do better to
1452 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001453 void EnsureInsertPoint() {
1454 if (!HaveInsertPoint())
1455 EmitBlock(createBasicBlock());
1456 }
Mike Stumpfc496822009-02-08 23:14:22 +00001457
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001458 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001459 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001460 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001461
Chris Lattnere9a64532007-06-22 21:44:33 +00001462 //===--------------------------------------------------------------------===//
1463 // Helpers
1464 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001465
Eli Friedmana0544d62011-12-03 04:14:32 +00001466 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1467 CharUnits Alignment = CharUnits()) {
Dan Gohman947c9af2010-10-14 23:06:10 +00001468 return LValue::MakeAddr(V, T, Alignment, getContext(),
1469 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001470 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001471
David Majnemer99281062014-09-18 22:05:54 +00001472 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001473
Chris Lattnere9a64532007-06-22 21:44:33 +00001474 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001475 /// block. The caller is responsible for setting an appropriate alignment on
1476 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001477 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001478 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001479
John McCall2e6567a2010-04-22 01:10:34 +00001480 /// InitTempAlloca - Provide an initial value for the given alloca.
1481 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1482
Daniel Dunbard0049182010-02-16 19:44:13 +00001483 /// CreateIRTemp - Create a temporary IR object of the given type, with
1484 /// appropriate alignment. This routine should only be used when an temporary
1485 /// value needs to be stored into an alloca (for example, to avoid explicit
1486 /// PHI construction), but the type is the IR type, not the type appropriate
1487 /// for storing in memory.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001488 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001489
Daniel Dunbara7566f12010-02-09 02:48:28 +00001490 /// CreateMemTemp - Create a temporary memory object of the given type, with
1491 /// appropriate alignment.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001492 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001493
John McCall7a626f62010-09-15 10:14:12 +00001494 /// CreateAggTemp - Create a temporary memory object for the given
1495 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001496 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedman38cd36d2011-12-03 02:13:40 +00001497 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001498 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1499 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001500 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001501 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001502 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001503 }
1504
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001505 /// CreateInAllocaTmp - Create a temporary memory object for the given
1506 /// aggregate type.
1507 AggValueSlot CreateInAllocaTmp(QualType T, const Twine &Name = "inalloca");
1508
John McCallad7c5c12011-02-08 08:22:06 +00001509 /// Emit a cast to void* in the appropriate address space.
1510 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1511
Chris Lattner8394d792007-06-05 20:53:16 +00001512 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1513 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001514 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001515
John McCalla2342eb2010-12-05 02:00:02 +00001516 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1517 void EmitIgnoredExpr(const Expr *E);
1518
Chris Lattner4647a212007-08-31 22:49:20 +00001519 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1520 /// any type. The result is returned as an RValue struct. If this is an
1521 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1522 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001523 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001524 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001525 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001526 AggValueSlot aggSlot = AggValueSlot::ignored(),
1527 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001528
Mike Stumpfc496822009-02-08 23:14:22 +00001529 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1530 // or the value of the expression, depending on how va_list is defined.
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001531 llvm::Value *EmitVAListRef(const Expr *E);
1532
Mike Stumpfc496822009-02-08 23:14:22 +00001533 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1534 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001535 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001536
John McCall91ca10f2011-03-08 09:11:50 +00001537 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001538 /// arbitrary expression into the given memory location.
John McCall21886962010-04-21 10:05:39 +00001539 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001540 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001541
John McCall91ca10f2011-03-08 09:11:50 +00001542 /// EmitExprAsInit - Emits the code necessary to initialize a
1543 /// location in memory with the given initializer.
John McCall31168b02011-06-15 23:02:42 +00001544 void EmitExprAsInit(const Expr *init, const ValueDecl *D,
John McCall1553b192011-06-16 04:16:24 +00001545 LValue lvalue, bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001546
Fariborz Jahanian78652202013-01-25 23:57:05 +00001547 /// hasVolatileMember - returns true if aggregate type has a volatile
1548 /// member.
1549 bool hasVolatileMember(QualType T) {
1550 if (const RecordType *RT = T->getAs<RecordType>()) {
1551 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1552 return RD->hasVolatileMember();
1553 }
1554 return false;
1555 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001556 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001557 ///
1558 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1559 /// This is required for correctness when assigning non-POD structures in C++.
1560 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001561 QualType EltTy) {
1562 bool IsVolatile = hasVolatileMember(EltTy);
1563 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1564 true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001565 }
1566
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001567 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001568 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001569 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001570 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001571 /// \param isAssignment - If false, allow padding to be copied. This often
1572 /// yields more efficient.
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001573 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001574 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001575 CharUnits Alignment = CharUnits::Zero(),
1576 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001577
Devang Patelda5d6bb2007-10-04 23:45:31 +00001578 /// StartBlock - Start new block named N. If insert block is a dummy block
1579 /// then reuse it.
1580 void StartBlock(const char *N);
1581
Anders Carlsson9396a892008-09-11 09:15:33 +00001582 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall5d865c322010-08-31 07:33:07 +00001583 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1584 llvm::Value *Res = LocalDeclMap[VD];
1585 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1586 return Res;
1587 }
Mike Stumpfc496822009-02-08 23:14:22 +00001588
John McCallc07a0c72011-02-17 10:25:35 +00001589 /// getOpaqueLValueMapping - Given an opaque value expression (which
1590 /// must be mapped to an l-value), return its mapping.
1591 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1592 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1593
1594 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1595 it = OpaqueLValues.find(e);
1596 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1597 return it->second;
1598 }
1599
1600 /// getOpaqueRValueMapping - Given an opaque value expression (which
1601 /// must be mapped to an r-value), return its mapping.
1602 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1603 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1604
1605 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1606 it = OpaqueRValues.find(e);
1607 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001608 return it->second;
1609 }
1610
Dan Gohman75d69da2008-05-22 00:50:06 +00001611 /// getAccessedFieldNo - Given an encoded value and a result number, return
1612 /// the input field number being accessed.
1613 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1614
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001615 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001616 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001617
Anders Carlssonc0964b62010-05-22 17:35:42 +00001618 /// EmitNullInitialization - Generate code to set a value of the given type to
1619 /// null, If the type contains data member pointers, they will be initialized
1620 /// to -1 in accordance with the Itanium C++ ABI.
1621 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001622
1623 // EmitVAArg - Generate code to get an argument from the passed in pointer
1624 // and update it accordingly. The return value is a pointer to the argument.
1625 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001626 // instruction in LLVM instead once it works well enough.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001627 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001628
John McCall82fe67b2011-07-09 01:37:26 +00001629 /// emitArrayLength - Compute the length of an array, even if it's a
1630 /// VLA, and drill down to the base element type.
1631 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1632 QualType &baseType,
1633 llvm::Value *&addr);
1634
John McCall23c29fe2011-06-24 21:55:10 +00001635 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1636 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001637 ///
1638 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001639 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001640
John McCall23c29fe2011-06-24 21:55:10 +00001641 /// getVLASize - Returns an LLVM value that corresponds to the size,
1642 /// in non-variably-sized elements, of a variable length array type,
1643 /// plus that largest non-variably-sized element type. Assumes that
1644 /// the type has already been emitted with EmitVariablyModifiedType.
1645 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1646 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001647
Anders Carlssona5d077d2009-04-14 16:58:56 +00001648 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1649 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001650 llvm::Value *LoadCXXThis() {
1651 assert(CXXThisValue && "no 'this' value for this function");
1652 return CXXThisValue;
1653 }
Mike Stump11289f42009-09-09 15:08:12 +00001654
Anders Carlssone36a6b32010-01-02 01:01:18 +00001655 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1656 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001657 // FIXME: Every place that calls LoadCXXVTT is something
1658 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001659 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001660 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1661 return CXXStructorImplicitParamValue;
1662 }
1663
1664 /// LoadCXXStructorImplicitParam - Load the implicit parameter
1665 /// for a constructor/destructor.
1666 llvm::Value *LoadCXXStructorImplicitParam() {
1667 assert(CXXStructorImplicitParamValue &&
1668 "no implicit argument value for this function");
1669 return CXXStructorImplicitParamValue;
John McCall347132b2010-02-16 22:04:33 +00001670 }
John McCall6ce74722010-02-16 04:15:37 +00001671
1672 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001673 /// complete class to the given direct base.
1674 llvm::Value *
1675 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1676 const CXXRecordDecl *Derived,
1677 const CXXRecordDecl *Base,
1678 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001679
Mike Stumpe5311b02009-11-30 20:08:49 +00001680 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1681 /// load of 'this' and returns address of the base class.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001682 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001683 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001684 CastExpr::path_const_iterator PathBegin,
1685 CastExpr::path_const_iterator PathEnd,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001686 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001687
Anders Carlsson8c793172009-11-23 17:57:54 +00001688 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001689 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001690 CastExpr::path_const_iterator PathBegin,
1691 CastExpr::path_const_iterator PathEnd,
Anders Carlsson8c793172009-11-23 17:57:54 +00001692 bool NullCheckValue);
1693
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001694 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1695 /// base constructor/destructor with virtual bases.
1696 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1697 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1698 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1699 bool Delegating);
1700
John McCallf8ff7b92010-02-23 00:48:20 +00001701 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1702 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001703 const FunctionArgList &Args,
1704 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001705 // It's important not to confuse this and the previous function. Delegating
1706 // constructors are the C++0x feature. The constructor delegate optimization
1707 // is used to reduce duplication in the base and complete consturctors where
1708 // they are substantially the same.
1709 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1710 const FunctionArgList &Args);
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001711 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001712 bool ForVirtualBase, bool Delegating,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001713 llvm::Value *This, const CXXConstructExpr *E);
1714
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001715 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1716 llvm::Value *This, llvm::Value *Src,
Alexey Samsonov525bf652014-08-25 21:58:56 +00001717 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001718
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001719 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001720 const ConstantArrayType *ArrayTy,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001721 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001722 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001723 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001724
Anders Carlssond49844b2009-09-23 02:45:36 +00001725 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1726 llvm::Value *NumElements,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001727 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001728 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001729 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001730
John McCall82fe67b2011-07-09 01:37:26 +00001731 static Destroyer destroyCXXObject;
1732
Anders Carlsson0a637412009-05-29 21:03:38 +00001733 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001734 bool ForVirtualBase, bool Delegating,
1735 llvm::Value *This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001736
John McCall99210dc2011-09-15 06:49:18 +00001737 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
Richard Smith06a67e22014-06-03 06:58:52 +00001738 llvm::Value *NewPtr, llvm::Value *NumElements,
1739 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00001740
Peter Collingbourne702b2842011-11-27 22:09:22 +00001741 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1742 llvm::Value *Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001743
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001744 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001745 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001746
Eli Friedman24f55432009-11-18 00:57:03 +00001747 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1748 QualType DeleteTy);
1749
Richard Smith760520b2014-06-03 23:27:44 +00001750 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1751 const Expr *Arg, bool IsDelete);
1752
Mike Stumpc9b231c2009-11-15 08:09:41 +00001753 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stump65511702009-11-16 06:50:58 +00001754 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Nico Webercf4ff5862012-10-11 10:13:44 +00001755 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001756
Richard Smith69d0d262012-08-24 00:54:33 +00001757 /// \brief Situations in which we might emit a check for the suitability of a
1758 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001759 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001760 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001761 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001762 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001763 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001764 /// Checking the bound value in a reference binding. Must be suitably sized
1765 /// and aligned, but is not required to refer to an object (until the
1766 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001767 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001768 /// Checking the object expression in a non-static data member access. Must
1769 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001770 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001771 /// Checking the 'this' pointer for a call to a non-static member function.
1772 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001773 TCK_MemberCall,
1774 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001775 TCK_ConstructorCall,
1776 /// Checking the operand of a static_cast to a derived pointer type. Must be
1777 /// null or an object within its lifetime.
1778 TCK_DowncastPointer,
1779 /// Checking the operand of a static_cast to a derived reference type. Must
1780 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001781 TCK_DowncastReference,
1782 /// Checking the operand of a cast to a base object. Must be suitably sized
1783 /// and aligned.
1784 TCK_Upcast,
1785 /// Checking the operand of a cast to a virtual base object. Must be an
1786 /// object within its lifetime.
1787 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00001788 };
1789
Alexey Samsonovac4afe42014-07-07 23:59:57 +00001790 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
1791 /// calls to EmitTypeCheck can be skipped.
1792 bool sanitizePerformTypeCheck() const;
1793
Richard Smith4d1458e2012-09-08 02:08:36 +00001794 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001795 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001796 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001797 QualType Type, CharUnits Alignment = CharUnits::Zero(),
1798 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001799
Richard Smith539e4a72013-02-23 02:53:19 +00001800 /// \brief Emit a check that \p Base points into an array object, which
1801 /// we can access at index \p Index. \p Accessed should be \c false if we
1802 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1803 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1804 QualType IndexType, bool Accessed);
1805
Chris Lattner116ce8f2010-01-09 21:40:03 +00001806 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1807 bool isInc, bool isPre);
1808 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1809 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00001810
1811 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00001812 llvm::Value *OffsetValue = nullptr) {
1813 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
1814 OffsetValue);
1815 }
Hal Finkelbcc06082014-09-07 22:58:14 +00001816
Chris Lattner8394d792007-06-05 20:53:16 +00001817 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001818 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001819 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001820
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001821 /// EmitDecl - Emit a declaration.
1822 ///
1823 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001824 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001825
John McCall1c9c3fd2010-10-15 04:57:14 +00001826 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001827 ///
1828 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001829 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001830
John McCall31168b02011-06-15 23:02:42 +00001831 void EmitScalarInit(const Expr *init, const ValueDecl *D,
John McCall1553b192011-06-16 04:16:24 +00001832 LValue lvalue, bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00001833 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001834
John McCallbd309292010-07-06 01:34:17 +00001835 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1836 llvm::Value *Address);
1837
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001838 /// \brief Determine whether the given initializer is trivial in the sense
1839 /// that it requires no code to be generated.
1840 bool isTrivialInitializer(const Expr *Init);
1841
John McCall1c9c3fd2010-10-15 04:57:14 +00001842 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001843 ///
1844 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00001845 void EmitAutoVarDecl(const VarDecl &D);
1846
1847 class AutoVarEmission {
1848 friend class CodeGenFunction;
1849
John McCall9e2e22f2011-02-22 07:16:58 +00001850 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00001851
1852 /// The alignment of the variable.
1853 CharUnits Alignment;
1854
1855 /// The address of the alloca. Null if the variable was emitted
1856 /// as a global constant.
1857 llvm::Value *Address;
1858
1859 llvm::Value *NRVOFlag;
1860
1861 /// True if the variable is a __block variable.
1862 bool IsByRef;
1863
1864 /// True if the variable is of aggregate type and has a constant
1865 /// initializer.
1866 bool IsConstantAggregate;
1867
Nadav Rotem1da30942013-03-23 06:43:35 +00001868 /// Non-null if we should use lifetime annotations.
1869 llvm::Value *SizeForLifetimeMarkers;
1870
John McCall9e2e22f2011-02-22 07:16:58 +00001871 struct Invalid {};
Craig Topper8a13c412014-05-21 05:09:00 +00001872 AutoVarEmission(Invalid) : Variable(nullptr) {}
John McCall9e2e22f2011-02-22 07:16:58 +00001873
John McCallc533cb72011-02-22 06:44:22 +00001874 AutoVarEmission(const VarDecl &variable)
Craig Topper8a13c412014-05-21 05:09:00 +00001875 : Variable(&variable), Address(nullptr), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00001876 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00001877 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00001878
Craig Topper8a13c412014-05-21 05:09:00 +00001879 bool wasEmittedAsGlobal() const { return Address == nullptr; }
John McCallc533cb72011-02-22 06:44:22 +00001880
1881 public:
John McCall9e2e22f2011-02-22 07:16:58 +00001882 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1883
Craig Topper8a13c412014-05-21 05:09:00 +00001884 bool useLifetimeMarkers() const {
1885 return SizeForLifetimeMarkers != nullptr;
1886 }
Nadav Rotem1da30942013-03-23 06:43:35 +00001887 llvm::Value *getSizeForLifetimeMarkers() const {
1888 assert(useLifetimeMarkers());
1889 return SizeForLifetimeMarkers;
1890 }
1891
1892 /// Returns the raw, allocated address, which is not necessarily
1893 /// the address of the object itself.
1894 llvm::Value *getAllocatedAddress() const {
1895 return Address;
1896 }
1897
John McCallc533cb72011-02-22 06:44:22 +00001898 /// Returns the address of the object within this declaration.
1899 /// Note that this does not chase the forwarding pointer for
1900 /// __block decls.
1901 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1902 if (!IsByRef) return Address;
1903
1904 return CGF.Builder.CreateStructGEP(Address,
John McCall9e2e22f2011-02-22 07:16:58 +00001905 CGF.getByRefValueLLVMField(Variable),
1906 Variable->getNameAsString());
John McCallc533cb72011-02-22 06:44:22 +00001907 }
1908 };
1909 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1910 void EmitAutoVarInit(const AutoVarEmission &emission);
1911 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00001912 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1913 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001914
John McCall1c9c3fd2010-10-15 04:57:14 +00001915 void EmitStaticVarDecl(const VarDecl &D,
1916 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001917
1918 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001919 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, bool ArgIsPointer,
1920 unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00001921
John McCallc07a0c72011-02-17 10:25:35 +00001922 /// protectFromPeepholes - Protect a value that we're intending to
1923 /// store to the side, but which will probably be used later, from
1924 /// aggressive peepholing optimizations that might delete it.
1925 ///
1926 /// Pass the result to unprotectFromPeepholes to declare that
1927 /// protection is no longer required.
1928 ///
1929 /// There's no particular reason why this shouldn't apply to
1930 /// l-values, it's just that no existing peepholes work on pointers.
1931 PeepholeProtection protectFromPeepholes(RValue rvalue);
1932 void unprotectFromPeepholes(PeepholeProtection protection);
1933
Chris Lattner84915fa2007-06-02 04:16:21 +00001934 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00001935 // Statement Emission
1936 //===--------------------------------------------------------------------===//
1937
Mike Stumpfc496822009-02-08 23:14:22 +00001938 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001939 void EmitStopPoint(const Stmt *S);
1940
Mike Stumpfc496822009-02-08 23:14:22 +00001941 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1942 /// this function even if there is no current insertion point.
1943 ///
1944 /// This function may clear the current insertion point; callers should use
1945 /// EnsureInsertPoint if they wish to subsequently generate code without first
1946 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00001947 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001948
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001949 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00001950 /// necessarily require an insertion point or debug information; typically
1951 /// because the statement amounts to a jump or a container of other
1952 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001953 ///
1954 /// \return True if the statement was handled.
1955 bool EmitSimpleStmt(const Stmt *S);
1956
Eli Friedman4871a462013-06-10 22:04:49 +00001957 llvm::Value *EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
1958 AggValueSlot AVS = AggValueSlot::ignored());
1959 llvm::Value *EmitCompoundStmtWithoutScope(const CompoundStmt &S,
1960 bool GetLast = false,
1961 AggValueSlot AVS =
1962 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001963
Mike Stumpfc496822009-02-08 23:14:22 +00001964 /// EmitLabel - Emit the block for the given label. It is legal to call this
1965 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001966 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001967
Chris Lattnerac248202007-05-30 00:13:02 +00001968 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00001969 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00001970 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001971 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00001972 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001973
1974 void EmitCondBrHints(llvm::LLVMContext &Context, llvm::BranchInst *CondBr,
Craig Topper3cb91b22014-08-27 06:28:16 +00001975 ArrayRef<const Attr *> Attrs);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001976 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00001977 ArrayRef<const Attr *> Attrs = None);
1978 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001979 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00001980 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00001981 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00001982 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001983 void EmitBreakStmt(const BreakStmt &S);
1984 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00001985 void EmitSwitchStmt(const SwitchStmt &S);
1986 void EmitDefaultStmt(const DefaultStmt &S);
1987 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00001988 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00001989 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00001990
Anders Carlsson2e744e82008-08-30 19:51:14 +00001991 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001992 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
1993 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00001994 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00001995 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00001996
John McCallb609d3f2010-07-07 06:56:46 +00001997 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
1998 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00001999
Anders Carlsson52d78a52009-09-27 18:58:34 +00002000 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002001 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002002 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002003 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002004 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002005
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002006 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002007 void GenerateCapturedStmtFunctionProlog(const CapturedStmt &S);
2008 llvm::Function *GenerateCapturedStmtFunctionEpilog(const CapturedStmt &S);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002009 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev9959db52014-05-06 10:08:46 +00002010 llvm::Value *GenerateCapturedStmtArgument(const CapturedStmt &S);
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002011 void EmitOMPAggregateAssign(LValue OriginalAddr, llvm::Value *PrivateAddr,
2012 const Expr *AssignExpr, QualType Type,
2013 const VarDecl *VDInit);
2014 void EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002015 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002016 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2017 OMPPrivateScope &PrivateScope);
Alexey Bataev9959db52014-05-06 10:08:46 +00002018
2019 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002020 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002021 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002022 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002023 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002024 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002025 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002026 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002027 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002028 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002029 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002030 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002031 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002032 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002033 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002034 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002035 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002036 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002037 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002038 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002039 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002040
Alexander Musmana5f070a2014-10-01 06:03:56 +00002041 /// Helpers for 'omp simd' directive.
Alexander Musmand196ef22014-10-07 08:57:09 +00002042 void EmitOMPLoopBody(const OMPLoopDirective &Directive,
2043 bool SeparateIter = false);
2044 void EmitOMPInnerLoop(const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
2045 bool SeparateIter = false);
Alexander Musmana5f070a2014-10-01 06:03:56 +00002046 void EmitOMPSimdFinal(const OMPLoopDirective &S);
2047
Chris Lattner208ae962007-05-30 17:57:17 +00002048 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002049 // LValue Expression Emission
2050 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002051
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002052 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2053 RValue GetUndefRValue(QualType Ty);
2054
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002055 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2056 /// and issue an ErrorUnsupported style diagnostic (using the
2057 /// provided Name).
2058 RValue EmitUnsupportedRValue(const Expr *E,
2059 const char *Name);
2060
Mike Stumpfc496822009-02-08 23:14:22 +00002061 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2062 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002063 LValue EmitUnsupportedLValue(const Expr *E,
2064 const char *Name);
2065
Chris Lattner8394d792007-06-05 20:53:16 +00002066 /// EmitLValue - Emit code to compute a designator that specifies the location
2067 /// of the expression.
2068 ///
2069 /// This can return one of two things: a simple address or a bitfield
2070 /// reference. In either case, the LLVM Value* in the LValue structure is
2071 /// guaranteed to be an LLVM pointer type.
2072 ///
2073 /// If this returns a bitfield reference, nothing about the pointee type of
2074 /// the LLVM value is known: For example, it may not be a pointer to an
2075 /// integer.
2076 ///
2077 /// If this returns a normal address, and if the lvalue's C type is fixed
2078 /// size, this method guarantees that the returned pointer type will point to
2079 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2080 /// variable length type, this is not possible.
2081 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002082 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002083
Richard Smith4d1458e2012-09-08 02:08:36 +00002084 /// \brief Same as EmitLValue but additionally we generate checking code to
2085 /// guard against undefined behavior. This is only suitable when we know
2086 /// that the address will be used to access the object.
2087 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002088
Nick Lewycky2d84e842013-10-02 02:29:49 +00002089 RValue convertTempToRValue(llvm::Value *addr, QualType type,
2090 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002091
John McCalla8ec7eb2013-03-07 21:37:17 +00002092 void EmitAtomicInit(Expr *E, LValue lvalue);
2093
Nick Lewycky2d84e842013-10-02 02:29:49 +00002094 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
John McCalla8ec7eb2013-03-07 21:37:17 +00002095 AggValueSlot slot = AggValueSlot::ignored());
2096
2097 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2098
John McCall3a7f6922010-10-27 20:58:56 +00002099 /// EmitToMemory - Change a scalar value from its value
2100 /// representation to its in-memory representation.
2101 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2102
2103 /// EmitFromMemory - Change a scalar value from its memory
2104 /// representation to its value representation.
2105 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2106
Daniel Dunbar1d425462009-02-10 00:57:50 +00002107 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2108 /// care to appropriately convert from the memory representation to
2109 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002110 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman947c9af2010-10-14 23:06:10 +00002111 unsigned Alignment, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002112 SourceLocation Loc,
Craig Topper8a13c412014-05-21 05:09:00 +00002113 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002114 QualType TBAABaseTy = QualType(),
2115 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002116
2117 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2118 /// care to appropriately convert from the memory representation to
2119 /// the LLVM value representation. The l-value must be a simple
2120 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002121 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002122
2123 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2124 /// care to appropriately convert from the memory representation to
2125 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002126 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman947c9af2010-10-14 23:06:10 +00002127 bool Volatile, unsigned Alignment, QualType Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00002128 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002129 QualType TBAABaseTy = QualType(),
2130 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002131
2132 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2133 /// care to appropriately convert from the memory representation to
2134 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002135 /// l-value. The isInit flag indicates whether this is an initialization.
2136 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2137 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002138
Chris Lattner8394d792007-06-05 20:53:16 +00002139 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2140 /// this method emits the address of the lvalue, then loads the result as an
2141 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002142 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002143 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2144 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002145 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002146
Chris Lattner8394d792007-06-05 20:53:16 +00002147 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2148 /// lvalue, where both are guaranteed to the have the same type, and that type
2149 /// is 'Ty'.
David Chisnallfa35df62012-01-16 17:27:18 +00002150 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false);
John McCall55e1fbc2011-06-25 02:11:03 +00002151 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002152 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002153
Nick Lewycky2d84e842013-10-02 02:29:49 +00002154 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2155 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002156 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002157 /// \param Result [out] - If non-null, this will be set to a Value* for the
2158 /// bit-field contents after the store, appropriate for use as the result of
2159 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002160 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002161 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002162
John McCall4f29b492010-11-16 23:07:28 +00002163 /// Emit an l-value for an assignment (simple or compound) of complex type.
2164 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002165 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Eli Friedmanf0450072013-06-12 01:40:06 +00002166 LValue EmitScalarCompooundAssignWithComplex(const CompoundAssignOperator *E,
2167 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002168
Chris Lattner57540c52011-04-15 05:22:18 +00002169 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002170 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002171 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002172 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002173 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002174 // Note: only available for agg return types
2175 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002176 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Renato Golin230c5eb2014-05-19 18:15:42 +00002177 LValue EmitReadRegister(const VarDecl *VD);
Chris Lattner4347e3692007-06-06 04:54:52 +00002178 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002179 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002180 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002181 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002182 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2183 bool Accessed = false);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002184 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002185 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002186 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002187 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002188 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002189 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002190 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002191 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002192 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002193
2194 llvm::Value *EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002195
Nick Lewycky2d84e842013-10-02 02:29:49 +00002196 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002197
John McCall71335052012-03-10 03:05:10 +00002198 class ConstantEmission {
2199 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2200 ConstantEmission(llvm::Constant *C, bool isReference)
2201 : ValueAndIsReference(C, isReference) {}
2202 public:
2203 ConstantEmission() {}
2204 static ConstantEmission forReference(llvm::Constant *C) {
2205 return ConstantEmission(C, true);
2206 }
2207 static ConstantEmission forValue(llvm::Constant *C) {
2208 return ConstantEmission(C, false);
2209 }
2210
Craig Topper8a13c412014-05-21 05:09:00 +00002211 LLVM_EXPLICIT operator bool() const {
2212 return ValueAndIsReference.getOpaqueValue() != nullptr;
2213 }
John McCall71335052012-03-10 03:05:10 +00002214
2215 bool isReference() const { return ValueAndIsReference.getInt(); }
2216 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2217 assert(isReference());
2218 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2219 refExpr->getType());
2220 }
2221
2222 llvm::Constant *getValue() const {
2223 assert(!isReference());
2224 return ValueAndIsReference.getPointer();
2225 }
2226 };
2227
John McCall113bee02012-03-10 09:33:50 +00002228 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002229
John McCallfe96e0b2011-11-06 09:01:30 +00002230 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2231 AggValueSlot slot = AggValueSlot::ignored());
2232 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2233
Daniel Dunbar722f4242009-04-22 05:08:15 +00002234 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002235 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002236 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002237 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002238
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002239 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2240 /// if the Field is a reference, this will return the address of the reference
2241 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002242 LValue EmitLValueForFieldInitialization(LValue Base,
2243 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002244
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002245 LValue EmitLValueForIvar(QualType ObjectTy,
2246 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002247 unsigned CVRQualifiers);
2248
Anders Carlsson3be22e22009-05-30 23:23:33 +00002249 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002250 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002251 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002252 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002253 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002254
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002255 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002256 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002257 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002258 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002259 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002260 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002261
Chris Lattnerd7f58862007-06-02 05:24:33 +00002262 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002263 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002264 //===--------------------------------------------------------------------===//
2265
Mike Stumpfc496822009-02-08 23:14:22 +00002266 /// EmitCall - Generate a call of the given function, expecting the given
2267 /// result type, and using the given argument list which specifies both the
2268 /// LLVM arguments and the types they were derived from.
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002269 ///
Mike Stumpe5311b02009-11-30 20:08:49 +00002270 /// \param TargetDecl - If given, the decl of the function in a direct call;
2271 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbard931a872009-02-02 22:03:45 +00002272 RValue EmitCall(const CGFunctionInfo &FnInfo,
2273 llvm::Value *Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00002274 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002275 const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00002276 const Decl *TargetDecl = nullptr,
2277 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002278
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002279 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002280 ReturnValueSlot ReturnValue,
Craig Topper8a13c412014-05-21 05:09:00 +00002281 const Decl *TargetDecl = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002282 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002283 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002284
John McCall882987f2013-02-28 19:01:20 +00002285 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2286 const Twine &name = "");
2287 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2288 ArrayRef<llvm::Value*> args,
2289 const Twine &name = "");
2290 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2291 const Twine &name = "");
2292 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2293 ArrayRef<llvm::Value*> args,
2294 const Twine &name = "");
2295
John McCallbd309292010-07-06 01:34:17 +00002296 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002297 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002298 const Twine &Name = "");
Jay Foad5bd375a2011-07-15 08:37:34 +00002299 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002300 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002301 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2302 ArrayRef<llvm::Value*> args,
2303 const Twine &name = "");
2304 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2305 const Twine &name = "");
2306 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2307 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002308
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002309 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2310 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002311 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002312
2313 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2314 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002315 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002316
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002317 RValue
2318 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2319 ReturnValueSlot ReturnValue, llvm::Value *This,
2320 llvm::Value *ImplicitParam,
2321 QualType ImplicitParamTy, const CallExpr *E);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002322 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2323 ReturnValueSlot ReturnValue);
2324 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2325 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002326
Anders Carlssonc36783e2011-05-08 20:32:23 +00002327 llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2328 const CXXMethodDecl *MD,
2329 llvm::Value *This);
Anders Carlsson4034a952009-05-27 04:18:27 +00002330 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002331 const CXXMethodDecl *MD,
2332 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002333
Peter Collingbournefe883422011-10-06 18:29:37 +00002334 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2335 ReturnValueSlot ReturnValue);
2336
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002337
Mike Stump11289f42009-09-09 15:08:12 +00002338 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Daniel Dunbar8eb018a2009-02-16 22:43:43 +00002339 unsigned BuiltinID, const CallExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002340
Anders Carlssonbfb36712009-12-24 21:13:40 +00002341 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002342
Mike Stumpfc496822009-02-08 23:14:22 +00002343 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2344 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002345 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2346
Kevin Qin1718af62013-11-14 02:45:18 +00002347 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2348 const llvm::CmpInst::Predicate Fp,
2349 const llvm::CmpInst::Predicate Ip,
2350 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002351 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002352
2353 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2354 unsigned LLVMIntrinsic,
2355 unsigned AltLLVMIntrinsic,
2356 const char *NameHint,
2357 unsigned Modifier,
2358 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002359 SmallVectorImpl<llvm::Value *> &Ops,
Craig Topper8a13c412014-05-21 05:09:00 +00002360 llvm::Value *Align = nullptr);
Tim Northover8fe03d62014-02-21 11:57:24 +00002361 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2362 unsigned Modifier, llvm::Type *ArgTy,
2363 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002364 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002365 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002366 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002367 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002368 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002369 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002370 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002371 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2372 llvm::Type *Ty, bool usgn, const char *name);
Tim Northover573cbee2014-05-24 12:52:07 +00002373 // Helper functions for EmitAArch64BuiltinExpr.
Tim Northovera2ee4332014-03-29 15:09:45 +00002374 llvm::Value *vectorWrapScalar8(llvm::Value *Op);
2375 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
2376 llvm::Value *emitVectorWrappedScalar8Intrinsic(
2377 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
2378 llvm::Value *emitVectorWrappedScalar16Intrinsic(
2379 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
Tim Northover573cbee2014-05-24 12:52:07 +00002380 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northovera2ee4332014-03-29 15:09:45 +00002381 llvm::Value *EmitNeon64Call(llvm::Function *F,
2382 llvm::SmallVectorImpl<llvm::Value *> &O,
2383 const char *name);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002384
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002385 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002386 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2387 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault56f008d2014-06-24 20:45:01 +00002388 llvm::Value *EmitR600BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002389
Daniel Dunbar66912a12008-08-20 00:28:19 +00002390 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002391 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002392 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002393 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2394 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2395 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian413297c2014-08-06 18:13:46 +00002396 const ObjCMethodDecl *MethodWithObjects,
2397 const ObjCMethodDecl *AllocMethod);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002398 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002399 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2400 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002401
John McCall31168b02011-06-15 23:02:42 +00002402 /// Retrieves the default cleanup kind for an ARC cleanup.
2403 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2404 CleanupKind getARCCleanupKind() {
2405 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2406 ? NormalAndEHCleanup : NormalCleanup;
2407 }
2408
2409 // ARC primitives.
2410 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2411 void EmitARCDestroyWeak(llvm::Value *addr);
2412 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2413 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2414 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2415 bool ignored);
2416 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2417 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2418 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2419 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002420 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002421 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002422 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002423 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002424 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2425 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002426 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCallcdda29c2013-03-13 03:10:54 +00002427 void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise);
2428 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCall31168b02011-06-15 23:02:42 +00002429 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2430 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2431 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2432 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2433
2434 std::pair<LValue,llvm::Value*>
2435 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2436 std::pair<LValue,llvm::Value*>
2437 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2438
John McCall248512a2011-10-01 10:32:24 +00002439 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2440
John McCall31168b02011-06-15 23:02:42 +00002441 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2442 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2443 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2444
John McCallff613032011-10-04 06:23:45 +00002445 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002446 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2447 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2448
Craig Topper00bbdcf2014-06-28 23:22:23 +00002449 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002450
John McCall82fe67b2011-07-09 01:37:26 +00002451 static Destroyer destroyARCStrongImprecise;
2452 static Destroyer destroyARCStrongPrecise;
2453 static Destroyer destroyARCWeak;
2454
John McCall31168b02011-06-15 23:02:42 +00002455 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2456 llvm::Value *EmitObjCAutoreleasePoolPush();
2457 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2458 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2459 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2460
Richard Smitha1c9d4d2013-06-12 23:38:09 +00002461 /// \brief Emits a reference binding to the passed in expression.
2462 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002463
Chris Lattner6278e6a2007-08-11 00:04:45 +00002464 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002465 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002466 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002467
2468 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002469
2470 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2471 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002472 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002473
Chris Lattner3474c202007-08-26 06:48:56 +00002474 /// EmitScalarConversion - Emit a conversion from the specified type to the
2475 /// specified destination type, both of which are LLVM scalar types.
2476 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2477 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002478
Chris Lattner42e6b812007-08-26 16:34:22 +00002479 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stumpfc496822009-02-08 23:14:22 +00002480 /// complex type to the specified destination type, where the destination type
2481 /// is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002482 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2483 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002484
2485
John McCall7a626f62010-09-15 10:14:12 +00002486 /// EmitAggExpr - Emit the computation of the specified expression
2487 /// of aggregate type. The result is computed into the given slot,
2488 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002489 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002490
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002491 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2492 /// aggregate type into a temporary LValue.
2493 LValue EmitAggExprToLValue(const Expr *E);
2494
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002495 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2496 /// pointers.
2497 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian879d7262009-08-31 19:33:16 +00002498 QualType Ty);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002499
John McCall1bd25562011-06-24 23:21:27 +00002500 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2501 /// make sure it survives garbage collection until this point.
2502 void EmitExtendGCLifetime(llvm::Value *object);
2503
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002504 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002505 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002506 ComplexPairTy EmitComplexExpr(const Expr *E,
2507 bool IgnoreReal = false,
2508 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002509
John McCall47fb9502013-03-07 21:37:08 +00002510 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2511 /// type and place its result into the specified l-value.
2512 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002513
John McCall47fb9502013-03-07 21:37:08 +00002514 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
2515 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
2516
2517 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002518 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002519
Chandler Carruth84537952012-03-30 19:44:53 +00002520 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2521 /// global variable that has already been created for it. If the initializer
2522 /// has a different type than GV does, this may free GV and return a different
2523 /// one. Otherwise it just returns GV.
2524 llvm::GlobalVariable *
2525 AddInitializerToStaticVarDecl(const VarDecl &D,
2526 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002527
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002528
Anders Carlssonf40886a2009-08-08 21:45:14 +00002529 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2530 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002531 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2532 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002533
David Majnemerb3341ea2014-10-05 05:05:40 +00002534 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
2535 llvm::Constant *Addr);
2536
John McCallc84ed6a2012-05-01 06:13:13 +00002537 /// Call atexit() with a function that passes the given argument to
2538 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00002539 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2540 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002541
John McCallcdf7ef52010-11-06 09:44:32 +00002542 /// Emit code in this function to perform a guarded variable
2543 /// initialization. Guarded initializations are used when it's not
2544 /// possible to prove that an initialization will be done exactly
2545 /// once, e.g. with a static local variable or a static data member
2546 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002547 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002548 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002549
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002550 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2551 /// variables.
2552 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00002553 ArrayRef<llvm::Function *> CXXThreadLocals,
Craig Topper8a13c412014-05-21 05:09:00 +00002554 llvm::GlobalVariable *Guard = nullptr);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002555
John McCallee08c532012-04-06 18:21:03 +00002556 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002557 /// variables.
John McCallee08c532012-04-06 18:21:03 +00002558 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2559 const std::vector<std::pair<llvm::WeakVH,
2560 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002561
John McCalla738c252011-03-09 04:27:21 +00002562 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2563 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00002564 llvm::GlobalVariable *Addr,
2565 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002566
John McCall7a626f62010-09-15 10:14:12 +00002567 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002568
2569 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian50198092010-12-02 17:02:11 +00002570 const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00002571
John McCall08ef4662011-11-10 08:15:53 +00002572 void enterFullExpression(const ExprWithCleanups *E) {
2573 if (E->getNumObjects() == 0) return;
2574 enterNonTrivialFullExpression(E);
2575 }
2576 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00002577
Richard Smithea852322013-05-07 21:53:22 +00002578 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00002579
Eli Friedmanc370a7e2012-02-09 03:32:31 +00002580 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2581
Craig Topper8a13c412014-05-21 05:09:00 +00002582 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = nullptr);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00002583
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002584 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002585 // Annotations Emission
2586 //===--------------------------------------------------------------------===//
2587
2588 /// Emit an annotation call (intrinsic or builtin).
2589 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2590 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002591 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002592 SourceLocation Location);
2593
2594 /// Emit local annotations for the local variable V, declared by D.
2595 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2596
2597 /// Emit field annotations for the given field & value. Returns the
2598 /// annotation result.
2599 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2600
2601 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002602 // Internal Helpers
2603 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002604
Chris Lattner5b1964b2008-11-11 07:41:27 +00002605 /// ContainsLabel - Return true if the statement contains a label in it. If
2606 /// this statement is not executed normally, it not containing a label means
2607 /// that we can just remove the code.
2608 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002609
Chris Lattner29911cc2011-02-28 00:18:40 +00002610 /// containsBreak - Return true if the statement contains a break out of it.
2611 /// If the statement (recursively) contains a switch or loop with a break
2612 /// inside of it, this is fine.
2613 static bool containsBreak(const Stmt *S);
2614
Daniel Dunbar682712c2008-11-12 10:12:14 +00002615 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00002616 /// to a constant, or if it does but contains a label, return false. If it
2617 /// constant folds return true and set the boolean result in Result.
2618 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00002619
Chris Lattner29911cc2011-02-28 00:18:40 +00002620 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2621 /// to a constant, or if it does but contains a label, return false. If it
2622 /// constant folds return true and set the folded value.
Richard Trieuc320c742012-07-23 20:21:35 +00002623 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattner29911cc2011-02-28 00:18:40 +00002624
Chris Lattnercd439292008-11-12 08:04:58 +00002625 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2626 /// if statement) to the specified blocks. Based on the condition, this might
2627 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00002628 /// TrueCount should be the number of times we expect the condition to
2629 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00002630 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00002631 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00002632
Richard Smithe30752c2012-10-09 19:52:38 +00002633 /// \brief Emit a description of a type in a format suitable for passing to
2634 /// a runtime sanitizer handler.
2635 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2636
2637 /// \brief Convert a value into a format suitable for passing to a runtime
2638 /// sanitizer handler.
2639 llvm::Value *EmitCheckValue(llvm::Value *V);
2640
2641 /// \brief Emit a description of a source location in a format suitable for
2642 /// passing to a runtime sanitizer handler.
2643 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2644
Will Dietz88e02332012-12-02 19:50:33 +00002645 /// \brief Specify under what conditions this check can be recovered
2646 enum CheckRecoverableKind {
2647 /// Always terminate program execution if this check fails
2648 CRK_Unrecoverable,
2649 /// Check supports recovering, allows user to specify which
2650 CRK_Recoverable,
2651 /// Runtime conditionally aborts, always need to support recovery.
2652 CRK_AlwaysRecoverable
2653 };
2654
Richard Smithde670682012-11-01 22:15:34 +00002655 /// \brief Create a basic block that will call a handler function in a
2656 /// sanitizer runtime with the provided arguments, and create a conditional
2657 /// branch to it.
Richard Smithe30752c2012-10-09 19:52:38 +00002658 void EmitCheck(llvm::Value *Checked, StringRef CheckName,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002659 ArrayRef<llvm::Constant *> StaticArgs,
2660 ArrayRef<llvm::Value *> DynamicArgs,
Will Dietz88e02332012-12-02 19:50:33 +00002661 CheckRecoverableKind Recoverable);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002662
Richard Smithde670682012-11-01 22:15:34 +00002663 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2664 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00002665 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00002666
Anders Carlsson093bdff2010-03-30 03:27:09 +00002667 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00002668 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00002669
John McCall23f66262010-05-26 22:34:26 +00002670 /// EmitDelegateCallArg - We are performing a delegate call; that
2671 /// is, the current function is delegating to another one. Produce
2672 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002673 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
2674 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00002675
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002676 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2677 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00002678 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002679
Chris Lattnercd439292008-11-12 08:04:58 +00002680private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00002681 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002682 void EmitReturnOfRValue(RValue RV, QualType Ty);
2683
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002684 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
2685
2686 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
2687 DeferredReplacements;
2688
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002689 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2690 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2691 ///
2692 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002693 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
2694 SmallVectorImpl<llvm::Argument *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002695
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002696 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
2697 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
2698 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
2699 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
2700 SmallVectorImpl<llvm::Value *> &IRCallArgs,
2701 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00002702
Chad Rosier59df25b2012-08-23 20:00:18 +00002703 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00002704 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00002705
Chad Rosier59df25b2012-08-23 20:00:18 +00002706 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00002707 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002708 std::string &ConstraintStr,
2709 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00002710
Reid Kleckner89077a12013-12-17 19:46:40 +00002711public:
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002712 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00002713 template <typename T>
2714 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002715 CallExpr::const_arg_iterator ArgBeg,
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002716 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002717 const FunctionDecl *CalleeDecl = nullptr,
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002718 unsigned ParamsToSkip = 0, bool ForceColumnInfo = false) {
Reid Kleckner739756c2013-12-04 19:23:12 +00002719 SmallVector<QualType, 16> ArgTypes;
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002720 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002721
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002722 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
2723 "Can't skip parameters if type info is not provided");
2724 if (CallArgTypeInfo) {
2725 // First, use the argument types that the type info knows about
2726 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
2727 E = CallArgTypeInfo->param_type_end();
2728 I != E; ++I, ++Arg) {
2729 assert(Arg != ArgEnd && "Running over edge of argument list!");
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002730#ifndef NDEBUG
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002731 QualType ArgType = *I;
2732 QualType ActualArgType = Arg->getType();
2733 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
2734 QualType ActualBaseType =
2735 ActualArgType->getAs<PointerType>()->getPointeeType();
2736 QualType ArgBaseType =
2737 ArgType->getAs<PointerType>()->getPointeeType();
2738 if (ArgBaseType->isVariableArrayType()) {
2739 if (const VariableArrayType *VAT =
2740 getContext().getAsVariableArrayType(ActualBaseType)) {
2741 if (!VAT->getSizeExpr())
2742 ActualArgType = ArgType;
2743 }
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002744 }
2745 }
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002746 assert(getContext()
2747 .getCanonicalType(ArgType.getNonReferenceType())
2748 .getTypePtr() ==
2749 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
2750 "type mismatch in call argument!");
Reid Kleckner739756c2013-12-04 19:23:12 +00002751#endif
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002752 ArgTypes.push_back(*I);
2753 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00002754 }
Mike Stump11289f42009-09-09 15:08:12 +00002755
Reid Kleckner739756c2013-12-04 19:23:12 +00002756 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002757 // function.
2758 assert(
2759 (Arg == ArgEnd || !CallArgTypeInfo || CallArgTypeInfo->isVariadic()) &&
2760 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00002761
Anders Carlsson603d6af2009-04-18 20:20:22 +00002762 // If we still have any arguments, emit them using the type of the argument.
Reid Kleckner739756c2013-12-04 19:23:12 +00002763 for (; Arg != ArgEnd; ++Arg)
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002764 ArgTypes.push_back(getVarArgType(*Arg));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002765
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002766 EmitCallArgs(Args, ArgTypes, ArgBeg, ArgEnd, CalleeDecl, ParamsToSkip,
2767 ForceColumnInfo);
Anders Carlsson603d6af2009-04-18 20:20:22 +00002768 }
John McCalld4f4b7f2010-03-03 04:15:11 +00002769
Reid Kleckner739756c2013-12-04 19:23:12 +00002770 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
2771 CallExpr::const_arg_iterator ArgBeg,
Richard Smith760520b2014-06-03 23:27:44 +00002772 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002773 const FunctionDecl *CalleeDecl = nullptr,
2774 unsigned ParamsToSkip = 0, bool ForceColumnInfo = false);
Reid Kleckner739756c2013-12-04 19:23:12 +00002775
Reid Kleckner89077a12013-12-17 19:46:40 +00002776private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002777 QualType getVarArgType(const Expr *Arg);
2778
John McCalld4f4b7f2010-03-03 04:15:11 +00002779 const TargetCodeGenInfo &getTargetHooks() const {
2780 return CGM.getTargetCodeGenInfo();
2781 }
John McCall09ae0322010-07-06 23:57:41 +00002782
2783 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00002784
2785 CodeGenModule::ByrefHelpers *
Chris Lattner2192fe52011-07-18 04:24:23 +00002786 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf9b056b2011-03-31 08:03:29 +00002787 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00002788
2789 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00002790
Eli Friedmana5dd5682012-08-23 03:10:17 +00002791 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2792 /// value and compute our best estimate of the alignment of the pointee.
2793 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
Chris Lattnerbed31442007-05-28 01:07:47 +00002794};
Mike Stump11289f42009-09-09 15:08:12 +00002795
John McCallce1de612011-01-26 04:00:11 +00002796/// Helper class with most of the code for saving a value for a
2797/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00002798struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00002799 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2800
2801 /// Answer whether the given value needs extra work to be saved.
2802 static bool needsSaving(llvm::Value *value) {
2803 // If it's not an instruction, we don't need to save.
2804 if (!isa<llvm::Instruction>(value)) return false;
2805
2806 // If it's an instruction in the entry block, we don't need to save.
2807 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2808 return (block != &block->getParent()->getEntryBlock());
2809 }
2810
2811 /// Try to save the given value.
2812 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2813 if (!needsSaving(value)) return saved_type(value, false);
2814
2815 // Otherwise we need an alloca.
2816 llvm::Value *alloca =
2817 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2818 CGF.Builder.CreateStore(value, alloca);
2819
2820 return saved_type(alloca, true);
2821 }
2822
2823 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2824 if (!value.getInt()) return value.getPointer();
2825 return CGF.Builder.CreateLoad(value.getPointer());
2826 }
2827};
2828
John McCallcb5f77f2011-01-28 10:53:53 +00002829/// A partial specialization of DominatingValue for llvm::Values that
2830/// might be llvm::Instructions.
2831template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2832 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00002833 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00002834 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2835 }
2836};
2837
2838/// A specialization of DominatingValue for RValue.
2839template <> struct DominatingValue<RValue> {
2840 typedef RValue type;
2841 class saved_type {
2842 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2843 AggregateAddress, ComplexAddress };
2844
2845 llvm::Value *Value;
2846 Kind K;
2847 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2848
2849 public:
2850 static bool needsSaving(RValue value);
2851 static saved_type save(CodeGenFunction &CGF, RValue value);
2852 RValue restore(CodeGenFunction &CGF);
2853
2854 // implementations in CGExprCXX.cpp
2855 };
2856
2857 static bool needsSaving(type value) {
2858 return saved_type::needsSaving(value);
2859 }
2860 static saved_type save(CodeGenFunction &CGF, type value) {
2861 return saved_type::save(CGF, value);
2862 }
2863 static type restore(CodeGenFunction &CGF, saved_type value) {
2864 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00002865 }
2866};
2867
Chris Lattnerbed31442007-05-28 01:07:47 +00002868} // end namespace CodeGen
2869} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00002870
Chris Lattnerbed31442007-05-28 01:07:47 +00002871#endif