blob: 4db5accc44df65c58b8558ae0f46b95cd7a81c49 [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
Alexander Musman515ad8c2014-05-22 08:54:05 +0000204 /// \brief CGBuilder insert helper. This function is called after an
205 /// 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;
Chris Lattnerac248202007-05-30 00:13:02 +0000217 llvm::Function *CurFn;
218
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.
245 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
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000258 /// \brief API for captured statement code generation.
259 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; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000286 // \brief 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
289 /// \brief 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
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000301 /// \brief 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
307 /// \brief Get the name of the capture helper.
308 virtual StringRef getHelperName() const { return "__captured_stmt"; }
309
310 private:
311 /// \brief The kind of captured statement being generated.
312 CapturedRegionKind Kind;
313
314 /// \brief Keep the map between VarDecl and FieldDecl.
315 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
316
317 /// \brief The base address of the captured record, passed in as the first
318 /// argument of the parallel region function.
319 llvm::Value *ThisValue;
320
321 /// \brief Captured 'this' type.
322 FieldDecl *CXXThisFieldDecl;
323 };
324 CGCapturedStmtInfo *CapturedStmtInfo;
325
Alexey Bataevd157d472015-06-24 03:35:38 +0000326 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
327 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
Alexey Samsonova0416102014-11-11 01:26:14 +0000365 /// \brief Sanitizers enabled for this function.
366 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000367
Alexey Samsonov24cad992014-07-17 18:46:27 +0000368 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
369 bool IsSanitizerScope;
370
371 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
372 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.
381 bool CurFuncIsThunk;
382
John McCall31168b02011-06-15 23:02:42 +0000383 /// In ARC, whether we should autorelease the return value.
384 bool AutoreleaseResult;
385
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.
388 bool SawAsmBlock;
389
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.
394 bool IsOutlinedSEHHelper;
395
John McCallad7c5c12011-02-08 08:22:06 +0000396 const CodeGen::CGBlockInfo *BlockInfo;
397 llvm::Value *BlockPointer;
398
Eli Friedman9fbeba02012-02-11 02:57:39 +0000399 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
400 FieldDecl *LambdaThisCaptureField;
401
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000402 /// \brief A mapping from NRVO variables to the flags used to indicate
403 /// 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.
John McCall5cdf0382018-01-12 22:07:01 +0000437 Address NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000438
439 unsigned NextCleanupDestIndex;
440
John McCall08ef4662011-11-10 08:15:53 +0000441 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
442 CGBlockInfo *FirstBlockInfo;
443
John McCall8e4c74b2011-08-11 02:22:43 +0000444 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
445 llvm::BasicBlock *EHResumeBlock;
446
Bill Wendlingf0724e82011-09-19 20:31:14 +0000447 /// The exception slot. All landing pads write the current exception pointer
448 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000449 llvm::Value *ExceptionSlot;
450
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.
John McCall9b382dd2011-05-28 21:13:02 +0000453 llvm::AllocaInst *EHSelectorSlot;
454
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
Richard Smith736a9472013-06-12 20:42:33 +0000528 /// \brief Queue a cleanup to be pushed after finishing the current
529 /// 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
John McCallbd309292010-07-06 01:34:17 +0000587 /// \brief Enters a new scope for capturing cleanups, all of which
588 /// will be executed once the scope is exited.
589 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000590 EHScopeStack::stable_iterator CleanupStackDepth;
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:
604 /// \brief 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;
Douglas Gregor965f4502009-11-24 16:43:22 +0000613 }
614
Reid Kleckner092d0652017-03-06 22:18:34 +0000615 /// \brief Exit this cleanup scope, emitting any accumulated cleanups.
John McCallbd309292010-07-06 01:34:17 +0000616 ~RunCleanupsScope() {
Reid Kleckner092d0652017-03-06 22:18:34 +0000617 if (PerformCleanup)
618 ForceCleanup();
Douglas Gregor680f8612009-11-24 21:15:44 +0000619 }
620
621 /// \brief Determine whether this scope requires any cleanups.
622 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000623 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000624 }
625
626 /// \brief Force the emission of cleanups now, instead of waiting
627 /// until this object is destroyed.
Reid Kleckner092d0652017-03-06 22:18:34 +0000628 /// \param ValuesToReload - A list of values that need to be available at
629 /// the insertion point after cleanup emission. If cleanup emission created
630 /// a shared cleanup block, these value pointers will be rewritten.
631 /// Otherwise, they not will be modified.
632 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
Douglas Gregor680f8612009-11-24 21:15:44 +0000633 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000634 CGF.DidCallStackSave = OldDidCallStackSave;
Reid Kleckner092d0652017-03-06 22:18:34 +0000635 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
636 ValuesToReload);
Douglas Gregor680f8612009-11-24 21:15:44 +0000637 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000638 }
639 };
640
David Blaikie93be0b22014-08-22 21:37:04 +0000641 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000642 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000643 SmallVector<const LabelDecl*, 4> Labels;
644 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000645
Aaron Ballmanabc18922015-02-15 22:54:08 +0000646 LexicalScope(const LexicalScope &) = delete;
647 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000648
649 public:
650 /// \brief Enter a new cleanup scope.
651 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000652 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
653 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000654 if (CGDebugInfo *DI = CGF.getDebugInfo())
655 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
656 }
657
Nadav Rotem1da30942013-03-23 06:43:35 +0000658 void addLabel(const LabelDecl *label) {
659 assert(PerformCleanup && "adding label to dead scope?");
660 Labels.push_back(label);
661 }
662
Eric Christophera9d34972011-10-19 00:43:52 +0000663 /// \brief Exit this cleanup scope, emitting any accumulated
664 /// cleanups.
665 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000666 if (CGDebugInfo *DI = CGF.getDebugInfo())
667 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
668
Nadav Rotem1da30942013-03-23 06:43:35 +0000669 // If we should perform a cleanup, force them now. Note that
670 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000671 if (PerformCleanup) {
672 ApplyDebugLocation DL(CGF, Range.getEnd());
673 ForceCleanup();
674 }
Eric Christophera9d34972011-10-19 00:43:52 +0000675 }
676
677 /// \brief Force the emission of cleanups now, instead of waiting
678 /// until this object is destroyed.
679 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000680 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000681 RunCleanupsScope::ForceCleanup();
682
Nadav Rotem1da30942013-03-23 06:43:35 +0000683 if (!Labels.empty())
684 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000685 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000686
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000687 bool hasLabels() const {
688 return !Labels.empty();
689 }
690
Nadav Rotem1da30942013-03-23 06:43:35 +0000691 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000692 };
693
John McCall7f416cc2015-09-08 08:05:57 +0000694 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
695
Alexey Bataevab4ea222018-03-07 18:17:06 +0000696 /// The class used to assign some variables some temporarily addresses.
697 class OMPMapVars {
John McCall7f416cc2015-09-08 08:05:57 +0000698 DeclMapTy SavedLocals;
Alexey Bataevab4ea222018-03-07 18:17:06 +0000699 DeclMapTy SavedTempAddresses;
700 OMPMapVars(const OMPMapVars &) = delete;
701 void operator=(const OMPMapVars &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000702
703 public:
Alexey Bataevab4ea222018-03-07 18:17:06 +0000704 explicit OMPMapVars() = default;
705 ~OMPMapVars() {
706 assert(SavedLocals.empty() && "Did not restored original addresses.");
707 };
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000708
Alexey Bataevab4ea222018-03-07 18:17:06 +0000709 /// Sets the address of the variable \p LocalVD to be \p TempAddr in
710 /// function \p CGF.
711 /// \return true if at least one variable was set already, false otherwise.
712 bool setVarAddr(CodeGenFunction &CGF, const VarDecl *LocalVD,
713 Address TempAddr) {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000714 LocalVD = LocalVD->getCanonicalDecl();
John McCall7f416cc2015-09-08 08:05:57 +0000715 // Only save it once.
716 if (SavedLocals.count(LocalVD)) return false;
717
718 // Copy the existing local entry to SavedLocals.
719 auto it = CGF.LocalDeclMap.find(LocalVD);
Alexey Bataevab4ea222018-03-07 18:17:06 +0000720 if (it != CGF.LocalDeclMap.end())
721 SavedLocals.try_emplace(LocalVD, it->second);
722 else
723 SavedLocals.try_emplace(LocalVD, Address::invalid());
John McCall7f416cc2015-09-08 08:05:57 +0000724
725 // Generate the private entry.
Alexey Bataevcaacd532015-09-04 11:26:21 +0000726 QualType VarTy = LocalVD->getType();
727 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000728 Address Temp = CGF.CreateMemTemp(VarTy);
Alexey Bataevab4ea222018-03-07 18:17:06 +0000729 CGF.Builder.CreateStore(TempAddr.getPointer(), Temp);
730 TempAddr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000731 }
Alexey Bataevab4ea222018-03-07 18:17:06 +0000732 SavedTempAddresses.try_emplace(LocalVD, TempAddr);
John McCall7f416cc2015-09-08 08:05:57 +0000733
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000734 return true;
735 }
736
Alexey Bataevab4ea222018-03-07 18:17:06 +0000737 /// Applies new addresses to the list of the variables.
738 /// \return true if at least one variable is using new address, false
739 /// otherwise.
740 bool apply(CodeGenFunction &CGF) {
741 copyInto(SavedTempAddresses, CGF.LocalDeclMap);
742 SavedTempAddresses.clear();
743 return !SavedLocals.empty();
744 }
745
746 /// Restores original addresses of the variables.
747 void restore(CodeGenFunction &CGF) {
748 if (!SavedLocals.empty()) {
749 copyInto(SavedLocals, CGF.LocalDeclMap);
750 SavedLocals.clear();
751 }
752 }
753
754 private:
755 /// Copy all the entries in the source map over the corresponding
756 /// entries in the destination, which must exist.
757 static void copyInto(const DeclMapTy &Src, DeclMapTy &Dest) {
758 for (auto &Pair : Src) {
759 if (!Pair.second.isValid()) {
760 Dest.erase(Pair.first);
761 continue;
762 }
763
764 auto I = Dest.find(Pair.first);
765 if (I != Dest.end())
766 I->second = Pair.second;
767 else
768 Dest.insert(Pair);
769 }
770 }
771 };
772
773 /// The scope used to remap some variables as private in the OpenMP loop body
774 /// (or other captured region emitted without outlining), and to restore old
775 /// vars back on exit.
776 class OMPPrivateScope : public RunCleanupsScope {
777 OMPMapVars MappedVars;
778 OMPPrivateScope(const OMPPrivateScope &) = delete;
779 void operator=(const OMPPrivateScope &) = delete;
780
781 public:
782 /// Enter a new OpenMP private scope.
783 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
784
785 /// Registers \p LocalVD variable as a private and apply \p PrivateGen
786 /// function for it to generate corresponding private variable. \p
787 /// PrivateGen returns an address of the generated private variable.
788 /// \return true if the variable is registered as private, false if it has
789 /// been privatized already.
790 bool addPrivate(const VarDecl *LocalVD,
791 llvm::function_ref<Address()> PrivateGen) {
792 assert(PerformCleanup && "adding private to dead scope");
793 return MappedVars.setVarAddr(CGF, LocalVD, PrivateGen());
794 }
795
796 /// Privatizes local variables previously registered as private.
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000797 /// Registration is separate from the actual privatization to allow
798 /// initializers use values of the original variables, not the private one.
799 /// This is important, for example, if the private variable is a class
800 /// variable initialized by a constructor that references other private
801 /// variables. But at initialization original variables must be used, not
802 /// private copies.
803 /// \return true if at least one variable was privatized, false otherwise.
Alexey Bataevab4ea222018-03-07 18:17:06 +0000804 bool Privatize() { return MappedVars.apply(CGF); }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000805
806 void ForceCleanup() {
807 RunCleanupsScope::ForceCleanup();
Alexey Bataevab4ea222018-03-07 18:17:06 +0000808 MappedVars.restore(CGF);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000809 }
810
Alexey Bataevab4ea222018-03-07 18:17:06 +0000811 /// Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000812 ~OMPPrivateScope() {
813 if (PerformCleanup)
814 ForceCleanup();
815 }
John McCall7f416cc2015-09-08 08:05:57 +0000816
Gor Nishanov04491bd2017-11-11 17:00:43 +0000817 /// Checks if the global variable is captured in current function.
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000818 bool isGlobalVarCaptured(const VarDecl *VD) const {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000819 VD = VD->getCanonicalDecl();
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000820 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
821 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000822 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000823
Richard Smith736a9472013-06-12 20:42:33 +0000824 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
825 /// that have been added.
Reid Kleckner092d0652017-03-06 22:18:34 +0000826 void
827 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
828 std::initializer_list<llvm::Value **> ValuesToReload = {});
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000829
Richard Smith736a9472013-06-12 20:42:33 +0000830 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
831 /// that have been added, then adds all lifetime-extended cleanups from
832 /// the given position to the stack.
Reid Kleckner092d0652017-03-06 22:18:34 +0000833 void
834 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
835 size_t OldLifetimeExtendedStackSize,
836 std::initializer_list<llvm::Value **> ValuesToReload = {});
Richard Smith736a9472013-06-12 20:42:33 +0000837
John McCallad5d61e2010-07-23 21:56:41 +0000838 void ResolveBranchFixups(llvm::BasicBlock *Target);
839
John McCallbd309292010-07-06 01:34:17 +0000840 /// The given basic block lies in the current EH scope, but may be a
841 /// target of a potentially scope-crossing jump; get a stable handle
842 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000843 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000844 return JumpDest(Target,
845 EHStack.getInnermostNormalCleanup(),
846 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000847 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000848
John McCallbd309292010-07-06 01:34:17 +0000849 /// The given basic block lies in the current EH scope, but may be a
850 /// target of a potentially scope-crossing jump; get a stable handle
851 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000852 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000853 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000854 }
855
856 /// EmitBranchThroughCleanup - Emit a branch from the current insert
857 /// block through the normal cleanup handling code (if any) and then
858 /// on to \arg Dest.
859 void EmitBranchThroughCleanup(JumpDest Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +0000860
Justin Bognere25ffdf2014-01-21 00:35:11 +0000861 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
862 /// specified destination obviously has no cleanups to run. 'false' is always
863 /// a conservatively correct answer for this method.
864 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
865
John McCall8e4c74b2011-08-11 02:22:43 +0000866 /// popCatchScope - Pops the catch scope at the top of the EHScope
867 /// stack, emitting any required code (other than the catch handlers
868 /// themselves).
869 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000870
David Chisnall9a837be2012-11-07 16:50:40 +0000871 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000872 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000873 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000874
John McCallce1de612011-01-26 04:00:11 +0000875 /// An object to manage conditionally-evaluated expressions.
876 class ConditionalEvaluation {
877 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000878
John McCallce1de612011-01-26 04:00:11 +0000879 public:
880 ConditionalEvaluation(CodeGenFunction &CGF)
881 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000882
John McCallce1de612011-01-26 04:00:11 +0000883 void begin(CodeGenFunction &CGF) {
884 assert(CGF.OutermostConditional != this);
885 if (!CGF.OutermostConditional)
886 CGF.OutermostConditional = this;
887 }
888
889 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000890 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000891 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000892 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000893 }
894
895 /// Returns a block which will be executed prior to each
896 /// evaluation of the conditional code.
897 llvm::BasicBlock *getStartingBlock() const {
898 return StartBB;
899 }
900 };
Mike Stump11289f42009-09-09 15:08:12 +0000901
John McCall7f9c92a2010-09-17 00:50:28 +0000902 /// isInConditionalBranch - Return true if we're currently emitting
903 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000904 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000905
John McCall7f416cc2015-09-08 08:05:57 +0000906 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000907 assert(isInConditionalBranch());
908 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000909 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
910 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000911 }
912
John McCallce1de612011-01-26 04:00:11 +0000913 /// An RAII object to record that we're evaluating a statement
914 /// expression.
915 class StmtExprEvaluation {
916 CodeGenFunction &CGF;
917
918 /// We have to save the outermost conditional: cleanups in a
919 /// statement expression aren't conditional just because the
920 /// StmtExpr is.
921 ConditionalEvaluation *SavedOutermostConditional;
922
923 public:
924 StmtExprEvaluation(CodeGenFunction &CGF)
925 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000926 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000927 }
928
929 ~StmtExprEvaluation() {
930 CGF.OutermostConditional = SavedOutermostConditional;
931 CGF.EnsureInsertPoint();
932 }
933 };
John McCall1bf58462011-02-16 08:02:54 +0000934
John McCallc07a0c72011-02-17 10:25:35 +0000935 /// An object which temporarily prevents a value from being
936 /// destroyed by aggressive peephole optimizations that assume that
937 /// all uses of a value have been realized in the IR.
938 class PeepholeProtection {
939 llvm::Instruction *Inst;
940 friend class CodeGenFunction;
941
942 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000943 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000944 };
John McCallc07a0c72011-02-17 10:25:35 +0000945
John McCallfe96e0b2011-11-06 09:01:30 +0000946 /// A non-RAII class containing all the information about a bound
947 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
948 /// this which makes individual mappings very simple; using this
949 /// class directly is useful when you have a variable number of
950 /// opaque values or don't want the RAII functionality for some
951 /// reason.
952 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000953 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000954 bool BoundLValue;
955 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000956
John McCallfe96e0b2011-11-06 09:01:30 +0000957 OpaqueValueMappingData(const OpaqueValueExpr *ov,
958 bool boundLValue)
959 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000960 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000961 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000962
John McCallc07a0c72011-02-17 10:25:35 +0000963 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000964 // gl-values should be bound as l-values for obvious reasons.
965 // Records should be bound as l-values because IR generation
966 // always keeps them in memory. Expressions of function type
967 // act exactly like l-values but are formally required to be
968 // r-values in C.
969 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000970 expr->getType()->isFunctionType() ||
971 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000972 }
973
John McCallfe96e0b2011-11-06 09:01:30 +0000974 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
975 const OpaqueValueExpr *ov,
976 const Expr *e) {
977 if (shouldBindAsLValue(ov))
978 return bind(CGF, ov, CGF.EmitLValue(e));
979 return bind(CGF, ov, CGF.EmitAnyExpr(e));
980 }
981
982 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
983 const OpaqueValueExpr *ov,
984 const LValue &lv) {
985 assert(shouldBindAsLValue(ov));
986 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
987 return OpaqueValueMappingData(ov, true);
988 }
989
990 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
991 const OpaqueValueExpr *ov,
992 const RValue &rv) {
993 assert(!shouldBindAsLValue(ov));
994 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
995
996 OpaqueValueMappingData data(ov, false);
997
998 // Work around an extremely aggressive peephole optimization in
999 // EmitScalarConversion which assumes that all other uses of a
1000 // value are extant.
1001 data.Protection = CGF.protectFromPeepholes(rv);
1002
1003 return data;
1004 }
1005
Craig Topper8a13c412014-05-21 05:09:00 +00001006 bool isValid() const { return OpaqueValue != nullptr; }
1007 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +00001008
1009 void unbind(CodeGenFunction &CGF) {
1010 assert(OpaqueValue && "no data to unbind!");
1011
1012 if (BoundLValue) {
1013 CGF.OpaqueLValues.erase(OpaqueValue);
1014 } else {
1015 CGF.OpaqueRValues.erase(OpaqueValue);
1016 CGF.unprotectFromPeepholes(Protection);
1017 }
1018 }
1019 };
1020
1021 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1022 class OpaqueValueMapping {
1023 CodeGenFunction &CGF;
1024 OpaqueValueMappingData Data;
1025
1026 public:
1027 static bool shouldBindAsLValue(const Expr *expr) {
1028 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1029 }
1030
John McCallc07a0c72011-02-17 10:25:35 +00001031 /// Build the opaque value mapping for the given conditional
1032 /// operator if it's the GNU ?: extension. This is a common
1033 /// enough pattern that the convenience operator is really
1034 /// helpful.
1035 ///
1036 OpaqueValueMapping(CodeGenFunction &CGF,
1037 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +00001038 if (isa<ConditionalOperator>(op))
1039 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001040 return;
John McCallc07a0c72011-02-17 10:25:35 +00001041
1042 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001043 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1044 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001045 }
1046
Richard Smith410306b2016-12-12 02:53:20 +00001047 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1048 /// expression is set to the expression the OVE represents.
1049 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1050 : CGF(CGF) {
1051 if (OV) {
1052 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1053 "for OVE with no source expression");
1054 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1055 }
1056 }
1057
John McCall1bf58462011-02-16 08:02:54 +00001058 OpaqueValueMapping(CodeGenFunction &CGF,
1059 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001060 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001061 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001062 }
1063
1064 OpaqueValueMapping(CodeGenFunction &CGF,
1065 const OpaqueValueExpr *opaqueValue,
1066 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001067 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001068 }
1069
1070 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001071 Data.unbind(CGF);
1072 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001073 }
1074
1075 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001076 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001077 }
1078 };
Gor Nishanov04491bd2017-11-11 17:00:43 +00001079
Chris Lattner2da04b32007-08-24 05:35:26 +00001080private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001081 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001082 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001083
John McCall9b382dd2011-05-28 21:13:02 +00001084 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1085 /// calling llvm.stacksave for multiple VLAs in the same scope.
1086 bool DidCallStackSave;
1087
Mike Stumpe5311b02009-11-30 20:08:49 +00001088 /// IndirectBranch - The first time an indirect goto is seen we create a block
1089 /// with an indirect branch. Every time we see the address of a label taken,
1090 /// we add the label to the indirect goto. Every subsequent indirect goto is
1091 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +00001092 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001093
Mike Stumpfc496822009-02-08 23:14:22 +00001094 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1095 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001096 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001097
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001098 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1099 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1100 /// parameter.
1101 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1102 SizeArguments;
1103
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001104 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001105 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001106 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1107
Chris Lattnerac248202007-05-30 00:13:02 +00001108 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001109 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001110
Mike Stumpfc496822009-02-08 23:14:22 +00001111 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001112 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001113 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001114 BreakContinue(JumpDest Break, JumpDest Continue)
1115 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001116
John McCallbd309292010-07-06 01:34:17 +00001117 JumpDest BreakBlock;
1118 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001119 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001120 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001121
Alexey Bataev957d8562016-11-17 15:12:05 +00001122 /// Handles cancellation exit points in OpenMP-related constructs.
1123 class OpenMPCancelExitStack {
1124 /// Tracks cancellation exit point and join point for cancel-related exit
1125 /// and normal exit.
1126 struct CancelExit {
1127 CancelExit() = default;
1128 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1129 JumpDest ContBlock)
1130 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1131 OpenMPDirectiveKind Kind = OMPD_unknown;
1132 /// true if the exit block has been emitted already by the special
1133 /// emitExit() call, false if the default codegen is used.
1134 bool HasBeenEmitted = false;
1135 JumpDest ExitBlock;
1136 JumpDest ContBlock;
1137 };
1138
1139 SmallVector<CancelExit, 8> Stack;
1140
1141 public:
1142 OpenMPCancelExitStack() : Stack(1) {}
1143 ~OpenMPCancelExitStack() = default;
1144 /// Fetches the exit block for the current OpenMP construct.
1145 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1146 /// Emits exit block with special codegen procedure specific for the related
1147 /// OpenMP construct + emits code for normal construct cleanup.
1148 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1149 const llvm::function_ref<void(CodeGenFunction &)> &CodeGen) {
1150 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1151 assert(CGF.getOMPCancelDestination(Kind).isValid());
1152 assert(CGF.HaveInsertPoint());
1153 assert(!Stack.back().HasBeenEmitted);
1154 auto IP = CGF.Builder.saveAndClearIP();
1155 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1156 CodeGen(CGF);
Erich Keane0026ed22017-07-27 16:28:20 +00001157 CGF.EmitBranch(Stack.back().ContBlock.getBlock());
Alexey Bataev957d8562016-11-17 15:12:05 +00001158 CGF.Builder.restoreIP(IP);
1159 Stack.back().HasBeenEmitted = true;
1160 }
1161 CodeGen(CGF);
1162 }
1163 /// Enter the cancel supporting \a Kind construct.
1164 /// \param Kind OpenMP directive that supports cancel constructs.
1165 /// \param HasCancel true, if the construct has inner cancel directive,
1166 /// false otherwise.
1167 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1168 Stack.push_back({Kind,
1169 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1170 : JumpDest(),
1171 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1172 : JumpDest()});
1173 }
1174 /// Emits default exit point for the cancel construct (if the special one
1175 /// has not be used) + join point for cancel/normal exits.
1176 void exit(CodeGenFunction &CGF) {
1177 if (getExitBlock().isValid()) {
1178 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1179 bool HaveIP = CGF.HaveInsertPoint();
1180 if (!Stack.back().HasBeenEmitted) {
1181 if (HaveIP)
1182 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1183 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1184 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1185 }
1186 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1187 if (!HaveIP) {
1188 CGF.Builder.CreateUnreachable();
1189 CGF.Builder.ClearInsertionPoint();
1190 }
1191 }
1192 Stack.pop_back();
1193 }
1194 };
1195 OpenMPCancelExitStack OMPCancelStack;
1196
Justin Bogneref512b92014-01-06 22:27:43 +00001197 CodeGenPGO PGO;
1198
Justin Bogner65512642015-05-02 05:00:55 +00001199 /// Calculate branch weights appropriate for PGO data
1200 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1201 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1202 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1203 uint64_t LoopCount);
1204
Justin Bogneref512b92014-01-06 22:27:43 +00001205public:
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001206 /// Increment the profiler's counter for the given statement by \p StepV.
1207 /// If \p StepV is null, the default increment is 1.
1208 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
Rong Xu9837ef52016-02-04 18:39:09 +00001209 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001210 PGO.emitCounterIncrement(Builder, S, StepV);
Justin Bogner66242d62015-04-23 23:06:47 +00001211 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001212 }
Justin Bogner66242d62015-04-23 23:06:47 +00001213
1214 /// Get the profiler's count for the given statement.
1215 uint64_t getProfileCount(const Stmt *S) {
1216 Optional<uint64_t> Count = PGO.getStmtCount(S);
1217 if (!Count.hasValue())
1218 return 0;
1219 return *Count;
1220 }
1221
1222 /// Set the profiler's current count.
1223 void setCurrentProfileCount(uint64_t Count) {
1224 PGO.setCurrentRegionCount(Count);
1225 }
1226
1227 /// Get the profiler's current count. This is generally the count for the most
1228 /// recently incremented counter.
1229 uint64_t getCurrentProfileCount() {
1230 return PGO.getCurrentRegionCount();
1231 }
1232
Justin Bogneref512b92014-01-06 22:27:43 +00001233private:
1234
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001235 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001236 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001237 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001238 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1239 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001240
Mike Stumpfc496822009-02-08 23:14:22 +00001241 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001242 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001243 llvm::BasicBlock *CaseRangeBlock;
1244
John McCallc07a0c72011-02-17 10:25:35 +00001245 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001246 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001247 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1248 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001249
Mike Stumpfc496822009-02-08 23:14:22 +00001250 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001251 // We track this by the size expression rather than the type itself because
1252 // in certain situations, like a const qualifier applied to an VLA typedef,
1253 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001254 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1255 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001256 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001257
John McCallbd309292010-07-06 01:34:17 +00001258 /// A block containing a single 'unreachable' instruction. Created
1259 /// lazily by getUnreachableBlock().
1260 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001261
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001262 /// Counts of the number return expressions in the function.
1263 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001264
1265 /// Count the number of simple (constant) return expressions in the function.
1266 unsigned NumSimpleReturnExprs;
1267
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001268 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001269 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001270
Richard Smith852c9db2013-04-20 22:23:05 +00001271public:
1272 /// A scope within which we are constructing the fields of an object which
1273 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1274 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1275 class FieldConstructionScope {
1276 public:
John McCall7f416cc2015-09-08 08:05:57 +00001277 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001278 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1279 CGF.CXXDefaultInitExprThis = This;
1280 }
1281 ~FieldConstructionScope() {
1282 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1283 }
1284
1285 private:
1286 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001287 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001288 };
1289
1290 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1291 /// is overridden to be the object under construction.
1292 class CXXDefaultInitExprScope {
1293 public:
1294 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001295 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1296 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1297 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1298 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001299 }
1300 ~CXXDefaultInitExprScope() {
1301 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001302 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001303 }
1304
1305 public:
1306 CodeGenFunction &CGF;
1307 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001308 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001309 };
1310
Richard Smith410306b2016-12-12 02:53:20 +00001311 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1312 /// current loop index is overridden.
1313 class ArrayInitLoopExprScope {
1314 public:
1315 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1316 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1317 CGF.ArrayInitIndex = Index;
1318 }
1319 ~ArrayInitLoopExprScope() {
1320 CGF.ArrayInitIndex = OldArrayInitIndex;
1321 }
1322
1323 private:
1324 CodeGenFunction &CGF;
1325 llvm::Value *OldArrayInitIndex;
1326 };
1327
Richard Smith5179eb72016-06-28 19:03:57 +00001328 class InlinedInheritingConstructorScope {
1329 public:
1330 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1331 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1332 OldCurCodeDecl(CGF.CurCodeDecl),
1333 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1334 OldCXXABIThisValue(CGF.CXXABIThisValue),
1335 OldCXXThisValue(CGF.CXXThisValue),
1336 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1337 OldCXXThisAlignment(CGF.CXXThisAlignment),
1338 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1339 OldCXXInheritedCtorInitExprArgs(
1340 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1341 CGF.CurGD = GD;
1342 CGF.CurFuncDecl = CGF.CurCodeDecl =
1343 cast<CXXConstructorDecl>(GD.getDecl());
1344 CGF.CXXABIThisDecl = nullptr;
1345 CGF.CXXABIThisValue = nullptr;
1346 CGF.CXXThisValue = nullptr;
1347 CGF.CXXABIThisAlignment = CharUnits();
1348 CGF.CXXThisAlignment = CharUnits();
1349 CGF.ReturnValue = Address::invalid();
1350 CGF.FnRetTy = QualType();
1351 CGF.CXXInheritedCtorInitExprArgs.clear();
1352 }
1353 ~InlinedInheritingConstructorScope() {
1354 CGF.CurGD = OldCurGD;
1355 CGF.CurFuncDecl = OldCurFuncDecl;
1356 CGF.CurCodeDecl = OldCurCodeDecl;
1357 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1358 CGF.CXXABIThisValue = OldCXXABIThisValue;
1359 CGF.CXXThisValue = OldCXXThisValue;
1360 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1361 CGF.CXXThisAlignment = OldCXXThisAlignment;
1362 CGF.ReturnValue = OldReturnValue;
1363 CGF.FnRetTy = OldFnRetTy;
1364 CGF.CXXInheritedCtorInitExprArgs =
1365 std::move(OldCXXInheritedCtorInitExprArgs);
1366 }
1367
1368 private:
1369 CodeGenFunction &CGF;
1370 GlobalDecl OldCurGD;
1371 const Decl *OldCurFuncDecl;
1372 const Decl *OldCurCodeDecl;
1373 ImplicitParamDecl *OldCXXABIThisDecl;
1374 llvm::Value *OldCXXABIThisValue;
1375 llvm::Value *OldCXXThisValue;
1376 CharUnits OldCXXABIThisAlignment;
1377 CharUnits OldCXXThisAlignment;
1378 Address OldReturnValue;
1379 QualType OldFnRetTy;
1380 CallArgList OldCXXInheritedCtorInitExprArgs;
1381 };
1382
Richard Smith852c9db2013-04-20 22:23:05 +00001383private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001384 /// CXXThisDecl - When generating code for a C++ member function,
1385 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001386 ImplicitParamDecl *CXXABIThisDecl;
1387 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001388 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001389 CharUnits CXXABIThisAlignment;
1390 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001391
Richard Smith852c9db2013-04-20 22:23:05 +00001392 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1393 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001394 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001395
Richard Smith410306b2016-12-12 02:53:20 +00001396 /// The current array initialization index when evaluating an
1397 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1398 llvm::Value *ArrayInitIndex = nullptr;
1399
Richard Smith5179eb72016-06-28 19:03:57 +00001400 /// The values of function arguments to use when evaluating
1401 /// CXXInheritedCtorInitExprs within this context.
1402 CallArgList CXXInheritedCtorInitExprArgs;
1403
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001404 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1405 /// destructor, this will hold the implicit argument (e.g. VTT).
1406 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1407 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001408
John McCallce1de612011-01-26 04:00:11 +00001409 /// OutermostConditional - Points to the outermost active
1410 /// conditional control. This is used so that we know if a
1411 /// temporary should be destroyed conditionally.
1412 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001413
Nadav Rotem1da30942013-03-23 06:43:35 +00001414 /// The current lexical scope.
1415 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001416
Adrian Prantldc237b52013-05-16 00:41:26 +00001417 /// The current source location that should be used for exception
1418 /// handling code.
1419 SourceLocation CurEHLocation;
1420
John McCall7f416cc2015-09-08 08:05:57 +00001421 /// BlockByrefInfos - For each __block variable, contains
1422 /// information about the layout of the variable.
1423 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001424
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001425 /// Used by -fsanitize=nullability-return to determine whether the return
1426 /// value can be checked.
1427 llvm::Value *RetValNullabilityPrecondition = nullptr;
1428
1429 /// Check if -fsanitize=nullability-return instrumentation is required for
1430 /// this function.
1431 bool requiresReturnValueNullabilityCheck() const {
1432 return RetValNullabilityPrecondition;
1433 }
1434
Vedant Kumarc34d3432017-06-23 21:32:38 +00001435 /// Used to store precise source locations for return statements by the
1436 /// runtime return value checks.
1437 Address ReturnLocation = Address::invalid();
1438
1439 /// Check if the return value of this function requires sanitization.
1440 bool requiresReturnValueCheck() const {
1441 return requiresReturnValueNullabilityCheck() ||
1442 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
1443 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
1444 }
1445
John McCallbd309292010-07-06 01:34:17 +00001446 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001447 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001448 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001449
Reid Kleckner06f19a02018-01-02 21:34:16 +00001450 /// Terminate funclets keyed by parent funclet pad.
1451 llvm::MapVector<llvm::Value *, llvm::BasicBlock *> TerminateFunclets;
1452
Vitaly Buka1c943322016-10-26 01:59:57 +00001453 /// True if we need emit the life-time markers.
1454 const bool ShouldEmitLifetimeMarkers;
1455
Xiuli Panbe6da4b2017-05-04 07:31:20 +00001456 /// Add OpenCL kernel arg metadata and the kernel attribute meatadata to
1457 /// the function metadata.
Gor Nishanov04491bd2017-11-11 17:00:43 +00001458 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001459 llvm::Function *Fn);
1460
Chris Lattnerbed31442007-05-28 01:07:47 +00001461public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001462 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001463 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001464
John McCall8ed55a52010-09-02 09:58:18 +00001465 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001466 ASTContext &getContext() const { return CGM.getContext(); }
Gor Nishanov04491bd2017-11-11 17:00:43 +00001467 CGDebugInfo *getDebugInfo() {
1468 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001469 return nullptr;
Gor Nishanov04491bd2017-11-11 17:00:43 +00001470 return DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001471 }
1472 void disableDebugInfo() { DisableDebugInfo = true; }
1473 void enableDebugInfo() { DisableDebugInfo = false; }
1474
John McCall31168b02011-06-15 23:02:42 +00001475 bool shouldUseFusedARCCalls() {
1476 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1477 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001478
David Blaikiebbafb8a2012-03-11 07:00:24 +00001479 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001480
Bill Wendlingf0724e82011-09-19 20:31:14 +00001481 /// Returns a pointer to the function's exception object and selector slot,
1482 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001483 Address getExceptionSlot();
1484 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001485
Bill Wendling79a70e42011-09-15 18:57:19 +00001486 /// Returns the contents of the function's exception object and selector
1487 /// slots.
1488 llvm::Value *getExceptionFromSlot();
1489 llvm::Value *getSelectorFromSlot();
1490
John McCall7f416cc2015-09-08 08:05:57 +00001491 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001492
John McCallbd309292010-07-06 01:34:17 +00001493 llvm::BasicBlock *getUnreachableBlock() {
1494 if (!UnreachableBlock) {
1495 UnreachableBlock = createBasicBlock("unreachable");
1496 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1497 }
1498 return UnreachableBlock;
1499 }
1500
1501 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001502 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001503 return getInvokeDestImpl();
1504 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001505
David Majnemer25eb1652016-03-01 19:42:53 +00001506 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001507
John McCallc8e01702013-04-16 22:48:15 +00001508 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001509 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Yaxun Liucbf647c2017-07-08 13:24:52 +00001510 const TargetCodeGenInfo &getTargetHooks() const {
1511 return CGM.getTargetCodeGenInfo();
1512 }
Owen Andersonae86c192009-07-13 04:10:07 +00001513
Daniel Dunbar12347492009-02-23 17:26:39 +00001514 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001515 // Cleanups
1516 //===--------------------------------------------------------------------===//
1517
John McCall7f416cc2015-09-08 08:05:57 +00001518 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001519
John McCall178360e2011-07-11 08:38:19 +00001520 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001521 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001522 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001523 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001524 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001525 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1526 llvm::Value *arrayEnd,
1527 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001528 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001529 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001530
John McCall4bd0fb12011-07-12 16:41:08 +00001531 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001532 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001533 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001534 Address addr, QualType type);
1535 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001536 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001537 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001538 QualType type, Destroyer *destroyer,
1539 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001540 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1541 llvm::Value *CompletePtr,
1542 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001543 void pushStackRestore(CleanupKind kind, Address SPMem);
1544 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001545 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001546 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001547 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001548 bool useEHCleanupForArray,
1549 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001550 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001551 QualType elementType, CharUnits elementAlign,
1552 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001553 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001554
Peter Collingbourne1425b452012-01-26 03:33:36 +00001555 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001556
John McCall82fe67b2011-07-09 01:37:26 +00001557 /// Determines whether an EH cleanup is required to destroy a type
1558 /// with the given destruction kind.
1559 bool needsEHCleanup(QualType::DestructionKind kind) {
1560 switch (kind) {
1561 case QualType::DK_none:
1562 return false;
1563 case QualType::DK_cxx_destructor:
1564 case QualType::DK_objc_weak_lifetime:
Akira Hatanaka7275da02018-02-28 07:15:55 +00001565 case QualType::DK_nontrivial_c_struct:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001566 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001567 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001568 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001569 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1570 }
1571 llvm_unreachable("bad destruction kind");
1572 }
1573
John McCall4bd0fb12011-07-12 16:41:08 +00001574 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1575 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1576 }
1577
John McCall82fe67b2011-07-09 01:37:26 +00001578 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001579 // Objective-C
1580 //===--------------------------------------------------------------------===//
1581
Chris Lattner4bd55962008-03-30 23:03:07 +00001582 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001583
David Blaikief1425802015-01-14 00:04:42 +00001584 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001585
Mike Stumpfc496822009-02-08 23:14:22 +00001586 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001587 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1588 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001589 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001590 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001591 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001592 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001593
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001594 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1595 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001596
Mike Stumpfc496822009-02-08 23:14:22 +00001597 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1598 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001599 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1600 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001601 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001602 const ObjCPropertyImplDecl *propImpl,
1603 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001604
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001605 //===--------------------------------------------------------------------===//
1606 // Block Bits
1607 //===--------------------------------------------------------------------===//
1608
Yaxun Liuc2a87a02017-10-14 12:23:50 +00001609 /// Emit block literal.
1610 /// \return an LLVM value which is a pointer to a struct which contains
1611 /// information about the block, including the block invoke function, the
1612 /// captured variables, etc.
Yaxun Liufa13d012018-02-15 16:39:19 +00001613 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001614 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001615
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001616 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001617 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001618 const DeclMapTy &ldm,
Akira Hatanakaba0367a2017-09-22 21:32:06 +00001619 bool IsLambdaConversionToBlock,
1620 bool BuildGlobalBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001621
John McCallad7c5c12011-02-08 08:22:06 +00001622 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1623 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001624 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1625 const ObjCPropertyImplDecl *PID);
1626 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1627 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001628 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001629
John McCallad7c5c12011-02-08 08:22:06 +00001630 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1631
John McCall73064872011-03-31 01:59:53 +00001632 class AutoVarEmission;
1633
1634 void emitByrefStructureInit(const AutoVarEmission &emission);
1635 void enterByrefCleanup(const AutoVarEmission &emission);
1636
John McCall7f416cc2015-09-08 08:05:57 +00001637 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1638 llvm::Value *ptr);
1639
1640 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001641 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1642
1643 /// BuildBlockByrefAddress - Computes the location of the
1644 /// data in a variable which is declared as __block.
1645 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1646 bool followForward = true);
1647 Address emitBlockByrefAddress(Address baseAddr,
1648 const BlockByrefInfo &info,
1649 bool followForward,
1650 const llvm::Twine &name);
1651
1652 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001653
Richard Smith5179eb72016-06-28 19:03:57 +00001654 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1655
John McCalla738c252011-03-09 04:27:21 +00001656 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1657 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001658 /// \brief Emit code for the start of a function.
1659 /// \param Loc The location to be associated with the function.
1660 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001661 void StartFunction(GlobalDecl GD,
1662 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001663 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001664 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001665 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001666 SourceLocation Loc = SourceLocation(),
1667 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001668
Vedant Kumar7f809b22017-02-24 01:15:19 +00001669 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1670
John McCallb81884d2010-02-19 09:25:03 +00001671 void EmitConstructorBody(FunctionArgList &Args);
1672 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001673 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001674 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001675 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001676
Faisal Vali571df122013-09-29 08:45:24 +00001677 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001678 CallArgList &CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00001679 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001680 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001681 void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001682 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001683
David Blaikiea0a1a872015-01-18 02:48:07 +00001684 /// \brief Emit the unified return block, trying to avoid its emission when
1685 /// possible.
1686 /// \return The debug location of the user written return statement if the
1687 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001688 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001689
Mike Stumpfc496822009-02-08 23:14:22 +00001690 /// FinishFunction - Complete IR generation of the current function. It is
1691 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001692 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001693
Nico Weber1bebad12015-02-11 22:33:32 +00001694 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
Reid Kleckner399d96e2018-04-02 20:20:33 +00001695 const CGFunctionInfo &FnInfo, bool IsUnprototyped);
Hans Wennborg88497d62013-11-15 17:24:45 +00001696
Reid Kleckner399d96e2018-04-02 20:20:33 +00001697 void EmitCallAndReturnForThunk(llvm::Constant *Callee, const ThunkInfo *Thunk,
1698 bool IsUnprototyped);
Hans Wennborg88497d62013-11-15 17:24:45 +00001699
John McCall7f416cc2015-09-08 08:05:57 +00001700 void FinishThunk();
1701
Reid Klecknerab2090d2014-07-26 01:34:32 +00001702 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1703 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1704 llvm::Value *Callee);
1705
Rafael Espindolad6e66942015-07-13 06:07:58 +00001706 /// Generate a thunk for the given method.
1707 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
Reid Kleckner399d96e2018-04-02 20:20:33 +00001708 GlobalDecl GD, const ThunkInfo &Thunk,
1709 bool IsUnprototyped);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001710
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001711 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1712 const CGFunctionInfo &FnInfo,
1713 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001714
Douglas Gregor94f9a482010-05-05 05:51:00 +00001715 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1716 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001717
Richard Smith30e304e2016-12-14 00:03:17 +00001718 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001719
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001720 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1721 struct VPtr {
1722 BaseSubobject Base;
1723 const CXXRecordDecl *NearestVBase;
1724 CharUnits OffsetFromNearestVBase;
1725 const CXXRecordDecl *VTableClass;
1726 };
1727
1728 /// Initialize the vtable pointer of the given subobject.
1729 void InitializeVTablePointer(const VPtr &vptr);
1730
1731 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001732
1733 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001734 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1735
1736 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1737 CharUnits OffsetFromNearestVBase,
1738 bool BaseIsNonVirtualPrimaryBase,
1739 const CXXRecordDecl *VTableClass,
1740 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001741
Anders Carlssond5895932010-03-28 21:07:49 +00001742 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001743
Dan Gohman8fc50c22010-10-26 18:44:08 +00001744 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1745 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001746 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1747 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001748
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001749 enum CFITypeCheckKind {
1750 CFITCK_VCall,
1751 CFITCK_NVCall,
1752 CFITCK_DerivedCast,
1753 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001754 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001755 };
1756
Peter Collingbourned2926c92015-03-14 02:42:25 +00001757 /// \brief Derived is the presumed address of an object of type T after a
1758 /// cast. If T is a polymorphic class type, emit a check that the virtual
1759 /// table for Derived belongs to a class derived from T.
1760 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001761 bool MayBeNull, CFITypeCheckKind TCK,
1762 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001763
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001764 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1765 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001766 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001767 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001768
Peter Collingbourned2926c92015-03-14 02:42:25 +00001769 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001770 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001771 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1772 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001773
Peter Collingbournefb532b92016-02-24 20:46:36 +00001774 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001775 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1776 /// enabled, emit a check that VTable is a member of RD's type identifier.
1777 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1778 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001779
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001780 /// Returns whether we should perform a type checked load when loading a
1781 /// virtual function for virtual calls to members of RD. This is generally
1782 /// true when both vcall CFI and whole-program-vtables are enabled.
1783 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1784
1785 /// Emit a type checked load from the given vtable.
1786 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1787 uint64_t VTableByteOffset);
1788
John McCallf99a6312010-07-21 05:30:47 +00001789 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1790 /// given phase of destruction for a destructor. The end result
1791 /// should call destructors on members and base classes in reverse
1792 /// order of their construction.
1793 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001794
Chris Lattner3c77a352010-06-22 00:03:40 +00001795 /// ShouldInstrumentFunction - Return true if the current function should be
1796 /// instrumented with __cyg_profile_func_* calls
1797 bool ShouldInstrumentFunction();
1798
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001799 /// ShouldXRayInstrument - Return true if the current function should be
1800 /// instrumented with XRay nop sleds.
1801 bool ShouldXRayInstrumentFunction() const;
1802
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +00001803 /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
1804 /// XRay custom event handling calls.
1805 bool AlwaysEmitXRayCustomEvents() const;
1806
Vedant Kumarbb5d4852017-09-13 00:04:35 +00001807 /// Encode an address into a form suitable for use in a function prologue.
1808 llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
1809 llvm::Constant *Addr);
1810
1811 /// Decode an address used in a function prologue, encoded by \c
1812 /// EncodeAddrForUseInPrologue.
1813 llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
1814 llvm::Value *EncodedAddr);
1815
Mike Stumpfc496822009-02-08 23:14:22 +00001816 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1817 /// arguments for the given function. This is also responsible for naming the
1818 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001819 void EmitFunctionProlog(const CGFunctionInfo &FI,
1820 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001821 const FunctionArgList &Args);
1822
Mike Stumpfc496822009-02-08 23:14:22 +00001823 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1824 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001825 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1826 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001827
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001828 /// Emit a test that checks if the return value \p RV is nonnull.
Vedant Kumarc34d3432017-06-23 21:32:38 +00001829 void EmitReturnValueCheck(llvm::Value *RV);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001830
Mike Stump1d849212009-12-07 23:38:24 +00001831 /// EmitStartEHSpec - Emit the start of the exception spec.
1832 void EmitStartEHSpec(const Decl *D);
1833
1834 /// EmitEndEHSpec - Emit the end of the exception spec.
1835 void EmitEndEHSpec(const Decl *D);
1836
John McCallbd309292010-07-06 01:34:17 +00001837 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1838 llvm::BasicBlock *getTerminateLandingPad();
1839
Reid Kleckner06f19a02018-01-02 21:34:16 +00001840 /// getTerminateLandingPad - Return a cleanup funclet that just calls
1841 /// terminate.
1842 llvm::BasicBlock *getTerminateFunclet();
1843
John McCallbd309292010-07-06 01:34:17 +00001844 /// getTerminateHandler - Return a handler (not a landing pad, just
1845 /// a catch handler) that just calls terminate. This is used when
1846 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001847 llvm::BasicBlock *getTerminateHandler();
1848
Chris Lattnera5f58b02011-07-09 17:41:47 +00001849 llvm::Type *ConvertTypeForMem(QualType T);
1850 llvm::Type *ConvertType(QualType T);
1851 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001852 return ConvertType(getContext().getTypeDeclType(T));
1853 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001854
Mike Stumpfc496822009-02-08 23:14:22 +00001855 /// LoadObjCSelf - Load the value of self. This function is only valid while
1856 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001857 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001858
1859 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001860 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001861
Krasimir Georgiev46dfb7a2017-09-08 13:44:51 +00001862 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
John McCall47fb9502013-03-07 21:37:08 +00001863 static TypeEvaluationKind getEvaluationKind(QualType T);
1864
1865 static bool hasScalarEvaluationKind(QualType T) {
1866 return getEvaluationKind(T) == TEK_Scalar;
1867 }
1868
1869 static bool hasAggregateEvaluationKind(QualType T) {
1870 return getEvaluationKind(T) == TEK_Aggregate;
1871 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001872
1873 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001874 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001875 llvm::Function *parent = nullptr,
1876 llvm::BasicBlock *before = nullptr) {
John McCallad7c5c12011-02-08 08:22:06 +00001877 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001878 }
Mike Stumpfc496822009-02-08 23:14:22 +00001879
Chris Lattnerac248202007-05-30 00:13:02 +00001880 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1881 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001882 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001883
Mike Stumpe5311b02009-11-30 20:08:49 +00001884 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1885 /// another basic block, simplify it. This assumes that no other code could
1886 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001887 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1888
Mike Stumpfc496822009-02-08 23:14:22 +00001889 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1890 /// adding a fall-through branch from the current insert block if
1891 /// necessary. It is legal to call this function even if there is no current
1892 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001893 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001894 /// IsFinished - If true, indicates that the caller has finished emitting
1895 /// branches to the given block and does not expect to emit code into it. This
1896 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001897 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001898
John McCall8e4c74b2011-08-11 02:22:43 +00001899 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1900 /// near its uses, and leave the insertion point in it.
1901 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1902
Mike Stumpfc496822009-02-08 23:14:22 +00001903 /// EmitBranch - Emit a branch to the specified basic block from the current
1904 /// insert block, taking care to avoid creation of branches from dummy
1905 /// blocks. It is legal to call this function even if there is no current
1906 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001907 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001908 /// This function clears the current insertion point. The caller should follow
1909 /// calls to this function with calls to Emit*Block prior to generation new
1910 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001911 void EmitBranch(llvm::BasicBlock *Block);
1912
Mike Stumpfc496822009-02-08 23:14:22 +00001913 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1914 /// indicates that the current code being emitted is unreachable.
1915 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001916 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001917 }
1918
Mike Stumpfc496822009-02-08 23:14:22 +00001919 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1920 /// emitted IR has a place to go. Note that by definition, if this function
1921 /// creates a block then that block is unreachable; callers may do better to
1922 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001923 void EnsureInsertPoint() {
1924 if (!HaveInsertPoint())
1925 EmitBlock(createBasicBlock());
1926 }
Mike Stumpfc496822009-02-08 23:14:22 +00001927
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001928 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001929 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001930 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001931
Chris Lattnere9a64532007-06-22 21:44:33 +00001932 //===--------------------------------------------------------------------===//
1933 // Helpers
1934 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001935
John McCall7f416cc2015-09-08 08:05:57 +00001936 LValue MakeAddrLValue(Address Addr, QualType T,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001937 AlignmentSource Source = AlignmentSource::Type) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00001938 return LValue::MakeAddr(Addr, T, getContext(), LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001939 CGM.getTBAAAccessInfo(T));
1940 }
1941
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001942 LValue MakeAddrLValue(Address Addr, QualType T, LValueBaseInfo BaseInfo,
1943 TBAAAccessInfo TBAAInfo) {
1944 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001945 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001946
John McCall7f416cc2015-09-08 08:05:57 +00001947 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001948 AlignmentSource Source = AlignmentSource::Type) {
1949 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00001950 LValueBaseInfo(Source), CGM.getTBAAAccessInfo(T));
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001951 }
1952
1953 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001954 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00001955 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001956 BaseInfo, TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +00001957 }
1958
1959 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001960 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001961 CharUnits getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001962 LValueBaseInfo *BaseInfo = nullptr,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +00001963 TBAAAccessInfo *TBAAInfo = nullptr,
John McCall7f416cc2015-09-08 08:05:57 +00001964 bool forPointeeType = false);
1965 CharUnits getNaturalPointeeTypeAlignment(QualType T,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00001966 LValueBaseInfo *BaseInfo = nullptr,
1967 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001968
Ivan A. Kosarev9f9d1572017-10-30 11:49:31 +00001969 Address EmitLoadOfReference(LValue RefLVal,
1970 LValueBaseInfo *PointeeBaseInfo = nullptr,
1971 TBAAAccessInfo *PointeeTBAAInfo = nullptr);
1972 LValue EmitLoadOfReferenceLValue(LValue RefLVal);
1973 LValue EmitLoadOfReferenceLValue(Address RefAddr, QualType RefTy,
1974 AlignmentSource Source =
1975 AlignmentSource::Type) {
1976 LValue RefLVal = MakeAddrLValue(RefAddr, RefTy, LValueBaseInfo(Source),
1977 CGM.getTBAAAccessInfo(RefTy));
1978 return EmitLoadOfReferenceLValue(RefLVal);
1979 }
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001980
Alexey Bataev31300ed2016-02-04 11:27:03 +00001981 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
Ivan A. Kosarev90295642017-10-13 16:47:22 +00001982 LValueBaseInfo *BaseInfo = nullptr,
1983 TBAAAccessInfo *TBAAInfo = nullptr);
Alexey Bataev31300ed2016-02-04 11:27:03 +00001984 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1985
Yaxun Liu84744c12017-06-19 17:03:41 +00001986 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
1987 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
1988 /// insertion point of the builder. The caller is responsible for setting an
1989 /// appropriate alignment on
Daniel Dunbara7566f12010-02-09 02:48:28 +00001990 /// the alloca.
Yaxun Liu84744c12017-06-19 17:03:41 +00001991 ///
1992 /// \p ArraySize is the number of array elements to be allocated if it
1993 /// is not nullptr.
1994 ///
1995 /// LangAS::Default is the address space of pointers to local variables and
1996 /// temporaries, as exposed in the source language. In certain
1997 /// configurations, this is not the same as the alloca address space, and a
1998 /// cast is needed to lift the pointer from the alloca AS into
1999 /// LangAS::Default. This can happen when the target uses a restricted
2000 /// address space for the stack but the source language requires
2001 /// LangAS::Default to be a generic address space. The latter condition is
2002 /// common for most programming languages; OpenCL is an exception in that
2003 /// LangAS::Default is the private address space, which naturally maps
2004 /// to the stack.
2005 ///
2006 /// Because the address of a temporary is often exposed to the program in
2007 /// various ways, this function will perform the cast by default. The cast
2008 /// may be avoided by passing false as \p CastToDefaultAddrSpace; this is
2009 /// more efficient if the caller knows that the address will not be exposed.
2010 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
2011 llvm::Value *ArraySize = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00002012 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
Yaxun Liu84744c12017-06-19 17:03:41 +00002013 const Twine &Name = "tmp",
2014 llvm::Value *ArraySize = nullptr,
2015 bool CastToDefaultAddrSpace = true);
Mike Stumpfc496822009-02-08 23:14:22 +00002016
John McCall7f416cc2015-09-08 08:05:57 +00002017 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
2018 /// default ABI alignment of the given LLVM type.
2019 ///
2020 /// IMPORTANT NOTE: This is *not* generally the right alignment for
2021 /// any given AST type that happens to have been lowered to the
2022 /// given IR type. This should only ever be used for function-local,
2023 /// IR-driven manipulations like saving and restoring a value. Do
2024 /// not hand this address off to arbitrary IRGen routines, and especially
2025 /// do not pass it as an argument to a function that might expect a
2026 /// properly ABI-aligned value.
2027 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
2028 const Twine &Name = "tmp");
2029
2030 /// InitTempAlloca - Provide an initial value for the given alloca which
2031 /// will be observable at all locations in the function.
2032 ///
2033 /// The address should be something that was returned from one of
2034 /// the CreateTempAlloca or CreateMemTemp routines, and the
2035 /// initializer must be valid in the entry block (i.e. it must
2036 /// either be a constant or an argument value).
2037 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00002038
Daniel Dunbard0049182010-02-16 19:44:13 +00002039 /// CreateIRTemp - Create a temporary IR object of the given type, with
2040 /// appropriate alignment. This routine should only be used when an temporary
2041 /// value needs to be stored into an alloca (for example, to avoid explicit
2042 /// PHI construction), but the type is the IR type, not the type appropriate
2043 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00002044 ///
2045 /// That is, this is exactly equivalent to CreateMemTemp, but calling
2046 /// ConvertType instead of ConvertTypeForMem.
2047 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00002048
Daniel Dunbara7566f12010-02-09 02:48:28 +00002049 /// CreateMemTemp - Create a temporary memory object of the given type, with
Yaxun Liu84744c12017-06-19 17:03:41 +00002050 /// appropriate alignment. Cast it to the default address space if
2051 /// \p CastToDefaultAddrSpace is true.
2052 Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
2053 bool CastToDefaultAddrSpace = true);
2054 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
2055 bool CastToDefaultAddrSpace = true);
Daniel Dunbara7566f12010-02-09 02:48:28 +00002056
John McCall7a626f62010-09-15 10:14:12 +00002057 /// CreateAggTemp - Create a temporary memory object for the given
2058 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00002059 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00002060 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00002061 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00002062 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00002063 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002064 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00002065 }
2066
John McCallad7c5c12011-02-08 08:22:06 +00002067 /// Emit a cast to void* in the appropriate address space.
2068 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2069
Chris Lattner8394d792007-06-05 20:53:16 +00002070 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2071 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00002072 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00002073
John McCalla2342eb2010-12-05 02:00:02 +00002074 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2075 void EmitIgnoredExpr(const Expr *E);
2076
Chris Lattner4647a212007-08-31 22:49:20 +00002077 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2078 /// any type. The result is returned as an RValue struct. If this is an
2079 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2080 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00002081 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00002082 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00002083 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00002084 AggValueSlot aggSlot = AggValueSlot::ignored(),
2085 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00002086
Mike Stumpfc496822009-02-08 23:14:22 +00002087 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2088 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00002089 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002090
Charles Davisc7d5c942015-09-17 20:55:33 +00002091 /// Emit a "reference" to a __builtin_ms_va_list; this is
2092 /// always the value of the expression, because a __builtin_ms_va_list is a
2093 /// pointer to a char.
2094 Address EmitMSVAListRef(const Expr *E);
2095
Gor Nishanov5eb58582017-03-26 02:18:05 +00002096 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
Mike Stumpfc496822009-02-08 23:14:22 +00002097 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00002098 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00002099
John McCall91ca10f2011-03-08 09:11:50 +00002100 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00002101 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00002102 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002103 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00002104
John McCall7f416cc2015-09-08 08:05:57 +00002105 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00002106
John McCall91ca10f2011-03-08 09:11:50 +00002107 /// EmitExprAsInit - Emits the code necessary to initialize a
2108 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00002109 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002110 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00002111
Fariborz Jahanian78652202013-01-25 23:57:05 +00002112 /// hasVolatileMember - returns true if aggregate type has a volatile
2113 /// member.
2114 bool hasVolatileMember(QualType T) {
2115 if (const RecordType *RT = T->getAs<RecordType>()) {
2116 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2117 return RD->hasVolatileMember();
2118 }
2119 return false;
2120 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002121 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002122 ///
2123 /// The difference to EmitAggregateCopy is that tail padding is not copied.
2124 /// This is required for correctness when assigning non-POD structures in C++.
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00002125 void EmitAggregateAssign(LValue Dest, LValue Src, QualType EltTy) {
Fariborz Jahanian78652202013-01-25 23:57:05 +00002126 bool IsVolatile = hasVolatileMember(EltTy);
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00002127 EmitAggregateCopy(Dest, Src, EltTy, IsVolatile, /* isAssignment= */ true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002128 }
2129
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00002130 void EmitAggregateCopyCtor(LValue Dest, LValue Src) {
2131 EmitAggregateCopy(Dest, Src, Src.getType(),
2132 /* IsVolatile= */ false, /* IsAssignment= */ false);
David Majnemerfd1e7392015-02-03 23:04:06 +00002133 }
2134
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002135 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00002136 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00002137 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00002138 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002139 /// \param isAssignment - If false, allow padding to be copied. This often
2140 /// yields more efficient.
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00002141 void EmitAggregateCopy(LValue Dest, LValue Src, QualType EltTy,
2142 bool isVolatile = false, bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00002143
Anders Carlsson9396a892008-09-11 09:15:33 +00002144 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00002145 Address GetAddrOfLocalVar(const VarDecl *VD) {
2146 auto it = LocalDeclMap.find(VD);
2147 assert(it != LocalDeclMap.end() &&
2148 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2149 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00002150 }
Mike Stumpfc496822009-02-08 23:14:22 +00002151
Akira Hatanaka797afe32018-03-20 01:47:58 +00002152 /// Given an opaque value expression, return its LValue mapping if it exists,
2153 /// otherwise create one.
2154 LValue getOrCreateOpaqueLValueMapping(const OpaqueValueExpr *e);
John McCallc07a0c72011-02-17 10:25:35 +00002155
Akira Hatanaka797afe32018-03-20 01:47:58 +00002156 /// Given an opaque value expression, return its RValue mapping if it exists,
2157 /// otherwise create one.
2158 RValue getOrCreateOpaqueRValueMapping(const OpaqueValueExpr *e);
John McCall1bf58462011-02-16 08:02:54 +00002159
Richard Smith410306b2016-12-12 02:53:20 +00002160 /// Get the index of the current ArrayInitLoopExpr, if any.
2161 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2162
Dan Gohman75d69da2008-05-22 00:50:06 +00002163 /// getAccessedFieldNo - Given an encoded value and a result number, return
2164 /// the input field number being accessed.
2165 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2166
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002167 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002168 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002169
Vedant Kumarffd7c882017-04-14 22:03:34 +00002170 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2171 static bool IsWrappedCXXThis(const Expr *E);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00002172
Anders Carlssonc0964b62010-05-22 17:35:42 +00002173 /// EmitNullInitialization - Generate code to set a value of the given type to
2174 /// null, If the type contains data member pointers, they will be initialized
2175 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002176 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002177
Charles Davisc7d5c942015-09-17 20:55:33 +00002178 /// Emits a call to an LLVM variable-argument intrinsic, either
2179 /// \c llvm.va_start or \c llvm.va_end.
2180 /// \param ArgValue A reference to the \c va_list as emitted by either
2181 /// \c EmitVAListRef or \c EmitMSVAListRef.
2182 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2183 /// calls \c llvm.va_end.
2184 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2185
2186 /// Generate code to get an argument from the passed in pointer
2187 /// and update it accordingly.
2188 /// \param VE The \c VAArgExpr for which to generate code.
2189 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2190 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2191 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002192 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002193 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002194 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002195
John McCall82fe67b2011-07-09 01:37:26 +00002196 /// emitArrayLength - Compute the length of an array, even if it's a
2197 /// VLA, and drill down to the base element type.
2198 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2199 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002200 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002201
John McCall23c29fe2011-06-24 21:55:10 +00002202 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2203 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002204 ///
2205 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002206 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002207
Sander de Smalen891af03a2018-02-03 13:55:59 +00002208 struct VlaSizePair {
2209 llvm::Value *NumElts;
2210 QualType Type;
2211
2212 VlaSizePair(llvm::Value *NE, QualType T) : NumElts(NE), Type(T) {}
2213 };
2214
2215 /// Return the number of elements for a single dimension
2216 /// for the given array type.
2217 VlaSizePair getVLAElements1D(const VariableArrayType *vla);
2218 VlaSizePair getVLAElements1D(QualType vla);
2219
2220 /// Returns an LLVM value that corresponds to the size,
John McCall23c29fe2011-06-24 21:55:10 +00002221 /// in non-variably-sized elements, of a variable length array type,
2222 /// plus that largest non-variably-sized element type. Assumes that
2223 /// the type has already been emitted with EmitVariablyModifiedType.
Sander de Smalen891af03a2018-02-03 13:55:59 +00002224 VlaSizePair getVLASize(const VariableArrayType *vla);
2225 VlaSizePair getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002226
Anders Carlssona5d077d2009-04-14 16:58:56 +00002227 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2228 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002229 llvm::Value *LoadCXXThis() {
2230 assert(CXXThisValue && "no 'this' value for this function");
2231 return CXXThisValue;
2232 }
John McCall7f416cc2015-09-08 08:05:57 +00002233 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002234
Anders Carlssone36a6b32010-01-02 01:01:18 +00002235 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2236 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002237 // FIXME: Every place that calls LoadCXXVTT is something
2238 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002239 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002240 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2241 return CXXStructorImplicitParamValue;
2242 }
2243
John McCall6ce74722010-02-16 04:15:37 +00002244 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002245 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002246 Address
2247 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002248 const CXXRecordDecl *Derived,
2249 const CXXRecordDecl *Base,
2250 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002251
John McCall7f416cc2015-09-08 08:05:57 +00002252 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2253
Mike Stumpe5311b02009-11-30 20:08:49 +00002254 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2255 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002256 Address GetAddressOfBaseClass(Address Value,
2257 const CXXRecordDecl *Derived,
2258 CastExpr::path_const_iterator PathBegin,
2259 CastExpr::path_const_iterator PathEnd,
2260 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002261
John McCall7f416cc2015-09-08 08:05:57 +00002262 Address GetAddressOfDerivedClass(Address Value,
2263 const CXXRecordDecl *Derived,
2264 CastExpr::path_const_iterator PathBegin,
2265 CastExpr::path_const_iterator PathEnd,
2266 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002267
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002268 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2269 /// base constructor/destructor with virtual bases.
2270 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2271 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2272 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2273 bool Delegating);
2274
John McCallf8ff7b92010-02-23 00:48:20 +00002275 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2276 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002277 const FunctionArgList &Args,
2278 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002279 // It's important not to confuse this and the previous function. Delegating
2280 // constructors are the C++0x feature. The constructor delegate optimization
2281 // is used to reduce duplication in the base and complete consturctors where
2282 // they are substantially the same.
2283 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2284 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002285
Richard Smith5179eb72016-06-28 19:03:57 +00002286 /// Emit a call to an inheriting constructor (that is, one that invokes a
2287 /// constructor inherited from a base class) by inlining its definition. This
2288 /// is necessary if the ABI does not support forwarding the arguments to the
2289 /// base class constructor (because they're variadic or similar).
2290 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2291 CXXCtorType CtorType,
2292 bool ForVirtualBase,
2293 bool Delegating,
2294 CallArgList &Args);
2295
2296 /// Emit a call to a constructor inherited from a base class, passing the
2297 /// current constructor's arguments along unmodified (without even making
2298 /// a copy).
2299 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2300 bool ForVirtualBase, Address This,
2301 bool InheritedFromVBase,
2302 const CXXInheritedCtorInitExpr *E);
2303
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002304 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002305 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002306 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002307
Richard Smith5179eb72016-06-28 19:03:57 +00002308 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2309 bool ForVirtualBase, bool Delegating,
2310 Address This, CallArgList &Args);
2311
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002312 /// Emit assumption load for all bases. Requires to be be called only on
2313 /// most-derived class and not under construction of the object.
2314 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2315
2316 /// Emit assumption that vptr load == global vtable.
2317 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2318
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002319 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002320 Address This, Address Src,
2321 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002322
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002323 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002324 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002325 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002326 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002327 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002328
Anders Carlssond49844b2009-09-23 02:45:36 +00002329 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2330 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002331 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002332 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002333 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002334
John McCall82fe67b2011-07-09 01:37:26 +00002335 static Destroyer destroyCXXObject;
2336
Anders Carlsson0a637412009-05-29 21:03:38 +00002337 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002338 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002339 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002340
John McCall99210dc2011-09-15 06:49:18 +00002341 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002342 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002343 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002344 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002345
Peter Collingbourne702b2842011-11-27 22:09:22 +00002346 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002347 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002348
David Majnemerdc012fa2015-04-22 21:38:15 +00002349 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2350 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2351
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002352 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002353 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002354
Eli Friedman24f55432009-11-18 00:57:03 +00002355 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002356 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2357 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002358
Richard Smith760520b2014-06-03 23:27:44 +00002359 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
Eric Fiselierfa752f22018-03-21 19:19:48 +00002360 const CallExpr *TheCallExpr, bool IsDelete);
Richard Smith760520b2014-06-03 23:27:44 +00002361
John McCall7f416cc2015-09-08 08:05:57 +00002362 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2363 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2364 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002365
Richard Smith69d0d262012-08-24 00:54:33 +00002366 /// \brief Situations in which we might emit a check for the suitability of a
2367 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002368 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002369 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002370 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002371 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002372 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002373 /// Checking the bound value in a reference binding. Must be suitably sized
2374 /// and aligned, but is not required to refer to an object (until the
2375 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002376 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002377 /// Checking the object expression in a non-static data member access. Must
2378 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002379 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002380 /// Checking the 'this' pointer for a call to a non-static member function.
2381 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002382 TCK_MemberCall,
2383 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002384 TCK_ConstructorCall,
2385 /// Checking the operand of a static_cast to a derived pointer type. Must be
2386 /// null or an object within its lifetime.
2387 TCK_DowncastPointer,
2388 /// Checking the operand of a static_cast to a derived reference type. Must
2389 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002390 TCK_DowncastReference,
2391 /// Checking the operand of a cast to a base object. Must be suitably sized
2392 /// and aligned.
2393 TCK_Upcast,
2394 /// Checking the operand of a cast to a virtual base object. Must be an
2395 /// object within its lifetime.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002396 TCK_UpcastToVirtualBase,
2397 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002398 TCK_NonnullAssign,
2399 /// Checking the operand of a dynamic_cast or a typeid expression. Must be
2400 /// null or an object within its lifetime.
2401 TCK_DynamicOperation
Richard Smith69d0d262012-08-24 00:54:33 +00002402 };
2403
Vedant Kumar24792e32017-10-03 01:27:25 +00002404 /// Determine whether the pointer type check \p TCK permits null pointers.
2405 static bool isNullPointerAllowed(TypeCheckKind TCK);
2406
2407 /// Determine whether the pointer type check \p TCK requires a vptr check.
2408 static bool isVptrCheckRequired(TypeCheckKind TCK, QualType Ty);
2409
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002410 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2411 /// calls to EmitTypeCheck can be skipped.
2412 bool sanitizePerformTypeCheck() const;
2413
Richard Smith4d1458e2012-09-08 02:08:36 +00002414 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002415 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002416 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002417 QualType Type, CharUnits Alignment = CharUnits::Zero(),
Vedant Kumar18348ea2017-02-17 23:22:55 +00002418 SanitizerSet SkippedChecks = SanitizerSet());
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002419
Richard Smith539e4a72013-02-23 02:53:19 +00002420 /// \brief Emit a check that \p Base points into an array object, which
2421 /// we can access at index \p Index. \p Accessed should be \c false if we
2422 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2423 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2424 QualType IndexType, bool Accessed);
2425
Chris Lattner116ce8f2010-01-09 21:40:03 +00002426 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2427 bool isInc, bool isPre);
2428 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2429 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002430
2431 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002432 llvm::Value *OffsetValue = nullptr) {
2433 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2434 OffsetValue);
2435 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002436
Amara Emerson652795d2016-11-10 14:44:30 +00002437 /// Converts Location to a DebugLoc, if debug information is enabled.
2438 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2439
2440
Chris Lattner8394d792007-06-05 20:53:16 +00002441 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002442 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002443 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002444
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002445 /// EmitDecl - Emit a declaration.
2446 ///
2447 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002448 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002449
John McCall1c9c3fd2010-10-15 04:57:14 +00002450 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002451 ///
2452 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002453 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002454
David Blaikie73ca5692014-12-09 00:32:22 +00002455 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002456 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002457
John McCallbd309292010-07-06 01:34:17 +00002458 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2459 llvm::Value *Address);
2460
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002461 /// \brief Determine whether the given initializer is trivial in the sense
2462 /// that it requires no code to be generated.
2463 bool isTrivialInitializer(const Expr *Init);
2464
John McCall1c9c3fd2010-10-15 04:57:14 +00002465 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002466 ///
2467 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002468 void EmitAutoVarDecl(const VarDecl &D);
2469
2470 class AutoVarEmission {
2471 friend class CodeGenFunction;
2472
John McCall9e2e22f2011-02-22 07:16:58 +00002473 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002474
John McCall7f416cc2015-09-08 08:05:57 +00002475 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002476 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002477 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002478
2479 llvm::Value *NRVOFlag;
2480
2481 /// True if the variable is a __block variable.
2482 bool IsByRef;
2483
2484 /// True if the variable is of aggregate type and has a constant
2485 /// initializer.
2486 bool IsConstantAggregate;
2487
Nadav Rotem1da30942013-03-23 06:43:35 +00002488 /// Non-null if we should use lifetime annotations.
2489 llvm::Value *SizeForLifetimeMarkers;
2490
John McCall9e2e22f2011-02-22 07:16:58 +00002491 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002492 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002493
John McCallc533cb72011-02-22 06:44:22 +00002494 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002495 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002496 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002497 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002498
John McCall7f416cc2015-09-08 08:05:57 +00002499 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002500
2501 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002502 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2503
Craig Topper8a13c412014-05-21 05:09:00 +00002504 bool useLifetimeMarkers() const {
2505 return SizeForLifetimeMarkers != nullptr;
2506 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002507 llvm::Value *getSizeForLifetimeMarkers() const {
2508 assert(useLifetimeMarkers());
2509 return SizeForLifetimeMarkers;
2510 }
2511
2512 /// Returns the raw, allocated address, which is not necessarily
2513 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002514 Address getAllocatedAddress() const {
2515 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002516 }
2517
John McCallc533cb72011-02-22 06:44:22 +00002518 /// Returns the address of the object within this declaration.
2519 /// Note that this does not chase the forwarding pointer for
2520 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002521 Address getObjectAddress(CodeGenFunction &CGF) const {
2522 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002523
John McCall7f416cc2015-09-08 08:05:57 +00002524 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002525 }
2526 };
2527 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2528 void EmitAutoVarInit(const AutoVarEmission &emission);
Gor Nishanov04491bd2017-11-11 17:00:43 +00002529 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002530 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2531 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002532
Sander de Smalen891af03a2018-02-03 13:55:59 +00002533 /// Emits the alloca and debug information for the size expressions for each
2534 /// dimension of an array. It registers the association of its (1-dimensional)
2535 /// QualTypes and size expression's debug node, so that CGDebugInfo can
2536 /// reference this node when creating the DISubrange object to describe the
2537 /// array types.
2538 void EmitAndRegisterVariableArrayDimensions(CGDebugInfo *DI,
2539 const VarDecl &D,
2540 bool EmitDebugInfo);
2541
John McCall1c9c3fd2010-10-15 04:57:14 +00002542 void EmitStaticVarDecl(const VarDecl &D,
2543 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002544
John McCall7f416cc2015-09-08 08:05:57 +00002545 class ParamValue {
2546 llvm::Value *Value;
2547 unsigned Alignment;
2548 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2549 public:
2550 static ParamValue forDirect(llvm::Value *value) {
2551 return ParamValue(value, 0);
2552 }
2553 static ParamValue forIndirect(Address addr) {
2554 assert(!addr.getAlignment().isZero());
2555 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2556 }
2557
2558 bool isIndirect() const { return Alignment != 0; }
2559 llvm::Value *getAnyValue() const { return Value; }
Gor Nishanov04491bd2017-11-11 17:00:43 +00002560
John McCall7f416cc2015-09-08 08:05:57 +00002561 llvm::Value *getDirectValue() const {
2562 assert(!isIndirect());
2563 return Value;
2564 }
2565
2566 Address getIndirectAddress() const {
2567 assert(isIndirect());
2568 return Address(Value, CharUnits::fromQuantity(Alignment));
2569 }
2570 };
2571
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002572 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002573 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002574
John McCallc07a0c72011-02-17 10:25:35 +00002575 /// protectFromPeepholes - Protect a value that we're intending to
2576 /// store to the side, but which will probably be used later, from
2577 /// aggressive peepholing optimizations that might delete it.
2578 ///
2579 /// Pass the result to unprotectFromPeepholes to declare that
2580 /// protection is no longer required.
2581 ///
2582 /// There's no particular reason why this shouldn't apply to
2583 /// l-values, it's just that no existing peepholes work on pointers.
2584 PeepholeProtection protectFromPeepholes(RValue rvalue);
2585 void unprotectFromPeepholes(PeepholeProtection protection);
2586
Erich Keane623efd82017-03-30 21:48:55 +00002587 void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment,
2588 llvm::Value *OffsetValue = nullptr) {
2589 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2590 OffsetValue);
2591 }
2592
Chris Lattner84915fa2007-06-02 04:16:21 +00002593 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002594 // Statement Emission
2595 //===--------------------------------------------------------------------===//
2596
Mike Stumpfc496822009-02-08 23:14:22 +00002597 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002598 void EmitStopPoint(const Stmt *S);
2599
Mike Stumpfc496822009-02-08 23:14:22 +00002600 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2601 /// this function even if there is no current insertion point.
2602 ///
2603 /// This function may clear the current insertion point; callers should use
2604 /// EnsureInsertPoint if they wish to subsequently generate code without first
2605 /// calling EmitBlock, EmitBranch, or EmitStmt.
Karl-Johan Karlsson33e205a2017-09-06 08:47:18 +00002606 void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002607
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002608 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002609 /// necessarily require an insertion point or debug information; typically
2610 /// because the statement amounts to a jump or a container of other
2611 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002612 ///
2613 /// \return True if the statement was handled.
2614 bool EmitSimpleStmt(const Stmt *S);
2615
John McCall7f416cc2015-09-08 08:05:57 +00002616 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2617 AggValueSlot AVS = AggValueSlot::ignored());
2618 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2619 bool GetLast = false,
2620 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002621 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002622
Mike Stumpfc496822009-02-08 23:14:22 +00002623 /// EmitLabel - Emit the block for the given label. It is legal to call this
2624 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002625 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002626
Chris Lattnerac248202007-05-30 00:13:02 +00002627 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002628 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002629 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002630 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002631 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002632
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002633 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002634 ArrayRef<const Attr *> Attrs = None);
2635 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002636 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002637 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002638 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002639 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002640 void EmitBreakStmt(const BreakStmt &S);
2641 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002642 void EmitSwitchStmt(const SwitchStmt &S);
2643 void EmitDefaultStmt(const DefaultStmt &S);
2644 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002645 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002646 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002647
Anders Carlsson2e744e82008-08-30 19:51:14 +00002648 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002649 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2650 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002651 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002652 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002653
Gor Nishanov8df64e92016-10-27 16:28:31 +00002654 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov90be1212017-03-06 21:12:54 +00002655 void EmitCoreturnStmt(const CoreturnStmt &S);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002656 RValue EmitCoawaitExpr(const CoawaitExpr &E,
2657 AggValueSlot aggSlot = AggValueSlot::ignored(),
2658 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002659 LValue EmitCoawaitLValue(const CoawaitExpr *E);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002660 RValue EmitCoyieldExpr(const CoyieldExpr &E,
2661 AggValueSlot aggSlot = AggValueSlot::ignored(),
2662 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002663 LValue EmitCoyieldLValue(const CoyieldExpr *E);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002664 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2665
John McCallb609d3f2010-07-07 06:56:46 +00002666 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2667 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002668
Anders Carlsson52d78a52009-09-27 18:58:34 +00002669 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002670 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002671 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002672 void EnterSEHTryStmt(const SEHTryStmt &S);
2673 void ExitSEHTryStmt(const SEHTryStmt &S);
2674
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002675 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002676 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002677
2678 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2679 const SEHExceptStmt &Except);
2680
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002681 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2682 const SEHFinallyStmt &Finally);
2683
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002684 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2685 llvm::Value *ParentFP,
2686 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002687 llvm::Value *EmitSEHExceptionCode();
2688 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002689 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002690
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002691 /// Emit simple code for OpenMP directives in Simd-only mode.
2692 void EmitSimpleOMPExecutableDirective(const OMPExecutableDirective &D);
2693
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002694 /// Scan the outlined statement for captures from the parent function. For
2695 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002696 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002697 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002698 bool IsFilter);
2699
2700 /// Recovers the address of a local in a parent function. ParentVar is the
2701 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002702 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002703 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2704 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002705 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2706 Address ParentVar,
2707 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002708
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002709 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002710 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002711
Alexey Bataev2139ed62017-11-16 18:20:21 +00002712 /// Controls insertion of cancellation exit blocks in worksharing constructs.
2713 class OMPCancelStackRAII {
2714 CodeGenFunction &CGF;
2715
2716 public:
2717 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
2718 bool HasCancel)
2719 : CGF(CGF) {
2720 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
2721 }
2722 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
2723 };
2724
Alexey Bataev1189bd02016-01-26 12:20:39 +00002725 /// Returns calculated size of the specified type.
2726 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002727 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002728 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002729 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002730 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002731 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002732 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002733 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002734 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2735 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002736 /// \brief Perform element by element copying of arrays with type \a
2737 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2738 /// generated by \a CopyGen.
2739 ///
2740 /// \param DestAddr Address of the destination array.
2741 /// \param SrcAddr Address of the source array.
2742 /// \param OriginalType Type of destination and source arrays.
2743 /// \param CopyGen Copying procedure that copies value of single array element
2744 /// to another single array element.
2745 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002746 Address DestAddr, Address SrcAddr, QualType OriginalType,
2747 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002748 /// \brief Emit proper copying of data from one variable to another.
2749 ///
2750 /// \param OriginalType Original type of the copied variables.
2751 /// \param DestAddr Destination address.
2752 /// \param SrcAddr Source address.
2753 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2754 /// type of the base array element).
2755 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2756 /// the base array element).
2757 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2758 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002759 void EmitOMPCopy(QualType OriginalType,
2760 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002761 const VarDecl *DestVD, const VarDecl *SrcVD,
2762 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002763 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2764 /// \a X = \a E \a BO \a E.
2765 ///
2766 /// \param X Value to be updated.
2767 /// \param E Update value.
2768 /// \param BO Binary operation for update operation.
2769 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2770 /// expression, false otherwise.
2771 /// \param AO Atomic ordering of the generated atomic instructions.
2772 /// \param CommonGen Code generator for complex expressions that cannot be
2773 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002774 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2775 /// generated, <false, RValue::get(nullptr)> otherwise.
2776 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002777 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2778 llvm::AtomicOrdering AO, SourceLocation Loc,
2779 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002780 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002781 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002782 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2783 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002784 void EmitOMPUseDevicePtrClause(
2785 const OMPClause &C, OMPPrivateScope &PrivateScope,
2786 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002787 /// \brief Emit code for copyin clause in \a D directive. The next code is
2788 /// generated at the start of outlined functions for directives:
2789 /// \code
2790 /// threadprivate_var1 = master_threadprivate_var1;
2791 /// operator=(threadprivate_var2, master_threadprivate_var2);
2792 /// ...
2793 /// __kmpc_barrier(&loc, global_tid);
2794 /// \endcode
2795 ///
2796 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2797 /// \returns true if at least one copyin variable is found, false otherwise.
2798 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002799 /// \brief Emit initial code for lastprivate variables. If some variable is
2800 /// not also firstprivate, then the default initialization is used. Otherwise
2801 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2802 /// method.
2803 ///
2804 /// \param D Directive that may have 'lastprivate' directives.
2805 /// \param PrivateScope Private scope for capturing lastprivate variables for
2806 /// proper codegen in internal captured statement.
2807 ///
2808 /// \returns true if there is at least one lastprivate variable, false
2809 /// otherwise.
2810 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2811 OMPPrivateScope &PrivateScope);
2812 /// \brief Emit final copying of lastprivate values to original variables at
2813 /// the end of the worksharing or simd directive.
2814 ///
2815 /// \param D Directive that has at least one 'lastprivate' directives.
2816 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2817 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002818 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002819 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002820 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002821 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002822 /// Emit initial code for linear clauses.
2823 void EmitOMPLinearClause(const OMPLoopDirective &D,
2824 CodeGenFunction::OMPPrivateScope &PrivateScope);
2825 /// Emit final code for linear clauses.
2826 /// \param CondGen Optional conditional code for final part of codegen for
2827 /// linear clause.
2828 void EmitOMPLinearClauseFinal(
2829 const OMPLoopDirective &D,
2830 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002831 /// \brief Emit initial code for reduction variables. Creates reduction copies
2832 /// and initializes them with the values according to OpenMP standard.
2833 ///
2834 /// \param D Directive (possibly) with the 'reduction' clause.
2835 /// \param PrivateScope Private scope for capturing reduction variables for
2836 /// proper codegen in internal captured statement.
2837 ///
2838 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2839 OMPPrivateScope &PrivateScope);
2840 /// \brief Emit final update of reduction values to original variables at
2841 /// the end of the directive.
2842 ///
2843 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00002844 /// \param ReductionKind The kind of reduction to perform.
2845 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
2846 const OpenMPDirectiveKind ReductionKind);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002847 /// \brief Emit initial code for linear variables. Creates private copies
2848 /// and initializes them with the values according to OpenMP standard.
2849 ///
2850 /// \param D Directive (possibly) with the 'linear' clause.
Alexey Bataev8c3edfe2017-08-16 15:58:46 +00002851 /// \return true if at least one linear variable is found that should be
2852 /// initialized with the value of the original variable, false otherwise.
2853 bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002854
Alexey Bataev7292c292016-04-25 12:22:29 +00002855 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2856 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002857 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002858 TaskGenTy;
2859 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
Alexey Bataev475a7442018-01-12 19:39:11 +00002860 const OpenMPDirectiveKind CapturedRegion,
Alexey Bataev7292c292016-04-25 12:22:29 +00002861 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002862 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataevd2202ca2017-12-27 17:58:32 +00002863 struct OMPTargetDataInfo {
2864 Address BasePointersArray = Address::invalid();
2865 Address PointersArray = Address::invalid();
2866 Address SizesArray = Address::invalid();
2867 unsigned NumberOfTargetItems = 0;
2868 explicit OMPTargetDataInfo() = default;
2869 OMPTargetDataInfo(Address BasePointersArray, Address PointersArray,
2870 Address SizesArray, unsigned NumberOfTargetItems)
2871 : BasePointersArray(BasePointersArray), PointersArray(PointersArray),
2872 SizesArray(SizesArray), NumberOfTargetItems(NumberOfTargetItems) {}
2873 };
2874 void EmitOMPTargetTaskBasedDirective(const OMPExecutableDirective &S,
2875 const RegionCodeGenTy &BodyGen,
2876 OMPTargetDataInfo &InputInfo);
Alexey Bataev7292c292016-04-25 12:22:29 +00002877
Alexey Bataev9959db52014-05-06 10:08:46 +00002878 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002879 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002880 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002881 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002882 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002883 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002884 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002885 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002886 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002887 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002888 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002889 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002890 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002891 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002892 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002893 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002894 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002895 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002896 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002897 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002898 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002899 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002900 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002901 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002902 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002903 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002904 void
2905 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002906 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002907 void
2908 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002909 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002910 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002911 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002912 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002913 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002914 void EmitOMPDistributeParallelForDirective(
2915 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002916 void EmitOMPDistributeParallelForSimdDirective(
2917 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002918 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002919 void EmitOMPTargetParallelForSimdDirective(
2920 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002921 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002922 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00002923 void
2924 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00002925 void EmitOMPTeamsDistributeParallelForSimdDirective(
2926 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00002927 void EmitOMPTeamsDistributeParallelForDirective(
2928 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00002929 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00002930 void EmitOMPTargetTeamsDistributeDirective(
2931 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00002932 void EmitOMPTargetTeamsDistributeParallelForDirective(
2933 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00002934 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
2935 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00002936 void EmitOMPTargetTeamsDistributeSimdDirective(
2937 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002938
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00002939 /// Emit device code for the target directive.
2940 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
2941 StringRef ParentName,
2942 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00002943 static void
2944 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2945 const OMPTargetParallelDirective &S);
Alexey Bataevfb0ebec2017-11-08 20:16:14 +00002946 /// Emit device code for the target parallel for directive.
2947 static void EmitOMPTargetParallelForDeviceFunction(
2948 CodeGenModule &CGM, StringRef ParentName,
2949 const OMPTargetParallelForDirective &S);
Alexey Bataev5d7edca2017-11-09 17:32:15 +00002950 /// Emit device code for the target parallel for simd directive.
2951 static void EmitOMPTargetParallelForSimdDeviceFunction(
2952 CodeGenModule &CGM, StringRef ParentName,
2953 const OMPTargetParallelForSimdDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00002954 /// Emit device code for the target teams directive.
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00002955 static void
2956 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2957 const OMPTargetTeamsDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00002958 /// Emit device code for the target teams distribute directive.
2959 static void EmitOMPTargetTeamsDistributeDeviceFunction(
2960 CodeGenModule &CGM, StringRef ParentName,
2961 const OMPTargetTeamsDistributeDirective &S);
Alexey Bataevfbe17fb2017-12-13 19:45:06 +00002962 /// Emit device code for the target teams distribute simd directive.
2963 static void EmitOMPTargetTeamsDistributeSimdDeviceFunction(
2964 CodeGenModule &CGM, StringRef ParentName,
2965 const OMPTargetTeamsDistributeSimdDirective &S);
Alexey Bataevf8365372017-11-17 17:57:25 +00002966 /// Emit device code for the target simd directive.
2967 static void EmitOMPTargetSimdDeviceFunction(CodeGenModule &CGM,
2968 StringRef ParentName,
2969 const OMPTargetSimdDirective &S);
Alexey Bataev647dd842018-01-15 20:59:40 +00002970 /// Emit device code for the target teams distribute parallel for simd
2971 /// directive.
2972 static void EmitOMPTargetTeamsDistributeParallelForSimdDeviceFunction(
2973 CodeGenModule &CGM, StringRef ParentName,
2974 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Carlo Bertolli52978c32018-01-03 21:12:44 +00002975
2976 static void EmitOMPTargetTeamsDistributeParallelForDeviceFunction(
2977 CodeGenModule &CGM, StringRef ParentName,
2978 const OMPTargetTeamsDistributeParallelForDirective &S);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002979 /// \brief Emit inner loop of the worksharing/simd construct.
2980 ///
2981 /// \param S Directive, for which the inner loop must be emitted.
2982 /// \param RequiresCleanup true, if directive has some associated private
2983 /// variables.
2984 /// \param LoopCond Bollean condition for loop continuation.
2985 /// \param IncExpr Increment expression for loop control variable.
2986 /// \param BodyGen Generator for the inner body of the inner loop.
2987 /// \param PostIncGen Genrator for post-increment code (required for ordered
2988 /// loop directvies).
2989 void EmitOMPInnerLoop(
2990 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2991 const Expr *IncExpr,
2992 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2993 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002994
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002995 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002996 /// Emit initial code for loop counters of loop-based directives.
2997 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2998 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002999
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003000 /// Helper for the OpenMP loop directives.
3001 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
3002
3003 /// \brief Emit code for the worksharing loop-based directive.
3004 /// \return true, if this construct has any lastprivate clause, false -
3005 /// otherwise.
3006 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
3007 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
3008 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3009
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003010 /// Emit code for the distribute loop-based directive.
3011 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
3012 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
3013
Alexey Bataevf8365372017-11-17 17:57:25 +00003014 /// Helpers for the OpenMP loop directives.
3015 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
3016 void EmitOMPSimdFinal(
3017 const OMPLoopDirective &D,
3018 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
3019
Alexey Bataevf47c4b42017-09-26 13:47:31 +00003020 /// Emits the lvalue for the expression with possibly captured variable.
3021 LValue EmitOMPSharedLValue(const Expr *E);
3022
Alexander Musmanc6388682014-12-15 07:07:06 +00003023private:
Yaxun Liufa13d012018-02-15 16:39:19 +00003024 /// Helpers for blocks.
3025 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
George Burgess IVe3763372016-12-22 02:50:20 +00003026
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003027 /// struct with the values to be passed to the OpenMP loop-related functions
3028 struct OMPLoopArguments {
3029 /// loop lower bound
3030 Address LB = Address::invalid();
3031 /// loop upper bound
3032 Address UB = Address::invalid();
3033 /// loop stride
3034 Address ST = Address::invalid();
3035 /// isLastIteration argument for runtime functions
3036 Address IL = Address::invalid();
3037 /// Chunk value generated by sema
3038 llvm::Value *Chunk = nullptr;
3039 /// EnsureUpperBound
3040 Expr *EUB = nullptr;
3041 /// IncrementExpression
3042 Expr *IncExpr = nullptr;
3043 /// Loop initialization
3044 Expr *Init = nullptr;
3045 /// Loop exit condition
3046 Expr *Cond = nullptr;
3047 /// Update of LB after a whole chunk has been executed
3048 Expr *NextLB = nullptr;
3049 /// Update of UB after a whole chunk has been executed
3050 Expr *NextUB = nullptr;
3051 OMPLoopArguments() = default;
3052 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
3053 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
3054 Expr *IncExpr = nullptr, Expr *Init = nullptr,
3055 Expr *Cond = nullptr, Expr *NextLB = nullptr,
3056 Expr *NextUB = nullptr)
3057 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
3058 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
3059 NextUB(NextUB) {}
3060 };
3061 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
3062 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
3063 const OMPLoopArguments &LoopArgs,
3064 const CodeGenLoopTy &CodeGenLoop,
3065 const CodeGenOrderedTy &CodeGenOrdered);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00003066 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00003067 bool IsMonotonic, const OMPLoopDirective &S,
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003068 OMPPrivateScope &LoopScope, bool Ordered,
3069 const OMPLoopArguments &LoopArgs,
3070 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3071 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
3072 const OMPLoopDirective &S,
3073 OMPPrivateScope &LoopScope,
3074 const OMPLoopArguments &LoopArgs,
3075 const CodeGenLoopTy &CodeGenLoopContent);
Alexey Bataev0f34da12015-07-02 04:17:07 +00003076 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00003077 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00003078
3079public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00003080
Chris Lattner208ae962007-05-30 17:57:17 +00003081 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00003082 // LValue Expression Emission
3083 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00003084
Daniel Dunbarc79407f2009-02-05 07:09:07 +00003085 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
3086 RValue GetUndefRValue(QualType Ty);
3087
Daniel Dunbarbb197e42009-01-09 16:50:52 +00003088 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
3089 /// and issue an ErrorUnsupported style diagnostic (using the
3090 /// provided Name).
3091 RValue EmitUnsupportedRValue(const Expr *E,
3092 const char *Name);
3093
Mike Stumpfc496822009-02-08 23:14:22 +00003094 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
3095 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00003096 LValue EmitUnsupportedLValue(const Expr *E,
3097 const char *Name);
3098
Chris Lattner8394d792007-06-05 20:53:16 +00003099 /// EmitLValue - Emit code to compute a designator that specifies the location
3100 /// of the expression.
3101 ///
3102 /// This can return one of two things: a simple address or a bitfield
3103 /// reference. In either case, the LLVM Value* in the LValue structure is
3104 /// guaranteed to be an LLVM pointer type.
3105 ///
3106 /// If this returns a bitfield reference, nothing about the pointee type of
3107 /// the LLVM value is known: For example, it may not be a pointer to an
3108 /// integer.
3109 ///
3110 /// If this returns a normal address, and if the lvalue's C type is fixed
3111 /// size, this method guarantees that the returned pointer type will point to
3112 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
3113 /// variable length type, this is not possible.
3114 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00003115 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003116
Richard Smith4d1458e2012-09-08 02:08:36 +00003117 /// \brief Same as EmitLValue but additionally we generate checking code to
3118 /// guard against undefined behavior. This is only suitable when we know
3119 /// that the address will be used to access the object.
3120 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00003121
John McCall7f416cc2015-09-08 08:05:57 +00003122 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003123 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00003124
John McCalla8ec7eb2013-03-07 21:37:17 +00003125 void EmitAtomicInit(Expr *E, LValue lvalue);
3126
David Majnemera5b195a2015-02-14 01:35:12 +00003127 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00003128
3129 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
3130 AggValueSlot Slot = AggValueSlot::ignored());
3131
Nick Lewycky2d84e842013-10-02 02:29:49 +00003132 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00003133 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00003134 AggValueSlot slot = AggValueSlot::ignored());
3135
3136 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3137
David Majnemera5b195a2015-02-14 01:35:12 +00003138 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3139 bool IsVolatile, bool isInit);
3140
Alexey Bataevb4505a72015-03-30 05:20:59 +00003141 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00003142 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00003143 llvm::AtomicOrdering Success =
3144 llvm::AtomicOrdering::SequentiallyConsistent,
3145 llvm::AtomicOrdering Failure =
3146 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00003147 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3148
Alexey Bataevb4505a72015-03-30 05:20:59 +00003149 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00003150 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00003151 bool IsVolatile);
3152
John McCall3a7f6922010-10-27 20:58:56 +00003153 /// EmitToMemory - Change a scalar value from its value
3154 /// representation to its in-memory representation.
3155 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3156
3157 /// EmitFromMemory - Change a scalar value from its memory
3158 /// representation to its value representation.
3159 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3160
Vedant Kumar5a972652017-02-27 19:46:19 +00003161 /// Check if the scalar \p Value is within the valid range for the given
3162 /// type \p Ty.
3163 ///
3164 /// Returns true if a check is needed (even if the range is unknown).
3165 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3166 SourceLocation Loc);
3167
Daniel Dunbar1d425462009-02-10 00:57:50 +00003168 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3169 /// care to appropriately convert from the memory representation to
3170 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003171 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003172 SourceLocation Loc,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003173 AlignmentSource Source = AlignmentSource::Type,
3174 bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003175 return EmitLoadOfScalar(Addr, Volatile, Ty, Loc, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003176 CGM.getTBAAAccessInfo(Ty), isNontemporal);
3177 }
3178
3179 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3180 SourceLocation Loc, LValueBaseInfo BaseInfo,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003181 TBAAAccessInfo TBAAInfo,
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003182 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003183
3184 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3185 /// care to appropriately convert from the memory representation to
3186 /// the LLVM value representation. The l-value must be a simple
3187 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003188 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003189
3190 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3191 /// care to appropriately convert from the memory representation to
3192 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003193 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3194 bool Volatile, QualType Ty,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003195 AlignmentSource Source = AlignmentSource::Type,
3196 bool isInit = false, bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003197 EmitStoreOfScalar(Value, Addr, Volatile, Ty, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003198 CGM.getTBAAAccessInfo(Ty), isInit, isNontemporal);
3199 }
3200
3201 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003202 bool Volatile, QualType Ty,
3203 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo,
Ivan A. Kosareva511ed72017-10-03 10:52:39 +00003204 bool isInit = false, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003205
3206 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3207 /// care to appropriately convert from the memory representation to
3208 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00003209 /// l-value. The isInit flag indicates whether this is an initialization.
3210 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3211 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003212
Chris Lattner8394d792007-06-05 20:53:16 +00003213 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3214 /// this method emits the address of the lvalue, then loads the result as an
3215 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003216 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00003217 RValue EmitLoadOfExtVectorElementLValue(LValue V);
Vedant Kumar129edab2017-03-09 16:06:27 +00003218 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
Renato Golin230c5eb2014-05-19 18:15:42 +00003219 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00003220
Chris Lattner8394d792007-06-05 20:53:16 +00003221 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3222 /// lvalue, where both are guaranteed to the have the same type, and that type
3223 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00003224 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003225 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00003226 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003227
Nick Lewycky2d84e842013-10-02 02:29:49 +00003228 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3229 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003230 ///
Mike Stumpfc496822009-02-08 23:14:22 +00003231 /// \param Result [out] - If non-null, this will be set to a Value* for the
3232 /// bit-field contents after the store, appropriate for use as the result of
3233 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00003234 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00003235 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00003236
John McCall4f29b492010-11-16 23:07:28 +00003237 /// Emit an l-value for an assignment (simple or compound) of complex type.
3238 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003239 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00003240 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3241 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00003242
Chris Lattner57540c52011-04-15 05:22:18 +00003243 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00003244 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003245 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003246 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00003247 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003248 // Note: only available for agg return types
3249 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00003250 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00003251 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00003252 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00003253 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00003254 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00003255 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3256 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00003257 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3258 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00003259 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00003260 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00003261 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00003262 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00003263 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00003264 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00003265 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00003266 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00003267 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003268
John McCall7f416cc2015-09-08 08:05:57 +00003269 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003270
Nick Lewycky2d84e842013-10-02 02:29:49 +00003271 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00003272
John McCall7f416cc2015-09-08 08:05:57 +00003273 Address EmitArrayToPointerDecay(const Expr *Array,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00003274 LValueBaseInfo *BaseInfo = nullptr,
3275 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003276
John McCall71335052012-03-10 03:05:10 +00003277 class ConstantEmission {
3278 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3279 ConstantEmission(llvm::Constant *C, bool isReference)
3280 : ValueAndIsReference(C, isReference) {}
3281 public:
3282 ConstantEmission() {}
3283 static ConstantEmission forReference(llvm::Constant *C) {
3284 return ConstantEmission(C, true);
3285 }
3286 static ConstantEmission forValue(llvm::Constant *C) {
3287 return ConstantEmission(C, false);
3288 }
3289
Aaron Ballman67347662015-02-15 22:00:28 +00003290 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00003291 return ValueAndIsReference.getOpaqueValue() != nullptr;
3292 }
John McCall71335052012-03-10 03:05:10 +00003293
3294 bool isReference() const { return ValueAndIsReference.getInt(); }
3295 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3296 assert(isReference());
3297 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3298 refExpr->getType());
3299 }
3300
3301 llvm::Constant *getValue() const {
3302 assert(!isReference());
3303 return ValueAndIsReference.getPointer();
3304 }
3305 };
3306
John McCall113bee02012-03-10 09:33:50 +00003307 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
Alex Lorenz6cc83172017-08-25 10:07:00 +00003308 ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
John McCall71335052012-03-10 03:05:10 +00003309
John McCallfe96e0b2011-11-06 09:01:30 +00003310 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3311 AggValueSlot slot = AggValueSlot::ignored());
3312 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3313
Daniel Dunbar722f4242009-04-22 05:08:15 +00003314 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003315 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00003316 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00003317 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003318
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003319 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3320 /// if the Field is a reference, this will return the address of the reference
3321 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003322 LValue EmitLValueForFieldInitialization(LValue Base,
3323 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003324
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003325 LValue EmitLValueForIvar(QualType ObjectTy,
3326 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003327 unsigned CVRQualifiers);
3328
Anders Carlsson3be22e22009-05-30 23:23:33 +00003329 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003330 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00003331 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003332 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003333 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003334
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003335 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003336 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003337 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003338 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003339 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003340 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003341
Chris Lattnerd7f58862007-06-02 05:24:33 +00003342 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003343 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003344 //===--------------------------------------------------------------------===//
3345
Mike Stumpfc496822009-02-08 23:14:22 +00003346 /// EmitCall - Generate a call of the given function, expecting the given
3347 /// result type, and using the given argument list which specifies both the
3348 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003349 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003350 ReturnValueSlot ReturnValue, const CallArgList &Args,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003351 llvm::Instruction **callOrInvoke, SourceLocation Loc);
3352 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
3353 ReturnValueSlot ReturnValue, const CallArgList &Args,
3354 llvm::Instruction **callOrInvoke = nullptr) {
3355 return EmitCall(CallInfo, Callee, ReturnValue, Args, callOrInvoke,
3356 SourceLocation());
3357 }
John McCallb92ab1a2016-10-26 23:46:34 +00003358 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003359 ReturnValueSlot ReturnValue, llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003360 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003361 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003362 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3363 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003364
Eric Christopherc7e79db2015-11-12 00:44:04 +00003365 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003366
John McCall882987f2013-02-28 19:01:20 +00003367 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3368 const Twine &name = "");
3369 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3370 ArrayRef<llvm::Value*> args,
3371 const Twine &name = "");
3372 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3373 const Twine &name = "");
3374 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3375 ArrayRef<llvm::Value*> args,
3376 const Twine &name = "");
3377
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003378 SmallVector<llvm::OperandBundleDef, 1>
3379 getBundlesForFunclet(llvm::Value *Callee);
3380
John McCallbd309292010-07-06 01:34:17 +00003381 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003382 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00003383 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00003384 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3385 ArrayRef<llvm::Value*> args,
3386 const Twine &name = "");
3387 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3388 const Twine &name = "");
3389 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3390 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00003391
Gor Nishanov04491bd2017-11-11 17:00:43 +00003392 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
John McCallb92ab1a2016-10-26 23:46:34 +00003393 NestedNameSpecifier *Qual,
3394 llvm::Type *Ty);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003395
John McCallb92ab1a2016-10-26 23:46:34 +00003396 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
Gor Nishanov04491bd2017-11-11 17:00:43 +00003397 CXXDtorType Type,
John McCallb92ab1a2016-10-26 23:46:34 +00003398 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003399
Akira Hatanaka7275da02018-02-28 07:15:55 +00003400 // These functions emit calls to the special functions of non-trivial C
3401 // structs.
3402 void defaultInitNonTrivialCStructVar(LValue Dst);
3403 void callCStructDefaultConstructor(LValue Dst);
3404 void callCStructDestructor(LValue Dst);
3405 void callCStructCopyConstructor(LValue Dst, LValue Src);
3406 void callCStructMoveConstructor(LValue Dst, LValue Src);
3407 void callCStructCopyAssignmentOperator(LValue Dst, LValue Src);
3408 void callCStructMoveAssignmentOperator(LValue Dst, LValue Src);
3409
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003410 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003411 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3412 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003413 ReturnValueSlot ReturnValue, llvm::Value *This,
3414 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003415 QualType ImplicitParamTy, const CallExpr *E,
3416 CallArgList *RtlArgs);
John McCallb92ab1a2016-10-26 23:46:34 +00003417 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3418 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003419 llvm::Value *This, llvm::Value *ImplicitParam,
3420 QualType ImplicitParamTy, const CallExpr *E,
3421 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003422 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3423 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003424 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3425 const CXXMethodDecl *MD,
3426 ReturnValueSlot ReturnValue,
3427 bool HasQualifier,
3428 NestedNameSpecifier *Qualifier,
3429 bool IsArrow, const Expr *Base);
3430 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003431 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3432 llvm::Value *memberPtr,
3433 const MemberPointerType *memberPtrType,
Ivan A. Kosarev229a6d82017-10-13 16:38:32 +00003434 LValueBaseInfo *BaseInfo = nullptr,
3435 TBAAAccessInfo *TBAAInfo = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003436 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3437 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003438
Anders Carlsson4034a952009-05-27 04:18:27 +00003439 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003440 const CXXMethodDecl *MD,
3441 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003442 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003443
Peter Collingbournefe883422011-10-06 18:29:37 +00003444 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3445 ReturnValueSlot ReturnValue);
3446
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003447 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3448 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003449
Mike Stump11289f42009-09-09 15:08:12 +00003450 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00003451 unsigned BuiltinID, const CallExpr *E,
3452 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003453
Akira Hatanaka6b103bc2017-10-06 07:12:46 +00003454 /// Emit IR for __builtin_os_log_format.
3455 RValue emitBuiltinOSLogFormat(const CallExpr &E);
3456
3457 llvm::Function *generateBuiltinOSLogHelperFunction(
3458 const analyze_os_log::OSLogBufferLayout &Layout,
3459 CharUnits BufferAlignment);
3460
Anders Carlssonbfb36712009-12-24 21:13:40 +00003461 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003462
Mike Stumpfc496822009-02-08 23:14:22 +00003463 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3464 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003465 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3466
Kevin Qin1718af62013-11-14 02:45:18 +00003467 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3468 const llvm::CmpInst::Predicate Fp,
3469 const llvm::CmpInst::Predicate Ip,
3470 const llvm::Twine &Name = "");
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003471 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3472 llvm::Triple::ArchType Arch);
Tim Northover8fe03d62014-02-21 11:57:24 +00003473
3474 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3475 unsigned LLVMIntrinsic,
3476 unsigned AltLLVMIntrinsic,
3477 const char *NameHint,
3478 unsigned Modifier,
3479 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003480 SmallVectorImpl<llvm::Value *> &Ops,
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003481 Address PtrOp0, Address PtrOp1,
3482 llvm::Triple::ArchType Arch);
Tim Northover8fe03d62014-02-21 11:57:24 +00003483 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3484 unsigned Modifier, llvm::Type *ArgTy,
3485 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003486 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003487 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003488 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003489 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003490 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003491 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003492 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003493 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3494 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003495 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003496 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3497 llvm::Triple::ArchType Arch);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003498
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003499 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003500 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3501 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003502 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003503 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003504 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003505 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3506 const CallExpr *E);
Krzysztof Parzyszek5a655832017-12-13 19:56:03 +00003507 llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003508
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003509private:
3510 enum class MSVCIntrin;
3511
3512public:
3513 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3514
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003515 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3516
Daniel Dunbar66912a12008-08-20 00:28:19 +00003517 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003518 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003519 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003520 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3521 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3522 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003523 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003524 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003525 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3526 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003527
John McCall31168b02011-06-15 23:02:42 +00003528 /// Retrieves the default cleanup kind for an ARC cleanup.
3529 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3530 CleanupKind getARCCleanupKind() {
3531 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3532 ? NormalAndEHCleanup : NormalCleanup;
3533 }
3534
3535 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003536 void EmitARCInitWeak(Address addr, llvm::Value *value);
3537 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003538 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003539 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3540 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
Akira Hatanakad791e922018-03-19 17:38:40 +00003541 void emitARCCopyAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
3542 void emitARCMoveAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
John McCall7f416cc2015-09-08 08:05:57 +00003543 void EmitARCCopyWeak(Address dst, Address src);
3544 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003545 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3546 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003547 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003548 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003549 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003550 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003551 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003552 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003553 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003554 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003555 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003556 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003557 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3558 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3559 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003560 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003561
3562 std::pair<LValue,llvm::Value*>
3563 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3564 std::pair<LValue,llvm::Value*>
3565 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003566 std::pair<LValue,llvm::Value*>
3567 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003568
John McCall248512a2011-10-01 10:32:24 +00003569 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003570 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3571 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3572
John McCallff613032011-10-04 06:23:45 +00003573 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003574 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3575 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003576 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3577 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003578 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003579
Craig Topper00bbdcf2014-06-28 23:22:23 +00003580 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003581
John McCall82fe67b2011-07-09 01:37:26 +00003582 static Destroyer destroyARCStrongImprecise;
3583 static Destroyer destroyARCStrongPrecise;
3584 static Destroyer destroyARCWeak;
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00003585 static Destroyer emitARCIntrinsicUse;
Akira Hatanaka7275da02018-02-28 07:15:55 +00003586 static Destroyer destroyNonTrivialCStruct;
John McCall82fe67b2011-07-09 01:37:26 +00003587
Gor Nishanov04491bd2017-11-11 17:00:43 +00003588 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003589 llvm::Value *EmitObjCAutoreleasePoolPush();
3590 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3591 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003592 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003593
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003594 /// \brief Emits a reference binding to the passed in expression.
3595 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003596
Chris Lattner6278e6a2007-08-11 00:04:45 +00003597 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003598 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003599 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003600
3601 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003602
3603 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3604 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003605 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003606
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003607 /// Emit a conversion from the specified type to the specified destination
3608 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003609 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003610 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003611
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003612 /// Emit a conversion from the specified complex type to the specified
3613 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003614 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003615 QualType DstTy,
3616 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003617
John McCall7a626f62010-09-15 10:14:12 +00003618 /// EmitAggExpr - Emit the computation of the specified expression
3619 /// of aggregate type. The result is computed into the given slot,
3620 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003621 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003622
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003623 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3624 /// aggregate type into a temporary LValue.
3625 LValue EmitAggExprToLValue(const Expr *E);
3626
John McCall1bd25562011-06-24 23:21:27 +00003627 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3628 /// make sure it survives garbage collection until this point.
3629 void EmitExtendGCLifetime(llvm::Value *object);
3630
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003631 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003632 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003633 ComplexPairTy EmitComplexExpr(const Expr *E,
3634 bool IgnoreReal = false,
3635 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003636
John McCall47fb9502013-03-07 21:37:08 +00003637 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3638 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003639 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003640
John McCall47fb9502013-03-07 21:37:08 +00003641 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003642 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003643
3644 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003645 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003646
John McCall7f416cc2015-09-08 08:05:57 +00003647 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3648 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3649
Chandler Carruth84537952012-03-30 19:44:53 +00003650 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3651 /// global variable that has already been created for it. If the initializer
3652 /// has a different type than GV does, this may free GV and return a different
3653 /// one. Otherwise it just returns GV.
3654 llvm::GlobalVariable *
3655 AddInitializerToStaticVarDecl(const VarDecl &D,
3656 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003657
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003658
Anders Carlssonf40886a2009-08-08 21:45:14 +00003659 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3660 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003661 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3662 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003663
David Majnemerb3341ea2014-10-05 05:05:40 +00003664 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3665 llvm::Constant *Addr);
3666
John McCallc84ed6a2012-05-01 06:13:13 +00003667 /// Call atexit() with a function that passes the given argument to
3668 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003669 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3670 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003671
John McCallcdf7ef52010-11-06 09:44:32 +00003672 /// Emit code in this function to perform a guarded variable
3673 /// initialization. Guarded initializations are used when it's not
3674 /// possible to prove that an initialization will be done exactly
3675 /// once, e.g. with a static local variable or a static data member
3676 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003677 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003678 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003679
Richard Smithae8d62c2017-07-26 22:01:09 +00003680 enum class GuardKind { VariableGuard, TlsGuard };
3681
3682 /// Emit a branch to select whether or not to perform guarded initialization.
3683 void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
3684 llvm::BasicBlock *InitBlock,
3685 llvm::BasicBlock *NoInitBlock,
3686 GuardKind Kind, const VarDecl *D);
3687
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003688 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3689 /// variables.
3690 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003691 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003692 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003693
John McCallee08c532012-04-06 18:21:03 +00003694 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003695 /// variables.
Sanjoy Dase369bd92017-05-01 17:08:00 +00003696 void GenerateCXXGlobalDtorsFunc(
3697 llvm::Function *Fn,
3698 const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
3699 &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003700
John McCalla738c252011-03-09 04:27:21 +00003701 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3702 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003703 llvm::GlobalVariable *Addr,
3704 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003705
John McCall7a626f62010-09-15 10:14:12 +00003706 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003707
John McCall7f416cc2015-09-08 08:05:57 +00003708 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003709
John McCall08ef4662011-11-10 08:15:53 +00003710 void enterFullExpression(const ExprWithCleanups *E) {
3711 if (E->getNumObjects() == 0) return;
3712 enterNonTrivialFullExpression(E);
3713 }
3714 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003715
Richard Smithea852322013-05-07 21:53:22 +00003716 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003717
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003718 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3719
Tim Northovercc2a6e02015-11-09 19:56:35 +00003720 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003721
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003722 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003723 // Annotations Emission
3724 //===--------------------------------------------------------------------===//
3725
3726 /// Emit an annotation call (intrinsic or builtin).
3727 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3728 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003729 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003730 SourceLocation Location);
3731
3732 /// Emit local annotations for the local variable V, declared by D.
3733 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3734
3735 /// Emit field annotations for the given field & value. Returns the
3736 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003737 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003738
3739 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003740 // Internal Helpers
3741 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003742
Chris Lattner5b1964b2008-11-11 07:41:27 +00003743 /// ContainsLabel - Return true if the statement contains a label in it. If
3744 /// this statement is not executed normally, it not containing a label means
3745 /// that we can just remove the code.
3746 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003747
Chris Lattner29911cc2011-02-28 00:18:40 +00003748 /// containsBreak - Return true if the statement contains a break out of it.
3749 /// If the statement (recursively) contains a switch or loop with a break
3750 /// inside of it, this is fine.
3751 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003752
3753 /// Determine if the given statement might introduce a declaration into the
3754 /// current scope, by being a (possibly-labelled) DeclStmt.
3755 static bool mightAddDeclToScope(const Stmt *S);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003756
Daniel Dunbar682712c2008-11-12 10:12:14 +00003757 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003758 /// to a constant, or if it does but contains a label, return false. If it
3759 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003760 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3761 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003762
Chris Lattner29911cc2011-02-28 00:18:40 +00003763 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3764 /// to a constant, or if it does but contains a label, return false. If it
3765 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003766 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3767 bool AllowLabels = false);
3768
Chris Lattnercd439292008-11-12 08:04:58 +00003769 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3770 /// if statement) to the specified blocks. Based on the condition, this might
3771 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003772 /// TrueCount should be the number of times we expect the condition to
3773 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003774 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003775 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003776
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003777 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
3778 /// nonnull, if \p LHS is marked _Nonnull.
3779 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
3780
Vedant Kumar175b6d12017-07-13 20:55:26 +00003781 /// An enumeration which makes it easier to specify whether or not an
3782 /// operation is a subtraction.
3783 enum { NotSubtraction = false, IsSubtraction = true };
3784
Vedant Kumara125eb52017-06-01 19:22:18 +00003785 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
3786 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003787 /// \p SignedIndices indicates whether any of the GEP indices are signed.
Vedant Kumar175b6d12017-07-13 20:55:26 +00003788 /// \p IsSubtraction indicates whether the expression used to form the GEP
3789 /// is a subtraction.
Vedant Kumara125eb52017-06-01 19:22:18 +00003790 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
3791 ArrayRef<llvm::Value *> IdxList,
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003792 bool SignedIndices,
Vedant Kumar175b6d12017-07-13 20:55:26 +00003793 bool IsSubtraction,
Vedant Kumara125eb52017-06-01 19:22:18 +00003794 SourceLocation Loc,
3795 const Twine &Name = "");
3796
Vedant Kumar10c31022017-07-29 00:19:51 +00003797 /// Specifies which type of sanitizer check to apply when handling a
3798 /// particular builtin.
3799 enum BuiltinCheckKind {
3800 BCK_CTZPassedZero,
3801 BCK_CLZPassedZero,
3802 };
3803
3804 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
3805 /// enabled, a runtime check specified by \p Kind is also emitted.
3806 llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
3807
Richard Smithe30752c2012-10-09 19:52:38 +00003808 /// \brief Emit a description of a type in a format suitable for passing to
3809 /// a runtime sanitizer handler.
3810 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3811
3812 /// \brief Convert a value into a format suitable for passing to a runtime
3813 /// sanitizer handler.
3814 llvm::Value *EmitCheckValue(llvm::Value *V);
3815
3816 /// \brief Emit a description of a source location in a format suitable for
3817 /// passing to a runtime sanitizer handler.
3818 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3819
Richard Smithde670682012-11-01 22:15:34 +00003820 /// \brief Create a basic block that will call a handler function in a
3821 /// sanitizer runtime with the provided arguments, and create a conditional
3822 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003823 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00003824 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003825 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003826
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003827 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3828 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003829 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3830 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3831 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003832
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003833 /// Emit a reached-unreachable diagnostic if \p Loc is valid and runtime
3834 /// checking is enabled. Otherwise, just emit an unreachable instruction.
3835 void EmitUnreachable(SourceLocation Loc);
3836
Richard Smithde670682012-11-01 22:15:34 +00003837 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3838 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003839 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003840
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003841 /// \brief Emit a call to trap or debugtrap and attach function attribute
3842 /// "trap-func-name" if specified.
3843 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3844
Evgeniy Stepanov1a8030e2017-04-07 23:00:38 +00003845 /// \brief Emit a stub for the cross-DSO CFI check function.
3846 void EmitCfiCheckStub();
3847
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003848 /// \brief Emit a cross-DSO CFI failure handling function.
3849 void EmitCfiCheckFail();
3850
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003851 /// \brief Create a check for a function parameter that may potentially be
3852 /// declared as non-null.
3853 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003854 AbstractCallee AC, unsigned ParmNum);
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003855
Anders Carlsson093bdff2010-03-30 03:27:09 +00003856 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003857 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003858
John McCall23f66262010-05-26 22:34:26 +00003859 /// EmitDelegateCallArg - We are performing a delegate call; that
3860 /// is, the current function is delegating to another one. Produce
3861 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003862 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3863 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003864
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003865 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3866 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003867 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003868
Chris Lattnercd439292008-11-12 08:04:58 +00003869private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003870 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003871 void EmitReturnOfRValue(RValue RV, QualType Ty);
3872
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003873 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3874
3875 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3876 DeferredReplacements;
3877
John McCall7f416cc2015-09-08 08:05:57 +00003878 /// Set the address of a local variable.
3879 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3880 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3881 LocalDeclMap.insert({VD, Addr});
3882 }
3883
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003884 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3885 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3886 ///
3887 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003888 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003889 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003890
Yaxun Liu5b330e82018-03-15 15:25:19 +00003891 /// ExpandTypeToArgs - Expand an CallArg \arg Arg, with the LLVM type for \arg
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003892 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3893 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003894 void ExpandTypeToArgs(QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003895 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3896 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003897
Chad Rosier59df25b2012-08-23 20:00:18 +00003898 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003899 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003900
Chad Rosier59df25b2012-08-23 20:00:18 +00003901 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003902 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003903 std::string &ConstraintStr,
3904 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003905
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003906 /// \brief Attempts to statically evaluate the object size of E. If that
3907 /// fails, emits code to figure the size of E out for us. This is
3908 /// pass_object_size aware.
George Burgess IV0d6592a2017-02-23 05:59:56 +00003909 ///
3910 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003911 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003912 llvm::IntegerType *ResType,
3913 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003914
3915 /// \brief Emits the size of E, as required by __builtin_object_size. This
3916 /// function is aware of pass_object_size parameters, and will act accordingly
3917 /// if E is a parameter with the pass_object_size attribute.
3918 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003919 llvm::IntegerType *ResType,
3920 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003921
Reid Kleckner89077a12013-12-17 19:46:40 +00003922public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003923#ifndef NDEBUG
3924 // Determine whether the given argument is an Objective-C method
3925 // that may have type parameters in its signature.
3926 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3927 const DeclContext *dc = method->getDeclContext();
3928 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3929 return classDecl->getTypeParamListAsWritten();
3930 }
3931
3932 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3933 return catDecl->getTypeParamList();
3934 }
3935
3936 return false;
3937 }
3938
3939 template<typename T>
3940 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3941#endif
3942
Richard Smitha560ccf2016-09-29 21:30:12 +00003943 enum class EvaluationOrder {
3944 ///! No language constraints on evaluation order.
3945 Default,
3946 ///! Language semantics require left-to-right evaluation.
3947 ForceLeftToRight,
3948 ///! Language semantics require right-to-left evaluation.
3949 ForceRightToLeft
3950 };
3951
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003952 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003953 template <typename T>
3954 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003955 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003956 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003957 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003958 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003959 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003960 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003961
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003962 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3963 "Can't skip parameters if type info is not provided");
3964 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003965#ifndef NDEBUG
3966 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3967#endif
3968
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003969 // First, use the argument types that the type info knows about
3970 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3971 E = CallArgTypeInfo->param_type_end();
3972 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003973 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003974 assert((isGenericMethod ||
3975 ((*I)->isVariablyModifiedType() ||
3976 (*I).getNonReferenceType()->isObjCRetainableType() ||
3977 getContext()
3978 .getCanonicalType((*I).getNonReferenceType())
3979 .getTypePtr() ==
3980 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003981 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003982 .getTypePtr())) &&
3983 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003984 ArgTypes.push_back(*I);
3985 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003986 }
Mike Stump11289f42009-09-09 15:08:12 +00003987
Reid Kleckner739756c2013-12-04 19:23:12 +00003988 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003989 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003990 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3991 CallArgTypeInfo->isVariadic()) &&
3992 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003993
Anders Carlsson603d6af2009-04-18 20:20:22 +00003994 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003995 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00003996 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003997
Vedant Kumared00ea02017-03-06 05:28:22 +00003998 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003999 }
John McCalld4f4b7f2010-03-03 04:15:11 +00004000
Reid Kleckner739756c2013-12-04 19:23:12 +00004001 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00004002 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00004003 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00004004 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00004005 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00004006
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00004007 /// EmitPointerWithAlignment - Given an expression with a pointer type,
4008 /// emit the value and compute our best estimate of the alignment of the
4009 /// pointee.
John McCall7f416cc2015-09-08 08:05:57 +00004010 ///
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00004011 /// \param BaseInfo - If non-null, this will be initialized with
4012 /// information about the source of the alignment and the may-alias
4013 /// attribute. Note that this function will conservatively fall back on
4014 /// the type when it doesn't recognize the expression and may-alias will
4015 /// be set to false.
4016 ///
4017 /// One reasonable way to use this information is when there's a language
4018 /// guarantee that the pointer must be aligned to some stricter value, and
4019 /// we're simply trying to ensure that sufficiently obvious uses of under-
4020 /// aligned objects don't get miscompiled; for example, a placement new
4021 /// into the address of a local variable. In such a case, it's quite
4022 /// reasonable to just ignore the returned alignment when it isn't from an
4023 /// explicit source.
John McCall7f416cc2015-09-08 08:05:57 +00004024 Address EmitPointerWithAlignment(const Expr *Addr,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00004025 LValueBaseInfo *BaseInfo = nullptr,
4026 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00004027
Vedant Kumar36347d92017-12-08 01:51:47 +00004028 /// If \p E references a parameter with pass_object_size info or a constant
4029 /// array size modifier, emit the object size divided by the size of \p EltTy.
4030 /// Otherwise return null.
4031 llvm::Value *LoadPassedObjectSize(const Expr *E, QualType EltTy);
4032
Peter Collingbournedc134532016-01-16 00:31:22 +00004033 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
4034
Erich Keane281d20b2018-01-08 21:34:17 +00004035 struct MultiVersionResolverOption {
4036 llvm::Function *Function;
4037 TargetAttr::ParsedTargetAttr ParsedAttribute;
4038 unsigned Priority;
4039 MultiVersionResolverOption(const TargetInfo &TargInfo, llvm::Function *F,
4040 const clang::TargetAttr::ParsedTargetAttr &PT)
4041 : Function(F), ParsedAttribute(PT), Priority(0u) {
4042 for (StringRef Feat : PT.Features)
4043 Priority = std::max(Priority,
4044 TargInfo.multiVersionSortPriority(Feat.substr(1)));
4045
4046 if (!PT.Architecture.empty())
4047 Priority = std::max(Priority,
4048 TargInfo.multiVersionSortPriority(PT.Architecture));
4049 }
4050
4051 bool operator>(const MultiVersionResolverOption &Other) const {
4052 return Priority > Other.Priority;
4053 }
4054 };
4055 void EmitMultiVersionResolver(llvm::Function *Resolver,
4056 ArrayRef<MultiVersionResolverOption> Options);
4057
Reid Kleckner89077a12013-12-17 19:46:40 +00004058private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004059 QualType getVarArgType(const Expr *Arg);
4060
John McCall09ae0322010-07-06 23:57:41 +00004061 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00004062
John McCall7f416cc2015-09-08 08:05:57 +00004063 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
4064 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00004065
4066 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00004067
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00004068 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Erich Keane9937b132017-09-01 19:42:45 +00004069 llvm::Value *EmitX86CpuIs(const CallExpr *E);
4070 llvm::Value *EmitX86CpuIs(StringRef CPUStr);
4071 llvm::Value *EmitX86CpuSupports(const CallExpr *E);
4072 llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
Erich Keane1fe643a2017-10-06 16:40:45 +00004073 llvm::Value *EmitX86CpuInit();
Erich Keane281d20b2018-01-08 21:34:17 +00004074 llvm::Value *FormResolverCondition(const MultiVersionResolverOption &RO);
Chris Lattnerbed31442007-05-28 01:07:47 +00004075};
Mike Stump11289f42009-09-09 15:08:12 +00004076
John McCallce1de612011-01-26 04:00:11 +00004077/// Helper class with most of the code for saving a value for a
4078/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00004079struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00004080 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
4081
4082 /// Answer whether the given value needs extra work to be saved.
4083 static bool needsSaving(llvm::Value *value) {
4084 // If it's not an instruction, we don't need to save.
4085 if (!isa<llvm::Instruction>(value)) return false;
4086
4087 // If it's an instruction in the entry block, we don't need to save.
4088 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
4089 return (block != &block->getParent()->getEntryBlock());
4090 }
4091
4092 /// Try to save the given value.
4093 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
4094 if (!needsSaving(value)) return saved_type(value, false);
4095
John McCall7f416cc2015-09-08 08:05:57 +00004096 // Otherwise, we need an alloca.
4097 auto align = CharUnits::fromQuantity(
4098 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
4099 Address alloca =
4100 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00004101 CGF.Builder.CreateStore(value, alloca);
4102
John McCall7f416cc2015-09-08 08:05:57 +00004103 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00004104 }
4105
4106 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00004107 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00004108 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00004109
4110 // Otherwise, it should be an alloca instruction, as set up in save().
4111 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
4112 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00004113 }
4114};
4115
John McCallcb5f77f2011-01-28 10:53:53 +00004116/// A partial specialization of DominatingValue for llvm::Values that
4117/// might be llvm::Instructions.
4118template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
4119 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00004120 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00004121 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
4122 }
4123};
4124
John McCall7f416cc2015-09-08 08:05:57 +00004125/// A specialization of DominatingValue for Address.
4126template <> struct DominatingValue<Address> {
4127 typedef Address type;
4128
4129 struct saved_type {
4130 DominatingLLVMValue::saved_type SavedValue;
4131 CharUnits Alignment;
4132 };
4133
4134 static bool needsSaving(type value) {
4135 return DominatingLLVMValue::needsSaving(value.getPointer());
4136 }
4137 static saved_type save(CodeGenFunction &CGF, type value) {
4138 return { DominatingLLVMValue::save(CGF, value.getPointer()),
4139 value.getAlignment() };
4140 }
4141 static type restore(CodeGenFunction &CGF, saved_type value) {
4142 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
4143 value.Alignment);
4144 }
4145};
4146
John McCallcb5f77f2011-01-28 10:53:53 +00004147/// A specialization of DominatingValue for RValue.
4148template <> struct DominatingValue<RValue> {
4149 typedef RValue type;
4150 class saved_type {
4151 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
4152 AggregateAddress, ComplexAddress };
4153
4154 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00004155 unsigned K : 3;
4156 unsigned Align : 29;
4157 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
4158 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00004159
4160 public:
4161 static bool needsSaving(RValue value);
4162 static saved_type save(CodeGenFunction &CGF, RValue value);
4163 RValue restore(CodeGenFunction &CGF);
4164
John McCall7f416cc2015-09-08 08:05:57 +00004165 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00004166 };
4167
4168 static bool needsSaving(type value) {
4169 return saved_type::needsSaving(value);
4170 }
4171 static saved_type save(CodeGenFunction &CGF, type value) {
4172 return saved_type::save(CGF, value);
4173 }
4174 static type restore(CodeGenFunction &CGF, saved_type value) {
4175 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00004176 }
4177};
4178
Chris Lattnerbed31442007-05-28 01:07:47 +00004179} // end namespace CodeGen
4180} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00004181
Chris Lattnerbed31442007-05-28 01:07:47 +00004182#endif