blob: 87b7a2bc89a0350ac5d58cc574f0cfcf38831357 [file] [log] [blame]
Daniel Dunbar9c426522008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Chris Lattnerbed31442007-05-28 01:07:47 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattnerbed31442007-05-28 01:07:47 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stumpfc496822009-02-08 23:14:22 +000010// This is the internal per-function state used for llvm translation.
Chris Lattnerbed31442007-05-28 01:07:47 +000011//
12//===----------------------------------------------------------------------===//
13
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000014#ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
15#define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
Chris Lattnerbed31442007-05-28 01:07:47 +000016
Daniel Dunbarcb463852008-11-01 01:53:16 +000017#include "CGBuilder.h"
Eric Christophera9d34972011-10-19 00:43:52 +000018#include "CGDebugInfo.h"
Alexander Musman515ad8c2014-05-22 08:54:05 +000019#include "CGLoopInfo.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000020#include "CGValue.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "CodeGenModule.h"
Justin Bogneref512b92014-01-06 22:27:43 +000022#include "CodeGenPGO.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000023#include "EHScopeStack.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000024#include "clang/AST/CharUnits.h"
25#include "clang/AST/ExprCXX.h"
26#include "clang/AST/ExprObjC.h"
27#include "clang/AST/Type.h"
28#include "clang/Basic/ABI.h"
Ben Langmuir3b4c30b2013-05-09 19:17:11 +000029#include "clang/Basic/CapturedStmt.h"
Alexander Musmandf7a8e22015-01-22 08:49:35 +000030#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000031#include "clang/Basic/TargetInfo.h"
32#include "clang/Frontend/CodeGenOptions.h"
33#include "llvm/ADT/ArrayRef.h"
34#include "llvm/ADT/DenseMap.h"
35#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000036#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000037#include "llvm/Support/Debug.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000038
Chris Lattnerbed31442007-05-28 01:07:47 +000039namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000040class BasicBlock;
41class LLVMContext;
42class MDNode;
43class Module;
44class SwitchInst;
45class Twine;
46class Value;
47class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000048}
49
Chris Lattnerbed31442007-05-28 01:07:47 +000050namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000051class ASTContext;
52class BlockDecl;
53class CXXDestructorDecl;
54class CXXForRangeStmt;
55class CXXTryStmt;
56class Decl;
57class LabelDecl;
58class EnumConstantDecl;
59class FunctionDecl;
60class FunctionProtoType;
61class LabelStmt;
62class ObjCContainerDecl;
63class ObjCInterfaceDecl;
64class ObjCIvarDecl;
65class ObjCMethodDecl;
66class ObjCImplementationDecl;
67class ObjCPropertyImplDecl;
68class TargetInfo;
69class TargetCodeGenInfo;
70class VarDecl;
71class ObjCForCollectionStmt;
72class ObjCAtTryStmt;
73class ObjCAtThrowStmt;
74class ObjCAtSynchronizedStmt;
75class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000076
Chris Lattnerbed31442007-05-28 01:07:47 +000077namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000078class CodeGenTypes;
79class CGFunctionInfo;
80class CGRecordLayout;
81class CGBlockInfo;
82class CGCXXABI;
83class BlockFlags;
84class BlockFieldFlags;
Mike Stumpfc496822009-02-08 23:14:22 +000085
John McCall47fb9502013-03-07 21:37:08 +000086/// The kind of evaluation to perform on values of a particular
87/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
88/// CGExprAgg?
89///
90/// TODO: should vectors maybe be split out into their own thing?
91enum TypeEvaluationKind {
92 TEK_Scalar,
93 TEK_Complex,
94 TEK_Aggregate
95};
96
Chris Lattnerbed31442007-05-28 01:07:47 +000097/// CodeGenFunction - This class organizes the per-function state that is used
98/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +000099class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000100 CodeGenFunction(const CodeGenFunction &) = delete;
101 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000102
103 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000104public:
John McCallad5d61e2010-07-23 21:56:41 +0000105 /// A jump destination is an abstract label, branching to which may
106 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000107 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000108 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000109 JumpDest(llvm::BasicBlock *Block,
110 EHScopeStack::stable_iterator Depth,
111 unsigned Index)
112 : Block(Block), ScopeDepth(Depth), Index(Index) {}
113
Craig Topper8a13c412014-05-21 05:09:00 +0000114 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000115 llvm::BasicBlock *getBlock() const { return Block; }
116 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
117 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000118
Nadav Rotem1da30942013-03-23 06:43:35 +0000119 // This should be used cautiously.
120 void setScopeDepth(EHScopeStack::stable_iterator depth) {
121 ScopeDepth = depth;
122 }
123
John McCallad5d61e2010-07-23 21:56:41 +0000124 private:
John McCallbd309292010-07-06 01:34:17 +0000125 llvm::BasicBlock *Block;
126 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000127 unsigned Index;
128 };
129
Chris Lattnerbed31442007-05-28 01:07:47 +0000130 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000131 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000132
Chris Lattner96d72562007-08-21 16:57:55 +0000133 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000134 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000135 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000136
Alexander Musman515ad8c2014-05-22 08:54:05 +0000137 /// \brief CGBuilder insert helper. This function is called after an
138 /// instruction is created using Builder.
139 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
140 llvm::BasicBlock *BB,
141 llvm::BasicBlock::iterator InsertPt) const;
142
John McCalldec348f72013-05-03 07:33:41 +0000143 /// CurFuncDecl - Holds the Decl for the current outermost
144 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000145 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000146 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
147 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000148 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000149 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000150 llvm::Function *CurFn;
151
Mike Stumpbee78dd2009-12-04 23:26:17 +0000152 /// CurGD - The GlobalDecl for the current function being compiled.
153 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000154
John McCall31168b02011-06-15 23:02:42 +0000155 /// PrologueCleanupDepth - The cleanup depth enclosing all the
156 /// cleanups associated with the parameters.
157 EHScopeStack::stable_iterator PrologueCleanupDepth;
158
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000159 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000160 JumpDest ReturnBlock;
161
Mike Stumpfc496822009-02-08 23:14:22 +0000162 /// ReturnValue - The temporary alloca to hold the return value. This is null
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +0000163 /// iff the function has no return value.
Eli Friedman4b1942c2009-12-04 02:43:40 +0000164 llvm::Value *ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000165
Chris Lattner03df1222007-06-02 04:53:11 +0000166 /// AllocaInsertPoint - This is an instruction in the entry block before which
167 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000168 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000169
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000170 /// \brief API for captured statement code generation.
171 class CGCapturedStmtInfo {
172 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000173 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
174 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000175 explicit CGCapturedStmtInfo(const CapturedStmt &S,
176 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000177 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000178
179 RecordDecl::field_iterator Field =
180 S.getCapturedRecordDecl()->field_begin();
181 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
182 E = S.capture_end();
183 I != E; ++I, ++Field) {
184 if (I->capturesThis())
185 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000186 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000187 CaptureFields[I->getCapturedVar()] = *Field;
188 }
189 }
190
191 virtual ~CGCapturedStmtInfo();
192
193 CapturedRegionKind getKind() const { return Kind; }
194
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000195 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000196 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000197 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000198
199 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000200 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000201 return CaptureFields.lookup(VD);
202 }
203
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000204 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
205 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000206
Alexey Bataev18095712014-10-10 12:19:54 +0000207 static bool classof(const CGCapturedStmtInfo *) {
208 return true;
209 }
210
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000211 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000212 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner81ab90f2014-04-15 00:50:54 +0000213 RegionCounter Cnt = CGF.getPGORegionCounter(S);
214 Cnt.beginRegion(CGF.Builder);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000215 CGF.EmitStmt(S);
216 }
217
218 /// \brief Get the name of the capture helper.
219 virtual StringRef getHelperName() const { return "__captured_stmt"; }
220
221 private:
222 /// \brief The kind of captured statement being generated.
223 CapturedRegionKind Kind;
224
225 /// \brief Keep the map between VarDecl and FieldDecl.
226 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
227
228 /// \brief The base address of the captured record, passed in as the first
229 /// argument of the parallel region function.
230 llvm::Value *ThisValue;
231
232 /// \brief Captured 'this' type.
233 FieldDecl *CXXThisFieldDecl;
234 };
235 CGCapturedStmtInfo *CapturedStmtInfo;
236
Nuno Lopes3d6311d2012-05-08 22:10:46 +0000237 /// BoundsChecking - Emit run-time bounds checks. Higher values mean
238 /// potentially higher performance penalties.
239 unsigned char BoundsChecking;
240
Alexey Samsonova0416102014-11-11 01:26:14 +0000241 /// \brief Sanitizers enabled for this function.
242 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000243
Alexey Samsonov24cad992014-07-17 18:46:27 +0000244 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
245 bool IsSanitizerScope;
246
247 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
248 class SanitizerScope {
249 CodeGenFunction *CGF;
250 public:
251 SanitizerScope(CodeGenFunction *CGF);
252 ~SanitizerScope();
253 };
254
Reid Kleckner19819442014-07-25 21:39:46 +0000255 /// In C++, whether we are code generating a thunk. This controls whether we
256 /// should emit cleanups.
257 bool CurFuncIsThunk;
258
John McCall31168b02011-06-15 23:02:42 +0000259 /// In ARC, whether we should autorelease the return value.
260 bool AutoreleaseResult;
261
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000262 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
263 /// potentially set the return value.
264 bool SawAsmBlock;
265
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000266 /// True if the current function is an outlined SEH helper. This can be a
267 /// finally block or filter expression.
268 bool IsOutlinedSEHHelper;
269
John McCallad7c5c12011-02-08 08:22:06 +0000270 const CodeGen::CGBlockInfo *BlockInfo;
271 llvm::Value *BlockPointer;
272
Eli Friedman9fbeba02012-02-11 02:57:39 +0000273 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
274 FieldDecl *LambdaThisCaptureField;
275
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000276 /// \brief A mapping from NRVO variables to the flags used to indicate
277 /// when the NRVO has been applied to this variable.
278 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000279
John McCallbd309292010-07-06 01:34:17 +0000280 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000281 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000282 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000283
284 /// Header for data within LifetimeExtendedCleanupStack.
285 struct LifetimeExtendedCleanupHeader {
286 /// The size of the following cleanup object.
Reid Klecknerc311aba2014-10-31 23:33:56 +0000287 unsigned Size : 29;
Richard Smith736a9472013-06-12 20:42:33 +0000288 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
289 unsigned Kind : 3;
290
Reid Klecknerc311aba2014-10-31 23:33:56 +0000291 size_t getSize() const { return size_t(Size); }
Richard Smith736a9472013-06-12 20:42:33 +0000292 CleanupKind getKind() const { return static_cast<CleanupKind>(Kind); }
293 };
John McCallbd309292010-07-06 01:34:17 +0000294
John McCallad5d61e2010-07-23 21:56:41 +0000295 /// i32s containing the indexes of the cleanup destinations.
296 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000297
298 unsigned NextCleanupDestIndex;
299
John McCall08ef4662011-11-10 08:15:53 +0000300 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
301 CGBlockInfo *FirstBlockInfo;
302
John McCall8e4c74b2011-08-11 02:22:43 +0000303 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
304 llvm::BasicBlock *EHResumeBlock;
305
Bill Wendlingf0724e82011-09-19 20:31:14 +0000306 /// The exception slot. All landing pads write the current exception pointer
307 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000308 llvm::Value *ExceptionSlot;
309
Bill Wendlingf0724e82011-09-19 20:31:14 +0000310 /// The selector slot. Under the MandatoryCleanup model, all landing pads
311 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000312 llvm::AllocaInst *EHSelectorSlot;
313
Reid Kleckneraca01db2015-02-04 22:37:07 +0000314 llvm::AllocaInst *AbnormalTerminationSlot;
315
Reid Kleckner1d59f992015-01-22 01:36:17 +0000316 /// The implicit parameter to SEH filter functions of type
317 /// 'EXCEPTION_POINTERS*'.
318 ImplicitParamDecl *SEHPointersDecl;
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
Reid Kleckner11c033e2015-02-12 23:40:45 +0000358 /// Returns true inside SEH __try blocks.
359 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
360
John McCallce1de612011-01-26 04:00:11 +0000361 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
362 /// current full-expression. Safe against the possibility that
363 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000364 template <class T, class... As>
365 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000366 // If we're not in a conditional branch, or if none of the
367 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000368 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000369 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000370
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000371 // Stash values in a tuple so we can guarantee the order of saves.
372 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
373 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000374
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000375 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000376 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000377 initFullExprCleanup();
378 }
379
Richard Smith736a9472013-06-12 20:42:33 +0000380 /// \brief Queue a cleanup to be pushed after finishing the current
381 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000382 template <class T, class... As>
383 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000384 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
385
386 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
387
388 size_t OldSize = LifetimeExtendedCleanupStack.size();
389 LifetimeExtendedCleanupStack.resize(
390 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
391
392 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
393 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000394 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000395 }
396
John McCallf4beacd2011-11-10 10:43:54 +0000397 /// Set up the last cleaup that was pushed as a conditional
398 /// full-expression cleanup.
399 void initFullExprCleanup();
400
John McCallbd309292010-07-06 01:34:17 +0000401 /// PushDestructorCleanup - Push a cleanup to call the
402 /// complete-object destructor of an object of the given type at the
403 /// given address. Does nothing if T is not a C++ class type with a
404 /// non-trivial destructor.
405 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
406
John McCall8680f872010-07-21 06:29:51 +0000407 /// PushDestructorCleanup - Push a cleanup to call the
408 /// complete-object variant of the given destructor on the object at
409 /// the given address.
410 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
411 llvm::Value *Addr);
412
John McCallbd309292010-07-06 01:34:17 +0000413 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
414 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000415 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000416
John McCall824c2f52010-09-14 07:57:04 +0000417 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
418 /// The block cannot be reactivated. Pops it if it's the top of the
419 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000420 ///
421 /// \param DominatingIP - An instruction which is known to
422 /// dominate the current IP (if set) and which lies along
423 /// all paths of execution between the current IP and the
424 /// the point at which the cleanup comes into scope.
425 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
426 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000427
428 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
429 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000430 ///
431 /// \param DominatingIP - An instruction which is known to
432 /// dominate the current IP (if set) and which lies along
433 /// all paths of execution between the current IP and the
434 /// the point at which the cleanup comes into scope.
435 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
436 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000437
John McCallbd309292010-07-06 01:34:17 +0000438 /// \brief Enters a new scope for capturing cleanups, all of which
439 /// will be executed once the scope is exited.
440 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000441 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000442 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000443 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000444 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000445 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000446 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000447
Aaron Ballmanabc18922015-02-15 22:54:08 +0000448 RunCleanupsScope(const RunCleanupsScope &) = delete;
449 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000450
Eric Christophera9d34972011-10-19 00:43:52 +0000451 protected:
452 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000453
Douglas Gregor965f4502009-11-24 16:43:22 +0000454 public:
455 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000456 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000457 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000458 {
John McCallbd309292010-07-06 01:34:17 +0000459 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000460 LifetimeExtendedCleanupStackSize =
461 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000462 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000463 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000464 }
465
466 /// \brief Exit this cleanup scope, emitting any accumulated
467 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000468 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000469 if (PerformCleanup) {
470 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000471 CGF.PopCleanupBlocks(CleanupStackDepth,
472 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000473 }
474 }
475
476 /// \brief Determine whether this scope requires any cleanups.
477 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000478 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000479 }
480
481 /// \brief Force the emission of cleanups now, instead of waiting
482 /// until this object is destroyed.
483 void ForceCleanup() {
484 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000485 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000486 CGF.PopCleanupBlocks(CleanupStackDepth,
487 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000488 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000489 }
490 };
491
David Blaikie93be0b22014-08-22 21:37:04 +0000492 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000493 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000494 SmallVector<const LabelDecl*, 4> Labels;
495 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000496
Aaron Ballmanabc18922015-02-15 22:54:08 +0000497 LexicalScope(const LexicalScope &) = delete;
498 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000499
500 public:
501 /// \brief Enter a new cleanup scope.
502 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000503 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
504 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000505 if (CGDebugInfo *DI = CGF.getDebugInfo())
506 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
507 }
508
Nadav Rotem1da30942013-03-23 06:43:35 +0000509 void addLabel(const LabelDecl *label) {
510 assert(PerformCleanup && "adding label to dead scope?");
511 Labels.push_back(label);
512 }
513
Eric Christophera9d34972011-10-19 00:43:52 +0000514 /// \brief Exit this cleanup scope, emitting any accumulated
515 /// cleanups.
516 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000517 if (CGDebugInfo *DI = CGF.getDebugInfo())
518 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
519
Nadav Rotem1da30942013-03-23 06:43:35 +0000520 // If we should perform a cleanup, force them now. Note that
521 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000522 if (PerformCleanup) {
523 ApplyDebugLocation DL(CGF, Range.getEnd());
524 ForceCleanup();
525 }
Eric Christophera9d34972011-10-19 00:43:52 +0000526 }
527
528 /// \brief Force the emission of cleanups now, instead of waiting
529 /// until this object is destroyed.
530 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000531 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000532 RunCleanupsScope::ForceCleanup();
533
Nadav Rotem1da30942013-03-23 06:43:35 +0000534 if (!Labels.empty())
535 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000536 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000537
538 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000539 };
540
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000541 /// \brief The scope used to remap some variables as private in the OpenMP
542 /// loop body (or other captured region emitted without outlining), and to
543 /// restore old vars back on exit.
544 class OMPPrivateScope : public RunCleanupsScope {
545 typedef llvm::DenseMap<const VarDecl *, llvm::Value *> VarDeclMapTy;
546 VarDeclMapTy SavedLocals;
547 VarDeclMapTy SavedPrivates;
548
549 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000550 OMPPrivateScope(const OMPPrivateScope &) = delete;
551 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000552
553 public:
554 /// \brief Enter a new OpenMP private scope.
555 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
556
557 /// \brief Registers \a LocalVD variable as a private and apply \a
558 /// PrivateGen function for it to generate corresponding private variable.
559 /// \a PrivateGen returns an address of the generated private variable.
560 /// \return true if the variable is registered as private, false if it has
561 /// been privatized already.
562 bool
563 addPrivate(const VarDecl *LocalVD,
564 const std::function<llvm::Value *()> &PrivateGen) {
565 assert(PerformCleanup && "adding private to dead scope");
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000566 if (SavedLocals.count(LocalVD) > 0) return false;
567 SavedLocals[LocalVD] = CGF.LocalDeclMap.lookup(LocalVD);
568 CGF.LocalDeclMap.erase(LocalVD);
569 SavedPrivates[LocalVD] = PrivateGen();
570 CGF.LocalDeclMap[LocalVD] = SavedLocals[LocalVD];
571 return true;
572 }
573
574 /// \brief Privatizes local variables previously registered as private.
575 /// Registration is separate from the actual privatization to allow
576 /// initializers use values of the original variables, not the private one.
577 /// This is important, for example, if the private variable is a class
578 /// variable initialized by a constructor that references other private
579 /// variables. But at initialization original variables must be used, not
580 /// private copies.
581 /// \return true if at least one variable was privatized, false otherwise.
582 bool Privatize() {
583 for (auto VDPair : SavedPrivates) {
584 CGF.LocalDeclMap[VDPair.first] = VDPair.second;
585 }
586 SavedPrivates.clear();
587 return !SavedLocals.empty();
588 }
589
590 void ForceCleanup() {
591 RunCleanupsScope::ForceCleanup();
592 // Remap vars back to the original values.
593 for (auto I : SavedLocals) {
594 CGF.LocalDeclMap[I.first] = I.second;
595 }
596 SavedLocals.clear();
597 }
598
599 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000600 ~OMPPrivateScope() {
601 if (PerformCleanup)
602 ForceCleanup();
603 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000604 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000605
Richard Smith736a9472013-06-12 20:42:33 +0000606 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
607 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000608 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000609
Richard Smith736a9472013-06-12 20:42:33 +0000610 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
611 /// that have been added, then adds all lifetime-extended cleanups from
612 /// the given position to the stack.
613 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
614 size_t OldLifetimeExtendedStackSize);
615
John McCallad5d61e2010-07-23 21:56:41 +0000616 void ResolveBranchFixups(llvm::BasicBlock *Target);
617
John McCallbd309292010-07-06 01:34:17 +0000618 /// The given basic block lies in the current EH scope, but may be a
619 /// target of a potentially scope-crossing jump; get a stable handle
620 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000621 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000622 return JumpDest(Target,
623 EHStack.getInnermostNormalCleanup(),
624 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000625 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000626
John McCallbd309292010-07-06 01:34:17 +0000627 /// The given basic block lies in the current EH scope, but may be a
628 /// target of a potentially scope-crossing jump; get a stable handle
629 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000630 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000631 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000632 }
633
634 /// EmitBranchThroughCleanup - Emit a branch from the current insert
635 /// block through the normal cleanup handling code (if any) and then
636 /// on to \arg Dest.
637 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000638
Justin Bognere25ffdf2014-01-21 00:35:11 +0000639 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
640 /// specified destination obviously has no cleanups to run. 'false' is always
641 /// a conservatively correct answer for this method.
642 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
643
John McCall8e4c74b2011-08-11 02:22:43 +0000644 /// popCatchScope - Pops the catch scope at the top of the EHScope
645 /// stack, emitting any required code (other than the catch handlers
646 /// themselves).
647 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000648
David Chisnall9a837be2012-11-07 16:50:40 +0000649 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000650 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000651
John McCallce1de612011-01-26 04:00:11 +0000652 /// An object to manage conditionally-evaluated expressions.
653 class ConditionalEvaluation {
654 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000655
John McCallce1de612011-01-26 04:00:11 +0000656 public:
657 ConditionalEvaluation(CodeGenFunction &CGF)
658 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000659
John McCallce1de612011-01-26 04:00:11 +0000660 void begin(CodeGenFunction &CGF) {
661 assert(CGF.OutermostConditional != this);
662 if (!CGF.OutermostConditional)
663 CGF.OutermostConditional = this;
664 }
665
666 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000667 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000668 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000669 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000670 }
671
672 /// Returns a block which will be executed prior to each
673 /// evaluation of the conditional code.
674 llvm::BasicBlock *getStartingBlock() const {
675 return StartBB;
676 }
677 };
Mike Stump11289f42009-09-09 15:08:12 +0000678
John McCall7f9c92a2010-09-17 00:50:28 +0000679 /// isInConditionalBranch - Return true if we're currently emitting
680 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000681 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000682
John McCallf4beacd2011-11-10 10:43:54 +0000683 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
684 assert(isInConditionalBranch());
685 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
686 new llvm::StoreInst(value, addr, &block->back());
687 }
688
John McCallce1de612011-01-26 04:00:11 +0000689 /// An RAII object to record that we're evaluating a statement
690 /// expression.
691 class StmtExprEvaluation {
692 CodeGenFunction &CGF;
693
694 /// We have to save the outermost conditional: cleanups in a
695 /// statement expression aren't conditional just because the
696 /// StmtExpr is.
697 ConditionalEvaluation *SavedOutermostConditional;
698
699 public:
700 StmtExprEvaluation(CodeGenFunction &CGF)
701 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000702 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000703 }
704
705 ~StmtExprEvaluation() {
706 CGF.OutermostConditional = SavedOutermostConditional;
707 CGF.EnsureInsertPoint();
708 }
709 };
John McCall1bf58462011-02-16 08:02:54 +0000710
John McCallc07a0c72011-02-17 10:25:35 +0000711 /// An object which temporarily prevents a value from being
712 /// destroyed by aggressive peephole optimizations that assume that
713 /// all uses of a value have been realized in the IR.
714 class PeepholeProtection {
715 llvm::Instruction *Inst;
716 friend class CodeGenFunction;
717
718 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000719 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000720 };
John McCallc07a0c72011-02-17 10:25:35 +0000721
John McCallfe96e0b2011-11-06 09:01:30 +0000722 /// A non-RAII class containing all the information about a bound
723 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
724 /// this which makes individual mappings very simple; using this
725 /// class directly is useful when you have a variable number of
726 /// opaque values or don't want the RAII functionality for some
727 /// reason.
728 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000729 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000730 bool BoundLValue;
731 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000732
John McCallfe96e0b2011-11-06 09:01:30 +0000733 OpaqueValueMappingData(const OpaqueValueExpr *ov,
734 bool boundLValue)
735 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000736 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000737 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000738
John McCallc07a0c72011-02-17 10:25:35 +0000739 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000740 // gl-values should be bound as l-values for obvious reasons.
741 // Records should be bound as l-values because IR generation
742 // always keeps them in memory. Expressions of function type
743 // act exactly like l-values but are formally required to be
744 // r-values in C.
745 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000746 expr->getType()->isFunctionType() ||
747 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000748 }
749
John McCallfe96e0b2011-11-06 09:01:30 +0000750 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
751 const OpaqueValueExpr *ov,
752 const Expr *e) {
753 if (shouldBindAsLValue(ov))
754 return bind(CGF, ov, CGF.EmitLValue(e));
755 return bind(CGF, ov, CGF.EmitAnyExpr(e));
756 }
757
758 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
759 const OpaqueValueExpr *ov,
760 const LValue &lv) {
761 assert(shouldBindAsLValue(ov));
762 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
763 return OpaqueValueMappingData(ov, true);
764 }
765
766 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
767 const OpaqueValueExpr *ov,
768 const RValue &rv) {
769 assert(!shouldBindAsLValue(ov));
770 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
771
772 OpaqueValueMappingData data(ov, false);
773
774 // Work around an extremely aggressive peephole optimization in
775 // EmitScalarConversion which assumes that all other uses of a
776 // value are extant.
777 data.Protection = CGF.protectFromPeepholes(rv);
778
779 return data;
780 }
781
Craig Topper8a13c412014-05-21 05:09:00 +0000782 bool isValid() const { return OpaqueValue != nullptr; }
783 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000784
785 void unbind(CodeGenFunction &CGF) {
786 assert(OpaqueValue && "no data to unbind!");
787
788 if (BoundLValue) {
789 CGF.OpaqueLValues.erase(OpaqueValue);
790 } else {
791 CGF.OpaqueRValues.erase(OpaqueValue);
792 CGF.unprotectFromPeepholes(Protection);
793 }
794 }
795 };
796
797 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
798 class OpaqueValueMapping {
799 CodeGenFunction &CGF;
800 OpaqueValueMappingData Data;
801
802 public:
803 static bool shouldBindAsLValue(const Expr *expr) {
804 return OpaqueValueMappingData::shouldBindAsLValue(expr);
805 }
806
John McCallc07a0c72011-02-17 10:25:35 +0000807 /// Build the opaque value mapping for the given conditional
808 /// operator if it's the GNU ?: extension. This is a common
809 /// enough pattern that the convenience operator is really
810 /// helpful.
811 ///
812 OpaqueValueMapping(CodeGenFunction &CGF,
813 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000814 if (isa<ConditionalOperator>(op))
815 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000816 return;
John McCallc07a0c72011-02-17 10:25:35 +0000817
818 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000819 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
820 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000821 }
822
John McCall1bf58462011-02-16 08:02:54 +0000823 OpaqueValueMapping(CodeGenFunction &CGF,
824 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000825 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000826 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000827 }
828
829 OpaqueValueMapping(CodeGenFunction &CGF,
830 const OpaqueValueExpr *opaqueValue,
831 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000832 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000833 }
834
835 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000836 Data.unbind(CGF);
837 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000838 }
839
840 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000841 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000842 }
843 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000844
845 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
846 /// number that holds the value.
David Blaikie1ed728c2015-04-05 22:45:47 +0000847 std::pair<llvm::Type *, unsigned>
848 getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian2f2fa722011-01-26 23:08:27 +0000849
850 /// BuildBlockByrefAddress - Computes address location of the
851 /// variable which is declared as __block.
852 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
853 const VarDecl *V);
Chris Lattner2da04b32007-08-24 05:35:26 +0000854private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000855 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000856 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000857
John McCall9b382dd2011-05-28 21:13:02 +0000858 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
859 /// calling llvm.stacksave for multiple VLAs in the same scope.
860 bool DidCallStackSave;
861
Mike Stumpe5311b02009-11-30 20:08:49 +0000862 /// IndirectBranch - The first time an indirect goto is seen we create a block
863 /// with an indirect branch. Every time we see the address of a label taken,
864 /// we add the label to the indirect goto. Every subsequent indirect goto is
865 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000866 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000867
Mike Stumpfc496822009-02-08 23:14:22 +0000868 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
869 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000870 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
871 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000872
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000873 /// Track escaped local variables with auto storage. Used during SEH
874 /// outlining to produce a call to llvm.frameescape.
875 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
876
Chris Lattnerac248202007-05-30 00:13:02 +0000877 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000878 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000879
Mike Stumpfc496822009-02-08 23:14:22 +0000880 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +0000881 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000882 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +0000883 BreakContinue(JumpDest Break, JumpDest Continue)
884 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000885
John McCallbd309292010-07-06 01:34:17 +0000886 JumpDest BreakBlock;
887 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000888 };
Chris Lattner01cf8db2011-07-20 06:58:45 +0000889 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000890
Justin Bogneref512b92014-01-06 22:27:43 +0000891 CodeGenPGO PGO;
892
893public:
894 /// Get a counter for instrumentation of the region associated with the given
895 /// statement.
896 RegionCounter getPGORegionCounter(const Stmt *S) {
897 return RegionCounter(PGO, S);
898 }
899private:
900
Zhongxing Xu82846ea2012-01-14 09:08:15 +0000901 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +0000902 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000903 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +0000904 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
905 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +0000906
Mike Stumpfc496822009-02-08 23:14:22 +0000907 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000908 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000909 llvm::BasicBlock *CaseRangeBlock;
910
John McCallc07a0c72011-02-17 10:25:35 +0000911 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +0000912 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +0000913 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
914 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +0000915
Mike Stumpfc496822009-02-08 23:14:22 +0000916 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +0000917 // We track this by the size expression rather than the type itself because
918 // in certain situations, like a const qualifier applied to an VLA typedef,
919 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +0000920 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
921 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +0000922 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000923
John McCallbd309292010-07-06 01:34:17 +0000924 /// A block containing a single 'unreachable' instruction. Created
925 /// lazily by getUnreachableBlock().
926 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000927
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000928 /// Counts of the number return expressions in the function.
929 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +0000930
931 /// Count the number of simple (constant) return expressions in the function.
932 unsigned NumSimpleReturnExprs;
933
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000934 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +0000935 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +0000936
Richard Smith852c9db2013-04-20 22:23:05 +0000937public:
938 /// A scope within which we are constructing the fields of an object which
939 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
940 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
941 class FieldConstructionScope {
942 public:
943 FieldConstructionScope(CodeGenFunction &CGF, llvm::Value *This)
944 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
945 CGF.CXXDefaultInitExprThis = This;
946 }
947 ~FieldConstructionScope() {
948 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
949 }
950
951 private:
952 CodeGenFunction &CGF;
953 llvm::Value *OldCXXDefaultInitExprThis;
954 };
955
956 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
957 /// is overridden to be the object under construction.
958 class CXXDefaultInitExprScope {
959 public:
960 CXXDefaultInitExprScope(CodeGenFunction &CGF)
961 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue) {
962 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis;
963 }
964 ~CXXDefaultInitExprScope() {
965 CGF.CXXThisValue = OldCXXThisValue;
966 }
967
968 public:
969 CodeGenFunction &CGF;
970 llvm::Value *OldCXXThisValue;
971 };
972
973private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000974 /// CXXThisDecl - When generating code for a C++ member function,
975 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +0000976 ImplicitParamDecl *CXXABIThisDecl;
977 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +0000978 llvm::Value *CXXThisValue;
Mike Stump11289f42009-09-09 15:08:12 +0000979
Richard Smith852c9db2013-04-20 22:23:05 +0000980 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
981 /// this expression.
982 llvm::Value *CXXDefaultInitExprThis;
983
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000984 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
985 /// destructor, this will hold the implicit argument (e.g. VTT).
986 ImplicitParamDecl *CXXStructorImplicitParamDecl;
987 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000988
John McCallce1de612011-01-26 04:00:11 +0000989 /// OutermostConditional - Points to the outermost active
990 /// conditional control. This is used so that we know if a
991 /// temporary should be destroyed conditionally.
992 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +0000993
Nadav Rotem1da30942013-03-23 06:43:35 +0000994 /// The current lexical scope.
995 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +0000996
Adrian Prantldc237b52013-05-16 00:41:26 +0000997 /// The current source location that should be used for exception
998 /// handling code.
999 SourceLocation CurEHLocation;
1000
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001001 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1002 /// type as well as the field number that contains the actual data.
Chris Lattner2192fe52011-07-18 04:24:23 +00001003 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001004 unsigned> > ByRefValueInfo;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001005
John McCallbd309292010-07-06 01:34:17 +00001006 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001007 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001008 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001009
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001010 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1011 /// In the kernel metadata node, reference the kernel function and metadata
1012 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001013 /// - A node for the vec_type_hint(<type>) qualifier contains string
1014 /// "vec_type_hint", an undefined value of the <type> data type,
1015 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001016 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1017 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1018 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1019 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1020 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1021 llvm::Function *Fn);
1022
Chris Lattnerbed31442007-05-28 01:07:47 +00001023public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001024 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001025 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001026
John McCall8ed55a52010-09-02 09:58:18 +00001027 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001028 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001029 CGDebugInfo *getDebugInfo() {
1030 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001031 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001032 return DebugInfo;
1033 }
1034 void disableDebugInfo() { DisableDebugInfo = true; }
1035 void enableDebugInfo() { DisableDebugInfo = false; }
1036
John McCall31168b02011-06-15 23:02:42 +00001037 bool shouldUseFusedARCCalls() {
1038 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1039 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001040
David Blaikiebbafb8a2012-03-11 07:00:24 +00001041 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001042
Bill Wendlingf0724e82011-09-19 20:31:14 +00001043 /// Returns a pointer to the function's exception object and selector slot,
1044 /// which is assigned in every landing pad.
John McCallbd309292010-07-06 01:34:17 +00001045 llvm::Value *getExceptionSlot();
John McCall9b382dd2011-05-28 21:13:02 +00001046 llvm::Value *getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001047
Bill Wendling79a70e42011-09-15 18:57:19 +00001048 /// Returns the contents of the function's exception object and selector
1049 /// slots.
1050 llvm::Value *getExceptionFromSlot();
1051 llvm::Value *getSelectorFromSlot();
1052
John McCallad5d61e2010-07-23 21:56:41 +00001053 llvm::Value *getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001054
John McCallbd309292010-07-06 01:34:17 +00001055 llvm::BasicBlock *getUnreachableBlock() {
1056 if (!UnreachableBlock) {
1057 UnreachableBlock = createBasicBlock("unreachable");
1058 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1059 }
1060 return UnreachableBlock;
1061 }
1062
1063 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001064 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001065 return getInvokeDestImpl();
1066 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001067
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001068 bool currentFunctionUsesSEHTry() const {
1069 const auto *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl);
1070 return FD && FD->usesSEHTry();
1071 }
1072
John McCallc8e01702013-04-16 22:48:15 +00001073 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001074 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001075
Daniel Dunbar12347492009-02-23 17:26:39 +00001076 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001077 // Cleanups
1078 //===--------------------------------------------------------------------===//
1079
1080 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1081
John McCall178360e2011-07-11 08:38:19 +00001082 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1083 llvm::Value *arrayEndPointer,
1084 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001085 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001086 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1087 llvm::Value *arrayEnd,
1088 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001089 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001090
John McCall4bd0fb12011-07-12 16:41:08 +00001091 void pushDestroy(QualType::DestructionKind dtorKind,
1092 llvm::Value *addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001093 void pushEHDestroy(QualType::DestructionKind dtorKind,
1094 llvm::Value *addr, QualType type);
John McCall82fe67b2011-07-09 01:37:26 +00001095 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001096 Destroyer *destroyer, bool useEHCleanupForArray);
Richard Smith736a9472013-06-12 20:42:33 +00001097 void pushLifetimeExtendedDestroy(CleanupKind kind, llvm::Value *addr,
1098 QualType type, Destroyer *destroyer,
1099 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001100 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1101 llvm::Value *CompletePtr,
1102 QualType ElementType);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001103 void pushStackRestore(CleanupKind kind, llvm::Value *SPMem);
Peter Collingbourne1425b452012-01-26 03:33:36 +00001104 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001105 bool useEHCleanupForArray);
David Blaikieebe87e12013-08-27 23:57:18 +00001106 llvm::Function *generateDestroyHelper(llvm::Constant *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001107 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001108 bool useEHCleanupForArray,
1109 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001110 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001111 QualType type, Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001112 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001113
Peter Collingbourne1425b452012-01-26 03:33:36 +00001114 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001115
John McCall82fe67b2011-07-09 01:37:26 +00001116 /// Determines whether an EH cleanup is required to destroy a type
1117 /// with the given destruction kind.
1118 bool needsEHCleanup(QualType::DestructionKind kind) {
1119 switch (kind) {
1120 case QualType::DK_none:
1121 return false;
1122 case QualType::DK_cxx_destructor:
1123 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001124 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001125 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001126 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001127 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1128 }
1129 llvm_unreachable("bad destruction kind");
1130 }
1131
John McCall4bd0fb12011-07-12 16:41:08 +00001132 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1133 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1134 }
1135
John McCall82fe67b2011-07-09 01:37:26 +00001136 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001137 // Objective-C
1138 //===--------------------------------------------------------------------===//
1139
Chris Lattner4bd55962008-03-30 23:03:07 +00001140 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001141
David Blaikief1425802015-01-14 00:04:42 +00001142 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001143
Mike Stumpfc496822009-02-08 23:14:22 +00001144 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001145 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1146 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001147 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001148 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001149 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001150 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001151
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001152 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1153 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001154
Mike Stumpfc496822009-02-08 23:14:22 +00001155 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1156 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001157 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1158 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001159 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001160 const ObjCPropertyImplDecl *propImpl,
1161 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian08b0f662010-04-13 00:38:05 +00001162 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001163 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001164
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001165 //===--------------------------------------------------------------------===//
1166 // Block Bits
1167 //===--------------------------------------------------------------------===//
1168
John McCall351762c2011-02-07 10:33:21 +00001169 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001170 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1171 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garstfc83aa02010-02-23 21:51:17 +00001172 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001173 const CGBlockInfo &Info,
Chris Lattner2192fe52011-07-18 04:24:23 +00001174 llvm::StructType *,
John McCallad7c5c12011-02-08 08:22:06 +00001175 llvm::Constant *BlockVarLayout);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001176
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001177 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001178 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001179 const DeclMapTy &ldm,
1180 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001181
John McCallad7c5c12011-02-08 08:22:06 +00001182 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1183 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001184 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1185 const ObjCPropertyImplDecl *PID);
1186 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1187 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001188 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001189
John McCallad7c5c12011-02-08 08:22:06 +00001190 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1191
John McCall73064872011-03-31 01:59:53 +00001192 class AutoVarEmission;
1193
1194 void emitByrefStructureInit(const AutoVarEmission &emission);
1195 void enterByrefCleanup(const AutoVarEmission &emission);
1196
John McCall351762c2011-02-07 10:33:21 +00001197 llvm::Value *LoadBlockStruct() {
1198 assert(BlockPointer && "no block pointer set!");
1199 return BlockPointer;
1200 }
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001201
John McCall87fe5d52010-05-20 01:18:31 +00001202 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCall113bee02012-03-10 09:33:50 +00001203 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall351762c2011-02-07 10:33:21 +00001204 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2192fe52011-07-18 04:24:23 +00001205 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001206
John McCalla738c252011-03-09 04:27:21 +00001207 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1208 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001209 /// \brief Emit code for the start of a function.
1210 /// \param Loc The location to be associated with the function.
1211 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001212 void StartFunction(GlobalDecl GD,
1213 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001214 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001215 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001216 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001217 SourceLocation Loc = SourceLocation(),
1218 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001219
John McCallb81884d2010-02-19 09:25:03 +00001220 void EmitConstructorBody(FunctionArgList &Args);
1221 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001222 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001223 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Bob Wilsonbf854f02014-02-17 19:21:09 +00001224 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, RegionCounter &Cnt);
John McCall89b12b32010-02-18 03:17:58 +00001225
Faisal Vali571df122013-09-29 08:45:24 +00001226 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001227 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001228 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001229 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001230 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1231 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001232 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001233
David Blaikiea0a1a872015-01-18 02:48:07 +00001234 /// \brief Emit the unified return block, trying to avoid its emission when
1235 /// possible.
1236 /// \return The debug location of the user written return statement if the
1237 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001238 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001239
Mike Stumpfc496822009-02-08 23:14:22 +00001240 /// FinishFunction - Complete IR generation of the current function. It is
1241 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001242 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001243
Nico Weber1bebad12015-02-11 22:33:32 +00001244 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1245 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001246
Reid Kleckner3f76ac72014-07-26 01:30:05 +00001247 void EmitCallAndReturnForThunk(llvm::Value *Callee, const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001248
Reid Klecknerab2090d2014-07-26 01:34:32 +00001249 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1250 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1251 llvm::Value *Callee);
1252
Anders Carlssonbad991d2010-03-24 00:39:18 +00001253 /// GenerateThunk - Generate a thunk for the given method.
John McCalla738c252011-03-09 04:27:21 +00001254 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1255 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001256
Eli Friedman49a94b12011-05-06 17:27:27 +00001257 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1258 GlobalDecl GD, const ThunkInfo &Thunk);
1259
Douglas Gregor94f9a482010-05-05 05:51:00 +00001260 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1261 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001262
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001263 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
David Blaikie66e41972015-01-14 07:38:27 +00001264 ArrayRef<VarDecl *> ArrayIndexes);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001265
Anders Carlssone87fae92010-03-28 19:40:00 +00001266 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1267 /// subobject.
1268 ///
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001269 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001270 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001271 CharUnits OffsetFromNearestVBase,
Anders Carlssone87fae92010-03-28 19:40:00 +00001272 const CXXRecordDecl *VTableClass);
1273
1274 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001275 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001276 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001277 CharUnits OffsetFromNearestVBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001278 bool BaseIsNonVirtualPrimaryBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001279 const CXXRecordDecl *VTableClass,
1280 VisitedVirtualBasesSetTy& VBases);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001281
Anders Carlssond5895932010-03-28 21:07:49 +00001282 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001283
Dan Gohman8fc50c22010-10-26 18:44:08 +00001284 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1285 /// to by This.
Chris Lattner2192fe52011-07-18 04:24:23 +00001286 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssone87fae92010-03-28 19:40:00 +00001287
Peter Collingbourned2926c92015-03-14 02:42:25 +00001288 /// \brief Derived is the presumed address of an object of type T after a
1289 /// cast. If T is a polymorphic class type, emit a check that the virtual
1290 /// table for Derived belongs to a class derived from T.
1291 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
1292 bool MayBeNull);
1293
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001294 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1295 /// If vptr CFI is enabled, emit a check that VTable is valid.
1296 void EmitVTablePtrCheckForCall(const CXXMethodDecl *MD, llvm::Value *VTable);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001297
Peter Collingbourned2926c92015-03-14 02:42:25 +00001298 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
1299 /// RD using llvm.bitset.test.
1300 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable);
1301
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001302 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1303 /// expr can be devirtualized.
1304 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1305 const CXXMethodDecl *MD);
1306
John McCallf99a6312010-07-21 05:30:47 +00001307 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1308 /// given phase of destruction for a destructor. The end result
1309 /// should call destructors on members and base classes in reverse
1310 /// order of their construction.
1311 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001312
Chris Lattner3c77a352010-06-22 00:03:40 +00001313 /// ShouldInstrumentFunction - Return true if the current function should be
1314 /// instrumented with __cyg_profile_func_* calls
1315 bool ShouldInstrumentFunction();
1316
1317 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1318 /// instrumentation function with the current function and the call site, if
1319 /// function instrumentation is enabled.
1320 void EmitFunctionInstrumentation(const char *Fn);
1321
Roman Divacky178e01602011-02-10 16:52:03 +00001322 /// EmitMCountInstrumentation - Emit call to .mcount.
1323 void EmitMCountInstrumentation();
1324
Mike Stumpfc496822009-02-08 23:14:22 +00001325 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1326 /// arguments for the given function. This is also responsible for naming the
1327 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001328 void EmitFunctionProlog(const CGFunctionInfo &FI,
1329 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001330 const FunctionArgList &Args);
1331
Mike Stumpfc496822009-02-08 23:14:22 +00001332 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1333 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001334 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1335 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001336
Mike Stump1d849212009-12-07 23:38:24 +00001337 /// EmitStartEHSpec - Emit the start of the exception spec.
1338 void EmitStartEHSpec(const Decl *D);
1339
1340 /// EmitEndEHSpec - Emit the end of the exception spec.
1341 void EmitEndEHSpec(const Decl *D);
1342
John McCallbd309292010-07-06 01:34:17 +00001343 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1344 llvm::BasicBlock *getTerminateLandingPad();
1345
1346 /// getTerminateHandler - Return a handler (not a landing pad, just
1347 /// a catch handler) that just calls terminate. This is used when
1348 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001349 llvm::BasicBlock *getTerminateHandler();
1350
Chris Lattnera5f58b02011-07-09 17:41:47 +00001351 llvm::Type *ConvertTypeForMem(QualType T);
1352 llvm::Type *ConvertType(QualType T);
1353 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001354 return ConvertType(getContext().getTypeDeclType(T));
1355 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001356
Mike Stumpfc496822009-02-08 23:14:22 +00001357 /// LoadObjCSelf - Load the value of self. This function is only valid while
1358 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001359 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001360
1361 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001362 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001363
Chris Lattner54fb19e2007-06-22 22:02:34 +00001364 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1365 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001366 static TypeEvaluationKind getEvaluationKind(QualType T);
1367
1368 static bool hasScalarEvaluationKind(QualType T) {
1369 return getEvaluationKind(T) == TEK_Scalar;
1370 }
1371
1372 static bool hasAggregateEvaluationKind(QualType T) {
1373 return getEvaluationKind(T) == TEK_Aggregate;
1374 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001375
1376 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001377 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001378 llvm::Function *parent = nullptr,
1379 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001380#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001381 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001382#else
John McCallad7c5c12011-02-08 08:22:06 +00001383 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001384#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001385 }
Mike Stumpfc496822009-02-08 23:14:22 +00001386
Chris Lattnerac248202007-05-30 00:13:02 +00001387 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1388 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001389 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001390
Mike Stumpe5311b02009-11-30 20:08:49 +00001391 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1392 /// another basic block, simplify it. This assumes that no other code could
1393 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001394 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1395
Mike Stumpfc496822009-02-08 23:14:22 +00001396 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1397 /// adding a fall-through branch from the current insert block if
1398 /// necessary. It is legal to call this function even if there is no current
1399 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001400 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001401 /// IsFinished - If true, indicates that the caller has finished emitting
1402 /// branches to the given block and does not expect to emit code into it. This
1403 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001404 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001405
John McCall8e4c74b2011-08-11 02:22:43 +00001406 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1407 /// near its uses, and leave the insertion point in it.
1408 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1409
Mike Stumpfc496822009-02-08 23:14:22 +00001410 /// EmitBranch - Emit a branch to the specified basic block from the current
1411 /// insert block, taking care to avoid creation of branches from dummy
1412 /// blocks. It is legal to call this function even if there is no current
1413 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001414 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001415 /// This function clears the current insertion point. The caller should follow
1416 /// calls to this function with calls to Emit*Block prior to generation new
1417 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001418 void EmitBranch(llvm::BasicBlock *Block);
1419
Mike Stumpfc496822009-02-08 23:14:22 +00001420 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1421 /// indicates that the current code being emitted is unreachable.
1422 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001423 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001424 }
1425
Mike Stumpfc496822009-02-08 23:14:22 +00001426 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1427 /// emitted IR has a place to go. Note that by definition, if this function
1428 /// creates a block then that block is unreachable; callers may do better to
1429 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001430 void EnsureInsertPoint() {
1431 if (!HaveInsertPoint())
1432 EmitBlock(createBasicBlock());
1433 }
Mike Stumpfc496822009-02-08 23:14:22 +00001434
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001435 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001436 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001437 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001438
Chris Lattnere9a64532007-06-22 21:44:33 +00001439 //===--------------------------------------------------------------------===//
1440 // Helpers
1441 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001442
Eli Friedmana0544d62011-12-03 04:14:32 +00001443 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1444 CharUnits Alignment = CharUnits()) {
Dan Gohman947c9af2010-10-14 23:06:10 +00001445 return LValue::MakeAddr(V, T, Alignment, getContext(),
1446 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001447 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001448
David Majnemer99281062014-09-18 22:05:54 +00001449 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001450
Chris Lattnere9a64532007-06-22 21:44:33 +00001451 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001452 /// block. The caller is responsible for setting an appropriate alignment on
1453 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001454 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001455 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001456
John McCall2e6567a2010-04-22 01:10:34 +00001457 /// InitTempAlloca - Provide an initial value for the given alloca.
1458 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1459
Daniel Dunbard0049182010-02-16 19:44:13 +00001460 /// CreateIRTemp - Create a temporary IR object of the given type, with
1461 /// appropriate alignment. This routine should only be used when an temporary
1462 /// value needs to be stored into an alloca (for example, to avoid explicit
1463 /// PHI construction), but the type is the IR type, not the type appropriate
1464 /// for storing in memory.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001465 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001466
Daniel Dunbara7566f12010-02-09 02:48:28 +00001467 /// CreateMemTemp - Create a temporary memory object of the given type, with
1468 /// appropriate alignment.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001469 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001470
John McCall7a626f62010-09-15 10:14:12 +00001471 /// CreateAggTemp - Create a temporary memory object for the given
1472 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001473 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedman38cd36d2011-12-03 02:13:40 +00001474 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001475 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1476 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001477 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001478 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001479 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001480 }
1481
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001482 /// CreateInAllocaTmp - Create a temporary memory object for the given
1483 /// aggregate type.
1484 AggValueSlot CreateInAllocaTmp(QualType T, const Twine &Name = "inalloca");
1485
John McCallad7c5c12011-02-08 08:22:06 +00001486 /// Emit a cast to void* in the appropriate address space.
1487 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1488
Chris Lattner8394d792007-06-05 20:53:16 +00001489 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1490 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001491 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001492
John McCalla2342eb2010-12-05 02:00:02 +00001493 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1494 void EmitIgnoredExpr(const Expr *E);
1495
Chris Lattner4647a212007-08-31 22:49:20 +00001496 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1497 /// any type. The result is returned as an RValue struct. If this is an
1498 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1499 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001500 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001501 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001502 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001503 AggValueSlot aggSlot = AggValueSlot::ignored(),
1504 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001505
Mike Stumpfc496822009-02-08 23:14:22 +00001506 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1507 // or the value of the expression, depending on how va_list is defined.
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001508 llvm::Value *EmitVAListRef(const Expr *E);
1509
Mike Stumpfc496822009-02-08 23:14:22 +00001510 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1511 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001512 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001513
John McCall91ca10f2011-03-08 09:11:50 +00001514 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001515 /// arbitrary expression into the given memory location.
John McCall21886962010-04-21 10:05:39 +00001516 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001517 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001518
David Majnemer7c237072015-03-05 00:46:22 +00001519 void EmitAnyExprToExn(const Expr *E, llvm::Value *Addr);
1520
John McCall91ca10f2011-03-08 09:11:50 +00001521 /// EmitExprAsInit - Emits the code necessary to initialize a
1522 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001523 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001524 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001525
Fariborz Jahanian78652202013-01-25 23:57:05 +00001526 /// hasVolatileMember - returns true if aggregate type has a volatile
1527 /// member.
1528 bool hasVolatileMember(QualType T) {
1529 if (const RecordType *RT = T->getAs<RecordType>()) {
1530 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1531 return RD->hasVolatileMember();
1532 }
1533 return false;
1534 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001535 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001536 ///
1537 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1538 /// This is required for correctness when assigning non-POD structures in C++.
1539 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001540 QualType EltTy) {
1541 bool IsVolatile = hasVolatileMember(EltTy);
1542 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1543 true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001544 }
1545
David Majnemerfd1e7392015-02-03 23:04:06 +00001546 void EmitAggregateCopyCtor(llvm::Value *DestPtr, llvm::Value *SrcPtr,
1547 QualType DestTy, QualType SrcTy) {
1548 CharUnits DestTypeAlign = getContext().getTypeAlignInChars(DestTy);
1549 CharUnits SrcTypeAlign = getContext().getTypeAlignInChars(SrcTy);
1550 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
1551 std::min(DestTypeAlign, SrcTypeAlign),
1552 /*IsAssignment=*/false);
1553 }
1554
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001555 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001556 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001557 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001558 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001559 /// \param isAssignment - If false, allow padding to be copied. This often
1560 /// yields more efficient.
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001561 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001562 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001563 CharUnits Alignment = CharUnits::Zero(),
1564 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001565
Devang Patelda5d6bb2007-10-04 23:45:31 +00001566 /// StartBlock - Start new block named N. If insert block is a dummy block
1567 /// then reuse it.
1568 void StartBlock(const char *N);
1569
Anders Carlsson9396a892008-09-11 09:15:33 +00001570 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall5d865c322010-08-31 07:33:07 +00001571 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1572 llvm::Value *Res = LocalDeclMap[VD];
1573 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1574 return Res;
1575 }
Mike Stumpfc496822009-02-08 23:14:22 +00001576
John McCallc07a0c72011-02-17 10:25:35 +00001577 /// getOpaqueLValueMapping - Given an opaque value expression (which
1578 /// must be mapped to an l-value), return its mapping.
1579 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1580 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1581
1582 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1583 it = OpaqueLValues.find(e);
1584 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1585 return it->second;
1586 }
1587
1588 /// getOpaqueRValueMapping - Given an opaque value expression (which
1589 /// must be mapped to an r-value), return its mapping.
1590 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1591 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1592
1593 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1594 it = OpaqueRValues.find(e);
1595 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001596 return it->second;
1597 }
1598
Dan Gohman75d69da2008-05-22 00:50:06 +00001599 /// getAccessedFieldNo - Given an encoded value and a result number, return
1600 /// the input field number being accessed.
1601 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1602
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001603 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001604 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001605
Anders Carlssonc0964b62010-05-22 17:35:42 +00001606 /// EmitNullInitialization - Generate code to set a value of the given type to
1607 /// null, If the type contains data member pointers, they will be initialized
1608 /// to -1 in accordance with the Itanium C++ ABI.
1609 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001610
1611 // EmitVAArg - Generate code to get an argument from the passed in pointer
1612 // and update it accordingly. The return value is a pointer to the argument.
1613 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001614 // instruction in LLVM instead once it works well enough.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001615 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001616
John McCall82fe67b2011-07-09 01:37:26 +00001617 /// emitArrayLength - Compute the length of an array, even if it's a
1618 /// VLA, and drill down to the base element type.
1619 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1620 QualType &baseType,
1621 llvm::Value *&addr);
1622
John McCall23c29fe2011-06-24 21:55:10 +00001623 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1624 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001625 ///
1626 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001627 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001628
John McCall23c29fe2011-06-24 21:55:10 +00001629 /// getVLASize - Returns an LLVM value that corresponds to the size,
1630 /// in non-variably-sized elements, of a variable length array type,
1631 /// plus that largest non-variably-sized element type. Assumes that
1632 /// the type has already been emitted with EmitVariablyModifiedType.
1633 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1634 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001635
Anders Carlssona5d077d2009-04-14 16:58:56 +00001636 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1637 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001638 llvm::Value *LoadCXXThis() {
1639 assert(CXXThisValue && "no 'this' value for this function");
1640 return CXXThisValue;
1641 }
Mike Stump11289f42009-09-09 15:08:12 +00001642
Anders Carlssone36a6b32010-01-02 01:01:18 +00001643 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1644 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001645 // FIXME: Every place that calls LoadCXXVTT is something
1646 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001647 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001648 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1649 return CXXStructorImplicitParamValue;
1650 }
1651
1652 /// LoadCXXStructorImplicitParam - Load the implicit parameter
1653 /// for a constructor/destructor.
1654 llvm::Value *LoadCXXStructorImplicitParam() {
1655 assert(CXXStructorImplicitParamValue &&
1656 "no implicit argument value for this function");
1657 return CXXStructorImplicitParamValue;
John McCall347132b2010-02-16 22:04:33 +00001658 }
John McCall6ce74722010-02-16 04:15:37 +00001659
1660 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001661 /// complete class to the given direct base.
1662 llvm::Value *
1663 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1664 const CXXRecordDecl *Derived,
1665 const CXXRecordDecl *Base,
1666 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001667
Mike Stumpe5311b02009-11-30 20:08:49 +00001668 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1669 /// load of 'this' and returns address of the base class.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001670 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001671 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001672 CastExpr::path_const_iterator PathBegin,
1673 CastExpr::path_const_iterator PathEnd,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001674 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00001675
Anders Carlsson8c793172009-11-23 17:57:54 +00001676 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001677 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001678 CastExpr::path_const_iterator PathBegin,
1679 CastExpr::path_const_iterator PathEnd,
Anders Carlsson8c793172009-11-23 17:57:54 +00001680 bool NullCheckValue);
1681
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001682 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1683 /// base constructor/destructor with virtual bases.
1684 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1685 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1686 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1687 bool Delegating);
1688
John McCallf8ff7b92010-02-23 00:48:20 +00001689 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1690 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00001691 const FunctionArgList &Args,
1692 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001693 // It's important not to confuse this and the previous function. Delegating
1694 // constructors are the C++0x feature. The constructor delegate optimization
1695 // is used to reduce duplication in the base and complete consturctors where
1696 // they are substantially the same.
1697 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1698 const FunctionArgList &Args);
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001699 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001700 bool ForVirtualBase, bool Delegating,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001701 llvm::Value *This, const CXXConstructExpr *E);
1702
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001703 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1704 llvm::Value *This, llvm::Value *Src,
Alexey Samsonov525bf652014-08-25 21:58:56 +00001705 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001706
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001707 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001708 const ConstantArrayType *ArrayTy,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001709 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001710 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001711 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001712
Anders Carlssond49844b2009-09-23 02:45:36 +00001713 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1714 llvm::Value *NumElements,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001715 llvm::Value *ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001716 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001717 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001718
John McCall82fe67b2011-07-09 01:37:26 +00001719 static Destroyer destroyCXXObject;
1720
Anders Carlsson0a637412009-05-29 21:03:38 +00001721 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001722 bool ForVirtualBase, bool Delegating,
1723 llvm::Value *This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001724
John McCall99210dc2011-09-15 06:49:18 +00001725 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
David Blaikiefb901c7a2015-04-04 15:12:29 +00001726 llvm::Type *ElementTy, llvm::Value *NewPtr,
1727 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00001728 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00001729
Peter Collingbourne702b2842011-11-27 22:09:22 +00001730 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1731 llvm::Value *Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001732
David Majnemerdc012fa2015-04-22 21:38:15 +00001733 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
1734 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
1735
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001736 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001737 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001738
Eli Friedman24f55432009-11-18 00:57:03 +00001739 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1740 QualType DeleteTy);
1741
Richard Smith760520b2014-06-03 23:27:44 +00001742 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1743 const Expr *Arg, bool IsDelete);
1744
Mike Stumpc9b231c2009-11-15 08:09:41 +00001745 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stump65511702009-11-16 06:50:58 +00001746 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Nico Webercf4ff5862012-10-11 10:13:44 +00001747 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001748
Richard Smith69d0d262012-08-24 00:54:33 +00001749 /// \brief Situations in which we might emit a check for the suitability of a
1750 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001751 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001752 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001753 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001754 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001755 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001756 /// Checking the bound value in a reference binding. Must be suitably sized
1757 /// and aligned, but is not required to refer to an object (until the
1758 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001759 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001760 /// Checking the object expression in a non-static data member access. Must
1761 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001762 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001763 /// Checking the 'this' pointer for a call to a non-static member function.
1764 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001765 TCK_MemberCall,
1766 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001767 TCK_ConstructorCall,
1768 /// Checking the operand of a static_cast to a derived pointer type. Must be
1769 /// null or an object within its lifetime.
1770 TCK_DowncastPointer,
1771 /// Checking the operand of a static_cast to a derived reference type. Must
1772 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001773 TCK_DowncastReference,
1774 /// Checking the operand of a cast to a base object. Must be suitably sized
1775 /// and aligned.
1776 TCK_Upcast,
1777 /// Checking the operand of a cast to a virtual base object. Must be an
1778 /// object within its lifetime.
1779 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00001780 };
1781
Alexey Samsonovac4afe42014-07-07 23:59:57 +00001782 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
1783 /// calls to EmitTypeCheck can be skipped.
1784 bool sanitizePerformTypeCheck() const;
1785
Richard Smith4d1458e2012-09-08 02:08:36 +00001786 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001787 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001788 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00001789 QualType Type, CharUnits Alignment = CharUnits::Zero(),
1790 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001791
Richard Smith539e4a72013-02-23 02:53:19 +00001792 /// \brief Emit a check that \p Base points into an array object, which
1793 /// we can access at index \p Index. \p Accessed should be \c false if we
1794 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1795 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1796 QualType IndexType, bool Accessed);
1797
Chris Lattner116ce8f2010-01-09 21:40:03 +00001798 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1799 bool isInc, bool isPre);
1800 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1801 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00001802
1803 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00001804 llvm::Value *OffsetValue = nullptr) {
1805 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
1806 OffsetValue);
1807 }
Hal Finkelbcc06082014-09-07 22:58:14 +00001808
Chris Lattner8394d792007-06-05 20:53:16 +00001809 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001810 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001811 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001812
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001813 /// EmitDecl - Emit a declaration.
1814 ///
1815 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001816 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001817
John McCall1c9c3fd2010-10-15 04:57:14 +00001818 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001819 ///
1820 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001821 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001822
David Blaikie73ca5692014-12-09 00:32:22 +00001823 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001824 bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00001825 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001826
John McCallbd309292010-07-06 01:34:17 +00001827 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1828 llvm::Value *Address);
1829
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001830 /// \brief Determine whether the given initializer is trivial in the sense
1831 /// that it requires no code to be generated.
1832 bool isTrivialInitializer(const Expr *Init);
1833
John McCall1c9c3fd2010-10-15 04:57:14 +00001834 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001835 ///
1836 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00001837 void EmitAutoVarDecl(const VarDecl &D);
1838
1839 class AutoVarEmission {
1840 friend class CodeGenFunction;
1841
John McCall9e2e22f2011-02-22 07:16:58 +00001842 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00001843
1844 /// The alignment of the variable.
1845 CharUnits Alignment;
1846
1847 /// The address of the alloca. Null if the variable was emitted
1848 /// as a global constant.
1849 llvm::Value *Address;
1850
1851 llvm::Value *NRVOFlag;
1852
1853 /// True if the variable is a __block variable.
1854 bool IsByRef;
1855
1856 /// True if the variable is of aggregate type and has a constant
1857 /// initializer.
1858 bool IsConstantAggregate;
1859
Nadav Rotem1da30942013-03-23 06:43:35 +00001860 /// Non-null if we should use lifetime annotations.
1861 llvm::Value *SizeForLifetimeMarkers;
1862
John McCall9e2e22f2011-02-22 07:16:58 +00001863 struct Invalid {};
Craig Topper8a13c412014-05-21 05:09:00 +00001864 AutoVarEmission(Invalid) : Variable(nullptr) {}
John McCall9e2e22f2011-02-22 07:16:58 +00001865
John McCallc533cb72011-02-22 06:44:22 +00001866 AutoVarEmission(const VarDecl &variable)
Craig Topper8a13c412014-05-21 05:09:00 +00001867 : Variable(&variable), Address(nullptr), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00001868 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00001869 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00001870
Craig Topper8a13c412014-05-21 05:09:00 +00001871 bool wasEmittedAsGlobal() const { return Address == nullptr; }
John McCallc533cb72011-02-22 06:44:22 +00001872
1873 public:
John McCall9e2e22f2011-02-22 07:16:58 +00001874 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1875
Craig Topper8a13c412014-05-21 05:09:00 +00001876 bool useLifetimeMarkers() const {
1877 return SizeForLifetimeMarkers != nullptr;
1878 }
Nadav Rotem1da30942013-03-23 06:43:35 +00001879 llvm::Value *getSizeForLifetimeMarkers() const {
1880 assert(useLifetimeMarkers());
1881 return SizeForLifetimeMarkers;
1882 }
1883
1884 /// Returns the raw, allocated address, which is not necessarily
1885 /// the address of the object itself.
1886 llvm::Value *getAllocatedAddress() const {
1887 return Address;
1888 }
1889
John McCallc533cb72011-02-22 06:44:22 +00001890 /// Returns the address of the object within this declaration.
1891 /// Note that this does not chase the forwarding pointer for
1892 /// __block decls.
1893 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1894 if (!IsByRef) return Address;
1895
David Blaikie1ed728c2015-04-05 22:45:47 +00001896 auto F = CGF.getByRefValueLLVMField(Variable);
1897 return CGF.Builder.CreateStructGEP(F.first, Address, F.second,
John McCall9e2e22f2011-02-22 07:16:58 +00001898 Variable->getNameAsString());
John McCallc533cb72011-02-22 06:44:22 +00001899 }
1900 };
1901 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1902 void EmitAutoVarInit(const AutoVarEmission &emission);
1903 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00001904 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1905 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001906
John McCall1c9c3fd2010-10-15 04:57:14 +00001907 void EmitStaticVarDecl(const VarDecl &D,
1908 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001909
1910 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001911 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, bool ArgIsPointer,
1912 unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00001913
John McCallc07a0c72011-02-17 10:25:35 +00001914 /// protectFromPeepholes - Protect a value that we're intending to
1915 /// store to the side, but which will probably be used later, from
1916 /// aggressive peepholing optimizations that might delete it.
1917 ///
1918 /// Pass the result to unprotectFromPeepholes to declare that
1919 /// protection is no longer required.
1920 ///
1921 /// There's no particular reason why this shouldn't apply to
1922 /// l-values, it's just that no existing peepholes work on pointers.
1923 PeepholeProtection protectFromPeepholes(RValue rvalue);
1924 void unprotectFromPeepholes(PeepholeProtection protection);
1925
Chris Lattner84915fa2007-06-02 04:16:21 +00001926 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00001927 // Statement Emission
1928 //===--------------------------------------------------------------------===//
1929
Mike Stumpfc496822009-02-08 23:14:22 +00001930 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001931 void EmitStopPoint(const Stmt *S);
1932
Mike Stumpfc496822009-02-08 23:14:22 +00001933 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1934 /// this function even if there is no current insertion point.
1935 ///
1936 /// This function may clear the current insertion point; callers should use
1937 /// EnsureInsertPoint if they wish to subsequently generate code without first
1938 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00001939 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001940
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001941 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00001942 /// necessarily require an insertion point or debug information; typically
1943 /// because the statement amounts to a jump or a container of other
1944 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001945 ///
1946 /// \return True if the statement was handled.
1947 bool EmitSimpleStmt(const Stmt *S);
1948
Eli Friedman4871a462013-06-10 22:04:49 +00001949 llvm::Value *EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
1950 AggValueSlot AVS = AggValueSlot::ignored());
1951 llvm::Value *EmitCompoundStmtWithoutScope(const CompoundStmt &S,
1952 bool GetLast = false,
1953 AggValueSlot AVS =
1954 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001955
Mike Stumpfc496822009-02-08 23:14:22 +00001956 /// EmitLabel - Emit the block for the given label. It is legal to call this
1957 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001958 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001959
Chris Lattnerac248202007-05-30 00:13:02 +00001960 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00001961 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00001962 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001963 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00001964 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001965
1966 void EmitCondBrHints(llvm::LLVMContext &Context, llvm::BranchInst *CondBr,
Craig Topper3cb91b22014-08-27 06:28:16 +00001967 ArrayRef<const Attr *> Attrs);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001968 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00001969 ArrayRef<const Attr *> Attrs = None);
1970 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00001971 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00001972 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00001973 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00001974 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001975 void EmitBreakStmt(const BreakStmt &S);
1976 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00001977 void EmitSwitchStmt(const SwitchStmt &S);
1978 void EmitDefaultStmt(const DefaultStmt &S);
1979 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00001980 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00001981 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00001982
Anders Carlsson2e744e82008-08-30 19:51:14 +00001983 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001984 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
1985 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00001986 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00001987 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00001988
John McCallb609d3f2010-07-07 06:56:46 +00001989 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
1990 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00001991
Anders Carlsson52d78a52009-09-27 18:58:34 +00001992 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00001993 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00001994 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001995 void EnterSEHTryStmt(const SEHTryStmt &S);
1996 void ExitSEHTryStmt(const SEHTryStmt &S);
1997
1998 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, StringRef Name,
1999 QualType RetTy, FunctionArgList &Args,
2000 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002001
2002 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2003 const SEHExceptStmt &Except);
2004
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002005 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2006 const SEHFinallyStmt &Finally);
2007
Reid Kleckner1d59f992015-01-22 01:36:17 +00002008 void EmitSEHExceptionCodeSave();
2009 llvm::Value *EmitSEHExceptionCode();
2010 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002011 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002012
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002013 /// Scan the outlined statement for captures from the parent function. For
2014 /// each capture, mark the capture as escaped and emit a call to
2015 /// llvm.framerecover. Insert the framerecover result into the LocalDeclMap.
2016 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
2017 llvm::Value *ParentFP);
2018
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002019 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002020 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002021
Alexey Bataev330de032014-10-29 12:21:55 +00002022 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002023 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002024 void GenerateCapturedStmtFunctionProlog(const CapturedStmt &S);
2025 llvm::Function *GenerateCapturedStmtFunctionEpilog(const CapturedStmt &S);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002026 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev9959db52014-05-06 10:08:46 +00002027 llvm::Value *GenerateCapturedStmtArgument(const CapturedStmt &S);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002028 /// \brief Perform element by element copying of arrays with type \a
2029 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2030 /// generated by \a CopyGen.
2031 ///
2032 /// \param DestAddr Address of the destination array.
2033 /// \param SrcAddr Address of the source array.
2034 /// \param OriginalType Type of destination and source arrays.
2035 /// \param CopyGen Copying procedure that copies value of single array element
2036 /// to another single array element.
2037 void EmitOMPAggregateAssign(
2038 llvm::Value *DestAddr, llvm::Value *SrcAddr, QualType OriginalType,
2039 const llvm::function_ref<void(llvm::Value *, llvm::Value *)> &CopyGen);
2040 /// \brief Emit proper copying of data from one variable to another.
2041 ///
2042 /// \param OriginalType Original type of the copied variables.
2043 /// \param DestAddr Destination address.
2044 /// \param SrcAddr Source address.
2045 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2046 /// type of the base array element).
2047 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2048 /// the base array element).
2049 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2050 /// DestVD.
2051 void EmitOMPCopy(CodeGenFunction &CGF, QualType OriginalType,
2052 llvm::Value *DestAddr, llvm::Value *SrcAddr,
2053 const VarDecl *DestVD, const VarDecl *SrcVD,
2054 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002055 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2056 /// \a X = \a E \a BO \a E.
2057 ///
2058 /// \param X Value to be updated.
2059 /// \param E Update value.
2060 /// \param BO Binary operation for update operation.
2061 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2062 /// expression, false otherwise.
2063 /// \param AO Atomic ordering of the generated atomic instructions.
2064 /// \param CommonGen Code generator for complex expressions that cannot be
2065 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002066 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2067 /// generated, <false, RValue::get(nullptr)> otherwise.
2068 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002069 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2070 llvm::AtomicOrdering AO, SourceLocation Loc,
2071 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002072 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002073 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002074 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2075 OMPPrivateScope &PrivateScope);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002076 /// \brief Emit code for copyin clause in \a D directive. The next code is
2077 /// generated at the start of outlined functions for directives:
2078 /// \code
2079 /// threadprivate_var1 = master_threadprivate_var1;
2080 /// operator=(threadprivate_var2, master_threadprivate_var2);
2081 /// ...
2082 /// __kmpc_barrier(&loc, global_tid);
2083 /// \endcode
2084 ///
2085 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2086 /// \returns true if at least one copyin variable is found, false otherwise.
2087 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002088 /// \brief Emit initial code for lastprivate variables. If some variable is
2089 /// not also firstprivate, then the default initialization is used. Otherwise
2090 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2091 /// method.
2092 ///
2093 /// \param D Directive that may have 'lastprivate' directives.
2094 /// \param PrivateScope Private scope for capturing lastprivate variables for
2095 /// proper codegen in internal captured statement.
2096 ///
2097 /// \returns true if there is at least one lastprivate variable, false
2098 /// otherwise.
2099 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2100 OMPPrivateScope &PrivateScope);
2101 /// \brief Emit final copying of lastprivate values to original variables at
2102 /// the end of the worksharing or simd directive.
2103 ///
2104 /// \param D Directive that has at least one 'lastprivate' directives.
2105 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2106 /// it is the last iteration of the loop code in associated directive, or to
2107 /// 'i1 false' otherwise.
2108 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
2109 llvm::Value *IsLastIterCond);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002110 /// \brief Emit initial code for reduction variables. Creates reduction copies
2111 /// and initializes them with the values according to OpenMP standard.
2112 ///
2113 /// \param D Directive (possibly) with the 'reduction' clause.
2114 /// \param PrivateScope Private scope for capturing reduction variables for
2115 /// proper codegen in internal captured statement.
2116 ///
2117 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2118 OMPPrivateScope &PrivateScope);
2119 /// \brief Emit final update of reduction values to original variables at
2120 /// the end of the directive.
2121 ///
2122 /// \param D Directive that has at least one 'reduction' directives.
2123 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002124
2125 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002126 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002127 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002128 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002129 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002130 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002131 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002132 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002133 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002134 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002135 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002136 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002137 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002138 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002139 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002140 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002141 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002142 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002143 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002144 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002145 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002146
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002147 /// \brief Emit inner loop of the worksharing/simd construct.
2148 ///
2149 /// \param S Directive, for which the inner loop must be emitted.
2150 /// \param RequiresCleanup true, if directive has some associated private
2151 /// variables.
2152 /// \param LoopCond Bollean condition for loop continuation.
2153 /// \param IncExpr Increment expression for loop control variable.
2154 /// \param BodyGen Generator for the inner body of the inner loop.
2155 /// \param PostIncGen Genrator for post-increment code (required for ordered
2156 /// loop directvies).
2157 void EmitOMPInnerLoop(
2158 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2159 const Expr *IncExpr,
2160 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2161 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002162
Alexander Musmanc6388682014-12-15 07:07:06 +00002163private:
2164
2165 /// Helpers for the OpenMP loop directives.
Alexander Musmand196ef22014-10-07 08:57:09 +00002166 void EmitOMPLoopBody(const OMPLoopDirective &Directive,
2167 bool SeparateIter = false);
Alexander Musmana5f070a2014-10-01 06:03:56 +00002168 void EmitOMPSimdFinal(const OMPLoopDirective &S);
Alexey Bataev38e89532015-04-16 04:54:05 +00002169 /// \brief Emit code for the worksharing loop-based directive.
2170 /// \return true, if this construct has any lastprivate clause, false -
2171 /// otherwise.
2172 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Alexander Musmandf7a8e22015-01-22 08:49:35 +00002173 void EmitOMPForOuterLoop(OpenMPScheduleClauseKind ScheduleKind,
2174 const OMPLoopDirective &S,
2175 OMPPrivateScope &LoopScope, llvm::Value *LB,
2176 llvm::Value *UB, llvm::Value *ST, llvm::Value *IL,
2177 llvm::Value *Chunk);
Alexander Musmanc6388682014-12-15 07:07:06 +00002178
2179public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002180
Chris Lattner208ae962007-05-30 17:57:17 +00002181 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002182 // LValue Expression Emission
2183 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002184
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002185 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2186 RValue GetUndefRValue(QualType Ty);
2187
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002188 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2189 /// and issue an ErrorUnsupported style diagnostic (using the
2190 /// provided Name).
2191 RValue EmitUnsupportedRValue(const Expr *E,
2192 const char *Name);
2193
Mike Stumpfc496822009-02-08 23:14:22 +00002194 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2195 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002196 LValue EmitUnsupportedLValue(const Expr *E,
2197 const char *Name);
2198
Chris Lattner8394d792007-06-05 20:53:16 +00002199 /// EmitLValue - Emit code to compute a designator that specifies the location
2200 /// of the expression.
2201 ///
2202 /// This can return one of two things: a simple address or a bitfield
2203 /// reference. In either case, the LLVM Value* in the LValue structure is
2204 /// guaranteed to be an LLVM pointer type.
2205 ///
2206 /// If this returns a bitfield reference, nothing about the pointee type of
2207 /// the LLVM value is known: For example, it may not be a pointer to an
2208 /// integer.
2209 ///
2210 /// If this returns a normal address, and if the lvalue's C type is fixed
2211 /// size, this method guarantees that the returned pointer type will point to
2212 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2213 /// variable length type, this is not possible.
2214 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002215 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002216
Richard Smith4d1458e2012-09-08 02:08:36 +00002217 /// \brief Same as EmitLValue but additionally we generate checking code to
2218 /// guard against undefined behavior. This is only suitable when we know
2219 /// that the address will be used to access the object.
2220 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002221
Nick Lewycky2d84e842013-10-02 02:29:49 +00002222 RValue convertTempToRValue(llvm::Value *addr, QualType type,
2223 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002224
John McCalla8ec7eb2013-03-07 21:37:17 +00002225 void EmitAtomicInit(Expr *E, LValue lvalue);
2226
David Majnemera5b195a2015-02-14 01:35:12 +00002227 bool LValueIsSuitableForInlineAtomic(LValue Src);
2228 bool typeIsSuitableForInlineAtomic(QualType Ty, bool IsVolatile) const;
2229
2230 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2231 AggValueSlot Slot = AggValueSlot::ignored());
2232
Nick Lewycky2d84e842013-10-02 02:29:49 +00002233 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002234 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002235 AggValueSlot slot = AggValueSlot::ignored());
2236
2237 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2238
David Majnemera5b195a2015-02-14 01:35:12 +00002239 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2240 bool IsVolatile, bool isInit);
2241
Alexey Bataevb4505a72015-03-30 05:20:59 +00002242 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002243 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
2244 llvm::AtomicOrdering Success = llvm::SequentiallyConsistent,
2245 llvm::AtomicOrdering Failure = llvm::SequentiallyConsistent,
2246 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2247
Alexey Bataevb4505a72015-03-30 05:20:59 +00002248 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
2249 const std::function<RValue(RValue)> &UpdateOp,
2250 bool IsVolatile);
2251
John McCall3a7f6922010-10-27 20:58:56 +00002252 /// EmitToMemory - Change a scalar value from its value
2253 /// representation to its in-memory representation.
2254 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2255
2256 /// EmitFromMemory - Change a scalar value from its memory
2257 /// representation to its value representation.
2258 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2259
Daniel Dunbar1d425462009-02-10 00:57:50 +00002260 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2261 /// care to appropriately convert from the memory representation to
2262 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002263 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman947c9af2010-10-14 23:06:10 +00002264 unsigned Alignment, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002265 SourceLocation Loc,
Craig Topper8a13c412014-05-21 05:09:00 +00002266 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002267 QualType TBAABaseTy = QualType(),
2268 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002269
2270 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2271 /// care to appropriately convert from the memory representation to
2272 /// the LLVM value representation. The l-value must be a simple
2273 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002274 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002275
2276 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2277 /// care to appropriately convert from the memory representation to
2278 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002279 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman947c9af2010-10-14 23:06:10 +00002280 bool Volatile, unsigned Alignment, QualType Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00002281 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002282 QualType TBAABaseTy = QualType(),
2283 uint64_t TBAAOffset = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002284
2285 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2286 /// care to appropriately convert from the memory representation to
2287 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002288 /// l-value. The isInit flag indicates whether this is an initialization.
2289 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2290 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002291
Chris Lattner8394d792007-06-05 20:53:16 +00002292 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2293 /// this method emits the address of the lvalue, then loads the result as an
2294 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002295 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002296 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2297 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002298 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002299
Chris Lattner8394d792007-06-05 20:53:16 +00002300 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2301 /// lvalue, where both are guaranteed to the have the same type, and that type
2302 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002303 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002304 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002305 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002306
Nick Lewycky2d84e842013-10-02 02:29:49 +00002307 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2308 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002309 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002310 /// \param Result [out] - If non-null, this will be set to a Value* for the
2311 /// bit-field contents after the store, appropriate for use as the result of
2312 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002313 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002314 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002315
John McCall4f29b492010-11-16 23:07:28 +00002316 /// Emit an l-value for an assignment (simple or compound) of complex type.
2317 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002318 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002319 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2320 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002321
Chris Lattner57540c52011-04-15 05:22:18 +00002322 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002323 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002324 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002325 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002326 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002327 // Note: only available for agg return types
2328 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002329 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Renato Golin230c5eb2014-05-19 18:15:42 +00002330 LValue EmitReadRegister(const VarDecl *VD);
Chris Lattner4347e3692007-06-06 04:54:52 +00002331 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002332 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002333 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002334 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002335 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2336 bool Accessed = false);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002337 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002338 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002339 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002340 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002341 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002342 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002343 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002344 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002345 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002346
2347 llvm::Value *EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002348
Nick Lewycky2d84e842013-10-02 02:29:49 +00002349 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002350
John McCall71335052012-03-10 03:05:10 +00002351 class ConstantEmission {
2352 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2353 ConstantEmission(llvm::Constant *C, bool isReference)
2354 : ValueAndIsReference(C, isReference) {}
2355 public:
2356 ConstantEmission() {}
2357 static ConstantEmission forReference(llvm::Constant *C) {
2358 return ConstantEmission(C, true);
2359 }
2360 static ConstantEmission forValue(llvm::Constant *C) {
2361 return ConstantEmission(C, false);
2362 }
2363
Aaron Ballman67347662015-02-15 22:00:28 +00002364 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002365 return ValueAndIsReference.getOpaqueValue() != nullptr;
2366 }
John McCall71335052012-03-10 03:05:10 +00002367
2368 bool isReference() const { return ValueAndIsReference.getInt(); }
2369 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2370 assert(isReference());
2371 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2372 refExpr->getType());
2373 }
2374
2375 llvm::Constant *getValue() const {
2376 assert(!isReference());
2377 return ValueAndIsReference.getPointer();
2378 }
2379 };
2380
John McCall113bee02012-03-10 09:33:50 +00002381 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002382
John McCallfe96e0b2011-11-06 09:01:30 +00002383 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2384 AggValueSlot slot = AggValueSlot::ignored());
2385 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2386
Daniel Dunbar722f4242009-04-22 05:08:15 +00002387 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002388 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002389 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002390 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002391
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002392 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2393 /// if the Field is a reference, this will return the address of the reference
2394 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002395 LValue EmitLValueForFieldInitialization(LValue Base,
2396 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002397
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002398 LValue EmitLValueForIvar(QualType ObjectTy,
2399 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002400 unsigned CVRQualifiers);
2401
Anders Carlsson3be22e22009-05-30 23:23:33 +00002402 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002403 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002404 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002405 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002406 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002407
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002408 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002409 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002410 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002411 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002412 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002413 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002414
Chris Lattnerd7f58862007-06-02 05:24:33 +00002415 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002416 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002417 //===--------------------------------------------------------------------===//
2418
Mike Stumpfc496822009-02-08 23:14:22 +00002419 /// EmitCall - Generate a call of the given function, expecting the given
2420 /// result type, and using the given argument list which specifies both the
2421 /// LLVM arguments and the types they were derived from.
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002422 ///
Mike Stumpe5311b02009-11-30 20:08:49 +00002423 /// \param TargetDecl - If given, the decl of the function in a direct call;
2424 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbard931a872009-02-02 22:03:45 +00002425 RValue EmitCall(const CGFunctionInfo &FnInfo,
2426 llvm::Value *Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00002427 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002428 const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00002429 const Decl *TargetDecl = nullptr,
2430 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00002431
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002432 RValue EmitCall(QualType FnType, llvm::Value *Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002433 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00002434 const Decl *TargetDecl = nullptr,
2435 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002436 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002437 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002438
John McCall882987f2013-02-28 19:01:20 +00002439 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2440 const Twine &name = "");
2441 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2442 ArrayRef<llvm::Value*> args,
2443 const Twine &name = "");
2444 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2445 const Twine &name = "");
2446 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2447 ArrayRef<llvm::Value*> args,
2448 const Twine &name = "");
2449
John McCallbd309292010-07-06 01:34:17 +00002450 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002451 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002452 const Twine &Name = "");
Jay Foad5bd375a2011-07-15 08:37:34 +00002453 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002454 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002455 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2456 ArrayRef<llvm::Value*> args,
2457 const Twine &name = "");
2458 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2459 const Twine &name = "");
2460 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2461 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002462
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002463 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2464 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002465 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002466
2467 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2468 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002469 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002470
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00002471 RValue
2472 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2473 ReturnValueSlot ReturnValue, llvm::Value *This,
2474 llvm::Value *ImplicitParam,
2475 QualType ImplicitParamTy, const CallExpr *E);
David Majnemer0c0b6d92014-10-31 20:09:12 +00002476 RValue EmitCXXStructorCall(const CXXMethodDecl *MD, llvm::Value *Callee,
2477 ReturnValueSlot ReturnValue, llvm::Value *This,
2478 llvm::Value *ImplicitParam,
2479 QualType ImplicitParamTy, const CallExpr *E,
2480 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002481 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2482 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00002483 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
2484 const CXXMethodDecl *MD,
2485 ReturnValueSlot ReturnValue,
2486 bool HasQualifier,
2487 NestedNameSpecifier *Qualifier,
2488 bool IsArrow, const Expr *Base);
2489 // Compute the object pointer.
Anders Carlssonbfb36712009-12-24 21:13:40 +00002490 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2491 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002492
Anders Carlsson4034a952009-05-27 04:18:27 +00002493 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002494 const CXXMethodDecl *MD,
2495 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002496
Peter Collingbournefe883422011-10-06 18:29:37 +00002497 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2498 ReturnValueSlot ReturnValue);
2499
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002500
Mike Stump11289f42009-09-09 15:08:12 +00002501 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00002502 unsigned BuiltinID, const CallExpr *E,
2503 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00002504
Anders Carlssonbfb36712009-12-24 21:13:40 +00002505 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002506
Mike Stumpfc496822009-02-08 23:14:22 +00002507 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2508 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002509 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2510
Kevin Qin1718af62013-11-14 02:45:18 +00002511 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
2512 const llvm::CmpInst::Predicate Fp,
2513 const llvm::CmpInst::Predicate Ip,
2514 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00002515 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00002516
2517 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
2518 unsigned LLVMIntrinsic,
2519 unsigned AltLLVMIntrinsic,
2520 const char *NameHint,
2521 unsigned Modifier,
2522 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00002523 SmallVectorImpl<llvm::Value *> &Ops,
Craig Topper8a13c412014-05-21 05:09:00 +00002524 llvm::Value *Align = nullptr);
Tim Northover8fe03d62014-02-21 11:57:24 +00002525 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
2526 unsigned Modifier, llvm::Type *ArgTy,
2527 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002528 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002529 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002530 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002531 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002532 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002533 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002534 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00002535 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
2536 llvm::Type *Ty, bool usgn, const char *name);
Tim Northover573cbee2014-05-24 12:52:07 +00002537 // Helper functions for EmitAArch64BuiltinExpr.
Tim Northovera2ee4332014-03-29 15:09:45 +00002538 llvm::Value *vectorWrapScalar8(llvm::Value *Op);
2539 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
2540 llvm::Value *emitVectorWrappedScalar8Intrinsic(
2541 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
2542 llvm::Value *emitVectorWrappedScalar16Intrinsic(
2543 unsigned Int, SmallVectorImpl<llvm::Value *> &Ops, const char *Name);
Tim Northover573cbee2014-05-24 12:52:07 +00002544 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northovera2ee4332014-03-29 15:09:45 +00002545 llvm::Value *EmitNeon64Call(llvm::Function *F,
2546 llvm::SmallVectorImpl<llvm::Value *> &O,
2547 const char *name);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002548
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002549 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002550 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2551 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault56f008d2014-06-24 20:45:01 +00002552 llvm::Value *EmitR600BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00002553 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002554
Daniel Dunbar66912a12008-08-20 00:28:19 +00002555 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002556 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002557 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002558 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2559 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2560 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00002561 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002562 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002563 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2564 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002565
John McCall31168b02011-06-15 23:02:42 +00002566 /// Retrieves the default cleanup kind for an ARC cleanup.
2567 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2568 CleanupKind getARCCleanupKind() {
2569 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2570 ? NormalAndEHCleanup : NormalCleanup;
2571 }
2572
2573 // ARC primitives.
2574 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2575 void EmitARCDestroyWeak(llvm::Value *addr);
2576 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2577 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2578 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2579 bool ignored);
2580 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2581 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2582 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2583 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002584 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002585 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002586 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002587 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002588 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2589 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002590 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCallcdda29c2013-03-13 03:10:54 +00002591 void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise);
2592 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCall31168b02011-06-15 23:02:42 +00002593 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2594 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2595 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2596 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2597
2598 std::pair<LValue,llvm::Value*>
2599 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2600 std::pair<LValue,llvm::Value*>
2601 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2602
John McCall248512a2011-10-01 10:32:24 +00002603 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2604
John McCall31168b02011-06-15 23:02:42 +00002605 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2606 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2607 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2608
John McCallff613032011-10-04 06:23:45 +00002609 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002610 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2611 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2612
Craig Topper00bbdcf2014-06-28 23:22:23 +00002613 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00002614
John McCall82fe67b2011-07-09 01:37:26 +00002615 static Destroyer destroyARCStrongImprecise;
2616 static Destroyer destroyARCStrongPrecise;
2617 static Destroyer destroyARCWeak;
2618
John McCall31168b02011-06-15 23:02:42 +00002619 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2620 llvm::Value *EmitObjCAutoreleasePoolPush();
2621 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2622 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2623 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2624
Richard Smitha1c9d4d2013-06-12 23:38:09 +00002625 /// \brief Emits a reference binding to the passed in expression.
2626 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002627
Chris Lattner6278e6a2007-08-11 00:04:45 +00002628 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002629 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002630 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002631
2632 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002633
2634 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2635 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002636 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002637
Chris Lattner3474c202007-08-26 06:48:56 +00002638 /// EmitScalarConversion - Emit a conversion from the specified type to the
2639 /// specified destination type, both of which are LLVM scalar types.
2640 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2641 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002642
Chris Lattner42e6b812007-08-26 16:34:22 +00002643 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stumpfc496822009-02-08 23:14:22 +00002644 /// complex type to the specified destination type, where the destination type
2645 /// is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002646 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2647 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002648
2649
John McCall7a626f62010-09-15 10:14:12 +00002650 /// EmitAggExpr - Emit the computation of the specified expression
2651 /// of aggregate type. The result is computed into the given slot,
2652 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002653 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002654
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002655 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2656 /// aggregate type into a temporary LValue.
2657 LValue EmitAggExprToLValue(const Expr *E);
2658
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002659 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2660 /// pointers.
2661 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian879d7262009-08-31 19:33:16 +00002662 QualType Ty);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002663
John McCall1bd25562011-06-24 23:21:27 +00002664 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2665 /// make sure it survives garbage collection until this point.
2666 void EmitExtendGCLifetime(llvm::Value *object);
2667
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002668 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002669 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002670 ComplexPairTy EmitComplexExpr(const Expr *E,
2671 bool IgnoreReal = false,
2672 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002673
John McCall47fb9502013-03-07 21:37:08 +00002674 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2675 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002676 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002677
John McCall47fb9502013-03-07 21:37:08 +00002678 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00002679 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00002680
2681 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002682 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002683
Chandler Carruth84537952012-03-30 19:44:53 +00002684 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2685 /// global variable that has already been created for it. If the initializer
2686 /// has a different type than GV does, this may free GV and return a different
2687 /// one. Otherwise it just returns GV.
2688 llvm::GlobalVariable *
2689 AddInitializerToStaticVarDecl(const VarDecl &D,
2690 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002691
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002692
Anders Carlssonf40886a2009-08-08 21:45:14 +00002693 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2694 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002695 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2696 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002697
David Majnemerb3341ea2014-10-05 05:05:40 +00002698 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
2699 llvm::Constant *Addr);
2700
John McCallc84ed6a2012-05-01 06:13:13 +00002701 /// Call atexit() with a function that passes the given argument to
2702 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00002703 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
2704 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002705
John McCallcdf7ef52010-11-06 09:44:32 +00002706 /// Emit code in this function to perform a guarded variable
2707 /// initialization. Guarded initializations are used when it's not
2708 /// possible to prove that an initialization will be done exactly
2709 /// once, e.g. with a static local variable or a static data member
2710 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002711 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002712 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002713
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002714 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2715 /// variables.
2716 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00002717 ArrayRef<llvm::Function *> CXXThreadLocals,
Craig Topper8a13c412014-05-21 05:09:00 +00002718 llvm::GlobalVariable *Guard = nullptr);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002719
John McCallee08c532012-04-06 18:21:03 +00002720 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002721 /// variables.
John McCallee08c532012-04-06 18:21:03 +00002722 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2723 const std::vector<std::pair<llvm::WeakVH,
2724 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002725
John McCalla738c252011-03-09 04:27:21 +00002726 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2727 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00002728 llvm::GlobalVariable *Addr,
2729 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002730
John McCall7a626f62010-09-15 10:14:12 +00002731 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002732
2733 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian50198092010-12-02 17:02:11 +00002734 const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00002735
John McCall08ef4662011-11-10 08:15:53 +00002736 void enterFullExpression(const ExprWithCleanups *E) {
2737 if (E->getNumObjects() == 0) return;
2738 enterNonTrivialFullExpression(E);
2739 }
2740 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00002741
Richard Smithea852322013-05-07 21:53:22 +00002742 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00002743
Eli Friedmanc370a7e2012-02-09 03:32:31 +00002744 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2745
Craig Topper8a13c412014-05-21 05:09:00 +00002746 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = nullptr);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00002747
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002748 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002749 // Annotations Emission
2750 //===--------------------------------------------------------------------===//
2751
2752 /// Emit an annotation call (intrinsic or builtin).
2753 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2754 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002755 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002756 SourceLocation Location);
2757
2758 /// Emit local annotations for the local variable V, declared by D.
2759 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2760
2761 /// Emit field annotations for the given field & value. Returns the
2762 /// annotation result.
2763 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2764
2765 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002766 // Internal Helpers
2767 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002768
Chris Lattner5b1964b2008-11-11 07:41:27 +00002769 /// ContainsLabel - Return true if the statement contains a label in it. If
2770 /// this statement is not executed normally, it not containing a label means
2771 /// that we can just remove the code.
2772 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002773
Chris Lattner29911cc2011-02-28 00:18:40 +00002774 /// containsBreak - Return true if the statement contains a break out of it.
2775 /// If the statement (recursively) contains a switch or loop with a break
2776 /// inside of it, this is fine.
2777 static bool containsBreak(const Stmt *S);
2778
Daniel Dunbar682712c2008-11-12 10:12:14 +00002779 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00002780 /// to a constant, or if it does but contains a label, return false. If it
2781 /// constant folds return true and set the boolean result in Result.
2782 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00002783
Chris Lattner29911cc2011-02-28 00:18:40 +00002784 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2785 /// to a constant, or if it does but contains a label, return false. If it
2786 /// constant folds return true and set the folded value.
Richard Trieuc320c742012-07-23 20:21:35 +00002787 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattner29911cc2011-02-28 00:18:40 +00002788
Chris Lattnercd439292008-11-12 08:04:58 +00002789 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2790 /// if statement) to the specified blocks. Based on the condition, this might
2791 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00002792 /// TrueCount should be the number of times we expect the condition to
2793 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00002794 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00002795 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00002796
Richard Smithe30752c2012-10-09 19:52:38 +00002797 /// \brief Emit a description of a type in a format suitable for passing to
2798 /// a runtime sanitizer handler.
2799 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2800
2801 /// \brief Convert a value into a format suitable for passing to a runtime
2802 /// sanitizer handler.
2803 llvm::Value *EmitCheckValue(llvm::Value *V);
2804
2805 /// \brief Emit a description of a source location in a format suitable for
2806 /// passing to a runtime sanitizer handler.
2807 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2808
Richard Smithde670682012-11-01 22:15:34 +00002809 /// \brief Create a basic block that will call a handler function in a
2810 /// sanitizer runtime with the provided arguments, and create a conditional
2811 /// branch to it.
Alexey Samsonove396bfc2014-11-11 22:03:54 +00002812 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerKind>> Checked,
2813 StringRef CheckName, ArrayRef<llvm::Constant *> StaticArgs,
2814 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002815
Richard Smithde670682012-11-01 22:15:34 +00002816 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2817 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00002818 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00002819
Anders Carlsson093bdff2010-03-30 03:27:09 +00002820 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00002821 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00002822
John McCall23f66262010-05-26 22:34:26 +00002823 /// EmitDelegateCallArg - We are performing a delegate call; that
2824 /// is, the current function is delegating to another one. Produce
2825 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002826 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
2827 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00002828
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002829 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2830 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00002831 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002832
Chris Lattnercd439292008-11-12 08:04:58 +00002833private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00002834 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002835 void EmitReturnOfRValue(RValue RV, QualType Ty);
2836
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002837 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
2838
2839 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
2840 DeferredReplacements;
2841
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002842 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2843 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2844 ///
2845 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002846 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
2847 SmallVectorImpl<llvm::Argument *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002848
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002849 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
2850 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
2851 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
2852 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
2853 SmallVectorImpl<llvm::Value *> &IRCallArgs,
2854 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00002855
Chad Rosier59df25b2012-08-23 20:00:18 +00002856 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00002857 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00002858
Chad Rosier59df25b2012-08-23 20:00:18 +00002859 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00002860 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002861 std::string &ConstraintStr,
2862 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00002863
Reid Kleckner89077a12013-12-17 19:46:40 +00002864public:
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002865 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00002866 template <typename T>
2867 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002868 CallExpr::const_arg_iterator ArgBeg,
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002869 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002870 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00002871 unsigned ParamsToSkip = 0) {
Reid Kleckner739756c2013-12-04 19:23:12 +00002872 SmallVector<QualType, 16> ArgTypes;
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002873 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002874
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002875 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
2876 "Can't skip parameters if type info is not provided");
2877 if (CallArgTypeInfo) {
2878 // First, use the argument types that the type info knows about
2879 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
2880 E = CallArgTypeInfo->param_type_end();
2881 I != E; ++I, ++Arg) {
2882 assert(Arg != ArgEnd && "Running over edge of argument list!");
Alexey Bataev7cb17892014-12-18 06:54:53 +00002883 assert(
2884 ((*I)->isVariablyModifiedType() ||
2885 getContext()
2886 .getCanonicalType((*I).getNonReferenceType())
2887 .getTypePtr() ==
2888 getContext().getCanonicalType(Arg->getType()).getTypePtr()) &&
2889 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002890 ArgTypes.push_back(*I);
2891 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00002892 }
Mike Stump11289f42009-09-09 15:08:12 +00002893
Reid Kleckner739756c2013-12-04 19:23:12 +00002894 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00002895 // function.
2896 assert(
2897 (Arg == ArgEnd || !CallArgTypeInfo || CallArgTypeInfo->isVariadic()) &&
2898 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00002899
Anders Carlsson603d6af2009-04-18 20:20:22 +00002900 // If we still have any arguments, emit them using the type of the argument.
Reid Kleckner739756c2013-12-04 19:23:12 +00002901 for (; Arg != ArgEnd; ++Arg)
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002902 ArgTypes.push_back(getVarArgType(*Arg));
Adrian Prantlca64c3e2013-07-26 20:42:57 +00002903
David Blaikie835afb22015-01-21 23:08:17 +00002904 EmitCallArgs(Args, ArgTypes, ArgBeg, ArgEnd, CalleeDecl, ParamsToSkip);
Anders Carlsson603d6af2009-04-18 20:20:22 +00002905 }
John McCalld4f4b7f2010-03-03 04:15:11 +00002906
Reid Kleckner739756c2013-12-04 19:23:12 +00002907 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
2908 CallExpr::const_arg_iterator ArgBeg,
Richard Smith760520b2014-06-03 23:27:44 +00002909 CallExpr::const_arg_iterator ArgEnd,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002910 const FunctionDecl *CalleeDecl = nullptr,
David Blaikie835afb22015-01-21 23:08:17 +00002911 unsigned ParamsToSkip = 0);
Reid Kleckner739756c2013-12-04 19:23:12 +00002912
Reid Kleckner89077a12013-12-17 19:46:40 +00002913private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00002914 QualType getVarArgType(const Expr *Arg);
2915
John McCalld4f4b7f2010-03-03 04:15:11 +00002916 const TargetCodeGenInfo &getTargetHooks() const {
2917 return CGM.getTargetCodeGenInfo();
2918 }
John McCall09ae0322010-07-06 23:57:41 +00002919
2920 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00002921
2922 CodeGenModule::ByrefHelpers *
Chris Lattner2192fe52011-07-18 04:24:23 +00002923 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf9b056b2011-03-31 08:03:29 +00002924 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00002925
2926 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00002927
Eli Friedmana5dd5682012-08-23 03:10:17 +00002928 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2929 /// value and compute our best estimate of the alignment of the pointee.
2930 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00002931
2932 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00002933};
Mike Stump11289f42009-09-09 15:08:12 +00002934
John McCallce1de612011-01-26 04:00:11 +00002935/// Helper class with most of the code for saving a value for a
2936/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00002937struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00002938 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2939
2940 /// Answer whether the given value needs extra work to be saved.
2941 static bool needsSaving(llvm::Value *value) {
2942 // If it's not an instruction, we don't need to save.
2943 if (!isa<llvm::Instruction>(value)) return false;
2944
2945 // If it's an instruction in the entry block, we don't need to save.
2946 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2947 return (block != &block->getParent()->getEntryBlock());
2948 }
2949
2950 /// Try to save the given value.
2951 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2952 if (!needsSaving(value)) return saved_type(value, false);
2953
2954 // Otherwise we need an alloca.
2955 llvm::Value *alloca =
2956 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2957 CGF.Builder.CreateStore(value, alloca);
2958
2959 return saved_type(alloca, true);
2960 }
2961
2962 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2963 if (!value.getInt()) return value.getPointer();
2964 return CGF.Builder.CreateLoad(value.getPointer());
2965 }
2966};
2967
John McCallcb5f77f2011-01-28 10:53:53 +00002968/// A partial specialization of DominatingValue for llvm::Values that
2969/// might be llvm::Instructions.
2970template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2971 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00002972 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00002973 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2974 }
2975};
2976
2977/// A specialization of DominatingValue for RValue.
2978template <> struct DominatingValue<RValue> {
2979 typedef RValue type;
2980 class saved_type {
2981 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2982 AggregateAddress, ComplexAddress };
2983
2984 llvm::Value *Value;
2985 Kind K;
2986 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2987
2988 public:
2989 static bool needsSaving(RValue value);
2990 static saved_type save(CodeGenFunction &CGF, RValue value);
2991 RValue restore(CodeGenFunction &CGF);
2992
2993 // implementations in CGExprCXX.cpp
2994 };
2995
2996 static bool needsSaving(type value) {
2997 return saved_type::needsSaving(value);
2998 }
2999 static saved_type save(CodeGenFunction &CGF, type value) {
3000 return saved_type::save(CGF, value);
3001 }
3002 static type restore(CodeGenFunction &CGF, saved_type value) {
3003 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003004 }
3005};
3006
Chris Lattnerbed31442007-05-28 01:07:47 +00003007} // end namespace CodeGen
3008} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003009
Chris Lattnerbed31442007-05-28 01:07:47 +00003010#endif