blob: 586134023240b3f27dfa50c1c37206d756b00eab [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"
Vitaly Buka64c80b42016-10-26 05:42:30 +000024#include "VarBypassDetector.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000025#include "clang/AST/CharUnits.h"
26#include "clang/AST/ExprCXX.h"
27#include "clang/AST/ExprObjC.h"
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +000028#include "clang/AST/ExprOpenMP.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000029#include "clang/AST/Type.h"
30#include "clang/Basic/ABI.h"
Ben Langmuir3b4c30b2013-05-09 19:17:11 +000031#include "clang/Basic/CapturedStmt.h"
Alexander Musmandf7a8e22015-01-22 08:49:35 +000032#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000033#include "clang/Basic/TargetInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000034#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000035#include "llvm/ADT/ArrayRef.h"
36#include "llvm/ADT/DenseMap.h"
37#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000038#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000039#include "llvm/Support/Debug.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000040#include "llvm/Transforms/Utils/SanitizerStats.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000041
Chris Lattnerbed31442007-05-28 01:07:47 +000042namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000043class BasicBlock;
44class LLVMContext;
45class MDNode;
46class Module;
47class SwitchInst;
48class Twine;
49class Value;
50class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000051}
52
Chris Lattnerbed31442007-05-28 01:07:47 +000053namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000054class ASTContext;
55class BlockDecl;
56class CXXDestructorDecl;
57class CXXForRangeStmt;
58class CXXTryStmt;
59class Decl;
60class LabelDecl;
61class EnumConstantDecl;
62class FunctionDecl;
63class FunctionProtoType;
64class LabelStmt;
65class ObjCContainerDecl;
66class ObjCInterfaceDecl;
67class ObjCIvarDecl;
68class ObjCMethodDecl;
69class ObjCImplementationDecl;
70class ObjCPropertyImplDecl;
71class TargetInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000072class VarDecl;
73class ObjCForCollectionStmt;
74class ObjCAtTryStmt;
75class ObjCAtThrowStmt;
76class ObjCAtSynchronizedStmt;
77class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000078
Chris Lattnerbed31442007-05-28 01:07:47 +000079namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000080class CodeGenTypes;
John McCallb92ab1a2016-10-26 23:46:34 +000081class CGCallee;
Rafael Espindola42ae7452014-05-09 00:57:59 +000082class CGFunctionInfo;
83class CGRecordLayout;
84class CGBlockInfo;
85class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000086class BlockByrefHelpers;
87class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000088class BlockFlags;
89class BlockFieldFlags;
Alexey Bataev7292c292016-04-25 12:22:29 +000090class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000091class TargetCodeGenInfo;
Alexey Bataev24b5bae2016-04-28 09:23:51 +000092struct OMPTaskDataTy;
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000093struct CGCoroData;
Mike Stumpfc496822009-02-08 23:14:22 +000094
John McCall47fb9502013-03-07 21:37:08 +000095/// The kind of evaluation to perform on values of a particular
96/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
97/// CGExprAgg?
98///
99/// TODO: should vectors maybe be split out into their own thing?
100enum TypeEvaluationKind {
101 TEK_Scalar,
102 TEK_Complex,
103 TEK_Aggregate
104};
105
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000106#define LIST_SANITIZER_CHECKS \
107 SANITIZER_CHECK(AddOverflow, add_overflow, 0) \
108 SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \
109 SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \
110 SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \
111 SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \
112 SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \
113 SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0) \
114 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
115 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
116 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
117 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
118 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
119 SANITIZER_CHECK(NonnullReturn, nonnull_return, 0) \
120 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
121 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
122 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
Filipe Cabecinhasfe5e5af2017-01-06 14:40:12 +0000123 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000124 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
125
126enum SanitizerHandler {
127#define SANITIZER_CHECK(Enum, Name, Version) Enum,
128 LIST_SANITIZER_CHECKS
129#undef SANITIZER_CHECK
130};
131
Chris Lattnerbed31442007-05-28 01:07:47 +0000132/// CodeGenFunction - This class organizes the per-function state that is used
133/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000134class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000135 CodeGenFunction(const CodeGenFunction &) = delete;
136 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000137
138 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000139public:
John McCallad5d61e2010-07-23 21:56:41 +0000140 /// A jump destination is an abstract label, branching to which may
141 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000142 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000143 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000144 JumpDest(llvm::BasicBlock *Block,
145 EHScopeStack::stable_iterator Depth,
146 unsigned Index)
147 : Block(Block), ScopeDepth(Depth), Index(Index) {}
148
Craig Topper8a13c412014-05-21 05:09:00 +0000149 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000150 llvm::BasicBlock *getBlock() const { return Block; }
151 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
152 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000153
Nadav Rotem1da30942013-03-23 06:43:35 +0000154 // This should be used cautiously.
155 void setScopeDepth(EHScopeStack::stable_iterator depth) {
156 ScopeDepth = depth;
157 }
158
John McCallad5d61e2010-07-23 21:56:41 +0000159 private:
John McCallbd309292010-07-06 01:34:17 +0000160 llvm::BasicBlock *Block;
161 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000162 unsigned Index;
163 };
164
Chris Lattnerbed31442007-05-28 01:07:47 +0000165 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000166 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000167
Chris Lattner96d72562007-08-21 16:57:55 +0000168 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000169 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000170 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000171
Vitaly Buka64c80b42016-10-26 05:42:30 +0000172 // Stores variables for which we can't generate correct lifetime markers
173 // because of jumps.
174 VarBypassDetector Bypasses;
175
Alexander Musman515ad8c2014-05-22 08:54:05 +0000176 /// \brief CGBuilder insert helper. This function is called after an
177 /// instruction is created using Builder.
178 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
179 llvm::BasicBlock *BB,
180 llvm::BasicBlock::iterator InsertPt) const;
181
John McCalldec348f72013-05-03 07:33:41 +0000182 /// CurFuncDecl - Holds the Decl for the current outermost
183 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000184 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000185 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
186 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000187 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000188 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000189 llvm::Function *CurFn;
190
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000191 // Holds coroutine data if the current function is a coroutine. We use a
192 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
193 // in this header.
194 struct CGCoroInfo {
195 std::unique_ptr<CGCoroData> Data;
196 CGCoroInfo();
197 ~CGCoroInfo();
198 };
199 CGCoroInfo CurCoro;
200
Mike Stumpbee78dd2009-12-04 23:26:17 +0000201 /// CurGD - The GlobalDecl for the current function being compiled.
202 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000203
John McCall31168b02011-06-15 23:02:42 +0000204 /// PrologueCleanupDepth - The cleanup depth enclosing all the
205 /// cleanups associated with the parameters.
206 EHScopeStack::stable_iterator PrologueCleanupDepth;
207
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000208 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000209 JumpDest ReturnBlock;
210
John McCall7f416cc2015-09-08 08:05:57 +0000211 /// ReturnValue - The temporary alloca to hold the return
212 /// value. This is invalid iff the function has no return value.
213 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000214
Chris Lattner03df1222007-06-02 04:53:11 +0000215 /// AllocaInsertPoint - This is an instruction in the entry block before which
216 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000217 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000218
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000219 /// \brief API for captured statement code generation.
220 class CGCapturedStmtInfo {
221 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000222 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
223 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000224 explicit CGCapturedStmtInfo(const CapturedStmt &S,
225 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000226 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000227
228 RecordDecl::field_iterator Field =
229 S.getCapturedRecordDecl()->field_begin();
230 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
231 E = S.capture_end();
232 I != E; ++I, ++Field) {
233 if (I->capturesThis())
234 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000235 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000236 CaptureFields[I->getCapturedVar()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000237 else if (I->capturesVariableByCopy())
238 CaptureFields[I->getCapturedVar()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000239 }
240 }
241
242 virtual ~CGCapturedStmtInfo();
243
244 CapturedRegionKind getKind() const { return Kind; }
245
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000246 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000247 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000248 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000249
250 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000251 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000252 return CaptureFields.lookup(VD);
253 }
254
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000255 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
256 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000257
Alexey Bataev18095712014-10-10 12:19:54 +0000258 static bool classof(const CGCapturedStmtInfo *) {
259 return true;
260 }
261
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000262 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000263 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000264 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000265 CGF.EmitStmt(S);
266 }
267
268 /// \brief Get the name of the capture helper.
269 virtual StringRef getHelperName() const { return "__captured_stmt"; }
270
271 private:
272 /// \brief The kind of captured statement being generated.
273 CapturedRegionKind Kind;
274
275 /// \brief Keep the map between VarDecl and FieldDecl.
276 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
277
278 /// \brief The base address of the captured record, passed in as the first
279 /// argument of the parallel region function.
280 llvm::Value *ThisValue;
281
282 /// \brief Captured 'this' type.
283 FieldDecl *CXXThisFieldDecl;
284 };
285 CGCapturedStmtInfo *CapturedStmtInfo;
286
Alexey Bataevd157d472015-06-24 03:35:38 +0000287 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
288 class CGCapturedStmtRAII {
289 private:
290 CodeGenFunction &CGF;
291 CGCapturedStmtInfo *PrevCapturedStmtInfo;
292 public:
293 CGCapturedStmtRAII(CodeGenFunction &CGF,
294 CGCapturedStmtInfo *NewCapturedStmtInfo)
295 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
296 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
297 }
298 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
299 };
300
Alexey Samsonova0416102014-11-11 01:26:14 +0000301 /// \brief Sanitizers enabled for this function.
302 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000303
Alexey Samsonov24cad992014-07-17 18:46:27 +0000304 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
305 bool IsSanitizerScope;
306
307 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
308 class SanitizerScope {
309 CodeGenFunction *CGF;
310 public:
311 SanitizerScope(CodeGenFunction *CGF);
312 ~SanitizerScope();
313 };
314
Reid Kleckner19819442014-07-25 21:39:46 +0000315 /// In C++, whether we are code generating a thunk. This controls whether we
316 /// should emit cleanups.
317 bool CurFuncIsThunk;
318
John McCall31168b02011-06-15 23:02:42 +0000319 /// In ARC, whether we should autorelease the return value.
320 bool AutoreleaseResult;
321
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000322 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
323 /// potentially set the return value.
324 bool SawAsmBlock;
325
David Majnemer25eb1652016-03-01 19:42:53 +0000326 const FunctionDecl *CurSEHParent = nullptr;
327
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000328 /// True if the current function is an outlined SEH helper. This can be a
329 /// finally block or filter expression.
330 bool IsOutlinedSEHHelper;
331
John McCallad7c5c12011-02-08 08:22:06 +0000332 const CodeGen::CGBlockInfo *BlockInfo;
333 llvm::Value *BlockPointer;
334
Eli Friedman9fbeba02012-02-11 02:57:39 +0000335 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
336 FieldDecl *LambdaThisCaptureField;
337
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000338 /// \brief A mapping from NRVO variables to the flags used to indicate
339 /// when the NRVO has been applied to this variable.
340 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000341
John McCallbd309292010-07-06 01:34:17 +0000342 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000343 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000344 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000345
David Majnemer4e52d6f2015-12-12 05:39:21 +0000346 llvm::Instruction *CurrentFuncletPad = nullptr;
347
Tim Shen421119f2016-07-01 21:08:47 +0000348 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
349 llvm::Value *Addr;
350 llvm::Value *Size;
351
352 public:
353 CallLifetimeEnd(Address addr, llvm::Value *size)
354 : Addr(addr.getPointer()), Size(size) {}
355
356 void Emit(CodeGenFunction &CGF, Flags flags) override {
357 CGF.EmitLifetimeEnd(Size, Addr);
358 }
359 };
360
Richard Smith736a9472013-06-12 20:42:33 +0000361 /// Header for data within LifetimeExtendedCleanupStack.
362 struct LifetimeExtendedCleanupHeader {
363 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000364 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000365 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000366 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000367
Justin Bognerbdff2192015-07-01 00:59:27 +0000368 size_t getSize() const { return Size; }
369 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000370 };
John McCallbd309292010-07-06 01:34:17 +0000371
John McCallad5d61e2010-07-23 21:56:41 +0000372 /// i32s containing the indexes of the cleanup destinations.
373 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000374
375 unsigned NextCleanupDestIndex;
376
John McCall08ef4662011-11-10 08:15:53 +0000377 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
378 CGBlockInfo *FirstBlockInfo;
379
John McCall8e4c74b2011-08-11 02:22:43 +0000380 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
381 llvm::BasicBlock *EHResumeBlock;
382
Bill Wendlingf0724e82011-09-19 20:31:14 +0000383 /// The exception slot. All landing pads write the current exception pointer
384 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000385 llvm::Value *ExceptionSlot;
386
Bill Wendlingf0724e82011-09-19 20:31:14 +0000387 /// The selector slot. Under the MandatoryCleanup model, all landing pads
388 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000389 llvm::AllocaInst *EHSelectorSlot;
390
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000391 /// A stack of exception code slots. Entering an __except block pushes a slot
392 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
393 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000394 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000395
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000396 /// Value returned by __exception_info intrinsic.
397 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000398
John McCallbd309292010-07-06 01:34:17 +0000399 /// Emits a landing pad for the current EH stack.
400 llvm::BasicBlock *EmitLandingPad();
401
402 llvm::BasicBlock *getInvokeDestImpl();
403
John McCallce1de612011-01-26 04:00:11 +0000404 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000405 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
406 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000407 }
408
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000409public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000410 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
411 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000412 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000413
John McCall6b0feb72011-06-22 02:32:12 +0000414 /// A class controlling the emission of a finally block.
415 class FinallyInfo {
416 /// Where the catchall's edge through the cleanup should go.
417 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000418
John McCall6b0feb72011-06-22 02:32:12 +0000419 /// A function to call to enter the catch.
420 llvm::Constant *BeginCatchFn;
421
422 /// An i1 variable indicating whether or not the @finally is
423 /// running for an exception.
424 llvm::AllocaInst *ForEHVar;
425
426 /// An i8* variable into which the exception pointer to rethrow
427 /// has been saved.
428 llvm::AllocaInst *SavedExnVar;
429
430 public:
431 void enter(CodeGenFunction &CGF, const Stmt *Finally,
432 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
433 llvm::Constant *rethrowFn);
434 void exit(CodeGenFunction &CGF);
435 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000436
Reid Kleckner11c033e2015-02-12 23:40:45 +0000437 /// Returns true inside SEH __try blocks.
438 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
439
Reid Klecknera002bd52015-10-28 23:06:42 +0000440 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000441 bool isCleanupPadScope() const {
442 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
443 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000444
John McCallce1de612011-01-26 04:00:11 +0000445 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
446 /// current full-expression. Safe against the possibility that
447 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000448 template <class T, class... As>
449 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000450 // If we're not in a conditional branch, or if none of the
451 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000452 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000453 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000454
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000455 // Stash values in a tuple so we can guarantee the order of saves.
456 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
457 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000458
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000459 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000460 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000461 initFullExprCleanup();
462 }
463
Richard Smith736a9472013-06-12 20:42:33 +0000464 /// \brief Queue a cleanup to be pushed after finishing the current
465 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000466 template <class T, class... As>
467 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000468 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
469
470 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
471
472 size_t OldSize = LifetimeExtendedCleanupStack.size();
473 LifetimeExtendedCleanupStack.resize(
474 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
475
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000476 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000477 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000478 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
479 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000480 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000481 }
482
John McCallf4beacd2011-11-10 10:43:54 +0000483 /// Set up the last cleaup that was pushed as a conditional
484 /// full-expression cleanup.
485 void initFullExprCleanup();
486
John McCallbd309292010-07-06 01:34:17 +0000487 /// PushDestructorCleanup - Push a cleanup to call the
488 /// complete-object destructor of an object of the given type at the
489 /// given address. Does nothing if T is not a C++ class type with a
490 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000491 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000492
John McCall8680f872010-07-21 06:29:51 +0000493 /// PushDestructorCleanup - Push a cleanup to call the
494 /// complete-object variant of the given destructor on the object at
495 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000496 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000497
John McCallbd309292010-07-06 01:34:17 +0000498 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
499 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000500 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000501
John McCall824c2f52010-09-14 07:57:04 +0000502 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
503 /// The block cannot be reactivated. Pops it if it's the top of the
504 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000505 ///
506 /// \param DominatingIP - An instruction which is known to
507 /// dominate the current IP (if set) and which lies along
508 /// all paths of execution between the current IP and the
509 /// the point at which the cleanup comes into scope.
510 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
511 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000512
513 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
514 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000515 ///
516 /// \param DominatingIP - An instruction which is known to
517 /// dominate the current IP (if set) and which lies along
518 /// all paths of execution between the current IP and the
519 /// the point at which the cleanup comes into scope.
520 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
521 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000522
John McCallbd309292010-07-06 01:34:17 +0000523 /// \brief Enters a new scope for capturing cleanups, all of which
524 /// will be executed once the scope is exited.
525 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000526 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000527 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000528 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000529 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000530 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000531 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000532
Aaron Ballmanabc18922015-02-15 22:54:08 +0000533 RunCleanupsScope(const RunCleanupsScope &) = delete;
534 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000535
Eric Christophera9d34972011-10-19 00:43:52 +0000536 protected:
537 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000538
Douglas Gregor965f4502009-11-24 16:43:22 +0000539 public:
540 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000541 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000542 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000543 {
John McCallbd309292010-07-06 01:34:17 +0000544 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000545 LifetimeExtendedCleanupStackSize =
546 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000547 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000548 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000549 }
550
551 /// \brief Exit this cleanup scope, emitting any accumulated
552 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000553 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000554 if (PerformCleanup) {
555 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000556 CGF.PopCleanupBlocks(CleanupStackDepth,
557 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000558 }
559 }
560
561 /// \brief Determine whether this scope requires any cleanups.
562 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000563 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000564 }
565
566 /// \brief Force the emission of cleanups now, instead of waiting
567 /// until this object is destroyed.
568 void ForceCleanup() {
569 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000570 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000571 CGF.PopCleanupBlocks(CleanupStackDepth,
572 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000573 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000574 }
575 };
576
David Blaikie93be0b22014-08-22 21:37:04 +0000577 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000578 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000579 SmallVector<const LabelDecl*, 4> Labels;
580 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000581
Aaron Ballmanabc18922015-02-15 22:54:08 +0000582 LexicalScope(const LexicalScope &) = delete;
583 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000584
585 public:
586 /// \brief Enter a new cleanup scope.
587 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000588 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
589 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000590 if (CGDebugInfo *DI = CGF.getDebugInfo())
591 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
592 }
593
Nadav Rotem1da30942013-03-23 06:43:35 +0000594 void addLabel(const LabelDecl *label) {
595 assert(PerformCleanup && "adding label to dead scope?");
596 Labels.push_back(label);
597 }
598
Eric Christophera9d34972011-10-19 00:43:52 +0000599 /// \brief Exit this cleanup scope, emitting any accumulated
600 /// cleanups.
601 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000602 if (CGDebugInfo *DI = CGF.getDebugInfo())
603 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
604
Nadav Rotem1da30942013-03-23 06:43:35 +0000605 // If we should perform a cleanup, force them now. Note that
606 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000607 if (PerformCleanup) {
608 ApplyDebugLocation DL(CGF, Range.getEnd());
609 ForceCleanup();
610 }
Eric Christophera9d34972011-10-19 00:43:52 +0000611 }
612
613 /// \brief Force the emission of cleanups now, instead of waiting
614 /// until this object is destroyed.
615 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000616 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000617 RunCleanupsScope::ForceCleanup();
618
Nadav Rotem1da30942013-03-23 06:43:35 +0000619 if (!Labels.empty())
620 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000621 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000622
623 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000624 };
625
John McCall7f416cc2015-09-08 08:05:57 +0000626 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
627
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000628 /// \brief The scope used to remap some variables as private in the OpenMP
629 /// loop body (or other captured region emitted without outlining), and to
630 /// restore old vars back on exit.
631 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000632 DeclMapTy SavedLocals;
633 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000634
635 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000636 OMPPrivateScope(const OMPPrivateScope &) = delete;
637 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000638
639 public:
640 /// \brief Enter a new OpenMP private scope.
641 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
642
643 /// \brief Registers \a LocalVD variable as a private and apply \a
644 /// PrivateGen function for it to generate corresponding private variable.
645 /// \a PrivateGen returns an address of the generated private variable.
646 /// \return true if the variable is registered as private, false if it has
647 /// been privatized already.
648 bool
649 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000650 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000651 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000652
653 // Only save it once.
654 if (SavedLocals.count(LocalVD)) return false;
655
656 // Copy the existing local entry to SavedLocals.
657 auto it = CGF.LocalDeclMap.find(LocalVD);
658 if (it != CGF.LocalDeclMap.end()) {
659 SavedLocals.insert({LocalVD, it->second});
660 } else {
661 SavedLocals.insert({LocalVD, Address::invalid()});
662 }
663
664 // Generate the private entry.
665 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000666 QualType VarTy = LocalVD->getType();
667 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000668 Address Temp = CGF.CreateMemTemp(VarTy);
669 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
670 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000671 }
John McCall7f416cc2015-09-08 08:05:57 +0000672 SavedPrivates.insert({LocalVD, Addr});
673
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000674 return true;
675 }
676
677 /// \brief Privatizes local variables previously registered as private.
678 /// Registration is separate from the actual privatization to allow
679 /// initializers use values of the original variables, not the private one.
680 /// This is important, for example, if the private variable is a class
681 /// variable initialized by a constructor that references other private
682 /// variables. But at initialization original variables must be used, not
683 /// private copies.
684 /// \return true if at least one variable was privatized, false otherwise.
685 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000686 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000687 SavedPrivates.clear();
688 return !SavedLocals.empty();
689 }
690
691 void ForceCleanup() {
692 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000693 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000694 SavedLocals.clear();
695 }
696
697 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000698 ~OMPPrivateScope() {
699 if (PerformCleanup)
700 ForceCleanup();
701 }
John McCall7f416cc2015-09-08 08:05:57 +0000702
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000703 /// Checks if the global variable is captured in current function.
704 bool isGlobalVarCaptured(const VarDecl *VD) const {
705 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
706 }
707
John McCall7f416cc2015-09-08 08:05:57 +0000708 private:
709 /// Copy all the entries in the source map over the corresponding
710 /// entries in the destination, which must exist.
711 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
712 for (auto &pair : src) {
713 if (!pair.second.isValid()) {
714 dest.erase(pair.first);
715 continue;
716 }
717
718 auto it = dest.find(pair.first);
719 if (it != dest.end()) {
720 it->second = pair.second;
721 } else {
722 dest.insert(pair);
723 }
724 }
725 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000726 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000727
Richard Smith736a9472013-06-12 20:42:33 +0000728 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
729 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000730 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000731
Richard Smith736a9472013-06-12 20:42:33 +0000732 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
733 /// that have been added, then adds all lifetime-extended cleanups from
734 /// the given position to the stack.
735 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
736 size_t OldLifetimeExtendedStackSize);
737
John McCallad5d61e2010-07-23 21:56:41 +0000738 void ResolveBranchFixups(llvm::BasicBlock *Target);
739
John McCallbd309292010-07-06 01:34:17 +0000740 /// The given basic block lies in the current EH scope, but may be a
741 /// target of a potentially scope-crossing jump; get a stable handle
742 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000743 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000744 return JumpDest(Target,
745 EHStack.getInnermostNormalCleanup(),
746 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000747 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000748
John McCallbd309292010-07-06 01:34:17 +0000749 /// The given basic block lies in the current EH scope, but may be a
750 /// target of a potentially scope-crossing jump; get a stable handle
751 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000752 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000753 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000754 }
755
756 /// EmitBranchThroughCleanup - Emit a branch from the current insert
757 /// block through the normal cleanup handling code (if any) and then
758 /// on to \arg Dest.
759 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000760
Justin Bognere25ffdf2014-01-21 00:35:11 +0000761 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
762 /// specified destination obviously has no cleanups to run. 'false' is always
763 /// a conservatively correct answer for this method.
764 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
765
John McCall8e4c74b2011-08-11 02:22:43 +0000766 /// popCatchScope - Pops the catch scope at the top of the EHScope
767 /// stack, emitting any required code (other than the catch handlers
768 /// themselves).
769 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000770
David Chisnall9a837be2012-11-07 16:50:40 +0000771 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000772 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000773 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000774
John McCallce1de612011-01-26 04:00:11 +0000775 /// An object to manage conditionally-evaluated expressions.
776 class ConditionalEvaluation {
777 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000778
John McCallce1de612011-01-26 04:00:11 +0000779 public:
780 ConditionalEvaluation(CodeGenFunction &CGF)
781 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000782
John McCallce1de612011-01-26 04:00:11 +0000783 void begin(CodeGenFunction &CGF) {
784 assert(CGF.OutermostConditional != this);
785 if (!CGF.OutermostConditional)
786 CGF.OutermostConditional = this;
787 }
788
789 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000790 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000791 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000792 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000793 }
794
795 /// Returns a block which will be executed prior to each
796 /// evaluation of the conditional code.
797 llvm::BasicBlock *getStartingBlock() const {
798 return StartBB;
799 }
800 };
Mike Stump11289f42009-09-09 15:08:12 +0000801
John McCall7f9c92a2010-09-17 00:50:28 +0000802 /// isInConditionalBranch - Return true if we're currently emitting
803 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000804 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000805
John McCall7f416cc2015-09-08 08:05:57 +0000806 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000807 assert(isInConditionalBranch());
808 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000809 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
810 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000811 }
812
John McCallce1de612011-01-26 04:00:11 +0000813 /// An RAII object to record that we're evaluating a statement
814 /// expression.
815 class StmtExprEvaluation {
816 CodeGenFunction &CGF;
817
818 /// We have to save the outermost conditional: cleanups in a
819 /// statement expression aren't conditional just because the
820 /// StmtExpr is.
821 ConditionalEvaluation *SavedOutermostConditional;
822
823 public:
824 StmtExprEvaluation(CodeGenFunction &CGF)
825 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000826 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000827 }
828
829 ~StmtExprEvaluation() {
830 CGF.OutermostConditional = SavedOutermostConditional;
831 CGF.EnsureInsertPoint();
832 }
833 };
John McCall1bf58462011-02-16 08:02:54 +0000834
John McCallc07a0c72011-02-17 10:25:35 +0000835 /// An object which temporarily prevents a value from being
836 /// destroyed by aggressive peephole optimizations that assume that
837 /// all uses of a value have been realized in the IR.
838 class PeepholeProtection {
839 llvm::Instruction *Inst;
840 friend class CodeGenFunction;
841
842 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000843 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000844 };
John McCallc07a0c72011-02-17 10:25:35 +0000845
John McCallfe96e0b2011-11-06 09:01:30 +0000846 /// A non-RAII class containing all the information about a bound
847 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
848 /// this which makes individual mappings very simple; using this
849 /// class directly is useful when you have a variable number of
850 /// opaque values or don't want the RAII functionality for some
851 /// reason.
852 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000853 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000854 bool BoundLValue;
855 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000856
John McCallfe96e0b2011-11-06 09:01:30 +0000857 OpaqueValueMappingData(const OpaqueValueExpr *ov,
858 bool boundLValue)
859 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000860 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000861 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000862
John McCallc07a0c72011-02-17 10:25:35 +0000863 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000864 // gl-values should be bound as l-values for obvious reasons.
865 // Records should be bound as l-values because IR generation
866 // always keeps them in memory. Expressions of function type
867 // act exactly like l-values but are formally required to be
868 // r-values in C.
869 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000870 expr->getType()->isFunctionType() ||
871 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000872 }
873
John McCallfe96e0b2011-11-06 09:01:30 +0000874 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
875 const OpaqueValueExpr *ov,
876 const Expr *e) {
877 if (shouldBindAsLValue(ov))
878 return bind(CGF, ov, CGF.EmitLValue(e));
879 return bind(CGF, ov, CGF.EmitAnyExpr(e));
880 }
881
882 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
883 const OpaqueValueExpr *ov,
884 const LValue &lv) {
885 assert(shouldBindAsLValue(ov));
886 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
887 return OpaqueValueMappingData(ov, true);
888 }
889
890 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
891 const OpaqueValueExpr *ov,
892 const RValue &rv) {
893 assert(!shouldBindAsLValue(ov));
894 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
895
896 OpaqueValueMappingData data(ov, false);
897
898 // Work around an extremely aggressive peephole optimization in
899 // EmitScalarConversion which assumes that all other uses of a
900 // value are extant.
901 data.Protection = CGF.protectFromPeepholes(rv);
902
903 return data;
904 }
905
Craig Topper8a13c412014-05-21 05:09:00 +0000906 bool isValid() const { return OpaqueValue != nullptr; }
907 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000908
909 void unbind(CodeGenFunction &CGF) {
910 assert(OpaqueValue && "no data to unbind!");
911
912 if (BoundLValue) {
913 CGF.OpaqueLValues.erase(OpaqueValue);
914 } else {
915 CGF.OpaqueRValues.erase(OpaqueValue);
916 CGF.unprotectFromPeepholes(Protection);
917 }
918 }
919 };
920
921 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
922 class OpaqueValueMapping {
923 CodeGenFunction &CGF;
924 OpaqueValueMappingData Data;
925
926 public:
927 static bool shouldBindAsLValue(const Expr *expr) {
928 return OpaqueValueMappingData::shouldBindAsLValue(expr);
929 }
930
John McCallc07a0c72011-02-17 10:25:35 +0000931 /// Build the opaque value mapping for the given conditional
932 /// operator if it's the GNU ?: extension. This is a common
933 /// enough pattern that the convenience operator is really
934 /// helpful.
935 ///
936 OpaqueValueMapping(CodeGenFunction &CGF,
937 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000938 if (isa<ConditionalOperator>(op))
939 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000940 return;
John McCallc07a0c72011-02-17 10:25:35 +0000941
942 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000943 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
944 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000945 }
946
Richard Smith410306b2016-12-12 02:53:20 +0000947 /// Build the opaque value mapping for an OpaqueValueExpr whose source
948 /// expression is set to the expression the OVE represents.
949 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
950 : CGF(CGF) {
951 if (OV) {
952 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
953 "for OVE with no source expression");
954 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
955 }
956 }
957
John McCall1bf58462011-02-16 08:02:54 +0000958 OpaqueValueMapping(CodeGenFunction &CGF,
959 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000960 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000961 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000962 }
963
964 OpaqueValueMapping(CodeGenFunction &CGF,
965 const OpaqueValueExpr *opaqueValue,
966 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000967 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000968 }
969
970 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000971 Data.unbind(CGF);
972 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000973 }
974
975 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000976 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000977 }
978 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000979
Chris Lattner2da04b32007-08-24 05:35:26 +0000980private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000981 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000982 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000983
John McCall9b382dd2011-05-28 21:13:02 +0000984 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
985 /// calling llvm.stacksave for multiple VLAs in the same scope.
986 bool DidCallStackSave;
987
Mike Stumpe5311b02009-11-30 20:08:49 +0000988 /// IndirectBranch - The first time an indirect goto is seen we create a block
989 /// with an indirect branch. Every time we see the address of a label taken,
990 /// we add the label to the indirect goto. Every subsequent indirect goto is
991 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000992 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000993
Mike Stumpfc496822009-02-08 23:14:22 +0000994 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
995 /// decls.
John McCall351762c2011-02-07 10:33:21 +0000996 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000997
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000998 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
999 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1000 /// parameter.
1001 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1002 SizeArguments;
1003
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001004 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001005 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001006 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1007
Chris Lattnerac248202007-05-30 00:13:02 +00001008 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001009 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001010
Mike Stumpfc496822009-02-08 23:14:22 +00001011 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001012 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001013 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001014 BreakContinue(JumpDest Break, JumpDest Continue)
1015 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001016
John McCallbd309292010-07-06 01:34:17 +00001017 JumpDest BreakBlock;
1018 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001019 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001020 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001021
Alexey Bataev957d8562016-11-17 15:12:05 +00001022 /// Handles cancellation exit points in OpenMP-related constructs.
1023 class OpenMPCancelExitStack {
1024 /// Tracks cancellation exit point and join point for cancel-related exit
1025 /// and normal exit.
1026 struct CancelExit {
1027 CancelExit() = default;
1028 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1029 JumpDest ContBlock)
1030 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1031 OpenMPDirectiveKind Kind = OMPD_unknown;
1032 /// true if the exit block has been emitted already by the special
1033 /// emitExit() call, false if the default codegen is used.
1034 bool HasBeenEmitted = false;
1035 JumpDest ExitBlock;
1036 JumpDest ContBlock;
1037 };
1038
1039 SmallVector<CancelExit, 8> Stack;
1040
1041 public:
1042 OpenMPCancelExitStack() : Stack(1) {}
1043 ~OpenMPCancelExitStack() = default;
1044 /// Fetches the exit block for the current OpenMP construct.
1045 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1046 /// Emits exit block with special codegen procedure specific for the related
1047 /// OpenMP construct + emits code for normal construct cleanup.
1048 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1049 const llvm::function_ref<void(CodeGenFunction &)> &CodeGen) {
1050 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1051 assert(CGF.getOMPCancelDestination(Kind).isValid());
1052 assert(CGF.HaveInsertPoint());
1053 assert(!Stack.back().HasBeenEmitted);
1054 auto IP = CGF.Builder.saveAndClearIP();
1055 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1056 CodeGen(CGF);
1057 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1058 CGF.Builder.restoreIP(IP);
1059 Stack.back().HasBeenEmitted = true;
1060 }
1061 CodeGen(CGF);
1062 }
1063 /// Enter the cancel supporting \a Kind construct.
1064 /// \param Kind OpenMP directive that supports cancel constructs.
1065 /// \param HasCancel true, if the construct has inner cancel directive,
1066 /// false otherwise.
1067 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1068 Stack.push_back({Kind,
1069 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1070 : JumpDest(),
1071 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1072 : JumpDest()});
1073 }
1074 /// Emits default exit point for the cancel construct (if the special one
1075 /// has not be used) + join point for cancel/normal exits.
1076 void exit(CodeGenFunction &CGF) {
1077 if (getExitBlock().isValid()) {
1078 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1079 bool HaveIP = CGF.HaveInsertPoint();
1080 if (!Stack.back().HasBeenEmitted) {
1081 if (HaveIP)
1082 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1083 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1084 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1085 }
1086 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1087 if (!HaveIP) {
1088 CGF.Builder.CreateUnreachable();
1089 CGF.Builder.ClearInsertionPoint();
1090 }
1091 }
1092 Stack.pop_back();
1093 }
1094 };
1095 OpenMPCancelExitStack OMPCancelStack;
1096
1097 /// Controls insertion of cancellation exit blocks in worksharing constructs.
1098 class OMPCancelStackRAII {
1099 CodeGenFunction &CGF;
1100
1101 public:
1102 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1103 bool HasCancel)
1104 : CGF(CGF) {
1105 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
1106 }
1107 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
1108 };
1109
Justin Bogneref512b92014-01-06 22:27:43 +00001110 CodeGenPGO PGO;
1111
Justin Bogner65512642015-05-02 05:00:55 +00001112 /// Calculate branch weights appropriate for PGO data
1113 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1114 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1115 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1116 uint64_t LoopCount);
1117
Justin Bogneref512b92014-01-06 22:27:43 +00001118public:
Justin Bogner66242d62015-04-23 23:06:47 +00001119 /// Increment the profiler's counter for the given statement.
1120 void incrementProfileCounter(const Stmt *S) {
Rong Xu9837ef52016-02-04 18:39:09 +00001121 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Justin Bogner66242d62015-04-23 23:06:47 +00001122 PGO.emitCounterIncrement(Builder, S);
1123 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001124 }
Justin Bogner66242d62015-04-23 23:06:47 +00001125
1126 /// Get the profiler's count for the given statement.
1127 uint64_t getProfileCount(const Stmt *S) {
1128 Optional<uint64_t> Count = PGO.getStmtCount(S);
1129 if (!Count.hasValue())
1130 return 0;
1131 return *Count;
1132 }
1133
1134 /// Set the profiler's current count.
1135 void setCurrentProfileCount(uint64_t Count) {
1136 PGO.setCurrentRegionCount(Count);
1137 }
1138
1139 /// Get the profiler's current count. This is generally the count for the most
1140 /// recently incremented counter.
1141 uint64_t getCurrentProfileCount() {
1142 return PGO.getCurrentRegionCount();
1143 }
1144
Justin Bogneref512b92014-01-06 22:27:43 +00001145private:
1146
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001147 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001148 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001149 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001150 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1151 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001152
Mike Stumpfc496822009-02-08 23:14:22 +00001153 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001154 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001155 llvm::BasicBlock *CaseRangeBlock;
1156
John McCallc07a0c72011-02-17 10:25:35 +00001157 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001158 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001159 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1160 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001161
Mike Stumpfc496822009-02-08 23:14:22 +00001162 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001163 // We track this by the size expression rather than the type itself because
1164 // in certain situations, like a const qualifier applied to an VLA typedef,
1165 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001166 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1167 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001168 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001169
John McCallbd309292010-07-06 01:34:17 +00001170 /// A block containing a single 'unreachable' instruction. Created
1171 /// lazily by getUnreachableBlock().
1172 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001173
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001174 /// Counts of the number return expressions in the function.
1175 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001176
1177 /// Count the number of simple (constant) return expressions in the function.
1178 unsigned NumSimpleReturnExprs;
1179
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001180 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001181 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001182
Richard Smith852c9db2013-04-20 22:23:05 +00001183public:
1184 /// A scope within which we are constructing the fields of an object which
1185 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1186 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1187 class FieldConstructionScope {
1188 public:
John McCall7f416cc2015-09-08 08:05:57 +00001189 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001190 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1191 CGF.CXXDefaultInitExprThis = This;
1192 }
1193 ~FieldConstructionScope() {
1194 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1195 }
1196
1197 private:
1198 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001199 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001200 };
1201
1202 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1203 /// is overridden to be the object under construction.
1204 class CXXDefaultInitExprScope {
1205 public:
1206 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001207 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1208 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1209 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1210 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001211 }
1212 ~CXXDefaultInitExprScope() {
1213 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001214 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001215 }
1216
1217 public:
1218 CodeGenFunction &CGF;
1219 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001220 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001221 };
1222
Richard Smith410306b2016-12-12 02:53:20 +00001223 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1224 /// current loop index is overridden.
1225 class ArrayInitLoopExprScope {
1226 public:
1227 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1228 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1229 CGF.ArrayInitIndex = Index;
1230 }
1231 ~ArrayInitLoopExprScope() {
1232 CGF.ArrayInitIndex = OldArrayInitIndex;
1233 }
1234
1235 private:
1236 CodeGenFunction &CGF;
1237 llvm::Value *OldArrayInitIndex;
1238 };
1239
Richard Smith5179eb72016-06-28 19:03:57 +00001240 class InlinedInheritingConstructorScope {
1241 public:
1242 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1243 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1244 OldCurCodeDecl(CGF.CurCodeDecl),
1245 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1246 OldCXXABIThisValue(CGF.CXXABIThisValue),
1247 OldCXXThisValue(CGF.CXXThisValue),
1248 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1249 OldCXXThisAlignment(CGF.CXXThisAlignment),
1250 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1251 OldCXXInheritedCtorInitExprArgs(
1252 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1253 CGF.CurGD = GD;
1254 CGF.CurFuncDecl = CGF.CurCodeDecl =
1255 cast<CXXConstructorDecl>(GD.getDecl());
1256 CGF.CXXABIThisDecl = nullptr;
1257 CGF.CXXABIThisValue = nullptr;
1258 CGF.CXXThisValue = nullptr;
1259 CGF.CXXABIThisAlignment = CharUnits();
1260 CGF.CXXThisAlignment = CharUnits();
1261 CGF.ReturnValue = Address::invalid();
1262 CGF.FnRetTy = QualType();
1263 CGF.CXXInheritedCtorInitExprArgs.clear();
1264 }
1265 ~InlinedInheritingConstructorScope() {
1266 CGF.CurGD = OldCurGD;
1267 CGF.CurFuncDecl = OldCurFuncDecl;
1268 CGF.CurCodeDecl = OldCurCodeDecl;
1269 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1270 CGF.CXXABIThisValue = OldCXXABIThisValue;
1271 CGF.CXXThisValue = OldCXXThisValue;
1272 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1273 CGF.CXXThisAlignment = OldCXXThisAlignment;
1274 CGF.ReturnValue = OldReturnValue;
1275 CGF.FnRetTy = OldFnRetTy;
1276 CGF.CXXInheritedCtorInitExprArgs =
1277 std::move(OldCXXInheritedCtorInitExprArgs);
1278 }
1279
1280 private:
1281 CodeGenFunction &CGF;
1282 GlobalDecl OldCurGD;
1283 const Decl *OldCurFuncDecl;
1284 const Decl *OldCurCodeDecl;
1285 ImplicitParamDecl *OldCXXABIThisDecl;
1286 llvm::Value *OldCXXABIThisValue;
1287 llvm::Value *OldCXXThisValue;
1288 CharUnits OldCXXABIThisAlignment;
1289 CharUnits OldCXXThisAlignment;
1290 Address OldReturnValue;
1291 QualType OldFnRetTy;
1292 CallArgList OldCXXInheritedCtorInitExprArgs;
1293 };
1294
Richard Smith852c9db2013-04-20 22:23:05 +00001295private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001296 /// CXXThisDecl - When generating code for a C++ member function,
1297 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001298 ImplicitParamDecl *CXXABIThisDecl;
1299 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001300 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001301 CharUnits CXXABIThisAlignment;
1302 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001303
Richard Smith852c9db2013-04-20 22:23:05 +00001304 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1305 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001306 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001307
Richard Smith410306b2016-12-12 02:53:20 +00001308 /// The current array initialization index when evaluating an
1309 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1310 llvm::Value *ArrayInitIndex = nullptr;
1311
Richard Smith5179eb72016-06-28 19:03:57 +00001312 /// The values of function arguments to use when evaluating
1313 /// CXXInheritedCtorInitExprs within this context.
1314 CallArgList CXXInheritedCtorInitExprArgs;
1315
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001316 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1317 /// destructor, this will hold the implicit argument (e.g. VTT).
1318 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1319 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001320
John McCallce1de612011-01-26 04:00:11 +00001321 /// OutermostConditional - Points to the outermost active
1322 /// conditional control. This is used so that we know if a
1323 /// temporary should be destroyed conditionally.
1324 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001325
Nadav Rotem1da30942013-03-23 06:43:35 +00001326 /// The current lexical scope.
1327 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001328
Adrian Prantldc237b52013-05-16 00:41:26 +00001329 /// The current source location that should be used for exception
1330 /// handling code.
1331 SourceLocation CurEHLocation;
1332
John McCall7f416cc2015-09-08 08:05:57 +00001333 /// BlockByrefInfos - For each __block variable, contains
1334 /// information about the layout of the variable.
1335 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001336
John McCallbd309292010-07-06 01:34:17 +00001337 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001338 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001339 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001340
Vitaly Buka1c943322016-10-26 01:59:57 +00001341 /// True if we need emit the life-time markers.
1342 const bool ShouldEmitLifetimeMarkers;
1343
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001344 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1345 /// In the kernel metadata node, reference the kernel function and metadata
1346 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001347 /// - A node for the vec_type_hint(<type>) qualifier contains string
1348 /// "vec_type_hint", an undefined value of the <type> data type,
1349 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001350 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1351 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1352 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1353 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1354 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1355 llvm::Function *Fn);
1356
Chris Lattnerbed31442007-05-28 01:07:47 +00001357public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001358 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001359 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001360
John McCall8ed55a52010-09-02 09:58:18 +00001361 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001362 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001363 CGDebugInfo *getDebugInfo() {
1364 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001365 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001366 return DebugInfo;
1367 }
1368 void disableDebugInfo() { DisableDebugInfo = true; }
1369 void enableDebugInfo() { DisableDebugInfo = false; }
1370
John McCall31168b02011-06-15 23:02:42 +00001371 bool shouldUseFusedARCCalls() {
1372 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1373 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001374
David Blaikiebbafb8a2012-03-11 07:00:24 +00001375 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001376
Bill Wendlingf0724e82011-09-19 20:31:14 +00001377 /// Returns a pointer to the function's exception object and selector slot,
1378 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001379 Address getExceptionSlot();
1380 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001381
Bill Wendling79a70e42011-09-15 18:57:19 +00001382 /// Returns the contents of the function's exception object and selector
1383 /// slots.
1384 llvm::Value *getExceptionFromSlot();
1385 llvm::Value *getSelectorFromSlot();
1386
John McCall7f416cc2015-09-08 08:05:57 +00001387 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001388
John McCallbd309292010-07-06 01:34:17 +00001389 llvm::BasicBlock *getUnreachableBlock() {
1390 if (!UnreachableBlock) {
1391 UnreachableBlock = createBasicBlock("unreachable");
1392 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1393 }
1394 return UnreachableBlock;
1395 }
1396
1397 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001398 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001399 return getInvokeDestImpl();
1400 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001401
David Majnemer25eb1652016-03-01 19:42:53 +00001402 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001403
John McCallc8e01702013-04-16 22:48:15 +00001404 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001405 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001406
Daniel Dunbar12347492009-02-23 17:26:39 +00001407 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001408 // Cleanups
1409 //===--------------------------------------------------------------------===//
1410
John McCall7f416cc2015-09-08 08:05:57 +00001411 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001412
John McCall178360e2011-07-11 08:38:19 +00001413 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001414 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001415 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001416 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001417 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001418 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1419 llvm::Value *arrayEnd,
1420 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001421 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001422 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001423
John McCall4bd0fb12011-07-12 16:41:08 +00001424 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001425 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001426 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001427 Address addr, QualType type);
1428 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001429 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001430 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001431 QualType type, Destroyer *destroyer,
1432 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001433 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1434 llvm::Value *CompletePtr,
1435 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001436 void pushStackRestore(CleanupKind kind, Address SPMem);
1437 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001438 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001439 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001440 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001441 bool useEHCleanupForArray,
1442 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001443 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001444 QualType elementType, CharUnits elementAlign,
1445 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001446 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001447
Peter Collingbourne1425b452012-01-26 03:33:36 +00001448 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001449
John McCall82fe67b2011-07-09 01:37:26 +00001450 /// Determines whether an EH cleanup is required to destroy a type
1451 /// with the given destruction kind.
1452 bool needsEHCleanup(QualType::DestructionKind kind) {
1453 switch (kind) {
1454 case QualType::DK_none:
1455 return false;
1456 case QualType::DK_cxx_destructor:
1457 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001458 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001459 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001460 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001461 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1462 }
1463 llvm_unreachable("bad destruction kind");
1464 }
1465
John McCall4bd0fb12011-07-12 16:41:08 +00001466 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1467 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1468 }
1469
John McCall82fe67b2011-07-09 01:37:26 +00001470 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001471 // Objective-C
1472 //===--------------------------------------------------------------------===//
1473
Chris Lattner4bd55962008-03-30 23:03:07 +00001474 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001475
David Blaikief1425802015-01-14 00:04:42 +00001476 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001477
Mike Stumpfc496822009-02-08 23:14:22 +00001478 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001479 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1480 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001481 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001482 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001483 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001484 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001485
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001486 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1487 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001488
Mike Stumpfc496822009-02-08 23:14:22 +00001489 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1490 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001491 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1492 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001493 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001494 const ObjCPropertyImplDecl *propImpl,
1495 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001496
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001497 //===--------------------------------------------------------------------===//
1498 // Block Bits
1499 //===--------------------------------------------------------------------===//
1500
John McCall351762c2011-02-07 10:33:21 +00001501 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001502 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001503
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001504 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001505 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001506 const DeclMapTy &ldm,
1507 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001508
John McCallad7c5c12011-02-08 08:22:06 +00001509 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1510 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001511 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1512 const ObjCPropertyImplDecl *PID);
1513 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1514 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001515 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001516
John McCallad7c5c12011-02-08 08:22:06 +00001517 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1518
John McCall73064872011-03-31 01:59:53 +00001519 class AutoVarEmission;
1520
1521 void emitByrefStructureInit(const AutoVarEmission &emission);
1522 void enterByrefCleanup(const AutoVarEmission &emission);
1523
John McCall7f416cc2015-09-08 08:05:57 +00001524 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1525 llvm::Value *ptr);
1526
1527 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001528 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1529
1530 /// BuildBlockByrefAddress - Computes the location of the
1531 /// data in a variable which is declared as __block.
1532 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1533 bool followForward = true);
1534 Address emitBlockByrefAddress(Address baseAddr,
1535 const BlockByrefInfo &info,
1536 bool followForward,
1537 const llvm::Twine &name);
1538
1539 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001540
Richard Smith5179eb72016-06-28 19:03:57 +00001541 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1542
John McCalla738c252011-03-09 04:27:21 +00001543 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1544 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001545 /// \brief Emit code for the start of a function.
1546 /// \param Loc The location to be associated with the function.
1547 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001548 void StartFunction(GlobalDecl GD,
1549 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001550 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001551 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001552 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001553 SourceLocation Loc = SourceLocation(),
1554 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001555
John McCallb81884d2010-02-19 09:25:03 +00001556 void EmitConstructorBody(FunctionArgList &Args);
1557 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001558 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001559 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001560 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001561
Faisal Vali571df122013-09-29 08:45:24 +00001562 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001563 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001564 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001565 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001566 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1567 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001568 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001569
David Blaikiea0a1a872015-01-18 02:48:07 +00001570 /// \brief Emit the unified return block, trying to avoid its emission when
1571 /// possible.
1572 /// \return The debug location of the user written return statement if the
1573 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001574 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001575
Mike Stumpfc496822009-02-08 23:14:22 +00001576 /// FinishFunction - Complete IR generation of the current function. It is
1577 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001578 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001579
Nico Weber1bebad12015-02-11 22:33:32 +00001580 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1581 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001582
John McCallb92ab1a2016-10-26 23:46:34 +00001583 void EmitCallAndReturnForThunk(llvm::Constant *Callee,
1584 const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001585
John McCall7f416cc2015-09-08 08:05:57 +00001586 void FinishThunk();
1587
Reid Klecknerab2090d2014-07-26 01:34:32 +00001588 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1589 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1590 llvm::Value *Callee);
1591
Rafael Espindolad6e66942015-07-13 06:07:58 +00001592 /// Generate a thunk for the given method.
1593 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001594 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001595
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001596 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1597 const CGFunctionInfo &FnInfo,
1598 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001599
Douglas Gregor94f9a482010-05-05 05:51:00 +00001600 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1601 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001602
Richard Smith30e304e2016-12-14 00:03:17 +00001603 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001604
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001605 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1606 struct VPtr {
1607 BaseSubobject Base;
1608 const CXXRecordDecl *NearestVBase;
1609 CharUnits OffsetFromNearestVBase;
1610 const CXXRecordDecl *VTableClass;
1611 };
1612
1613 /// Initialize the vtable pointer of the given subobject.
1614 void InitializeVTablePointer(const VPtr &vptr);
1615
1616 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001617
1618 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001619 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1620
1621 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1622 CharUnits OffsetFromNearestVBase,
1623 bool BaseIsNonVirtualPrimaryBase,
1624 const CXXRecordDecl *VTableClass,
1625 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001626
Anders Carlssond5895932010-03-28 21:07:49 +00001627 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001628
Dan Gohman8fc50c22010-10-26 18:44:08 +00001629 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1630 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001631 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1632 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001633
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001634 enum CFITypeCheckKind {
1635 CFITCK_VCall,
1636 CFITCK_NVCall,
1637 CFITCK_DerivedCast,
1638 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001639 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001640 };
1641
Peter Collingbourned2926c92015-03-14 02:42:25 +00001642 /// \brief Derived is the presumed address of an object of type T after a
1643 /// cast. If T is a polymorphic class type, emit a check that the virtual
1644 /// table for Derived belongs to a class derived from T.
1645 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001646 bool MayBeNull, CFITypeCheckKind TCK,
1647 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001648
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001649 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1650 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001651 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001652 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001653
Peter Collingbourned2926c92015-03-14 02:42:25 +00001654 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001655 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001656 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1657 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001658
Peter Collingbournefb532b92016-02-24 20:46:36 +00001659 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001660 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1661 /// enabled, emit a check that VTable is a member of RD's type identifier.
1662 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1663 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001664
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001665 /// Returns whether we should perform a type checked load when loading a
1666 /// virtual function for virtual calls to members of RD. This is generally
1667 /// true when both vcall CFI and whole-program-vtables are enabled.
1668 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1669
1670 /// Emit a type checked load from the given vtable.
1671 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1672 uint64_t VTableByteOffset);
1673
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001674 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1675 /// expr can be devirtualized.
1676 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1677 const CXXMethodDecl *MD);
1678
John McCallf99a6312010-07-21 05:30:47 +00001679 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1680 /// given phase of destruction for a destructor. The end result
1681 /// should call destructors on members and base classes in reverse
1682 /// order of their construction.
1683 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001684
Chris Lattner3c77a352010-06-22 00:03:40 +00001685 /// ShouldInstrumentFunction - Return true if the current function should be
1686 /// instrumented with __cyg_profile_func_* calls
1687 bool ShouldInstrumentFunction();
1688
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001689 /// ShouldXRayInstrument - Return true if the current function should be
1690 /// instrumented with XRay nop sleds.
1691 bool ShouldXRayInstrumentFunction() const;
1692
Chris Lattner3c77a352010-06-22 00:03:40 +00001693 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1694 /// instrumentation function with the current function and the call site, if
1695 /// function instrumentation is enabled.
1696 void EmitFunctionInstrumentation(const char *Fn);
1697
Roman Divacky178e01602011-02-10 16:52:03 +00001698 /// EmitMCountInstrumentation - Emit call to .mcount.
1699 void EmitMCountInstrumentation();
1700
Mike Stumpfc496822009-02-08 23:14:22 +00001701 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1702 /// arguments for the given function. This is also responsible for naming the
1703 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001704 void EmitFunctionProlog(const CGFunctionInfo &FI,
1705 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001706 const FunctionArgList &Args);
1707
Mike Stumpfc496822009-02-08 23:14:22 +00001708 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1709 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001710 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1711 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001712
Mike Stump1d849212009-12-07 23:38:24 +00001713 /// EmitStartEHSpec - Emit the start of the exception spec.
1714 void EmitStartEHSpec(const Decl *D);
1715
1716 /// EmitEndEHSpec - Emit the end of the exception spec.
1717 void EmitEndEHSpec(const Decl *D);
1718
John McCallbd309292010-07-06 01:34:17 +00001719 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1720 llvm::BasicBlock *getTerminateLandingPad();
1721
1722 /// getTerminateHandler - Return a handler (not a landing pad, just
1723 /// a catch handler) that just calls terminate. This is used when
1724 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001725 llvm::BasicBlock *getTerminateHandler();
1726
Chris Lattnera5f58b02011-07-09 17:41:47 +00001727 llvm::Type *ConvertTypeForMem(QualType T);
1728 llvm::Type *ConvertType(QualType T);
1729 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001730 return ConvertType(getContext().getTypeDeclType(T));
1731 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001732
Mike Stumpfc496822009-02-08 23:14:22 +00001733 /// LoadObjCSelf - Load the value of self. This function is only valid while
1734 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001735 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001736
1737 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001738 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001739
Chris Lattner54fb19e2007-06-22 22:02:34 +00001740 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1741 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001742 static TypeEvaluationKind getEvaluationKind(QualType T);
1743
1744 static bool hasScalarEvaluationKind(QualType T) {
1745 return getEvaluationKind(T) == TEK_Scalar;
1746 }
1747
1748 static bool hasAggregateEvaluationKind(QualType T) {
1749 return getEvaluationKind(T) == TEK_Aggregate;
1750 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001751
1752 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001753 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001754 llvm::Function *parent = nullptr,
1755 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001756#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001757 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001758#else
John McCallad7c5c12011-02-08 08:22:06 +00001759 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001760#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001761 }
Mike Stumpfc496822009-02-08 23:14:22 +00001762
Chris Lattnerac248202007-05-30 00:13:02 +00001763 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1764 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001765 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001766
Mike Stumpe5311b02009-11-30 20:08:49 +00001767 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1768 /// another basic block, simplify it. This assumes that no other code could
1769 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001770 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1771
Mike Stumpfc496822009-02-08 23:14:22 +00001772 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1773 /// adding a fall-through branch from the current insert block if
1774 /// necessary. It is legal to call this function even if there is no current
1775 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001776 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001777 /// IsFinished - If true, indicates that the caller has finished emitting
1778 /// branches to the given block and does not expect to emit code into it. This
1779 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001780 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001781
John McCall8e4c74b2011-08-11 02:22:43 +00001782 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1783 /// near its uses, and leave the insertion point in it.
1784 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1785
Mike Stumpfc496822009-02-08 23:14:22 +00001786 /// EmitBranch - Emit a branch to the specified basic block from the current
1787 /// insert block, taking care to avoid creation of branches from dummy
1788 /// blocks. It is legal to call this function even if there is no current
1789 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001790 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001791 /// This function clears the current insertion point. The caller should follow
1792 /// calls to this function with calls to Emit*Block prior to generation new
1793 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001794 void EmitBranch(llvm::BasicBlock *Block);
1795
Mike Stumpfc496822009-02-08 23:14:22 +00001796 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1797 /// indicates that the current code being emitted is unreachable.
1798 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001799 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001800 }
1801
Mike Stumpfc496822009-02-08 23:14:22 +00001802 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1803 /// emitted IR has a place to go. Note that by definition, if this function
1804 /// creates a block then that block is unreachable; callers may do better to
1805 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001806 void EnsureInsertPoint() {
1807 if (!HaveInsertPoint())
1808 EmitBlock(createBasicBlock());
1809 }
Mike Stumpfc496822009-02-08 23:14:22 +00001810
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001811 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001812 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001813 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001814
Chris Lattnere9a64532007-06-22 21:44:33 +00001815 //===--------------------------------------------------------------------===//
1816 // Helpers
1817 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001818
John McCall7f416cc2015-09-08 08:05:57 +00001819 LValue MakeAddrLValue(Address Addr, QualType T,
1820 AlignmentSource AlignSource = AlignmentSource::Type) {
1821 return LValue::MakeAddr(Addr, T, getContext(), AlignSource,
Dan Gohman947c9af2010-10-14 23:06:10 +00001822 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001823 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001824
John McCall7f416cc2015-09-08 08:05:57 +00001825 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1826 AlignmentSource AlignSource = AlignmentSource::Type) {
1827 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1828 AlignSource, CGM.getTBAAInfo(T));
1829 }
1830
1831 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001832 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001833 CharUnits getNaturalTypeAlignment(QualType T,
1834 AlignmentSource *Source = nullptr,
1835 bool forPointeeType = false);
1836 CharUnits getNaturalPointeeTypeAlignment(QualType T,
1837 AlignmentSource *Source = nullptr);
1838
1839 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
1840 AlignmentSource *Source = nullptr);
1841 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001842
Alexey Bataev31300ed2016-02-04 11:27:03 +00001843 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
1844 AlignmentSource *Source = nullptr);
1845 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1846
Chris Lattnere9a64532007-06-22 21:44:33 +00001847 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001848 /// block. The caller is responsible for setting an appropriate alignment on
1849 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001850 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001851 const Twine &Name = "tmp");
John McCall7f416cc2015-09-08 08:05:57 +00001852 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
1853 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001854
John McCall7f416cc2015-09-08 08:05:57 +00001855 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1856 /// default ABI alignment of the given LLVM type.
1857 ///
1858 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1859 /// any given AST type that happens to have been lowered to the
1860 /// given IR type. This should only ever be used for function-local,
1861 /// IR-driven manipulations like saving and restoring a value. Do
1862 /// not hand this address off to arbitrary IRGen routines, and especially
1863 /// do not pass it as an argument to a function that might expect a
1864 /// properly ABI-aligned value.
1865 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1866 const Twine &Name = "tmp");
1867
1868 /// InitTempAlloca - Provide an initial value for the given alloca which
1869 /// will be observable at all locations in the function.
1870 ///
1871 /// The address should be something that was returned from one of
1872 /// the CreateTempAlloca or CreateMemTemp routines, and the
1873 /// initializer must be valid in the entry block (i.e. it must
1874 /// either be a constant or an argument value).
1875 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001876
Daniel Dunbard0049182010-02-16 19:44:13 +00001877 /// CreateIRTemp - Create a temporary IR object of the given type, with
1878 /// appropriate alignment. This routine should only be used when an temporary
1879 /// value needs to be stored into an alloca (for example, to avoid explicit
1880 /// PHI construction), but the type is the IR type, not the type appropriate
1881 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001882 ///
1883 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1884 /// ConvertType instead of ConvertTypeForMem.
1885 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001886
Daniel Dunbara7566f12010-02-09 02:48:28 +00001887 /// CreateMemTemp - Create a temporary memory object of the given type, with
1888 /// appropriate alignment.
John McCall7f416cc2015-09-08 08:05:57 +00001889 Address CreateMemTemp(QualType T, const Twine &Name = "tmp");
1890 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001891
John McCall7a626f62010-09-15 10:14:12 +00001892 /// CreateAggTemp - Create a temporary memory object for the given
1893 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001894 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00001895 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001896 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001897 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001898 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001899 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001900 }
1901
John McCallad7c5c12011-02-08 08:22:06 +00001902 /// Emit a cast to void* in the appropriate address space.
1903 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1904
Chris Lattner8394d792007-06-05 20:53:16 +00001905 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1906 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001907 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001908
John McCalla2342eb2010-12-05 02:00:02 +00001909 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1910 void EmitIgnoredExpr(const Expr *E);
1911
Chris Lattner4647a212007-08-31 22:49:20 +00001912 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1913 /// any type. The result is returned as an RValue struct. If this is an
1914 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1915 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001916 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001917 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001918 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001919 AggValueSlot aggSlot = AggValueSlot::ignored(),
1920 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001921
Mike Stumpfc496822009-02-08 23:14:22 +00001922 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1923 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00001924 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001925
Charles Davisc7d5c942015-09-17 20:55:33 +00001926 /// Emit a "reference" to a __builtin_ms_va_list; this is
1927 /// always the value of the expression, because a __builtin_ms_va_list is a
1928 /// pointer to a char.
1929 Address EmitMSVAListRef(const Expr *E);
1930
Mike Stumpfc496822009-02-08 23:14:22 +00001931 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1932 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001933 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001934
John McCall91ca10f2011-03-08 09:11:50 +00001935 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001936 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00001937 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001938 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001939
John McCall7f416cc2015-09-08 08:05:57 +00001940 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00001941
John McCall91ca10f2011-03-08 09:11:50 +00001942 /// EmitExprAsInit - Emits the code necessary to initialize a
1943 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001944 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001945 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001946
Fariborz Jahanian78652202013-01-25 23:57:05 +00001947 /// hasVolatileMember - returns true if aggregate type has a volatile
1948 /// member.
1949 bool hasVolatileMember(QualType T) {
1950 if (const RecordType *RT = T->getAs<RecordType>()) {
1951 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1952 return RD->hasVolatileMember();
1953 }
1954 return false;
1955 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001956 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001957 ///
1958 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1959 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00001960 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001961 QualType EltTy) {
1962 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00001963 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001964 }
1965
John McCall7f416cc2015-09-08 08:05:57 +00001966 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
1967 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00001968 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00001969 /*IsAssignment=*/false);
1970 }
1971
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001972 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001973 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001974 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001975 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001976 /// \param isAssignment - If false, allow padding to be copied. This often
1977 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00001978 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001979 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001980 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001981
Anders Carlsson9396a892008-09-11 09:15:33 +00001982 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00001983 Address GetAddrOfLocalVar(const VarDecl *VD) {
1984 auto it = LocalDeclMap.find(VD);
1985 assert(it != LocalDeclMap.end() &&
1986 "Invalid argument to GetAddrOfLocalVar(), no decl!");
1987 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00001988 }
Mike Stumpfc496822009-02-08 23:14:22 +00001989
John McCallc07a0c72011-02-17 10:25:35 +00001990 /// getOpaqueLValueMapping - Given an opaque value expression (which
1991 /// must be mapped to an l-value), return its mapping.
1992 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1993 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1994
1995 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1996 it = OpaqueLValues.find(e);
1997 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1998 return it->second;
1999 }
2000
2001 /// getOpaqueRValueMapping - Given an opaque value expression (which
2002 /// must be mapped to an r-value), return its mapping.
2003 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
2004 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
2005
2006 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
2007 it = OpaqueRValues.find(e);
2008 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00002009 return it->second;
2010 }
2011
Richard Smith410306b2016-12-12 02:53:20 +00002012 /// Get the index of the current ArrayInitLoopExpr, if any.
2013 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2014
Dan Gohman75d69da2008-05-22 00:50:06 +00002015 /// getAccessedFieldNo - Given an encoded value and a result number, return
2016 /// the input field number being accessed.
2017 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2018
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002019 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002020 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002021
Anders Carlssonc0964b62010-05-22 17:35:42 +00002022 /// EmitNullInitialization - Generate code to set a value of the given type to
2023 /// null, If the type contains data member pointers, they will be initialized
2024 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002025 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002026
Charles Davisc7d5c942015-09-17 20:55:33 +00002027 /// Emits a call to an LLVM variable-argument intrinsic, either
2028 /// \c llvm.va_start or \c llvm.va_end.
2029 /// \param ArgValue A reference to the \c va_list as emitted by either
2030 /// \c EmitVAListRef or \c EmitMSVAListRef.
2031 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2032 /// calls \c llvm.va_end.
2033 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2034
2035 /// Generate code to get an argument from the passed in pointer
2036 /// and update it accordingly.
2037 /// \param VE The \c VAArgExpr for which to generate code.
2038 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2039 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2040 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002041 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002042 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002043 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002044
John McCall82fe67b2011-07-09 01:37:26 +00002045 /// emitArrayLength - Compute the length of an array, even if it's a
2046 /// VLA, and drill down to the base element type.
2047 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2048 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002049 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002050
John McCall23c29fe2011-06-24 21:55:10 +00002051 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2052 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002053 ///
2054 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002055 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002056
John McCall23c29fe2011-06-24 21:55:10 +00002057 /// getVLASize - Returns an LLVM value that corresponds to the size,
2058 /// in non-variably-sized elements, of a variable length array type,
2059 /// plus that largest non-variably-sized element type. Assumes that
2060 /// the type has already been emitted with EmitVariablyModifiedType.
2061 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
2062 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002063
Anders Carlssona5d077d2009-04-14 16:58:56 +00002064 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2065 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002066 llvm::Value *LoadCXXThis() {
2067 assert(CXXThisValue && "no 'this' value for this function");
2068 return CXXThisValue;
2069 }
John McCall7f416cc2015-09-08 08:05:57 +00002070 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002071
Anders Carlssone36a6b32010-01-02 01:01:18 +00002072 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2073 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002074 // FIXME: Every place that calls LoadCXXVTT is something
2075 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002076 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002077 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2078 return CXXStructorImplicitParamValue;
2079 }
2080
John McCall6ce74722010-02-16 04:15:37 +00002081 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002082 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002083 Address
2084 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002085 const CXXRecordDecl *Derived,
2086 const CXXRecordDecl *Base,
2087 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002088
John McCall7f416cc2015-09-08 08:05:57 +00002089 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2090
Mike Stumpe5311b02009-11-30 20:08:49 +00002091 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2092 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002093 Address GetAddressOfBaseClass(Address Value,
2094 const CXXRecordDecl *Derived,
2095 CastExpr::path_const_iterator PathBegin,
2096 CastExpr::path_const_iterator PathEnd,
2097 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002098
John McCall7f416cc2015-09-08 08:05:57 +00002099 Address GetAddressOfDerivedClass(Address Value,
2100 const CXXRecordDecl *Derived,
2101 CastExpr::path_const_iterator PathBegin,
2102 CastExpr::path_const_iterator PathEnd,
2103 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002104
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002105 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2106 /// base constructor/destructor with virtual bases.
2107 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2108 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2109 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2110 bool Delegating);
2111
John McCallf8ff7b92010-02-23 00:48:20 +00002112 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2113 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002114 const FunctionArgList &Args,
2115 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002116 // It's important not to confuse this and the previous function. Delegating
2117 // constructors are the C++0x feature. The constructor delegate optimization
2118 // is used to reduce duplication in the base and complete consturctors where
2119 // they are substantially the same.
2120 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2121 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002122
Richard Smith5179eb72016-06-28 19:03:57 +00002123 /// Emit a call to an inheriting constructor (that is, one that invokes a
2124 /// constructor inherited from a base class) by inlining its definition. This
2125 /// is necessary if the ABI does not support forwarding the arguments to the
2126 /// base class constructor (because they're variadic or similar).
2127 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2128 CXXCtorType CtorType,
2129 bool ForVirtualBase,
2130 bool Delegating,
2131 CallArgList &Args);
2132
2133 /// Emit a call to a constructor inherited from a base class, passing the
2134 /// current constructor's arguments along unmodified (without even making
2135 /// a copy).
2136 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2137 bool ForVirtualBase, Address This,
2138 bool InheritedFromVBase,
2139 const CXXInheritedCtorInitExpr *E);
2140
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002141 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002142 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002143 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002144
Richard Smith5179eb72016-06-28 19:03:57 +00002145 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2146 bool ForVirtualBase, bool Delegating,
2147 Address This, CallArgList &Args);
2148
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002149 /// Emit assumption load for all bases. Requires to be be called only on
2150 /// most-derived class and not under construction of the object.
2151 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2152
2153 /// Emit assumption that vptr load == global vtable.
2154 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2155
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002156 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002157 Address This, Address Src,
2158 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002159
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002160 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002161 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002162 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002163 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002164 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002165
Anders Carlssond49844b2009-09-23 02:45:36 +00002166 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2167 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002168 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002169 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002170 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002171
John McCall82fe67b2011-07-09 01:37:26 +00002172 static Destroyer destroyCXXObject;
2173
Anders Carlsson0a637412009-05-29 21:03:38 +00002174 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002175 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002176 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002177
John McCall99210dc2011-09-15 06:49:18 +00002178 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002179 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002180 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002181 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002182
Peter Collingbourne702b2842011-11-27 22:09:22 +00002183 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002184 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002185
David Majnemerdc012fa2015-04-22 21:38:15 +00002186 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2187 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2188
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002189 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002190 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002191
Eli Friedman24f55432009-11-18 00:57:03 +00002192 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002193 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2194 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002195
Richard Smith760520b2014-06-03 23:27:44 +00002196 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2197 const Expr *Arg, bool IsDelete);
2198
John McCall7f416cc2015-09-08 08:05:57 +00002199 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2200 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2201 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002202
Richard Smith69d0d262012-08-24 00:54:33 +00002203 /// \brief Situations in which we might emit a check for the suitability of a
2204 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002205 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002206 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002207 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002208 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002209 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002210 /// Checking the bound value in a reference binding. Must be suitably sized
2211 /// and aligned, but is not required to refer to an object (until the
2212 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002213 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002214 /// Checking the object expression in a non-static data member access. Must
2215 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002216 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002217 /// Checking the 'this' pointer for a call to a non-static member function.
2218 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002219 TCK_MemberCall,
2220 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002221 TCK_ConstructorCall,
2222 /// Checking the operand of a static_cast to a derived pointer type. Must be
2223 /// null or an object within its lifetime.
2224 TCK_DowncastPointer,
2225 /// Checking the operand of a static_cast to a derived reference type. Must
2226 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002227 TCK_DowncastReference,
2228 /// Checking the operand of a cast to a base object. Must be suitably sized
2229 /// and aligned.
2230 TCK_Upcast,
2231 /// Checking the operand of a cast to a virtual base object. Must be an
2232 /// object within its lifetime.
2233 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00002234 };
2235
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002236 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2237 /// calls to EmitTypeCheck can be skipped.
2238 bool sanitizePerformTypeCheck() const;
2239
Richard Smith4d1458e2012-09-08 02:08:36 +00002240 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002241 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002242 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002243 QualType Type, CharUnits Alignment = CharUnits::Zero(),
2244 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002245
Richard Smith539e4a72013-02-23 02:53:19 +00002246 /// \brief Emit a check that \p Base points into an array object, which
2247 /// we can access at index \p Index. \p Accessed should be \c false if we
2248 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2249 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2250 QualType IndexType, bool Accessed);
2251
Chris Lattner116ce8f2010-01-09 21:40:03 +00002252 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2253 bool isInc, bool isPre);
2254 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2255 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002256
2257 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002258 llvm::Value *OffsetValue = nullptr) {
2259 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2260 OffsetValue);
2261 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002262
Amara Emerson652795d2016-11-10 14:44:30 +00002263 /// Converts Location to a DebugLoc, if debug information is enabled.
2264 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2265
2266
Chris Lattner8394d792007-06-05 20:53:16 +00002267 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002268 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002269 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002270
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002271 /// EmitDecl - Emit a declaration.
2272 ///
2273 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002274 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002275
John McCall1c9c3fd2010-10-15 04:57:14 +00002276 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002277 ///
2278 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002279 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002280
David Blaikie73ca5692014-12-09 00:32:22 +00002281 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002282 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002283
John McCallbd309292010-07-06 01:34:17 +00002284 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2285 llvm::Value *Address);
2286
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002287 /// \brief Determine whether the given initializer is trivial in the sense
2288 /// that it requires no code to be generated.
2289 bool isTrivialInitializer(const Expr *Init);
2290
John McCall1c9c3fd2010-10-15 04:57:14 +00002291 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002292 ///
2293 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002294 void EmitAutoVarDecl(const VarDecl &D);
2295
2296 class AutoVarEmission {
2297 friend class CodeGenFunction;
2298
John McCall9e2e22f2011-02-22 07:16:58 +00002299 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002300
John McCall7f416cc2015-09-08 08:05:57 +00002301 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002302 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002303 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002304
2305 llvm::Value *NRVOFlag;
2306
2307 /// True if the variable is a __block variable.
2308 bool IsByRef;
2309
2310 /// True if the variable is of aggregate type and has a constant
2311 /// initializer.
2312 bool IsConstantAggregate;
2313
Nadav Rotem1da30942013-03-23 06:43:35 +00002314 /// Non-null if we should use lifetime annotations.
2315 llvm::Value *SizeForLifetimeMarkers;
2316
John McCall9e2e22f2011-02-22 07:16:58 +00002317 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002318 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002319
John McCallc533cb72011-02-22 06:44:22 +00002320 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002321 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002322 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002323 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002324
John McCall7f416cc2015-09-08 08:05:57 +00002325 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002326
2327 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002328 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2329
Craig Topper8a13c412014-05-21 05:09:00 +00002330 bool useLifetimeMarkers() const {
2331 return SizeForLifetimeMarkers != nullptr;
2332 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002333 llvm::Value *getSizeForLifetimeMarkers() const {
2334 assert(useLifetimeMarkers());
2335 return SizeForLifetimeMarkers;
2336 }
2337
2338 /// Returns the raw, allocated address, which is not necessarily
2339 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002340 Address getAllocatedAddress() const {
2341 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002342 }
2343
John McCallc533cb72011-02-22 06:44:22 +00002344 /// Returns the address of the object within this declaration.
2345 /// Note that this does not chase the forwarding pointer for
2346 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002347 Address getObjectAddress(CodeGenFunction &CGF) const {
2348 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002349
John McCall7f416cc2015-09-08 08:05:57 +00002350 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002351 }
2352 };
2353 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2354 void EmitAutoVarInit(const AutoVarEmission &emission);
2355 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002356 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2357 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002358
John McCall1c9c3fd2010-10-15 04:57:14 +00002359 void EmitStaticVarDecl(const VarDecl &D,
2360 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002361
John McCall7f416cc2015-09-08 08:05:57 +00002362 class ParamValue {
2363 llvm::Value *Value;
2364 unsigned Alignment;
2365 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2366 public:
2367 static ParamValue forDirect(llvm::Value *value) {
2368 return ParamValue(value, 0);
2369 }
2370 static ParamValue forIndirect(Address addr) {
2371 assert(!addr.getAlignment().isZero());
2372 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2373 }
2374
2375 bool isIndirect() const { return Alignment != 0; }
2376 llvm::Value *getAnyValue() const { return Value; }
2377
2378 llvm::Value *getDirectValue() const {
2379 assert(!isIndirect());
2380 return Value;
2381 }
2382
2383 Address getIndirectAddress() const {
2384 assert(isIndirect());
2385 return Address(Value, CharUnits::fromQuantity(Alignment));
2386 }
2387 };
2388
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002389 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002390 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002391
John McCallc07a0c72011-02-17 10:25:35 +00002392 /// protectFromPeepholes - Protect a value that we're intending to
2393 /// store to the side, but which will probably be used later, from
2394 /// aggressive peepholing optimizations that might delete it.
2395 ///
2396 /// Pass the result to unprotectFromPeepholes to declare that
2397 /// protection is no longer required.
2398 ///
2399 /// There's no particular reason why this shouldn't apply to
2400 /// l-values, it's just that no existing peepholes work on pointers.
2401 PeepholeProtection protectFromPeepholes(RValue rvalue);
2402 void unprotectFromPeepholes(PeepholeProtection protection);
2403
Chris Lattner84915fa2007-06-02 04:16:21 +00002404 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002405 // Statement Emission
2406 //===--------------------------------------------------------------------===//
2407
Mike Stumpfc496822009-02-08 23:14:22 +00002408 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002409 void EmitStopPoint(const Stmt *S);
2410
Mike Stumpfc496822009-02-08 23:14:22 +00002411 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2412 /// this function even if there is no current insertion point.
2413 ///
2414 /// This function may clear the current insertion point; callers should use
2415 /// EnsureInsertPoint if they wish to subsequently generate code without first
2416 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002417 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002418
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002419 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002420 /// necessarily require an insertion point or debug information; typically
2421 /// because the statement amounts to a jump or a container of other
2422 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002423 ///
2424 /// \return True if the statement was handled.
2425 bool EmitSimpleStmt(const Stmt *S);
2426
John McCall7f416cc2015-09-08 08:05:57 +00002427 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2428 AggValueSlot AVS = AggValueSlot::ignored());
2429 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2430 bool GetLast = false,
2431 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002432 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002433
Mike Stumpfc496822009-02-08 23:14:22 +00002434 /// EmitLabel - Emit the block for the given label. It is legal to call this
2435 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002436 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002437
Chris Lattnerac248202007-05-30 00:13:02 +00002438 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002439 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002440 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002441 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002442 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002443
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002444 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002445 ArrayRef<const Attr *> Attrs = None);
2446 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002447 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002448 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002449 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002450 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002451 void EmitBreakStmt(const BreakStmt &S);
2452 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002453 void EmitSwitchStmt(const SwitchStmt &S);
2454 void EmitDefaultStmt(const DefaultStmt &S);
2455 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002456 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002457 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002458
Anders Carlsson2e744e82008-08-30 19:51:14 +00002459 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002460 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2461 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002462 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002463 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002464
Gor Nishanov8df64e92016-10-27 16:28:31 +00002465 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002466 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2467
John McCallb609d3f2010-07-07 06:56:46 +00002468 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2469 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002470
Anders Carlsson52d78a52009-09-27 18:58:34 +00002471 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002472 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002473 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002474 void EnterSEHTryStmt(const SEHTryStmt &S);
2475 void ExitSEHTryStmt(const SEHTryStmt &S);
2476
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002477 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002478 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002479
2480 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2481 const SEHExceptStmt &Except);
2482
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002483 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2484 const SEHFinallyStmt &Finally);
2485
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002486 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2487 llvm::Value *ParentFP,
2488 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002489 llvm::Value *EmitSEHExceptionCode();
2490 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002491 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002492
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002493 /// Scan the outlined statement for captures from the parent function. For
2494 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002495 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002496 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002497 bool IsFilter);
2498
2499 /// Recovers the address of a local in a parent function. ParentVar is the
2500 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002501 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002502 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2503 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002504 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2505 Address ParentVar,
2506 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002507
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002508 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002509 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002510
Alexey Bataev1189bd02016-01-26 12:20:39 +00002511 /// Returns calculated size of the specified type.
2512 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002513 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002514 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002515 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002516 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002517 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002518 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002519 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002520 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2521 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002522 /// \brief Perform element by element copying of arrays with type \a
2523 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2524 /// generated by \a CopyGen.
2525 ///
2526 /// \param DestAddr Address of the destination array.
2527 /// \param SrcAddr Address of the source array.
2528 /// \param OriginalType Type of destination and source arrays.
2529 /// \param CopyGen Copying procedure that copies value of single array element
2530 /// to another single array element.
2531 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002532 Address DestAddr, Address SrcAddr, QualType OriginalType,
2533 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002534 /// \brief Emit proper copying of data from one variable to another.
2535 ///
2536 /// \param OriginalType Original type of the copied variables.
2537 /// \param DestAddr Destination address.
2538 /// \param SrcAddr Source address.
2539 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2540 /// type of the base array element).
2541 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2542 /// the base array element).
2543 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2544 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002545 void EmitOMPCopy(QualType OriginalType,
2546 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002547 const VarDecl *DestVD, const VarDecl *SrcVD,
2548 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002549 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2550 /// \a X = \a E \a BO \a E.
2551 ///
2552 /// \param X Value to be updated.
2553 /// \param E Update value.
2554 /// \param BO Binary operation for update operation.
2555 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2556 /// expression, false otherwise.
2557 /// \param AO Atomic ordering of the generated atomic instructions.
2558 /// \param CommonGen Code generator for complex expressions that cannot be
2559 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002560 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2561 /// generated, <false, RValue::get(nullptr)> otherwise.
2562 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002563 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2564 llvm::AtomicOrdering AO, SourceLocation Loc,
2565 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002566 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002567 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002568 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2569 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002570 void EmitOMPUseDevicePtrClause(
2571 const OMPClause &C, OMPPrivateScope &PrivateScope,
2572 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002573 /// \brief Emit code for copyin clause in \a D directive. The next code is
2574 /// generated at the start of outlined functions for directives:
2575 /// \code
2576 /// threadprivate_var1 = master_threadprivate_var1;
2577 /// operator=(threadprivate_var2, master_threadprivate_var2);
2578 /// ...
2579 /// __kmpc_barrier(&loc, global_tid);
2580 /// \endcode
2581 ///
2582 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2583 /// \returns true if at least one copyin variable is found, false otherwise.
2584 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002585 /// \brief Emit initial code for lastprivate variables. If some variable is
2586 /// not also firstprivate, then the default initialization is used. Otherwise
2587 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2588 /// method.
2589 ///
2590 /// \param D Directive that may have 'lastprivate' directives.
2591 /// \param PrivateScope Private scope for capturing lastprivate variables for
2592 /// proper codegen in internal captured statement.
2593 ///
2594 /// \returns true if there is at least one lastprivate variable, false
2595 /// otherwise.
2596 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2597 OMPPrivateScope &PrivateScope);
2598 /// \brief Emit final copying of lastprivate values to original variables at
2599 /// the end of the worksharing or simd directive.
2600 ///
2601 /// \param D Directive that has at least one 'lastprivate' directives.
2602 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2603 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002604 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002605 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002606 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002607 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002608 /// Emit initial code for linear clauses.
2609 void EmitOMPLinearClause(const OMPLoopDirective &D,
2610 CodeGenFunction::OMPPrivateScope &PrivateScope);
2611 /// Emit final code for linear clauses.
2612 /// \param CondGen Optional conditional code for final part of codegen for
2613 /// linear clause.
2614 void EmitOMPLinearClauseFinal(
2615 const OMPLoopDirective &D,
2616 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002617 /// \brief Emit initial code for reduction variables. Creates reduction copies
2618 /// and initializes them with the values according to OpenMP standard.
2619 ///
2620 /// \param D Directive (possibly) with the 'reduction' clause.
2621 /// \param PrivateScope Private scope for capturing reduction variables for
2622 /// proper codegen in internal captured statement.
2623 ///
2624 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2625 OMPPrivateScope &PrivateScope);
2626 /// \brief Emit final update of reduction values to original variables at
2627 /// the end of the directive.
2628 ///
2629 /// \param D Directive that has at least one 'reduction' directives.
2630 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002631 /// \brief Emit initial code for linear variables. Creates private copies
2632 /// and initializes them with the values according to OpenMP standard.
2633 ///
2634 /// \param D Directive (possibly) with the 'linear' clause.
2635 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002636
Alexey Bataev7292c292016-04-25 12:22:29 +00002637 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2638 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002639 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002640 TaskGenTy;
2641 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2642 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002643 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00002644
Alexey Bataev9959db52014-05-06 10:08:46 +00002645 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002646 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002647 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002648 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002649 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002650 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002651 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002652 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002653 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002654 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002655 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002656 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002657 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002658 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002659 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002660 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002661 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002662 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002663 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002664 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002665 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002666 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002667 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002668 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002669 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002670 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002671 void
2672 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002673 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002674 void
2675 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002676 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002677 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002678 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002679 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002680 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002681 void EmitOMPDistributeLoop(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002682 void EmitOMPDistributeParallelForDirective(
2683 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002684 void EmitOMPDistributeParallelForSimdDirective(
2685 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002686 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002687 void EmitOMPTargetParallelForSimdDirective(
2688 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002689 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002690 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00002691 void
2692 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00002693 void EmitOMPTeamsDistributeParallelForSimdDirective(
2694 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00002695 void EmitOMPTeamsDistributeParallelForDirective(
2696 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00002697 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00002698 void EmitOMPTargetTeamsDistributeDirective(
2699 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00002700 void EmitOMPTargetTeamsDistributeParallelForDirective(
2701 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00002702 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
2703 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00002704 void EmitOMPTargetTeamsDistributeSimdDirective(
2705 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002706
Alexey Bataev14fa1c62016-03-29 05:34:15 +00002707 /// Emit outlined function for the target directive.
2708 static std::pair<llvm::Function * /*OutlinedFn*/,
2709 llvm::Constant * /*OutlinedFnID*/>
2710 EmitOMPTargetDirectiveOutlinedFunction(CodeGenModule &CGM,
2711 const OMPTargetDirective &S,
2712 StringRef ParentName,
2713 bool IsOffloadEntry);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002714 /// \brief Emit inner loop of the worksharing/simd construct.
2715 ///
2716 /// \param S Directive, for which the inner loop must be emitted.
2717 /// \param RequiresCleanup true, if directive has some associated private
2718 /// variables.
2719 /// \param LoopCond Bollean condition for loop continuation.
2720 /// \param IncExpr Increment expression for loop control variable.
2721 /// \param BodyGen Generator for the inner body of the inner loop.
2722 /// \param PostIncGen Genrator for post-increment code (required for ordered
2723 /// loop directvies).
2724 void EmitOMPInnerLoop(
2725 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2726 const Expr *IncExpr,
2727 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2728 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002729
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002730 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002731 /// Emit initial code for loop counters of loop-based directives.
2732 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2733 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002734
Alexander Musmanc6388682014-12-15 07:07:06 +00002735private:
George Burgess IVe3763372016-12-22 02:50:20 +00002736 /// Helpers for blocks
2737 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
2738
Alexander Musmanc6388682014-12-15 07:07:06 +00002739 /// Helpers for the OpenMP loop directives.
Alexey Bataev0f34da12015-07-02 04:17:07 +00002740 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002741 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002742 void EmitOMPSimdFinal(
2743 const OMPLoopDirective &D,
2744 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev38e89532015-04-16 04:54:05 +00002745 /// \brief Emit code for the worksharing loop-based directive.
2746 /// \return true, if this construct has any lastprivate clause, false -
2747 /// otherwise.
2748 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002749 void EmitOMPOuterLoop(bool IsMonotonic, bool DynamicOrOrdered,
2750 const OMPLoopDirective &S, OMPPrivateScope &LoopScope, bool Ordered,
2751 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00002752 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002753 bool IsMonotonic, const OMPLoopDirective &S,
2754 OMPPrivateScope &LoopScope, bool Ordered, Address LB,
2755 Address UB, Address ST, Address IL,
2756 llvm::Value *Chunk);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002757 void EmitOMPDistributeOuterLoop(
2758 OpenMPDistScheduleClauseKind ScheduleKind,
2759 const OMPDistributeDirective &S, OMPPrivateScope &LoopScope,
2760 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002761 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002762 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002763
2764public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002765
Chris Lattner208ae962007-05-30 17:57:17 +00002766 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002767 // LValue Expression Emission
2768 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002769
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002770 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2771 RValue GetUndefRValue(QualType Ty);
2772
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002773 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2774 /// and issue an ErrorUnsupported style diagnostic (using the
2775 /// provided Name).
2776 RValue EmitUnsupportedRValue(const Expr *E,
2777 const char *Name);
2778
Mike Stumpfc496822009-02-08 23:14:22 +00002779 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2780 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002781 LValue EmitUnsupportedLValue(const Expr *E,
2782 const char *Name);
2783
Chris Lattner8394d792007-06-05 20:53:16 +00002784 /// EmitLValue - Emit code to compute a designator that specifies the location
2785 /// of the expression.
2786 ///
2787 /// This can return one of two things: a simple address or a bitfield
2788 /// reference. In either case, the LLVM Value* in the LValue structure is
2789 /// guaranteed to be an LLVM pointer type.
2790 ///
2791 /// If this returns a bitfield reference, nothing about the pointee type of
2792 /// the LLVM value is known: For example, it may not be a pointer to an
2793 /// integer.
2794 ///
2795 /// If this returns a normal address, and if the lvalue's C type is fixed
2796 /// size, this method guarantees that the returned pointer type will point to
2797 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2798 /// variable length type, this is not possible.
2799 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002800 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002801
Richard Smith4d1458e2012-09-08 02:08:36 +00002802 /// \brief Same as EmitLValue but additionally we generate checking code to
2803 /// guard against undefined behavior. This is only suitable when we know
2804 /// that the address will be used to access the object.
2805 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002806
John McCall7f416cc2015-09-08 08:05:57 +00002807 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002808 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002809
John McCalla8ec7eb2013-03-07 21:37:17 +00002810 void EmitAtomicInit(Expr *E, LValue lvalue);
2811
David Majnemera5b195a2015-02-14 01:35:12 +00002812 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00002813
2814 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2815 AggValueSlot Slot = AggValueSlot::ignored());
2816
Nick Lewycky2d84e842013-10-02 02:29:49 +00002817 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002818 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002819 AggValueSlot slot = AggValueSlot::ignored());
2820
2821 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2822
David Majnemera5b195a2015-02-14 01:35:12 +00002823 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2824 bool IsVolatile, bool isInit);
2825
Alexey Bataevb4505a72015-03-30 05:20:59 +00002826 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002827 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00002828 llvm::AtomicOrdering Success =
2829 llvm::AtomicOrdering::SequentiallyConsistent,
2830 llvm::AtomicOrdering Failure =
2831 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00002832 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2833
Alexey Bataevb4505a72015-03-30 05:20:59 +00002834 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002835 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002836 bool IsVolatile);
2837
John McCall3a7f6922010-10-27 20:58:56 +00002838 /// EmitToMemory - Change a scalar value from its value
2839 /// representation to its in-memory representation.
2840 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2841
2842 /// EmitFromMemory - Change a scalar value from its memory
2843 /// representation to its value representation.
2844 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2845
Daniel Dunbar1d425462009-02-10 00:57:50 +00002846 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2847 /// care to appropriately convert from the memory representation to
2848 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002849 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002850 SourceLocation Loc,
John McCall7f416cc2015-09-08 08:05:57 +00002851 AlignmentSource AlignSource =
2852 AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002853 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002854 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002855 uint64_t TBAAOffset = 0,
2856 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002857
2858 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2859 /// care to appropriately convert from the memory representation to
2860 /// the LLVM value representation. The l-value must be a simple
2861 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002862 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002863
2864 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2865 /// care to appropriately convert from the memory representation to
2866 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002867 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
2868 bool Volatile, QualType Ty,
2869 AlignmentSource AlignSource = AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002870 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002871 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002872 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002873
2874 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2875 /// care to appropriately convert from the memory representation to
2876 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002877 /// l-value. The isInit flag indicates whether this is an initialization.
2878 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2879 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002880
Chris Lattner8394d792007-06-05 20:53:16 +00002881 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2882 /// this method emits the address of the lvalue, then loads the result as an
2883 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002884 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002885 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2886 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002887 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002888
Chris Lattner8394d792007-06-05 20:53:16 +00002889 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2890 /// lvalue, where both are guaranteed to the have the same type, and that type
2891 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002892 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002893 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002894 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002895
Nick Lewycky2d84e842013-10-02 02:29:49 +00002896 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2897 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002898 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002899 /// \param Result [out] - If non-null, this will be set to a Value* for the
2900 /// bit-field contents after the store, appropriate for use as the result of
2901 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002902 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002903 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002904
John McCall4f29b492010-11-16 23:07:28 +00002905 /// Emit an l-value for an assignment (simple or compound) of complex type.
2906 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002907 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002908 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2909 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002910
Chris Lattner57540c52011-04-15 05:22:18 +00002911 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002912 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002913 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002914 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002915 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002916 // Note: only available for agg return types
2917 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002918 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002919 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002920 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002921 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002922 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002923 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2924 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00002925 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
2926 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002927 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002928 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002929 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002930 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002931 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002932 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002933 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002934 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002935 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002936
John McCall7f416cc2015-09-08 08:05:57 +00002937 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002938
Nick Lewycky2d84e842013-10-02 02:29:49 +00002939 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002940
John McCall7f416cc2015-09-08 08:05:57 +00002941 Address EmitArrayToPointerDecay(const Expr *Array,
2942 AlignmentSource *AlignSource = nullptr);
2943
John McCall71335052012-03-10 03:05:10 +00002944 class ConstantEmission {
2945 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2946 ConstantEmission(llvm::Constant *C, bool isReference)
2947 : ValueAndIsReference(C, isReference) {}
2948 public:
2949 ConstantEmission() {}
2950 static ConstantEmission forReference(llvm::Constant *C) {
2951 return ConstantEmission(C, true);
2952 }
2953 static ConstantEmission forValue(llvm::Constant *C) {
2954 return ConstantEmission(C, false);
2955 }
2956
Aaron Ballman67347662015-02-15 22:00:28 +00002957 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002958 return ValueAndIsReference.getOpaqueValue() != nullptr;
2959 }
John McCall71335052012-03-10 03:05:10 +00002960
2961 bool isReference() const { return ValueAndIsReference.getInt(); }
2962 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2963 assert(isReference());
2964 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2965 refExpr->getType());
2966 }
2967
2968 llvm::Constant *getValue() const {
2969 assert(!isReference());
2970 return ValueAndIsReference.getPointer();
2971 }
2972 };
2973
John McCall113bee02012-03-10 09:33:50 +00002974 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002975
John McCallfe96e0b2011-11-06 09:01:30 +00002976 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2977 AggValueSlot slot = AggValueSlot::ignored());
2978 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2979
Daniel Dunbar722f4242009-04-22 05:08:15 +00002980 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002981 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002982 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002983 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002984
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002985 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2986 /// if the Field is a reference, this will return the address of the reference
2987 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002988 LValue EmitLValueForFieldInitialization(LValue Base,
2989 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002990
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002991 LValue EmitLValueForIvar(QualType ObjectTy,
2992 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002993 unsigned CVRQualifiers);
2994
Anders Carlsson3be22e22009-05-30 23:23:33 +00002995 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002996 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002997 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002998 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002999 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003000
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003001 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003002 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003003 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003004 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003005 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003006 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003007
Chris Lattnerd7f58862007-06-02 05:24:33 +00003008 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003009 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003010 //===--------------------------------------------------------------------===//
3011
Mike Stumpfc496822009-02-08 23:14:22 +00003012 /// EmitCall - Generate a call of the given function, expecting the given
3013 /// result type, and using the given argument list which specifies both the
3014 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003015 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003016 ReturnValueSlot ReturnValue, const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00003017 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003018
John McCallb92ab1a2016-10-26 23:46:34 +00003019 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003020 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00003021 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003022 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003023 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003024 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3025 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003026
Eric Christopherc7e79db2015-11-12 00:44:04 +00003027 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003028
John McCall882987f2013-02-28 19:01:20 +00003029 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3030 const Twine &name = "");
3031 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3032 ArrayRef<llvm::Value*> args,
3033 const Twine &name = "");
3034 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3035 const Twine &name = "");
3036 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3037 ArrayRef<llvm::Value*> args,
3038 const Twine &name = "");
3039
John McCallbd309292010-07-06 01:34:17 +00003040 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003041 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00003042 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00003043 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3044 ArrayRef<llvm::Value*> args,
3045 const Twine &name = "");
3046 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3047 const Twine &name = "");
3048 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3049 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00003050
John McCallb92ab1a2016-10-26 23:46:34 +00003051 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
3052 NestedNameSpecifier *Qual,
3053 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00003054
John McCallb92ab1a2016-10-26 23:46:34 +00003055 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
3056 CXXDtorType Type,
3057 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003058
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003059 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003060 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3061 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003062 ReturnValueSlot ReturnValue, llvm::Value *This,
3063 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003064 QualType ImplicitParamTy, const CallExpr *E,
3065 CallArgList *RtlArgs);
John McCallb92ab1a2016-10-26 23:46:34 +00003066 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3067 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003068 llvm::Value *This, llvm::Value *ImplicitParam,
3069 QualType ImplicitParamTy, const CallExpr *E,
3070 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003071 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3072 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003073 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3074 const CXXMethodDecl *MD,
3075 ReturnValueSlot ReturnValue,
3076 bool HasQualifier,
3077 NestedNameSpecifier *Qualifier,
3078 bool IsArrow, const Expr *Base);
3079 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003080 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3081 llvm::Value *memberPtr,
3082 const MemberPointerType *memberPtrType,
3083 AlignmentSource *AlignSource = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003084 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3085 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003086
Anders Carlsson4034a952009-05-27 04:18:27 +00003087 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003088 const CXXMethodDecl *MD,
3089 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003090 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003091
Peter Collingbournefe883422011-10-06 18:29:37 +00003092 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3093 ReturnValueSlot ReturnValue);
3094
Justin Lebar3039a592016-01-23 21:28:14 +00003095 RValue EmitCUDADevicePrintfCallExpr(const CallExpr *E,
3096 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003097
Mike Stump11289f42009-09-09 15:08:12 +00003098 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00003099 unsigned BuiltinID, const CallExpr *E,
3100 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003101
Anders Carlssonbfb36712009-12-24 21:13:40 +00003102 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003103
Mike Stumpfc496822009-02-08 23:14:22 +00003104 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3105 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003106 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3107
Kevin Qin1718af62013-11-14 02:45:18 +00003108 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3109 const llvm::CmpInst::Predicate Fp,
3110 const llvm::CmpInst::Predicate Ip,
3111 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00003112 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00003113
3114 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3115 unsigned LLVMIntrinsic,
3116 unsigned AltLLVMIntrinsic,
3117 const char *NameHint,
3118 unsigned Modifier,
3119 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003120 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00003121 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00003122 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3123 unsigned Modifier, llvm::Type *ArgTy,
3124 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003125 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003126 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003127 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003128 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003129 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003130 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003131 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003132 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3133 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003134 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00003135 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003136
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003137 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003138 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3139 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003140 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003141 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003142 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003143 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3144 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003145
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003146private:
3147 enum class MSVCIntrin;
3148
3149public:
3150 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3151
Daniel Dunbar66912a12008-08-20 00:28:19 +00003152 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003153 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003154 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003155 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3156 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3157 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003158 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003159 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003160 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3161 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003162
John McCall31168b02011-06-15 23:02:42 +00003163 /// Retrieves the default cleanup kind for an ARC cleanup.
3164 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3165 CleanupKind getARCCleanupKind() {
3166 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3167 ? NormalAndEHCleanup : NormalCleanup;
3168 }
3169
3170 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003171 void EmitARCInitWeak(Address addr, llvm::Value *value);
3172 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003173 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003174 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3175 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3176 void EmitARCCopyWeak(Address dst, Address src);
3177 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003178 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3179 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003180 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003181 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003182 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003183 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003184 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003185 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003186 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003187 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003188 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003189 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003190 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3191 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3192 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003193 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003194
3195 std::pair<LValue,llvm::Value*>
3196 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3197 std::pair<LValue,llvm::Value*>
3198 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003199 std::pair<LValue,llvm::Value*>
3200 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003201
John McCall248512a2011-10-01 10:32:24 +00003202 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003203 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3204 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3205
John McCallff613032011-10-04 06:23:45 +00003206 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003207 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3208 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003209 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3210 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003211 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003212
Craig Topper00bbdcf2014-06-28 23:22:23 +00003213 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003214
John McCall82fe67b2011-07-09 01:37:26 +00003215 static Destroyer destroyARCStrongImprecise;
3216 static Destroyer destroyARCStrongPrecise;
3217 static Destroyer destroyARCWeak;
3218
John McCall31168b02011-06-15 23:02:42 +00003219 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3220 llvm::Value *EmitObjCAutoreleasePoolPush();
3221 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3222 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3223 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3224
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003225 /// \brief Emits a reference binding to the passed in expression.
3226 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003227
Chris Lattner6278e6a2007-08-11 00:04:45 +00003228 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003229 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003230 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003231
3232 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003233
3234 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3235 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003236 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003237
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003238 /// Emit a conversion from the specified type to the specified destination
3239 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003240 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003241 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003242
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003243 /// Emit a conversion from the specified complex type to the specified
3244 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003245 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003246 QualType DstTy,
3247 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003248
John McCall7a626f62010-09-15 10:14:12 +00003249 /// EmitAggExpr - Emit the computation of the specified expression
3250 /// of aggregate type. The result is computed into the given slot,
3251 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003252 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003253
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003254 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3255 /// aggregate type into a temporary LValue.
3256 LValue EmitAggExprToLValue(const Expr *E);
3257
John McCall1bd25562011-06-24 23:21:27 +00003258 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3259 /// make sure it survives garbage collection until this point.
3260 void EmitExtendGCLifetime(llvm::Value *object);
3261
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003262 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003263 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003264 ComplexPairTy EmitComplexExpr(const Expr *E,
3265 bool IgnoreReal = false,
3266 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003267
John McCall47fb9502013-03-07 21:37:08 +00003268 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3269 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003270 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003271
John McCall47fb9502013-03-07 21:37:08 +00003272 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003273 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003274
3275 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003276 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003277
John McCall7f416cc2015-09-08 08:05:57 +00003278 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3279 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3280
Chandler Carruth84537952012-03-30 19:44:53 +00003281 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3282 /// global variable that has already been created for it. If the initializer
3283 /// has a different type than GV does, this may free GV and return a different
3284 /// one. Otherwise it just returns GV.
3285 llvm::GlobalVariable *
3286 AddInitializerToStaticVarDecl(const VarDecl &D,
3287 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003288
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003289
Anders Carlssonf40886a2009-08-08 21:45:14 +00003290 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3291 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003292 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3293 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003294
David Majnemerb3341ea2014-10-05 05:05:40 +00003295 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3296 llvm::Constant *Addr);
3297
John McCallc84ed6a2012-05-01 06:13:13 +00003298 /// Call atexit() with a function that passes the given argument to
3299 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003300 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3301 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003302
John McCallcdf7ef52010-11-06 09:44:32 +00003303 /// Emit code in this function to perform a guarded variable
3304 /// initialization. Guarded initializations are used when it's not
3305 /// possible to prove that an initialization will be done exactly
3306 /// once, e.g. with a static local variable or a static data member
3307 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003308 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003309 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003310
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003311 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3312 /// variables.
3313 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003314 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003315 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003316
John McCallee08c532012-04-06 18:21:03 +00003317 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003318 /// variables.
John McCallee08c532012-04-06 18:21:03 +00003319 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
3320 const std::vector<std::pair<llvm::WeakVH,
3321 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003322
John McCalla738c252011-03-09 04:27:21 +00003323 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3324 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003325 llvm::GlobalVariable *Addr,
3326 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003327
John McCall7a626f62010-09-15 10:14:12 +00003328 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00003329
John McCall7f416cc2015-09-08 08:05:57 +00003330 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003331
John McCall08ef4662011-11-10 08:15:53 +00003332 void enterFullExpression(const ExprWithCleanups *E) {
3333 if (E->getNumObjects() == 0) return;
3334 enterNonTrivialFullExpression(E);
3335 }
3336 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003337
Richard Smithea852322013-05-07 21:53:22 +00003338 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003339
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003340 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3341
Tim Northovercc2a6e02015-11-09 19:56:35 +00003342 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003343
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003344 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003345 // Annotations Emission
3346 //===--------------------------------------------------------------------===//
3347
3348 /// Emit an annotation call (intrinsic or builtin).
3349 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3350 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003351 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003352 SourceLocation Location);
3353
3354 /// Emit local annotations for the local variable V, declared by D.
3355 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3356
3357 /// Emit field annotations for the given field & value. Returns the
3358 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003359 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003360
3361 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003362 // Internal Helpers
3363 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003364
Chris Lattner5b1964b2008-11-11 07:41:27 +00003365 /// ContainsLabel - Return true if the statement contains a label in it. If
3366 /// this statement is not executed normally, it not containing a label means
3367 /// that we can just remove the code.
3368 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003369
Chris Lattner29911cc2011-02-28 00:18:40 +00003370 /// containsBreak - Return true if the statement contains a break out of it.
3371 /// If the statement (recursively) contains a switch or loop with a break
3372 /// inside of it, this is fine.
3373 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003374
3375 /// Determine if the given statement might introduce a declaration into the
3376 /// current scope, by being a (possibly-labelled) DeclStmt.
3377 static bool mightAddDeclToScope(const Stmt *S);
Chris Lattner29911cc2011-02-28 00:18:40 +00003378
Daniel Dunbar682712c2008-11-12 10:12:14 +00003379 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003380 /// to a constant, or if it does but contains a label, return false. If it
3381 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003382 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3383 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003384
Chris Lattner29911cc2011-02-28 00:18:40 +00003385 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3386 /// to a constant, or if it does but contains a label, return false. If it
3387 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003388 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3389 bool AllowLabels = false);
3390
Chris Lattnercd439292008-11-12 08:04:58 +00003391 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3392 /// if statement) to the specified blocks. Based on the condition, this might
3393 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003394 /// TrueCount should be the number of times we expect the condition to
3395 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003396 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003397 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003398
Richard Smithe30752c2012-10-09 19:52:38 +00003399 /// \brief Emit a description of a type in a format suitable for passing to
3400 /// a runtime sanitizer handler.
3401 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3402
3403 /// \brief Convert a value into a format suitable for passing to a runtime
3404 /// sanitizer handler.
3405 llvm::Value *EmitCheckValue(llvm::Value *V);
3406
3407 /// \brief Emit a description of a source location in a format suitable for
3408 /// passing to a runtime sanitizer handler.
3409 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3410
Richard Smithde670682012-11-01 22:15:34 +00003411 /// \brief Create a basic block that will call a handler function in a
3412 /// sanitizer runtime with the provided arguments, and create a conditional
3413 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003414 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00003415 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003416 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003417
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003418 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3419 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003420 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3421 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3422 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003423
Richard Smithde670682012-11-01 22:15:34 +00003424 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3425 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003426 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003427
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003428 /// \brief Emit a call to trap or debugtrap and attach function attribute
3429 /// "trap-func-name" if specified.
3430 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3431
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003432 /// \brief Emit a cross-DSO CFI failure handling function.
3433 void EmitCfiCheckFail();
3434
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003435 /// \brief Create a check for a function parameter that may potentially be
3436 /// declared as non-null.
3437 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
3438 const FunctionDecl *FD, unsigned ParmNum);
3439
Anders Carlsson093bdff2010-03-30 03:27:09 +00003440 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003441 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003442
John McCall23f66262010-05-26 22:34:26 +00003443 /// EmitDelegateCallArg - We are performing a delegate call; that
3444 /// is, the current function is delegating to another one. Produce
3445 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003446 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3447 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003448
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003449 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3450 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003451 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003452
Chris Lattnercd439292008-11-12 08:04:58 +00003453private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003454 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003455 void EmitReturnOfRValue(RValue RV, QualType Ty);
3456
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003457 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3458
3459 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3460 DeferredReplacements;
3461
John McCall7f416cc2015-09-08 08:05:57 +00003462 /// Set the address of a local variable.
3463 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3464 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3465 LocalDeclMap.insert({VD, Addr});
3466 }
3467
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003468 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3469 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3470 ///
3471 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003472 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003473 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003474
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003475 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3476 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3477 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3478 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3479 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3480 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003481
Chad Rosier59df25b2012-08-23 20:00:18 +00003482 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003483 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003484
Chad Rosier59df25b2012-08-23 20:00:18 +00003485 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003486 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003487 std::string &ConstraintStr,
3488 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003489
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003490 /// \brief Attempts to statically evaluate the object size of E. If that
3491 /// fails, emits code to figure the size of E out for us. This is
3492 /// pass_object_size aware.
3493 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
3494 llvm::IntegerType *ResType);
3495
3496 /// \brief Emits the size of E, as required by __builtin_object_size. This
3497 /// function is aware of pass_object_size parameters, and will act accordingly
3498 /// if E is a parameter with the pass_object_size attribute.
3499 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
3500 llvm::IntegerType *ResType);
3501
Reid Kleckner89077a12013-12-17 19:46:40 +00003502public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003503#ifndef NDEBUG
3504 // Determine whether the given argument is an Objective-C method
3505 // that may have type parameters in its signature.
3506 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3507 const DeclContext *dc = method->getDeclContext();
3508 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3509 return classDecl->getTypeParamListAsWritten();
3510 }
3511
3512 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3513 return catDecl->getTypeParamList();
3514 }
3515
3516 return false;
3517 }
3518
3519 template<typename T>
3520 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3521#endif
3522
Richard Smitha560ccf2016-09-29 21:30:12 +00003523 enum class EvaluationOrder {
3524 ///! No language constraints on evaluation order.
3525 Default,
3526 ///! Language semantics require left-to-right evaluation.
3527 ForceLeftToRight,
3528 ///! Language semantics require right-to-left evaluation.
3529 ForceRightToLeft
3530 };
3531
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003532 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003533 template <typename T>
3534 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003535 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003536 const FunctionDecl *CalleeDecl = nullptr,
Richard Smith762672a2016-09-28 19:09:10 +00003537 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003538 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003539 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003540 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003541
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003542 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3543 "Can't skip parameters if type info is not provided");
3544 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003545#ifndef NDEBUG
3546 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3547#endif
3548
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003549 // First, use the argument types that the type info knows about
3550 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3551 E = CallArgTypeInfo->param_type_end();
3552 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003553 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003554 assert((isGenericMethod ||
3555 ((*I)->isVariablyModifiedType() ||
3556 (*I).getNonReferenceType()->isObjCRetainableType() ||
3557 getContext()
3558 .getCanonicalType((*I).getNonReferenceType())
3559 .getTypePtr() ==
3560 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003561 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003562 .getTypePtr())) &&
3563 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003564 ArgTypes.push_back(*I);
3565 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003566 }
Mike Stump11289f42009-09-09 15:08:12 +00003567
Reid Kleckner739756c2013-12-04 19:23:12 +00003568 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003569 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003570 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3571 CallArgTypeInfo->isVariadic()) &&
3572 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003573
Anders Carlsson603d6af2009-04-18 20:20:22 +00003574 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003575 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00003576 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003577
Richard Smitha560ccf2016-09-29 21:30:12 +00003578 EmitCallArgs(Args, ArgTypes, ArgRange, CalleeDecl, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003579 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003580
Reid Kleckner739756c2013-12-04 19:23:12 +00003581 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003582 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003583 const FunctionDecl *CalleeDecl = nullptr,
Richard Smith762672a2016-09-28 19:09:10 +00003584 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003585 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00003586
John McCall7f416cc2015-09-08 08:05:57 +00003587 /// EmitPointerWithAlignment - Given an expression with a pointer
3588 /// type, emit the value and compute our best estimate of the
3589 /// alignment of the pointee.
3590 ///
3591 /// Note that this function will conservatively fall back on the type
3592 /// when it doesn't
3593 ///
3594 /// \param Source - If non-null, this will be initialized with
3595 /// information about the source of the alignment. Note that this
3596 /// function will conservatively fall back on the type when it
3597 /// doesn't recognize the expression, which means that sometimes
3598 ///
3599 /// a worst-case One
3600 /// reasonable way to use this information is when there's a
3601 /// language guarantee that the pointer must be aligned to some
3602 /// stricter value, and we're simply trying to ensure that
3603 /// sufficiently obvious uses of under-aligned objects don't get
3604 /// miscompiled; for example, a placement new into the address of
3605 /// a local variable. In such a case, it's quite reasonable to
3606 /// just ignore the returned alignment when it isn't from an
3607 /// explicit source.
3608 Address EmitPointerWithAlignment(const Expr *Addr,
3609 AlignmentSource *Source = nullptr);
3610
Peter Collingbournedc134532016-01-16 00:31:22 +00003611 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3612
Reid Kleckner89077a12013-12-17 19:46:40 +00003613private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003614 QualType getVarArgType(const Expr *Arg);
3615
John McCalld4f4b7f2010-03-03 04:15:11 +00003616 const TargetCodeGenInfo &getTargetHooks() const {
3617 return CGM.getTargetCodeGenInfo();
3618 }
John McCall09ae0322010-07-06 23:57:41 +00003619
3620 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003621
John McCall7f416cc2015-09-08 08:05:57 +00003622 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3623 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003624
3625 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003626
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003627 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003628};
Mike Stump11289f42009-09-09 15:08:12 +00003629
John McCallce1de612011-01-26 04:00:11 +00003630/// Helper class with most of the code for saving a value for a
3631/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003632struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003633 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3634
3635 /// Answer whether the given value needs extra work to be saved.
3636 static bool needsSaving(llvm::Value *value) {
3637 // If it's not an instruction, we don't need to save.
3638 if (!isa<llvm::Instruction>(value)) return false;
3639
3640 // If it's an instruction in the entry block, we don't need to save.
3641 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3642 return (block != &block->getParent()->getEntryBlock());
3643 }
3644
3645 /// Try to save the given value.
3646 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3647 if (!needsSaving(value)) return saved_type(value, false);
3648
John McCall7f416cc2015-09-08 08:05:57 +00003649 // Otherwise, we need an alloca.
3650 auto align = CharUnits::fromQuantity(
3651 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3652 Address alloca =
3653 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003654 CGF.Builder.CreateStore(value, alloca);
3655
John McCall7f416cc2015-09-08 08:05:57 +00003656 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003657 }
3658
3659 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003660 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003661 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003662
3663 // Otherwise, it should be an alloca instruction, as set up in save().
3664 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3665 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003666 }
3667};
3668
John McCallcb5f77f2011-01-28 10:53:53 +00003669/// A partial specialization of DominatingValue for llvm::Values that
3670/// might be llvm::Instructions.
3671template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3672 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003673 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003674 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3675 }
3676};
3677
John McCall7f416cc2015-09-08 08:05:57 +00003678/// A specialization of DominatingValue for Address.
3679template <> struct DominatingValue<Address> {
3680 typedef Address type;
3681
3682 struct saved_type {
3683 DominatingLLVMValue::saved_type SavedValue;
3684 CharUnits Alignment;
3685 };
3686
3687 static bool needsSaving(type value) {
3688 return DominatingLLVMValue::needsSaving(value.getPointer());
3689 }
3690 static saved_type save(CodeGenFunction &CGF, type value) {
3691 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3692 value.getAlignment() };
3693 }
3694 static type restore(CodeGenFunction &CGF, saved_type value) {
3695 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3696 value.Alignment);
3697 }
3698};
3699
John McCallcb5f77f2011-01-28 10:53:53 +00003700/// A specialization of DominatingValue for RValue.
3701template <> struct DominatingValue<RValue> {
3702 typedef RValue type;
3703 class saved_type {
3704 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3705 AggregateAddress, ComplexAddress };
3706
3707 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003708 unsigned K : 3;
3709 unsigned Align : 29;
3710 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3711 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003712
3713 public:
3714 static bool needsSaving(RValue value);
3715 static saved_type save(CodeGenFunction &CGF, RValue value);
3716 RValue restore(CodeGenFunction &CGF);
3717
John McCall7f416cc2015-09-08 08:05:57 +00003718 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003719 };
3720
3721 static bool needsSaving(type value) {
3722 return saved_type::needsSaving(value);
3723 }
3724 static saved_type save(CodeGenFunction &CGF, type value) {
3725 return saved_type::save(CGF, value);
3726 }
3727 static type restore(CodeGenFunction &CGF, saved_type value) {
3728 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003729 }
3730};
3731
Chris Lattnerbed31442007-05-28 01:07:47 +00003732} // end namespace CodeGen
3733} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003734
Chris Lattnerbed31442007-05-28 01:07:47 +00003735#endif