blob: e1db4c74992a466e221ffaf306f16194ad3183bb [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 Bataev435ad7b2014-10-10 09:48:26 +0000696 /// \brief The scope used to remap some variables as private in the OpenMP
697 /// loop body (or other captured region emitted without outlining), and to
698 /// restore old vars back on exit.
699 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000700 DeclMapTy SavedLocals;
701 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000702
703 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000704 OMPPrivateScope(const OMPPrivateScope &) = delete;
705 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000706
707 public:
708 /// \brief Enter a new OpenMP private scope.
709 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
710
711 /// \brief Registers \a LocalVD variable as a private and apply \a
712 /// PrivateGen function for it to generate corresponding private variable.
713 /// \a PrivateGen returns an address of the generated private variable.
714 /// \return true if the variable is registered as private, false if it has
715 /// been privatized already.
716 bool
717 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000718 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000719 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000720
Alexey Bataev6a71f362017-08-22 17:54:52 +0000721 LocalVD = LocalVD->getCanonicalDecl();
John McCall7f416cc2015-09-08 08:05:57 +0000722 // Only save it once.
723 if (SavedLocals.count(LocalVD)) return false;
724
725 // Copy the existing local entry to SavedLocals.
726 auto it = CGF.LocalDeclMap.find(LocalVD);
727 if (it != CGF.LocalDeclMap.end()) {
728 SavedLocals.insert({LocalVD, it->second});
729 } else {
730 SavedLocals.insert({LocalVD, Address::invalid()});
731 }
732
733 // Generate the private entry.
734 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000735 QualType VarTy = LocalVD->getType();
736 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000737 Address Temp = CGF.CreateMemTemp(VarTy);
738 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
739 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000740 }
John McCall7f416cc2015-09-08 08:05:57 +0000741 SavedPrivates.insert({LocalVD, Addr});
742
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000743 return true;
744 }
745
746 /// \brief Privatizes local variables previously registered as private.
747 /// Registration is separate from the actual privatization to allow
748 /// initializers use values of the original variables, not the private one.
749 /// This is important, for example, if the private variable is a class
750 /// variable initialized by a constructor that references other private
751 /// variables. But at initialization original variables must be used, not
752 /// private copies.
753 /// \return true if at least one variable was privatized, false otherwise.
754 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000755 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000756 SavedPrivates.clear();
757 return !SavedLocals.empty();
758 }
759
760 void ForceCleanup() {
761 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000762 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000763 SavedLocals.clear();
764 }
765
766 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000767 ~OMPPrivateScope() {
768 if (PerformCleanup)
769 ForceCleanup();
770 }
John McCall7f416cc2015-09-08 08:05:57 +0000771
Gor Nishanov04491bd2017-11-11 17:00:43 +0000772 /// Checks if the global variable is captured in current function.
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000773 bool isGlobalVarCaptured(const VarDecl *VD) const {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000774 VD = VD->getCanonicalDecl();
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000775 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
776 }
777
John McCall7f416cc2015-09-08 08:05:57 +0000778 private:
779 /// Copy all the entries in the source map over the corresponding
780 /// entries in the destination, which must exist.
781 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
782 for (auto &pair : src) {
783 if (!pair.second.isValid()) {
784 dest.erase(pair.first);
785 continue;
786 }
787
788 auto it = dest.find(pair.first);
789 if (it != dest.end()) {
790 it->second = pair.second;
791 } else {
792 dest.insert(pair);
793 }
794 }
795 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000796 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000797
Richard Smith736a9472013-06-12 20:42:33 +0000798 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
799 /// that have been added.
Reid Kleckner092d0652017-03-06 22:18:34 +0000800 void
801 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
802 std::initializer_list<llvm::Value **> ValuesToReload = {});
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000803
Richard Smith736a9472013-06-12 20:42:33 +0000804 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
805 /// that have been added, then adds all lifetime-extended cleanups from
806 /// the given position to the stack.
Reid Kleckner092d0652017-03-06 22:18:34 +0000807 void
808 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
809 size_t OldLifetimeExtendedStackSize,
810 std::initializer_list<llvm::Value **> ValuesToReload = {});
Richard Smith736a9472013-06-12 20:42:33 +0000811
John McCallad5d61e2010-07-23 21:56:41 +0000812 void ResolveBranchFixups(llvm::BasicBlock *Target);
813
John McCallbd309292010-07-06 01:34:17 +0000814 /// The given basic block lies in the current EH scope, but may be a
815 /// target of a potentially scope-crossing jump; get a stable handle
816 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000817 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000818 return JumpDest(Target,
819 EHStack.getInnermostNormalCleanup(),
820 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000821 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000822
John McCallbd309292010-07-06 01:34:17 +0000823 /// The given basic block lies in the current EH scope, but may be a
824 /// target of a potentially scope-crossing jump; get a stable handle
825 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000826 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000827 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000828 }
829
830 /// EmitBranchThroughCleanup - Emit a branch from the current insert
831 /// block through the normal cleanup handling code (if any) and then
832 /// on to \arg Dest.
833 void EmitBranchThroughCleanup(JumpDest Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +0000834
Justin Bognere25ffdf2014-01-21 00:35:11 +0000835 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
836 /// specified destination obviously has no cleanups to run. 'false' is always
837 /// a conservatively correct answer for this method.
838 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
839
John McCall8e4c74b2011-08-11 02:22:43 +0000840 /// popCatchScope - Pops the catch scope at the top of the EHScope
841 /// stack, emitting any required code (other than the catch handlers
842 /// themselves).
843 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000844
David Chisnall9a837be2012-11-07 16:50:40 +0000845 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000846 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000847 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000848
John McCallce1de612011-01-26 04:00:11 +0000849 /// An object to manage conditionally-evaluated expressions.
850 class ConditionalEvaluation {
851 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000852
John McCallce1de612011-01-26 04:00:11 +0000853 public:
854 ConditionalEvaluation(CodeGenFunction &CGF)
855 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000856
John McCallce1de612011-01-26 04:00:11 +0000857 void begin(CodeGenFunction &CGF) {
858 assert(CGF.OutermostConditional != this);
859 if (!CGF.OutermostConditional)
860 CGF.OutermostConditional = this;
861 }
862
863 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000864 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000865 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000866 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000867 }
868
869 /// Returns a block which will be executed prior to each
870 /// evaluation of the conditional code.
871 llvm::BasicBlock *getStartingBlock() const {
872 return StartBB;
873 }
874 };
Mike Stump11289f42009-09-09 15:08:12 +0000875
John McCall7f9c92a2010-09-17 00:50:28 +0000876 /// isInConditionalBranch - Return true if we're currently emitting
877 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000878 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000879
John McCall7f416cc2015-09-08 08:05:57 +0000880 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000881 assert(isInConditionalBranch());
882 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000883 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
884 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000885 }
886
John McCallce1de612011-01-26 04:00:11 +0000887 /// An RAII object to record that we're evaluating a statement
888 /// expression.
889 class StmtExprEvaluation {
890 CodeGenFunction &CGF;
891
892 /// We have to save the outermost conditional: cleanups in a
893 /// statement expression aren't conditional just because the
894 /// StmtExpr is.
895 ConditionalEvaluation *SavedOutermostConditional;
896
897 public:
898 StmtExprEvaluation(CodeGenFunction &CGF)
899 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000900 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000901 }
902
903 ~StmtExprEvaluation() {
904 CGF.OutermostConditional = SavedOutermostConditional;
905 CGF.EnsureInsertPoint();
906 }
907 };
John McCall1bf58462011-02-16 08:02:54 +0000908
John McCallc07a0c72011-02-17 10:25:35 +0000909 /// An object which temporarily prevents a value from being
910 /// destroyed by aggressive peephole optimizations that assume that
911 /// all uses of a value have been realized in the IR.
912 class PeepholeProtection {
913 llvm::Instruction *Inst;
914 friend class CodeGenFunction;
915
916 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000917 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000918 };
John McCallc07a0c72011-02-17 10:25:35 +0000919
John McCallfe96e0b2011-11-06 09:01:30 +0000920 /// A non-RAII class containing all the information about a bound
921 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
922 /// this which makes individual mappings very simple; using this
923 /// class directly is useful when you have a variable number of
924 /// opaque values or don't want the RAII functionality for some
925 /// reason.
926 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000927 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000928 bool BoundLValue;
929 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000930
John McCallfe96e0b2011-11-06 09:01:30 +0000931 OpaqueValueMappingData(const OpaqueValueExpr *ov,
932 bool boundLValue)
933 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000934 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000935 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000936
John McCallc07a0c72011-02-17 10:25:35 +0000937 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000938 // gl-values should be bound as l-values for obvious reasons.
939 // Records should be bound as l-values because IR generation
940 // always keeps them in memory. Expressions of function type
941 // act exactly like l-values but are formally required to be
942 // r-values in C.
943 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000944 expr->getType()->isFunctionType() ||
945 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000946 }
947
John McCallfe96e0b2011-11-06 09:01:30 +0000948 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
949 const OpaqueValueExpr *ov,
950 const Expr *e) {
951 if (shouldBindAsLValue(ov))
952 return bind(CGF, ov, CGF.EmitLValue(e));
953 return bind(CGF, ov, CGF.EmitAnyExpr(e));
954 }
955
956 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
957 const OpaqueValueExpr *ov,
958 const LValue &lv) {
959 assert(shouldBindAsLValue(ov));
960 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
961 return OpaqueValueMappingData(ov, true);
962 }
963
964 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
965 const OpaqueValueExpr *ov,
966 const RValue &rv) {
967 assert(!shouldBindAsLValue(ov));
968 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
969
970 OpaqueValueMappingData data(ov, false);
971
972 // Work around an extremely aggressive peephole optimization in
973 // EmitScalarConversion which assumes that all other uses of a
974 // value are extant.
975 data.Protection = CGF.protectFromPeepholes(rv);
976
977 return data;
978 }
979
Craig Topper8a13c412014-05-21 05:09:00 +0000980 bool isValid() const { return OpaqueValue != nullptr; }
981 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000982
983 void unbind(CodeGenFunction &CGF) {
984 assert(OpaqueValue && "no data to unbind!");
985
986 if (BoundLValue) {
987 CGF.OpaqueLValues.erase(OpaqueValue);
988 } else {
989 CGF.OpaqueRValues.erase(OpaqueValue);
990 CGF.unprotectFromPeepholes(Protection);
991 }
992 }
993 };
994
995 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
996 class OpaqueValueMapping {
997 CodeGenFunction &CGF;
998 OpaqueValueMappingData Data;
999
1000 public:
1001 static bool shouldBindAsLValue(const Expr *expr) {
1002 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1003 }
1004
John McCallc07a0c72011-02-17 10:25:35 +00001005 /// Build the opaque value mapping for the given conditional
1006 /// operator if it's the GNU ?: extension. This is a common
1007 /// enough pattern that the convenience operator is really
1008 /// helpful.
1009 ///
1010 OpaqueValueMapping(CodeGenFunction &CGF,
1011 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +00001012 if (isa<ConditionalOperator>(op))
1013 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001014 return;
John McCallc07a0c72011-02-17 10:25:35 +00001015
1016 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001017 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1018 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001019 }
1020
Richard Smith410306b2016-12-12 02:53:20 +00001021 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1022 /// expression is set to the expression the OVE represents.
1023 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1024 : CGF(CGF) {
1025 if (OV) {
1026 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1027 "for OVE with no source expression");
1028 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1029 }
1030 }
1031
John McCall1bf58462011-02-16 08:02:54 +00001032 OpaqueValueMapping(CodeGenFunction &CGF,
1033 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001034 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001035 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001036 }
1037
1038 OpaqueValueMapping(CodeGenFunction &CGF,
1039 const OpaqueValueExpr *opaqueValue,
1040 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001041 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001042 }
1043
1044 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001045 Data.unbind(CGF);
1046 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001047 }
1048
1049 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001050 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001051 }
1052 };
Gor Nishanov04491bd2017-11-11 17:00:43 +00001053
Chris Lattner2da04b32007-08-24 05:35:26 +00001054private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001055 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001056 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001057
John McCall9b382dd2011-05-28 21:13:02 +00001058 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1059 /// calling llvm.stacksave for multiple VLAs in the same scope.
1060 bool DidCallStackSave;
1061
Mike Stumpe5311b02009-11-30 20:08:49 +00001062 /// IndirectBranch - The first time an indirect goto is seen we create a block
1063 /// with an indirect branch. Every time we see the address of a label taken,
1064 /// we add the label to the indirect goto. Every subsequent indirect goto is
1065 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +00001066 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001067
Mike Stumpfc496822009-02-08 23:14:22 +00001068 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1069 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001070 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001071
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001072 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1073 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1074 /// parameter.
1075 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1076 SizeArguments;
1077
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001078 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001079 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001080 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1081
Chris Lattnerac248202007-05-30 00:13:02 +00001082 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001083 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001084
Mike Stumpfc496822009-02-08 23:14:22 +00001085 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001086 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001087 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001088 BreakContinue(JumpDest Break, JumpDest Continue)
1089 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001090
John McCallbd309292010-07-06 01:34:17 +00001091 JumpDest BreakBlock;
1092 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001093 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001094 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001095
Alexey Bataev957d8562016-11-17 15:12:05 +00001096 /// Handles cancellation exit points in OpenMP-related constructs.
1097 class OpenMPCancelExitStack {
1098 /// Tracks cancellation exit point and join point for cancel-related exit
1099 /// and normal exit.
1100 struct CancelExit {
1101 CancelExit() = default;
1102 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1103 JumpDest ContBlock)
1104 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1105 OpenMPDirectiveKind Kind = OMPD_unknown;
1106 /// true if the exit block has been emitted already by the special
1107 /// emitExit() call, false if the default codegen is used.
1108 bool HasBeenEmitted = false;
1109 JumpDest ExitBlock;
1110 JumpDest ContBlock;
1111 };
1112
1113 SmallVector<CancelExit, 8> Stack;
1114
1115 public:
1116 OpenMPCancelExitStack() : Stack(1) {}
1117 ~OpenMPCancelExitStack() = default;
1118 /// Fetches the exit block for the current OpenMP construct.
1119 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1120 /// Emits exit block with special codegen procedure specific for the related
1121 /// OpenMP construct + emits code for normal construct cleanup.
1122 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1123 const llvm::function_ref<void(CodeGenFunction &)> &CodeGen) {
1124 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1125 assert(CGF.getOMPCancelDestination(Kind).isValid());
1126 assert(CGF.HaveInsertPoint());
1127 assert(!Stack.back().HasBeenEmitted);
1128 auto IP = CGF.Builder.saveAndClearIP();
1129 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1130 CodeGen(CGF);
Erich Keane0026ed22017-07-27 16:28:20 +00001131 CGF.EmitBranch(Stack.back().ContBlock.getBlock());
Alexey Bataev957d8562016-11-17 15:12:05 +00001132 CGF.Builder.restoreIP(IP);
1133 Stack.back().HasBeenEmitted = true;
1134 }
1135 CodeGen(CGF);
1136 }
1137 /// Enter the cancel supporting \a Kind construct.
1138 /// \param Kind OpenMP directive that supports cancel constructs.
1139 /// \param HasCancel true, if the construct has inner cancel directive,
1140 /// false otherwise.
1141 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1142 Stack.push_back({Kind,
1143 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1144 : JumpDest(),
1145 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1146 : JumpDest()});
1147 }
1148 /// Emits default exit point for the cancel construct (if the special one
1149 /// has not be used) + join point for cancel/normal exits.
1150 void exit(CodeGenFunction &CGF) {
1151 if (getExitBlock().isValid()) {
1152 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1153 bool HaveIP = CGF.HaveInsertPoint();
1154 if (!Stack.back().HasBeenEmitted) {
1155 if (HaveIP)
1156 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1157 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1158 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1159 }
1160 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1161 if (!HaveIP) {
1162 CGF.Builder.CreateUnreachable();
1163 CGF.Builder.ClearInsertionPoint();
1164 }
1165 }
1166 Stack.pop_back();
1167 }
1168 };
1169 OpenMPCancelExitStack OMPCancelStack;
1170
Justin Bogneref512b92014-01-06 22:27:43 +00001171 CodeGenPGO PGO;
1172
Justin Bogner65512642015-05-02 05:00:55 +00001173 /// Calculate branch weights appropriate for PGO data
1174 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1175 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1176 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1177 uint64_t LoopCount);
1178
Justin Bogneref512b92014-01-06 22:27:43 +00001179public:
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001180 /// Increment the profiler's counter for the given statement by \p StepV.
1181 /// If \p StepV is null, the default increment is 1.
1182 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
Rong Xu9837ef52016-02-04 18:39:09 +00001183 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001184 PGO.emitCounterIncrement(Builder, S, StepV);
Justin Bogner66242d62015-04-23 23:06:47 +00001185 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001186 }
Justin Bogner66242d62015-04-23 23:06:47 +00001187
1188 /// Get the profiler's count for the given statement.
1189 uint64_t getProfileCount(const Stmt *S) {
1190 Optional<uint64_t> Count = PGO.getStmtCount(S);
1191 if (!Count.hasValue())
1192 return 0;
1193 return *Count;
1194 }
1195
1196 /// Set the profiler's current count.
1197 void setCurrentProfileCount(uint64_t Count) {
1198 PGO.setCurrentRegionCount(Count);
1199 }
1200
1201 /// Get the profiler's current count. This is generally the count for the most
1202 /// recently incremented counter.
1203 uint64_t getCurrentProfileCount() {
1204 return PGO.getCurrentRegionCount();
1205 }
1206
Justin Bogneref512b92014-01-06 22:27:43 +00001207private:
1208
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001209 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001210 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001211 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001212 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1213 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001214
Mike Stumpfc496822009-02-08 23:14:22 +00001215 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001216 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001217 llvm::BasicBlock *CaseRangeBlock;
1218
John McCallc07a0c72011-02-17 10:25:35 +00001219 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001220 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001221 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1222 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001223
Mike Stumpfc496822009-02-08 23:14:22 +00001224 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001225 // We track this by the size expression rather than the type itself because
1226 // in certain situations, like a const qualifier applied to an VLA typedef,
1227 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001228 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1229 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001230 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001231
John McCallbd309292010-07-06 01:34:17 +00001232 /// A block containing a single 'unreachable' instruction. Created
1233 /// lazily by getUnreachableBlock().
1234 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001235
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001236 /// Counts of the number return expressions in the function.
1237 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001238
1239 /// Count the number of simple (constant) return expressions in the function.
1240 unsigned NumSimpleReturnExprs;
1241
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001242 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001243 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001244
Richard Smith852c9db2013-04-20 22:23:05 +00001245public:
1246 /// A scope within which we are constructing the fields of an object which
1247 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1248 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1249 class FieldConstructionScope {
1250 public:
John McCall7f416cc2015-09-08 08:05:57 +00001251 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001252 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1253 CGF.CXXDefaultInitExprThis = This;
1254 }
1255 ~FieldConstructionScope() {
1256 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1257 }
1258
1259 private:
1260 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001261 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001262 };
1263
1264 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1265 /// is overridden to be the object under construction.
1266 class CXXDefaultInitExprScope {
1267 public:
1268 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001269 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1270 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1271 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1272 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001273 }
1274 ~CXXDefaultInitExprScope() {
1275 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001276 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001277 }
1278
1279 public:
1280 CodeGenFunction &CGF;
1281 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001282 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001283 };
1284
Richard Smith410306b2016-12-12 02:53:20 +00001285 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1286 /// current loop index is overridden.
1287 class ArrayInitLoopExprScope {
1288 public:
1289 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1290 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1291 CGF.ArrayInitIndex = Index;
1292 }
1293 ~ArrayInitLoopExprScope() {
1294 CGF.ArrayInitIndex = OldArrayInitIndex;
1295 }
1296
1297 private:
1298 CodeGenFunction &CGF;
1299 llvm::Value *OldArrayInitIndex;
1300 };
1301
Richard Smith5179eb72016-06-28 19:03:57 +00001302 class InlinedInheritingConstructorScope {
1303 public:
1304 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1305 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1306 OldCurCodeDecl(CGF.CurCodeDecl),
1307 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1308 OldCXXABIThisValue(CGF.CXXABIThisValue),
1309 OldCXXThisValue(CGF.CXXThisValue),
1310 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1311 OldCXXThisAlignment(CGF.CXXThisAlignment),
1312 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1313 OldCXXInheritedCtorInitExprArgs(
1314 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1315 CGF.CurGD = GD;
1316 CGF.CurFuncDecl = CGF.CurCodeDecl =
1317 cast<CXXConstructorDecl>(GD.getDecl());
1318 CGF.CXXABIThisDecl = nullptr;
1319 CGF.CXXABIThisValue = nullptr;
1320 CGF.CXXThisValue = nullptr;
1321 CGF.CXXABIThisAlignment = CharUnits();
1322 CGF.CXXThisAlignment = CharUnits();
1323 CGF.ReturnValue = Address::invalid();
1324 CGF.FnRetTy = QualType();
1325 CGF.CXXInheritedCtorInitExprArgs.clear();
1326 }
1327 ~InlinedInheritingConstructorScope() {
1328 CGF.CurGD = OldCurGD;
1329 CGF.CurFuncDecl = OldCurFuncDecl;
1330 CGF.CurCodeDecl = OldCurCodeDecl;
1331 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1332 CGF.CXXABIThisValue = OldCXXABIThisValue;
1333 CGF.CXXThisValue = OldCXXThisValue;
1334 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1335 CGF.CXXThisAlignment = OldCXXThisAlignment;
1336 CGF.ReturnValue = OldReturnValue;
1337 CGF.FnRetTy = OldFnRetTy;
1338 CGF.CXXInheritedCtorInitExprArgs =
1339 std::move(OldCXXInheritedCtorInitExprArgs);
1340 }
1341
1342 private:
1343 CodeGenFunction &CGF;
1344 GlobalDecl OldCurGD;
1345 const Decl *OldCurFuncDecl;
1346 const Decl *OldCurCodeDecl;
1347 ImplicitParamDecl *OldCXXABIThisDecl;
1348 llvm::Value *OldCXXABIThisValue;
1349 llvm::Value *OldCXXThisValue;
1350 CharUnits OldCXXABIThisAlignment;
1351 CharUnits OldCXXThisAlignment;
1352 Address OldReturnValue;
1353 QualType OldFnRetTy;
1354 CallArgList OldCXXInheritedCtorInitExprArgs;
1355 };
1356
Richard Smith852c9db2013-04-20 22:23:05 +00001357private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001358 /// CXXThisDecl - When generating code for a C++ member function,
1359 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001360 ImplicitParamDecl *CXXABIThisDecl;
1361 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001362 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001363 CharUnits CXXABIThisAlignment;
1364 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001365
Richard Smith852c9db2013-04-20 22:23:05 +00001366 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1367 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001368 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001369
Richard Smith410306b2016-12-12 02:53:20 +00001370 /// The current array initialization index when evaluating an
1371 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1372 llvm::Value *ArrayInitIndex = nullptr;
1373
Richard Smith5179eb72016-06-28 19:03:57 +00001374 /// The values of function arguments to use when evaluating
1375 /// CXXInheritedCtorInitExprs within this context.
1376 CallArgList CXXInheritedCtorInitExprArgs;
1377
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001378 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1379 /// destructor, this will hold the implicit argument (e.g. VTT).
1380 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1381 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001382
John McCallce1de612011-01-26 04:00:11 +00001383 /// OutermostConditional - Points to the outermost active
1384 /// conditional control. This is used so that we know if a
1385 /// temporary should be destroyed conditionally.
1386 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001387
Nadav Rotem1da30942013-03-23 06:43:35 +00001388 /// The current lexical scope.
1389 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001390
Adrian Prantldc237b52013-05-16 00:41:26 +00001391 /// The current source location that should be used for exception
1392 /// handling code.
1393 SourceLocation CurEHLocation;
1394
John McCall7f416cc2015-09-08 08:05:57 +00001395 /// BlockByrefInfos - For each __block variable, contains
1396 /// information about the layout of the variable.
1397 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001398
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001399 /// Used by -fsanitize=nullability-return to determine whether the return
1400 /// value can be checked.
1401 llvm::Value *RetValNullabilityPrecondition = nullptr;
1402
1403 /// Check if -fsanitize=nullability-return instrumentation is required for
1404 /// this function.
1405 bool requiresReturnValueNullabilityCheck() const {
1406 return RetValNullabilityPrecondition;
1407 }
1408
Vedant Kumarc34d3432017-06-23 21:32:38 +00001409 /// Used to store precise source locations for return statements by the
1410 /// runtime return value checks.
1411 Address ReturnLocation = Address::invalid();
1412
1413 /// Check if the return value of this function requires sanitization.
1414 bool requiresReturnValueCheck() const {
1415 return requiresReturnValueNullabilityCheck() ||
1416 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
1417 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
1418 }
1419
John McCallbd309292010-07-06 01:34:17 +00001420 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001421 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001422 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001423
Reid Kleckner06f19a02018-01-02 21:34:16 +00001424 /// Terminate funclets keyed by parent funclet pad.
1425 llvm::MapVector<llvm::Value *, llvm::BasicBlock *> TerminateFunclets;
1426
Vitaly Buka1c943322016-10-26 01:59:57 +00001427 /// True if we need emit the life-time markers.
1428 const bool ShouldEmitLifetimeMarkers;
1429
Xiuli Panbe6da4b2017-05-04 07:31:20 +00001430 /// Add OpenCL kernel arg metadata and the kernel attribute meatadata to
1431 /// the function metadata.
Gor Nishanov04491bd2017-11-11 17:00:43 +00001432 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001433 llvm::Function *Fn);
1434
Chris Lattnerbed31442007-05-28 01:07:47 +00001435public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001436 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001437 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001438
John McCall8ed55a52010-09-02 09:58:18 +00001439 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001440 ASTContext &getContext() const { return CGM.getContext(); }
Gor Nishanov04491bd2017-11-11 17:00:43 +00001441 CGDebugInfo *getDebugInfo() {
1442 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001443 return nullptr;
Gor Nishanov04491bd2017-11-11 17:00:43 +00001444 return DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001445 }
1446 void disableDebugInfo() { DisableDebugInfo = true; }
1447 void enableDebugInfo() { DisableDebugInfo = false; }
1448
John McCall31168b02011-06-15 23:02:42 +00001449 bool shouldUseFusedARCCalls() {
1450 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1451 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001452
David Blaikiebbafb8a2012-03-11 07:00:24 +00001453 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001454
Bill Wendlingf0724e82011-09-19 20:31:14 +00001455 /// Returns a pointer to the function's exception object and selector slot,
1456 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001457 Address getExceptionSlot();
1458 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001459
Bill Wendling79a70e42011-09-15 18:57:19 +00001460 /// Returns the contents of the function's exception object and selector
1461 /// slots.
1462 llvm::Value *getExceptionFromSlot();
1463 llvm::Value *getSelectorFromSlot();
1464
John McCall7f416cc2015-09-08 08:05:57 +00001465 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001466
John McCallbd309292010-07-06 01:34:17 +00001467 llvm::BasicBlock *getUnreachableBlock() {
1468 if (!UnreachableBlock) {
1469 UnreachableBlock = createBasicBlock("unreachable");
1470 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1471 }
1472 return UnreachableBlock;
1473 }
1474
1475 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001476 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001477 return getInvokeDestImpl();
1478 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001479
David Majnemer25eb1652016-03-01 19:42:53 +00001480 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001481
John McCallc8e01702013-04-16 22:48:15 +00001482 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001483 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Yaxun Liucbf647c2017-07-08 13:24:52 +00001484 const TargetCodeGenInfo &getTargetHooks() const {
1485 return CGM.getTargetCodeGenInfo();
1486 }
Owen Andersonae86c192009-07-13 04:10:07 +00001487
Daniel Dunbar12347492009-02-23 17:26:39 +00001488 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001489 // Cleanups
1490 //===--------------------------------------------------------------------===//
1491
John McCall7f416cc2015-09-08 08:05:57 +00001492 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001493
John McCall178360e2011-07-11 08:38:19 +00001494 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001495 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001496 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001497 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001498 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001499 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1500 llvm::Value *arrayEnd,
1501 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001502 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001503 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001504
John McCall4bd0fb12011-07-12 16:41:08 +00001505 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001506 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001507 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001508 Address addr, QualType type);
1509 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001510 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001511 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001512 QualType type, Destroyer *destroyer,
1513 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001514 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1515 llvm::Value *CompletePtr,
1516 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001517 void pushStackRestore(CleanupKind kind, Address SPMem);
1518 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001519 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001520 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001521 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001522 bool useEHCleanupForArray,
1523 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001524 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001525 QualType elementType, CharUnits elementAlign,
1526 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001527 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001528
Peter Collingbourne1425b452012-01-26 03:33:36 +00001529 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001530
John McCall82fe67b2011-07-09 01:37:26 +00001531 /// Determines whether an EH cleanup is required to destroy a type
1532 /// with the given destruction kind.
1533 bool needsEHCleanup(QualType::DestructionKind kind) {
1534 switch (kind) {
1535 case QualType::DK_none:
1536 return false;
1537 case QualType::DK_cxx_destructor:
1538 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001539 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001540 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001541 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001542 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1543 }
1544 llvm_unreachable("bad destruction kind");
1545 }
1546
John McCall4bd0fb12011-07-12 16:41:08 +00001547 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1548 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1549 }
1550
John McCall82fe67b2011-07-09 01:37:26 +00001551 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001552 // Objective-C
1553 //===--------------------------------------------------------------------===//
1554
Chris Lattner4bd55962008-03-30 23:03:07 +00001555 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001556
David Blaikief1425802015-01-14 00:04:42 +00001557 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001558
Mike Stumpfc496822009-02-08 23:14:22 +00001559 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001560 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1561 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001562 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001563 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001564 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001565 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001566
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001567 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1568 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001569
Mike Stumpfc496822009-02-08 23:14:22 +00001570 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1571 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001572 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1573 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001574 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001575 const ObjCPropertyImplDecl *propImpl,
1576 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001577
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001578 //===--------------------------------------------------------------------===//
1579 // Block Bits
1580 //===--------------------------------------------------------------------===//
1581
Yaxun Liuc2a87a02017-10-14 12:23:50 +00001582 /// Emit block literal.
1583 /// \return an LLVM value which is a pointer to a struct which contains
1584 /// information about the block, including the block invoke function, the
1585 /// captured variables, etc.
1586 /// \param InvokeF will contain the block invoke function if it is not
1587 /// nullptr.
1588 llvm::Value *EmitBlockLiteral(const BlockExpr *,
1589 llvm::Function **InvokeF = nullptr);
John McCall08ef4662011-11-10 08:15:53 +00001590 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001591
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001592 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001593 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001594 const DeclMapTy &ldm,
Akira Hatanakaba0367a2017-09-22 21:32:06 +00001595 bool IsLambdaConversionToBlock,
1596 bool BuildGlobalBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001597
John McCallad7c5c12011-02-08 08:22:06 +00001598 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1599 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001600 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1601 const ObjCPropertyImplDecl *PID);
1602 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1603 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001604 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001605
John McCallad7c5c12011-02-08 08:22:06 +00001606 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1607
John McCall73064872011-03-31 01:59:53 +00001608 class AutoVarEmission;
1609
1610 void emitByrefStructureInit(const AutoVarEmission &emission);
1611 void enterByrefCleanup(const AutoVarEmission &emission);
1612
John McCall7f416cc2015-09-08 08:05:57 +00001613 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1614 llvm::Value *ptr);
1615
1616 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001617 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1618
1619 /// BuildBlockByrefAddress - Computes the location of the
1620 /// data in a variable which is declared as __block.
1621 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1622 bool followForward = true);
1623 Address emitBlockByrefAddress(Address baseAddr,
1624 const BlockByrefInfo &info,
1625 bool followForward,
1626 const llvm::Twine &name);
1627
1628 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001629
Richard Smith5179eb72016-06-28 19:03:57 +00001630 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1631
John McCalla738c252011-03-09 04:27:21 +00001632 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1633 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001634 /// \brief Emit code for the start of a function.
1635 /// \param Loc The location to be associated with the function.
1636 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001637 void StartFunction(GlobalDecl GD,
1638 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001639 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001640 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001641 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001642 SourceLocation Loc = SourceLocation(),
1643 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001644
Vedant Kumar7f809b22017-02-24 01:15:19 +00001645 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1646
John McCallb81884d2010-02-19 09:25:03 +00001647 void EmitConstructorBody(FunctionArgList &Args);
1648 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001649 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001650 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001651 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001652
Faisal Vali571df122013-09-29 08:45:24 +00001653 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001654 CallArgList &CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00001655 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001656 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001657 void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001658 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001659
David Blaikiea0a1a872015-01-18 02:48:07 +00001660 /// \brief Emit the unified return block, trying to avoid its emission when
1661 /// possible.
1662 /// \return The debug location of the user written return statement if the
1663 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001664 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001665
Mike Stumpfc496822009-02-08 23:14:22 +00001666 /// FinishFunction - Complete IR generation of the current function. It is
1667 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001668 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001669
Nico Weber1bebad12015-02-11 22:33:32 +00001670 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1671 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001672
John McCallb92ab1a2016-10-26 23:46:34 +00001673 void EmitCallAndReturnForThunk(llvm::Constant *Callee,
1674 const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001675
John McCall7f416cc2015-09-08 08:05:57 +00001676 void FinishThunk();
1677
Reid Klecknerab2090d2014-07-26 01:34:32 +00001678 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1679 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1680 llvm::Value *Callee);
1681
Rafael Espindolad6e66942015-07-13 06:07:58 +00001682 /// Generate a thunk for the given method.
1683 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001684 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001685
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001686 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1687 const CGFunctionInfo &FnInfo,
1688 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001689
Douglas Gregor94f9a482010-05-05 05:51:00 +00001690 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1691 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001692
Richard Smith30e304e2016-12-14 00:03:17 +00001693 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001694
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001695 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1696 struct VPtr {
1697 BaseSubobject Base;
1698 const CXXRecordDecl *NearestVBase;
1699 CharUnits OffsetFromNearestVBase;
1700 const CXXRecordDecl *VTableClass;
1701 };
1702
1703 /// Initialize the vtable pointer of the given subobject.
1704 void InitializeVTablePointer(const VPtr &vptr);
1705
1706 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001707
1708 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001709 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1710
1711 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1712 CharUnits OffsetFromNearestVBase,
1713 bool BaseIsNonVirtualPrimaryBase,
1714 const CXXRecordDecl *VTableClass,
1715 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001716
Anders Carlssond5895932010-03-28 21:07:49 +00001717 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001718
Dan Gohman8fc50c22010-10-26 18:44:08 +00001719 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1720 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001721 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1722 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001723
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001724 enum CFITypeCheckKind {
1725 CFITCK_VCall,
1726 CFITCK_NVCall,
1727 CFITCK_DerivedCast,
1728 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001729 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001730 };
1731
Peter Collingbourned2926c92015-03-14 02:42:25 +00001732 /// \brief Derived is the presumed address of an object of type T after a
1733 /// cast. If T is a polymorphic class type, emit a check that the virtual
1734 /// table for Derived belongs to a class derived from T.
1735 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001736 bool MayBeNull, CFITypeCheckKind TCK,
1737 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001738
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001739 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1740 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001741 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001742 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001743
Peter Collingbourned2926c92015-03-14 02:42:25 +00001744 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001745 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001746 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1747 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001748
Peter Collingbournefb532b92016-02-24 20:46:36 +00001749 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001750 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1751 /// enabled, emit a check that VTable is a member of RD's type identifier.
1752 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1753 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001754
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001755 /// Returns whether we should perform a type checked load when loading a
1756 /// virtual function for virtual calls to members of RD. This is generally
1757 /// true when both vcall CFI and whole-program-vtables are enabled.
1758 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1759
1760 /// Emit a type checked load from the given vtable.
1761 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1762 uint64_t VTableByteOffset);
1763
John McCallf99a6312010-07-21 05:30:47 +00001764 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1765 /// given phase of destruction for a destructor. The end result
1766 /// should call destructors on members and base classes in reverse
1767 /// order of their construction.
1768 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001769
Chris Lattner3c77a352010-06-22 00:03:40 +00001770 /// ShouldInstrumentFunction - Return true if the current function should be
1771 /// instrumented with __cyg_profile_func_* calls
1772 bool ShouldInstrumentFunction();
1773
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001774 /// ShouldXRayInstrument - Return true if the current function should be
1775 /// instrumented with XRay nop sleds.
1776 bool ShouldXRayInstrumentFunction() const;
1777
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +00001778 /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
1779 /// XRay custom event handling calls.
1780 bool AlwaysEmitXRayCustomEvents() const;
1781
Vedant Kumarbb5d4852017-09-13 00:04:35 +00001782 /// Encode an address into a form suitable for use in a function prologue.
1783 llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
1784 llvm::Constant *Addr);
1785
1786 /// Decode an address used in a function prologue, encoded by \c
1787 /// EncodeAddrForUseInPrologue.
1788 llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
1789 llvm::Value *EncodedAddr);
1790
Mike Stumpfc496822009-02-08 23:14:22 +00001791 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1792 /// arguments for the given function. This is also responsible for naming the
1793 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001794 void EmitFunctionProlog(const CGFunctionInfo &FI,
1795 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001796 const FunctionArgList &Args);
1797
Mike Stumpfc496822009-02-08 23:14:22 +00001798 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1799 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001800 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1801 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001802
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001803 /// Emit a test that checks if the return value \p RV is nonnull.
Vedant Kumarc34d3432017-06-23 21:32:38 +00001804 void EmitReturnValueCheck(llvm::Value *RV);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001805
Mike Stump1d849212009-12-07 23:38:24 +00001806 /// EmitStartEHSpec - Emit the start of the exception spec.
1807 void EmitStartEHSpec(const Decl *D);
1808
1809 /// EmitEndEHSpec - Emit the end of the exception spec.
1810 void EmitEndEHSpec(const Decl *D);
1811
John McCallbd309292010-07-06 01:34:17 +00001812 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1813 llvm::BasicBlock *getTerminateLandingPad();
1814
Reid Kleckner06f19a02018-01-02 21:34:16 +00001815 /// getTerminateLandingPad - Return a cleanup funclet that just calls
1816 /// terminate.
1817 llvm::BasicBlock *getTerminateFunclet();
1818
John McCallbd309292010-07-06 01:34:17 +00001819 /// getTerminateHandler - Return a handler (not a landing pad, just
1820 /// a catch handler) that just calls terminate. This is used when
1821 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001822 llvm::BasicBlock *getTerminateHandler();
1823
Chris Lattnera5f58b02011-07-09 17:41:47 +00001824 llvm::Type *ConvertTypeForMem(QualType T);
1825 llvm::Type *ConvertType(QualType T);
1826 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001827 return ConvertType(getContext().getTypeDeclType(T));
1828 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001829
Mike Stumpfc496822009-02-08 23:14:22 +00001830 /// LoadObjCSelf - Load the value of self. This function is only valid while
1831 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001832 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001833
1834 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001835 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001836
Krasimir Georgiev46dfb7a2017-09-08 13:44:51 +00001837 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
John McCall47fb9502013-03-07 21:37:08 +00001838 static TypeEvaluationKind getEvaluationKind(QualType T);
1839
1840 static bool hasScalarEvaluationKind(QualType T) {
1841 return getEvaluationKind(T) == TEK_Scalar;
1842 }
1843
1844 static bool hasAggregateEvaluationKind(QualType T) {
1845 return getEvaluationKind(T) == TEK_Aggregate;
1846 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001847
1848 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001849 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001850 llvm::Function *parent = nullptr,
1851 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001852#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001853 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001854#else
John McCallad7c5c12011-02-08 08:22:06 +00001855 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001856#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001857 }
Mike Stumpfc496822009-02-08 23:14:22 +00001858
Chris Lattnerac248202007-05-30 00:13:02 +00001859 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1860 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001861 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001862
Mike Stumpe5311b02009-11-30 20:08:49 +00001863 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1864 /// another basic block, simplify it. This assumes that no other code could
1865 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001866 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1867
Mike Stumpfc496822009-02-08 23:14:22 +00001868 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1869 /// adding a fall-through branch from the current insert block if
1870 /// necessary. It is legal to call this function even if there is no current
1871 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001872 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001873 /// IsFinished - If true, indicates that the caller has finished emitting
1874 /// branches to the given block and does not expect to emit code into it. This
1875 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001876 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001877
John McCall8e4c74b2011-08-11 02:22:43 +00001878 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1879 /// near its uses, and leave the insertion point in it.
1880 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1881
Mike Stumpfc496822009-02-08 23:14:22 +00001882 /// EmitBranch - Emit a branch to the specified basic block from the current
1883 /// insert block, taking care to avoid creation of branches from dummy
1884 /// blocks. It is legal to call this function even if there is no current
1885 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001886 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001887 /// This function clears the current insertion point. The caller should follow
1888 /// calls to this function with calls to Emit*Block prior to generation new
1889 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001890 void EmitBranch(llvm::BasicBlock *Block);
1891
Mike Stumpfc496822009-02-08 23:14:22 +00001892 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1893 /// indicates that the current code being emitted is unreachable.
1894 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001895 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001896 }
1897
Mike Stumpfc496822009-02-08 23:14:22 +00001898 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1899 /// emitted IR has a place to go. Note that by definition, if this function
1900 /// creates a block then that block is unreachable; callers may do better to
1901 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001902 void EnsureInsertPoint() {
1903 if (!HaveInsertPoint())
1904 EmitBlock(createBasicBlock());
1905 }
Mike Stumpfc496822009-02-08 23:14:22 +00001906
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001907 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001908 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001909 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001910
Chris Lattnere9a64532007-06-22 21:44:33 +00001911 //===--------------------------------------------------------------------===//
1912 // Helpers
1913 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001914
John McCall7f416cc2015-09-08 08:05:57 +00001915 LValue MakeAddrLValue(Address Addr, QualType T,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001916 AlignmentSource Source = AlignmentSource::Type) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00001917 return LValue::MakeAddr(Addr, T, getContext(), LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001918 CGM.getTBAAAccessInfo(T));
1919 }
1920
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001921 LValue MakeAddrLValue(Address Addr, QualType T, LValueBaseInfo BaseInfo,
1922 TBAAAccessInfo TBAAInfo) {
1923 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001924 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001925
John McCall7f416cc2015-09-08 08:05:57 +00001926 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001927 AlignmentSource Source = AlignmentSource::Type) {
1928 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00001929 LValueBaseInfo(Source), CGM.getTBAAAccessInfo(T));
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001930 }
1931
1932 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001933 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00001934 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001935 BaseInfo, TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +00001936 }
1937
1938 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001939 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001940 CharUnits getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001941 LValueBaseInfo *BaseInfo = nullptr,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +00001942 TBAAAccessInfo *TBAAInfo = nullptr,
John McCall7f416cc2015-09-08 08:05:57 +00001943 bool forPointeeType = false);
1944 CharUnits getNaturalPointeeTypeAlignment(QualType T,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00001945 LValueBaseInfo *BaseInfo = nullptr,
1946 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001947
Ivan A. Kosarev9f9d1572017-10-30 11:49:31 +00001948 Address EmitLoadOfReference(LValue RefLVal,
1949 LValueBaseInfo *PointeeBaseInfo = nullptr,
1950 TBAAAccessInfo *PointeeTBAAInfo = nullptr);
1951 LValue EmitLoadOfReferenceLValue(LValue RefLVal);
1952 LValue EmitLoadOfReferenceLValue(Address RefAddr, QualType RefTy,
1953 AlignmentSource Source =
1954 AlignmentSource::Type) {
1955 LValue RefLVal = MakeAddrLValue(RefAddr, RefTy, LValueBaseInfo(Source),
1956 CGM.getTBAAAccessInfo(RefTy));
1957 return EmitLoadOfReferenceLValue(RefLVal);
1958 }
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001959
Alexey Bataev31300ed2016-02-04 11:27:03 +00001960 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
Ivan A. Kosarev90295642017-10-13 16:47:22 +00001961 LValueBaseInfo *BaseInfo = nullptr,
1962 TBAAAccessInfo *TBAAInfo = nullptr);
Alexey Bataev31300ed2016-02-04 11:27:03 +00001963 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1964
Yaxun Liu84744c12017-06-19 17:03:41 +00001965 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
1966 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
1967 /// insertion point of the builder. The caller is responsible for setting an
1968 /// appropriate alignment on
Daniel Dunbara7566f12010-02-09 02:48:28 +00001969 /// the alloca.
Yaxun Liu84744c12017-06-19 17:03:41 +00001970 ///
1971 /// \p ArraySize is the number of array elements to be allocated if it
1972 /// is not nullptr.
1973 ///
1974 /// LangAS::Default is the address space of pointers to local variables and
1975 /// temporaries, as exposed in the source language. In certain
1976 /// configurations, this is not the same as the alloca address space, and a
1977 /// cast is needed to lift the pointer from the alloca AS into
1978 /// LangAS::Default. This can happen when the target uses a restricted
1979 /// address space for the stack but the source language requires
1980 /// LangAS::Default to be a generic address space. The latter condition is
1981 /// common for most programming languages; OpenCL is an exception in that
1982 /// LangAS::Default is the private address space, which naturally maps
1983 /// to the stack.
1984 ///
1985 /// Because the address of a temporary is often exposed to the program in
1986 /// various ways, this function will perform the cast by default. The cast
1987 /// may be avoided by passing false as \p CastToDefaultAddrSpace; this is
1988 /// more efficient if the caller knows that the address will not be exposed.
1989 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
1990 llvm::Value *ArraySize = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001991 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
Yaxun Liu84744c12017-06-19 17:03:41 +00001992 const Twine &Name = "tmp",
1993 llvm::Value *ArraySize = nullptr,
1994 bool CastToDefaultAddrSpace = true);
Mike Stumpfc496822009-02-08 23:14:22 +00001995
John McCall7f416cc2015-09-08 08:05:57 +00001996 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1997 /// default ABI alignment of the given LLVM type.
1998 ///
1999 /// IMPORTANT NOTE: This is *not* generally the right alignment for
2000 /// any given AST type that happens to have been lowered to the
2001 /// given IR type. This should only ever be used for function-local,
2002 /// IR-driven manipulations like saving and restoring a value. Do
2003 /// not hand this address off to arbitrary IRGen routines, and especially
2004 /// do not pass it as an argument to a function that might expect a
2005 /// properly ABI-aligned value.
2006 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
2007 const Twine &Name = "tmp");
2008
2009 /// InitTempAlloca - Provide an initial value for the given alloca which
2010 /// will be observable at all locations in the function.
2011 ///
2012 /// The address should be something that was returned from one of
2013 /// the CreateTempAlloca or CreateMemTemp routines, and the
2014 /// initializer must be valid in the entry block (i.e. it must
2015 /// either be a constant or an argument value).
2016 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00002017
Daniel Dunbard0049182010-02-16 19:44:13 +00002018 /// CreateIRTemp - Create a temporary IR object of the given type, with
2019 /// appropriate alignment. This routine should only be used when an temporary
2020 /// value needs to be stored into an alloca (for example, to avoid explicit
2021 /// PHI construction), but the type is the IR type, not the type appropriate
2022 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00002023 ///
2024 /// That is, this is exactly equivalent to CreateMemTemp, but calling
2025 /// ConvertType instead of ConvertTypeForMem.
2026 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00002027
Daniel Dunbara7566f12010-02-09 02:48:28 +00002028 /// CreateMemTemp - Create a temporary memory object of the given type, with
Yaxun Liu84744c12017-06-19 17:03:41 +00002029 /// appropriate alignment. Cast it to the default address space if
2030 /// \p CastToDefaultAddrSpace is true.
2031 Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
2032 bool CastToDefaultAddrSpace = true);
2033 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
2034 bool CastToDefaultAddrSpace = true);
Daniel Dunbara7566f12010-02-09 02:48:28 +00002035
John McCall7a626f62010-09-15 10:14:12 +00002036 /// CreateAggTemp - Create a temporary memory object for the given
2037 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00002038 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00002039 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00002040 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00002041 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00002042 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002043 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00002044 }
2045
John McCallad7c5c12011-02-08 08:22:06 +00002046 /// Emit a cast to void* in the appropriate address space.
2047 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2048
Chris Lattner8394d792007-06-05 20:53:16 +00002049 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2050 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00002051 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00002052
John McCalla2342eb2010-12-05 02:00:02 +00002053 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2054 void EmitIgnoredExpr(const Expr *E);
2055
Chris Lattner4647a212007-08-31 22:49:20 +00002056 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2057 /// any type. The result is returned as an RValue struct. If this is an
2058 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2059 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00002060 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00002061 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00002062 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00002063 AggValueSlot aggSlot = AggValueSlot::ignored(),
2064 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00002065
Mike Stumpfc496822009-02-08 23:14:22 +00002066 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2067 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00002068 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002069
Charles Davisc7d5c942015-09-17 20:55:33 +00002070 /// Emit a "reference" to a __builtin_ms_va_list; this is
2071 /// always the value of the expression, because a __builtin_ms_va_list is a
2072 /// pointer to a char.
2073 Address EmitMSVAListRef(const Expr *E);
2074
Gor Nishanov5eb58582017-03-26 02:18:05 +00002075 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
Mike Stumpfc496822009-02-08 23:14:22 +00002076 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00002077 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00002078
John McCall91ca10f2011-03-08 09:11:50 +00002079 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00002080 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00002081 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002082 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00002083
John McCall7f416cc2015-09-08 08:05:57 +00002084 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00002085
John McCall91ca10f2011-03-08 09:11:50 +00002086 /// EmitExprAsInit - Emits the code necessary to initialize a
2087 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00002088 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002089 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00002090
Fariborz Jahanian78652202013-01-25 23:57:05 +00002091 /// hasVolatileMember - returns true if aggregate type has a volatile
2092 /// member.
2093 bool hasVolatileMember(QualType T) {
2094 if (const RecordType *RT = T->getAs<RecordType>()) {
2095 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2096 return RD->hasVolatileMember();
2097 }
2098 return false;
2099 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002100 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002101 ///
2102 /// The difference to EmitAggregateCopy is that tail padding is not copied.
2103 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00002104 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00002105 QualType EltTy) {
2106 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00002107 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002108 }
2109
John McCall7f416cc2015-09-08 08:05:57 +00002110 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
2111 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00002112 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00002113 /*IsAssignment=*/false);
2114 }
2115
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002116 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00002117 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00002118 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00002119 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002120 /// \param isAssignment - If false, allow padding to be copied. This often
2121 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00002122 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00002123 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002124 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00002125
Anders Carlsson9396a892008-09-11 09:15:33 +00002126 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00002127 Address GetAddrOfLocalVar(const VarDecl *VD) {
2128 auto it = LocalDeclMap.find(VD);
2129 assert(it != LocalDeclMap.end() &&
2130 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2131 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00002132 }
Mike Stumpfc496822009-02-08 23:14:22 +00002133
John McCallc07a0c72011-02-17 10:25:35 +00002134 /// getOpaqueLValueMapping - Given an opaque value expression (which
2135 /// must be mapped to an l-value), return its mapping.
2136 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
2137 assert(OpaqueValueMapping::shouldBindAsLValue(e));
2138
2139 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
2140 it = OpaqueLValues.find(e);
2141 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
2142 return it->second;
2143 }
2144
2145 /// getOpaqueRValueMapping - Given an opaque value expression (which
2146 /// must be mapped to an r-value), return its mapping.
2147 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
2148 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
2149
2150 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
2151 it = OpaqueRValues.find(e);
2152 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00002153 return it->second;
2154 }
2155
Richard Smith410306b2016-12-12 02:53:20 +00002156 /// Get the index of the current ArrayInitLoopExpr, if any.
2157 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2158
Dan Gohman75d69da2008-05-22 00:50:06 +00002159 /// getAccessedFieldNo - Given an encoded value and a result number, return
2160 /// the input field number being accessed.
2161 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2162
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002163 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002164 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002165
Vedant Kumarffd7c882017-04-14 22:03:34 +00002166 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2167 static bool IsWrappedCXXThis(const Expr *E);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00002168
Anders Carlssonc0964b62010-05-22 17:35:42 +00002169 /// EmitNullInitialization - Generate code to set a value of the given type to
2170 /// null, If the type contains data member pointers, they will be initialized
2171 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002172 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002173
Charles Davisc7d5c942015-09-17 20:55:33 +00002174 /// Emits a call to an LLVM variable-argument intrinsic, either
2175 /// \c llvm.va_start or \c llvm.va_end.
2176 /// \param ArgValue A reference to the \c va_list as emitted by either
2177 /// \c EmitVAListRef or \c EmitMSVAListRef.
2178 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2179 /// calls \c llvm.va_end.
2180 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2181
2182 /// Generate code to get an argument from the passed in pointer
2183 /// and update it accordingly.
2184 /// \param VE The \c VAArgExpr for which to generate code.
2185 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2186 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2187 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002188 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002189 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002190 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002191
John McCall82fe67b2011-07-09 01:37:26 +00002192 /// emitArrayLength - Compute the length of an array, even if it's a
2193 /// VLA, and drill down to the base element type.
2194 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2195 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002196 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002197
John McCall23c29fe2011-06-24 21:55:10 +00002198 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2199 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002200 ///
2201 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002202 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002203
John McCall23c29fe2011-06-24 21:55:10 +00002204 /// getVLASize - Returns an LLVM value that corresponds to the size,
2205 /// in non-variably-sized elements, of a variable length array type,
2206 /// plus that largest non-variably-sized element type. Assumes that
2207 /// the type has already been emitted with EmitVariablyModifiedType.
2208 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
2209 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002210
Anders Carlssona5d077d2009-04-14 16:58:56 +00002211 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2212 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002213 llvm::Value *LoadCXXThis() {
2214 assert(CXXThisValue && "no 'this' value for this function");
2215 return CXXThisValue;
2216 }
John McCall7f416cc2015-09-08 08:05:57 +00002217 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002218
Anders Carlssone36a6b32010-01-02 01:01:18 +00002219 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2220 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002221 // FIXME: Every place that calls LoadCXXVTT is something
2222 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002223 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002224 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2225 return CXXStructorImplicitParamValue;
2226 }
2227
John McCall6ce74722010-02-16 04:15:37 +00002228 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002229 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002230 Address
2231 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002232 const CXXRecordDecl *Derived,
2233 const CXXRecordDecl *Base,
2234 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002235
John McCall7f416cc2015-09-08 08:05:57 +00002236 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2237
Mike Stumpe5311b02009-11-30 20:08:49 +00002238 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2239 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002240 Address GetAddressOfBaseClass(Address Value,
2241 const CXXRecordDecl *Derived,
2242 CastExpr::path_const_iterator PathBegin,
2243 CastExpr::path_const_iterator PathEnd,
2244 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002245
John McCall7f416cc2015-09-08 08:05:57 +00002246 Address GetAddressOfDerivedClass(Address Value,
2247 const CXXRecordDecl *Derived,
2248 CastExpr::path_const_iterator PathBegin,
2249 CastExpr::path_const_iterator PathEnd,
2250 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002251
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002252 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2253 /// base constructor/destructor with virtual bases.
2254 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2255 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2256 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2257 bool Delegating);
2258
John McCallf8ff7b92010-02-23 00:48:20 +00002259 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2260 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002261 const FunctionArgList &Args,
2262 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002263 // It's important not to confuse this and the previous function. Delegating
2264 // constructors are the C++0x feature. The constructor delegate optimization
2265 // is used to reduce duplication in the base and complete consturctors where
2266 // they are substantially the same.
2267 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2268 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002269
Richard Smith5179eb72016-06-28 19:03:57 +00002270 /// Emit a call to an inheriting constructor (that is, one that invokes a
2271 /// constructor inherited from a base class) by inlining its definition. This
2272 /// is necessary if the ABI does not support forwarding the arguments to the
2273 /// base class constructor (because they're variadic or similar).
2274 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2275 CXXCtorType CtorType,
2276 bool ForVirtualBase,
2277 bool Delegating,
2278 CallArgList &Args);
2279
2280 /// Emit a call to a constructor inherited from a base class, passing the
2281 /// current constructor's arguments along unmodified (without even making
2282 /// a copy).
2283 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2284 bool ForVirtualBase, Address This,
2285 bool InheritedFromVBase,
2286 const CXXInheritedCtorInitExpr *E);
2287
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002288 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002289 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002290 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002291
Richard Smith5179eb72016-06-28 19:03:57 +00002292 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2293 bool ForVirtualBase, bool Delegating,
2294 Address This, CallArgList &Args);
2295
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002296 /// Emit assumption load for all bases. Requires to be be called only on
2297 /// most-derived class and not under construction of the object.
2298 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2299
2300 /// Emit assumption that vptr load == global vtable.
2301 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2302
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002303 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002304 Address This, Address Src,
2305 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002306
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002307 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002308 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002309 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002310 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002311 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002312
Anders Carlssond49844b2009-09-23 02:45:36 +00002313 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2314 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002315 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002316 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002317 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002318
John McCall82fe67b2011-07-09 01:37:26 +00002319 static Destroyer destroyCXXObject;
2320
Anders Carlsson0a637412009-05-29 21:03:38 +00002321 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002322 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002323 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002324
John McCall99210dc2011-09-15 06:49:18 +00002325 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002326 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002327 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002328 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002329
Peter Collingbourne702b2842011-11-27 22:09:22 +00002330 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002331 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002332
David Majnemerdc012fa2015-04-22 21:38:15 +00002333 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2334 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2335
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002336 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002337 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002338
Eli Friedman24f55432009-11-18 00:57:03 +00002339 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002340 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2341 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002342
Richard Smith760520b2014-06-03 23:27:44 +00002343 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2344 const Expr *Arg, bool IsDelete);
2345
John McCall7f416cc2015-09-08 08:05:57 +00002346 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2347 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2348 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002349
Richard Smith69d0d262012-08-24 00:54:33 +00002350 /// \brief Situations in which we might emit a check for the suitability of a
2351 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002352 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002353 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002354 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002355 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002356 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002357 /// Checking the bound value in a reference binding. Must be suitably sized
2358 /// and aligned, but is not required to refer to an object (until the
2359 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002360 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002361 /// Checking the object expression in a non-static data member access. Must
2362 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002363 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002364 /// Checking the 'this' pointer for a call to a non-static member function.
2365 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002366 TCK_MemberCall,
2367 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002368 TCK_ConstructorCall,
2369 /// Checking the operand of a static_cast to a derived pointer type. Must be
2370 /// null or an object within its lifetime.
2371 TCK_DowncastPointer,
2372 /// Checking the operand of a static_cast to a derived reference type. Must
2373 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002374 TCK_DowncastReference,
2375 /// Checking the operand of a cast to a base object. Must be suitably sized
2376 /// and aligned.
2377 TCK_Upcast,
2378 /// Checking the operand of a cast to a virtual base object. Must be an
2379 /// object within its lifetime.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002380 TCK_UpcastToVirtualBase,
2381 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002382 TCK_NonnullAssign,
2383 /// Checking the operand of a dynamic_cast or a typeid expression. Must be
2384 /// null or an object within its lifetime.
2385 TCK_DynamicOperation
Richard Smith69d0d262012-08-24 00:54:33 +00002386 };
2387
Vedant Kumar24792e32017-10-03 01:27:25 +00002388 /// Determine whether the pointer type check \p TCK permits null pointers.
2389 static bool isNullPointerAllowed(TypeCheckKind TCK);
2390
2391 /// Determine whether the pointer type check \p TCK requires a vptr check.
2392 static bool isVptrCheckRequired(TypeCheckKind TCK, QualType Ty);
2393
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002394 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2395 /// calls to EmitTypeCheck can be skipped.
2396 bool sanitizePerformTypeCheck() const;
2397
Richard Smith4d1458e2012-09-08 02:08:36 +00002398 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002399 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002400 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002401 QualType Type, CharUnits Alignment = CharUnits::Zero(),
Vedant Kumar18348ea2017-02-17 23:22:55 +00002402 SanitizerSet SkippedChecks = SanitizerSet());
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002403
Richard Smith539e4a72013-02-23 02:53:19 +00002404 /// \brief Emit a check that \p Base points into an array object, which
2405 /// we can access at index \p Index. \p Accessed should be \c false if we
2406 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2407 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2408 QualType IndexType, bool Accessed);
2409
Chris Lattner116ce8f2010-01-09 21:40:03 +00002410 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2411 bool isInc, bool isPre);
2412 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2413 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002414
2415 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002416 llvm::Value *OffsetValue = nullptr) {
2417 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2418 OffsetValue);
2419 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002420
Amara Emerson652795d2016-11-10 14:44:30 +00002421 /// Converts Location to a DebugLoc, if debug information is enabled.
2422 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2423
2424
Chris Lattner8394d792007-06-05 20:53:16 +00002425 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002426 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002427 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002428
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002429 /// EmitDecl - Emit a declaration.
2430 ///
2431 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002432 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002433
John McCall1c9c3fd2010-10-15 04:57:14 +00002434 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002435 ///
2436 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002437 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002438
David Blaikie73ca5692014-12-09 00:32:22 +00002439 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002440 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002441
John McCallbd309292010-07-06 01:34:17 +00002442 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2443 llvm::Value *Address);
2444
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002445 /// \brief Determine whether the given initializer is trivial in the sense
2446 /// that it requires no code to be generated.
2447 bool isTrivialInitializer(const Expr *Init);
2448
John McCall1c9c3fd2010-10-15 04:57:14 +00002449 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002450 ///
2451 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002452 void EmitAutoVarDecl(const VarDecl &D);
2453
2454 class AutoVarEmission {
2455 friend class CodeGenFunction;
2456
John McCall9e2e22f2011-02-22 07:16:58 +00002457 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002458
John McCall7f416cc2015-09-08 08:05:57 +00002459 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002460 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002461 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002462
2463 llvm::Value *NRVOFlag;
2464
2465 /// True if the variable is a __block variable.
2466 bool IsByRef;
2467
2468 /// True if the variable is of aggregate type and has a constant
2469 /// initializer.
2470 bool IsConstantAggregate;
2471
Nadav Rotem1da30942013-03-23 06:43:35 +00002472 /// Non-null if we should use lifetime annotations.
2473 llvm::Value *SizeForLifetimeMarkers;
2474
John McCall9e2e22f2011-02-22 07:16:58 +00002475 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002476 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002477
John McCallc533cb72011-02-22 06:44:22 +00002478 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002479 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002480 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002481 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002482
John McCall7f416cc2015-09-08 08:05:57 +00002483 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002484
2485 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002486 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2487
Craig Topper8a13c412014-05-21 05:09:00 +00002488 bool useLifetimeMarkers() const {
2489 return SizeForLifetimeMarkers != nullptr;
2490 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002491 llvm::Value *getSizeForLifetimeMarkers() const {
2492 assert(useLifetimeMarkers());
2493 return SizeForLifetimeMarkers;
2494 }
2495
2496 /// Returns the raw, allocated address, which is not necessarily
2497 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002498 Address getAllocatedAddress() const {
2499 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002500 }
2501
John McCallc533cb72011-02-22 06:44:22 +00002502 /// Returns the address of the object within this declaration.
2503 /// Note that this does not chase the forwarding pointer for
2504 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002505 Address getObjectAddress(CodeGenFunction &CGF) const {
2506 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002507
John McCall7f416cc2015-09-08 08:05:57 +00002508 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002509 }
2510 };
2511 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2512 void EmitAutoVarInit(const AutoVarEmission &emission);
Gor Nishanov04491bd2017-11-11 17:00:43 +00002513 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002514 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2515 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002516
John McCall1c9c3fd2010-10-15 04:57:14 +00002517 void EmitStaticVarDecl(const VarDecl &D,
2518 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002519
John McCall7f416cc2015-09-08 08:05:57 +00002520 class ParamValue {
2521 llvm::Value *Value;
2522 unsigned Alignment;
2523 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2524 public:
2525 static ParamValue forDirect(llvm::Value *value) {
2526 return ParamValue(value, 0);
2527 }
2528 static ParamValue forIndirect(Address addr) {
2529 assert(!addr.getAlignment().isZero());
2530 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2531 }
2532
2533 bool isIndirect() const { return Alignment != 0; }
2534 llvm::Value *getAnyValue() const { return Value; }
Gor Nishanov04491bd2017-11-11 17:00:43 +00002535
John McCall7f416cc2015-09-08 08:05:57 +00002536 llvm::Value *getDirectValue() const {
2537 assert(!isIndirect());
2538 return Value;
2539 }
2540
2541 Address getIndirectAddress() const {
2542 assert(isIndirect());
2543 return Address(Value, CharUnits::fromQuantity(Alignment));
2544 }
2545 };
2546
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002547 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002548 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002549
John McCallc07a0c72011-02-17 10:25:35 +00002550 /// protectFromPeepholes - Protect a value that we're intending to
2551 /// store to the side, but which will probably be used later, from
2552 /// aggressive peepholing optimizations that might delete it.
2553 ///
2554 /// Pass the result to unprotectFromPeepholes to declare that
2555 /// protection is no longer required.
2556 ///
2557 /// There's no particular reason why this shouldn't apply to
2558 /// l-values, it's just that no existing peepholes work on pointers.
2559 PeepholeProtection protectFromPeepholes(RValue rvalue);
2560 void unprotectFromPeepholes(PeepholeProtection protection);
2561
Erich Keane623efd82017-03-30 21:48:55 +00002562 void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment,
2563 llvm::Value *OffsetValue = nullptr) {
2564 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2565 OffsetValue);
2566 }
2567
Chris Lattner84915fa2007-06-02 04:16:21 +00002568 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002569 // Statement Emission
2570 //===--------------------------------------------------------------------===//
2571
Mike Stumpfc496822009-02-08 23:14:22 +00002572 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002573 void EmitStopPoint(const Stmt *S);
2574
Mike Stumpfc496822009-02-08 23:14:22 +00002575 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2576 /// this function even if there is no current insertion point.
2577 ///
2578 /// This function may clear the current insertion point; callers should use
2579 /// EnsureInsertPoint if they wish to subsequently generate code without first
2580 /// calling EmitBlock, EmitBranch, or EmitStmt.
Karl-Johan Karlsson33e205a2017-09-06 08:47:18 +00002581 void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002582
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002583 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002584 /// necessarily require an insertion point or debug information; typically
2585 /// because the statement amounts to a jump or a container of other
2586 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002587 ///
2588 /// \return True if the statement was handled.
2589 bool EmitSimpleStmt(const Stmt *S);
2590
John McCall7f416cc2015-09-08 08:05:57 +00002591 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2592 AggValueSlot AVS = AggValueSlot::ignored());
2593 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2594 bool GetLast = false,
2595 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002596 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002597
Mike Stumpfc496822009-02-08 23:14:22 +00002598 /// EmitLabel - Emit the block for the given label. It is legal to call this
2599 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002600 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002601
Chris Lattnerac248202007-05-30 00:13:02 +00002602 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002603 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002604 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002605 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002606 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002607
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002608 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002609 ArrayRef<const Attr *> Attrs = None);
2610 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002611 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002612 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002613 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002614 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002615 void EmitBreakStmt(const BreakStmt &S);
2616 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002617 void EmitSwitchStmt(const SwitchStmt &S);
2618 void EmitDefaultStmt(const DefaultStmt &S);
2619 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002620 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002621 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002622
Anders Carlsson2e744e82008-08-30 19:51:14 +00002623 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002624 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2625 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002626 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002627 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002628
Gor Nishanov8df64e92016-10-27 16:28:31 +00002629 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov90be1212017-03-06 21:12:54 +00002630 void EmitCoreturnStmt(const CoreturnStmt &S);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002631 RValue EmitCoawaitExpr(const CoawaitExpr &E,
2632 AggValueSlot aggSlot = AggValueSlot::ignored(),
2633 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002634 LValue EmitCoawaitLValue(const CoawaitExpr *E);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002635 RValue EmitCoyieldExpr(const CoyieldExpr &E,
2636 AggValueSlot aggSlot = AggValueSlot::ignored(),
2637 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002638 LValue EmitCoyieldLValue(const CoyieldExpr *E);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002639 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2640
John McCallb609d3f2010-07-07 06:56:46 +00002641 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2642 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002643
Anders Carlsson52d78a52009-09-27 18:58:34 +00002644 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002645 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002646 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002647 void EnterSEHTryStmt(const SEHTryStmt &S);
2648 void ExitSEHTryStmt(const SEHTryStmt &S);
2649
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002650 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002651 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002652
2653 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2654 const SEHExceptStmt &Except);
2655
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002656 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2657 const SEHFinallyStmt &Finally);
2658
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002659 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2660 llvm::Value *ParentFP,
2661 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002662 llvm::Value *EmitSEHExceptionCode();
2663 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002664 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002665
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002666 /// Emit simple code for OpenMP directives in Simd-only mode.
2667 void EmitSimpleOMPExecutableDirective(const OMPExecutableDirective &D);
2668
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002669 /// Scan the outlined statement for captures from the parent function. For
2670 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002671 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002672 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002673 bool IsFilter);
2674
2675 /// Recovers the address of a local in a parent function. ParentVar is the
2676 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002677 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002678 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2679 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002680 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2681 Address ParentVar,
2682 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002683
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002684 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002685 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002686
Alexey Bataev2139ed62017-11-16 18:20:21 +00002687 /// Controls insertion of cancellation exit blocks in worksharing constructs.
2688 class OMPCancelStackRAII {
2689 CodeGenFunction &CGF;
2690
2691 public:
2692 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
2693 bool HasCancel)
2694 : CGF(CGF) {
2695 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
2696 }
2697 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
2698 };
2699
Alexey Bataev1189bd02016-01-26 12:20:39 +00002700 /// Returns calculated size of the specified type.
2701 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002702 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002703 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002704 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002705 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002706 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002707 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002708 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002709 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2710 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002711 /// \brief Perform element by element copying of arrays with type \a
2712 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2713 /// generated by \a CopyGen.
2714 ///
2715 /// \param DestAddr Address of the destination array.
2716 /// \param SrcAddr Address of the source array.
2717 /// \param OriginalType Type of destination and source arrays.
2718 /// \param CopyGen Copying procedure that copies value of single array element
2719 /// to another single array element.
2720 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002721 Address DestAddr, Address SrcAddr, QualType OriginalType,
2722 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002723 /// \brief Emit proper copying of data from one variable to another.
2724 ///
2725 /// \param OriginalType Original type of the copied variables.
2726 /// \param DestAddr Destination address.
2727 /// \param SrcAddr Source address.
2728 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2729 /// type of the base array element).
2730 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2731 /// the base array element).
2732 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2733 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002734 void EmitOMPCopy(QualType OriginalType,
2735 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002736 const VarDecl *DestVD, const VarDecl *SrcVD,
2737 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002738 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2739 /// \a X = \a E \a BO \a E.
2740 ///
2741 /// \param X Value to be updated.
2742 /// \param E Update value.
2743 /// \param BO Binary operation for update operation.
2744 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2745 /// expression, false otherwise.
2746 /// \param AO Atomic ordering of the generated atomic instructions.
2747 /// \param CommonGen Code generator for complex expressions that cannot be
2748 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002749 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2750 /// generated, <false, RValue::get(nullptr)> otherwise.
2751 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002752 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2753 llvm::AtomicOrdering AO, SourceLocation Loc,
2754 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002755 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002756 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002757 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2758 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002759 void EmitOMPUseDevicePtrClause(
2760 const OMPClause &C, OMPPrivateScope &PrivateScope,
2761 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002762 /// \brief Emit code for copyin clause in \a D directive. The next code is
2763 /// generated at the start of outlined functions for directives:
2764 /// \code
2765 /// threadprivate_var1 = master_threadprivate_var1;
2766 /// operator=(threadprivate_var2, master_threadprivate_var2);
2767 /// ...
2768 /// __kmpc_barrier(&loc, global_tid);
2769 /// \endcode
2770 ///
2771 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2772 /// \returns true if at least one copyin variable is found, false otherwise.
2773 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002774 /// \brief Emit initial code for lastprivate variables. If some variable is
2775 /// not also firstprivate, then the default initialization is used. Otherwise
2776 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2777 /// method.
2778 ///
2779 /// \param D Directive that may have 'lastprivate' directives.
2780 /// \param PrivateScope Private scope for capturing lastprivate variables for
2781 /// proper codegen in internal captured statement.
2782 ///
2783 /// \returns true if there is at least one lastprivate variable, false
2784 /// otherwise.
2785 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2786 OMPPrivateScope &PrivateScope);
2787 /// \brief Emit final copying of lastprivate values to original variables at
2788 /// the end of the worksharing or simd directive.
2789 ///
2790 /// \param D Directive that has at least one 'lastprivate' directives.
2791 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2792 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002793 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002794 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002795 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002796 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002797 /// Emit initial code for linear clauses.
2798 void EmitOMPLinearClause(const OMPLoopDirective &D,
2799 CodeGenFunction::OMPPrivateScope &PrivateScope);
2800 /// Emit final code for linear clauses.
2801 /// \param CondGen Optional conditional code for final part of codegen for
2802 /// linear clause.
2803 void EmitOMPLinearClauseFinal(
2804 const OMPLoopDirective &D,
2805 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002806 /// \brief Emit initial code for reduction variables. Creates reduction copies
2807 /// and initializes them with the values according to OpenMP standard.
2808 ///
2809 /// \param D Directive (possibly) with the 'reduction' clause.
2810 /// \param PrivateScope Private scope for capturing reduction variables for
2811 /// proper codegen in internal captured statement.
2812 ///
2813 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2814 OMPPrivateScope &PrivateScope);
2815 /// \brief Emit final update of reduction values to original variables at
2816 /// the end of the directive.
2817 ///
2818 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00002819 /// \param ReductionKind The kind of reduction to perform.
2820 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
2821 const OpenMPDirectiveKind ReductionKind);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002822 /// \brief Emit initial code for linear variables. Creates private copies
2823 /// and initializes them with the values according to OpenMP standard.
2824 ///
2825 /// \param D Directive (possibly) with the 'linear' clause.
Alexey Bataev8c3edfe2017-08-16 15:58:46 +00002826 /// \return true if at least one linear variable is found that should be
2827 /// initialized with the value of the original variable, false otherwise.
2828 bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002829
Alexey Bataev7292c292016-04-25 12:22:29 +00002830 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2831 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002832 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002833 TaskGenTy;
2834 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
Alexey Bataev475a7442018-01-12 19:39:11 +00002835 const OpenMPDirectiveKind CapturedRegion,
Alexey Bataev7292c292016-04-25 12:22:29 +00002836 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002837 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataevd2202ca2017-12-27 17:58:32 +00002838 struct OMPTargetDataInfo {
2839 Address BasePointersArray = Address::invalid();
2840 Address PointersArray = Address::invalid();
2841 Address SizesArray = Address::invalid();
2842 unsigned NumberOfTargetItems = 0;
2843 explicit OMPTargetDataInfo() = default;
2844 OMPTargetDataInfo(Address BasePointersArray, Address PointersArray,
2845 Address SizesArray, unsigned NumberOfTargetItems)
2846 : BasePointersArray(BasePointersArray), PointersArray(PointersArray),
2847 SizesArray(SizesArray), NumberOfTargetItems(NumberOfTargetItems) {}
2848 };
2849 void EmitOMPTargetTaskBasedDirective(const OMPExecutableDirective &S,
2850 const RegionCodeGenTy &BodyGen,
2851 OMPTargetDataInfo &InputInfo);
Alexey Bataev7292c292016-04-25 12:22:29 +00002852
Alexey Bataev9959db52014-05-06 10:08:46 +00002853 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002854 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002855 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002856 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002857 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002858 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002859 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002860 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002861 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002862 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002863 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002864 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002865 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002866 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002867 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002868 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002869 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002870 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002871 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002872 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002873 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002874 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002875 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002876 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002877 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002878 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002879 void
2880 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002881 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002882 void
2883 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002884 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002885 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002886 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002887 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002888 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002889 void EmitOMPDistributeParallelForDirective(
2890 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002891 void EmitOMPDistributeParallelForSimdDirective(
2892 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002893 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002894 void EmitOMPTargetParallelForSimdDirective(
2895 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002896 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002897 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00002898 void
2899 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00002900 void EmitOMPTeamsDistributeParallelForSimdDirective(
2901 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00002902 void EmitOMPTeamsDistributeParallelForDirective(
2903 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00002904 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00002905 void EmitOMPTargetTeamsDistributeDirective(
2906 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00002907 void EmitOMPTargetTeamsDistributeParallelForDirective(
2908 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00002909 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
2910 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00002911 void EmitOMPTargetTeamsDistributeSimdDirective(
2912 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002913
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00002914 /// Emit device code for the target directive.
2915 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
2916 StringRef ParentName,
2917 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00002918 static void
2919 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2920 const OMPTargetParallelDirective &S);
Alexey Bataevfb0ebec2017-11-08 20:16:14 +00002921 /// Emit device code for the target parallel for directive.
2922 static void EmitOMPTargetParallelForDeviceFunction(
2923 CodeGenModule &CGM, StringRef ParentName,
2924 const OMPTargetParallelForDirective &S);
Alexey Bataev5d7edca2017-11-09 17:32:15 +00002925 /// Emit device code for the target parallel for simd directive.
2926 static void EmitOMPTargetParallelForSimdDeviceFunction(
2927 CodeGenModule &CGM, StringRef ParentName,
2928 const OMPTargetParallelForSimdDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00002929 /// Emit device code for the target teams directive.
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00002930 static void
2931 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2932 const OMPTargetTeamsDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00002933 /// Emit device code for the target teams distribute directive.
2934 static void EmitOMPTargetTeamsDistributeDeviceFunction(
2935 CodeGenModule &CGM, StringRef ParentName,
2936 const OMPTargetTeamsDistributeDirective &S);
Alexey Bataevfbe17fb2017-12-13 19:45:06 +00002937 /// Emit device code for the target teams distribute simd directive.
2938 static void EmitOMPTargetTeamsDistributeSimdDeviceFunction(
2939 CodeGenModule &CGM, StringRef ParentName,
2940 const OMPTargetTeamsDistributeSimdDirective &S);
Alexey Bataevf8365372017-11-17 17:57:25 +00002941 /// Emit device code for the target simd directive.
2942 static void EmitOMPTargetSimdDeviceFunction(CodeGenModule &CGM,
2943 StringRef ParentName,
2944 const OMPTargetSimdDirective &S);
Carlo Bertolli52978c32018-01-03 21:12:44 +00002945
2946 static void EmitOMPTargetTeamsDistributeParallelForDeviceFunction(
2947 CodeGenModule &CGM, StringRef ParentName,
2948 const OMPTargetTeamsDistributeParallelForDirective &S);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002949 /// \brief Emit inner loop of the worksharing/simd construct.
2950 ///
2951 /// \param S Directive, for which the inner loop must be emitted.
2952 /// \param RequiresCleanup true, if directive has some associated private
2953 /// variables.
2954 /// \param LoopCond Bollean condition for loop continuation.
2955 /// \param IncExpr Increment expression for loop control variable.
2956 /// \param BodyGen Generator for the inner body of the inner loop.
2957 /// \param PostIncGen Genrator for post-increment code (required for ordered
2958 /// loop directvies).
2959 void EmitOMPInnerLoop(
2960 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2961 const Expr *IncExpr,
2962 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2963 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002964
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002965 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002966 /// Emit initial code for loop counters of loop-based directives.
2967 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2968 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002969
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002970 /// Helper for the OpenMP loop directives.
2971 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
2972
2973 /// \brief Emit code for the worksharing loop-based directive.
2974 /// \return true, if this construct has any lastprivate clause, false -
2975 /// otherwise.
2976 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
2977 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
2978 const CodeGenDispatchBoundsTy &CGDispatchBounds);
2979
Alexey Bataevdfa430f2017-12-08 15:03:50 +00002980 /// Emit code for the distribute loop-based directive.
2981 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
2982 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
2983
Alexey Bataevf8365372017-11-17 17:57:25 +00002984 /// Helpers for the OpenMP loop directives.
2985 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
2986 void EmitOMPSimdFinal(
2987 const OMPLoopDirective &D,
2988 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
2989
Alexey Bataevf47c4b42017-09-26 13:47:31 +00002990 /// Emits the lvalue for the expression with possibly captured variable.
2991 LValue EmitOMPSharedLValue(const Expr *E);
2992
Alexander Musmanc6388682014-12-15 07:07:06 +00002993private:
Yaxun Liuc2a87a02017-10-14 12:23:50 +00002994 /// Helpers for blocks. Returns invoke function by \p InvokeF if it is not
2995 /// nullptr. It should be called without \p InvokeF if the caller does not
2996 /// need invoke function to be returned.
2997 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info,
2998 llvm::Function **InvokeF = nullptr);
George Burgess IVe3763372016-12-22 02:50:20 +00002999
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003000 /// struct with the values to be passed to the OpenMP loop-related functions
3001 struct OMPLoopArguments {
3002 /// loop lower bound
3003 Address LB = Address::invalid();
3004 /// loop upper bound
3005 Address UB = Address::invalid();
3006 /// loop stride
3007 Address ST = Address::invalid();
3008 /// isLastIteration argument for runtime functions
3009 Address IL = Address::invalid();
3010 /// Chunk value generated by sema
3011 llvm::Value *Chunk = nullptr;
3012 /// EnsureUpperBound
3013 Expr *EUB = nullptr;
3014 /// IncrementExpression
3015 Expr *IncExpr = nullptr;
3016 /// Loop initialization
3017 Expr *Init = nullptr;
3018 /// Loop exit condition
3019 Expr *Cond = nullptr;
3020 /// Update of LB after a whole chunk has been executed
3021 Expr *NextLB = nullptr;
3022 /// Update of UB after a whole chunk has been executed
3023 Expr *NextUB = nullptr;
3024 OMPLoopArguments() = default;
3025 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
3026 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
3027 Expr *IncExpr = nullptr, Expr *Init = nullptr,
3028 Expr *Cond = nullptr, Expr *NextLB = nullptr,
3029 Expr *NextUB = nullptr)
3030 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
3031 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
3032 NextUB(NextUB) {}
3033 };
3034 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
3035 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
3036 const OMPLoopArguments &LoopArgs,
3037 const CodeGenLoopTy &CodeGenLoop,
3038 const CodeGenOrderedTy &CodeGenOrdered);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00003039 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00003040 bool IsMonotonic, const OMPLoopDirective &S,
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003041 OMPPrivateScope &LoopScope, bool Ordered,
3042 const OMPLoopArguments &LoopArgs,
3043 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3044 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
3045 const OMPLoopDirective &S,
3046 OMPPrivateScope &LoopScope,
3047 const OMPLoopArguments &LoopArgs,
3048 const CodeGenLoopTy &CodeGenLoopContent);
Alexey Bataev0f34da12015-07-02 04:17:07 +00003049 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00003050 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00003051
3052public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00003053
Chris Lattner208ae962007-05-30 17:57:17 +00003054 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00003055 // LValue Expression Emission
3056 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00003057
Daniel Dunbarc79407f2009-02-05 07:09:07 +00003058 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
3059 RValue GetUndefRValue(QualType Ty);
3060
Daniel Dunbarbb197e42009-01-09 16:50:52 +00003061 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
3062 /// and issue an ErrorUnsupported style diagnostic (using the
3063 /// provided Name).
3064 RValue EmitUnsupportedRValue(const Expr *E,
3065 const char *Name);
3066
Mike Stumpfc496822009-02-08 23:14:22 +00003067 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
3068 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00003069 LValue EmitUnsupportedLValue(const Expr *E,
3070 const char *Name);
3071
Chris Lattner8394d792007-06-05 20:53:16 +00003072 /// EmitLValue - Emit code to compute a designator that specifies the location
3073 /// of the expression.
3074 ///
3075 /// This can return one of two things: a simple address or a bitfield
3076 /// reference. In either case, the LLVM Value* in the LValue structure is
3077 /// guaranteed to be an LLVM pointer type.
3078 ///
3079 /// If this returns a bitfield reference, nothing about the pointee type of
3080 /// the LLVM value is known: For example, it may not be a pointer to an
3081 /// integer.
3082 ///
3083 /// If this returns a normal address, and if the lvalue's C type is fixed
3084 /// size, this method guarantees that the returned pointer type will point to
3085 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
3086 /// variable length type, this is not possible.
3087 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00003088 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003089
Richard Smith4d1458e2012-09-08 02:08:36 +00003090 /// \brief Same as EmitLValue but additionally we generate checking code to
3091 /// guard against undefined behavior. This is only suitable when we know
3092 /// that the address will be used to access the object.
3093 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00003094
John McCall7f416cc2015-09-08 08:05:57 +00003095 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003096 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00003097
John McCalla8ec7eb2013-03-07 21:37:17 +00003098 void EmitAtomicInit(Expr *E, LValue lvalue);
3099
David Majnemera5b195a2015-02-14 01:35:12 +00003100 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00003101
3102 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
3103 AggValueSlot Slot = AggValueSlot::ignored());
3104
Nick Lewycky2d84e842013-10-02 02:29:49 +00003105 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00003106 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00003107 AggValueSlot slot = AggValueSlot::ignored());
3108
3109 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3110
David Majnemera5b195a2015-02-14 01:35:12 +00003111 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3112 bool IsVolatile, bool isInit);
3113
Alexey Bataevb4505a72015-03-30 05:20:59 +00003114 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00003115 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00003116 llvm::AtomicOrdering Success =
3117 llvm::AtomicOrdering::SequentiallyConsistent,
3118 llvm::AtomicOrdering Failure =
3119 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00003120 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3121
Alexey Bataevb4505a72015-03-30 05:20:59 +00003122 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00003123 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00003124 bool IsVolatile);
3125
John McCall3a7f6922010-10-27 20:58:56 +00003126 /// EmitToMemory - Change a scalar value from its value
3127 /// representation to its in-memory representation.
3128 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3129
3130 /// EmitFromMemory - Change a scalar value from its memory
3131 /// representation to its value representation.
3132 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3133
Vedant Kumar5a972652017-02-27 19:46:19 +00003134 /// Check if the scalar \p Value is within the valid range for the given
3135 /// type \p Ty.
3136 ///
3137 /// Returns true if a check is needed (even if the range is unknown).
3138 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3139 SourceLocation Loc);
3140
Daniel Dunbar1d425462009-02-10 00:57:50 +00003141 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3142 /// care to appropriately convert from the memory representation to
3143 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003144 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003145 SourceLocation Loc,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003146 AlignmentSource Source = AlignmentSource::Type,
3147 bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003148 return EmitLoadOfScalar(Addr, Volatile, Ty, Loc, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003149 CGM.getTBAAAccessInfo(Ty), isNontemporal);
3150 }
3151
3152 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3153 SourceLocation Loc, LValueBaseInfo BaseInfo,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003154 TBAAAccessInfo TBAAInfo,
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003155 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003156
3157 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3158 /// care to appropriately convert from the memory representation to
3159 /// the LLVM value representation. The l-value must be a simple
3160 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003161 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003162
3163 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3164 /// care to appropriately convert from the memory representation to
3165 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003166 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3167 bool Volatile, QualType Ty,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003168 AlignmentSource Source = AlignmentSource::Type,
3169 bool isInit = false, bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003170 EmitStoreOfScalar(Value, Addr, Volatile, Ty, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003171 CGM.getTBAAAccessInfo(Ty), isInit, isNontemporal);
3172 }
3173
3174 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003175 bool Volatile, QualType Ty,
3176 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo,
Ivan A. Kosareva511ed72017-10-03 10:52:39 +00003177 bool isInit = false, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003178
3179 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3180 /// care to appropriately convert from the memory representation to
3181 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00003182 /// l-value. The isInit flag indicates whether this is an initialization.
3183 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3184 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003185
Chris Lattner8394d792007-06-05 20:53:16 +00003186 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3187 /// this method emits the address of the lvalue, then loads the result as an
3188 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003189 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00003190 RValue EmitLoadOfExtVectorElementLValue(LValue V);
Vedant Kumar129edab2017-03-09 16:06:27 +00003191 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
Renato Golin230c5eb2014-05-19 18:15:42 +00003192 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00003193
Chris Lattner8394d792007-06-05 20:53:16 +00003194 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3195 /// lvalue, where both are guaranteed to the have the same type, and that type
3196 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00003197 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003198 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00003199 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003200
Nick Lewycky2d84e842013-10-02 02:29:49 +00003201 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3202 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003203 ///
Mike Stumpfc496822009-02-08 23:14:22 +00003204 /// \param Result [out] - If non-null, this will be set to a Value* for the
3205 /// bit-field contents after the store, appropriate for use as the result of
3206 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00003207 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00003208 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00003209
John McCall4f29b492010-11-16 23:07:28 +00003210 /// Emit an l-value for an assignment (simple or compound) of complex type.
3211 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003212 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00003213 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3214 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00003215
Chris Lattner57540c52011-04-15 05:22:18 +00003216 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00003217 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003218 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003219 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00003220 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003221 // Note: only available for agg return types
3222 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00003223 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00003224 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00003225 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00003226 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00003227 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00003228 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3229 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00003230 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3231 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00003232 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00003233 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00003234 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00003235 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00003236 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00003237 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00003238 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00003239 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00003240 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003241
John McCall7f416cc2015-09-08 08:05:57 +00003242 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003243
Nick Lewycky2d84e842013-10-02 02:29:49 +00003244 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00003245
John McCall7f416cc2015-09-08 08:05:57 +00003246 Address EmitArrayToPointerDecay(const Expr *Array,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00003247 LValueBaseInfo *BaseInfo = nullptr,
3248 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003249
John McCall71335052012-03-10 03:05:10 +00003250 class ConstantEmission {
3251 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3252 ConstantEmission(llvm::Constant *C, bool isReference)
3253 : ValueAndIsReference(C, isReference) {}
3254 public:
3255 ConstantEmission() {}
3256 static ConstantEmission forReference(llvm::Constant *C) {
3257 return ConstantEmission(C, true);
3258 }
3259 static ConstantEmission forValue(llvm::Constant *C) {
3260 return ConstantEmission(C, false);
3261 }
3262
Aaron Ballman67347662015-02-15 22:00:28 +00003263 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00003264 return ValueAndIsReference.getOpaqueValue() != nullptr;
3265 }
John McCall71335052012-03-10 03:05:10 +00003266
3267 bool isReference() const { return ValueAndIsReference.getInt(); }
3268 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3269 assert(isReference());
3270 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3271 refExpr->getType());
3272 }
3273
3274 llvm::Constant *getValue() const {
3275 assert(!isReference());
3276 return ValueAndIsReference.getPointer();
3277 }
3278 };
3279
John McCall113bee02012-03-10 09:33:50 +00003280 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
Alex Lorenz6cc83172017-08-25 10:07:00 +00003281 ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
John McCall71335052012-03-10 03:05:10 +00003282
John McCallfe96e0b2011-11-06 09:01:30 +00003283 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3284 AggValueSlot slot = AggValueSlot::ignored());
3285 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3286
Daniel Dunbar722f4242009-04-22 05:08:15 +00003287 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003288 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00003289 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00003290 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003291
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003292 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3293 /// if the Field is a reference, this will return the address of the reference
3294 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003295 LValue EmitLValueForFieldInitialization(LValue Base,
3296 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003297
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003298 LValue EmitLValueForIvar(QualType ObjectTy,
3299 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003300 unsigned CVRQualifiers);
3301
Anders Carlsson3be22e22009-05-30 23:23:33 +00003302 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003303 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00003304 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003305 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003306 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003307
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003308 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003309 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003310 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003311 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003312 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003313 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003314
Chris Lattnerd7f58862007-06-02 05:24:33 +00003315 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003316 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003317 //===--------------------------------------------------------------------===//
3318
Mike Stumpfc496822009-02-08 23:14:22 +00003319 /// EmitCall - Generate a call of the given function, expecting the given
3320 /// result type, and using the given argument list which specifies both the
3321 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003322 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003323 ReturnValueSlot ReturnValue, const CallArgList &Args,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003324 llvm::Instruction **callOrInvoke, SourceLocation Loc);
3325 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
3326 ReturnValueSlot ReturnValue, const CallArgList &Args,
3327 llvm::Instruction **callOrInvoke = nullptr) {
3328 return EmitCall(CallInfo, Callee, ReturnValue, Args, callOrInvoke,
3329 SourceLocation());
3330 }
John McCallb92ab1a2016-10-26 23:46:34 +00003331 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003332 ReturnValueSlot ReturnValue, llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003333 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003334 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003335 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3336 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003337
Eric Christopherc7e79db2015-11-12 00:44:04 +00003338 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003339
John McCall882987f2013-02-28 19:01:20 +00003340 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3341 const Twine &name = "");
3342 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3343 ArrayRef<llvm::Value*> args,
3344 const Twine &name = "");
3345 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3346 const Twine &name = "");
3347 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3348 ArrayRef<llvm::Value*> args,
3349 const Twine &name = "");
3350
John McCallbd309292010-07-06 01:34:17 +00003351 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003352 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00003353 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00003354 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3355 ArrayRef<llvm::Value*> args,
3356 const Twine &name = "");
3357 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3358 const Twine &name = "");
3359 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3360 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00003361
Gor Nishanov04491bd2017-11-11 17:00:43 +00003362 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
John McCallb92ab1a2016-10-26 23:46:34 +00003363 NestedNameSpecifier *Qual,
3364 llvm::Type *Ty);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003365
John McCallb92ab1a2016-10-26 23:46:34 +00003366 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
Gor Nishanov04491bd2017-11-11 17:00:43 +00003367 CXXDtorType Type,
John McCallb92ab1a2016-10-26 23:46:34 +00003368 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003369
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003370 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003371 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3372 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003373 ReturnValueSlot ReturnValue, llvm::Value *This,
3374 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003375 QualType ImplicitParamTy, const CallExpr *E,
3376 CallArgList *RtlArgs);
John McCallb92ab1a2016-10-26 23:46:34 +00003377 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3378 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003379 llvm::Value *This, llvm::Value *ImplicitParam,
3380 QualType ImplicitParamTy, const CallExpr *E,
3381 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003382 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3383 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003384 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3385 const CXXMethodDecl *MD,
3386 ReturnValueSlot ReturnValue,
3387 bool HasQualifier,
3388 NestedNameSpecifier *Qualifier,
3389 bool IsArrow, const Expr *Base);
3390 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003391 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3392 llvm::Value *memberPtr,
3393 const MemberPointerType *memberPtrType,
Ivan A. Kosarev229a6d82017-10-13 16:38:32 +00003394 LValueBaseInfo *BaseInfo = nullptr,
3395 TBAAAccessInfo *TBAAInfo = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003396 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3397 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003398
Anders Carlsson4034a952009-05-27 04:18:27 +00003399 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003400 const CXXMethodDecl *MD,
3401 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003402 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003403
Peter Collingbournefe883422011-10-06 18:29:37 +00003404 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3405 ReturnValueSlot ReturnValue);
3406
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003407 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3408 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003409
Mike Stump11289f42009-09-09 15:08:12 +00003410 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00003411 unsigned BuiltinID, const CallExpr *E,
3412 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003413
Akira Hatanaka6b103bc2017-10-06 07:12:46 +00003414 /// Emit IR for __builtin_os_log_format.
3415 RValue emitBuiltinOSLogFormat(const CallExpr &E);
3416
3417 llvm::Function *generateBuiltinOSLogHelperFunction(
3418 const analyze_os_log::OSLogBufferLayout &Layout,
3419 CharUnits BufferAlignment);
3420
Anders Carlssonbfb36712009-12-24 21:13:40 +00003421 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003422
Mike Stumpfc496822009-02-08 23:14:22 +00003423 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3424 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003425 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3426
Kevin Qin1718af62013-11-14 02:45:18 +00003427 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3428 const llvm::CmpInst::Predicate Fp,
3429 const llvm::CmpInst::Predicate Ip,
3430 const llvm::Twine &Name = "");
Abderrazek Zaafraniabb890b2017-12-21 20:10:03 +00003431 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3432 llvm::Triple::ArchType Arch);
Tim Northover8fe03d62014-02-21 11:57:24 +00003433
3434 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3435 unsigned LLVMIntrinsic,
3436 unsigned AltLLVMIntrinsic,
3437 const char *NameHint,
3438 unsigned Modifier,
3439 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003440 SmallVectorImpl<llvm::Value *> &Ops,
Abderrazek Zaafraniabb890b2017-12-21 20:10:03 +00003441 Address PtrOp0, Address PtrOp1,
3442 llvm::Triple::ArchType Arch);
Tim Northover8fe03d62014-02-21 11:57:24 +00003443 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3444 unsigned Modifier, llvm::Type *ArgTy,
3445 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003446 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003447 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003448 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003449 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003450 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003451 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003452 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003453 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3454 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003455 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Abderrazek Zaafraniabb890b2017-12-21 20:10:03 +00003456 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3457 llvm::Triple::ArchType Arch);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003458
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003459 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003460 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3461 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003462 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003463 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003464 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003465 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3466 const CallExpr *E);
Krzysztof Parzyszek5a655832017-12-13 19:56:03 +00003467 llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003468
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003469private:
3470 enum class MSVCIntrin;
3471
3472public:
3473 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3474
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003475 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3476
Daniel Dunbar66912a12008-08-20 00:28:19 +00003477 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003478 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003479 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003480 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3481 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3482 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003483 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003484 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003485 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3486 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003487
John McCall31168b02011-06-15 23:02:42 +00003488 /// Retrieves the default cleanup kind for an ARC cleanup.
3489 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3490 CleanupKind getARCCleanupKind() {
3491 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3492 ? NormalAndEHCleanup : NormalCleanup;
3493 }
3494
3495 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003496 void EmitARCInitWeak(Address addr, llvm::Value *value);
3497 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003498 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003499 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3500 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3501 void EmitARCCopyWeak(Address dst, Address src);
3502 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003503 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3504 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003505 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003506 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003507 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003508 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003509 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003510 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003511 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003512 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003513 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003514 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003515 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3516 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3517 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003518 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003519
3520 std::pair<LValue,llvm::Value*>
3521 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3522 std::pair<LValue,llvm::Value*>
3523 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003524 std::pair<LValue,llvm::Value*>
3525 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003526
John McCall248512a2011-10-01 10:32:24 +00003527 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003528 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3529 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3530
John McCallff613032011-10-04 06:23:45 +00003531 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003532 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3533 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003534 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3535 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003536 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003537
Craig Topper00bbdcf2014-06-28 23:22:23 +00003538 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003539
John McCall82fe67b2011-07-09 01:37:26 +00003540 static Destroyer destroyARCStrongImprecise;
3541 static Destroyer destroyARCStrongPrecise;
3542 static Destroyer destroyARCWeak;
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00003543 static Destroyer emitARCIntrinsicUse;
John McCall82fe67b2011-07-09 01:37:26 +00003544
Gor Nishanov04491bd2017-11-11 17:00:43 +00003545 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003546 llvm::Value *EmitObjCAutoreleasePoolPush();
3547 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3548 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003549 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003550
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003551 /// \brief Emits a reference binding to the passed in expression.
3552 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003553
Chris Lattner6278e6a2007-08-11 00:04:45 +00003554 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003555 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003556 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003557
3558 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003559
3560 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3561 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003562 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003563
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003564 /// Emit a conversion from the specified type to the specified destination
3565 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003566 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003567 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003568
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003569 /// Emit a conversion from the specified complex type to the specified
3570 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003571 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003572 QualType DstTy,
3573 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003574
John McCall7a626f62010-09-15 10:14:12 +00003575 /// EmitAggExpr - Emit the computation of the specified expression
3576 /// of aggregate type. The result is computed into the given slot,
3577 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003578 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003579
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003580 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3581 /// aggregate type into a temporary LValue.
3582 LValue EmitAggExprToLValue(const Expr *E);
3583
John McCall1bd25562011-06-24 23:21:27 +00003584 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3585 /// make sure it survives garbage collection until this point.
3586 void EmitExtendGCLifetime(llvm::Value *object);
3587
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003588 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003589 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003590 ComplexPairTy EmitComplexExpr(const Expr *E,
3591 bool IgnoreReal = false,
3592 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003593
John McCall47fb9502013-03-07 21:37:08 +00003594 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3595 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003596 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003597
John McCall47fb9502013-03-07 21:37:08 +00003598 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003599 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003600
3601 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003602 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003603
John McCall7f416cc2015-09-08 08:05:57 +00003604 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3605 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3606
Chandler Carruth84537952012-03-30 19:44:53 +00003607 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3608 /// global variable that has already been created for it. If the initializer
3609 /// has a different type than GV does, this may free GV and return a different
3610 /// one. Otherwise it just returns GV.
3611 llvm::GlobalVariable *
3612 AddInitializerToStaticVarDecl(const VarDecl &D,
3613 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003614
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003615
Anders Carlssonf40886a2009-08-08 21:45:14 +00003616 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3617 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003618 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3619 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003620
David Majnemerb3341ea2014-10-05 05:05:40 +00003621 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3622 llvm::Constant *Addr);
3623
John McCallc84ed6a2012-05-01 06:13:13 +00003624 /// Call atexit() with a function that passes the given argument to
3625 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003626 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3627 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003628
John McCallcdf7ef52010-11-06 09:44:32 +00003629 /// Emit code in this function to perform a guarded variable
3630 /// initialization. Guarded initializations are used when it's not
3631 /// possible to prove that an initialization will be done exactly
3632 /// once, e.g. with a static local variable or a static data member
3633 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003634 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003635 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003636
Richard Smithae8d62c2017-07-26 22:01:09 +00003637 enum class GuardKind { VariableGuard, TlsGuard };
3638
3639 /// Emit a branch to select whether or not to perform guarded initialization.
3640 void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
3641 llvm::BasicBlock *InitBlock,
3642 llvm::BasicBlock *NoInitBlock,
3643 GuardKind Kind, const VarDecl *D);
3644
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003645 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3646 /// variables.
3647 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003648 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003649 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003650
John McCallee08c532012-04-06 18:21:03 +00003651 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003652 /// variables.
Sanjoy Dase369bd92017-05-01 17:08:00 +00003653 void GenerateCXXGlobalDtorsFunc(
3654 llvm::Function *Fn,
3655 const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
3656 &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003657
John McCalla738c252011-03-09 04:27:21 +00003658 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3659 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003660 llvm::GlobalVariable *Addr,
3661 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003662
John McCall7a626f62010-09-15 10:14:12 +00003663 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003664
John McCall7f416cc2015-09-08 08:05:57 +00003665 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003666
John McCall08ef4662011-11-10 08:15:53 +00003667 void enterFullExpression(const ExprWithCleanups *E) {
3668 if (E->getNumObjects() == 0) return;
3669 enterNonTrivialFullExpression(E);
3670 }
3671 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003672
Richard Smithea852322013-05-07 21:53:22 +00003673 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003674
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003675 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3676
Tim Northovercc2a6e02015-11-09 19:56:35 +00003677 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003678
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003679 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003680 // Annotations Emission
3681 //===--------------------------------------------------------------------===//
3682
3683 /// Emit an annotation call (intrinsic or builtin).
3684 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3685 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003686 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003687 SourceLocation Location);
3688
3689 /// Emit local annotations for the local variable V, declared by D.
3690 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3691
3692 /// Emit field annotations for the given field & value. Returns the
3693 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003694 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003695
3696 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003697 // Internal Helpers
3698 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003699
Chris Lattner5b1964b2008-11-11 07:41:27 +00003700 /// ContainsLabel - Return true if the statement contains a label in it. If
3701 /// this statement is not executed normally, it not containing a label means
3702 /// that we can just remove the code.
3703 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003704
Chris Lattner29911cc2011-02-28 00:18:40 +00003705 /// containsBreak - Return true if the statement contains a break out of it.
3706 /// If the statement (recursively) contains a switch or loop with a break
3707 /// inside of it, this is fine.
3708 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003709
3710 /// Determine if the given statement might introduce a declaration into the
3711 /// current scope, by being a (possibly-labelled) DeclStmt.
3712 static bool mightAddDeclToScope(const Stmt *S);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003713
Daniel Dunbar682712c2008-11-12 10:12:14 +00003714 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003715 /// to a constant, or if it does but contains a label, return false. If it
3716 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003717 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3718 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003719
Chris Lattner29911cc2011-02-28 00:18:40 +00003720 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3721 /// to a constant, or if it does but contains a label, return false. If it
3722 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003723 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3724 bool AllowLabels = false);
3725
Chris Lattnercd439292008-11-12 08:04:58 +00003726 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3727 /// if statement) to the specified blocks. Based on the condition, this might
3728 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003729 /// TrueCount should be the number of times we expect the condition to
3730 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003731 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003732 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003733
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003734 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
3735 /// nonnull, if \p LHS is marked _Nonnull.
3736 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
3737
Vedant Kumar175b6d12017-07-13 20:55:26 +00003738 /// An enumeration which makes it easier to specify whether or not an
3739 /// operation is a subtraction.
3740 enum { NotSubtraction = false, IsSubtraction = true };
3741
Vedant Kumara125eb52017-06-01 19:22:18 +00003742 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
3743 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003744 /// \p SignedIndices indicates whether any of the GEP indices are signed.
Vedant Kumar175b6d12017-07-13 20:55:26 +00003745 /// \p IsSubtraction indicates whether the expression used to form the GEP
3746 /// is a subtraction.
Vedant Kumara125eb52017-06-01 19:22:18 +00003747 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
3748 ArrayRef<llvm::Value *> IdxList,
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003749 bool SignedIndices,
Vedant Kumar175b6d12017-07-13 20:55:26 +00003750 bool IsSubtraction,
Vedant Kumara125eb52017-06-01 19:22:18 +00003751 SourceLocation Loc,
3752 const Twine &Name = "");
3753
Vedant Kumar10c31022017-07-29 00:19:51 +00003754 /// Specifies which type of sanitizer check to apply when handling a
3755 /// particular builtin.
3756 enum BuiltinCheckKind {
3757 BCK_CTZPassedZero,
3758 BCK_CLZPassedZero,
3759 };
3760
3761 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
3762 /// enabled, a runtime check specified by \p Kind is also emitted.
3763 llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
3764
Richard Smithe30752c2012-10-09 19:52:38 +00003765 /// \brief Emit a description of a type in a format suitable for passing to
3766 /// a runtime sanitizer handler.
3767 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3768
3769 /// \brief Convert a value into a format suitable for passing to a runtime
3770 /// sanitizer handler.
3771 llvm::Value *EmitCheckValue(llvm::Value *V);
3772
3773 /// \brief Emit a description of a source location in a format suitable for
3774 /// passing to a runtime sanitizer handler.
3775 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3776
Richard Smithde670682012-11-01 22:15:34 +00003777 /// \brief Create a basic block that will call a handler function in a
3778 /// sanitizer runtime with the provided arguments, and create a conditional
3779 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003780 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00003781 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003782 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003783
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003784 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3785 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003786 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3787 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3788 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003789
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003790 /// Emit a reached-unreachable diagnostic if \p Loc is valid and runtime
3791 /// checking is enabled. Otherwise, just emit an unreachable instruction.
3792 void EmitUnreachable(SourceLocation Loc);
3793
Richard Smithde670682012-11-01 22:15:34 +00003794 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3795 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003796 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003797
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003798 /// \brief Emit a call to trap or debugtrap and attach function attribute
3799 /// "trap-func-name" if specified.
3800 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3801
Evgeniy Stepanov1a8030e2017-04-07 23:00:38 +00003802 /// \brief Emit a stub for the cross-DSO CFI check function.
3803 void EmitCfiCheckStub();
3804
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003805 /// \brief Emit a cross-DSO CFI failure handling function.
3806 void EmitCfiCheckFail();
3807
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003808 /// \brief Create a check for a function parameter that may potentially be
3809 /// declared as non-null.
3810 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003811 AbstractCallee AC, unsigned ParmNum);
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003812
Anders Carlsson093bdff2010-03-30 03:27:09 +00003813 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003814 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003815
John McCall23f66262010-05-26 22:34:26 +00003816 /// EmitDelegateCallArg - We are performing a delegate call; that
3817 /// is, the current function is delegating to another one. Produce
3818 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003819 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3820 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003821
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003822 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3823 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003824 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003825
Chris Lattnercd439292008-11-12 08:04:58 +00003826private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003827 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003828 void EmitReturnOfRValue(RValue RV, QualType Ty);
3829
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003830 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3831
3832 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3833 DeferredReplacements;
3834
John McCall7f416cc2015-09-08 08:05:57 +00003835 /// Set the address of a local variable.
3836 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3837 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3838 LocalDeclMap.insert({VD, Addr});
3839 }
3840
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003841 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3842 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3843 ///
3844 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003845 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003846 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003847
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003848 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3849 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3850 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3851 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3852 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3853 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003854
Chad Rosier59df25b2012-08-23 20:00:18 +00003855 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003856 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003857
Chad Rosier59df25b2012-08-23 20:00:18 +00003858 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003859 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003860 std::string &ConstraintStr,
3861 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003862
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003863 /// \brief Attempts to statically evaluate the object size of E. If that
3864 /// fails, emits code to figure the size of E out for us. This is
3865 /// pass_object_size aware.
George Burgess IV0d6592a2017-02-23 05:59:56 +00003866 ///
3867 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003868 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003869 llvm::IntegerType *ResType,
3870 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003871
3872 /// \brief Emits the size of E, as required by __builtin_object_size. This
3873 /// function is aware of pass_object_size parameters, and will act accordingly
3874 /// if E is a parameter with the pass_object_size attribute.
3875 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003876 llvm::IntegerType *ResType,
3877 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003878
Reid Kleckner89077a12013-12-17 19:46:40 +00003879public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003880#ifndef NDEBUG
3881 // Determine whether the given argument is an Objective-C method
3882 // that may have type parameters in its signature.
3883 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3884 const DeclContext *dc = method->getDeclContext();
3885 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3886 return classDecl->getTypeParamListAsWritten();
3887 }
3888
3889 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3890 return catDecl->getTypeParamList();
3891 }
3892
3893 return false;
3894 }
3895
3896 template<typename T>
3897 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3898#endif
3899
Richard Smitha560ccf2016-09-29 21:30:12 +00003900 enum class EvaluationOrder {
3901 ///! No language constraints on evaluation order.
3902 Default,
3903 ///! Language semantics require left-to-right evaluation.
3904 ForceLeftToRight,
3905 ///! Language semantics require right-to-left evaluation.
3906 ForceRightToLeft
3907 };
3908
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003909 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003910 template <typename T>
3911 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003912 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003913 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003914 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003915 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003916 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003917 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003918
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003919 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3920 "Can't skip parameters if type info is not provided");
3921 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003922#ifndef NDEBUG
3923 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3924#endif
3925
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003926 // First, use the argument types that the type info knows about
3927 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3928 E = CallArgTypeInfo->param_type_end();
3929 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003930 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003931 assert((isGenericMethod ||
3932 ((*I)->isVariablyModifiedType() ||
3933 (*I).getNonReferenceType()->isObjCRetainableType() ||
3934 getContext()
3935 .getCanonicalType((*I).getNonReferenceType())
3936 .getTypePtr() ==
3937 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003938 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003939 .getTypePtr())) &&
3940 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003941 ArgTypes.push_back(*I);
3942 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003943 }
Mike Stump11289f42009-09-09 15:08:12 +00003944
Reid Kleckner739756c2013-12-04 19:23:12 +00003945 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003946 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003947 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3948 CallArgTypeInfo->isVariadic()) &&
3949 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003950
Anders Carlsson603d6af2009-04-18 20:20:22 +00003951 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003952 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00003953 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003954
Vedant Kumared00ea02017-03-06 05:28:22 +00003955 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003956 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003957
Reid Kleckner739756c2013-12-04 19:23:12 +00003958 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003959 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003960 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003961 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003962 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00003963
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00003964 /// EmitPointerWithAlignment - Given an expression with a pointer type,
3965 /// emit the value and compute our best estimate of the alignment of the
3966 /// pointee.
John McCall7f416cc2015-09-08 08:05:57 +00003967 ///
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00003968 /// \param BaseInfo - If non-null, this will be initialized with
3969 /// information about the source of the alignment and the may-alias
3970 /// attribute. Note that this function will conservatively fall back on
3971 /// the type when it doesn't recognize the expression and may-alias will
3972 /// be set to false.
3973 ///
3974 /// One reasonable way to use this information is when there's a language
3975 /// guarantee that the pointer must be aligned to some stricter value, and
3976 /// we're simply trying to ensure that sufficiently obvious uses of under-
3977 /// aligned objects don't get miscompiled; for example, a placement new
3978 /// into the address of a local variable. In such a case, it's quite
3979 /// reasonable to just ignore the returned alignment when it isn't from an
3980 /// explicit source.
John McCall7f416cc2015-09-08 08:05:57 +00003981 Address EmitPointerWithAlignment(const Expr *Addr,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00003982 LValueBaseInfo *BaseInfo = nullptr,
3983 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003984
Vedant Kumar36347d92017-12-08 01:51:47 +00003985 /// If \p E references a parameter with pass_object_size info or a constant
3986 /// array size modifier, emit the object size divided by the size of \p EltTy.
3987 /// Otherwise return null.
3988 llvm::Value *LoadPassedObjectSize(const Expr *E, QualType EltTy);
3989
Peter Collingbournedc134532016-01-16 00:31:22 +00003990 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3991
Erich Keane281d20b2018-01-08 21:34:17 +00003992 struct MultiVersionResolverOption {
3993 llvm::Function *Function;
3994 TargetAttr::ParsedTargetAttr ParsedAttribute;
3995 unsigned Priority;
3996 MultiVersionResolverOption(const TargetInfo &TargInfo, llvm::Function *F,
3997 const clang::TargetAttr::ParsedTargetAttr &PT)
3998 : Function(F), ParsedAttribute(PT), Priority(0u) {
3999 for (StringRef Feat : PT.Features)
4000 Priority = std::max(Priority,
4001 TargInfo.multiVersionSortPriority(Feat.substr(1)));
4002
4003 if (!PT.Architecture.empty())
4004 Priority = std::max(Priority,
4005 TargInfo.multiVersionSortPriority(PT.Architecture));
4006 }
4007
4008 bool operator>(const MultiVersionResolverOption &Other) const {
4009 return Priority > Other.Priority;
4010 }
4011 };
4012 void EmitMultiVersionResolver(llvm::Function *Resolver,
4013 ArrayRef<MultiVersionResolverOption> Options);
4014
Reid Kleckner89077a12013-12-17 19:46:40 +00004015private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004016 QualType getVarArgType(const Expr *Arg);
4017
John McCall09ae0322010-07-06 23:57:41 +00004018 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00004019
John McCall7f416cc2015-09-08 08:05:57 +00004020 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
4021 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00004022
4023 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00004024
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00004025 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Erich Keane9937b132017-09-01 19:42:45 +00004026 llvm::Value *EmitX86CpuIs(const CallExpr *E);
4027 llvm::Value *EmitX86CpuIs(StringRef CPUStr);
4028 llvm::Value *EmitX86CpuSupports(const CallExpr *E);
4029 llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
Erich Keane1fe643a2017-10-06 16:40:45 +00004030 llvm::Value *EmitX86CpuInit();
Erich Keane281d20b2018-01-08 21:34:17 +00004031 llvm::Value *FormResolverCondition(const MultiVersionResolverOption &RO);
Chris Lattnerbed31442007-05-28 01:07:47 +00004032};
Mike Stump11289f42009-09-09 15:08:12 +00004033
John McCallce1de612011-01-26 04:00:11 +00004034/// Helper class with most of the code for saving a value for a
4035/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00004036struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00004037 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
4038
4039 /// Answer whether the given value needs extra work to be saved.
4040 static bool needsSaving(llvm::Value *value) {
4041 // If it's not an instruction, we don't need to save.
4042 if (!isa<llvm::Instruction>(value)) return false;
4043
4044 // If it's an instruction in the entry block, we don't need to save.
4045 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
4046 return (block != &block->getParent()->getEntryBlock());
4047 }
4048
4049 /// Try to save the given value.
4050 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
4051 if (!needsSaving(value)) return saved_type(value, false);
4052
John McCall7f416cc2015-09-08 08:05:57 +00004053 // Otherwise, we need an alloca.
4054 auto align = CharUnits::fromQuantity(
4055 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
4056 Address alloca =
4057 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00004058 CGF.Builder.CreateStore(value, alloca);
4059
John McCall7f416cc2015-09-08 08:05:57 +00004060 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00004061 }
4062
4063 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00004064 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00004065 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00004066
4067 // Otherwise, it should be an alloca instruction, as set up in save().
4068 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
4069 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00004070 }
4071};
4072
John McCallcb5f77f2011-01-28 10:53:53 +00004073/// A partial specialization of DominatingValue for llvm::Values that
4074/// might be llvm::Instructions.
4075template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
4076 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00004077 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00004078 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
4079 }
4080};
4081
John McCall7f416cc2015-09-08 08:05:57 +00004082/// A specialization of DominatingValue for Address.
4083template <> struct DominatingValue<Address> {
4084 typedef Address type;
4085
4086 struct saved_type {
4087 DominatingLLVMValue::saved_type SavedValue;
4088 CharUnits Alignment;
4089 };
4090
4091 static bool needsSaving(type value) {
4092 return DominatingLLVMValue::needsSaving(value.getPointer());
4093 }
4094 static saved_type save(CodeGenFunction &CGF, type value) {
4095 return { DominatingLLVMValue::save(CGF, value.getPointer()),
4096 value.getAlignment() };
4097 }
4098 static type restore(CodeGenFunction &CGF, saved_type value) {
4099 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
4100 value.Alignment);
4101 }
4102};
4103
John McCallcb5f77f2011-01-28 10:53:53 +00004104/// A specialization of DominatingValue for RValue.
4105template <> struct DominatingValue<RValue> {
4106 typedef RValue type;
4107 class saved_type {
4108 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
4109 AggregateAddress, ComplexAddress };
4110
4111 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00004112 unsigned K : 3;
4113 unsigned Align : 29;
4114 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
4115 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00004116
4117 public:
4118 static bool needsSaving(RValue value);
4119 static saved_type save(CodeGenFunction &CGF, RValue value);
4120 RValue restore(CodeGenFunction &CGF);
4121
John McCall7f416cc2015-09-08 08:05:57 +00004122 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00004123 };
4124
4125 static bool needsSaving(type value) {
4126 return saved_type::needsSaving(value);
4127 }
4128 static saved_type save(CodeGenFunction &CGF, type value) {
4129 return saved_type::save(CGF, value);
4130 }
4131 static type restore(CodeGenFunction &CGF, saved_type value) {
4132 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00004133 }
4134};
4135
Chris Lattnerbed31442007-05-28 01:07:47 +00004136} // end namespace CodeGen
4137} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00004138
Chris Lattnerbed31442007-05-28 01:07:47 +00004139#endif