blob: b2bcd1cfbd3945975d43b4c1544cce1d6cf5b51b [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"
Reid Kleckner06f19a02018-01-02 21:34:16 +000037#include "llvm/ADT/MapVector.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000038#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000039#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000040#include "llvm/Support/Debug.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000041#include "llvm/Transforms/Utils/SanitizerStats.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000042
Chris Lattnerbed31442007-05-28 01:07:47 +000043namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000044class BasicBlock;
45class LLVMContext;
46class MDNode;
47class Module;
48class SwitchInst;
49class Twine;
50class Value;
51class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000052}
53
Chris Lattnerbed31442007-05-28 01:07:47 +000054namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000055class ASTContext;
56class BlockDecl;
57class CXXDestructorDecl;
58class CXXForRangeStmt;
59class CXXTryStmt;
60class Decl;
61class LabelDecl;
62class EnumConstantDecl;
63class FunctionDecl;
64class FunctionProtoType;
65class LabelStmt;
66class ObjCContainerDecl;
67class ObjCInterfaceDecl;
68class ObjCIvarDecl;
69class ObjCMethodDecl;
70class ObjCImplementationDecl;
71class ObjCPropertyImplDecl;
72class TargetInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000073class VarDecl;
74class ObjCForCollectionStmt;
75class ObjCAtTryStmt;
76class ObjCAtThrowStmt;
77class ObjCAtSynchronizedStmt;
78class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000079
Akira Hatanaka6b103bc2017-10-06 07:12:46 +000080namespace analyze_os_log {
81class OSLogBufferLayout;
82}
83
Chris Lattnerbed31442007-05-28 01:07:47 +000084namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000085class CodeGenTypes;
John McCallb92ab1a2016-10-26 23:46:34 +000086class CGCallee;
Rafael Espindola42ae7452014-05-09 00:57:59 +000087class CGFunctionInfo;
88class CGRecordLayout;
89class CGBlockInfo;
90class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000091class BlockByrefHelpers;
92class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000093class BlockFlags;
94class BlockFieldFlags;
Alexey Bataev7292c292016-04-25 12:22:29 +000095class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000096class TargetCodeGenInfo;
Alexey Bataev24b5bae2016-04-28 09:23:51 +000097struct OMPTaskDataTy;
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000098struct CGCoroData;
Mike Stumpfc496822009-02-08 23:14:22 +000099
John McCall47fb9502013-03-07 21:37:08 +0000100/// The kind of evaluation to perform on values of a particular
101/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
102/// CGExprAgg?
103///
104/// TODO: should vectors maybe be split out into their own thing?
105enum TypeEvaluationKind {
106 TEK_Scalar,
107 TEK_Complex,
108 TEK_Aggregate
109};
110
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000111#define LIST_SANITIZER_CHECKS \
112 SANITIZER_CHECK(AddOverflow, add_overflow, 0) \
113 SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \
114 SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \
115 SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \
116 SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \
117 SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \
118 SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0) \
Vedant Kumar10c31022017-07-29 00:19:51 +0000119 SANITIZER_CHECK(InvalidBuiltin, invalid_builtin, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000120 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
121 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
122 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
123 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000124 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000125 SANITIZER_CHECK(NullabilityReturn, nullability_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000126 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000127 SANITIZER_CHECK(NonnullReturn, nonnull_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000128 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
Vedant Kumara125eb52017-06-01 19:22:18 +0000129 SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000130 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
131 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
Filipe Cabecinhasfe5e5af2017-01-06 14:40:12 +0000132 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000133 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
134
135enum SanitizerHandler {
136#define SANITIZER_CHECK(Enum, Name, Version) Enum,
137 LIST_SANITIZER_CHECKS
138#undef SANITIZER_CHECK
139};
140
Chris Lattnerbed31442007-05-28 01:07:47 +0000141/// CodeGenFunction - This class organizes the per-function state that is used
142/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000143class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000144 CodeGenFunction(const CodeGenFunction &) = delete;
145 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000146
147 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000148public:
John McCallad5d61e2010-07-23 21:56:41 +0000149 /// A jump destination is an abstract label, branching to which may
150 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000151 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000152 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000153 JumpDest(llvm::BasicBlock *Block,
154 EHScopeStack::stable_iterator Depth,
155 unsigned Index)
156 : Block(Block), ScopeDepth(Depth), Index(Index) {}
157
Craig Topper8a13c412014-05-21 05:09:00 +0000158 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000159 llvm::BasicBlock *getBlock() const { return Block; }
160 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
161 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000162
Nadav Rotem1da30942013-03-23 06:43:35 +0000163 // This should be used cautiously.
164 void setScopeDepth(EHScopeStack::stable_iterator depth) {
165 ScopeDepth = depth;
166 }
167
John McCallad5d61e2010-07-23 21:56:41 +0000168 private:
John McCallbd309292010-07-06 01:34:17 +0000169 llvm::BasicBlock *Block;
170 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000171 unsigned Index;
172 };
173
Chris Lattnerbed31442007-05-28 01:07:47 +0000174 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000175 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000176
Chris Lattner96d72562007-08-21 16:57:55 +0000177 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000178 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000179 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000180
Vitaly Buka64c80b42016-10-26 05:42:30 +0000181 // Stores variables for which we can't generate correct lifetime markers
182 // because of jumps.
183 VarBypassDetector Bypasses;
184
Carlo Bertollib0ff0a62017-04-25 17:52:12 +0000185 // CodeGen lambda for loops and support for ordered clause
186 typedef llvm::function_ref<void(CodeGenFunction &, const OMPLoopDirective &,
187 JumpDest)>
188 CodeGenLoopTy;
189 typedef llvm::function_ref<void(CodeGenFunction &, SourceLocation,
190 const unsigned, const bool)>
191 CodeGenOrderedTy;
192
193 // Codegen lambda for loop bounds in worksharing loop constructs
194 typedef llvm::function_ref<std::pair<LValue, LValue>(
195 CodeGenFunction &, const OMPExecutableDirective &S)>
196 CodeGenLoopBoundsTy;
197
198 // Codegen lambda for loop bounds in dispatch-based loop implementation
199 typedef llvm::function_ref<std::pair<llvm::Value *, llvm::Value *>(
200 CodeGenFunction &, const OMPExecutableDirective &S, Address LB,
201 Address UB)>
202 CodeGenDispatchBoundsTy;
203
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000204 /// CGBuilder insert helper. This function is called after an
Alexander Musman515ad8c2014-05-22 08:54:05 +0000205 /// instruction is created using Builder.
206 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
207 llvm::BasicBlock *BB,
208 llvm::BasicBlock::iterator InsertPt) const;
209
John McCalldec348f72013-05-03 07:33:41 +0000210 /// CurFuncDecl - Holds the Decl for the current outermost
211 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000212 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000213 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
214 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000215 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000216 QualType FnRetTy;
Erich Keane9960b8f2018-07-10 20:51:41 +0000217 llvm::Function *CurFn;
Chris Lattnerac248202007-05-30 00:13:02 +0000218
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000219 // Holds coroutine data if the current function is a coroutine. We use a
220 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
221 // in this header.
222 struct CGCoroInfo {
223 std::unique_ptr<CGCoroData> Data;
224 CGCoroInfo();
225 ~CGCoroInfo();
226 };
227 CGCoroInfo CurCoro;
228
Gor Nishanov04491bd2017-11-11 17:00:43 +0000229 bool isCoroutine() const {
230 return CurCoro.Data != nullptr;
231 }
232
Mike Stumpbee78dd2009-12-04 23:26:17 +0000233 /// CurGD - The GlobalDecl for the current function being compiled.
234 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000235
John McCall31168b02011-06-15 23:02:42 +0000236 /// PrologueCleanupDepth - The cleanup depth enclosing all the
237 /// cleanups associated with the parameters.
238 EHScopeStack::stable_iterator PrologueCleanupDepth;
239
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000240 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000241 JumpDest ReturnBlock;
242
John McCall7f416cc2015-09-08 08:05:57 +0000243 /// ReturnValue - The temporary alloca to hold the return
244 /// value. This is invalid iff the function has no return value.
Erich Keane9960b8f2018-07-10 20:51:41 +0000245 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000246
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000247 /// Return true if a label was seen in the current scope.
248 bool hasLabelBeenSeenInCurrentScope() const {
249 if (CurLexicalScope)
250 return CurLexicalScope->hasLabels();
251 return !LabelMap.empty();
252 }
253
Chris Lattner03df1222007-06-02 04:53:11 +0000254 /// AllocaInsertPoint - This is an instruction in the entry block before which
255 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000256 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000257
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000258 /// API for captured statement code generation.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000259 class CGCapturedStmtInfo {
260 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000261 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
262 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000263 explicit CGCapturedStmtInfo(const CapturedStmt &S,
264 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000265 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000266
267 RecordDecl::field_iterator Field =
268 S.getCapturedRecordDecl()->field_begin();
269 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
270 E = S.capture_end();
271 I != E; ++I, ++Field) {
272 if (I->capturesThis())
273 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000274 else if (I->capturesVariable())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000275 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000276 else if (I->capturesVariableByCopy())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000277 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000278 }
279 }
280
281 virtual ~CGCapturedStmtInfo();
282
283 CapturedRegionKind getKind() const { return Kind; }
284
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000285 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000286 // Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000287 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000288
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000289 /// Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000290 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000291 return CaptureFields.lookup(VD->getCanonicalDecl());
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000292 }
293
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000294 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
295 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000296
Alexey Bataev18095712014-10-10 12:19:54 +0000297 static bool classof(const CGCapturedStmtInfo *) {
298 return true;
299 }
300
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000301 /// Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000302 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000303 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000304 CGF.EmitStmt(S);
305 }
306
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000307 /// Get the name of the capture helper.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000308 virtual StringRef getHelperName() const { return "__captured_stmt"; }
309
310 private:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000311 /// The kind of captured statement being generated.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000312 CapturedRegionKind Kind;
313
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000314 /// Keep the map between VarDecl and FieldDecl.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000315 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
316
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000317 /// The base address of the captured record, passed in as the first
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000318 /// argument of the parallel region function.
319 llvm::Value *ThisValue;
320
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000321 /// Captured 'this' type.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000322 FieldDecl *CXXThisFieldDecl;
323 };
Erich Keane9960b8f2018-07-10 20:51:41 +0000324 CGCapturedStmtInfo *CapturedStmtInfo;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000325
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000326 /// RAII for correct setting/restoring of CapturedStmtInfo.
Alexey Bataevd157d472015-06-24 03:35:38 +0000327 class CGCapturedStmtRAII {
328 private:
329 CodeGenFunction &CGF;
330 CGCapturedStmtInfo *PrevCapturedStmtInfo;
331 public:
332 CGCapturedStmtRAII(CodeGenFunction &CGF,
333 CGCapturedStmtInfo *NewCapturedStmtInfo)
334 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
335 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
336 }
337 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
338 };
339
Vedant Kumared00ea02017-03-06 05:28:22 +0000340 /// An abstract representation of regular/ObjC call/message targets.
341 class AbstractCallee {
342 /// The function declaration of the callee.
343 const Decl *CalleeDecl;
344
345 public:
346 AbstractCallee() : CalleeDecl(nullptr) {}
347 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
348 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
349 bool hasFunctionDecl() const {
350 return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
351 }
352 const Decl *getDecl() const { return CalleeDecl; }
353 unsigned getNumParams() const {
354 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
355 return FD->getNumParams();
356 return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
357 }
358 const ParmVarDecl *getParamDecl(unsigned I) const {
359 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
360 return FD->getParamDecl(I);
361 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
362 }
363 };
364
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000365 /// Sanitizers enabled for this function.
Alexey Samsonova0416102014-11-11 01:26:14 +0000366 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000367
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000368 /// True if CodeGen currently emits code implementing sanitizer checks.
Erich Keane9960b8f2018-07-10 20:51:41 +0000369 bool IsSanitizerScope;
Alexey Samsonov24cad992014-07-17 18:46:27 +0000370
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000371 /// RAII object to set/unset CodeGenFunction::IsSanitizerScope.
Alexey Samsonov24cad992014-07-17 18:46:27 +0000372 class SanitizerScope {
373 CodeGenFunction *CGF;
374 public:
375 SanitizerScope(CodeGenFunction *CGF);
376 ~SanitizerScope();
377 };
378
Reid Kleckner19819442014-07-25 21:39:46 +0000379 /// In C++, whether we are code generating a thunk. This controls whether we
380 /// should emit cleanups.
Erich Keane9960b8f2018-07-10 20:51:41 +0000381 bool CurFuncIsThunk;
Reid Kleckner19819442014-07-25 21:39:46 +0000382
John McCall31168b02011-06-15 23:02:42 +0000383 /// In ARC, whether we should autorelease the return value.
Erich Keane9960b8f2018-07-10 20:51:41 +0000384 bool AutoreleaseResult;
John McCall31168b02011-06-15 23:02:42 +0000385
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000386 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
387 /// potentially set the return value.
Erich Keane9960b8f2018-07-10 20:51:41 +0000388 bool SawAsmBlock;
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000389
David Majnemer25eb1652016-03-01 19:42:53 +0000390 const FunctionDecl *CurSEHParent = nullptr;
391
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000392 /// True if the current function is an outlined SEH helper. This can be a
393 /// finally block or filter expression.
Erich Keane9960b8f2018-07-10 20:51:41 +0000394 bool IsOutlinedSEHHelper;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000395
Erich Keane9960b8f2018-07-10 20:51:41 +0000396 const CodeGen::CGBlockInfo *BlockInfo;
397 llvm::Value *BlockPointer;
John McCallad7c5c12011-02-08 08:22:06 +0000398
Eli Friedman9fbeba02012-02-11 02:57:39 +0000399 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
Erich Keane9960b8f2018-07-10 20:51:41 +0000400 FieldDecl *LambdaThisCaptureField;
Eli Friedman9fbeba02012-02-11 02:57:39 +0000401
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000402 /// A mapping from NRVO variables to the flags used to indicate
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000403 /// when the NRVO has been applied to this variable.
404 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000405
John McCallbd309292010-07-06 01:34:17 +0000406 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000407 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000408 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000409
David Majnemer4e52d6f2015-12-12 05:39:21 +0000410 llvm::Instruction *CurrentFuncletPad = nullptr;
411
Tim Shen421119f2016-07-01 21:08:47 +0000412 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
413 llvm::Value *Addr;
414 llvm::Value *Size;
415
416 public:
417 CallLifetimeEnd(Address addr, llvm::Value *size)
418 : Addr(addr.getPointer()), Size(size) {}
419
420 void Emit(CodeGenFunction &CGF, Flags flags) override {
421 CGF.EmitLifetimeEnd(Size, Addr);
422 }
423 };
424
Richard Smith736a9472013-06-12 20:42:33 +0000425 /// Header for data within LifetimeExtendedCleanupStack.
426 struct LifetimeExtendedCleanupHeader {
427 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000428 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000429 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000430 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000431
Justin Bognerbdff2192015-07-01 00:59:27 +0000432 size_t getSize() const { return Size; }
433 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000434 };
John McCallbd309292010-07-06 01:34:17 +0000435
John McCallad5d61e2010-07-23 21:56:41 +0000436 /// i32s containing the indexes of the cleanup destinations.
Erich Keane9960b8f2018-07-10 20:51:41 +0000437 Address NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000438
Erich Keane9960b8f2018-07-10 20:51:41 +0000439 unsigned NextCleanupDestIndex;
John McCallad5d61e2010-07-23 21:56:41 +0000440
John McCall08ef4662011-11-10 08:15:53 +0000441 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
Erich Keane9960b8f2018-07-10 20:51:41 +0000442 CGBlockInfo *FirstBlockInfo;
John McCall08ef4662011-11-10 08:15:53 +0000443
John McCall8e4c74b2011-08-11 02:22:43 +0000444 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
Erich Keane9960b8f2018-07-10 20:51:41 +0000445 llvm::BasicBlock *EHResumeBlock;
John McCall8e4c74b2011-08-11 02:22:43 +0000446
Bill Wendlingf0724e82011-09-19 20:31:14 +0000447 /// The exception slot. All landing pads write the current exception pointer
448 /// into this alloca.
Erich Keane9960b8f2018-07-10 20:51:41 +0000449 llvm::Value *ExceptionSlot;
John McCallbd309292010-07-06 01:34:17 +0000450
Bill Wendlingf0724e82011-09-19 20:31:14 +0000451 /// The selector slot. Under the MandatoryCleanup model, all landing pads
452 /// write the current selector value into this alloca.
Erich Keane9960b8f2018-07-10 20:51:41 +0000453 llvm::AllocaInst *EHSelectorSlot;
John McCall9b382dd2011-05-28 21:13:02 +0000454
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000455 /// A stack of exception code slots. Entering an __except block pushes a slot
456 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
457 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000458 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000459
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000460 /// Value returned by __exception_info intrinsic.
461 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000462
John McCallbd309292010-07-06 01:34:17 +0000463 /// Emits a landing pad for the current EH stack.
464 llvm::BasicBlock *EmitLandingPad();
465
466 llvm::BasicBlock *getInvokeDestImpl();
467
John McCallce1de612011-01-26 04:00:11 +0000468 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000469 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
470 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000471 }
472
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000473public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000474 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
475 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000476 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000477
John McCall6b0feb72011-06-22 02:32:12 +0000478 /// A class controlling the emission of a finally block.
479 class FinallyInfo {
480 /// Where the catchall's edge through the cleanup should go.
481 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000482
John McCall6b0feb72011-06-22 02:32:12 +0000483 /// A function to call to enter the catch.
484 llvm::Constant *BeginCatchFn;
485
486 /// An i1 variable indicating whether or not the @finally is
487 /// running for an exception.
488 llvm::AllocaInst *ForEHVar;
489
490 /// An i8* variable into which the exception pointer to rethrow
491 /// has been saved.
492 llvm::AllocaInst *SavedExnVar;
493
494 public:
495 void enter(CodeGenFunction &CGF, const Stmt *Finally,
496 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
497 llvm::Constant *rethrowFn);
498 void exit(CodeGenFunction &CGF);
499 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000500
Reid Kleckner11c033e2015-02-12 23:40:45 +0000501 /// Returns true inside SEH __try blocks.
502 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
503
Reid Klecknera002bd52015-10-28 23:06:42 +0000504 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000505 bool isCleanupPadScope() const {
506 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
507 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000508
John McCallce1de612011-01-26 04:00:11 +0000509 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
510 /// current full-expression. Safe against the possibility that
511 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000512 template <class T, class... As>
513 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000514 // If we're not in a conditional branch, or if none of the
515 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000516 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000517 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000518
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000519 // Stash values in a tuple so we can guarantee the order of saves.
520 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
521 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000522
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000523 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000524 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000525 initFullExprCleanup();
526 }
527
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000528 /// Queue a cleanup to be pushed after finishing the current
Richard Smith736a9472013-06-12 20:42:33 +0000529 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000530 template <class T, class... As>
531 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000532 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
533
534 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
535
536 size_t OldSize = LifetimeExtendedCleanupStack.size();
537 LifetimeExtendedCleanupStack.resize(
538 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
539
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000540 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000541 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000542 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
543 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000544 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000545 }
546
John McCallf4beacd2011-11-10 10:43:54 +0000547 /// Set up the last cleaup that was pushed as a conditional
548 /// full-expression cleanup.
549 void initFullExprCleanup();
550
John McCallbd309292010-07-06 01:34:17 +0000551 /// PushDestructorCleanup - Push a cleanup to call the
552 /// complete-object destructor of an object of the given type at the
553 /// given address. Does nothing if T is not a C++ class type with a
554 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000555 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000556
John McCall8680f872010-07-21 06:29:51 +0000557 /// PushDestructorCleanup - Push a cleanup to call the
558 /// complete-object variant of the given destructor on the object at
559 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000560 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000561
John McCallbd309292010-07-06 01:34:17 +0000562 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
563 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000564 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000565
John McCall824c2f52010-09-14 07:57:04 +0000566 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
567 /// The block cannot be reactivated. Pops it if it's the top of the
568 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000569 ///
570 /// \param DominatingIP - An instruction which is known to
571 /// dominate the current IP (if set) and which lies along
572 /// all paths of execution between the current IP and the
573 /// the point at which the cleanup comes into scope.
574 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
575 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000576
577 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
578 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000579 ///
580 /// \param DominatingIP - An instruction which is known to
581 /// dominate the current IP (if set) and which lies along
582 /// all paths of execution between the current IP and the
583 /// the point at which the cleanup comes into scope.
584 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
585 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000586
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000587 /// Enters a new scope for capturing cleanups, all of which
John McCallbd309292010-07-06 01:34:17 +0000588 /// will be executed once the scope is exited.
589 class RunCleanupsScope {
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000590 EHScopeStack::stable_iterator CleanupStackDepth, OldCleanupScopeDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000591 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000592 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000593 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000594 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000595 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000596
Aaron Ballmanabc18922015-02-15 22:54:08 +0000597 RunCleanupsScope(const RunCleanupsScope &) = delete;
598 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000599
Eric Christophera9d34972011-10-19 00:43:52 +0000600 protected:
601 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000602
Douglas Gregor965f4502009-11-24 16:43:22 +0000603 public:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000604 /// Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000605 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000606 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000607 {
John McCallbd309292010-07-06 01:34:17 +0000608 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000609 LifetimeExtendedCleanupStackSize =
610 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000611 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000612 CGF.DidCallStackSave = false;
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000613 OldCleanupScopeDepth = CGF.CurrentCleanupScopeDepth;
614 CGF.CurrentCleanupScopeDepth = CleanupStackDepth;
Douglas Gregor965f4502009-11-24 16:43:22 +0000615 }
616
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000617 /// Exit this cleanup scope, emitting any accumulated cleanups.
John McCallbd309292010-07-06 01:34:17 +0000618 ~RunCleanupsScope() {
Reid Kleckner092d0652017-03-06 22:18:34 +0000619 if (PerformCleanup)
620 ForceCleanup();
Douglas Gregor680f8612009-11-24 21:15:44 +0000621 }
622
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000623 /// Determine whether this scope requires any cleanups.
Douglas Gregor680f8612009-11-24 21:15:44 +0000624 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000625 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000626 }
627
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000628 /// Force the emission of cleanups now, instead of waiting
Douglas Gregor680f8612009-11-24 21:15:44 +0000629 /// until this object is destroyed.
Reid Kleckner092d0652017-03-06 22:18:34 +0000630 /// \param ValuesToReload - A list of values that need to be available at
631 /// the insertion point after cleanup emission. If cleanup emission created
632 /// a shared cleanup block, these value pointers will be rewritten.
633 /// Otherwise, they not will be modified.
634 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
Douglas Gregor680f8612009-11-24 21:15:44 +0000635 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000636 CGF.DidCallStackSave = OldDidCallStackSave;
Reid Kleckner092d0652017-03-06 22:18:34 +0000637 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
638 ValuesToReload);
Douglas Gregor680f8612009-11-24 21:15:44 +0000639 PerformCleanup = false;
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000640 CGF.CurrentCleanupScopeDepth = OldCleanupScopeDepth;
Douglas Gregor965f4502009-11-24 16:43:22 +0000641 }
642 };
643
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000644 // Cleanup stack depth of the RunCleanupsScope that was pushed most recently.
645 EHScopeStack::stable_iterator CurrentCleanupScopeDepth =
646 EHScopeStack::stable_end();
647
David Blaikie93be0b22014-08-22 21:37:04 +0000648 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000649 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000650 SmallVector<const LabelDecl*, 4> Labels;
651 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000652
Aaron Ballmanabc18922015-02-15 22:54:08 +0000653 LexicalScope(const LexicalScope &) = delete;
654 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000655
656 public:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000657 /// Enter a new cleanup scope.
Eric Christophera9d34972011-10-19 00:43:52 +0000658 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000659 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
660 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000661 if (CGDebugInfo *DI = CGF.getDebugInfo())
662 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
663 }
664
Nadav Rotem1da30942013-03-23 06:43:35 +0000665 void addLabel(const LabelDecl *label) {
666 assert(PerformCleanup && "adding label to dead scope?");
667 Labels.push_back(label);
668 }
669
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000670 /// Exit this cleanup scope, emitting any accumulated
Eric Christophera9d34972011-10-19 00:43:52 +0000671 /// cleanups.
672 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000673 if (CGDebugInfo *DI = CGF.getDebugInfo())
674 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
675
Nadav Rotem1da30942013-03-23 06:43:35 +0000676 // If we should perform a cleanup, force them now. Note that
677 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000678 if (PerformCleanup) {
679 ApplyDebugLocation DL(CGF, Range.getEnd());
680 ForceCleanup();
681 }
Eric Christophera9d34972011-10-19 00:43:52 +0000682 }
683
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000684 /// Force the emission of cleanups now, instead of waiting
Eric Christophera9d34972011-10-19 00:43:52 +0000685 /// until this object is destroyed.
686 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000687 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000688 RunCleanupsScope::ForceCleanup();
689
Nadav Rotem1da30942013-03-23 06:43:35 +0000690 if (!Labels.empty())
691 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000692 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000693
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000694 bool hasLabels() const {
695 return !Labels.empty();
696 }
697
Nadav Rotem1da30942013-03-23 06:43:35 +0000698 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000699 };
700
John McCall7f416cc2015-09-08 08:05:57 +0000701 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
702
Alexey Bataevab4ea222018-03-07 18:17:06 +0000703 /// The class used to assign some variables some temporarily addresses.
704 class OMPMapVars {
John McCall7f416cc2015-09-08 08:05:57 +0000705 DeclMapTy SavedLocals;
Alexey Bataevab4ea222018-03-07 18:17:06 +0000706 DeclMapTy SavedTempAddresses;
707 OMPMapVars(const OMPMapVars &) = delete;
708 void operator=(const OMPMapVars &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000709
710 public:
Alexey Bataevab4ea222018-03-07 18:17:06 +0000711 explicit OMPMapVars() = default;
712 ~OMPMapVars() {
713 assert(SavedLocals.empty() && "Did not restored original addresses.");
714 };
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000715
Alexey Bataevab4ea222018-03-07 18:17:06 +0000716 /// Sets the address of the variable \p LocalVD to be \p TempAddr in
717 /// function \p CGF.
718 /// \return true if at least one variable was set already, false otherwise.
719 bool setVarAddr(CodeGenFunction &CGF, const VarDecl *LocalVD,
720 Address TempAddr) {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000721 LocalVD = LocalVD->getCanonicalDecl();
John McCall7f416cc2015-09-08 08:05:57 +0000722 // Only save it once.
723 if (SavedLocals.count(LocalVD)) return false;
724
725 // Copy the existing local entry to SavedLocals.
726 auto it = CGF.LocalDeclMap.find(LocalVD);
Alexey Bataevab4ea222018-03-07 18:17:06 +0000727 if (it != CGF.LocalDeclMap.end())
728 SavedLocals.try_emplace(LocalVD, it->second);
729 else
730 SavedLocals.try_emplace(LocalVD, Address::invalid());
John McCall7f416cc2015-09-08 08:05:57 +0000731
732 // Generate the private entry.
Alexey Bataevcaacd532015-09-04 11:26:21 +0000733 QualType VarTy = LocalVD->getType();
734 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000735 Address Temp = CGF.CreateMemTemp(VarTy);
Alexey Bataevab4ea222018-03-07 18:17:06 +0000736 CGF.Builder.CreateStore(TempAddr.getPointer(), Temp);
737 TempAddr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000738 }
Alexey Bataevab4ea222018-03-07 18:17:06 +0000739 SavedTempAddresses.try_emplace(LocalVD, TempAddr);
John McCall7f416cc2015-09-08 08:05:57 +0000740
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000741 return true;
742 }
743
Alexey Bataevab4ea222018-03-07 18:17:06 +0000744 /// Applies new addresses to the list of the variables.
745 /// \return true if at least one variable is using new address, false
746 /// otherwise.
747 bool apply(CodeGenFunction &CGF) {
748 copyInto(SavedTempAddresses, CGF.LocalDeclMap);
749 SavedTempAddresses.clear();
750 return !SavedLocals.empty();
751 }
752
753 /// Restores original addresses of the variables.
754 void restore(CodeGenFunction &CGF) {
755 if (!SavedLocals.empty()) {
756 copyInto(SavedLocals, CGF.LocalDeclMap);
757 SavedLocals.clear();
758 }
759 }
760
761 private:
762 /// Copy all the entries in the source map over the corresponding
763 /// entries in the destination, which must exist.
764 static void copyInto(const DeclMapTy &Src, DeclMapTy &Dest) {
765 for (auto &Pair : Src) {
766 if (!Pair.second.isValid()) {
767 Dest.erase(Pair.first);
768 continue;
769 }
770
771 auto I = Dest.find(Pair.first);
772 if (I != Dest.end())
773 I->second = Pair.second;
774 else
775 Dest.insert(Pair);
776 }
777 }
778 };
779
780 /// The scope used to remap some variables as private in the OpenMP loop body
781 /// (or other captured region emitted without outlining), and to restore old
782 /// vars back on exit.
783 class OMPPrivateScope : public RunCleanupsScope {
784 OMPMapVars MappedVars;
785 OMPPrivateScope(const OMPPrivateScope &) = delete;
786 void operator=(const OMPPrivateScope &) = delete;
787
788 public:
789 /// Enter a new OpenMP private scope.
790 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
791
792 /// Registers \p LocalVD variable as a private and apply \p PrivateGen
793 /// function for it to generate corresponding private variable. \p
794 /// PrivateGen returns an address of the generated private variable.
795 /// \return true if the variable is registered as private, false if it has
796 /// been privatized already.
797 bool addPrivate(const VarDecl *LocalVD,
Alexey Bataevddf3db92018-04-13 17:31:06 +0000798 const llvm::function_ref<Address()> PrivateGen) {
Alexey Bataevab4ea222018-03-07 18:17:06 +0000799 assert(PerformCleanup && "adding private to dead scope");
800 return MappedVars.setVarAddr(CGF, LocalVD, PrivateGen());
801 }
802
803 /// Privatizes local variables previously registered as private.
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000804 /// Registration is separate from the actual privatization to allow
805 /// initializers use values of the original variables, not the private one.
806 /// This is important, for example, if the private variable is a class
807 /// variable initialized by a constructor that references other private
808 /// variables. But at initialization original variables must be used, not
809 /// private copies.
810 /// \return true if at least one variable was privatized, false otherwise.
Alexey Bataevab4ea222018-03-07 18:17:06 +0000811 bool Privatize() { return MappedVars.apply(CGF); }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000812
813 void ForceCleanup() {
814 RunCleanupsScope::ForceCleanup();
Alexey Bataevab4ea222018-03-07 18:17:06 +0000815 MappedVars.restore(CGF);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000816 }
817
Alexey Bataevab4ea222018-03-07 18:17:06 +0000818 /// Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000819 ~OMPPrivateScope() {
820 if (PerformCleanup)
821 ForceCleanup();
822 }
John McCall7f416cc2015-09-08 08:05:57 +0000823
Gor Nishanov04491bd2017-11-11 17:00:43 +0000824 /// Checks if the global variable is captured in current function.
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000825 bool isGlobalVarCaptured(const VarDecl *VD) const {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000826 VD = VD->getCanonicalDecl();
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000827 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
828 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000829 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000830
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000831 /// Takes the old cleanup stack size and emits the cleanup blocks
Richard Smith736a9472013-06-12 20:42:33 +0000832 /// that have been added.
Reid Kleckner092d0652017-03-06 22:18:34 +0000833 void
834 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
835 std::initializer_list<llvm::Value **> ValuesToReload = {});
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000836
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000837 /// Takes the old cleanup stack size and emits the cleanup blocks
Richard Smith736a9472013-06-12 20:42:33 +0000838 /// that have been added, then adds all lifetime-extended cleanups from
839 /// the given position to the stack.
Reid Kleckner092d0652017-03-06 22:18:34 +0000840 void
841 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
842 size_t OldLifetimeExtendedStackSize,
843 std::initializer_list<llvm::Value **> ValuesToReload = {});
Richard Smith736a9472013-06-12 20:42:33 +0000844
John McCallad5d61e2010-07-23 21:56:41 +0000845 void ResolveBranchFixups(llvm::BasicBlock *Target);
846
John McCallbd309292010-07-06 01:34:17 +0000847 /// The given basic block lies in the current EH scope, but may be a
848 /// target of a potentially scope-crossing jump; get a stable handle
849 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000850 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000851 return JumpDest(Target,
852 EHStack.getInnermostNormalCleanup(),
853 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000854 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000855
John McCallbd309292010-07-06 01:34:17 +0000856 /// The given basic block lies in the current EH scope, but may be a
857 /// target of a potentially scope-crossing jump; get a stable handle
858 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000859 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000860 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000861 }
862
863 /// EmitBranchThroughCleanup - Emit a branch from the current insert
864 /// block through the normal cleanup handling code (if any) and then
865 /// on to \arg Dest.
866 void EmitBranchThroughCleanup(JumpDest Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +0000867
Justin Bognere25ffdf2014-01-21 00:35:11 +0000868 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
869 /// specified destination obviously has no cleanups to run. 'false' is always
870 /// a conservatively correct answer for this method.
871 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
872
John McCall8e4c74b2011-08-11 02:22:43 +0000873 /// popCatchScope - Pops the catch scope at the top of the EHScope
874 /// stack, emitting any required code (other than the catch handlers
875 /// themselves).
876 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000877
David Chisnall9a837be2012-11-07 16:50:40 +0000878 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000879 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Heejin Ahnc6479192018-05-31 22:18:13 +0000880 llvm::BasicBlock *
881 getFuncletEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000882
John McCallce1de612011-01-26 04:00:11 +0000883 /// An object to manage conditionally-evaluated expressions.
884 class ConditionalEvaluation {
885 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000886
John McCallce1de612011-01-26 04:00:11 +0000887 public:
888 ConditionalEvaluation(CodeGenFunction &CGF)
889 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000890
John McCallce1de612011-01-26 04:00:11 +0000891 void begin(CodeGenFunction &CGF) {
892 assert(CGF.OutermostConditional != this);
893 if (!CGF.OutermostConditional)
894 CGF.OutermostConditional = this;
895 }
896
897 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000898 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000899 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000900 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000901 }
902
903 /// Returns a block which will be executed prior to each
904 /// evaluation of the conditional code.
905 llvm::BasicBlock *getStartingBlock() const {
906 return StartBB;
907 }
908 };
Mike Stump11289f42009-09-09 15:08:12 +0000909
John McCall7f9c92a2010-09-17 00:50:28 +0000910 /// isInConditionalBranch - Return true if we're currently emitting
911 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000912 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000913
John McCall7f416cc2015-09-08 08:05:57 +0000914 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000915 assert(isInConditionalBranch());
916 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000917 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
918 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000919 }
920
John McCallce1de612011-01-26 04:00:11 +0000921 /// An RAII object to record that we're evaluating a statement
922 /// expression.
923 class StmtExprEvaluation {
924 CodeGenFunction &CGF;
925
926 /// We have to save the outermost conditional: cleanups in a
927 /// statement expression aren't conditional just because the
928 /// StmtExpr is.
929 ConditionalEvaluation *SavedOutermostConditional;
930
931 public:
932 StmtExprEvaluation(CodeGenFunction &CGF)
933 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000934 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000935 }
936
937 ~StmtExprEvaluation() {
938 CGF.OutermostConditional = SavedOutermostConditional;
939 CGF.EnsureInsertPoint();
940 }
941 };
John McCall1bf58462011-02-16 08:02:54 +0000942
John McCallc07a0c72011-02-17 10:25:35 +0000943 /// An object which temporarily prevents a value from being
944 /// destroyed by aggressive peephole optimizations that assume that
945 /// all uses of a value have been realized in the IR.
946 class PeepholeProtection {
947 llvm::Instruction *Inst;
948 friend class CodeGenFunction;
949
950 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000951 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000952 };
John McCallc07a0c72011-02-17 10:25:35 +0000953
John McCallfe96e0b2011-11-06 09:01:30 +0000954 /// A non-RAII class containing all the information about a bound
955 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
956 /// this which makes individual mappings very simple; using this
957 /// class directly is useful when you have a variable number of
958 /// opaque values or don't want the RAII functionality for some
959 /// reason.
960 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000961 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000962 bool BoundLValue;
963 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000964
John McCallfe96e0b2011-11-06 09:01:30 +0000965 OpaqueValueMappingData(const OpaqueValueExpr *ov,
966 bool boundLValue)
967 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000968 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000969 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000970
John McCallc07a0c72011-02-17 10:25:35 +0000971 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000972 // gl-values should be bound as l-values for obvious reasons.
973 // Records should be bound as l-values because IR generation
974 // always keeps them in memory. Expressions of function type
975 // act exactly like l-values but are formally required to be
976 // r-values in C.
977 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000978 expr->getType()->isFunctionType() ||
979 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000980 }
981
John McCallfe96e0b2011-11-06 09:01:30 +0000982 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
983 const OpaqueValueExpr *ov,
984 const Expr *e) {
985 if (shouldBindAsLValue(ov))
986 return bind(CGF, ov, CGF.EmitLValue(e));
987 return bind(CGF, ov, CGF.EmitAnyExpr(e));
988 }
989
990 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
991 const OpaqueValueExpr *ov,
992 const LValue &lv) {
993 assert(shouldBindAsLValue(ov));
994 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
995 return OpaqueValueMappingData(ov, true);
996 }
997
998 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
999 const OpaqueValueExpr *ov,
1000 const RValue &rv) {
1001 assert(!shouldBindAsLValue(ov));
1002 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1003
1004 OpaqueValueMappingData data(ov, false);
1005
1006 // Work around an extremely aggressive peephole optimization in
1007 // EmitScalarConversion which assumes that all other uses of a
1008 // value are extant.
1009 data.Protection = CGF.protectFromPeepholes(rv);
1010
1011 return data;
1012 }
1013
Craig Topper8a13c412014-05-21 05:09:00 +00001014 bool isValid() const { return OpaqueValue != nullptr; }
1015 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +00001016
1017 void unbind(CodeGenFunction &CGF) {
1018 assert(OpaqueValue && "no data to unbind!");
1019
1020 if (BoundLValue) {
1021 CGF.OpaqueLValues.erase(OpaqueValue);
1022 } else {
1023 CGF.OpaqueRValues.erase(OpaqueValue);
1024 CGF.unprotectFromPeepholes(Protection);
1025 }
1026 }
1027 };
1028
1029 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1030 class OpaqueValueMapping {
1031 CodeGenFunction &CGF;
1032 OpaqueValueMappingData Data;
1033
1034 public:
1035 static bool shouldBindAsLValue(const Expr *expr) {
1036 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1037 }
1038
John McCallc07a0c72011-02-17 10:25:35 +00001039 /// Build the opaque value mapping for the given conditional
1040 /// operator if it's the GNU ?: extension. This is a common
1041 /// enough pattern that the convenience operator is really
1042 /// helpful.
1043 ///
1044 OpaqueValueMapping(CodeGenFunction &CGF,
1045 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +00001046 if (isa<ConditionalOperator>(op))
1047 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001048 return;
John McCallc07a0c72011-02-17 10:25:35 +00001049
1050 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001051 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1052 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001053 }
1054
Richard Smith410306b2016-12-12 02:53:20 +00001055 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1056 /// expression is set to the expression the OVE represents.
1057 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1058 : CGF(CGF) {
1059 if (OV) {
1060 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1061 "for OVE with no source expression");
1062 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1063 }
1064 }
1065
John McCall1bf58462011-02-16 08:02:54 +00001066 OpaqueValueMapping(CodeGenFunction &CGF,
1067 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001068 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001069 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001070 }
1071
1072 OpaqueValueMapping(CodeGenFunction &CGF,
1073 const OpaqueValueExpr *opaqueValue,
1074 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001075 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001076 }
1077
1078 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001079 Data.unbind(CGF);
1080 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001081 }
1082
1083 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001084 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001085 }
1086 };
Gor Nishanov04491bd2017-11-11 17:00:43 +00001087
Chris Lattner2da04b32007-08-24 05:35:26 +00001088private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001089 CGDebugInfo *DebugInfo;
Erich Keane9960b8f2018-07-10 20:51:41 +00001090 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001091
John McCall9b382dd2011-05-28 21:13:02 +00001092 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1093 /// calling llvm.stacksave for multiple VLAs in the same scope.
Erich Keane9960b8f2018-07-10 20:51:41 +00001094 bool DidCallStackSave;
John McCall9b382dd2011-05-28 21:13:02 +00001095
Mike Stumpe5311b02009-11-30 20:08:49 +00001096 /// IndirectBranch - The first time an indirect goto is seen we create a block
1097 /// with an indirect branch. Every time we see the address of a label taken,
1098 /// we add the label to the indirect goto. Every subsequent indirect goto is
1099 /// codegen'd as a jump to the IndirectBranch's basic block.
Erich Keane9960b8f2018-07-10 20:51:41 +00001100 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001101
Mike Stumpfc496822009-02-08 23:14:22 +00001102 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1103 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001104 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001105
Akira Hatanakaccda3d22018-04-27 06:57:00 +00001106 // Keep track of the cleanups for callee-destructed parameters pushed to the
1107 // cleanup stack so that they can be deactivated later.
1108 llvm::DenseMap<const ParmVarDecl *, EHScopeStack::stable_iterator>
1109 CalleeDestructedParamCleanups;
1110
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001111 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1112 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1113 /// parameter.
1114 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1115 SizeArguments;
1116
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001117 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001118 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001119 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1120
Chris Lattnerac248202007-05-30 00:13:02 +00001121 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001122 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001123
Mike Stumpfc496822009-02-08 23:14:22 +00001124 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001125 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001126 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001127 BreakContinue(JumpDest Break, JumpDest Continue)
1128 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001129
John McCallbd309292010-07-06 01:34:17 +00001130 JumpDest BreakBlock;
1131 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001132 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001133 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001134
Alexey Bataev957d8562016-11-17 15:12:05 +00001135 /// Handles cancellation exit points in OpenMP-related constructs.
1136 class OpenMPCancelExitStack {
1137 /// Tracks cancellation exit point and join point for cancel-related exit
1138 /// and normal exit.
1139 struct CancelExit {
1140 CancelExit() = default;
1141 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1142 JumpDest ContBlock)
1143 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1144 OpenMPDirectiveKind Kind = OMPD_unknown;
1145 /// true if the exit block has been emitted already by the special
1146 /// emitExit() call, false if the default codegen is used.
1147 bool HasBeenEmitted = false;
1148 JumpDest ExitBlock;
1149 JumpDest ContBlock;
1150 };
1151
1152 SmallVector<CancelExit, 8> Stack;
1153
1154 public:
1155 OpenMPCancelExitStack() : Stack(1) {}
1156 ~OpenMPCancelExitStack() = default;
1157 /// Fetches the exit block for the current OpenMP construct.
1158 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1159 /// Emits exit block with special codegen procedure specific for the related
1160 /// OpenMP construct + emits code for normal construct cleanup.
1161 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
Alexey Bataevddf3db92018-04-13 17:31:06 +00001162 const llvm::function_ref<void(CodeGenFunction &)> CodeGen) {
Alexey Bataev957d8562016-11-17 15:12:05 +00001163 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1164 assert(CGF.getOMPCancelDestination(Kind).isValid());
1165 assert(CGF.HaveInsertPoint());
1166 assert(!Stack.back().HasBeenEmitted);
1167 auto IP = CGF.Builder.saveAndClearIP();
1168 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1169 CodeGen(CGF);
Erich Keane0026ed22017-07-27 16:28:20 +00001170 CGF.EmitBranch(Stack.back().ContBlock.getBlock());
Alexey Bataev957d8562016-11-17 15:12:05 +00001171 CGF.Builder.restoreIP(IP);
1172 Stack.back().HasBeenEmitted = true;
1173 }
1174 CodeGen(CGF);
1175 }
1176 /// Enter the cancel supporting \a Kind construct.
1177 /// \param Kind OpenMP directive that supports cancel constructs.
1178 /// \param HasCancel true, if the construct has inner cancel directive,
1179 /// false otherwise.
1180 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1181 Stack.push_back({Kind,
1182 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1183 : JumpDest(),
1184 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1185 : JumpDest()});
1186 }
1187 /// Emits default exit point for the cancel construct (if the special one
1188 /// has not be used) + join point for cancel/normal exits.
1189 void exit(CodeGenFunction &CGF) {
1190 if (getExitBlock().isValid()) {
1191 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1192 bool HaveIP = CGF.HaveInsertPoint();
1193 if (!Stack.back().HasBeenEmitted) {
1194 if (HaveIP)
1195 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1196 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1197 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1198 }
1199 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1200 if (!HaveIP) {
1201 CGF.Builder.CreateUnreachable();
1202 CGF.Builder.ClearInsertionPoint();
1203 }
1204 }
1205 Stack.pop_back();
1206 }
1207 };
1208 OpenMPCancelExitStack OMPCancelStack;
1209
Justin Bogneref512b92014-01-06 22:27:43 +00001210 CodeGenPGO PGO;
1211
Justin Bogner65512642015-05-02 05:00:55 +00001212 /// Calculate branch weights appropriate for PGO data
1213 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1214 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1215 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1216 uint64_t LoopCount);
1217
Justin Bogneref512b92014-01-06 22:27:43 +00001218public:
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001219 /// Increment the profiler's counter for the given statement by \p StepV.
1220 /// If \p StepV is null, the default increment is 1.
1221 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
Rong Xu9837ef52016-02-04 18:39:09 +00001222 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001223 PGO.emitCounterIncrement(Builder, S, StepV);
Justin Bogner66242d62015-04-23 23:06:47 +00001224 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001225 }
Justin Bogner66242d62015-04-23 23:06:47 +00001226
1227 /// Get the profiler's count for the given statement.
1228 uint64_t getProfileCount(const Stmt *S) {
1229 Optional<uint64_t> Count = PGO.getStmtCount(S);
1230 if (!Count.hasValue())
1231 return 0;
1232 return *Count;
1233 }
1234
1235 /// Set the profiler's current count.
1236 void setCurrentProfileCount(uint64_t Count) {
1237 PGO.setCurrentRegionCount(Count);
1238 }
1239
1240 /// Get the profiler's current count. This is generally the count for the most
1241 /// recently incremented counter.
1242 uint64_t getCurrentProfileCount() {
1243 return PGO.getCurrentRegionCount();
1244 }
1245
Justin Bogneref512b92014-01-06 22:27:43 +00001246private:
1247
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001248 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001249 /// current context is not in a switch.
Erich Keane9960b8f2018-07-10 20:51:41 +00001250 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001251 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
Erich Keane9960b8f2018-07-10 20:51:41 +00001252 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001253
Mike Stumpfc496822009-02-08 23:14:22 +00001254 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001255 /// statement range in current switch instruction.
Erich Keane9960b8f2018-07-10 20:51:41 +00001256 llvm::BasicBlock *CaseRangeBlock;
Devang Patel11663122007-10-08 20:57:48 +00001257
John McCallc07a0c72011-02-17 10:25:35 +00001258 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001259 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001260 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1261 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001262
Mike Stumpfc496822009-02-08 23:14:22 +00001263 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001264 // We track this by the size expression rather than the type itself because
1265 // in certain situations, like a const qualifier applied to an VLA typedef,
1266 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001267 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1268 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001269 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001270
John McCallbd309292010-07-06 01:34:17 +00001271 /// A block containing a single 'unreachable' instruction. Created
1272 /// lazily by getUnreachableBlock().
Erich Keane9960b8f2018-07-10 20:51:41 +00001273 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001274
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001275 /// Counts of the number return expressions in the function.
Erich Keane9960b8f2018-07-10 20:51:41 +00001276 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001277
1278 /// Count the number of simple (constant) return expressions in the function.
Erich Keane9960b8f2018-07-10 20:51:41 +00001279 unsigned NumSimpleReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001280
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001281 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001282 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001283
Richard Smith852c9db2013-04-20 22:23:05 +00001284public:
1285 /// A scope within which we are constructing the fields of an object which
1286 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1287 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1288 class FieldConstructionScope {
1289 public:
John McCall7f416cc2015-09-08 08:05:57 +00001290 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001291 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1292 CGF.CXXDefaultInitExprThis = This;
1293 }
1294 ~FieldConstructionScope() {
1295 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1296 }
1297
1298 private:
1299 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001300 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001301 };
1302
1303 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1304 /// is overridden to be the object under construction.
1305 class CXXDefaultInitExprScope {
1306 public:
1307 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001308 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1309 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1310 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1311 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001312 }
1313 ~CXXDefaultInitExprScope() {
1314 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001315 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001316 }
1317
1318 public:
1319 CodeGenFunction &CGF;
1320 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001321 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001322 };
1323
Richard Smith410306b2016-12-12 02:53:20 +00001324 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1325 /// current loop index is overridden.
1326 class ArrayInitLoopExprScope {
1327 public:
1328 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1329 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1330 CGF.ArrayInitIndex = Index;
1331 }
1332 ~ArrayInitLoopExprScope() {
1333 CGF.ArrayInitIndex = OldArrayInitIndex;
1334 }
1335
1336 private:
1337 CodeGenFunction &CGF;
1338 llvm::Value *OldArrayInitIndex;
1339 };
1340
Richard Smith5179eb72016-06-28 19:03:57 +00001341 class InlinedInheritingConstructorScope {
1342 public:
1343 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1344 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1345 OldCurCodeDecl(CGF.CurCodeDecl),
1346 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1347 OldCXXABIThisValue(CGF.CXXABIThisValue),
1348 OldCXXThisValue(CGF.CXXThisValue),
1349 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1350 OldCXXThisAlignment(CGF.CXXThisAlignment),
1351 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1352 OldCXXInheritedCtorInitExprArgs(
1353 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1354 CGF.CurGD = GD;
1355 CGF.CurFuncDecl = CGF.CurCodeDecl =
1356 cast<CXXConstructorDecl>(GD.getDecl());
1357 CGF.CXXABIThisDecl = nullptr;
1358 CGF.CXXABIThisValue = nullptr;
1359 CGF.CXXThisValue = nullptr;
1360 CGF.CXXABIThisAlignment = CharUnits();
1361 CGF.CXXThisAlignment = CharUnits();
1362 CGF.ReturnValue = Address::invalid();
1363 CGF.FnRetTy = QualType();
1364 CGF.CXXInheritedCtorInitExprArgs.clear();
1365 }
1366 ~InlinedInheritingConstructorScope() {
1367 CGF.CurGD = OldCurGD;
1368 CGF.CurFuncDecl = OldCurFuncDecl;
1369 CGF.CurCodeDecl = OldCurCodeDecl;
1370 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1371 CGF.CXXABIThisValue = OldCXXABIThisValue;
1372 CGF.CXXThisValue = OldCXXThisValue;
1373 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1374 CGF.CXXThisAlignment = OldCXXThisAlignment;
1375 CGF.ReturnValue = OldReturnValue;
1376 CGF.FnRetTy = OldFnRetTy;
1377 CGF.CXXInheritedCtorInitExprArgs =
1378 std::move(OldCXXInheritedCtorInitExprArgs);
1379 }
1380
1381 private:
1382 CodeGenFunction &CGF;
1383 GlobalDecl OldCurGD;
1384 const Decl *OldCurFuncDecl;
1385 const Decl *OldCurCodeDecl;
1386 ImplicitParamDecl *OldCXXABIThisDecl;
1387 llvm::Value *OldCXXABIThisValue;
1388 llvm::Value *OldCXXThisValue;
1389 CharUnits OldCXXABIThisAlignment;
1390 CharUnits OldCXXThisAlignment;
1391 Address OldReturnValue;
1392 QualType OldFnRetTy;
1393 CallArgList OldCXXInheritedCtorInitExprArgs;
1394 };
1395
Richard Smith852c9db2013-04-20 22:23:05 +00001396private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001397 /// CXXThisDecl - When generating code for a C++ member function,
1398 /// this will hold the implicit 'this' declaration.
Erich Keane9960b8f2018-07-10 20:51:41 +00001399 ImplicitParamDecl *CXXABIThisDecl;
1400 llvm::Value *CXXABIThisValue;
1401 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001402 CharUnits CXXABIThisAlignment;
1403 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001404
Richard Smith852c9db2013-04-20 22:23:05 +00001405 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1406 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001407 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001408
Richard Smith410306b2016-12-12 02:53:20 +00001409 /// The current array initialization index when evaluating an
1410 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1411 llvm::Value *ArrayInitIndex = nullptr;
1412
Richard Smith5179eb72016-06-28 19:03:57 +00001413 /// The values of function arguments to use when evaluating
1414 /// CXXInheritedCtorInitExprs within this context.
1415 CallArgList CXXInheritedCtorInitExprArgs;
1416
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001417 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1418 /// destructor, this will hold the implicit argument (e.g. VTT).
Erich Keane9960b8f2018-07-10 20:51:41 +00001419 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1420 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001421
John McCallce1de612011-01-26 04:00:11 +00001422 /// OutermostConditional - Points to the outermost active
1423 /// conditional control. This is used so that we know if a
1424 /// temporary should be destroyed conditionally.
Erich Keane9960b8f2018-07-10 20:51:41 +00001425 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001426
Nadav Rotem1da30942013-03-23 06:43:35 +00001427 /// The current lexical scope.
Erich Keane9960b8f2018-07-10 20:51:41 +00001428 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001429
Adrian Prantldc237b52013-05-16 00:41:26 +00001430 /// The current source location that should be used for exception
1431 /// handling code.
1432 SourceLocation CurEHLocation;
1433
John McCall7f416cc2015-09-08 08:05:57 +00001434 /// BlockByrefInfos - For each __block variable, contains
1435 /// information about the layout of the variable.
1436 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001437
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001438 /// Used by -fsanitize=nullability-return to determine whether the return
1439 /// value can be checked.
1440 llvm::Value *RetValNullabilityPrecondition = nullptr;
1441
1442 /// Check if -fsanitize=nullability-return instrumentation is required for
1443 /// this function.
1444 bool requiresReturnValueNullabilityCheck() const {
1445 return RetValNullabilityPrecondition;
1446 }
1447
Vedant Kumarc34d3432017-06-23 21:32:38 +00001448 /// Used to store precise source locations for return statements by the
1449 /// runtime return value checks.
1450 Address ReturnLocation = Address::invalid();
1451
1452 /// Check if the return value of this function requires sanitization.
1453 bool requiresReturnValueCheck() const {
1454 return requiresReturnValueNullabilityCheck() ||
1455 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
1456 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
1457 }
1458
Erich Keane9960b8f2018-07-10 20:51:41 +00001459 llvm::BasicBlock *TerminateLandingPad;
1460 llvm::BasicBlock *TerminateHandler;
1461 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001462
Reid Kleckner06f19a02018-01-02 21:34:16 +00001463 /// Terminate funclets keyed by parent funclet pad.
1464 llvm::MapVector<llvm::Value *, llvm::BasicBlock *> TerminateFunclets;
1465
Craig Topper74c10e32018-07-09 19:00:16 +00001466 /// Largest vector width used in ths function. Will be used to create a
1467 /// function attribute.
Erich Keane9960b8f2018-07-10 20:51:41 +00001468 unsigned LargestVectorWidth;
Craig Topper74c10e32018-07-09 19:00:16 +00001469
Vitaly Buka1c943322016-10-26 01:59:57 +00001470 /// True if we need emit the life-time markers.
1471 const bool ShouldEmitLifetimeMarkers;
1472
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00001473 /// Add OpenCL kernel arg metadata and the kernel attribute metadata to
Xiuli Panbe6da4b2017-05-04 07:31:20 +00001474 /// the function metadata.
Gor Nishanov04491bd2017-11-11 17:00:43 +00001475 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001476 llvm::Function *Fn);
1477
Chris Lattnerbed31442007-05-28 01:07:47 +00001478public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001479 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001480 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001481
John McCall8ed55a52010-09-02 09:58:18 +00001482 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001483 ASTContext &getContext() const { return CGM.getContext(); }
Gor Nishanov04491bd2017-11-11 17:00:43 +00001484 CGDebugInfo *getDebugInfo() {
1485 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001486 return nullptr;
Gor Nishanov04491bd2017-11-11 17:00:43 +00001487 return DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001488 }
1489 void disableDebugInfo() { DisableDebugInfo = true; }
1490 void enableDebugInfo() { DisableDebugInfo = false; }
1491
John McCall31168b02011-06-15 23:02:42 +00001492 bool shouldUseFusedARCCalls() {
1493 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1494 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001495
David Blaikiebbafb8a2012-03-11 07:00:24 +00001496 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001497
Bill Wendlingf0724e82011-09-19 20:31:14 +00001498 /// Returns a pointer to the function's exception object and selector slot,
1499 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001500 Address getExceptionSlot();
1501 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001502
Bill Wendling79a70e42011-09-15 18:57:19 +00001503 /// Returns the contents of the function's exception object and selector
1504 /// slots.
1505 llvm::Value *getExceptionFromSlot();
1506 llvm::Value *getSelectorFromSlot();
1507
John McCall7f416cc2015-09-08 08:05:57 +00001508 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001509
John McCallbd309292010-07-06 01:34:17 +00001510 llvm::BasicBlock *getUnreachableBlock() {
1511 if (!UnreachableBlock) {
1512 UnreachableBlock = createBasicBlock("unreachable");
1513 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1514 }
1515 return UnreachableBlock;
1516 }
1517
1518 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001519 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001520 return getInvokeDestImpl();
1521 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001522
David Majnemer25eb1652016-03-01 19:42:53 +00001523 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001524
John McCallc8e01702013-04-16 22:48:15 +00001525 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001526 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Yaxun Liucbf647c2017-07-08 13:24:52 +00001527 const TargetCodeGenInfo &getTargetHooks() const {
1528 return CGM.getTargetCodeGenInfo();
1529 }
Owen Andersonae86c192009-07-13 04:10:07 +00001530
Daniel Dunbar12347492009-02-23 17:26:39 +00001531 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001532 // Cleanups
1533 //===--------------------------------------------------------------------===//
1534
John McCall7f416cc2015-09-08 08:05:57 +00001535 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001536
John McCall178360e2011-07-11 08:38:19 +00001537 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001538 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001539 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001540 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001541 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001542 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1543 llvm::Value *arrayEnd,
1544 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001545 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001546 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001547
John McCall4bd0fb12011-07-12 16:41:08 +00001548 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001549 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001550 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001551 Address addr, QualType type);
1552 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001553 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001554 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001555 QualType type, Destroyer *destroyer,
1556 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001557 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1558 llvm::Value *CompletePtr,
1559 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001560 void pushStackRestore(CleanupKind kind, Address SPMem);
1561 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001562 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001563 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001564 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001565 bool useEHCleanupForArray,
1566 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001567 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001568 QualType elementType, CharUnits elementAlign,
1569 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001570 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001571
Peter Collingbourne1425b452012-01-26 03:33:36 +00001572 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001573
John McCall82fe67b2011-07-09 01:37:26 +00001574 /// Determines whether an EH cleanup is required to destroy a type
1575 /// with the given destruction kind.
1576 bool needsEHCleanup(QualType::DestructionKind kind) {
1577 switch (kind) {
1578 case QualType::DK_none:
1579 return false;
1580 case QualType::DK_cxx_destructor:
1581 case QualType::DK_objc_weak_lifetime:
Akira Hatanaka7275da02018-02-28 07:15:55 +00001582 case QualType::DK_nontrivial_c_struct:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001583 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001584 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001585 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001586 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1587 }
1588 llvm_unreachable("bad destruction kind");
1589 }
1590
John McCall4bd0fb12011-07-12 16:41:08 +00001591 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1592 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1593 }
1594
John McCall82fe67b2011-07-09 01:37:26 +00001595 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001596 // Objective-C
1597 //===--------------------------------------------------------------------===//
1598
Chris Lattner4bd55962008-03-30 23:03:07 +00001599 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001600
David Blaikief1425802015-01-14 00:04:42 +00001601 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001602
Mike Stumpfc496822009-02-08 23:14:22 +00001603 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001604 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1605 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001606 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001607 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001608 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001609 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001610
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001611 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1612 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001613
Mike Stumpfc496822009-02-08 23:14:22 +00001614 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1615 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001616 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1617 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001618 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001619 const ObjCPropertyImplDecl *propImpl,
1620 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001621
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001622 //===--------------------------------------------------------------------===//
1623 // Block Bits
1624 //===--------------------------------------------------------------------===//
1625
Yaxun Liuc2a87a02017-10-14 12:23:50 +00001626 /// Emit block literal.
1627 /// \return an LLVM value which is a pointer to a struct which contains
1628 /// information about the block, including the block invoke function, the
1629 /// captured variables, etc.
Yaxun Liufa13d012018-02-15 16:39:19 +00001630 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001631 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001632
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001633 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001634 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001635 const DeclMapTy &ldm,
Akira Hatanakaba0367a2017-09-22 21:32:06 +00001636 bool IsLambdaConversionToBlock,
1637 bool BuildGlobalBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001638
John McCallad7c5c12011-02-08 08:22:06 +00001639 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1640 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001641 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1642 const ObjCPropertyImplDecl *PID);
1643 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1644 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001645 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001646
John McCallad7c5c12011-02-08 08:22:06 +00001647 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1648
John McCall73064872011-03-31 01:59:53 +00001649 class AutoVarEmission;
1650
1651 void emitByrefStructureInit(const AutoVarEmission &emission);
1652 void enterByrefCleanup(const AutoVarEmission &emission);
1653
John McCall7f416cc2015-09-08 08:05:57 +00001654 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1655 llvm::Value *ptr);
1656
1657 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001658 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1659
1660 /// BuildBlockByrefAddress - Computes the location of the
1661 /// data in a variable which is declared as __block.
1662 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1663 bool followForward = true);
1664 Address emitBlockByrefAddress(Address baseAddr,
1665 const BlockByrefInfo &info,
1666 bool followForward,
1667 const llvm::Twine &name);
1668
1669 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001670
Richard Smith5179eb72016-06-28 19:03:57 +00001671 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1672
John McCalla738c252011-03-09 04:27:21 +00001673 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1674 const CGFunctionInfo &FnInfo);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001675 /// Emit code for the start of a function.
Adrian Prantl42d71b92014-04-10 23:21:53 +00001676 /// \param Loc The location to be associated with the function.
1677 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001678 void StartFunction(GlobalDecl GD,
1679 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001680 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001681 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001682 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001683 SourceLocation Loc = SourceLocation(),
1684 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001685
Vedant Kumar7f809b22017-02-24 01:15:19 +00001686 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1687
John McCallb81884d2010-02-19 09:25:03 +00001688 void EmitConstructorBody(FunctionArgList &Args);
1689 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001690 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001691 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001692 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001693
Faisal Vali571df122013-09-29 08:45:24 +00001694 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001695 CallArgList &CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00001696 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001697 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001698 void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001699 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001700
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001701 /// Emit the unified return block, trying to avoid its emission when
David Blaikiea0a1a872015-01-18 02:48:07 +00001702 /// possible.
1703 /// \return The debug location of the user written return statement if the
1704 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001705 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001706
Mike Stumpfc496822009-02-08 23:14:22 +00001707 /// FinishFunction - Complete IR generation of the current function. It is
1708 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001709 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001710
Nico Weber1bebad12015-02-11 22:33:32 +00001711 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
Reid Kleckner399d96e2018-04-02 20:20:33 +00001712 const CGFunctionInfo &FnInfo, bool IsUnprototyped);
Hans Wennborg88497d62013-11-15 17:24:45 +00001713
Reid Kleckner399d96e2018-04-02 20:20:33 +00001714 void EmitCallAndReturnForThunk(llvm::Constant *Callee, const ThunkInfo *Thunk,
1715 bool IsUnprototyped);
Hans Wennborg88497d62013-11-15 17:24:45 +00001716
John McCall7f416cc2015-09-08 08:05:57 +00001717 void FinishThunk();
1718
Reid Klecknerab2090d2014-07-26 01:34:32 +00001719 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1720 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1721 llvm::Value *Callee);
1722
Rafael Espindolad6e66942015-07-13 06:07:58 +00001723 /// Generate a thunk for the given method.
1724 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
Reid Kleckner399d96e2018-04-02 20:20:33 +00001725 GlobalDecl GD, const ThunkInfo &Thunk,
1726 bool IsUnprototyped);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001727
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001728 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1729 const CGFunctionInfo &FnInfo,
1730 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001731
Douglas Gregor94f9a482010-05-05 05:51:00 +00001732 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1733 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001734
Richard Smith30e304e2016-12-14 00:03:17 +00001735 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001736
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00001737 /// Struct with all information about dynamic [sub]class needed to set vptr.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001738 struct VPtr {
1739 BaseSubobject Base;
1740 const CXXRecordDecl *NearestVBase;
1741 CharUnits OffsetFromNearestVBase;
1742 const CXXRecordDecl *VTableClass;
1743 };
1744
1745 /// Initialize the vtable pointer of the given subobject.
1746 void InitializeVTablePointer(const VPtr &vptr);
1747
1748 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001749
1750 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001751 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1752
1753 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1754 CharUnits OffsetFromNearestVBase,
1755 bool BaseIsNonVirtualPrimaryBase,
1756 const CXXRecordDecl *VTableClass,
1757 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001758
Anders Carlssond5895932010-03-28 21:07:49 +00001759 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001760
Dan Gohman8fc50c22010-10-26 18:44:08 +00001761 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1762 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001763 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1764 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001765
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001766 enum CFITypeCheckKind {
1767 CFITCK_VCall,
1768 CFITCK_NVCall,
1769 CFITCK_DerivedCast,
1770 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001771 CFITCK_ICall,
Peter Collingbournee44acad2018-06-26 02:15:47 +00001772 CFITCK_NVMFCall,
1773 CFITCK_VMFCall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001774 };
1775
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001776 /// Derived is the presumed address of an object of type T after a
Peter Collingbourned2926c92015-03-14 02:42:25 +00001777 /// cast. If T is a polymorphic class type, emit a check that the virtual
1778 /// table for Derived belongs to a class derived from T.
1779 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001780 bool MayBeNull, CFITypeCheckKind TCK,
1781 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001782
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001783 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1784 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001785 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001786 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001787
Peter Collingbourned2926c92015-03-14 02:42:25 +00001788 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001789 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001790 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1791 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001792
Peter Collingbournefb532b92016-02-24 20:46:36 +00001793 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001794 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1795 /// enabled, emit a check that VTable is a member of RD's type identifier.
1796 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1797 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001798
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001799 /// Returns whether we should perform a type checked load when loading a
1800 /// virtual function for virtual calls to members of RD. This is generally
1801 /// true when both vcall CFI and whole-program-vtables are enabled.
1802 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1803
1804 /// Emit a type checked load from the given vtable.
1805 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1806 uint64_t VTableByteOffset);
1807
John McCallf99a6312010-07-21 05:30:47 +00001808 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1809 /// given phase of destruction for a destructor. The end result
1810 /// should call destructors on members and base classes in reverse
1811 /// order of their construction.
1812 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001813
Chris Lattner3c77a352010-06-22 00:03:40 +00001814 /// ShouldInstrumentFunction - Return true if the current function should be
1815 /// instrumented with __cyg_profile_func_* calls
1816 bool ShouldInstrumentFunction();
1817
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001818 /// ShouldXRayInstrument - Return true if the current function should be
1819 /// instrumented with XRay nop sleds.
1820 bool ShouldXRayInstrumentFunction() const;
1821
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +00001822 /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
1823 /// XRay custom event handling calls.
1824 bool AlwaysEmitXRayCustomEvents() const;
1825
Keith Wyssf437e352018-04-17 21:32:43 +00001826 /// AlwaysEmitXRayTypedEvents - Return true if clang must unconditionally emit
1827 /// XRay typed event handling calls.
1828 bool AlwaysEmitXRayTypedEvents() const;
1829
Vedant Kumarbb5d4852017-09-13 00:04:35 +00001830 /// Encode an address into a form suitable for use in a function prologue.
1831 llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
1832 llvm::Constant *Addr);
1833
1834 /// Decode an address used in a function prologue, encoded by \c
1835 /// EncodeAddrForUseInPrologue.
1836 llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
1837 llvm::Value *EncodedAddr);
1838
Mike Stumpfc496822009-02-08 23:14:22 +00001839 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1840 /// arguments for the given function. This is also responsible for naming the
1841 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001842 void EmitFunctionProlog(const CGFunctionInfo &FI,
1843 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001844 const FunctionArgList &Args);
1845
Mike Stumpfc496822009-02-08 23:14:22 +00001846 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1847 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001848 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1849 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001850
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001851 /// Emit a test that checks if the return value \p RV is nonnull.
Vedant Kumarc34d3432017-06-23 21:32:38 +00001852 void EmitReturnValueCheck(llvm::Value *RV);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001853
Mike Stump1d849212009-12-07 23:38:24 +00001854 /// EmitStartEHSpec - Emit the start of the exception spec.
1855 void EmitStartEHSpec(const Decl *D);
1856
1857 /// EmitEndEHSpec - Emit the end of the exception spec.
1858 void EmitEndEHSpec(const Decl *D);
1859
John McCallbd309292010-07-06 01:34:17 +00001860 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1861 llvm::BasicBlock *getTerminateLandingPad();
1862
Reid Kleckner06f19a02018-01-02 21:34:16 +00001863 /// getTerminateLandingPad - Return a cleanup funclet that just calls
1864 /// terminate.
1865 llvm::BasicBlock *getTerminateFunclet();
1866
John McCallbd309292010-07-06 01:34:17 +00001867 /// getTerminateHandler - Return a handler (not a landing pad, just
1868 /// a catch handler) that just calls terminate. This is used when
1869 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001870 llvm::BasicBlock *getTerminateHandler();
1871
Chris Lattnera5f58b02011-07-09 17:41:47 +00001872 llvm::Type *ConvertTypeForMem(QualType T);
1873 llvm::Type *ConvertType(QualType T);
1874 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001875 return ConvertType(getContext().getTypeDeclType(T));
1876 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001877
Mike Stumpfc496822009-02-08 23:14:22 +00001878 /// LoadObjCSelf - Load the value of self. This function is only valid while
1879 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001880 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001881
1882 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001883 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001884
Krasimir Georgiev46dfb7a2017-09-08 13:44:51 +00001885 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
John McCall47fb9502013-03-07 21:37:08 +00001886 static TypeEvaluationKind getEvaluationKind(QualType T);
1887
1888 static bool hasScalarEvaluationKind(QualType T) {
1889 return getEvaluationKind(T) == TEK_Scalar;
1890 }
1891
1892 static bool hasAggregateEvaluationKind(QualType T) {
1893 return getEvaluationKind(T) == TEK_Aggregate;
1894 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001895
1896 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001897 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001898 llvm::Function *parent = nullptr,
1899 llvm::BasicBlock *before = nullptr) {
John McCallad7c5c12011-02-08 08:22:06 +00001900 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001901 }
Mike Stumpfc496822009-02-08 23:14:22 +00001902
Chris Lattnerac248202007-05-30 00:13:02 +00001903 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1904 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001905 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001906
Mike Stumpe5311b02009-11-30 20:08:49 +00001907 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1908 /// another basic block, simplify it. This assumes that no other code could
1909 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001910 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1911
Mike Stumpfc496822009-02-08 23:14:22 +00001912 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1913 /// adding a fall-through branch from the current insert block if
1914 /// necessary. It is legal to call this function even if there is no current
1915 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001916 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001917 /// IsFinished - If true, indicates that the caller has finished emitting
1918 /// branches to the given block and does not expect to emit code into it. This
1919 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001920 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001921
John McCall8e4c74b2011-08-11 02:22:43 +00001922 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1923 /// near its uses, and leave the insertion point in it.
1924 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1925
Mike Stumpfc496822009-02-08 23:14:22 +00001926 /// EmitBranch - Emit a branch to the specified basic block from the current
1927 /// insert block, taking care to avoid creation of branches from dummy
1928 /// blocks. It is legal to call this function even if there is no current
1929 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001930 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001931 /// This function clears the current insertion point. The caller should follow
1932 /// calls to this function with calls to Emit*Block prior to generation new
1933 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001934 void EmitBranch(llvm::BasicBlock *Block);
1935
Mike Stumpfc496822009-02-08 23:14:22 +00001936 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1937 /// indicates that the current code being emitted is unreachable.
1938 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001939 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001940 }
1941
Mike Stumpfc496822009-02-08 23:14:22 +00001942 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1943 /// emitted IR has a place to go. Note that by definition, if this function
1944 /// creates a block then that block is unreachable; callers may do better to
1945 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001946 void EnsureInsertPoint() {
1947 if (!HaveInsertPoint())
1948 EmitBlock(createBasicBlock());
1949 }
Mike Stumpfc496822009-02-08 23:14:22 +00001950
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001951 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001952 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001953 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001954
Chris Lattnere9a64532007-06-22 21:44:33 +00001955 //===--------------------------------------------------------------------===//
1956 // Helpers
1957 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001958
John McCall7f416cc2015-09-08 08:05:57 +00001959 LValue MakeAddrLValue(Address Addr, QualType T,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001960 AlignmentSource Source = AlignmentSource::Type) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00001961 return LValue::MakeAddr(Addr, T, getContext(), LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001962 CGM.getTBAAAccessInfo(T));
1963 }
1964
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001965 LValue MakeAddrLValue(Address Addr, QualType T, LValueBaseInfo BaseInfo,
1966 TBAAAccessInfo TBAAInfo) {
1967 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001968 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001969
John McCall7f416cc2015-09-08 08:05:57 +00001970 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001971 AlignmentSource Source = AlignmentSource::Type) {
1972 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00001973 LValueBaseInfo(Source), CGM.getTBAAAccessInfo(T));
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001974 }
1975
1976 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001977 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00001978 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001979 BaseInfo, TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +00001980 }
1981
1982 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001983 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001984 CharUnits getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001985 LValueBaseInfo *BaseInfo = nullptr,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +00001986 TBAAAccessInfo *TBAAInfo = nullptr,
John McCall7f416cc2015-09-08 08:05:57 +00001987 bool forPointeeType = false);
1988 CharUnits getNaturalPointeeTypeAlignment(QualType T,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00001989 LValueBaseInfo *BaseInfo = nullptr,
1990 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001991
Ivan A. Kosarev9f9d1572017-10-30 11:49:31 +00001992 Address EmitLoadOfReference(LValue RefLVal,
1993 LValueBaseInfo *PointeeBaseInfo = nullptr,
1994 TBAAAccessInfo *PointeeTBAAInfo = nullptr);
1995 LValue EmitLoadOfReferenceLValue(LValue RefLVal);
1996 LValue EmitLoadOfReferenceLValue(Address RefAddr, QualType RefTy,
1997 AlignmentSource Source =
1998 AlignmentSource::Type) {
1999 LValue RefLVal = MakeAddrLValue(RefAddr, RefTy, LValueBaseInfo(Source),
2000 CGM.getTBAAAccessInfo(RefTy));
2001 return EmitLoadOfReferenceLValue(RefLVal);
2002 }
Daniel Dunbar93b00a92010-08-21 02:53:44 +00002003
Alexey Bataev31300ed2016-02-04 11:27:03 +00002004 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
Ivan A. Kosarev90295642017-10-13 16:47:22 +00002005 LValueBaseInfo *BaseInfo = nullptr,
2006 TBAAAccessInfo *TBAAInfo = nullptr);
Alexey Bataev31300ed2016-02-04 11:27:03 +00002007 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
2008
Yaxun Liu84744c12017-06-19 17:03:41 +00002009 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
2010 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
2011 /// insertion point of the builder. The caller is responsible for setting an
2012 /// appropriate alignment on
Daniel Dunbara7566f12010-02-09 02:48:28 +00002013 /// the alloca.
Yaxun Liu84744c12017-06-19 17:03:41 +00002014 ///
2015 /// \p ArraySize is the number of array elements to be allocated if it
2016 /// is not nullptr.
2017 ///
2018 /// LangAS::Default is the address space of pointers to local variables and
2019 /// temporaries, as exposed in the source language. In certain
2020 /// configurations, this is not the same as the alloca address space, and a
2021 /// cast is needed to lift the pointer from the alloca AS into
2022 /// LangAS::Default. This can happen when the target uses a restricted
2023 /// address space for the stack but the source language requires
2024 /// LangAS::Default to be a generic address space. The latter condition is
2025 /// common for most programming languages; OpenCL is an exception in that
2026 /// LangAS::Default is the private address space, which naturally maps
2027 /// to the stack.
2028 ///
2029 /// Because the address of a temporary is often exposed to the program in
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002030 /// various ways, this function will perform the cast. The original alloca
2031 /// instruction is returned through \p Alloca if it is not nullptr.
2032 ///
2033 /// The cast is not performaed in CreateTempAllocaWithoutCast. This is
Yaxun Liu84744c12017-06-19 17:03:41 +00002034 /// more efficient if the caller knows that the address will not be exposed.
2035 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
2036 llvm::Value *ArraySize = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00002037 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
Yaxun Liu84744c12017-06-19 17:03:41 +00002038 const Twine &Name = "tmp",
2039 llvm::Value *ArraySize = nullptr,
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002040 Address *Alloca = nullptr);
2041 Address CreateTempAllocaWithoutCast(llvm::Type *Ty, CharUnits align,
2042 const Twine &Name = "tmp",
2043 llvm::Value *ArraySize = nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002044
John McCall7f416cc2015-09-08 08:05:57 +00002045 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
2046 /// default ABI alignment of the given LLVM type.
2047 ///
2048 /// IMPORTANT NOTE: This is *not* generally the right alignment for
2049 /// any given AST type that happens to have been lowered to the
2050 /// given IR type. This should only ever be used for function-local,
2051 /// IR-driven manipulations like saving and restoring a value. Do
2052 /// not hand this address off to arbitrary IRGen routines, and especially
2053 /// do not pass it as an argument to a function that might expect a
2054 /// properly ABI-aligned value.
2055 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
2056 const Twine &Name = "tmp");
2057
2058 /// InitTempAlloca - Provide an initial value for the given alloca which
2059 /// will be observable at all locations in the function.
2060 ///
2061 /// The address should be something that was returned from one of
2062 /// the CreateTempAlloca or CreateMemTemp routines, and the
2063 /// initializer must be valid in the entry block (i.e. it must
2064 /// either be a constant or an argument value).
2065 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00002066
Daniel Dunbard0049182010-02-16 19:44:13 +00002067 /// CreateIRTemp - Create a temporary IR object of the given type, with
2068 /// appropriate alignment. This routine should only be used when an temporary
2069 /// value needs to be stored into an alloca (for example, to avoid explicit
2070 /// PHI construction), but the type is the IR type, not the type appropriate
2071 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00002072 ///
2073 /// That is, this is exactly equivalent to CreateMemTemp, but calling
2074 /// ConvertType instead of ConvertTypeForMem.
2075 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00002076
Daniel Dunbara7566f12010-02-09 02:48:28 +00002077 /// CreateMemTemp - Create a temporary memory object of the given type, with
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002078 /// appropriate alignmen and cast it to the default address space. Returns
2079 /// the original alloca instruction by \p Alloca if it is not nullptr.
Yaxun Liu84744c12017-06-19 17:03:41 +00002080 Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002081 Address *Alloca = nullptr);
Yaxun Liu84744c12017-06-19 17:03:41 +00002082 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002083 Address *Alloca = nullptr);
2084
2085 /// CreateMemTemp - Create a temporary memory object of the given type, with
2086 /// appropriate alignmen without casting it to the default address space.
2087 Address CreateMemTempWithoutCast(QualType T, const Twine &Name = "tmp");
2088 Address CreateMemTempWithoutCast(QualType T, CharUnits Align,
2089 const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00002090
John McCall7a626f62010-09-15 10:14:12 +00002091 /// CreateAggTemp - Create a temporary memory object for the given
2092 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00002093 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00002094 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00002095 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00002096 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00002097 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00002098 AggValueSlot::IsNotAliased,
2099 AggValueSlot::DoesNotOverlap);
John McCall7a626f62010-09-15 10:14:12 +00002100 }
2101
John McCallad7c5c12011-02-08 08:22:06 +00002102 /// Emit a cast to void* in the appropriate address space.
2103 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2104
Chris Lattner8394d792007-06-05 20:53:16 +00002105 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2106 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00002107 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00002108
John McCalla2342eb2010-12-05 02:00:02 +00002109 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2110 void EmitIgnoredExpr(const Expr *E);
2111
Chris Lattner4647a212007-08-31 22:49:20 +00002112 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2113 /// any type. The result is returned as an RValue struct. If this is an
2114 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2115 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00002116 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00002117 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00002118 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00002119 AggValueSlot aggSlot = AggValueSlot::ignored(),
2120 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00002121
Mike Stumpfc496822009-02-08 23:14:22 +00002122 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2123 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00002124 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002125
Charles Davisc7d5c942015-09-17 20:55:33 +00002126 /// Emit a "reference" to a __builtin_ms_va_list; this is
2127 /// always the value of the expression, because a __builtin_ms_va_list is a
2128 /// pointer to a char.
2129 Address EmitMSVAListRef(const Expr *E);
2130
Gor Nishanov5eb58582017-03-26 02:18:05 +00002131 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
Mike Stumpfc496822009-02-08 23:14:22 +00002132 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00002133 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00002134
John McCall91ca10f2011-03-08 09:11:50 +00002135 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00002136 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00002137 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002138 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00002139
John McCall7f416cc2015-09-08 08:05:57 +00002140 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00002141
John McCall91ca10f2011-03-08 09:11:50 +00002142 /// EmitExprAsInit - Emits the code necessary to initialize a
2143 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00002144 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002145 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00002146
Fariborz Jahanian78652202013-01-25 23:57:05 +00002147 /// hasVolatileMember - returns true if aggregate type has a volatile
2148 /// member.
2149 bool hasVolatileMember(QualType T) {
2150 if (const RecordType *RT = T->getAs<RecordType>()) {
2151 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2152 return RD->hasVolatileMember();
2153 }
2154 return false;
2155 }
Richard Smithe78fac52018-04-05 20:52:58 +00002156
2157 /// Determine whether a return value slot may overlap some other object.
2158 AggValueSlot::Overlap_t overlapForReturnValue() {
2159 // FIXME: Assuming no overlap here breaks guaranteed copy elision for base
2160 // class subobjects. These cases may need to be revisited depending on the
2161 // resolution of the relevant core issue.
2162 return AggValueSlot::DoesNotOverlap;
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002163 }
2164
Richard Smithe78fac52018-04-05 20:52:58 +00002165 /// Determine whether a field initialization may overlap some other object.
2166 AggValueSlot::Overlap_t overlapForFieldInit(const FieldDecl *FD) {
2167 // FIXME: These cases can result in overlap as a result of P0840R0's
2168 // [[no_unique_address]] attribute. We can still infer NoOverlap in the
2169 // presence of that attribute if the field is within the nvsize of its
2170 // containing class, because non-virtual subobjects are initialized in
2171 // address order.
2172 return AggValueSlot::DoesNotOverlap;
2173 }
2174
2175 /// Determine whether a base class initialization may overlap some other
2176 /// object.
2177 AggValueSlot::Overlap_t overlapForBaseInit(const CXXRecordDecl *RD,
2178 const CXXRecordDecl *BaseRD,
2179 bool IsVirtual);
2180
2181 /// Emit an aggregate assignment.
2182 void EmitAggregateAssign(LValue Dest, LValue Src, QualType EltTy) {
2183 bool IsVolatile = hasVolatileMember(EltTy);
2184 EmitAggregateCopy(Dest, Src, EltTy, AggValueSlot::MayOverlap, IsVolatile);
2185 }
2186
2187 void EmitAggregateCopyCtor(LValue Dest, LValue Src,
2188 AggValueSlot::Overlap_t MayOverlap) {
2189 EmitAggregateCopy(Dest, Src, Src.getType(), MayOverlap);
David Majnemerfd1e7392015-02-03 23:04:06 +00002190 }
2191
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002192 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00002193 ///
Richard Smithe78fac52018-04-05 20:52:58 +00002194 /// \param isVolatile \c true iff either the source or the destination is
2195 /// volatile.
2196 /// \param MayOverlap Whether the tail padding of the destination might be
2197 /// occupied by some other object. More efficient code can often be
2198 /// generated if not.
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00002199 void EmitAggregateCopy(LValue Dest, LValue Src, QualType EltTy,
Richard Smithe78fac52018-04-05 20:52:58 +00002200 AggValueSlot::Overlap_t MayOverlap,
2201 bool isVolatile = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00002202
Anders Carlsson9396a892008-09-11 09:15:33 +00002203 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00002204 Address GetAddrOfLocalVar(const VarDecl *VD) {
2205 auto it = LocalDeclMap.find(VD);
2206 assert(it != LocalDeclMap.end() &&
2207 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2208 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00002209 }
Mike Stumpfc496822009-02-08 23:14:22 +00002210
Akira Hatanaka797afe32018-03-20 01:47:58 +00002211 /// Given an opaque value expression, return its LValue mapping if it exists,
2212 /// otherwise create one.
2213 LValue getOrCreateOpaqueLValueMapping(const OpaqueValueExpr *e);
John McCallc07a0c72011-02-17 10:25:35 +00002214
Akira Hatanaka797afe32018-03-20 01:47:58 +00002215 /// Given an opaque value expression, return its RValue mapping if it exists,
2216 /// otherwise create one.
2217 RValue getOrCreateOpaqueRValueMapping(const OpaqueValueExpr *e);
John McCall1bf58462011-02-16 08:02:54 +00002218
Richard Smith410306b2016-12-12 02:53:20 +00002219 /// Get the index of the current ArrayInitLoopExpr, if any.
2220 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2221
Dan Gohman75d69da2008-05-22 00:50:06 +00002222 /// getAccessedFieldNo - Given an encoded value and a result number, return
2223 /// the input field number being accessed.
2224 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2225
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002226 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002227 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002228
Vedant Kumarffd7c882017-04-14 22:03:34 +00002229 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2230 static bool IsWrappedCXXThis(const Expr *E);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00002231
Anders Carlssonc0964b62010-05-22 17:35:42 +00002232 /// EmitNullInitialization - Generate code to set a value of the given type to
2233 /// null, If the type contains data member pointers, they will be initialized
2234 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002235 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002236
Charles Davisc7d5c942015-09-17 20:55:33 +00002237 /// Emits a call to an LLVM variable-argument intrinsic, either
2238 /// \c llvm.va_start or \c llvm.va_end.
2239 /// \param ArgValue A reference to the \c va_list as emitted by either
2240 /// \c EmitVAListRef or \c EmitMSVAListRef.
2241 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2242 /// calls \c llvm.va_end.
2243 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2244
2245 /// Generate code to get an argument from the passed in pointer
2246 /// and update it accordingly.
2247 /// \param VE The \c VAArgExpr for which to generate code.
2248 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2249 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2250 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002251 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002252 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002253 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002254
John McCall82fe67b2011-07-09 01:37:26 +00002255 /// emitArrayLength - Compute the length of an array, even if it's a
2256 /// VLA, and drill down to the base element type.
2257 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2258 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002259 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002260
John McCall23c29fe2011-06-24 21:55:10 +00002261 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2262 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002263 ///
2264 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002265 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002266
Sander de Smalen891af03a2018-02-03 13:55:59 +00002267 struct VlaSizePair {
2268 llvm::Value *NumElts;
2269 QualType Type;
2270
2271 VlaSizePair(llvm::Value *NE, QualType T) : NumElts(NE), Type(T) {}
2272 };
2273
2274 /// Return the number of elements for a single dimension
2275 /// for the given array type.
2276 VlaSizePair getVLAElements1D(const VariableArrayType *vla);
2277 VlaSizePair getVLAElements1D(QualType vla);
2278
2279 /// Returns an LLVM value that corresponds to the size,
John McCall23c29fe2011-06-24 21:55:10 +00002280 /// in non-variably-sized elements, of a variable length array type,
2281 /// plus that largest non-variably-sized element type. Assumes that
2282 /// the type has already been emitted with EmitVariablyModifiedType.
Sander de Smalen891af03a2018-02-03 13:55:59 +00002283 VlaSizePair getVLASize(const VariableArrayType *vla);
2284 VlaSizePair getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002285
Anders Carlssona5d077d2009-04-14 16:58:56 +00002286 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2287 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002288 llvm::Value *LoadCXXThis() {
2289 assert(CXXThisValue && "no 'this' value for this function");
2290 return CXXThisValue;
2291 }
John McCall7f416cc2015-09-08 08:05:57 +00002292 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002293
Anders Carlssone36a6b32010-01-02 01:01:18 +00002294 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2295 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002296 // FIXME: Every place that calls LoadCXXVTT is something
2297 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002298 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002299 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2300 return CXXStructorImplicitParamValue;
2301 }
2302
John McCall6ce74722010-02-16 04:15:37 +00002303 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002304 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002305 Address
2306 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002307 const CXXRecordDecl *Derived,
2308 const CXXRecordDecl *Base,
2309 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002310
John McCall7f416cc2015-09-08 08:05:57 +00002311 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2312
Mike Stumpe5311b02009-11-30 20:08:49 +00002313 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2314 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002315 Address GetAddressOfBaseClass(Address Value,
2316 const CXXRecordDecl *Derived,
2317 CastExpr::path_const_iterator PathBegin,
2318 CastExpr::path_const_iterator PathEnd,
2319 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002320
John McCall7f416cc2015-09-08 08:05:57 +00002321 Address GetAddressOfDerivedClass(Address Value,
2322 const CXXRecordDecl *Derived,
2323 CastExpr::path_const_iterator PathBegin,
2324 CastExpr::path_const_iterator PathEnd,
2325 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002326
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002327 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2328 /// base constructor/destructor with virtual bases.
2329 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2330 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2331 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2332 bool Delegating);
2333
John McCallf8ff7b92010-02-23 00:48:20 +00002334 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2335 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002336 const FunctionArgList &Args,
2337 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002338 // It's important not to confuse this and the previous function. Delegating
2339 // constructors are the C++0x feature. The constructor delegate optimization
2340 // is used to reduce duplication in the base and complete consturctors where
2341 // they are substantially the same.
2342 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2343 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002344
Richard Smith5179eb72016-06-28 19:03:57 +00002345 /// Emit a call to an inheriting constructor (that is, one that invokes a
2346 /// constructor inherited from a base class) by inlining its definition. This
2347 /// is necessary if the ABI does not support forwarding the arguments to the
2348 /// base class constructor (because they're variadic or similar).
2349 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2350 CXXCtorType CtorType,
2351 bool ForVirtualBase,
2352 bool Delegating,
2353 CallArgList &Args);
2354
2355 /// Emit a call to a constructor inherited from a base class, passing the
2356 /// current constructor's arguments along unmodified (without even making
2357 /// a copy).
2358 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2359 bool ForVirtualBase, Address This,
2360 bool InheritedFromVBase,
2361 const CXXInheritedCtorInitExpr *E);
2362
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002363 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002364 bool ForVirtualBase, bool Delegating,
Richard Smithe78fac52018-04-05 20:52:58 +00002365 Address This, const CXXConstructExpr *E,
2366 AggValueSlot::Overlap_t Overlap);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002367
Richard Smith5179eb72016-06-28 19:03:57 +00002368 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2369 bool ForVirtualBase, bool Delegating,
Richard Smithe78fac52018-04-05 20:52:58 +00002370 Address This, CallArgList &Args,
Igor Kudrineff8f9d2018-06-25 05:48:04 +00002371 AggValueSlot::Overlap_t Overlap,
2372 SourceLocation Loc);
Richard Smith5179eb72016-06-28 19:03:57 +00002373
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002374 /// Emit assumption load for all bases. Requires to be be called only on
2375 /// most-derived class and not under construction of the object.
2376 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2377
2378 /// Emit assumption that vptr load == global vtable.
2379 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2380
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002381 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002382 Address This, Address Src,
2383 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002384
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002385 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002386 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002387 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002388 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002389 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002390
Anders Carlssond49844b2009-09-23 02:45:36 +00002391 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2392 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002393 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002394 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002395 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002396
John McCall82fe67b2011-07-09 01:37:26 +00002397 static Destroyer destroyCXXObject;
2398
Anders Carlsson0a637412009-05-29 21:03:38 +00002399 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002400 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002401 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002402
John McCall99210dc2011-09-15 06:49:18 +00002403 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002404 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002405 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002406 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002407
Peter Collingbourne702b2842011-11-27 22:09:22 +00002408 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002409 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002410
David Majnemerdc012fa2015-04-22 21:38:15 +00002411 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2412 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2413
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002414 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002415 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002416
Eli Friedman24f55432009-11-18 00:57:03 +00002417 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002418 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2419 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002420
Richard Smith760520b2014-06-03 23:27:44 +00002421 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
Eric Fiselierfa752f22018-03-21 19:19:48 +00002422 const CallExpr *TheCallExpr, bool IsDelete);
Richard Smith760520b2014-06-03 23:27:44 +00002423
John McCall7f416cc2015-09-08 08:05:57 +00002424 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2425 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2426 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002427
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002428 /// Situations in which we might emit a check for the suitability of a
Richard Smith69d0d262012-08-24 00:54:33 +00002429 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002430 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002431 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002432 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002433 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002434 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002435 /// Checking the bound value in a reference binding. Must be suitably sized
2436 /// and aligned, but is not required to refer to an object (until the
2437 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002438 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002439 /// Checking the object expression in a non-static data member access. Must
2440 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002441 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002442 /// Checking the 'this' pointer for a call to a non-static member function.
2443 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002444 TCK_MemberCall,
2445 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002446 TCK_ConstructorCall,
2447 /// Checking the operand of a static_cast to a derived pointer type. Must be
2448 /// null or an object within its lifetime.
2449 TCK_DowncastPointer,
2450 /// Checking the operand of a static_cast to a derived reference type. Must
2451 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002452 TCK_DowncastReference,
2453 /// Checking the operand of a cast to a base object. Must be suitably sized
2454 /// and aligned.
2455 TCK_Upcast,
2456 /// Checking the operand of a cast to a virtual base object. Must be an
2457 /// object within its lifetime.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002458 TCK_UpcastToVirtualBase,
2459 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002460 TCK_NonnullAssign,
2461 /// Checking the operand of a dynamic_cast or a typeid expression. Must be
2462 /// null or an object within its lifetime.
2463 TCK_DynamicOperation
Richard Smith69d0d262012-08-24 00:54:33 +00002464 };
2465
Vedant Kumar24792e32017-10-03 01:27:25 +00002466 /// Determine whether the pointer type check \p TCK permits null pointers.
2467 static bool isNullPointerAllowed(TypeCheckKind TCK);
2468
2469 /// Determine whether the pointer type check \p TCK requires a vptr check.
2470 static bool isVptrCheckRequired(TypeCheckKind TCK, QualType Ty);
2471
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002472 /// Whether any type-checking sanitizers are enabled. If \c false,
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002473 /// calls to EmitTypeCheck can be skipped.
2474 bool sanitizePerformTypeCheck() const;
2475
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002476 /// Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002477 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002478 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002479 QualType Type, CharUnits Alignment = CharUnits::Zero(),
Vedant Kumar18348ea2017-02-17 23:22:55 +00002480 SanitizerSet SkippedChecks = SanitizerSet());
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002481
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002482 /// Emit a check that \p Base points into an array object, which
Richard Smith539e4a72013-02-23 02:53:19 +00002483 /// we can access at index \p Index. \p Accessed should be \c false if we
2484 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2485 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2486 QualType IndexType, bool Accessed);
2487
Chris Lattner116ce8f2010-01-09 21:40:03 +00002488 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2489 bool isInc, bool isPre);
2490 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2491 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002492
2493 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002494 llvm::Value *OffsetValue = nullptr) {
2495 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2496 OffsetValue);
2497 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002498
Amara Emerson652795d2016-11-10 14:44:30 +00002499 /// Converts Location to a DebugLoc, if debug information is enabled.
2500 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2501
2502
Chris Lattner8394d792007-06-05 20:53:16 +00002503 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002504 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002505 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002506
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002507 /// EmitDecl - Emit a declaration.
2508 ///
2509 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002510 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002511
John McCall1c9c3fd2010-10-15 04:57:14 +00002512 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002513 ///
2514 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002515 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002516
David Blaikie73ca5692014-12-09 00:32:22 +00002517 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002518 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002519
John McCallbd309292010-07-06 01:34:17 +00002520 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2521 llvm::Value *Address);
2522
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002523 /// Determine whether the given initializer is trivial in the sense
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002524 /// that it requires no code to be generated.
2525 bool isTrivialInitializer(const Expr *Init);
2526
John McCall1c9c3fd2010-10-15 04:57:14 +00002527 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002528 ///
2529 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002530 void EmitAutoVarDecl(const VarDecl &D);
2531
2532 class AutoVarEmission {
2533 friend class CodeGenFunction;
2534
John McCall9e2e22f2011-02-22 07:16:58 +00002535 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002536
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002537 /// The address of the alloca for languages with explicit address space
2538 /// (e.g. OpenCL) or alloca casted to generic pointer for address space
2539 /// agnostic languages (e.g. C++). Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002540 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002541 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002542
2543 llvm::Value *NRVOFlag;
2544
2545 /// True if the variable is a __block variable.
2546 bool IsByRef;
2547
2548 /// True if the variable is of aggregate type and has a constant
2549 /// initializer.
2550 bool IsConstantAggregate;
2551
Nadav Rotem1da30942013-03-23 06:43:35 +00002552 /// Non-null if we should use lifetime annotations.
2553 llvm::Value *SizeForLifetimeMarkers;
2554
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002555 /// Address with original alloca instruction. Invalid if the variable was
2556 /// emitted as a global constant.
2557 Address AllocaAddr;
2558
John McCall9e2e22f2011-02-22 07:16:58 +00002559 struct Invalid {};
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002560 AutoVarEmission(Invalid)
2561 : Variable(nullptr), Addr(Address::invalid()),
2562 AllocaAddr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002563
John McCallc533cb72011-02-22 06:44:22 +00002564 AutoVarEmission(const VarDecl &variable)
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002565 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
2566 IsByRef(false), IsConstantAggregate(false),
2567 SizeForLifetimeMarkers(nullptr), AllocaAddr(Address::invalid()) {}
John McCallc533cb72011-02-22 06:44:22 +00002568
John McCall7f416cc2015-09-08 08:05:57 +00002569 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002570
2571 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002572 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2573
Craig Topper8a13c412014-05-21 05:09:00 +00002574 bool useLifetimeMarkers() const {
2575 return SizeForLifetimeMarkers != nullptr;
2576 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002577 llvm::Value *getSizeForLifetimeMarkers() const {
2578 assert(useLifetimeMarkers());
2579 return SizeForLifetimeMarkers;
2580 }
2581
2582 /// Returns the raw, allocated address, which is not necessarily
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002583 /// the address of the object itself. It is casted to default
2584 /// address space for address space agnostic languages.
John McCall7f416cc2015-09-08 08:05:57 +00002585 Address getAllocatedAddress() const {
2586 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002587 }
2588
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002589 /// Returns the address for the original alloca instruction.
2590 Address getOriginalAllocatedAddress() const { return AllocaAddr; }
2591
John McCallc533cb72011-02-22 06:44:22 +00002592 /// Returns the address of the object within this declaration.
2593 /// Note that this does not chase the forwarding pointer for
2594 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002595 Address getObjectAddress(CodeGenFunction &CGF) const {
2596 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002597
John McCall7f416cc2015-09-08 08:05:57 +00002598 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002599 }
2600 };
2601 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2602 void EmitAutoVarInit(const AutoVarEmission &emission);
Gor Nishanov04491bd2017-11-11 17:00:43 +00002603 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002604 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2605 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002606
Sander de Smalen891af03a2018-02-03 13:55:59 +00002607 /// Emits the alloca and debug information for the size expressions for each
2608 /// dimension of an array. It registers the association of its (1-dimensional)
2609 /// QualTypes and size expression's debug node, so that CGDebugInfo can
2610 /// reference this node when creating the DISubrange object to describe the
2611 /// array types.
2612 void EmitAndRegisterVariableArrayDimensions(CGDebugInfo *DI,
2613 const VarDecl &D,
2614 bool EmitDebugInfo);
2615
John McCall1c9c3fd2010-10-15 04:57:14 +00002616 void EmitStaticVarDecl(const VarDecl &D,
2617 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002618
John McCall7f416cc2015-09-08 08:05:57 +00002619 class ParamValue {
2620 llvm::Value *Value;
2621 unsigned Alignment;
2622 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2623 public:
2624 static ParamValue forDirect(llvm::Value *value) {
2625 return ParamValue(value, 0);
2626 }
2627 static ParamValue forIndirect(Address addr) {
2628 assert(!addr.getAlignment().isZero());
2629 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2630 }
2631
2632 bool isIndirect() const { return Alignment != 0; }
2633 llvm::Value *getAnyValue() const { return Value; }
Gor Nishanov04491bd2017-11-11 17:00:43 +00002634
John McCall7f416cc2015-09-08 08:05:57 +00002635 llvm::Value *getDirectValue() const {
2636 assert(!isIndirect());
2637 return Value;
2638 }
2639
2640 Address getIndirectAddress() const {
2641 assert(isIndirect());
2642 return Address(Value, CharUnits::fromQuantity(Alignment));
2643 }
2644 };
2645
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002646 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002647 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002648
John McCallc07a0c72011-02-17 10:25:35 +00002649 /// protectFromPeepholes - Protect a value that we're intending to
2650 /// store to the side, but which will probably be used later, from
2651 /// aggressive peepholing optimizations that might delete it.
2652 ///
2653 /// Pass the result to unprotectFromPeepholes to declare that
2654 /// protection is no longer required.
2655 ///
2656 /// There's no particular reason why this shouldn't apply to
2657 /// l-values, it's just that no existing peepholes work on pointers.
2658 PeepholeProtection protectFromPeepholes(RValue rvalue);
2659 void unprotectFromPeepholes(PeepholeProtection protection);
2660
Erich Keane623efd82017-03-30 21:48:55 +00002661 void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment,
2662 llvm::Value *OffsetValue = nullptr) {
2663 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2664 OffsetValue);
2665 }
2666
Chris Lattner84915fa2007-06-02 04:16:21 +00002667 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002668 // Statement Emission
2669 //===--------------------------------------------------------------------===//
2670
Mike Stumpfc496822009-02-08 23:14:22 +00002671 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002672 void EmitStopPoint(const Stmt *S);
2673
Mike Stumpfc496822009-02-08 23:14:22 +00002674 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2675 /// this function even if there is no current insertion point.
2676 ///
2677 /// This function may clear the current insertion point; callers should use
2678 /// EnsureInsertPoint if they wish to subsequently generate code without first
2679 /// calling EmitBlock, EmitBranch, or EmitStmt.
Karl-Johan Karlsson33e205a2017-09-06 08:47:18 +00002680 void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002681
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002682 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002683 /// necessarily require an insertion point or debug information; typically
2684 /// because the statement amounts to a jump or a container of other
2685 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002686 ///
2687 /// \return True if the statement was handled.
2688 bool EmitSimpleStmt(const Stmt *S);
2689
John McCall7f416cc2015-09-08 08:05:57 +00002690 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2691 AggValueSlot AVS = AggValueSlot::ignored());
2692 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2693 bool GetLast = false,
2694 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002695 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002696
Mike Stumpfc496822009-02-08 23:14:22 +00002697 /// EmitLabel - Emit the block for the given label. It is legal to call this
2698 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002699 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002700
Chris Lattnerac248202007-05-30 00:13:02 +00002701 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002702 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002703 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002704 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002705 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002706
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002707 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002708 ArrayRef<const Attr *> Attrs = None);
2709 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002710 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002711 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002712 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002713 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002714 void EmitBreakStmt(const BreakStmt &S);
2715 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002716 void EmitSwitchStmt(const SwitchStmt &S);
2717 void EmitDefaultStmt(const DefaultStmt &S);
2718 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002719 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002720 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002721
Anders Carlsson2e744e82008-08-30 19:51:14 +00002722 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002723 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2724 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002725 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002726 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002727
Gor Nishanov8df64e92016-10-27 16:28:31 +00002728 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov90be1212017-03-06 21:12:54 +00002729 void EmitCoreturnStmt(const CoreturnStmt &S);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002730 RValue EmitCoawaitExpr(const CoawaitExpr &E,
2731 AggValueSlot aggSlot = AggValueSlot::ignored(),
2732 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002733 LValue EmitCoawaitLValue(const CoawaitExpr *E);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002734 RValue EmitCoyieldExpr(const CoyieldExpr &E,
2735 AggValueSlot aggSlot = AggValueSlot::ignored(),
2736 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002737 LValue EmitCoyieldLValue(const CoyieldExpr *E);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002738 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2739
John McCallb609d3f2010-07-07 06:56:46 +00002740 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2741 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002742
Anders Carlsson52d78a52009-09-27 18:58:34 +00002743 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002744 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002745 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002746 void EnterSEHTryStmt(const SEHTryStmt &S);
2747 void ExitSEHTryStmt(const SEHTryStmt &S);
2748
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002749 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002750 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002751
2752 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2753 const SEHExceptStmt &Except);
2754
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002755 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2756 const SEHFinallyStmt &Finally);
2757
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002758 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2759 llvm::Value *ParentFP,
2760 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002761 llvm::Value *EmitSEHExceptionCode();
2762 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002763 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002764
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002765 /// Emit simple code for OpenMP directives in Simd-only mode.
2766 void EmitSimpleOMPExecutableDirective(const OMPExecutableDirective &D);
2767
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002768 /// Scan the outlined statement for captures from the parent function. For
2769 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002770 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002771 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002772 bool IsFilter);
2773
2774 /// Recovers the address of a local in a parent function. ParentVar is the
2775 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002776 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002777 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2778 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002779 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2780 Address ParentVar,
2781 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002782
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002783 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002784 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002785
Alexey Bataev2139ed62017-11-16 18:20:21 +00002786 /// Controls insertion of cancellation exit blocks in worksharing constructs.
2787 class OMPCancelStackRAII {
2788 CodeGenFunction &CGF;
2789
2790 public:
2791 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
2792 bool HasCancel)
2793 : CGF(CGF) {
2794 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
2795 }
2796 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
2797 };
2798
Alexey Bataev1189bd02016-01-26 12:20:39 +00002799 /// Returns calculated size of the specified type.
2800 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002801 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002802 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002803 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002804 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002805 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002806 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002807 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002808 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2809 SourceLocation Loc);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002810 /// Perform element by element copying of arrays with type \a
Alexey Bataev420d45b2015-04-14 05:11:24 +00002811 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2812 /// generated by \a CopyGen.
2813 ///
2814 /// \param DestAddr Address of the destination array.
2815 /// \param SrcAddr Address of the source array.
2816 /// \param OriginalType Type of destination and source arrays.
2817 /// \param CopyGen Copying procedure that copies value of single array element
2818 /// to another single array element.
2819 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002820 Address DestAddr, Address SrcAddr, QualType OriginalType,
Alexey Bataevddf3db92018-04-13 17:31:06 +00002821 const llvm::function_ref<void(Address, Address)> CopyGen);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002822 /// Emit proper copying of data from one variable to another.
Alexey Bataev420d45b2015-04-14 05:11:24 +00002823 ///
2824 /// \param OriginalType Original type of the copied variables.
2825 /// \param DestAddr Destination address.
2826 /// \param SrcAddr Source address.
2827 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2828 /// type of the base array element).
2829 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2830 /// the base array element).
2831 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2832 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002833 void EmitOMPCopy(QualType OriginalType,
2834 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002835 const VarDecl *DestVD, const VarDecl *SrcVD,
2836 const Expr *Copy);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002837 /// Emit atomic update code for constructs: \a X = \a X \a BO \a E or
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002838 /// \a X = \a E \a BO \a E.
2839 ///
2840 /// \param X Value to be updated.
2841 /// \param E Update value.
2842 /// \param BO Binary operation for update operation.
2843 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2844 /// expression, false otherwise.
2845 /// \param AO Atomic ordering of the generated atomic instructions.
2846 /// \param CommonGen Code generator for complex expressions that cannot be
2847 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002848 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2849 /// generated, <false, RValue::get(nullptr)> otherwise.
2850 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002851 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2852 llvm::AtomicOrdering AO, SourceLocation Loc,
Alexey Bataevddf3db92018-04-13 17:31:06 +00002853 const llvm::function_ref<RValue(RValue)> CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002854 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002855 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002856 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2857 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002858 void EmitOMPUseDevicePtrClause(
2859 const OMPClause &C, OMPPrivateScope &PrivateScope,
2860 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002861 /// Emit code for copyin clause in \a D directive. The next code is
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002862 /// generated at the start of outlined functions for directives:
2863 /// \code
2864 /// threadprivate_var1 = master_threadprivate_var1;
2865 /// operator=(threadprivate_var2, master_threadprivate_var2);
2866 /// ...
2867 /// __kmpc_barrier(&loc, global_tid);
2868 /// \endcode
2869 ///
2870 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2871 /// \returns true if at least one copyin variable is found, false otherwise.
2872 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002873 /// Emit initial code for lastprivate variables. If some variable is
Alexey Bataev38e89532015-04-16 04:54:05 +00002874 /// not also firstprivate, then the default initialization is used. Otherwise
2875 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2876 /// method.
2877 ///
2878 /// \param D Directive that may have 'lastprivate' directives.
2879 /// \param PrivateScope Private scope for capturing lastprivate variables for
2880 /// proper codegen in internal captured statement.
2881 ///
2882 /// \returns true if there is at least one lastprivate variable, false
2883 /// otherwise.
2884 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2885 OMPPrivateScope &PrivateScope);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002886 /// Emit final copying of lastprivate values to original variables at
Alexey Bataev38e89532015-04-16 04:54:05 +00002887 /// the end of the worksharing or simd directive.
2888 ///
2889 /// \param D Directive that has at least one 'lastprivate' directives.
2890 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2891 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002892 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002893 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002894 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002895 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002896 /// Emit initial code for linear clauses.
2897 void EmitOMPLinearClause(const OMPLoopDirective &D,
2898 CodeGenFunction::OMPPrivateScope &PrivateScope);
2899 /// Emit final code for linear clauses.
2900 /// \param CondGen Optional conditional code for final part of codegen for
2901 /// linear clause.
2902 void EmitOMPLinearClauseFinal(
2903 const OMPLoopDirective &D,
Alexey Bataevddf3db92018-04-13 17:31:06 +00002904 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002905 /// Emit initial code for reduction variables. Creates reduction copies
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002906 /// and initializes them with the values according to OpenMP standard.
2907 ///
2908 /// \param D Directive (possibly) with the 'reduction' clause.
2909 /// \param PrivateScope Private scope for capturing reduction variables for
2910 /// proper codegen in internal captured statement.
2911 ///
2912 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2913 OMPPrivateScope &PrivateScope);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002914 /// Emit final update of reduction values to original variables at
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002915 /// the end of the directive.
2916 ///
2917 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00002918 /// \param ReductionKind The kind of reduction to perform.
2919 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
2920 const OpenMPDirectiveKind ReductionKind);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002921 /// Emit initial code for linear variables. Creates private copies
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002922 /// and initializes them with the values according to OpenMP standard.
2923 ///
2924 /// \param D Directive (possibly) with the 'linear' clause.
Alexey Bataev8c3edfe2017-08-16 15:58:46 +00002925 /// \return true if at least one linear variable is found that should be
2926 /// initialized with the value of the original variable, false otherwise.
2927 bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002928
Alexey Bataev7292c292016-04-25 12:22:29 +00002929 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2930 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002931 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002932 TaskGenTy;
2933 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
Alexey Bataev475a7442018-01-12 19:39:11 +00002934 const OpenMPDirectiveKind CapturedRegion,
Alexey Bataev7292c292016-04-25 12:22:29 +00002935 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002936 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataevd2202ca2017-12-27 17:58:32 +00002937 struct OMPTargetDataInfo {
2938 Address BasePointersArray = Address::invalid();
2939 Address PointersArray = Address::invalid();
2940 Address SizesArray = Address::invalid();
2941 unsigned NumberOfTargetItems = 0;
2942 explicit OMPTargetDataInfo() = default;
2943 OMPTargetDataInfo(Address BasePointersArray, Address PointersArray,
2944 Address SizesArray, unsigned NumberOfTargetItems)
2945 : BasePointersArray(BasePointersArray), PointersArray(PointersArray),
2946 SizesArray(SizesArray), NumberOfTargetItems(NumberOfTargetItems) {}
2947 };
2948 void EmitOMPTargetTaskBasedDirective(const OMPExecutableDirective &S,
2949 const RegionCodeGenTy &BodyGen,
2950 OMPTargetDataInfo &InputInfo);
Alexey Bataev7292c292016-04-25 12:22:29 +00002951
Alexey Bataev9959db52014-05-06 10:08:46 +00002952 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002953 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002954 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002955 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002956 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002957 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002958 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002959 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002960 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002961 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002962 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002963 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002964 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002965 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002966 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002967 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002968 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002969 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002970 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002971 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002972 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002973 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002974 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002975 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002976 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002977 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002978 void
2979 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002980 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002981 void
2982 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002983 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002984 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002985 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002986 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002987 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002988 void EmitOMPDistributeParallelForDirective(
2989 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002990 void EmitOMPDistributeParallelForSimdDirective(
2991 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002992 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002993 void EmitOMPTargetParallelForSimdDirective(
2994 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002995 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002996 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00002997 void
2998 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00002999 void EmitOMPTeamsDistributeParallelForSimdDirective(
3000 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00003001 void EmitOMPTeamsDistributeParallelForDirective(
3002 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00003003 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00003004 void EmitOMPTargetTeamsDistributeDirective(
3005 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00003006 void EmitOMPTargetTeamsDistributeParallelForDirective(
3007 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00003008 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
3009 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00003010 void EmitOMPTargetTeamsDistributeSimdDirective(
3011 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00003012
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00003013 /// Emit device code for the target directive.
3014 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
3015 StringRef ParentName,
3016 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00003017 static void
3018 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3019 const OMPTargetParallelDirective &S);
Alexey Bataevfb0ebec2017-11-08 20:16:14 +00003020 /// Emit device code for the target parallel for directive.
3021 static void EmitOMPTargetParallelForDeviceFunction(
3022 CodeGenModule &CGM, StringRef ParentName,
3023 const OMPTargetParallelForDirective &S);
Alexey Bataev5d7edca2017-11-09 17:32:15 +00003024 /// Emit device code for the target parallel for simd directive.
3025 static void EmitOMPTargetParallelForSimdDeviceFunction(
3026 CodeGenModule &CGM, StringRef ParentName,
3027 const OMPTargetParallelForSimdDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003028 /// Emit device code for the target teams directive.
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00003029 static void
3030 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3031 const OMPTargetTeamsDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003032 /// Emit device code for the target teams distribute directive.
3033 static void EmitOMPTargetTeamsDistributeDeviceFunction(
3034 CodeGenModule &CGM, StringRef ParentName,
3035 const OMPTargetTeamsDistributeDirective &S);
Alexey Bataevfbe17fb2017-12-13 19:45:06 +00003036 /// Emit device code for the target teams distribute simd directive.
3037 static void EmitOMPTargetTeamsDistributeSimdDeviceFunction(
3038 CodeGenModule &CGM, StringRef ParentName,
3039 const OMPTargetTeamsDistributeSimdDirective &S);
Alexey Bataevf8365372017-11-17 17:57:25 +00003040 /// Emit device code for the target simd directive.
3041 static void EmitOMPTargetSimdDeviceFunction(CodeGenModule &CGM,
3042 StringRef ParentName,
3043 const OMPTargetSimdDirective &S);
Alexey Bataev647dd842018-01-15 20:59:40 +00003044 /// Emit device code for the target teams distribute parallel for simd
3045 /// directive.
3046 static void EmitOMPTargetTeamsDistributeParallelForSimdDeviceFunction(
3047 CodeGenModule &CGM, StringRef ParentName,
3048 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Carlo Bertolli52978c32018-01-03 21:12:44 +00003049
3050 static void EmitOMPTargetTeamsDistributeParallelForDeviceFunction(
3051 CodeGenModule &CGM, StringRef ParentName,
3052 const OMPTargetTeamsDistributeParallelForDirective &S);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003053 /// Emit inner loop of the worksharing/simd construct.
Alexey Bataev98eb6e32015-04-22 11:15:40 +00003054 ///
3055 /// \param S Directive, for which the inner loop must be emitted.
3056 /// \param RequiresCleanup true, if directive has some associated private
3057 /// variables.
3058 /// \param LoopCond Bollean condition for loop continuation.
3059 /// \param IncExpr Increment expression for loop control variable.
3060 /// \param BodyGen Generator for the inner body of the inner loop.
3061 /// \param PostIncGen Genrator for post-increment code (required for ordered
3062 /// loop directvies).
3063 void EmitOMPInnerLoop(
3064 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
3065 const Expr *IncExpr,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003066 const llvm::function_ref<void(CodeGenFunction &)> BodyGen,
3067 const llvm::function_ref<void(CodeGenFunction &)> PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00003068
Alexey Bataev81c7ea02015-07-03 09:56:58 +00003069 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00003070 /// Emit initial code for loop counters of loop-based directives.
3071 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
3072 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00003073
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003074 /// Helper for the OpenMP loop directives.
3075 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
3076
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003077 /// Emit code for the worksharing loop-based directive.
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003078 /// \return true, if this construct has any lastprivate clause, false -
3079 /// otherwise.
3080 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
3081 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
3082 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3083
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003084 /// Emit code for the distribute loop-based directive.
3085 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
3086 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
3087
Alexey Bataevf8365372017-11-17 17:57:25 +00003088 /// Helpers for the OpenMP loop directives.
3089 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
3090 void EmitOMPSimdFinal(
3091 const OMPLoopDirective &D,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003092 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
Alexey Bataevf8365372017-11-17 17:57:25 +00003093
Alexey Bataevf47c4b42017-09-26 13:47:31 +00003094 /// Emits the lvalue for the expression with possibly captured variable.
3095 LValue EmitOMPSharedLValue(const Expr *E);
3096
Alexander Musmanc6388682014-12-15 07:07:06 +00003097private:
Yaxun Liufa13d012018-02-15 16:39:19 +00003098 /// Helpers for blocks.
3099 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
George Burgess IVe3763372016-12-22 02:50:20 +00003100
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003101 /// struct with the values to be passed to the OpenMP loop-related functions
3102 struct OMPLoopArguments {
3103 /// loop lower bound
3104 Address LB = Address::invalid();
3105 /// loop upper bound
3106 Address UB = Address::invalid();
3107 /// loop stride
3108 Address ST = Address::invalid();
3109 /// isLastIteration argument for runtime functions
3110 Address IL = Address::invalid();
3111 /// Chunk value generated by sema
3112 llvm::Value *Chunk = nullptr;
3113 /// EnsureUpperBound
3114 Expr *EUB = nullptr;
3115 /// IncrementExpression
3116 Expr *IncExpr = nullptr;
3117 /// Loop initialization
3118 Expr *Init = nullptr;
3119 /// Loop exit condition
3120 Expr *Cond = nullptr;
3121 /// Update of LB after a whole chunk has been executed
3122 Expr *NextLB = nullptr;
3123 /// Update of UB after a whole chunk has been executed
3124 Expr *NextUB = nullptr;
3125 OMPLoopArguments() = default;
3126 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
3127 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
3128 Expr *IncExpr = nullptr, Expr *Init = nullptr,
3129 Expr *Cond = nullptr, Expr *NextLB = nullptr,
3130 Expr *NextUB = nullptr)
3131 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
3132 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
3133 NextUB(NextUB) {}
3134 };
3135 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
3136 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
3137 const OMPLoopArguments &LoopArgs,
3138 const CodeGenLoopTy &CodeGenLoop,
3139 const CodeGenOrderedTy &CodeGenOrdered);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00003140 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00003141 bool IsMonotonic, const OMPLoopDirective &S,
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003142 OMPPrivateScope &LoopScope, bool Ordered,
3143 const OMPLoopArguments &LoopArgs,
3144 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3145 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
3146 const OMPLoopDirective &S,
3147 OMPPrivateScope &LoopScope,
3148 const OMPLoopArguments &LoopArgs,
3149 const CodeGenLoopTy &CodeGenLoopContent);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003150 /// Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00003151 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00003152
3153public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00003154
Chris Lattner208ae962007-05-30 17:57:17 +00003155 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00003156 // LValue Expression Emission
3157 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00003158
Daniel Dunbarc79407f2009-02-05 07:09:07 +00003159 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
3160 RValue GetUndefRValue(QualType Ty);
3161
Daniel Dunbarbb197e42009-01-09 16:50:52 +00003162 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
3163 /// and issue an ErrorUnsupported style diagnostic (using the
3164 /// provided Name).
3165 RValue EmitUnsupportedRValue(const Expr *E,
3166 const char *Name);
3167
Mike Stumpfc496822009-02-08 23:14:22 +00003168 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
3169 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00003170 LValue EmitUnsupportedLValue(const Expr *E,
3171 const char *Name);
3172
Chris Lattner8394d792007-06-05 20:53:16 +00003173 /// EmitLValue - Emit code to compute a designator that specifies the location
3174 /// of the expression.
3175 ///
3176 /// This can return one of two things: a simple address or a bitfield
3177 /// reference. In either case, the LLVM Value* in the LValue structure is
3178 /// guaranteed to be an LLVM pointer type.
3179 ///
3180 /// If this returns a bitfield reference, nothing about the pointee type of
3181 /// the LLVM value is known: For example, it may not be a pointer to an
3182 /// integer.
3183 ///
3184 /// If this returns a normal address, and if the lvalue's C type is fixed
3185 /// size, this method guarantees that the returned pointer type will point to
3186 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
3187 /// variable length type, this is not possible.
3188 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00003189 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003190
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003191 /// Same as EmitLValue but additionally we generate checking code to
Richard Smith4d1458e2012-09-08 02:08:36 +00003192 /// guard against undefined behavior. This is only suitable when we know
3193 /// that the address will be used to access the object.
3194 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00003195
John McCall7f416cc2015-09-08 08:05:57 +00003196 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003197 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00003198
John McCalla8ec7eb2013-03-07 21:37:17 +00003199 void EmitAtomicInit(Expr *E, LValue lvalue);
3200
David Majnemera5b195a2015-02-14 01:35:12 +00003201 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00003202
3203 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
3204 AggValueSlot Slot = AggValueSlot::ignored());
3205
Nick Lewycky2d84e842013-10-02 02:29:49 +00003206 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00003207 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00003208 AggValueSlot slot = AggValueSlot::ignored());
3209
3210 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3211
David Majnemera5b195a2015-02-14 01:35:12 +00003212 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3213 bool IsVolatile, bool isInit);
3214
Alexey Bataevb4505a72015-03-30 05:20:59 +00003215 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00003216 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00003217 llvm::AtomicOrdering Success =
3218 llvm::AtomicOrdering::SequentiallyConsistent,
3219 llvm::AtomicOrdering Failure =
3220 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00003221 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3222
Alexey Bataevb4505a72015-03-30 05:20:59 +00003223 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00003224 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00003225 bool IsVolatile);
3226
John McCall3a7f6922010-10-27 20:58:56 +00003227 /// EmitToMemory - Change a scalar value from its value
3228 /// representation to its in-memory representation.
3229 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3230
3231 /// EmitFromMemory - Change a scalar value from its memory
3232 /// representation to its value representation.
3233 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3234
Vedant Kumar5a972652017-02-27 19:46:19 +00003235 /// Check if the scalar \p Value is within the valid range for the given
3236 /// type \p Ty.
3237 ///
3238 /// Returns true if a check is needed (even if the range is unknown).
3239 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3240 SourceLocation Loc);
3241
Daniel Dunbar1d425462009-02-10 00:57:50 +00003242 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3243 /// care to appropriately convert from the memory representation to
3244 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003245 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003246 SourceLocation Loc,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003247 AlignmentSource Source = AlignmentSource::Type,
3248 bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003249 return EmitLoadOfScalar(Addr, Volatile, Ty, Loc, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003250 CGM.getTBAAAccessInfo(Ty), isNontemporal);
3251 }
3252
3253 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3254 SourceLocation Loc, LValueBaseInfo BaseInfo,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003255 TBAAAccessInfo TBAAInfo,
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003256 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003257
3258 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3259 /// care to appropriately convert from the memory representation to
3260 /// the LLVM value representation. The l-value must be a simple
3261 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003262 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003263
3264 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3265 /// care to appropriately convert from the memory representation to
3266 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003267 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3268 bool Volatile, QualType Ty,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003269 AlignmentSource Source = AlignmentSource::Type,
3270 bool isInit = false, bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003271 EmitStoreOfScalar(Value, Addr, Volatile, Ty, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003272 CGM.getTBAAAccessInfo(Ty), isInit, isNontemporal);
3273 }
3274
3275 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003276 bool Volatile, QualType Ty,
3277 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo,
Ivan A. Kosareva511ed72017-10-03 10:52:39 +00003278 bool isInit = false, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003279
3280 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3281 /// care to appropriately convert from the memory representation to
3282 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00003283 /// l-value. The isInit flag indicates whether this is an initialization.
3284 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3285 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003286
Chris Lattner8394d792007-06-05 20:53:16 +00003287 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3288 /// this method emits the address of the lvalue, then loads the result as an
3289 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003290 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00003291 RValue EmitLoadOfExtVectorElementLValue(LValue V);
Vedant Kumar129edab2017-03-09 16:06:27 +00003292 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
Renato Golin230c5eb2014-05-19 18:15:42 +00003293 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00003294
Chris Lattner8394d792007-06-05 20:53:16 +00003295 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3296 /// lvalue, where both are guaranteed to the have the same type, and that type
3297 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00003298 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003299 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00003300 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003301
Nick Lewycky2d84e842013-10-02 02:29:49 +00003302 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3303 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003304 ///
Mike Stumpfc496822009-02-08 23:14:22 +00003305 /// \param Result [out] - If non-null, this will be set to a Value* for the
3306 /// bit-field contents after the store, appropriate for use as the result of
3307 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00003308 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00003309 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00003310
John McCall4f29b492010-11-16 23:07:28 +00003311 /// Emit an l-value for an assignment (simple or compound) of complex type.
3312 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003313 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00003314 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3315 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00003316
Chris Lattner57540c52011-04-15 05:22:18 +00003317 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00003318 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003319 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003320 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00003321 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003322 // Note: only available for agg return types
3323 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00003324 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00003325 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00003326 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00003327 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00003328 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00003329 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3330 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00003331 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3332 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00003333 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00003334 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00003335 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00003336 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00003337 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00003338 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00003339 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00003340 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00003341 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003342
John McCall7f416cc2015-09-08 08:05:57 +00003343 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003344
Nick Lewycky2d84e842013-10-02 02:29:49 +00003345 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00003346
John McCall7f416cc2015-09-08 08:05:57 +00003347 Address EmitArrayToPointerDecay(const Expr *Array,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00003348 LValueBaseInfo *BaseInfo = nullptr,
3349 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003350
John McCall71335052012-03-10 03:05:10 +00003351 class ConstantEmission {
3352 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3353 ConstantEmission(llvm::Constant *C, bool isReference)
3354 : ValueAndIsReference(C, isReference) {}
3355 public:
3356 ConstantEmission() {}
3357 static ConstantEmission forReference(llvm::Constant *C) {
3358 return ConstantEmission(C, true);
3359 }
3360 static ConstantEmission forValue(llvm::Constant *C) {
3361 return ConstantEmission(C, false);
3362 }
3363
Aaron Ballman67347662015-02-15 22:00:28 +00003364 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00003365 return ValueAndIsReference.getOpaqueValue() != nullptr;
3366 }
John McCall71335052012-03-10 03:05:10 +00003367
3368 bool isReference() const { return ValueAndIsReference.getInt(); }
3369 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3370 assert(isReference());
3371 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3372 refExpr->getType());
3373 }
3374
3375 llvm::Constant *getValue() const {
3376 assert(!isReference());
3377 return ValueAndIsReference.getPointer();
3378 }
3379 };
3380
John McCall113bee02012-03-10 09:33:50 +00003381 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
Alex Lorenz6cc83172017-08-25 10:07:00 +00003382 ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
John McCall71335052012-03-10 03:05:10 +00003383
John McCallfe96e0b2011-11-06 09:01:30 +00003384 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3385 AggValueSlot slot = AggValueSlot::ignored());
3386 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3387
Daniel Dunbar722f4242009-04-22 05:08:15 +00003388 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003389 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00003390 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00003391 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003392
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003393 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3394 /// if the Field is a reference, this will return the address of the reference
3395 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003396 LValue EmitLValueForFieldInitialization(LValue Base,
3397 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003398
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003399 LValue EmitLValueForIvar(QualType ObjectTy,
3400 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003401 unsigned CVRQualifiers);
3402
Anders Carlsson3be22e22009-05-30 23:23:33 +00003403 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003404 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00003405 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003406 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003407 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003408
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003409 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003410 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003411 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003412 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003413 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003414 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003415
Chris Lattnerd7f58862007-06-02 05:24:33 +00003416 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003417 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003418 //===--------------------------------------------------------------------===//
3419
Mike Stumpfc496822009-02-08 23:14:22 +00003420 /// EmitCall - Generate a call of the given function, expecting the given
3421 /// result type, and using the given argument list which specifies both the
3422 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003423 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003424 ReturnValueSlot ReturnValue, const CallArgList &Args,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003425 llvm::Instruction **callOrInvoke, SourceLocation Loc);
3426 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
3427 ReturnValueSlot ReturnValue, const CallArgList &Args,
3428 llvm::Instruction **callOrInvoke = nullptr) {
3429 return EmitCall(CallInfo, Callee, ReturnValue, Args, callOrInvoke,
3430 SourceLocation());
3431 }
John McCallb92ab1a2016-10-26 23:46:34 +00003432 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003433 ReturnValueSlot ReturnValue, llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003434 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003435 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003436 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3437 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003438
Eric Christopherc7e79db2015-11-12 00:44:04 +00003439 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003440
John McCall882987f2013-02-28 19:01:20 +00003441 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3442 const Twine &name = "");
3443 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3444 ArrayRef<llvm::Value*> args,
3445 const Twine &name = "");
3446 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3447 const Twine &name = "");
3448 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3449 ArrayRef<llvm::Value*> args,
3450 const Twine &name = "");
3451
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003452 SmallVector<llvm::OperandBundleDef, 1>
3453 getBundlesForFunclet(llvm::Value *Callee);
3454
John McCallbd309292010-07-06 01:34:17 +00003455 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003456 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00003457 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00003458 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3459 ArrayRef<llvm::Value*> args,
3460 const Twine &name = "");
3461 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3462 const Twine &name = "");
3463 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3464 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00003465
Gor Nishanov04491bd2017-11-11 17:00:43 +00003466 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
John McCallb92ab1a2016-10-26 23:46:34 +00003467 NestedNameSpecifier *Qual,
3468 llvm::Type *Ty);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003469
John McCallb92ab1a2016-10-26 23:46:34 +00003470 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
Gor Nishanov04491bd2017-11-11 17:00:43 +00003471 CXXDtorType Type,
John McCallb92ab1a2016-10-26 23:46:34 +00003472 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003473
Akira Hatanaka7275da02018-02-28 07:15:55 +00003474 // These functions emit calls to the special functions of non-trivial C
3475 // structs.
3476 void defaultInitNonTrivialCStructVar(LValue Dst);
3477 void callCStructDefaultConstructor(LValue Dst);
3478 void callCStructDestructor(LValue Dst);
3479 void callCStructCopyConstructor(LValue Dst, LValue Src);
3480 void callCStructMoveConstructor(LValue Dst, LValue Src);
3481 void callCStructCopyAssignmentOperator(LValue Dst, LValue Src);
3482 void callCStructMoveAssignmentOperator(LValue Dst, LValue Src);
3483
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003484 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003485 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3486 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003487 ReturnValueSlot ReturnValue, llvm::Value *This,
3488 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003489 QualType ImplicitParamTy, const CallExpr *E,
3490 CallArgList *RtlArgs);
John McCallb92ab1a2016-10-26 23:46:34 +00003491 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3492 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003493 llvm::Value *This, llvm::Value *ImplicitParam,
3494 QualType ImplicitParamTy, const CallExpr *E,
3495 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003496 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3497 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003498 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3499 const CXXMethodDecl *MD,
3500 ReturnValueSlot ReturnValue,
3501 bool HasQualifier,
3502 NestedNameSpecifier *Qualifier,
3503 bool IsArrow, const Expr *Base);
3504 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003505 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3506 llvm::Value *memberPtr,
3507 const MemberPointerType *memberPtrType,
Ivan A. Kosarev229a6d82017-10-13 16:38:32 +00003508 LValueBaseInfo *BaseInfo = nullptr,
3509 TBAAAccessInfo *TBAAInfo = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003510 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3511 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003512
Anders Carlsson4034a952009-05-27 04:18:27 +00003513 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003514 const CXXMethodDecl *MD,
3515 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003516 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003517
Peter Collingbournefe883422011-10-06 18:29:37 +00003518 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3519 ReturnValueSlot ReturnValue);
3520
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003521 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3522 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003523
Mike Stump11289f42009-09-09 15:08:12 +00003524 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00003525 unsigned BuiltinID, const CallExpr *E,
3526 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003527
Akira Hatanaka6b103bc2017-10-06 07:12:46 +00003528 /// Emit IR for __builtin_os_log_format.
3529 RValue emitBuiltinOSLogFormat(const CallExpr &E);
3530
3531 llvm::Function *generateBuiltinOSLogHelperFunction(
3532 const analyze_os_log::OSLogBufferLayout &Layout,
3533 CharUnits BufferAlignment);
3534
Anders Carlssonbfb36712009-12-24 21:13:40 +00003535 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003536
Mike Stumpfc496822009-02-08 23:14:22 +00003537 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3538 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003539 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3540
Kevin Qin1718af62013-11-14 02:45:18 +00003541 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3542 const llvm::CmpInst::Predicate Fp,
3543 const llvm::CmpInst::Predicate Ip,
3544 const llvm::Twine &Name = "");
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003545 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3546 llvm::Triple::ArchType Arch);
Tim Northover8fe03d62014-02-21 11:57:24 +00003547
3548 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3549 unsigned LLVMIntrinsic,
3550 unsigned AltLLVMIntrinsic,
3551 const char *NameHint,
3552 unsigned Modifier,
3553 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003554 SmallVectorImpl<llvm::Value *> &Ops,
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003555 Address PtrOp0, Address PtrOp1,
3556 llvm::Triple::ArchType Arch);
Simon Tatham89e31fa2018-05-30 07:54:05 +00003557
3558 llvm::Value *EmitISOVolatileLoad(const CallExpr *E);
3559 llvm::Value *EmitISOVolatileStore(const CallExpr *E);
3560
Tim Northover8fe03d62014-02-21 11:57:24 +00003561 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3562 unsigned Modifier, llvm::Type *ArgTy,
3563 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003564 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003565 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003566 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003567 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003568 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003569 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003570 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003571 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3572 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003573 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003574 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3575 llvm::Triple::ArchType Arch);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003576
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003577 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003578 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3579 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003580 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003581 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003582 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003583 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3584 const CallExpr *E);
Krzysztof Parzyszek5a655832017-12-13 19:56:03 +00003585 llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003586
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003587private:
3588 enum class MSVCIntrin;
3589
3590public:
3591 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3592
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003593 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3594
Daniel Dunbar66912a12008-08-20 00:28:19 +00003595 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003596 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003597 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003598 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3599 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3600 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003601 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003602 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003603 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3604 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003605
John McCall31168b02011-06-15 23:02:42 +00003606 /// Retrieves the default cleanup kind for an ARC cleanup.
3607 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3608 CleanupKind getARCCleanupKind() {
3609 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3610 ? NormalAndEHCleanup : NormalCleanup;
3611 }
3612
3613 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003614 void EmitARCInitWeak(Address addr, llvm::Value *value);
3615 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003616 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003617 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3618 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
Akira Hatanakad791e922018-03-19 17:38:40 +00003619 void emitARCCopyAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
3620 void emitARCMoveAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
John McCall7f416cc2015-09-08 08:05:57 +00003621 void EmitARCCopyWeak(Address dst, Address src);
3622 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003623 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3624 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003625 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003626 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003627 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003628 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003629 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003630 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003631 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003632 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003633 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003634 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003635 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3636 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3637 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003638 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003639
3640 std::pair<LValue,llvm::Value*>
3641 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3642 std::pair<LValue,llvm::Value*>
3643 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003644 std::pair<LValue,llvm::Value*>
3645 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003646
John McCall248512a2011-10-01 10:32:24 +00003647 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003648 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3649 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3650
John McCallff613032011-10-04 06:23:45 +00003651 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003652 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3653 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003654 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3655 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003656 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003657
Craig Topper00bbdcf2014-06-28 23:22:23 +00003658 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003659
John McCall82fe67b2011-07-09 01:37:26 +00003660 static Destroyer destroyARCStrongImprecise;
3661 static Destroyer destroyARCStrongPrecise;
3662 static Destroyer destroyARCWeak;
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00003663 static Destroyer emitARCIntrinsicUse;
Akira Hatanaka7275da02018-02-28 07:15:55 +00003664 static Destroyer destroyNonTrivialCStruct;
John McCall82fe67b2011-07-09 01:37:26 +00003665
Gor Nishanov04491bd2017-11-11 17:00:43 +00003666 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003667 llvm::Value *EmitObjCAutoreleasePoolPush();
3668 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3669 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003670 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003671
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003672 /// Emits a reference binding to the passed in expression.
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003673 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003674
Chris Lattner6278e6a2007-08-11 00:04:45 +00003675 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003676 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003677 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003678
3679 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003680
3681 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3682 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003683 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003684
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003685 /// Emit a conversion from the specified type to the specified destination
3686 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003687 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003688 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003689
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003690 /// Emit a conversion from the specified complex type to the specified
3691 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003692 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003693 QualType DstTy,
3694 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003695
John McCall7a626f62010-09-15 10:14:12 +00003696 /// EmitAggExpr - Emit the computation of the specified expression
3697 /// of aggregate type. The result is computed into the given slot,
3698 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003699 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003700
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003701 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3702 /// aggregate type into a temporary LValue.
3703 LValue EmitAggExprToLValue(const Expr *E);
3704
John McCall1bd25562011-06-24 23:21:27 +00003705 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3706 /// make sure it survives garbage collection until this point.
3707 void EmitExtendGCLifetime(llvm::Value *object);
3708
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003709 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003710 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003711 ComplexPairTy EmitComplexExpr(const Expr *E,
3712 bool IgnoreReal = false,
3713 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003714
John McCall47fb9502013-03-07 21:37:08 +00003715 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3716 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003717 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003718
John McCall47fb9502013-03-07 21:37:08 +00003719 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003720 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003721
3722 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003723 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003724
John McCall7f416cc2015-09-08 08:05:57 +00003725 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3726 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3727
Chandler Carruth84537952012-03-30 19:44:53 +00003728 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3729 /// global variable that has already been created for it. If the initializer
3730 /// has a different type than GV does, this may free GV and return a different
3731 /// one. Otherwise it just returns GV.
3732 llvm::GlobalVariable *
3733 AddInitializerToStaticVarDecl(const VarDecl &D,
3734 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003735
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003736
Anders Carlssonf40886a2009-08-08 21:45:14 +00003737 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3738 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003739 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3740 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003741
David Majnemerb3341ea2014-10-05 05:05:40 +00003742 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3743 llvm::Constant *Addr);
3744
John McCallc84ed6a2012-05-01 06:13:13 +00003745 /// Call atexit() with a function that passes the given argument to
3746 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003747 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3748 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003749
Akira Hatanaka617e2612018-04-17 18:41:52 +00003750 /// Call atexit() with function dtorStub.
3751 void registerGlobalDtorWithAtExit(llvm::Constant *dtorStub);
3752
John McCallcdf7ef52010-11-06 09:44:32 +00003753 /// Emit code in this function to perform a guarded variable
3754 /// initialization. Guarded initializations are used when it's not
3755 /// possible to prove that an initialization will be done exactly
3756 /// once, e.g. with a static local variable or a static data member
3757 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003758 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003759 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003760
Richard Smithae8d62c2017-07-26 22:01:09 +00003761 enum class GuardKind { VariableGuard, TlsGuard };
3762
3763 /// Emit a branch to select whether or not to perform guarded initialization.
3764 void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
3765 llvm::BasicBlock *InitBlock,
3766 llvm::BasicBlock *NoInitBlock,
3767 GuardKind Kind, const VarDecl *D);
3768
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003769 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3770 /// variables.
3771 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003772 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003773 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003774
John McCallee08c532012-04-06 18:21:03 +00003775 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003776 /// variables.
Sanjoy Dase369bd92017-05-01 17:08:00 +00003777 void GenerateCXXGlobalDtorsFunc(
3778 llvm::Function *Fn,
3779 const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
3780 &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003781
John McCalla738c252011-03-09 04:27:21 +00003782 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3783 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003784 llvm::GlobalVariable *Addr,
3785 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003786
John McCall7a626f62010-09-15 10:14:12 +00003787 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003788
John McCall7f416cc2015-09-08 08:05:57 +00003789 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003790
John McCall08ef4662011-11-10 08:15:53 +00003791 void enterFullExpression(const ExprWithCleanups *E) {
3792 if (E->getNumObjects() == 0) return;
3793 enterNonTrivialFullExpression(E);
3794 }
3795 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003796
Richard Smithea852322013-05-07 21:53:22 +00003797 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003798
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003799 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3800
Tim Northovercc2a6e02015-11-09 19:56:35 +00003801 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003802
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003803 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003804 // Annotations Emission
3805 //===--------------------------------------------------------------------===//
3806
3807 /// Emit an annotation call (intrinsic or builtin).
3808 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3809 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003810 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003811 SourceLocation Location);
3812
3813 /// Emit local annotations for the local variable V, declared by D.
3814 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3815
3816 /// Emit field annotations for the given field & value. Returns the
3817 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003818 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003819
3820 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003821 // Internal Helpers
3822 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003823
Chris Lattner5b1964b2008-11-11 07:41:27 +00003824 /// ContainsLabel - Return true if the statement contains a label in it. If
3825 /// this statement is not executed normally, it not containing a label means
3826 /// that we can just remove the code.
3827 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003828
Chris Lattner29911cc2011-02-28 00:18:40 +00003829 /// containsBreak - Return true if the statement contains a break out of it.
3830 /// If the statement (recursively) contains a switch or loop with a break
3831 /// inside of it, this is fine.
3832 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003833
3834 /// Determine if the given statement might introduce a declaration into the
3835 /// current scope, by being a (possibly-labelled) DeclStmt.
3836 static bool mightAddDeclToScope(const Stmt *S);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003837
Daniel Dunbar682712c2008-11-12 10:12:14 +00003838 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003839 /// to a constant, or if it does but contains a label, return false. If it
3840 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003841 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3842 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003843
Chris Lattner29911cc2011-02-28 00:18:40 +00003844 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3845 /// to a constant, or if it does but contains a label, return false. If it
3846 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003847 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3848 bool AllowLabels = false);
3849
Chris Lattnercd439292008-11-12 08:04:58 +00003850 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3851 /// if statement) to the specified blocks. Based on the condition, this might
3852 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003853 /// TrueCount should be the number of times we expect the condition to
3854 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003855 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003856 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003857
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003858 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
3859 /// nonnull, if \p LHS is marked _Nonnull.
3860 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
3861
Vedant Kumar175b6d12017-07-13 20:55:26 +00003862 /// An enumeration which makes it easier to specify whether or not an
3863 /// operation is a subtraction.
3864 enum { NotSubtraction = false, IsSubtraction = true };
3865
Vedant Kumara125eb52017-06-01 19:22:18 +00003866 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
3867 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003868 /// \p SignedIndices indicates whether any of the GEP indices are signed.
Vedant Kumar175b6d12017-07-13 20:55:26 +00003869 /// \p IsSubtraction indicates whether the expression used to form the GEP
3870 /// is a subtraction.
Vedant Kumara125eb52017-06-01 19:22:18 +00003871 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
3872 ArrayRef<llvm::Value *> IdxList,
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003873 bool SignedIndices,
Vedant Kumar175b6d12017-07-13 20:55:26 +00003874 bool IsSubtraction,
Vedant Kumara125eb52017-06-01 19:22:18 +00003875 SourceLocation Loc,
3876 const Twine &Name = "");
3877
Vedant Kumar10c31022017-07-29 00:19:51 +00003878 /// Specifies which type of sanitizer check to apply when handling a
3879 /// particular builtin.
3880 enum BuiltinCheckKind {
3881 BCK_CTZPassedZero,
3882 BCK_CLZPassedZero,
3883 };
3884
3885 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
3886 /// enabled, a runtime check specified by \p Kind is also emitted.
3887 llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
3888
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003889 /// Emit a description of a type in a format suitable for passing to
Richard Smithe30752c2012-10-09 19:52:38 +00003890 /// a runtime sanitizer handler.
3891 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3892
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003893 /// Convert a value into a format suitable for passing to a runtime
Richard Smithe30752c2012-10-09 19:52:38 +00003894 /// sanitizer handler.
3895 llvm::Value *EmitCheckValue(llvm::Value *V);
3896
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003897 /// Emit a description of a source location in a format suitable for
Richard Smithe30752c2012-10-09 19:52:38 +00003898 /// passing to a runtime sanitizer handler.
3899 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3900
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003901 /// Create a basic block that will call a handler function in a
Richard Smithde670682012-11-01 22:15:34 +00003902 /// sanitizer runtime with the provided arguments, and create a conditional
3903 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003904 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00003905 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003906 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003907
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003908 /// Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003909 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003910 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3911 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3912 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003913
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003914 /// Emit a reached-unreachable diagnostic if \p Loc is valid and runtime
3915 /// checking is enabled. Otherwise, just emit an unreachable instruction.
3916 void EmitUnreachable(SourceLocation Loc);
3917
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003918 /// Create a basic block that will call the trap intrinsic, and emit a
Richard Smithde670682012-11-01 22:15:34 +00003919 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003920 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003921
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003922 /// Emit a call to trap or debugtrap and attach function attribute
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003923 /// "trap-func-name" if specified.
3924 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3925
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003926 /// Emit a stub for the cross-DSO CFI check function.
Evgeniy Stepanov1a8030e2017-04-07 23:00:38 +00003927 void EmitCfiCheckStub();
3928
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003929 /// Emit a cross-DSO CFI failure handling function.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003930 void EmitCfiCheckFail();
3931
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003932 /// Create a check for a function parameter that may potentially be
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003933 /// declared as non-null.
3934 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003935 AbstractCallee AC, unsigned ParmNum);
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003936
Anders Carlsson093bdff2010-03-30 03:27:09 +00003937 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003938 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003939
John McCall23f66262010-05-26 22:34:26 +00003940 /// EmitDelegateCallArg - We are performing a delegate call; that
3941 /// is, the current function is delegating to another one. Produce
3942 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003943 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3944 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003945
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003946 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3947 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003948 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003949
Chris Lattnercd439292008-11-12 08:04:58 +00003950private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003951 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003952 void EmitReturnOfRValue(RValue RV, QualType Ty);
3953
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003954 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3955
3956 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3957 DeferredReplacements;
3958
John McCall7f416cc2015-09-08 08:05:57 +00003959 /// Set the address of a local variable.
3960 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3961 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3962 LocalDeclMap.insert({VD, Addr});
3963 }
3964
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003965 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3966 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3967 ///
3968 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003969 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003970 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003971
Yaxun Liu5b330e82018-03-15 15:25:19 +00003972 /// ExpandTypeToArgs - Expand an CallArg \arg Arg, with the LLVM type for \arg
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003973 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3974 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003975 void ExpandTypeToArgs(QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003976 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3977 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003978
Chad Rosier59df25b2012-08-23 20:00:18 +00003979 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003980 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003981
Chad Rosier59df25b2012-08-23 20:00:18 +00003982 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003983 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003984 std::string &ConstraintStr,
3985 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003986
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003987 /// Attempts to statically evaluate the object size of E. If that
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003988 /// fails, emits code to figure the size of E out for us. This is
3989 /// pass_object_size aware.
George Burgess IV0d6592a2017-02-23 05:59:56 +00003990 ///
3991 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003992 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003993 llvm::IntegerType *ResType,
3994 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003995
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003996 /// Emits the size of E, as required by __builtin_object_size. This
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003997 /// function is aware of pass_object_size parameters, and will act accordingly
3998 /// if E is a parameter with the pass_object_size attribute.
3999 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00004000 llvm::IntegerType *ResType,
4001 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004002
Reid Kleckner89077a12013-12-17 19:46:40 +00004003public:
Douglas Gregore83b9562015-07-07 03:57:53 +00004004#ifndef NDEBUG
4005 // Determine whether the given argument is an Objective-C method
4006 // that may have type parameters in its signature.
4007 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
4008 const DeclContext *dc = method->getDeclContext();
4009 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
4010 return classDecl->getTypeParamListAsWritten();
4011 }
4012
4013 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
4014 return catDecl->getTypeParamList();
4015 }
4016
4017 return false;
4018 }
4019
4020 template<typename T>
4021 static bool isObjCMethodWithTypeParams(const T *) { return false; }
4022#endif
4023
Richard Smitha560ccf2016-09-29 21:30:12 +00004024 enum class EvaluationOrder {
4025 ///! No language constraints on evaluation order.
4026 Default,
4027 ///! Language semantics require left-to-right evaluation.
4028 ForceLeftToRight,
4029 ///! Language semantics require right-to-left evaluation.
4030 ForceRightToLeft
4031 };
4032
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00004033 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00004034 template <typename T>
4035 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00004036 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00004037 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00004038 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00004039 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00004040 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00004041 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00004042
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004043 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
4044 "Can't skip parameters if type info is not provided");
4045 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00004046#ifndef NDEBUG
4047 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
4048#endif
4049
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004050 // First, use the argument types that the type info knows about
4051 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
4052 E = CallArgTypeInfo->param_type_end();
4053 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00004054 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00004055 assert((isGenericMethod ||
4056 ((*I)->isVariablyModifiedType() ||
4057 (*I).getNonReferenceType()->isObjCRetainableType() ||
4058 getContext()
4059 .getCanonicalType((*I).getNonReferenceType())
4060 .getTypePtr() ==
4061 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00004062 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00004063 .getTypePtr())) &&
4064 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004065 ArgTypes.push_back(*I);
4066 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00004067 }
Mike Stump11289f42009-09-09 15:08:12 +00004068
Reid Kleckner739756c2013-12-04 19:23:12 +00004069 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004070 // function.
David Blaikief05779e2015-07-21 18:37:18 +00004071 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
4072 CallArgTypeInfo->isVariadic()) &&
4073 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00004074
Anders Carlsson603d6af2009-04-18 20:20:22 +00004075 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00004076 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00004077 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00004078
Vedant Kumared00ea02017-03-06 05:28:22 +00004079 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00004080 }
John McCalld4f4b7f2010-03-03 04:15:11 +00004081
Reid Kleckner739756c2013-12-04 19:23:12 +00004082 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00004083 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00004084 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00004085 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00004086 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00004087
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00004088 /// EmitPointerWithAlignment - Given an expression with a pointer type,
4089 /// emit the value and compute our best estimate of the alignment of the
4090 /// pointee.
John McCall7f416cc2015-09-08 08:05:57 +00004091 ///
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00004092 /// \param BaseInfo - If non-null, this will be initialized with
4093 /// information about the source of the alignment and the may-alias
4094 /// attribute. Note that this function will conservatively fall back on
4095 /// the type when it doesn't recognize the expression and may-alias will
4096 /// be set to false.
4097 ///
4098 /// One reasonable way to use this information is when there's a language
4099 /// guarantee that the pointer must be aligned to some stricter value, and
4100 /// we're simply trying to ensure that sufficiently obvious uses of under-
4101 /// aligned objects don't get miscompiled; for example, a placement new
4102 /// into the address of a local variable. In such a case, it's quite
4103 /// reasonable to just ignore the returned alignment when it isn't from an
4104 /// explicit source.
John McCall7f416cc2015-09-08 08:05:57 +00004105 Address EmitPointerWithAlignment(const Expr *Addr,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00004106 LValueBaseInfo *BaseInfo = nullptr,
4107 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00004108
Vedant Kumar36347d92017-12-08 01:51:47 +00004109 /// If \p E references a parameter with pass_object_size info or a constant
4110 /// array size modifier, emit the object size divided by the size of \p EltTy.
4111 /// Otherwise return null.
4112 llvm::Value *LoadPassedObjectSize(const Expr *E, QualType EltTy);
4113
Peter Collingbournedc134532016-01-16 00:31:22 +00004114 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
4115
Erich Keane281d20b2018-01-08 21:34:17 +00004116 struct MultiVersionResolverOption {
4117 llvm::Function *Function;
4118 TargetAttr::ParsedTargetAttr ParsedAttribute;
4119 unsigned Priority;
4120 MultiVersionResolverOption(const TargetInfo &TargInfo, llvm::Function *F,
4121 const clang::TargetAttr::ParsedTargetAttr &PT)
4122 : Function(F), ParsedAttribute(PT), Priority(0u) {
4123 for (StringRef Feat : PT.Features)
4124 Priority = std::max(Priority,
4125 TargInfo.multiVersionSortPriority(Feat.substr(1)));
4126
4127 if (!PT.Architecture.empty())
4128 Priority = std::max(Priority,
4129 TargInfo.multiVersionSortPriority(PT.Architecture));
4130 }
4131
4132 bool operator>(const MultiVersionResolverOption &Other) const {
4133 return Priority > Other.Priority;
4134 }
4135 };
4136 void EmitMultiVersionResolver(llvm::Function *Resolver,
4137 ArrayRef<MultiVersionResolverOption> Options);
4138
Reid Kleckner89077a12013-12-17 19:46:40 +00004139private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004140 QualType getVarArgType(const Expr *Arg);
4141
John McCall09ae0322010-07-06 23:57:41 +00004142 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00004143
John McCall7f416cc2015-09-08 08:05:57 +00004144 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
4145 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00004146
4147 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00004148
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00004149 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Erich Keane9937b132017-09-01 19:42:45 +00004150 llvm::Value *EmitX86CpuIs(const CallExpr *E);
4151 llvm::Value *EmitX86CpuIs(StringRef CPUStr);
4152 llvm::Value *EmitX86CpuSupports(const CallExpr *E);
4153 llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
Erich Keane1fe643a2017-10-06 16:40:45 +00004154 llvm::Value *EmitX86CpuInit();
Erich Keane281d20b2018-01-08 21:34:17 +00004155 llvm::Value *FormResolverCondition(const MultiVersionResolverOption &RO);
Chris Lattnerbed31442007-05-28 01:07:47 +00004156};
Mike Stump11289f42009-09-09 15:08:12 +00004157
John McCallce1de612011-01-26 04:00:11 +00004158/// Helper class with most of the code for saving a value for a
4159/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00004160struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00004161 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
4162
4163 /// Answer whether the given value needs extra work to be saved.
4164 static bool needsSaving(llvm::Value *value) {
4165 // If it's not an instruction, we don't need to save.
4166 if (!isa<llvm::Instruction>(value)) return false;
4167
4168 // If it's an instruction in the entry block, we don't need to save.
4169 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
4170 return (block != &block->getParent()->getEntryBlock());
4171 }
4172
4173 /// Try to save the given value.
4174 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
4175 if (!needsSaving(value)) return saved_type(value, false);
4176
John McCall7f416cc2015-09-08 08:05:57 +00004177 // Otherwise, we need an alloca.
4178 auto align = CharUnits::fromQuantity(
4179 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
4180 Address alloca =
4181 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00004182 CGF.Builder.CreateStore(value, alloca);
4183
John McCall7f416cc2015-09-08 08:05:57 +00004184 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00004185 }
4186
4187 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00004188 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00004189 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00004190
4191 // Otherwise, it should be an alloca instruction, as set up in save().
4192 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
4193 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00004194 }
4195};
4196
John McCallcb5f77f2011-01-28 10:53:53 +00004197/// A partial specialization of DominatingValue for llvm::Values that
4198/// might be llvm::Instructions.
4199template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
4200 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00004201 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00004202 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
4203 }
4204};
4205
John McCall7f416cc2015-09-08 08:05:57 +00004206/// A specialization of DominatingValue for Address.
4207template <> struct DominatingValue<Address> {
4208 typedef Address type;
4209
4210 struct saved_type {
4211 DominatingLLVMValue::saved_type SavedValue;
4212 CharUnits Alignment;
4213 };
4214
4215 static bool needsSaving(type value) {
4216 return DominatingLLVMValue::needsSaving(value.getPointer());
4217 }
4218 static saved_type save(CodeGenFunction &CGF, type value) {
4219 return { DominatingLLVMValue::save(CGF, value.getPointer()),
4220 value.getAlignment() };
4221 }
4222 static type restore(CodeGenFunction &CGF, saved_type value) {
4223 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
4224 value.Alignment);
4225 }
4226};
4227
John McCallcb5f77f2011-01-28 10:53:53 +00004228/// A specialization of DominatingValue for RValue.
4229template <> struct DominatingValue<RValue> {
4230 typedef RValue type;
4231 class saved_type {
4232 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
4233 AggregateAddress, ComplexAddress };
4234
4235 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00004236 unsigned K : 3;
4237 unsigned Align : 29;
4238 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
4239 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00004240
4241 public:
4242 static bool needsSaving(RValue value);
4243 static saved_type save(CodeGenFunction &CGF, RValue value);
4244 RValue restore(CodeGenFunction &CGF);
4245
John McCall7f416cc2015-09-08 08:05:57 +00004246 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00004247 };
4248
4249 static bool needsSaving(type value) {
4250 return saved_type::needsSaving(value);
4251 }
4252 static saved_type save(CodeGenFunction &CGF, type value) {
4253 return saved_type::save(CGF, value);
4254 }
4255 static type restore(CodeGenFunction &CGF, saved_type value) {
4256 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00004257 }
4258};
4259
Chris Lattnerbed31442007-05-28 01:07:47 +00004260} // end namespace CodeGen
4261} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00004262
Chris Lattnerbed31442007-05-28 01:07:47 +00004263#endif