blob: 1a66533f2359525e162e226a1ff123b003f115f2 [file] [log] [blame]
Daniel Dunbar9c426522008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Chris Lattnerbed31442007-05-28 01:07:47 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattnerbed31442007-05-28 01:07:47 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stumpfc496822009-02-08 23:14:22 +000010// This is the internal per-function state used for llvm translation.
Chris Lattnerbed31442007-05-28 01:07:47 +000011//
12//===----------------------------------------------------------------------===//
13
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000014#ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
15#define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
Chris Lattnerbed31442007-05-28 01:07:47 +000016
Daniel Dunbarcb463852008-11-01 01:53:16 +000017#include "CGBuilder.h"
Eric Christophera9d34972011-10-19 00:43:52 +000018#include "CGDebugInfo.h"
Alexander Musman515ad8c2014-05-22 08:54:05 +000019#include "CGLoopInfo.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000020#include "CGValue.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "CodeGenModule.h"
Justin Bogneref512b92014-01-06 22:27:43 +000022#include "CodeGenPGO.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000023#include "EHScopeStack.h"
Vitaly Buka64c80b42016-10-26 05:42:30 +000024#include "VarBypassDetector.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000025#include "clang/AST/CharUnits.h"
26#include "clang/AST/ExprCXX.h"
27#include "clang/AST/ExprObjC.h"
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +000028#include "clang/AST/ExprOpenMP.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000029#include "clang/AST/Type.h"
30#include "clang/Basic/ABI.h"
Ben Langmuir3b4c30b2013-05-09 19:17:11 +000031#include "clang/Basic/CapturedStmt.h"
Alexander Musmandf7a8e22015-01-22 08:49:35 +000032#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000033#include "clang/Basic/TargetInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000034#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000035#include "llvm/ADT/ArrayRef.h"
36#include "llvm/ADT/DenseMap.h"
37#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000038#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000039#include "llvm/Support/Debug.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000040#include "llvm/Transforms/Utils/SanitizerStats.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000041
Chris Lattnerbed31442007-05-28 01:07:47 +000042namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000043class BasicBlock;
44class LLVMContext;
45class MDNode;
46class Module;
47class SwitchInst;
48class Twine;
49class Value;
50class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000051}
52
Chris Lattnerbed31442007-05-28 01:07:47 +000053namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000054class ASTContext;
55class BlockDecl;
56class CXXDestructorDecl;
57class CXXForRangeStmt;
58class CXXTryStmt;
59class Decl;
60class LabelDecl;
61class EnumConstantDecl;
62class FunctionDecl;
63class FunctionProtoType;
64class LabelStmt;
65class ObjCContainerDecl;
66class ObjCInterfaceDecl;
67class ObjCIvarDecl;
68class ObjCMethodDecl;
69class ObjCImplementationDecl;
70class ObjCPropertyImplDecl;
71class TargetInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000072class VarDecl;
73class ObjCForCollectionStmt;
74class ObjCAtTryStmt;
75class ObjCAtThrowStmt;
76class ObjCAtSynchronizedStmt;
77class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000078
Akira Hatanaka6b103bc2017-10-06 07:12:46 +000079namespace analyze_os_log {
80class OSLogBufferLayout;
81}
82
Chris Lattnerbed31442007-05-28 01:07:47 +000083namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000084class CodeGenTypes;
John McCallb92ab1a2016-10-26 23:46:34 +000085class CGCallee;
Rafael Espindola42ae7452014-05-09 00:57:59 +000086class CGFunctionInfo;
87class CGRecordLayout;
88class CGBlockInfo;
89class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000090class BlockByrefHelpers;
91class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000092class BlockFlags;
93class BlockFieldFlags;
Alexey Bataev7292c292016-04-25 12:22:29 +000094class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000095class TargetCodeGenInfo;
Alexey Bataev24b5bae2016-04-28 09:23:51 +000096struct OMPTaskDataTy;
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000097struct CGCoroData;
Mike Stumpfc496822009-02-08 23:14:22 +000098
John McCall47fb9502013-03-07 21:37:08 +000099/// The kind of evaluation to perform on values of a particular
100/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
101/// CGExprAgg?
102///
103/// TODO: should vectors maybe be split out into their own thing?
104enum TypeEvaluationKind {
105 TEK_Scalar,
106 TEK_Complex,
107 TEK_Aggregate
108};
109
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000110#define LIST_SANITIZER_CHECKS \
111 SANITIZER_CHECK(AddOverflow, add_overflow, 0) \
112 SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \
113 SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \
114 SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \
115 SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \
116 SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \
117 SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0) \
Vedant Kumar10c31022017-07-29 00:19:51 +0000118 SANITIZER_CHECK(InvalidBuiltin, invalid_builtin, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000119 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
120 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
121 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
122 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000123 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000124 SANITIZER_CHECK(NullabilityReturn, nullability_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000125 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000126 SANITIZER_CHECK(NonnullReturn, nonnull_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000127 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
Vedant Kumara125eb52017-06-01 19:22:18 +0000128 SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000129 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
130 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
Filipe Cabecinhasfe5e5af2017-01-06 14:40:12 +0000131 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000132 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
133
134enum SanitizerHandler {
135#define SANITIZER_CHECK(Enum, Name, Version) Enum,
136 LIST_SANITIZER_CHECKS
137#undef SANITIZER_CHECK
138};
139
Chris Lattnerbed31442007-05-28 01:07:47 +0000140/// CodeGenFunction - This class organizes the per-function state that is used
141/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000142class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000143 CodeGenFunction(const CodeGenFunction &) = delete;
144 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000145
146 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000147public:
John McCallad5d61e2010-07-23 21:56:41 +0000148 /// A jump destination is an abstract label, branching to which may
149 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000150 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000151 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000152 JumpDest(llvm::BasicBlock *Block,
153 EHScopeStack::stable_iterator Depth,
154 unsigned Index)
155 : Block(Block), ScopeDepth(Depth), Index(Index) {}
156
Craig Topper8a13c412014-05-21 05:09:00 +0000157 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000158 llvm::BasicBlock *getBlock() const { return Block; }
159 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
160 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000161
Nadav Rotem1da30942013-03-23 06:43:35 +0000162 // This should be used cautiously.
163 void setScopeDepth(EHScopeStack::stable_iterator depth) {
164 ScopeDepth = depth;
165 }
166
John McCallad5d61e2010-07-23 21:56:41 +0000167 private:
John McCallbd309292010-07-06 01:34:17 +0000168 llvm::BasicBlock *Block;
169 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000170 unsigned Index;
171 };
172
Chris Lattnerbed31442007-05-28 01:07:47 +0000173 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000174 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000175
Chris Lattner96d72562007-08-21 16:57:55 +0000176 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000177 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000178 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000179
Vitaly Buka64c80b42016-10-26 05:42:30 +0000180 // Stores variables for which we can't generate correct lifetime markers
181 // because of jumps.
182 VarBypassDetector Bypasses;
183
Carlo Bertollib0ff0a62017-04-25 17:52:12 +0000184 // CodeGen lambda for loops and support for ordered clause
185 typedef llvm::function_ref<void(CodeGenFunction &, const OMPLoopDirective &,
186 JumpDest)>
187 CodeGenLoopTy;
188 typedef llvm::function_ref<void(CodeGenFunction &, SourceLocation,
189 const unsigned, const bool)>
190 CodeGenOrderedTy;
191
192 // Codegen lambda for loop bounds in worksharing loop constructs
193 typedef llvm::function_ref<std::pair<LValue, LValue>(
194 CodeGenFunction &, const OMPExecutableDirective &S)>
195 CodeGenLoopBoundsTy;
196
197 // Codegen lambda for loop bounds in dispatch-based loop implementation
198 typedef llvm::function_ref<std::pair<llvm::Value *, llvm::Value *>(
199 CodeGenFunction &, const OMPExecutableDirective &S, Address LB,
200 Address UB)>
201 CodeGenDispatchBoundsTy;
202
Alexander Musman515ad8c2014-05-22 08:54:05 +0000203 /// \brief CGBuilder insert helper. This function is called after an
204 /// instruction is created using Builder.
205 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
206 llvm::BasicBlock *BB,
207 llvm::BasicBlock::iterator InsertPt) const;
208
John McCalldec348f72013-05-03 07:33:41 +0000209 /// CurFuncDecl - Holds the Decl for the current outermost
210 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000211 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000212 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
213 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000214 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000215 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000216 llvm::Function *CurFn;
217
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000218 // Holds coroutine data if the current function is a coroutine. We use a
219 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
220 // in this header.
221 struct CGCoroInfo {
222 std::unique_ptr<CGCoroData> Data;
223 CGCoroInfo();
224 ~CGCoroInfo();
225 };
226 CGCoroInfo CurCoro;
227
Gor Nishanov04491bd2017-11-11 17:00:43 +0000228 bool isCoroutine() const {
229 return CurCoro.Data != nullptr;
230 }
231
Mike Stumpbee78dd2009-12-04 23:26:17 +0000232 /// CurGD - The GlobalDecl for the current function being compiled.
233 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000234
John McCall31168b02011-06-15 23:02:42 +0000235 /// PrologueCleanupDepth - The cleanup depth enclosing all the
236 /// cleanups associated with the parameters.
237 EHScopeStack::stable_iterator PrologueCleanupDepth;
238
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000239 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000240 JumpDest ReturnBlock;
241
John McCall7f416cc2015-09-08 08:05:57 +0000242 /// ReturnValue - The temporary alloca to hold the return
243 /// value. This is invalid iff the function has no return value.
244 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000245
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000246 /// Return true if a label was seen in the current scope.
247 bool hasLabelBeenSeenInCurrentScope() const {
248 if (CurLexicalScope)
249 return CurLexicalScope->hasLabels();
250 return !LabelMap.empty();
251 }
252
Chris Lattner03df1222007-06-02 04:53:11 +0000253 /// AllocaInsertPoint - This is an instruction in the entry block before which
254 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000255 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000256
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000257 /// \brief API for captured statement code generation.
258 class CGCapturedStmtInfo {
259 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000260 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
261 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000262 explicit CGCapturedStmtInfo(const CapturedStmt &S,
263 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000264 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000265
266 RecordDecl::field_iterator Field =
267 S.getCapturedRecordDecl()->field_begin();
268 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
269 E = S.capture_end();
270 I != E; ++I, ++Field) {
271 if (I->capturesThis())
272 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000273 else if (I->capturesVariable())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000274 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000275 else if (I->capturesVariableByCopy())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000276 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000277 }
278 }
279
280 virtual ~CGCapturedStmtInfo();
281
282 CapturedRegionKind getKind() const { return Kind; }
283
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000284 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000285 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000286 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000287
288 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000289 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000290 return CaptureFields.lookup(VD->getCanonicalDecl());
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000291 }
292
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000293 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
294 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000295
Alexey Bataev18095712014-10-10 12:19:54 +0000296 static bool classof(const CGCapturedStmtInfo *) {
297 return true;
298 }
299
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000300 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000301 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000302 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000303 CGF.EmitStmt(S);
304 }
305
306 /// \brief Get the name of the capture helper.
307 virtual StringRef getHelperName() const { return "__captured_stmt"; }
308
309 private:
310 /// \brief The kind of captured statement being generated.
311 CapturedRegionKind Kind;
312
313 /// \brief Keep the map between VarDecl and FieldDecl.
314 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
315
316 /// \brief The base address of the captured record, passed in as the first
317 /// argument of the parallel region function.
318 llvm::Value *ThisValue;
319
320 /// \brief Captured 'this' type.
321 FieldDecl *CXXThisFieldDecl;
322 };
323 CGCapturedStmtInfo *CapturedStmtInfo;
324
Alexey Bataevd157d472015-06-24 03:35:38 +0000325 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
326 class CGCapturedStmtRAII {
327 private:
328 CodeGenFunction &CGF;
329 CGCapturedStmtInfo *PrevCapturedStmtInfo;
330 public:
331 CGCapturedStmtRAII(CodeGenFunction &CGF,
332 CGCapturedStmtInfo *NewCapturedStmtInfo)
333 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
334 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
335 }
336 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
337 };
338
Vedant Kumared00ea02017-03-06 05:28:22 +0000339 /// An abstract representation of regular/ObjC call/message targets.
340 class AbstractCallee {
341 /// The function declaration of the callee.
342 const Decl *CalleeDecl;
343
344 public:
345 AbstractCallee() : CalleeDecl(nullptr) {}
346 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
347 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
348 bool hasFunctionDecl() const {
349 return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
350 }
351 const Decl *getDecl() const { return CalleeDecl; }
352 unsigned getNumParams() const {
353 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
354 return FD->getNumParams();
355 return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
356 }
357 const ParmVarDecl *getParamDecl(unsigned I) const {
358 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
359 return FD->getParamDecl(I);
360 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
361 }
362 };
363
Alexey Samsonova0416102014-11-11 01:26:14 +0000364 /// \brief Sanitizers enabled for this function.
365 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000366
Alexey Samsonov24cad992014-07-17 18:46:27 +0000367 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
368 bool IsSanitizerScope;
369
370 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
371 class SanitizerScope {
372 CodeGenFunction *CGF;
373 public:
374 SanitizerScope(CodeGenFunction *CGF);
375 ~SanitizerScope();
376 };
377
Reid Kleckner19819442014-07-25 21:39:46 +0000378 /// In C++, whether we are code generating a thunk. This controls whether we
379 /// should emit cleanups.
380 bool CurFuncIsThunk;
381
John McCall31168b02011-06-15 23:02:42 +0000382 /// In ARC, whether we should autorelease the return value.
383 bool AutoreleaseResult;
384
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000385 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
386 /// potentially set the return value.
387 bool SawAsmBlock;
388
David Majnemer25eb1652016-03-01 19:42:53 +0000389 const FunctionDecl *CurSEHParent = nullptr;
390
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000391 /// True if the current function is an outlined SEH helper. This can be a
392 /// finally block or filter expression.
393 bool IsOutlinedSEHHelper;
394
John McCallad7c5c12011-02-08 08:22:06 +0000395 const CodeGen::CGBlockInfo *BlockInfo;
396 llvm::Value *BlockPointer;
397
Eli Friedman9fbeba02012-02-11 02:57:39 +0000398 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
399 FieldDecl *LambdaThisCaptureField;
400
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000401 /// \brief A mapping from NRVO variables to the flags used to indicate
402 /// when the NRVO has been applied to this variable.
403 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000404
John McCallbd309292010-07-06 01:34:17 +0000405 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000406 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000407 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000408
David Majnemer4e52d6f2015-12-12 05:39:21 +0000409 llvm::Instruction *CurrentFuncletPad = nullptr;
410
Tim Shen421119f2016-07-01 21:08:47 +0000411 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
412 llvm::Value *Addr;
413 llvm::Value *Size;
414
415 public:
416 CallLifetimeEnd(Address addr, llvm::Value *size)
417 : Addr(addr.getPointer()), Size(size) {}
418
419 void Emit(CodeGenFunction &CGF, Flags flags) override {
420 CGF.EmitLifetimeEnd(Size, Addr);
421 }
422 };
423
Richard Smith736a9472013-06-12 20:42:33 +0000424 /// Header for data within LifetimeExtendedCleanupStack.
425 struct LifetimeExtendedCleanupHeader {
426 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000427 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000428 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000429 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000430
Justin Bognerbdff2192015-07-01 00:59:27 +0000431 size_t getSize() const { return Size; }
432 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000433 };
John McCallbd309292010-07-06 01:34:17 +0000434
John McCallad5d61e2010-07-23 21:56:41 +0000435 /// i32s containing the indexes of the cleanup destinations.
436 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000437
438 unsigned NextCleanupDestIndex;
439
John McCall08ef4662011-11-10 08:15:53 +0000440 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
441 CGBlockInfo *FirstBlockInfo;
442
John McCall8e4c74b2011-08-11 02:22:43 +0000443 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
444 llvm::BasicBlock *EHResumeBlock;
445
Bill Wendlingf0724e82011-09-19 20:31:14 +0000446 /// The exception slot. All landing pads write the current exception pointer
447 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000448 llvm::Value *ExceptionSlot;
449
Bill Wendlingf0724e82011-09-19 20:31:14 +0000450 /// The selector slot. Under the MandatoryCleanup model, all landing pads
451 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000452 llvm::AllocaInst *EHSelectorSlot;
453
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000454 /// A stack of exception code slots. Entering an __except block pushes a slot
455 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
456 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000457 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000458
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000459 /// Value returned by __exception_info intrinsic.
460 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000461
John McCallbd309292010-07-06 01:34:17 +0000462 /// Emits a landing pad for the current EH stack.
463 llvm::BasicBlock *EmitLandingPad();
464
465 llvm::BasicBlock *getInvokeDestImpl();
466
John McCallce1de612011-01-26 04:00:11 +0000467 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000468 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
469 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000470 }
471
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000472public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000473 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
474 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000475 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000476
John McCall6b0feb72011-06-22 02:32:12 +0000477 /// A class controlling the emission of a finally block.
478 class FinallyInfo {
479 /// Where the catchall's edge through the cleanup should go.
480 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000481
John McCall6b0feb72011-06-22 02:32:12 +0000482 /// A function to call to enter the catch.
483 llvm::Constant *BeginCatchFn;
484
485 /// An i1 variable indicating whether or not the @finally is
486 /// running for an exception.
487 llvm::AllocaInst *ForEHVar;
488
489 /// An i8* variable into which the exception pointer to rethrow
490 /// has been saved.
491 llvm::AllocaInst *SavedExnVar;
492
493 public:
494 void enter(CodeGenFunction &CGF, const Stmt *Finally,
495 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
496 llvm::Constant *rethrowFn);
497 void exit(CodeGenFunction &CGF);
498 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000499
Reid Kleckner11c033e2015-02-12 23:40:45 +0000500 /// Returns true inside SEH __try blocks.
501 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
502
Reid Klecknera002bd52015-10-28 23:06:42 +0000503 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000504 bool isCleanupPadScope() const {
505 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
506 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000507
John McCallce1de612011-01-26 04:00:11 +0000508 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
509 /// current full-expression. Safe against the possibility that
510 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000511 template <class T, class... As>
512 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000513 // If we're not in a conditional branch, or if none of the
514 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000515 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000516 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000517
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000518 // Stash values in a tuple so we can guarantee the order of saves.
519 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
520 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000521
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000522 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000523 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000524 initFullExprCleanup();
525 }
526
Richard Smith736a9472013-06-12 20:42:33 +0000527 /// \brief Queue a cleanup to be pushed after finishing the current
528 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000529 template <class T, class... As>
530 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000531 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
532
533 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
534
535 size_t OldSize = LifetimeExtendedCleanupStack.size();
536 LifetimeExtendedCleanupStack.resize(
537 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
538
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000539 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000540 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000541 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
542 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000543 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000544 }
545
John McCallf4beacd2011-11-10 10:43:54 +0000546 /// Set up the last cleaup that was pushed as a conditional
547 /// full-expression cleanup.
548 void initFullExprCleanup();
549
John McCallbd309292010-07-06 01:34:17 +0000550 /// PushDestructorCleanup - Push a cleanup to call the
551 /// complete-object destructor of an object of the given type at the
552 /// given address. Does nothing if T is not a C++ class type with a
553 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000554 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000555
John McCall8680f872010-07-21 06:29:51 +0000556 /// PushDestructorCleanup - Push a cleanup to call the
557 /// complete-object variant of the given destructor on the object at
558 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000559 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000560
John McCallbd309292010-07-06 01:34:17 +0000561 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
562 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000563 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000564
John McCall824c2f52010-09-14 07:57:04 +0000565 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
566 /// The block cannot be reactivated. Pops it if it's the top of the
567 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000568 ///
569 /// \param DominatingIP - An instruction which is known to
570 /// dominate the current IP (if set) and which lies along
571 /// all paths of execution between the current IP and the
572 /// the point at which the cleanup comes into scope.
573 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
574 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000575
576 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
577 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000578 ///
579 /// \param DominatingIP - An instruction which is known to
580 /// dominate the current IP (if set) and which lies along
581 /// all paths of execution between the current IP and the
582 /// the point at which the cleanup comes into scope.
583 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
584 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000585
John McCallbd309292010-07-06 01:34:17 +0000586 /// \brief Enters a new scope for capturing cleanups, all of which
587 /// will be executed once the scope is exited.
588 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000589 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000590 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000591 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000592 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000593 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000594 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000595
Aaron Ballmanabc18922015-02-15 22:54:08 +0000596 RunCleanupsScope(const RunCleanupsScope &) = delete;
597 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000598
Eric Christophera9d34972011-10-19 00:43:52 +0000599 protected:
600 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000601
Douglas Gregor965f4502009-11-24 16:43:22 +0000602 public:
603 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000604 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000605 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000606 {
John McCallbd309292010-07-06 01:34:17 +0000607 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000608 LifetimeExtendedCleanupStackSize =
609 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000610 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000611 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000612 }
613
Reid Kleckner092d0652017-03-06 22:18:34 +0000614 /// \brief Exit this cleanup scope, emitting any accumulated cleanups.
John McCallbd309292010-07-06 01:34:17 +0000615 ~RunCleanupsScope() {
Reid Kleckner092d0652017-03-06 22:18:34 +0000616 if (PerformCleanup)
617 ForceCleanup();
Douglas Gregor680f8612009-11-24 21:15:44 +0000618 }
619
620 /// \brief Determine whether this scope requires any cleanups.
621 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000622 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000623 }
624
625 /// \brief Force the emission of cleanups now, instead of waiting
626 /// until this object is destroyed.
Reid Kleckner092d0652017-03-06 22:18:34 +0000627 /// \param ValuesToReload - A list of values that need to be available at
628 /// the insertion point after cleanup emission. If cleanup emission created
629 /// a shared cleanup block, these value pointers will be rewritten.
630 /// Otherwise, they not will be modified.
631 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
Douglas Gregor680f8612009-11-24 21:15:44 +0000632 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000633 CGF.DidCallStackSave = OldDidCallStackSave;
Reid Kleckner092d0652017-03-06 22:18:34 +0000634 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
635 ValuesToReload);
Douglas Gregor680f8612009-11-24 21:15:44 +0000636 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000637 }
638 };
639
David Blaikie93be0b22014-08-22 21:37:04 +0000640 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000641 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000642 SmallVector<const LabelDecl*, 4> Labels;
643 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000644
Aaron Ballmanabc18922015-02-15 22:54:08 +0000645 LexicalScope(const LexicalScope &) = delete;
646 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000647
648 public:
649 /// \brief Enter a new cleanup scope.
650 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000651 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
652 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000653 if (CGDebugInfo *DI = CGF.getDebugInfo())
654 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
655 }
656
Nadav Rotem1da30942013-03-23 06:43:35 +0000657 void addLabel(const LabelDecl *label) {
658 assert(PerformCleanup && "adding label to dead scope?");
659 Labels.push_back(label);
660 }
661
Eric Christophera9d34972011-10-19 00:43:52 +0000662 /// \brief Exit this cleanup scope, emitting any accumulated
663 /// cleanups.
664 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000665 if (CGDebugInfo *DI = CGF.getDebugInfo())
666 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
667
Nadav Rotem1da30942013-03-23 06:43:35 +0000668 // If we should perform a cleanup, force them now. Note that
669 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000670 if (PerformCleanup) {
671 ApplyDebugLocation DL(CGF, Range.getEnd());
672 ForceCleanup();
673 }
Eric Christophera9d34972011-10-19 00:43:52 +0000674 }
675
676 /// \brief Force the emission of cleanups now, instead of waiting
677 /// until this object is destroyed.
678 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000679 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000680 RunCleanupsScope::ForceCleanup();
681
Nadav Rotem1da30942013-03-23 06:43:35 +0000682 if (!Labels.empty())
683 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000684 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000685
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000686 bool hasLabels() const {
687 return !Labels.empty();
688 }
689
Nadav Rotem1da30942013-03-23 06:43:35 +0000690 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000691 };
692
John McCall7f416cc2015-09-08 08:05:57 +0000693 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
694
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000695 /// \brief The scope used to remap some variables as private in the OpenMP
696 /// loop body (or other captured region emitted without outlining), and to
697 /// restore old vars back on exit.
698 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000699 DeclMapTy SavedLocals;
700 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000701
702 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000703 OMPPrivateScope(const OMPPrivateScope &) = delete;
704 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000705
706 public:
707 /// \brief Enter a new OpenMP private scope.
708 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
709
710 /// \brief Registers \a LocalVD variable as a private and apply \a
711 /// PrivateGen function for it to generate corresponding private variable.
712 /// \a PrivateGen returns an address of the generated private variable.
713 /// \return true if the variable is registered as private, false if it has
714 /// been privatized already.
715 bool
716 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000717 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000718 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000719
Alexey Bataev6a71f362017-08-22 17:54:52 +0000720 LocalVD = LocalVD->getCanonicalDecl();
John McCall7f416cc2015-09-08 08:05:57 +0000721 // Only save it once.
722 if (SavedLocals.count(LocalVD)) return false;
723
724 // Copy the existing local entry to SavedLocals.
725 auto it = CGF.LocalDeclMap.find(LocalVD);
726 if (it != CGF.LocalDeclMap.end()) {
727 SavedLocals.insert({LocalVD, it->second});
728 } else {
729 SavedLocals.insert({LocalVD, Address::invalid()});
730 }
731
732 // Generate the private entry.
733 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000734 QualType VarTy = LocalVD->getType();
735 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000736 Address Temp = CGF.CreateMemTemp(VarTy);
737 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
738 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000739 }
John McCall7f416cc2015-09-08 08:05:57 +0000740 SavedPrivates.insert({LocalVD, Addr});
741
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000742 return true;
743 }
744
745 /// \brief Privatizes local variables previously registered as private.
746 /// Registration is separate from the actual privatization to allow
747 /// initializers use values of the original variables, not the private one.
748 /// This is important, for example, if the private variable is a class
749 /// variable initialized by a constructor that references other private
750 /// variables. But at initialization original variables must be used, not
751 /// private copies.
752 /// \return true if at least one variable was privatized, false otherwise.
753 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000754 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000755 SavedPrivates.clear();
756 return !SavedLocals.empty();
757 }
758
759 void ForceCleanup() {
760 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000761 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000762 SavedLocals.clear();
763 }
764
765 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000766 ~OMPPrivateScope() {
767 if (PerformCleanup)
768 ForceCleanup();
769 }
John McCall7f416cc2015-09-08 08:05:57 +0000770
Gor Nishanov04491bd2017-11-11 17:00:43 +0000771 /// Checks if the global variable is captured in current function.
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000772 bool isGlobalVarCaptured(const VarDecl *VD) const {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000773 VD = VD->getCanonicalDecl();
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000774 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
775 }
776
John McCall7f416cc2015-09-08 08:05:57 +0000777 private:
778 /// Copy all the entries in the source map over the corresponding
779 /// entries in the destination, which must exist.
780 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
781 for (auto &pair : src) {
782 if (!pair.second.isValid()) {
783 dest.erase(pair.first);
784 continue;
785 }
786
787 auto it = dest.find(pair.first);
788 if (it != dest.end()) {
789 it->second = pair.second;
790 } else {
791 dest.insert(pair);
792 }
793 }
794 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000795 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000796
Richard Smith736a9472013-06-12 20:42:33 +0000797 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
798 /// that have been added.
Reid Kleckner092d0652017-03-06 22:18:34 +0000799 void
800 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
801 std::initializer_list<llvm::Value **> ValuesToReload = {});
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000802
Richard Smith736a9472013-06-12 20:42:33 +0000803 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
804 /// that have been added, then adds all lifetime-extended cleanups from
805 /// the given position to the stack.
Reid Kleckner092d0652017-03-06 22:18:34 +0000806 void
807 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
808 size_t OldLifetimeExtendedStackSize,
809 std::initializer_list<llvm::Value **> ValuesToReload = {});
Richard Smith736a9472013-06-12 20:42:33 +0000810
John McCallad5d61e2010-07-23 21:56:41 +0000811 void ResolveBranchFixups(llvm::BasicBlock *Target);
812
John McCallbd309292010-07-06 01:34:17 +0000813 /// The given basic block lies in the current EH scope, but may be a
814 /// target of a potentially scope-crossing jump; get a stable handle
815 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000816 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000817 return JumpDest(Target,
818 EHStack.getInnermostNormalCleanup(),
819 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000820 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000821
John McCallbd309292010-07-06 01:34:17 +0000822 /// The given basic block lies in the current EH scope, but may be a
823 /// target of a potentially scope-crossing jump; get a stable handle
824 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000825 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000826 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000827 }
828
829 /// EmitBranchThroughCleanup - Emit a branch from the current insert
830 /// block through the normal cleanup handling code (if any) and then
831 /// on to \arg Dest.
832 void EmitBranchThroughCleanup(JumpDest Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +0000833
Justin Bognere25ffdf2014-01-21 00:35:11 +0000834 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
835 /// specified destination obviously has no cleanups to run. 'false' is always
836 /// a conservatively correct answer for this method.
837 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
838
John McCall8e4c74b2011-08-11 02:22:43 +0000839 /// popCatchScope - Pops the catch scope at the top of the EHScope
840 /// stack, emitting any required code (other than the catch handlers
841 /// themselves).
842 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000843
David Chisnall9a837be2012-11-07 16:50:40 +0000844 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000845 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000846 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000847
John McCallce1de612011-01-26 04:00:11 +0000848 /// An object to manage conditionally-evaluated expressions.
849 class ConditionalEvaluation {
850 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000851
John McCallce1de612011-01-26 04:00:11 +0000852 public:
853 ConditionalEvaluation(CodeGenFunction &CGF)
854 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000855
John McCallce1de612011-01-26 04:00:11 +0000856 void begin(CodeGenFunction &CGF) {
857 assert(CGF.OutermostConditional != this);
858 if (!CGF.OutermostConditional)
859 CGF.OutermostConditional = this;
860 }
861
862 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000863 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000864 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000865 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000866 }
867
868 /// Returns a block which will be executed prior to each
869 /// evaluation of the conditional code.
870 llvm::BasicBlock *getStartingBlock() const {
871 return StartBB;
872 }
873 };
Mike Stump11289f42009-09-09 15:08:12 +0000874
John McCall7f9c92a2010-09-17 00:50:28 +0000875 /// isInConditionalBranch - Return true if we're currently emitting
876 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000877 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000878
John McCall7f416cc2015-09-08 08:05:57 +0000879 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000880 assert(isInConditionalBranch());
881 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000882 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
883 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000884 }
885
John McCallce1de612011-01-26 04:00:11 +0000886 /// An RAII object to record that we're evaluating a statement
887 /// expression.
888 class StmtExprEvaluation {
889 CodeGenFunction &CGF;
890
891 /// We have to save the outermost conditional: cleanups in a
892 /// statement expression aren't conditional just because the
893 /// StmtExpr is.
894 ConditionalEvaluation *SavedOutermostConditional;
895
896 public:
897 StmtExprEvaluation(CodeGenFunction &CGF)
898 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000899 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000900 }
901
902 ~StmtExprEvaluation() {
903 CGF.OutermostConditional = SavedOutermostConditional;
904 CGF.EnsureInsertPoint();
905 }
906 };
John McCall1bf58462011-02-16 08:02:54 +0000907
John McCallc07a0c72011-02-17 10:25:35 +0000908 /// An object which temporarily prevents a value from being
909 /// destroyed by aggressive peephole optimizations that assume that
910 /// all uses of a value have been realized in the IR.
911 class PeepholeProtection {
912 llvm::Instruction *Inst;
913 friend class CodeGenFunction;
914
915 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000916 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000917 };
John McCallc07a0c72011-02-17 10:25:35 +0000918
John McCallfe96e0b2011-11-06 09:01:30 +0000919 /// A non-RAII class containing all the information about a bound
920 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
921 /// this which makes individual mappings very simple; using this
922 /// class directly is useful when you have a variable number of
923 /// opaque values or don't want the RAII functionality for some
924 /// reason.
925 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000926 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000927 bool BoundLValue;
928 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000929
John McCallfe96e0b2011-11-06 09:01:30 +0000930 OpaqueValueMappingData(const OpaqueValueExpr *ov,
931 bool boundLValue)
932 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000933 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000934 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000935
John McCallc07a0c72011-02-17 10:25:35 +0000936 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000937 // gl-values should be bound as l-values for obvious reasons.
938 // Records should be bound as l-values because IR generation
939 // always keeps them in memory. Expressions of function type
940 // act exactly like l-values but are formally required to be
941 // r-values in C.
942 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000943 expr->getType()->isFunctionType() ||
944 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000945 }
946
John McCallfe96e0b2011-11-06 09:01:30 +0000947 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
948 const OpaqueValueExpr *ov,
949 const Expr *e) {
950 if (shouldBindAsLValue(ov))
951 return bind(CGF, ov, CGF.EmitLValue(e));
952 return bind(CGF, ov, CGF.EmitAnyExpr(e));
953 }
954
955 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
956 const OpaqueValueExpr *ov,
957 const LValue &lv) {
958 assert(shouldBindAsLValue(ov));
959 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
960 return OpaqueValueMappingData(ov, true);
961 }
962
963 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
964 const OpaqueValueExpr *ov,
965 const RValue &rv) {
966 assert(!shouldBindAsLValue(ov));
967 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
968
969 OpaqueValueMappingData data(ov, false);
970
971 // Work around an extremely aggressive peephole optimization in
972 // EmitScalarConversion which assumes that all other uses of a
973 // value are extant.
974 data.Protection = CGF.protectFromPeepholes(rv);
975
976 return data;
977 }
978
Craig Topper8a13c412014-05-21 05:09:00 +0000979 bool isValid() const { return OpaqueValue != nullptr; }
980 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000981
982 void unbind(CodeGenFunction &CGF) {
983 assert(OpaqueValue && "no data to unbind!");
984
985 if (BoundLValue) {
986 CGF.OpaqueLValues.erase(OpaqueValue);
987 } else {
988 CGF.OpaqueRValues.erase(OpaqueValue);
989 CGF.unprotectFromPeepholes(Protection);
990 }
991 }
992 };
993
994 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
995 class OpaqueValueMapping {
996 CodeGenFunction &CGF;
997 OpaqueValueMappingData Data;
998
999 public:
1000 static bool shouldBindAsLValue(const Expr *expr) {
1001 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1002 }
1003
John McCallc07a0c72011-02-17 10:25:35 +00001004 /// Build the opaque value mapping for the given conditional
1005 /// operator if it's the GNU ?: extension. This is a common
1006 /// enough pattern that the convenience operator is really
1007 /// helpful.
1008 ///
1009 OpaqueValueMapping(CodeGenFunction &CGF,
1010 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +00001011 if (isa<ConditionalOperator>(op))
1012 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001013 return;
John McCallc07a0c72011-02-17 10:25:35 +00001014
1015 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001016 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1017 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001018 }
1019
Richard Smith410306b2016-12-12 02:53:20 +00001020 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1021 /// expression is set to the expression the OVE represents.
1022 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1023 : CGF(CGF) {
1024 if (OV) {
1025 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1026 "for OVE with no source expression");
1027 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1028 }
1029 }
1030
John McCall1bf58462011-02-16 08:02:54 +00001031 OpaqueValueMapping(CodeGenFunction &CGF,
1032 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001033 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001034 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001035 }
1036
1037 OpaqueValueMapping(CodeGenFunction &CGF,
1038 const OpaqueValueExpr *opaqueValue,
1039 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001040 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001041 }
1042
1043 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001044 Data.unbind(CGF);
1045 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001046 }
1047
1048 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001049 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001050 }
1051 };
Gor Nishanov04491bd2017-11-11 17:00:43 +00001052
Chris Lattner2da04b32007-08-24 05:35:26 +00001053private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001054 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001055 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001056
John McCall9b382dd2011-05-28 21:13:02 +00001057 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1058 /// calling llvm.stacksave for multiple VLAs in the same scope.
1059 bool DidCallStackSave;
1060
Mike Stumpe5311b02009-11-30 20:08:49 +00001061 /// IndirectBranch - The first time an indirect goto is seen we create a block
1062 /// with an indirect branch. Every time we see the address of a label taken,
1063 /// we add the label to the indirect goto. Every subsequent indirect goto is
1064 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +00001065 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001066
Mike Stumpfc496822009-02-08 23:14:22 +00001067 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1068 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001069 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001070
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001071 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1072 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1073 /// parameter.
1074 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1075 SizeArguments;
1076
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001077 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001078 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001079 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1080
Chris Lattnerac248202007-05-30 00:13:02 +00001081 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001082 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001083
Mike Stumpfc496822009-02-08 23:14:22 +00001084 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001085 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001086 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001087 BreakContinue(JumpDest Break, JumpDest Continue)
1088 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001089
John McCallbd309292010-07-06 01:34:17 +00001090 JumpDest BreakBlock;
1091 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001092 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001093 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001094
Alexey Bataev957d8562016-11-17 15:12:05 +00001095 /// Handles cancellation exit points in OpenMP-related constructs.
1096 class OpenMPCancelExitStack {
1097 /// Tracks cancellation exit point and join point for cancel-related exit
1098 /// and normal exit.
1099 struct CancelExit {
1100 CancelExit() = default;
1101 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1102 JumpDest ContBlock)
1103 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1104 OpenMPDirectiveKind Kind = OMPD_unknown;
1105 /// true if the exit block has been emitted already by the special
1106 /// emitExit() call, false if the default codegen is used.
1107 bool HasBeenEmitted = false;
1108 JumpDest ExitBlock;
1109 JumpDest ContBlock;
1110 };
1111
1112 SmallVector<CancelExit, 8> Stack;
1113
1114 public:
1115 OpenMPCancelExitStack() : Stack(1) {}
1116 ~OpenMPCancelExitStack() = default;
1117 /// Fetches the exit block for the current OpenMP construct.
1118 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1119 /// Emits exit block with special codegen procedure specific for the related
1120 /// OpenMP construct + emits code for normal construct cleanup.
1121 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1122 const llvm::function_ref<void(CodeGenFunction &)> &CodeGen) {
1123 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1124 assert(CGF.getOMPCancelDestination(Kind).isValid());
1125 assert(CGF.HaveInsertPoint());
1126 assert(!Stack.back().HasBeenEmitted);
1127 auto IP = CGF.Builder.saveAndClearIP();
1128 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1129 CodeGen(CGF);
Erich Keane0026ed22017-07-27 16:28:20 +00001130 CGF.EmitBranch(Stack.back().ContBlock.getBlock());
Alexey Bataev957d8562016-11-17 15:12:05 +00001131 CGF.Builder.restoreIP(IP);
1132 Stack.back().HasBeenEmitted = true;
1133 }
1134 CodeGen(CGF);
1135 }
1136 /// Enter the cancel supporting \a Kind construct.
1137 /// \param Kind OpenMP directive that supports cancel constructs.
1138 /// \param HasCancel true, if the construct has inner cancel directive,
1139 /// false otherwise.
1140 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1141 Stack.push_back({Kind,
1142 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1143 : JumpDest(),
1144 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1145 : JumpDest()});
1146 }
1147 /// Emits default exit point for the cancel construct (if the special one
1148 /// has not be used) + join point for cancel/normal exits.
1149 void exit(CodeGenFunction &CGF) {
1150 if (getExitBlock().isValid()) {
1151 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1152 bool HaveIP = CGF.HaveInsertPoint();
1153 if (!Stack.back().HasBeenEmitted) {
1154 if (HaveIP)
1155 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1156 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1157 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1158 }
1159 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1160 if (!HaveIP) {
1161 CGF.Builder.CreateUnreachable();
1162 CGF.Builder.ClearInsertionPoint();
1163 }
1164 }
1165 Stack.pop_back();
1166 }
1167 };
1168 OpenMPCancelExitStack OMPCancelStack;
1169
Justin Bogneref512b92014-01-06 22:27:43 +00001170 CodeGenPGO PGO;
1171
Justin Bogner65512642015-05-02 05:00:55 +00001172 /// Calculate branch weights appropriate for PGO data
1173 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1174 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1175 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1176 uint64_t LoopCount);
1177
Justin Bogneref512b92014-01-06 22:27:43 +00001178public:
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001179 /// Increment the profiler's counter for the given statement by \p StepV.
1180 /// If \p StepV is null, the default increment is 1.
1181 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
Rong Xu9837ef52016-02-04 18:39:09 +00001182 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001183 PGO.emitCounterIncrement(Builder, S, StepV);
Justin Bogner66242d62015-04-23 23:06:47 +00001184 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001185 }
Justin Bogner66242d62015-04-23 23:06:47 +00001186
1187 /// Get the profiler's count for the given statement.
1188 uint64_t getProfileCount(const Stmt *S) {
1189 Optional<uint64_t> Count = PGO.getStmtCount(S);
1190 if (!Count.hasValue())
1191 return 0;
1192 return *Count;
1193 }
1194
1195 /// Set the profiler's current count.
1196 void setCurrentProfileCount(uint64_t Count) {
1197 PGO.setCurrentRegionCount(Count);
1198 }
1199
1200 /// Get the profiler's current count. This is generally the count for the most
1201 /// recently incremented counter.
1202 uint64_t getCurrentProfileCount() {
1203 return PGO.getCurrentRegionCount();
1204 }
1205
Justin Bogneref512b92014-01-06 22:27:43 +00001206private:
1207
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001208 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001209 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001210 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001211 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1212 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001213
Mike Stumpfc496822009-02-08 23:14:22 +00001214 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001215 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001216 llvm::BasicBlock *CaseRangeBlock;
1217
John McCallc07a0c72011-02-17 10:25:35 +00001218 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001219 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001220 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1221 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001222
Mike Stumpfc496822009-02-08 23:14:22 +00001223 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001224 // We track this by the size expression rather than the type itself because
1225 // in certain situations, like a const qualifier applied to an VLA typedef,
1226 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001227 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1228 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001229 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001230
John McCallbd309292010-07-06 01:34:17 +00001231 /// A block containing a single 'unreachable' instruction. Created
1232 /// lazily by getUnreachableBlock().
1233 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001234
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001235 /// Counts of the number return expressions in the function.
1236 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001237
1238 /// Count the number of simple (constant) return expressions in the function.
1239 unsigned NumSimpleReturnExprs;
1240
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001241 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001242 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001243
Richard Smith852c9db2013-04-20 22:23:05 +00001244public:
1245 /// A scope within which we are constructing the fields of an object which
1246 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1247 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1248 class FieldConstructionScope {
1249 public:
John McCall7f416cc2015-09-08 08:05:57 +00001250 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001251 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1252 CGF.CXXDefaultInitExprThis = This;
1253 }
1254 ~FieldConstructionScope() {
1255 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1256 }
1257
1258 private:
1259 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001260 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001261 };
1262
1263 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1264 /// is overridden to be the object under construction.
1265 class CXXDefaultInitExprScope {
1266 public:
1267 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001268 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1269 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1270 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1271 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001272 }
1273 ~CXXDefaultInitExprScope() {
1274 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001275 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001276 }
1277
1278 public:
1279 CodeGenFunction &CGF;
1280 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001281 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001282 };
1283
Richard Smith410306b2016-12-12 02:53:20 +00001284 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1285 /// current loop index is overridden.
1286 class ArrayInitLoopExprScope {
1287 public:
1288 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1289 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1290 CGF.ArrayInitIndex = Index;
1291 }
1292 ~ArrayInitLoopExprScope() {
1293 CGF.ArrayInitIndex = OldArrayInitIndex;
1294 }
1295
1296 private:
1297 CodeGenFunction &CGF;
1298 llvm::Value *OldArrayInitIndex;
1299 };
1300
Richard Smith5179eb72016-06-28 19:03:57 +00001301 class InlinedInheritingConstructorScope {
1302 public:
1303 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1304 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1305 OldCurCodeDecl(CGF.CurCodeDecl),
1306 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1307 OldCXXABIThisValue(CGF.CXXABIThisValue),
1308 OldCXXThisValue(CGF.CXXThisValue),
1309 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1310 OldCXXThisAlignment(CGF.CXXThisAlignment),
1311 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1312 OldCXXInheritedCtorInitExprArgs(
1313 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1314 CGF.CurGD = GD;
1315 CGF.CurFuncDecl = CGF.CurCodeDecl =
1316 cast<CXXConstructorDecl>(GD.getDecl());
1317 CGF.CXXABIThisDecl = nullptr;
1318 CGF.CXXABIThisValue = nullptr;
1319 CGF.CXXThisValue = nullptr;
1320 CGF.CXXABIThisAlignment = CharUnits();
1321 CGF.CXXThisAlignment = CharUnits();
1322 CGF.ReturnValue = Address::invalid();
1323 CGF.FnRetTy = QualType();
1324 CGF.CXXInheritedCtorInitExprArgs.clear();
1325 }
1326 ~InlinedInheritingConstructorScope() {
1327 CGF.CurGD = OldCurGD;
1328 CGF.CurFuncDecl = OldCurFuncDecl;
1329 CGF.CurCodeDecl = OldCurCodeDecl;
1330 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1331 CGF.CXXABIThisValue = OldCXXABIThisValue;
1332 CGF.CXXThisValue = OldCXXThisValue;
1333 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1334 CGF.CXXThisAlignment = OldCXXThisAlignment;
1335 CGF.ReturnValue = OldReturnValue;
1336 CGF.FnRetTy = OldFnRetTy;
1337 CGF.CXXInheritedCtorInitExprArgs =
1338 std::move(OldCXXInheritedCtorInitExprArgs);
1339 }
1340
1341 private:
1342 CodeGenFunction &CGF;
1343 GlobalDecl OldCurGD;
1344 const Decl *OldCurFuncDecl;
1345 const Decl *OldCurCodeDecl;
1346 ImplicitParamDecl *OldCXXABIThisDecl;
1347 llvm::Value *OldCXXABIThisValue;
1348 llvm::Value *OldCXXThisValue;
1349 CharUnits OldCXXABIThisAlignment;
1350 CharUnits OldCXXThisAlignment;
1351 Address OldReturnValue;
1352 QualType OldFnRetTy;
1353 CallArgList OldCXXInheritedCtorInitExprArgs;
1354 };
1355
Richard Smith852c9db2013-04-20 22:23:05 +00001356private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001357 /// CXXThisDecl - When generating code for a C++ member function,
1358 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001359 ImplicitParamDecl *CXXABIThisDecl;
1360 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001361 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001362 CharUnits CXXABIThisAlignment;
1363 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001364
Richard Smith852c9db2013-04-20 22:23:05 +00001365 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1366 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001367 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001368
Richard Smith410306b2016-12-12 02:53:20 +00001369 /// The current array initialization index when evaluating an
1370 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1371 llvm::Value *ArrayInitIndex = nullptr;
1372
Richard Smith5179eb72016-06-28 19:03:57 +00001373 /// The values of function arguments to use when evaluating
1374 /// CXXInheritedCtorInitExprs within this context.
1375 CallArgList CXXInheritedCtorInitExprArgs;
1376
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001377 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1378 /// destructor, this will hold the implicit argument (e.g. VTT).
1379 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1380 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001381
John McCallce1de612011-01-26 04:00:11 +00001382 /// OutermostConditional - Points to the outermost active
1383 /// conditional control. This is used so that we know if a
1384 /// temporary should be destroyed conditionally.
1385 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001386
Nadav Rotem1da30942013-03-23 06:43:35 +00001387 /// The current lexical scope.
1388 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001389
Adrian Prantldc237b52013-05-16 00:41:26 +00001390 /// The current source location that should be used for exception
1391 /// handling code.
1392 SourceLocation CurEHLocation;
1393
John McCall7f416cc2015-09-08 08:05:57 +00001394 /// BlockByrefInfos - For each __block variable, contains
1395 /// information about the layout of the variable.
1396 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001397
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001398 /// Used by -fsanitize=nullability-return to determine whether the return
1399 /// value can be checked.
1400 llvm::Value *RetValNullabilityPrecondition = nullptr;
1401
1402 /// Check if -fsanitize=nullability-return instrumentation is required for
1403 /// this function.
1404 bool requiresReturnValueNullabilityCheck() const {
1405 return RetValNullabilityPrecondition;
1406 }
1407
Vedant Kumarc34d3432017-06-23 21:32:38 +00001408 /// Used to store precise source locations for return statements by the
1409 /// runtime return value checks.
1410 Address ReturnLocation = Address::invalid();
1411
1412 /// Check if the return value of this function requires sanitization.
1413 bool requiresReturnValueCheck() const {
1414 return requiresReturnValueNullabilityCheck() ||
1415 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
1416 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
1417 }
1418
John McCallbd309292010-07-06 01:34:17 +00001419 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001420 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001421 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001422
Vitaly Buka1c943322016-10-26 01:59:57 +00001423 /// True if we need emit the life-time markers.
1424 const bool ShouldEmitLifetimeMarkers;
1425
Xiuli Panbe6da4b2017-05-04 07:31:20 +00001426 /// Add OpenCL kernel arg metadata and the kernel attribute meatadata to
1427 /// the function metadata.
Gor Nishanov04491bd2017-11-11 17:00:43 +00001428 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001429 llvm::Function *Fn);
1430
Chris Lattnerbed31442007-05-28 01:07:47 +00001431public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001432 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001433 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001434
John McCall8ed55a52010-09-02 09:58:18 +00001435 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001436 ASTContext &getContext() const { return CGM.getContext(); }
Gor Nishanov04491bd2017-11-11 17:00:43 +00001437 CGDebugInfo *getDebugInfo() {
1438 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001439 return nullptr;
Gor Nishanov04491bd2017-11-11 17:00:43 +00001440 return DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001441 }
1442 void disableDebugInfo() { DisableDebugInfo = true; }
1443 void enableDebugInfo() { DisableDebugInfo = false; }
1444
John McCall31168b02011-06-15 23:02:42 +00001445 bool shouldUseFusedARCCalls() {
1446 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1447 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001448
David Blaikiebbafb8a2012-03-11 07:00:24 +00001449 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001450
Bill Wendlingf0724e82011-09-19 20:31:14 +00001451 /// Returns a pointer to the function's exception object and selector slot,
1452 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001453 Address getExceptionSlot();
1454 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001455
Bill Wendling79a70e42011-09-15 18:57:19 +00001456 /// Returns the contents of the function's exception object and selector
1457 /// slots.
1458 llvm::Value *getExceptionFromSlot();
1459 llvm::Value *getSelectorFromSlot();
1460
John McCall7f416cc2015-09-08 08:05:57 +00001461 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001462
John McCallbd309292010-07-06 01:34:17 +00001463 llvm::BasicBlock *getUnreachableBlock() {
1464 if (!UnreachableBlock) {
1465 UnreachableBlock = createBasicBlock("unreachable");
1466 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1467 }
1468 return UnreachableBlock;
1469 }
1470
1471 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001472 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001473 return getInvokeDestImpl();
1474 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001475
David Majnemer25eb1652016-03-01 19:42:53 +00001476 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001477
John McCallc8e01702013-04-16 22:48:15 +00001478 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001479 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Yaxun Liucbf647c2017-07-08 13:24:52 +00001480 const TargetCodeGenInfo &getTargetHooks() const {
1481 return CGM.getTargetCodeGenInfo();
1482 }
Owen Andersonae86c192009-07-13 04:10:07 +00001483
Daniel Dunbar12347492009-02-23 17:26:39 +00001484 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001485 // Cleanups
1486 //===--------------------------------------------------------------------===//
1487
John McCall7f416cc2015-09-08 08:05:57 +00001488 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001489
John McCall178360e2011-07-11 08:38:19 +00001490 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001491 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001492 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001493 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001494 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001495 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1496 llvm::Value *arrayEnd,
1497 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001498 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001499 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001500
John McCall4bd0fb12011-07-12 16:41:08 +00001501 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001502 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001503 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001504 Address addr, QualType type);
1505 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001506 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001507 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001508 QualType type, Destroyer *destroyer,
1509 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001510 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1511 llvm::Value *CompletePtr,
1512 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001513 void pushStackRestore(CleanupKind kind, Address SPMem);
1514 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001515 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001516 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001517 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001518 bool useEHCleanupForArray,
1519 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001520 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001521 QualType elementType, CharUnits elementAlign,
1522 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001523 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001524
Peter Collingbourne1425b452012-01-26 03:33:36 +00001525 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001526
John McCall82fe67b2011-07-09 01:37:26 +00001527 /// Determines whether an EH cleanup is required to destroy a type
1528 /// with the given destruction kind.
1529 bool needsEHCleanup(QualType::DestructionKind kind) {
1530 switch (kind) {
1531 case QualType::DK_none:
1532 return false;
1533 case QualType::DK_cxx_destructor:
1534 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001535 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001536 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001537 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001538 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1539 }
1540 llvm_unreachable("bad destruction kind");
1541 }
1542
John McCall4bd0fb12011-07-12 16:41:08 +00001543 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1544 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1545 }
1546
John McCall82fe67b2011-07-09 01:37:26 +00001547 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001548 // Objective-C
1549 //===--------------------------------------------------------------------===//
1550
Chris Lattner4bd55962008-03-30 23:03:07 +00001551 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001552
David Blaikief1425802015-01-14 00:04:42 +00001553 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001554
Mike Stumpfc496822009-02-08 23:14:22 +00001555 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001556 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1557 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001558 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001559 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001560 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001561 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001562
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001563 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1564 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001565
Mike Stumpfc496822009-02-08 23:14:22 +00001566 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1567 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001568 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1569 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001570 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001571 const ObjCPropertyImplDecl *propImpl,
1572 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001573
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001574 //===--------------------------------------------------------------------===//
1575 // Block Bits
1576 //===--------------------------------------------------------------------===//
1577
Yaxun Liuc2a87a02017-10-14 12:23:50 +00001578 /// Emit block literal.
1579 /// \return an LLVM value which is a pointer to a struct which contains
1580 /// information about the block, including the block invoke function, the
1581 /// captured variables, etc.
1582 /// \param InvokeF will contain the block invoke function if it is not
1583 /// nullptr.
1584 llvm::Value *EmitBlockLiteral(const BlockExpr *,
1585 llvm::Function **InvokeF = nullptr);
John McCall08ef4662011-11-10 08:15:53 +00001586 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001587
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001588 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001589 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001590 const DeclMapTy &ldm,
Akira Hatanakaba0367a2017-09-22 21:32:06 +00001591 bool IsLambdaConversionToBlock,
1592 bool BuildGlobalBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001593
John McCallad7c5c12011-02-08 08:22:06 +00001594 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1595 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001596 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1597 const ObjCPropertyImplDecl *PID);
1598 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1599 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001600 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001601
John McCallad7c5c12011-02-08 08:22:06 +00001602 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1603
John McCall73064872011-03-31 01:59:53 +00001604 class AutoVarEmission;
1605
1606 void emitByrefStructureInit(const AutoVarEmission &emission);
1607 void enterByrefCleanup(const AutoVarEmission &emission);
1608
John McCall7f416cc2015-09-08 08:05:57 +00001609 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1610 llvm::Value *ptr);
1611
1612 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001613 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1614
1615 /// BuildBlockByrefAddress - Computes the location of the
1616 /// data in a variable which is declared as __block.
1617 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1618 bool followForward = true);
1619 Address emitBlockByrefAddress(Address baseAddr,
1620 const BlockByrefInfo &info,
1621 bool followForward,
1622 const llvm::Twine &name);
1623
1624 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001625
Richard Smith5179eb72016-06-28 19:03:57 +00001626 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1627
John McCalla738c252011-03-09 04:27:21 +00001628 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1629 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001630 /// \brief Emit code for the start of a function.
1631 /// \param Loc The location to be associated with the function.
1632 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001633 void StartFunction(GlobalDecl GD,
1634 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001635 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001636 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001637 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001638 SourceLocation Loc = SourceLocation(),
1639 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001640
Vedant Kumar7f809b22017-02-24 01:15:19 +00001641 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1642
John McCallb81884d2010-02-19 09:25:03 +00001643 void EmitConstructorBody(FunctionArgList &Args);
1644 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001645 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001646 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001647 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001648
Faisal Vali571df122013-09-29 08:45:24 +00001649 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001650 CallArgList &CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00001651 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001652 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001653 void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001654 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001655
David Blaikiea0a1a872015-01-18 02:48:07 +00001656 /// \brief Emit the unified return block, trying to avoid its emission when
1657 /// possible.
1658 /// \return The debug location of the user written return statement if the
1659 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001660 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001661
Mike Stumpfc496822009-02-08 23:14:22 +00001662 /// FinishFunction - Complete IR generation of the current function. It is
1663 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001664 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001665
Nico Weber1bebad12015-02-11 22:33:32 +00001666 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1667 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001668
John McCallb92ab1a2016-10-26 23:46:34 +00001669 void EmitCallAndReturnForThunk(llvm::Constant *Callee,
1670 const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001671
John McCall7f416cc2015-09-08 08:05:57 +00001672 void FinishThunk();
1673
Reid Klecknerab2090d2014-07-26 01:34:32 +00001674 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1675 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1676 llvm::Value *Callee);
1677
Rafael Espindolad6e66942015-07-13 06:07:58 +00001678 /// Generate a thunk for the given method.
1679 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001680 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001681
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001682 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1683 const CGFunctionInfo &FnInfo,
1684 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001685
Douglas Gregor94f9a482010-05-05 05:51:00 +00001686 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1687 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001688
Richard Smith30e304e2016-12-14 00:03:17 +00001689 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001690
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001691 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1692 struct VPtr {
1693 BaseSubobject Base;
1694 const CXXRecordDecl *NearestVBase;
1695 CharUnits OffsetFromNearestVBase;
1696 const CXXRecordDecl *VTableClass;
1697 };
1698
1699 /// Initialize the vtable pointer of the given subobject.
1700 void InitializeVTablePointer(const VPtr &vptr);
1701
1702 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001703
1704 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001705 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1706
1707 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1708 CharUnits OffsetFromNearestVBase,
1709 bool BaseIsNonVirtualPrimaryBase,
1710 const CXXRecordDecl *VTableClass,
1711 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001712
Anders Carlssond5895932010-03-28 21:07:49 +00001713 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001714
Dan Gohman8fc50c22010-10-26 18:44:08 +00001715 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1716 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001717 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1718 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001719
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001720 enum CFITypeCheckKind {
1721 CFITCK_VCall,
1722 CFITCK_NVCall,
1723 CFITCK_DerivedCast,
1724 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001725 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001726 };
1727
Peter Collingbourned2926c92015-03-14 02:42:25 +00001728 /// \brief Derived is the presumed address of an object of type T after a
1729 /// cast. If T is a polymorphic class type, emit a check that the virtual
1730 /// table for Derived belongs to a class derived from T.
1731 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001732 bool MayBeNull, CFITypeCheckKind TCK,
1733 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001734
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001735 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1736 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001737 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001738 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001739
Peter Collingbourned2926c92015-03-14 02:42:25 +00001740 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001741 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001742 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1743 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001744
Peter Collingbournefb532b92016-02-24 20:46:36 +00001745 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001746 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1747 /// enabled, emit a check that VTable is a member of RD's type identifier.
1748 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1749 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001750
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001751 /// Returns whether we should perform a type checked load when loading a
1752 /// virtual function for virtual calls to members of RD. This is generally
1753 /// true when both vcall CFI and whole-program-vtables are enabled.
1754 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1755
1756 /// Emit a type checked load from the given vtable.
1757 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1758 uint64_t VTableByteOffset);
1759
John McCallf99a6312010-07-21 05:30:47 +00001760 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1761 /// given phase of destruction for a destructor. The end result
1762 /// should call destructors on members and base classes in reverse
1763 /// order of their construction.
1764 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001765
Chris Lattner3c77a352010-06-22 00:03:40 +00001766 /// ShouldInstrumentFunction - Return true if the current function should be
1767 /// instrumented with __cyg_profile_func_* calls
1768 bool ShouldInstrumentFunction();
1769
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001770 /// ShouldXRayInstrument - Return true if the current function should be
1771 /// instrumented with XRay nop sleds.
1772 bool ShouldXRayInstrumentFunction() const;
1773
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +00001774 /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
1775 /// XRay custom event handling calls.
1776 bool AlwaysEmitXRayCustomEvents() const;
1777
Vedant Kumarbb5d4852017-09-13 00:04:35 +00001778 /// Encode an address into a form suitable for use in a function prologue.
1779 llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
1780 llvm::Constant *Addr);
1781
1782 /// Decode an address used in a function prologue, encoded by \c
1783 /// EncodeAddrForUseInPrologue.
1784 llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
1785 llvm::Value *EncodedAddr);
1786
Mike Stumpfc496822009-02-08 23:14:22 +00001787 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1788 /// arguments for the given function. This is also responsible for naming the
1789 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001790 void EmitFunctionProlog(const CGFunctionInfo &FI,
1791 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001792 const FunctionArgList &Args);
1793
Mike Stumpfc496822009-02-08 23:14:22 +00001794 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1795 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001796 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1797 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001798
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001799 /// Emit a test that checks if the return value \p RV is nonnull.
Vedant Kumarc34d3432017-06-23 21:32:38 +00001800 void EmitReturnValueCheck(llvm::Value *RV);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001801
Mike Stump1d849212009-12-07 23:38:24 +00001802 /// EmitStartEHSpec - Emit the start of the exception spec.
1803 void EmitStartEHSpec(const Decl *D);
1804
1805 /// EmitEndEHSpec - Emit the end of the exception spec.
1806 void EmitEndEHSpec(const Decl *D);
1807
John McCallbd309292010-07-06 01:34:17 +00001808 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1809 llvm::BasicBlock *getTerminateLandingPad();
1810
1811 /// getTerminateHandler - Return a handler (not a landing pad, just
1812 /// a catch handler) that just calls terminate. This is used when
1813 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001814 llvm::BasicBlock *getTerminateHandler();
1815
Chris Lattnera5f58b02011-07-09 17:41:47 +00001816 llvm::Type *ConvertTypeForMem(QualType T);
1817 llvm::Type *ConvertType(QualType T);
1818 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001819 return ConvertType(getContext().getTypeDeclType(T));
1820 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001821
Mike Stumpfc496822009-02-08 23:14:22 +00001822 /// LoadObjCSelf - Load the value of self. This function is only valid while
1823 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001824 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001825
1826 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001827 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001828
Krasimir Georgiev46dfb7a2017-09-08 13:44:51 +00001829 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
John McCall47fb9502013-03-07 21:37:08 +00001830 static TypeEvaluationKind getEvaluationKind(QualType T);
1831
1832 static bool hasScalarEvaluationKind(QualType T) {
1833 return getEvaluationKind(T) == TEK_Scalar;
1834 }
1835
1836 static bool hasAggregateEvaluationKind(QualType T) {
1837 return getEvaluationKind(T) == TEK_Aggregate;
1838 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001839
1840 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001841 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001842 llvm::Function *parent = nullptr,
1843 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001844#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001845 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001846#else
John McCallad7c5c12011-02-08 08:22:06 +00001847 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001848#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001849 }
Mike Stumpfc496822009-02-08 23:14:22 +00001850
Chris Lattnerac248202007-05-30 00:13:02 +00001851 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1852 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001853 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001854
Mike Stumpe5311b02009-11-30 20:08:49 +00001855 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1856 /// another basic block, simplify it. This assumes that no other code could
1857 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001858 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1859
Mike Stumpfc496822009-02-08 23:14:22 +00001860 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1861 /// adding a fall-through branch from the current insert block if
1862 /// necessary. It is legal to call this function even if there is no current
1863 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001864 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001865 /// IsFinished - If true, indicates that the caller has finished emitting
1866 /// branches to the given block and does not expect to emit code into it. This
1867 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001868 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001869
John McCall8e4c74b2011-08-11 02:22:43 +00001870 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1871 /// near its uses, and leave the insertion point in it.
1872 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1873
Mike Stumpfc496822009-02-08 23:14:22 +00001874 /// EmitBranch - Emit a branch to the specified basic block from the current
1875 /// insert block, taking care to avoid creation of branches from dummy
1876 /// blocks. It is legal to call this function even if there is no current
1877 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001878 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001879 /// This function clears the current insertion point. The caller should follow
1880 /// calls to this function with calls to Emit*Block prior to generation new
1881 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001882 void EmitBranch(llvm::BasicBlock *Block);
1883
Mike Stumpfc496822009-02-08 23:14:22 +00001884 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1885 /// indicates that the current code being emitted is unreachable.
1886 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001887 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001888 }
1889
Mike Stumpfc496822009-02-08 23:14:22 +00001890 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1891 /// emitted IR has a place to go. Note that by definition, if this function
1892 /// creates a block then that block is unreachable; callers may do better to
1893 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001894 void EnsureInsertPoint() {
1895 if (!HaveInsertPoint())
1896 EmitBlock(createBasicBlock());
1897 }
Mike Stumpfc496822009-02-08 23:14:22 +00001898
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001899 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001900 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001901 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001902
Chris Lattnere9a64532007-06-22 21:44:33 +00001903 //===--------------------------------------------------------------------===//
1904 // Helpers
1905 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001906
John McCall7f416cc2015-09-08 08:05:57 +00001907 LValue MakeAddrLValue(Address Addr, QualType T,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001908 AlignmentSource Source = AlignmentSource::Type) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00001909 return LValue::MakeAddr(Addr, T, getContext(), LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001910 CGM.getTBAAAccessInfo(T));
1911 }
1912
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001913 LValue MakeAddrLValue(Address Addr, QualType T, LValueBaseInfo BaseInfo,
1914 TBAAAccessInfo TBAAInfo) {
1915 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001916 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001917
John McCall7f416cc2015-09-08 08:05:57 +00001918 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001919 AlignmentSource Source = AlignmentSource::Type) {
1920 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00001921 LValueBaseInfo(Source), CGM.getTBAAAccessInfo(T));
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001922 }
1923
1924 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001925 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00001926 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001927 BaseInfo, TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +00001928 }
1929
1930 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001931 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001932 CharUnits getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001933 LValueBaseInfo *BaseInfo = nullptr,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +00001934 TBAAAccessInfo *TBAAInfo = nullptr,
John McCall7f416cc2015-09-08 08:05:57 +00001935 bool forPointeeType = false);
1936 CharUnits getNaturalPointeeTypeAlignment(QualType T,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00001937 LValueBaseInfo *BaseInfo = nullptr,
1938 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001939
Ivan A. Kosarev9f9d1572017-10-30 11:49:31 +00001940 Address EmitLoadOfReference(LValue RefLVal,
1941 LValueBaseInfo *PointeeBaseInfo = nullptr,
1942 TBAAAccessInfo *PointeeTBAAInfo = nullptr);
1943 LValue EmitLoadOfReferenceLValue(LValue RefLVal);
1944 LValue EmitLoadOfReferenceLValue(Address RefAddr, QualType RefTy,
1945 AlignmentSource Source =
1946 AlignmentSource::Type) {
1947 LValue RefLVal = MakeAddrLValue(RefAddr, RefTy, LValueBaseInfo(Source),
1948 CGM.getTBAAAccessInfo(RefTy));
1949 return EmitLoadOfReferenceLValue(RefLVal);
1950 }
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001951
Alexey Bataev31300ed2016-02-04 11:27:03 +00001952 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
Ivan A. Kosarev90295642017-10-13 16:47:22 +00001953 LValueBaseInfo *BaseInfo = nullptr,
1954 TBAAAccessInfo *TBAAInfo = nullptr);
Alexey Bataev31300ed2016-02-04 11:27:03 +00001955 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1956
Yaxun Liu84744c12017-06-19 17:03:41 +00001957 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
1958 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
1959 /// insertion point of the builder. The caller is responsible for setting an
1960 /// appropriate alignment on
Daniel Dunbara7566f12010-02-09 02:48:28 +00001961 /// the alloca.
Yaxun Liu84744c12017-06-19 17:03:41 +00001962 ///
1963 /// \p ArraySize is the number of array elements to be allocated if it
1964 /// is not nullptr.
1965 ///
1966 /// LangAS::Default is the address space of pointers to local variables and
1967 /// temporaries, as exposed in the source language. In certain
1968 /// configurations, this is not the same as the alloca address space, and a
1969 /// cast is needed to lift the pointer from the alloca AS into
1970 /// LangAS::Default. This can happen when the target uses a restricted
1971 /// address space for the stack but the source language requires
1972 /// LangAS::Default to be a generic address space. The latter condition is
1973 /// common for most programming languages; OpenCL is an exception in that
1974 /// LangAS::Default is the private address space, which naturally maps
1975 /// to the stack.
1976 ///
1977 /// Because the address of a temporary is often exposed to the program in
1978 /// various ways, this function will perform the cast by default. The cast
1979 /// may be avoided by passing false as \p CastToDefaultAddrSpace; this is
1980 /// more efficient if the caller knows that the address will not be exposed.
1981 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
1982 llvm::Value *ArraySize = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001983 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
Yaxun Liu84744c12017-06-19 17:03:41 +00001984 const Twine &Name = "tmp",
1985 llvm::Value *ArraySize = nullptr,
1986 bool CastToDefaultAddrSpace = true);
Mike Stumpfc496822009-02-08 23:14:22 +00001987
John McCall7f416cc2015-09-08 08:05:57 +00001988 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1989 /// default ABI alignment of the given LLVM type.
1990 ///
1991 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1992 /// any given AST type that happens to have been lowered to the
1993 /// given IR type. This should only ever be used for function-local,
1994 /// IR-driven manipulations like saving and restoring a value. Do
1995 /// not hand this address off to arbitrary IRGen routines, and especially
1996 /// do not pass it as an argument to a function that might expect a
1997 /// properly ABI-aligned value.
1998 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1999 const Twine &Name = "tmp");
2000
2001 /// InitTempAlloca - Provide an initial value for the given alloca which
2002 /// will be observable at all locations in the function.
2003 ///
2004 /// The address should be something that was returned from one of
2005 /// the CreateTempAlloca or CreateMemTemp routines, and the
2006 /// initializer must be valid in the entry block (i.e. it must
2007 /// either be a constant or an argument value).
2008 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00002009
Daniel Dunbard0049182010-02-16 19:44:13 +00002010 /// CreateIRTemp - Create a temporary IR object of the given type, with
2011 /// appropriate alignment. This routine should only be used when an temporary
2012 /// value needs to be stored into an alloca (for example, to avoid explicit
2013 /// PHI construction), but the type is the IR type, not the type appropriate
2014 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00002015 ///
2016 /// That is, this is exactly equivalent to CreateMemTemp, but calling
2017 /// ConvertType instead of ConvertTypeForMem.
2018 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00002019
Daniel Dunbara7566f12010-02-09 02:48:28 +00002020 /// CreateMemTemp - Create a temporary memory object of the given type, with
Yaxun Liu84744c12017-06-19 17:03:41 +00002021 /// appropriate alignment. Cast it to the default address space if
2022 /// \p CastToDefaultAddrSpace is true.
2023 Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
2024 bool CastToDefaultAddrSpace = true);
2025 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
2026 bool CastToDefaultAddrSpace = true);
Daniel Dunbara7566f12010-02-09 02:48:28 +00002027
John McCall7a626f62010-09-15 10:14:12 +00002028 /// CreateAggTemp - Create a temporary memory object for the given
2029 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00002030 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00002031 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00002032 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00002033 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00002034 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002035 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00002036 }
2037
John McCallad7c5c12011-02-08 08:22:06 +00002038 /// Emit a cast to void* in the appropriate address space.
2039 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2040
Chris Lattner8394d792007-06-05 20:53:16 +00002041 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2042 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00002043 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00002044
John McCalla2342eb2010-12-05 02:00:02 +00002045 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2046 void EmitIgnoredExpr(const Expr *E);
2047
Chris Lattner4647a212007-08-31 22:49:20 +00002048 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2049 /// any type. The result is returned as an RValue struct. If this is an
2050 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2051 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00002052 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00002053 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00002054 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00002055 AggValueSlot aggSlot = AggValueSlot::ignored(),
2056 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00002057
Mike Stumpfc496822009-02-08 23:14:22 +00002058 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2059 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00002060 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002061
Charles Davisc7d5c942015-09-17 20:55:33 +00002062 /// Emit a "reference" to a __builtin_ms_va_list; this is
2063 /// always the value of the expression, because a __builtin_ms_va_list is a
2064 /// pointer to a char.
2065 Address EmitMSVAListRef(const Expr *E);
2066
Gor Nishanov5eb58582017-03-26 02:18:05 +00002067 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
Mike Stumpfc496822009-02-08 23:14:22 +00002068 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00002069 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00002070
John McCall91ca10f2011-03-08 09:11:50 +00002071 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00002072 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00002073 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002074 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00002075
John McCall7f416cc2015-09-08 08:05:57 +00002076 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00002077
John McCall91ca10f2011-03-08 09:11:50 +00002078 /// EmitExprAsInit - Emits the code necessary to initialize a
2079 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00002080 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002081 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00002082
Fariborz Jahanian78652202013-01-25 23:57:05 +00002083 /// hasVolatileMember - returns true if aggregate type has a volatile
2084 /// member.
2085 bool hasVolatileMember(QualType T) {
2086 if (const RecordType *RT = T->getAs<RecordType>()) {
2087 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2088 return RD->hasVolatileMember();
2089 }
2090 return false;
2091 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002092 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002093 ///
2094 /// The difference to EmitAggregateCopy is that tail padding is not copied.
2095 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00002096 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00002097 QualType EltTy) {
2098 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00002099 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002100 }
2101
John McCall7f416cc2015-09-08 08:05:57 +00002102 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
2103 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00002104 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00002105 /*IsAssignment=*/false);
2106 }
2107
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002108 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00002109 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00002110 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00002111 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002112 /// \param isAssignment - If false, allow padding to be copied. This often
2113 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00002114 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00002115 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002116 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00002117
Anders Carlsson9396a892008-09-11 09:15:33 +00002118 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00002119 Address GetAddrOfLocalVar(const VarDecl *VD) {
2120 auto it = LocalDeclMap.find(VD);
2121 assert(it != LocalDeclMap.end() &&
2122 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2123 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00002124 }
Mike Stumpfc496822009-02-08 23:14:22 +00002125
John McCallc07a0c72011-02-17 10:25:35 +00002126 /// getOpaqueLValueMapping - Given an opaque value expression (which
2127 /// must be mapped to an l-value), return its mapping.
2128 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
2129 assert(OpaqueValueMapping::shouldBindAsLValue(e));
2130
2131 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
2132 it = OpaqueLValues.find(e);
2133 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
2134 return it->second;
2135 }
2136
2137 /// getOpaqueRValueMapping - Given an opaque value expression (which
2138 /// must be mapped to an r-value), return its mapping.
2139 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
2140 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
2141
2142 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
2143 it = OpaqueRValues.find(e);
2144 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00002145 return it->second;
2146 }
2147
Richard Smith410306b2016-12-12 02:53:20 +00002148 /// Get the index of the current ArrayInitLoopExpr, if any.
2149 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2150
Dan Gohman75d69da2008-05-22 00:50:06 +00002151 /// getAccessedFieldNo - Given an encoded value and a result number, return
2152 /// the input field number being accessed.
2153 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2154
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002155 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002156 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002157
Vedant Kumarffd7c882017-04-14 22:03:34 +00002158 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2159 static bool IsWrappedCXXThis(const Expr *E);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00002160
Anders Carlssonc0964b62010-05-22 17:35:42 +00002161 /// EmitNullInitialization - Generate code to set a value of the given type to
2162 /// null, If the type contains data member pointers, they will be initialized
2163 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002164 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002165
Charles Davisc7d5c942015-09-17 20:55:33 +00002166 /// Emits a call to an LLVM variable-argument intrinsic, either
2167 /// \c llvm.va_start or \c llvm.va_end.
2168 /// \param ArgValue A reference to the \c va_list as emitted by either
2169 /// \c EmitVAListRef or \c EmitMSVAListRef.
2170 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2171 /// calls \c llvm.va_end.
2172 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2173
2174 /// Generate code to get an argument from the passed in pointer
2175 /// and update it accordingly.
2176 /// \param VE The \c VAArgExpr for which to generate code.
2177 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2178 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2179 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002180 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002181 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002182 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002183
John McCall82fe67b2011-07-09 01:37:26 +00002184 /// emitArrayLength - Compute the length of an array, even if it's a
2185 /// VLA, and drill down to the base element type.
2186 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2187 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002188 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002189
John McCall23c29fe2011-06-24 21:55:10 +00002190 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2191 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002192 ///
2193 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002194 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002195
John McCall23c29fe2011-06-24 21:55:10 +00002196 /// getVLASize - Returns an LLVM value that corresponds to the size,
2197 /// in non-variably-sized elements, of a variable length array type,
2198 /// plus that largest non-variably-sized element type. Assumes that
2199 /// the type has already been emitted with EmitVariablyModifiedType.
2200 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
2201 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002202
Anders Carlssona5d077d2009-04-14 16:58:56 +00002203 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2204 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002205 llvm::Value *LoadCXXThis() {
2206 assert(CXXThisValue && "no 'this' value for this function");
2207 return CXXThisValue;
2208 }
John McCall7f416cc2015-09-08 08:05:57 +00002209 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002210
Anders Carlssone36a6b32010-01-02 01:01:18 +00002211 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2212 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002213 // FIXME: Every place that calls LoadCXXVTT is something
2214 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002215 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002216 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2217 return CXXStructorImplicitParamValue;
2218 }
2219
John McCall6ce74722010-02-16 04:15:37 +00002220 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002221 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002222 Address
2223 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002224 const CXXRecordDecl *Derived,
2225 const CXXRecordDecl *Base,
2226 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002227
John McCall7f416cc2015-09-08 08:05:57 +00002228 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2229
Mike Stumpe5311b02009-11-30 20:08:49 +00002230 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2231 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002232 Address GetAddressOfBaseClass(Address Value,
2233 const CXXRecordDecl *Derived,
2234 CastExpr::path_const_iterator PathBegin,
2235 CastExpr::path_const_iterator PathEnd,
2236 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002237
John McCall7f416cc2015-09-08 08:05:57 +00002238 Address GetAddressOfDerivedClass(Address Value,
2239 const CXXRecordDecl *Derived,
2240 CastExpr::path_const_iterator PathBegin,
2241 CastExpr::path_const_iterator PathEnd,
2242 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002243
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002244 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2245 /// base constructor/destructor with virtual bases.
2246 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2247 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2248 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2249 bool Delegating);
2250
John McCallf8ff7b92010-02-23 00:48:20 +00002251 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2252 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002253 const FunctionArgList &Args,
2254 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002255 // It's important not to confuse this and the previous function. Delegating
2256 // constructors are the C++0x feature. The constructor delegate optimization
2257 // is used to reduce duplication in the base and complete consturctors where
2258 // they are substantially the same.
2259 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2260 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002261
Richard Smith5179eb72016-06-28 19:03:57 +00002262 /// Emit a call to an inheriting constructor (that is, one that invokes a
2263 /// constructor inherited from a base class) by inlining its definition. This
2264 /// is necessary if the ABI does not support forwarding the arguments to the
2265 /// base class constructor (because they're variadic or similar).
2266 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2267 CXXCtorType CtorType,
2268 bool ForVirtualBase,
2269 bool Delegating,
2270 CallArgList &Args);
2271
2272 /// Emit a call to a constructor inherited from a base class, passing the
2273 /// current constructor's arguments along unmodified (without even making
2274 /// a copy).
2275 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2276 bool ForVirtualBase, Address This,
2277 bool InheritedFromVBase,
2278 const CXXInheritedCtorInitExpr *E);
2279
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002280 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002281 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002282 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002283
Richard Smith5179eb72016-06-28 19:03:57 +00002284 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2285 bool ForVirtualBase, bool Delegating,
2286 Address This, CallArgList &Args);
2287
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002288 /// Emit assumption load for all bases. Requires to be be called only on
2289 /// most-derived class and not under construction of the object.
2290 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2291
2292 /// Emit assumption that vptr load == global vtable.
2293 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2294
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002295 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002296 Address This, Address Src,
2297 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002298
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002299 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002300 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002301 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002302 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002303 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002304
Anders Carlssond49844b2009-09-23 02:45:36 +00002305 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2306 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002307 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002308 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002309 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002310
John McCall82fe67b2011-07-09 01:37:26 +00002311 static Destroyer destroyCXXObject;
2312
Anders Carlsson0a637412009-05-29 21:03:38 +00002313 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002314 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002315 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002316
John McCall99210dc2011-09-15 06:49:18 +00002317 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002318 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002319 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002320 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002321
Peter Collingbourne702b2842011-11-27 22:09:22 +00002322 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002323 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002324
David Majnemerdc012fa2015-04-22 21:38:15 +00002325 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2326 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2327
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002328 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002329 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002330
Eli Friedman24f55432009-11-18 00:57:03 +00002331 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002332 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2333 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002334
Richard Smith760520b2014-06-03 23:27:44 +00002335 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2336 const Expr *Arg, bool IsDelete);
2337
John McCall7f416cc2015-09-08 08:05:57 +00002338 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2339 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2340 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002341
Richard Smith69d0d262012-08-24 00:54:33 +00002342 /// \brief Situations in which we might emit a check for the suitability of a
2343 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002344 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002345 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002346 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002347 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002348 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002349 /// Checking the bound value in a reference binding. Must be suitably sized
2350 /// and aligned, but is not required to refer to an object (until the
2351 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002352 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002353 /// Checking the object expression in a non-static data member access. Must
2354 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002355 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002356 /// Checking the 'this' pointer for a call to a non-static member function.
2357 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002358 TCK_MemberCall,
2359 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002360 TCK_ConstructorCall,
2361 /// Checking the operand of a static_cast to a derived pointer type. Must be
2362 /// null or an object within its lifetime.
2363 TCK_DowncastPointer,
2364 /// Checking the operand of a static_cast to a derived reference type. Must
2365 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002366 TCK_DowncastReference,
2367 /// Checking the operand of a cast to a base object. Must be suitably sized
2368 /// and aligned.
2369 TCK_Upcast,
2370 /// Checking the operand of a cast to a virtual base object. Must be an
2371 /// object within its lifetime.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002372 TCK_UpcastToVirtualBase,
2373 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
2374 TCK_NonnullAssign
Richard Smith69d0d262012-08-24 00:54:33 +00002375 };
2376
Vedant Kumar24792e32017-10-03 01:27:25 +00002377 /// Determine whether the pointer type check \p TCK permits null pointers.
2378 static bool isNullPointerAllowed(TypeCheckKind TCK);
2379
2380 /// Determine whether the pointer type check \p TCK requires a vptr check.
2381 static bool isVptrCheckRequired(TypeCheckKind TCK, QualType Ty);
2382
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002383 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2384 /// calls to EmitTypeCheck can be skipped.
2385 bool sanitizePerformTypeCheck() const;
2386
Richard Smith4d1458e2012-09-08 02:08:36 +00002387 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002388 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002389 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002390 QualType Type, CharUnits Alignment = CharUnits::Zero(),
Vedant Kumar18348ea2017-02-17 23:22:55 +00002391 SanitizerSet SkippedChecks = SanitizerSet());
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002392
Richard Smith539e4a72013-02-23 02:53:19 +00002393 /// \brief Emit a check that \p Base points into an array object, which
2394 /// we can access at index \p Index. \p Accessed should be \c false if we
2395 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2396 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2397 QualType IndexType, bool Accessed);
2398
Chris Lattner116ce8f2010-01-09 21:40:03 +00002399 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2400 bool isInc, bool isPre);
2401 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2402 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002403
2404 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002405 llvm::Value *OffsetValue = nullptr) {
2406 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2407 OffsetValue);
2408 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002409
Amara Emerson652795d2016-11-10 14:44:30 +00002410 /// Converts Location to a DebugLoc, if debug information is enabled.
2411 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2412
2413
Chris Lattner8394d792007-06-05 20:53:16 +00002414 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002415 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002416 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002417
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002418 /// EmitDecl - Emit a declaration.
2419 ///
2420 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002421 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002422
John McCall1c9c3fd2010-10-15 04:57:14 +00002423 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002424 ///
2425 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002426 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002427
David Blaikie73ca5692014-12-09 00:32:22 +00002428 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002429 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002430
John McCallbd309292010-07-06 01:34:17 +00002431 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2432 llvm::Value *Address);
2433
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002434 /// \brief Determine whether the given initializer is trivial in the sense
2435 /// that it requires no code to be generated.
2436 bool isTrivialInitializer(const Expr *Init);
2437
John McCall1c9c3fd2010-10-15 04:57:14 +00002438 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002439 ///
2440 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002441 void EmitAutoVarDecl(const VarDecl &D);
2442
2443 class AutoVarEmission {
2444 friend class CodeGenFunction;
2445
John McCall9e2e22f2011-02-22 07:16:58 +00002446 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002447
John McCall7f416cc2015-09-08 08:05:57 +00002448 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002449 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002450 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002451
2452 llvm::Value *NRVOFlag;
2453
2454 /// True if the variable is a __block variable.
2455 bool IsByRef;
2456
2457 /// True if the variable is of aggregate type and has a constant
2458 /// initializer.
2459 bool IsConstantAggregate;
2460
Nadav Rotem1da30942013-03-23 06:43:35 +00002461 /// Non-null if we should use lifetime annotations.
2462 llvm::Value *SizeForLifetimeMarkers;
2463
John McCall9e2e22f2011-02-22 07:16:58 +00002464 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002465 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002466
John McCallc533cb72011-02-22 06:44:22 +00002467 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002468 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002469 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002470 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002471
John McCall7f416cc2015-09-08 08:05:57 +00002472 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002473
2474 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002475 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2476
Craig Topper8a13c412014-05-21 05:09:00 +00002477 bool useLifetimeMarkers() const {
2478 return SizeForLifetimeMarkers != nullptr;
2479 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002480 llvm::Value *getSizeForLifetimeMarkers() const {
2481 assert(useLifetimeMarkers());
2482 return SizeForLifetimeMarkers;
2483 }
2484
2485 /// Returns the raw, allocated address, which is not necessarily
2486 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002487 Address getAllocatedAddress() const {
2488 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002489 }
2490
John McCallc533cb72011-02-22 06:44:22 +00002491 /// Returns the address of the object within this declaration.
2492 /// Note that this does not chase the forwarding pointer for
2493 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002494 Address getObjectAddress(CodeGenFunction &CGF) const {
2495 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002496
John McCall7f416cc2015-09-08 08:05:57 +00002497 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002498 }
2499 };
2500 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2501 void EmitAutoVarInit(const AutoVarEmission &emission);
Gor Nishanov04491bd2017-11-11 17:00:43 +00002502 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002503 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2504 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002505
John McCall1c9c3fd2010-10-15 04:57:14 +00002506 void EmitStaticVarDecl(const VarDecl &D,
2507 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002508
John McCall7f416cc2015-09-08 08:05:57 +00002509 class ParamValue {
2510 llvm::Value *Value;
2511 unsigned Alignment;
2512 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2513 public:
2514 static ParamValue forDirect(llvm::Value *value) {
2515 return ParamValue(value, 0);
2516 }
2517 static ParamValue forIndirect(Address addr) {
2518 assert(!addr.getAlignment().isZero());
2519 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2520 }
2521
2522 bool isIndirect() const { return Alignment != 0; }
2523 llvm::Value *getAnyValue() const { return Value; }
Gor Nishanov04491bd2017-11-11 17:00:43 +00002524
John McCall7f416cc2015-09-08 08:05:57 +00002525 llvm::Value *getDirectValue() const {
2526 assert(!isIndirect());
2527 return Value;
2528 }
2529
2530 Address getIndirectAddress() const {
2531 assert(isIndirect());
2532 return Address(Value, CharUnits::fromQuantity(Alignment));
2533 }
2534 };
2535
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002536 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002537 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002538
John McCallc07a0c72011-02-17 10:25:35 +00002539 /// protectFromPeepholes - Protect a value that we're intending to
2540 /// store to the side, but which will probably be used later, from
2541 /// aggressive peepholing optimizations that might delete it.
2542 ///
2543 /// Pass the result to unprotectFromPeepholes to declare that
2544 /// protection is no longer required.
2545 ///
2546 /// There's no particular reason why this shouldn't apply to
2547 /// l-values, it's just that no existing peepholes work on pointers.
2548 PeepholeProtection protectFromPeepholes(RValue rvalue);
2549 void unprotectFromPeepholes(PeepholeProtection protection);
2550
Erich Keane623efd82017-03-30 21:48:55 +00002551 void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment,
2552 llvm::Value *OffsetValue = nullptr) {
2553 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2554 OffsetValue);
2555 }
2556
Chris Lattner84915fa2007-06-02 04:16:21 +00002557 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002558 // Statement Emission
2559 //===--------------------------------------------------------------------===//
2560
Mike Stumpfc496822009-02-08 23:14:22 +00002561 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002562 void EmitStopPoint(const Stmt *S);
2563
Mike Stumpfc496822009-02-08 23:14:22 +00002564 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2565 /// this function even if there is no current insertion point.
2566 ///
2567 /// This function may clear the current insertion point; callers should use
2568 /// EnsureInsertPoint if they wish to subsequently generate code without first
2569 /// calling EmitBlock, EmitBranch, or EmitStmt.
Karl-Johan Karlsson33e205a2017-09-06 08:47:18 +00002570 void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002571
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002572 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002573 /// necessarily require an insertion point or debug information; typically
2574 /// because the statement amounts to a jump or a container of other
2575 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002576 ///
2577 /// \return True if the statement was handled.
2578 bool EmitSimpleStmt(const Stmt *S);
2579
John McCall7f416cc2015-09-08 08:05:57 +00002580 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2581 AggValueSlot AVS = AggValueSlot::ignored());
2582 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2583 bool GetLast = false,
2584 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002585 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002586
Mike Stumpfc496822009-02-08 23:14:22 +00002587 /// EmitLabel - Emit the block for the given label. It is legal to call this
2588 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002589 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002590
Chris Lattnerac248202007-05-30 00:13:02 +00002591 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002592 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002593 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002594 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002595 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002596
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002597 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002598 ArrayRef<const Attr *> Attrs = None);
2599 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002600 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002601 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002602 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002603 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002604 void EmitBreakStmt(const BreakStmt &S);
2605 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002606 void EmitSwitchStmt(const SwitchStmt &S);
2607 void EmitDefaultStmt(const DefaultStmt &S);
2608 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002609 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002610 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002611
Anders Carlsson2e744e82008-08-30 19:51:14 +00002612 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002613 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2614 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002615 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002616 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002617
Gor Nishanov8df64e92016-10-27 16:28:31 +00002618 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov90be1212017-03-06 21:12:54 +00002619 void EmitCoreturnStmt(const CoreturnStmt &S);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002620 RValue EmitCoawaitExpr(const CoawaitExpr &E,
2621 AggValueSlot aggSlot = AggValueSlot::ignored(),
2622 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002623 LValue EmitCoawaitLValue(const CoawaitExpr *E);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002624 RValue EmitCoyieldExpr(const CoyieldExpr &E,
2625 AggValueSlot aggSlot = AggValueSlot::ignored(),
2626 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002627 LValue EmitCoyieldLValue(const CoyieldExpr *E);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002628 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2629
John McCallb609d3f2010-07-07 06:56:46 +00002630 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2631 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002632
Anders Carlsson52d78a52009-09-27 18:58:34 +00002633 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002634 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002635 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002636 void EnterSEHTryStmt(const SEHTryStmt &S);
2637 void ExitSEHTryStmt(const SEHTryStmt &S);
2638
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002639 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002640 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002641
2642 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2643 const SEHExceptStmt &Except);
2644
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002645 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2646 const SEHFinallyStmt &Finally);
2647
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002648 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2649 llvm::Value *ParentFP,
2650 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002651 llvm::Value *EmitSEHExceptionCode();
2652 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002653 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002654
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002655 /// Scan the outlined statement for captures from the parent function. For
2656 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002657 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002658 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002659 bool IsFilter);
2660
2661 /// Recovers the address of a local in a parent function. ParentVar is the
2662 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002663 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002664 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2665 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002666 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2667 Address ParentVar,
2668 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002669
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002670 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002671 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002672
Alexey Bataev2139ed62017-11-16 18:20:21 +00002673 /// Controls insertion of cancellation exit blocks in worksharing constructs.
2674 class OMPCancelStackRAII {
2675 CodeGenFunction &CGF;
2676
2677 public:
2678 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
2679 bool HasCancel)
2680 : CGF(CGF) {
2681 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
2682 }
2683 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
2684 };
2685
Alexey Bataev1189bd02016-01-26 12:20:39 +00002686 /// Returns calculated size of the specified type.
2687 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002688 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002689 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002690 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002691 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002692 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002693 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002694 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002695 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2696 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002697 /// \brief Perform element by element copying of arrays with type \a
2698 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2699 /// generated by \a CopyGen.
2700 ///
2701 /// \param DestAddr Address of the destination array.
2702 /// \param SrcAddr Address of the source array.
2703 /// \param OriginalType Type of destination and source arrays.
2704 /// \param CopyGen Copying procedure that copies value of single array element
2705 /// to another single array element.
2706 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002707 Address DestAddr, Address SrcAddr, QualType OriginalType,
2708 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002709 /// \brief Emit proper copying of data from one variable to another.
2710 ///
2711 /// \param OriginalType Original type of the copied variables.
2712 /// \param DestAddr Destination address.
2713 /// \param SrcAddr Source address.
2714 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2715 /// type of the base array element).
2716 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2717 /// the base array element).
2718 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2719 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002720 void EmitOMPCopy(QualType OriginalType,
2721 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002722 const VarDecl *DestVD, const VarDecl *SrcVD,
2723 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002724 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2725 /// \a X = \a E \a BO \a E.
2726 ///
2727 /// \param X Value to be updated.
2728 /// \param E Update value.
2729 /// \param BO Binary operation for update operation.
2730 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2731 /// expression, false otherwise.
2732 /// \param AO Atomic ordering of the generated atomic instructions.
2733 /// \param CommonGen Code generator for complex expressions that cannot be
2734 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002735 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2736 /// generated, <false, RValue::get(nullptr)> otherwise.
2737 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002738 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2739 llvm::AtomicOrdering AO, SourceLocation Loc,
2740 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002741 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002742 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002743 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2744 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002745 void EmitOMPUseDevicePtrClause(
2746 const OMPClause &C, OMPPrivateScope &PrivateScope,
2747 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002748 /// \brief Emit code for copyin clause in \a D directive. The next code is
2749 /// generated at the start of outlined functions for directives:
2750 /// \code
2751 /// threadprivate_var1 = master_threadprivate_var1;
2752 /// operator=(threadprivate_var2, master_threadprivate_var2);
2753 /// ...
2754 /// __kmpc_barrier(&loc, global_tid);
2755 /// \endcode
2756 ///
2757 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2758 /// \returns true if at least one copyin variable is found, false otherwise.
2759 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002760 /// \brief Emit initial code for lastprivate variables. If some variable is
2761 /// not also firstprivate, then the default initialization is used. Otherwise
2762 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2763 /// method.
2764 ///
2765 /// \param D Directive that may have 'lastprivate' directives.
2766 /// \param PrivateScope Private scope for capturing lastprivate variables for
2767 /// proper codegen in internal captured statement.
2768 ///
2769 /// \returns true if there is at least one lastprivate variable, false
2770 /// otherwise.
2771 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2772 OMPPrivateScope &PrivateScope);
2773 /// \brief Emit final copying of lastprivate values to original variables at
2774 /// the end of the worksharing or simd directive.
2775 ///
2776 /// \param D Directive that has at least one 'lastprivate' directives.
2777 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2778 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002779 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002780 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002781 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002782 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002783 /// Emit initial code for linear clauses.
2784 void EmitOMPLinearClause(const OMPLoopDirective &D,
2785 CodeGenFunction::OMPPrivateScope &PrivateScope);
2786 /// Emit final code for linear clauses.
2787 /// \param CondGen Optional conditional code for final part of codegen for
2788 /// linear clause.
2789 void EmitOMPLinearClauseFinal(
2790 const OMPLoopDirective &D,
2791 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002792 /// \brief Emit initial code for reduction variables. Creates reduction copies
2793 /// and initializes them with the values according to OpenMP standard.
2794 ///
2795 /// \param D Directive (possibly) with the 'reduction' clause.
2796 /// \param PrivateScope Private scope for capturing reduction variables for
2797 /// proper codegen in internal captured statement.
2798 ///
2799 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2800 OMPPrivateScope &PrivateScope);
2801 /// \brief Emit final update of reduction values to original variables at
2802 /// the end of the directive.
2803 ///
2804 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00002805 /// \param ReductionKind The kind of reduction to perform.
2806 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
2807 const OpenMPDirectiveKind ReductionKind);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002808 /// \brief Emit initial code for linear variables. Creates private copies
2809 /// and initializes them with the values according to OpenMP standard.
2810 ///
2811 /// \param D Directive (possibly) with the 'linear' clause.
Alexey Bataev8c3edfe2017-08-16 15:58:46 +00002812 /// \return true if at least one linear variable is found that should be
2813 /// initialized with the value of the original variable, false otherwise.
2814 bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002815
Alexey Bataev7292c292016-04-25 12:22:29 +00002816 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2817 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002818 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002819 TaskGenTy;
2820 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2821 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002822 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00002823
Alexey Bataev9959db52014-05-06 10:08:46 +00002824 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002825 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002826 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002827 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002828 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002829 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002830 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002831 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002832 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002833 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002834 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002835 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002836 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002837 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002838 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002839 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002840 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002841 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002842 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002843 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002844 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002845 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002846 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002847 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002848 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002849 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002850 void
2851 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002852 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002853 void
2854 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002855 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002856 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002857 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002858 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002859 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002860 void EmitOMPDistributeParallelForDirective(
2861 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002862 void EmitOMPDistributeParallelForSimdDirective(
2863 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002864 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002865 void EmitOMPTargetParallelForSimdDirective(
2866 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002867 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002868 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00002869 void
2870 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00002871 void EmitOMPTeamsDistributeParallelForSimdDirective(
2872 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00002873 void EmitOMPTeamsDistributeParallelForDirective(
2874 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00002875 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00002876 void EmitOMPTargetTeamsDistributeDirective(
2877 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00002878 void EmitOMPTargetTeamsDistributeParallelForDirective(
2879 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00002880 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
2881 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00002882 void EmitOMPTargetTeamsDistributeSimdDirective(
2883 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002884
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00002885 /// Emit device code for the target directive.
2886 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
2887 StringRef ParentName,
2888 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00002889 static void
2890 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2891 const OMPTargetParallelDirective &S);
Alexey Bataevfb0ebec2017-11-08 20:16:14 +00002892 /// Emit device code for the target parallel for directive.
2893 static void EmitOMPTargetParallelForDeviceFunction(
2894 CodeGenModule &CGM, StringRef ParentName,
2895 const OMPTargetParallelForDirective &S);
Alexey Bataev5d7edca2017-11-09 17:32:15 +00002896 /// Emit device code for the target parallel for simd directive.
2897 static void EmitOMPTargetParallelForSimdDeviceFunction(
2898 CodeGenModule &CGM, StringRef ParentName,
2899 const OMPTargetParallelForSimdDirective &S);
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00002900 static void
2901 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2902 const OMPTargetTeamsDirective &S);
Alexey Bataevf8365372017-11-17 17:57:25 +00002903 /// Emit device code for the target simd directive.
2904 static void EmitOMPTargetSimdDeviceFunction(CodeGenModule &CGM,
2905 StringRef ParentName,
2906 const OMPTargetSimdDirective &S);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002907 /// \brief Emit inner loop of the worksharing/simd construct.
2908 ///
2909 /// \param S Directive, for which the inner loop must be emitted.
2910 /// \param RequiresCleanup true, if directive has some associated private
2911 /// variables.
2912 /// \param LoopCond Bollean condition for loop continuation.
2913 /// \param IncExpr Increment expression for loop control variable.
2914 /// \param BodyGen Generator for the inner body of the inner loop.
2915 /// \param PostIncGen Genrator for post-increment code (required for ordered
2916 /// loop directvies).
2917 void EmitOMPInnerLoop(
2918 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2919 const Expr *IncExpr,
2920 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2921 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002922
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002923 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002924 /// Emit initial code for loop counters of loop-based directives.
2925 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2926 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002927
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002928 /// Helper for the OpenMP loop directives.
2929 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
2930
2931 /// \brief Emit code for the worksharing loop-based directive.
2932 /// \return true, if this construct has any lastprivate clause, false -
2933 /// otherwise.
2934 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
2935 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
2936 const CodeGenDispatchBoundsTy &CGDispatchBounds);
2937
Alexey Bataevf8365372017-11-17 17:57:25 +00002938 /// Helpers for the OpenMP loop directives.
2939 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
2940 void EmitOMPSimdFinal(
2941 const OMPLoopDirective &D,
2942 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
2943
Alexey Bataevf47c4b42017-09-26 13:47:31 +00002944 /// Emits the lvalue for the expression with possibly captured variable.
2945 LValue EmitOMPSharedLValue(const Expr *E);
2946
Alexander Musmanc6388682014-12-15 07:07:06 +00002947private:
Yaxun Liuc2a87a02017-10-14 12:23:50 +00002948 /// Helpers for blocks. Returns invoke function by \p InvokeF if it is not
2949 /// nullptr. It should be called without \p InvokeF if the caller does not
2950 /// need invoke function to be returned.
2951 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info,
2952 llvm::Function **InvokeF = nullptr);
George Burgess IVe3763372016-12-22 02:50:20 +00002953
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002954 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
2955 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
2956
2957 /// struct with the values to be passed to the OpenMP loop-related functions
2958 struct OMPLoopArguments {
2959 /// loop lower bound
2960 Address LB = Address::invalid();
2961 /// loop upper bound
2962 Address UB = Address::invalid();
2963 /// loop stride
2964 Address ST = Address::invalid();
2965 /// isLastIteration argument for runtime functions
2966 Address IL = Address::invalid();
2967 /// Chunk value generated by sema
2968 llvm::Value *Chunk = nullptr;
2969 /// EnsureUpperBound
2970 Expr *EUB = nullptr;
2971 /// IncrementExpression
2972 Expr *IncExpr = nullptr;
2973 /// Loop initialization
2974 Expr *Init = nullptr;
2975 /// Loop exit condition
2976 Expr *Cond = nullptr;
2977 /// Update of LB after a whole chunk has been executed
2978 Expr *NextLB = nullptr;
2979 /// Update of UB after a whole chunk has been executed
2980 Expr *NextUB = nullptr;
2981 OMPLoopArguments() = default;
2982 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
2983 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
2984 Expr *IncExpr = nullptr, Expr *Init = nullptr,
2985 Expr *Cond = nullptr, Expr *NextLB = nullptr,
2986 Expr *NextUB = nullptr)
2987 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
2988 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
2989 NextUB(NextUB) {}
2990 };
2991 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
2992 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
2993 const OMPLoopArguments &LoopArgs,
2994 const CodeGenLoopTy &CodeGenLoop,
2995 const CodeGenOrderedTy &CodeGenOrdered);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00002996 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002997 bool IsMonotonic, const OMPLoopDirective &S,
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002998 OMPPrivateScope &LoopScope, bool Ordered,
2999 const OMPLoopArguments &LoopArgs,
3000 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3001 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
3002 const OMPLoopDirective &S,
3003 OMPPrivateScope &LoopScope,
3004 const OMPLoopArguments &LoopArgs,
3005 const CodeGenLoopTy &CodeGenLoopContent);
Alexey Bataev0f34da12015-07-02 04:17:07 +00003006 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00003007 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00003008
3009public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00003010
Chris Lattner208ae962007-05-30 17:57:17 +00003011 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00003012 // LValue Expression Emission
3013 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00003014
Daniel Dunbarc79407f2009-02-05 07:09:07 +00003015 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
3016 RValue GetUndefRValue(QualType Ty);
3017
Daniel Dunbarbb197e42009-01-09 16:50:52 +00003018 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
3019 /// and issue an ErrorUnsupported style diagnostic (using the
3020 /// provided Name).
3021 RValue EmitUnsupportedRValue(const Expr *E,
3022 const char *Name);
3023
Mike Stumpfc496822009-02-08 23:14:22 +00003024 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
3025 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00003026 LValue EmitUnsupportedLValue(const Expr *E,
3027 const char *Name);
3028
Chris Lattner8394d792007-06-05 20:53:16 +00003029 /// EmitLValue - Emit code to compute a designator that specifies the location
3030 /// of the expression.
3031 ///
3032 /// This can return one of two things: a simple address or a bitfield
3033 /// reference. In either case, the LLVM Value* in the LValue structure is
3034 /// guaranteed to be an LLVM pointer type.
3035 ///
3036 /// If this returns a bitfield reference, nothing about the pointee type of
3037 /// the LLVM value is known: For example, it may not be a pointer to an
3038 /// integer.
3039 ///
3040 /// If this returns a normal address, and if the lvalue's C type is fixed
3041 /// size, this method guarantees that the returned pointer type will point to
3042 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
3043 /// variable length type, this is not possible.
3044 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00003045 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003046
Richard Smith4d1458e2012-09-08 02:08:36 +00003047 /// \brief Same as EmitLValue but additionally we generate checking code to
3048 /// guard against undefined behavior. This is only suitable when we know
3049 /// that the address will be used to access the object.
3050 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00003051
John McCall7f416cc2015-09-08 08:05:57 +00003052 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003053 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00003054
John McCalla8ec7eb2013-03-07 21:37:17 +00003055 void EmitAtomicInit(Expr *E, LValue lvalue);
3056
David Majnemera5b195a2015-02-14 01:35:12 +00003057 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00003058
3059 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
3060 AggValueSlot Slot = AggValueSlot::ignored());
3061
Nick Lewycky2d84e842013-10-02 02:29:49 +00003062 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00003063 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00003064 AggValueSlot slot = AggValueSlot::ignored());
3065
3066 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3067
David Majnemera5b195a2015-02-14 01:35:12 +00003068 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3069 bool IsVolatile, bool isInit);
3070
Alexey Bataevb4505a72015-03-30 05:20:59 +00003071 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00003072 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00003073 llvm::AtomicOrdering Success =
3074 llvm::AtomicOrdering::SequentiallyConsistent,
3075 llvm::AtomicOrdering Failure =
3076 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00003077 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3078
Alexey Bataevb4505a72015-03-30 05:20:59 +00003079 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00003080 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00003081 bool IsVolatile);
3082
John McCall3a7f6922010-10-27 20:58:56 +00003083 /// EmitToMemory - Change a scalar value from its value
3084 /// representation to its in-memory representation.
3085 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3086
3087 /// EmitFromMemory - Change a scalar value from its memory
3088 /// representation to its value representation.
3089 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3090
Vedant Kumar5a972652017-02-27 19:46:19 +00003091 /// Check if the scalar \p Value is within the valid range for the given
3092 /// type \p Ty.
3093 ///
3094 /// Returns true if a check is needed (even if the range is unknown).
3095 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3096 SourceLocation Loc);
3097
Daniel Dunbar1d425462009-02-10 00:57:50 +00003098 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3099 /// care to appropriately convert from the memory representation to
3100 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003101 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003102 SourceLocation Loc,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003103 AlignmentSource Source = AlignmentSource::Type,
3104 bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003105 return EmitLoadOfScalar(Addr, Volatile, Ty, Loc, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003106 CGM.getTBAAAccessInfo(Ty), isNontemporal);
3107 }
3108
3109 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3110 SourceLocation Loc, LValueBaseInfo BaseInfo,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003111 TBAAAccessInfo TBAAInfo,
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003112 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003113
3114 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3115 /// care to appropriately convert from the memory representation to
3116 /// the LLVM value representation. The l-value must be a simple
3117 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003118 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003119
3120 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3121 /// care to appropriately convert from the memory representation to
3122 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003123 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3124 bool Volatile, QualType Ty,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003125 AlignmentSource Source = AlignmentSource::Type,
3126 bool isInit = false, bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003127 EmitStoreOfScalar(Value, Addr, Volatile, Ty, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003128 CGM.getTBAAAccessInfo(Ty), isInit, isNontemporal);
3129 }
3130
3131 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003132 bool Volatile, QualType Ty,
3133 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo,
Ivan A. Kosareva511ed72017-10-03 10:52:39 +00003134 bool isInit = false, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003135
3136 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3137 /// care to appropriately convert from the memory representation to
3138 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00003139 /// l-value. The isInit flag indicates whether this is an initialization.
3140 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3141 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003142
Chris Lattner8394d792007-06-05 20:53:16 +00003143 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3144 /// this method emits the address of the lvalue, then loads the result as an
3145 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003146 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00003147 RValue EmitLoadOfExtVectorElementLValue(LValue V);
Vedant Kumar129edab2017-03-09 16:06:27 +00003148 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
Renato Golin230c5eb2014-05-19 18:15:42 +00003149 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00003150
Chris Lattner8394d792007-06-05 20:53:16 +00003151 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3152 /// lvalue, where both are guaranteed to the have the same type, and that type
3153 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00003154 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003155 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00003156 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003157
Nick Lewycky2d84e842013-10-02 02:29:49 +00003158 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3159 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003160 ///
Mike Stumpfc496822009-02-08 23:14:22 +00003161 /// \param Result [out] - If non-null, this will be set to a Value* for the
3162 /// bit-field contents after the store, appropriate for use as the result of
3163 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00003164 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00003165 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00003166
John McCall4f29b492010-11-16 23:07:28 +00003167 /// Emit an l-value for an assignment (simple or compound) of complex type.
3168 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003169 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00003170 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3171 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00003172
Chris Lattner57540c52011-04-15 05:22:18 +00003173 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00003174 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003175 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003176 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00003177 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003178 // Note: only available for agg return types
3179 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00003180 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00003181 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00003182 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00003183 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00003184 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00003185 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3186 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00003187 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3188 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00003189 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00003190 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00003191 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00003192 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00003193 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00003194 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00003195 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00003196 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00003197 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003198
John McCall7f416cc2015-09-08 08:05:57 +00003199 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003200
Nick Lewycky2d84e842013-10-02 02:29:49 +00003201 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00003202
John McCall7f416cc2015-09-08 08:05:57 +00003203 Address EmitArrayToPointerDecay(const Expr *Array,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00003204 LValueBaseInfo *BaseInfo = nullptr,
3205 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003206
John McCall71335052012-03-10 03:05:10 +00003207 class ConstantEmission {
3208 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3209 ConstantEmission(llvm::Constant *C, bool isReference)
3210 : ValueAndIsReference(C, isReference) {}
3211 public:
3212 ConstantEmission() {}
3213 static ConstantEmission forReference(llvm::Constant *C) {
3214 return ConstantEmission(C, true);
3215 }
3216 static ConstantEmission forValue(llvm::Constant *C) {
3217 return ConstantEmission(C, false);
3218 }
3219
Aaron Ballman67347662015-02-15 22:00:28 +00003220 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00003221 return ValueAndIsReference.getOpaqueValue() != nullptr;
3222 }
John McCall71335052012-03-10 03:05:10 +00003223
3224 bool isReference() const { return ValueAndIsReference.getInt(); }
3225 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3226 assert(isReference());
3227 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3228 refExpr->getType());
3229 }
3230
3231 llvm::Constant *getValue() const {
3232 assert(!isReference());
3233 return ValueAndIsReference.getPointer();
3234 }
3235 };
3236
John McCall113bee02012-03-10 09:33:50 +00003237 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
Alex Lorenz6cc83172017-08-25 10:07:00 +00003238 ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
John McCall71335052012-03-10 03:05:10 +00003239
John McCallfe96e0b2011-11-06 09:01:30 +00003240 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3241 AggValueSlot slot = AggValueSlot::ignored());
3242 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3243
Daniel Dunbar722f4242009-04-22 05:08:15 +00003244 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003245 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00003246 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00003247 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003248
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003249 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3250 /// if the Field is a reference, this will return the address of the reference
3251 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003252 LValue EmitLValueForFieldInitialization(LValue Base,
3253 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003254
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003255 LValue EmitLValueForIvar(QualType ObjectTy,
3256 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003257 unsigned CVRQualifiers);
3258
Anders Carlsson3be22e22009-05-30 23:23:33 +00003259 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003260 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00003261 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003262 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003263 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003264
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003265 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003266 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003267 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003268 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003269 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003270 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003271
Chris Lattnerd7f58862007-06-02 05:24:33 +00003272 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003273 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003274 //===--------------------------------------------------------------------===//
3275
Mike Stumpfc496822009-02-08 23:14:22 +00003276 /// EmitCall - Generate a call of the given function, expecting the given
3277 /// result type, and using the given argument list which specifies both the
3278 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003279 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003280 ReturnValueSlot ReturnValue, const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00003281 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003282
John McCallb92ab1a2016-10-26 23:46:34 +00003283 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003284 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00003285 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003286 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003287 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003288 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3289 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003290
Eric Christopherc7e79db2015-11-12 00:44:04 +00003291 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003292
John McCall882987f2013-02-28 19:01:20 +00003293 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3294 const Twine &name = "");
3295 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3296 ArrayRef<llvm::Value*> args,
3297 const Twine &name = "");
3298 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3299 const Twine &name = "");
3300 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3301 ArrayRef<llvm::Value*> args,
3302 const Twine &name = "");
3303
John McCallbd309292010-07-06 01:34:17 +00003304 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003305 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00003306 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00003307 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3308 ArrayRef<llvm::Value*> args,
3309 const Twine &name = "");
3310 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3311 const Twine &name = "");
3312 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3313 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00003314
Gor Nishanov04491bd2017-11-11 17:00:43 +00003315 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
John McCallb92ab1a2016-10-26 23:46:34 +00003316 NestedNameSpecifier *Qual,
3317 llvm::Type *Ty);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003318
John McCallb92ab1a2016-10-26 23:46:34 +00003319 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
Gor Nishanov04491bd2017-11-11 17:00:43 +00003320 CXXDtorType Type,
John McCallb92ab1a2016-10-26 23:46:34 +00003321 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003322
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003323 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003324 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3325 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003326 ReturnValueSlot ReturnValue, llvm::Value *This,
3327 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003328 QualType ImplicitParamTy, const CallExpr *E,
3329 CallArgList *RtlArgs);
John McCallb92ab1a2016-10-26 23:46:34 +00003330 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3331 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003332 llvm::Value *This, llvm::Value *ImplicitParam,
3333 QualType ImplicitParamTy, const CallExpr *E,
3334 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003335 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3336 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003337 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3338 const CXXMethodDecl *MD,
3339 ReturnValueSlot ReturnValue,
3340 bool HasQualifier,
3341 NestedNameSpecifier *Qualifier,
3342 bool IsArrow, const Expr *Base);
3343 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003344 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3345 llvm::Value *memberPtr,
3346 const MemberPointerType *memberPtrType,
Ivan A. Kosarev229a6d82017-10-13 16:38:32 +00003347 LValueBaseInfo *BaseInfo = nullptr,
3348 TBAAAccessInfo *TBAAInfo = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003349 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3350 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003351
Anders Carlsson4034a952009-05-27 04:18:27 +00003352 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003353 const CXXMethodDecl *MD,
3354 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003355 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003356
Peter Collingbournefe883422011-10-06 18:29:37 +00003357 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3358 ReturnValueSlot ReturnValue);
3359
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003360 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3361 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003362
Mike Stump11289f42009-09-09 15:08:12 +00003363 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00003364 unsigned BuiltinID, const CallExpr *E,
3365 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003366
Akira Hatanaka6b103bc2017-10-06 07:12:46 +00003367 /// Emit IR for __builtin_os_log_format.
3368 RValue emitBuiltinOSLogFormat(const CallExpr &E);
3369
3370 llvm::Function *generateBuiltinOSLogHelperFunction(
3371 const analyze_os_log::OSLogBufferLayout &Layout,
3372 CharUnits BufferAlignment);
3373
Anders Carlssonbfb36712009-12-24 21:13:40 +00003374 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003375
Mike Stumpfc496822009-02-08 23:14:22 +00003376 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3377 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003378 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3379
Kevin Qin1718af62013-11-14 02:45:18 +00003380 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3381 const llvm::CmpInst::Predicate Fp,
3382 const llvm::CmpInst::Predicate Ip,
3383 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00003384 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00003385
3386 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3387 unsigned LLVMIntrinsic,
3388 unsigned AltLLVMIntrinsic,
3389 const char *NameHint,
3390 unsigned Modifier,
3391 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003392 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00003393 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00003394 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3395 unsigned Modifier, llvm::Type *ArgTy,
3396 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003397 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003398 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003399 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003400 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003401 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003402 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003403 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003404 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3405 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003406 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00003407 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003408
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003409 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003410 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3411 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003412 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003413 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003414 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003415 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3416 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003417
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003418private:
3419 enum class MSVCIntrin;
3420
3421public:
3422 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3423
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003424 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3425
Daniel Dunbar66912a12008-08-20 00:28:19 +00003426 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003427 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003428 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003429 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3430 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3431 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003432 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003433 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003434 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3435 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003436
John McCall31168b02011-06-15 23:02:42 +00003437 /// Retrieves the default cleanup kind for an ARC cleanup.
3438 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3439 CleanupKind getARCCleanupKind() {
3440 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3441 ? NormalAndEHCleanup : NormalCleanup;
3442 }
3443
3444 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003445 void EmitARCInitWeak(Address addr, llvm::Value *value);
3446 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003447 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003448 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3449 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3450 void EmitARCCopyWeak(Address dst, Address src);
3451 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003452 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3453 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003454 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003455 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003456 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003457 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003458 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003459 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003460 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003461 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003462 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003463 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003464 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3465 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3466 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003467 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003468
3469 std::pair<LValue,llvm::Value*>
3470 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3471 std::pair<LValue,llvm::Value*>
3472 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003473 std::pair<LValue,llvm::Value*>
3474 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003475
John McCall248512a2011-10-01 10:32:24 +00003476 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003477 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3478 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3479
John McCallff613032011-10-04 06:23:45 +00003480 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003481 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3482 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003483 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3484 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003485 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003486
Craig Topper00bbdcf2014-06-28 23:22:23 +00003487 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003488
John McCall82fe67b2011-07-09 01:37:26 +00003489 static Destroyer destroyARCStrongImprecise;
3490 static Destroyer destroyARCStrongPrecise;
3491 static Destroyer destroyARCWeak;
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00003492 static Destroyer emitARCIntrinsicUse;
John McCall82fe67b2011-07-09 01:37:26 +00003493
Gor Nishanov04491bd2017-11-11 17:00:43 +00003494 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003495 llvm::Value *EmitObjCAutoreleasePoolPush();
3496 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3497 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003498 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003499
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003500 /// \brief Emits a reference binding to the passed in expression.
3501 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003502
Chris Lattner6278e6a2007-08-11 00:04:45 +00003503 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003504 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003505 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003506
3507 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003508
3509 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3510 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003511 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003512
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003513 /// Emit a conversion from the specified type to the specified destination
3514 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003515 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003516 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003517
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003518 /// Emit a conversion from the specified complex type to the specified
3519 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003520 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003521 QualType DstTy,
3522 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003523
John McCall7a626f62010-09-15 10:14:12 +00003524 /// EmitAggExpr - Emit the computation of the specified expression
3525 /// of aggregate type. The result is computed into the given slot,
3526 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003527 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003528
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003529 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3530 /// aggregate type into a temporary LValue.
3531 LValue EmitAggExprToLValue(const Expr *E);
3532
John McCall1bd25562011-06-24 23:21:27 +00003533 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3534 /// make sure it survives garbage collection until this point.
3535 void EmitExtendGCLifetime(llvm::Value *object);
3536
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003537 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003538 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003539 ComplexPairTy EmitComplexExpr(const Expr *E,
3540 bool IgnoreReal = false,
3541 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003542
John McCall47fb9502013-03-07 21:37:08 +00003543 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3544 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003545 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003546
John McCall47fb9502013-03-07 21:37:08 +00003547 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003548 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003549
3550 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003551 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003552
John McCall7f416cc2015-09-08 08:05:57 +00003553 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3554 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3555
Chandler Carruth84537952012-03-30 19:44:53 +00003556 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3557 /// global variable that has already been created for it. If the initializer
3558 /// has a different type than GV does, this may free GV and return a different
3559 /// one. Otherwise it just returns GV.
3560 llvm::GlobalVariable *
3561 AddInitializerToStaticVarDecl(const VarDecl &D,
3562 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003563
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003564
Anders Carlssonf40886a2009-08-08 21:45:14 +00003565 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3566 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003567 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3568 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003569
David Majnemerb3341ea2014-10-05 05:05:40 +00003570 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3571 llvm::Constant *Addr);
3572
John McCallc84ed6a2012-05-01 06:13:13 +00003573 /// Call atexit() with a function that passes the given argument to
3574 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003575 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3576 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003577
John McCallcdf7ef52010-11-06 09:44:32 +00003578 /// Emit code in this function to perform a guarded variable
3579 /// initialization. Guarded initializations are used when it's not
3580 /// possible to prove that an initialization will be done exactly
3581 /// once, e.g. with a static local variable or a static data member
3582 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003583 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003584 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003585
Richard Smithae8d62c2017-07-26 22:01:09 +00003586 enum class GuardKind { VariableGuard, TlsGuard };
3587
3588 /// Emit a branch to select whether or not to perform guarded initialization.
3589 void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
3590 llvm::BasicBlock *InitBlock,
3591 llvm::BasicBlock *NoInitBlock,
3592 GuardKind Kind, const VarDecl *D);
3593
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003594 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3595 /// variables.
3596 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003597 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003598 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003599
John McCallee08c532012-04-06 18:21:03 +00003600 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003601 /// variables.
Sanjoy Dase369bd92017-05-01 17:08:00 +00003602 void GenerateCXXGlobalDtorsFunc(
3603 llvm::Function *Fn,
3604 const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
3605 &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003606
John McCalla738c252011-03-09 04:27:21 +00003607 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3608 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003609 llvm::GlobalVariable *Addr,
3610 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003611
John McCall7a626f62010-09-15 10:14:12 +00003612 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003613
John McCall7f416cc2015-09-08 08:05:57 +00003614 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003615
John McCall08ef4662011-11-10 08:15:53 +00003616 void enterFullExpression(const ExprWithCleanups *E) {
3617 if (E->getNumObjects() == 0) return;
3618 enterNonTrivialFullExpression(E);
3619 }
3620 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003621
Richard Smithea852322013-05-07 21:53:22 +00003622 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003623
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003624 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3625
Tim Northovercc2a6e02015-11-09 19:56:35 +00003626 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003627
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003628 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003629 // Annotations Emission
3630 //===--------------------------------------------------------------------===//
3631
3632 /// Emit an annotation call (intrinsic or builtin).
3633 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3634 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003635 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003636 SourceLocation Location);
3637
3638 /// Emit local annotations for the local variable V, declared by D.
3639 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3640
3641 /// Emit field annotations for the given field & value. Returns the
3642 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003643 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003644
3645 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003646 // Internal Helpers
3647 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003648
Chris Lattner5b1964b2008-11-11 07:41:27 +00003649 /// ContainsLabel - Return true if the statement contains a label in it. If
3650 /// this statement is not executed normally, it not containing a label means
3651 /// that we can just remove the code.
3652 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003653
Chris Lattner29911cc2011-02-28 00:18:40 +00003654 /// containsBreak - Return true if the statement contains a break out of it.
3655 /// If the statement (recursively) contains a switch or loop with a break
3656 /// inside of it, this is fine.
3657 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003658
3659 /// Determine if the given statement might introduce a declaration into the
3660 /// current scope, by being a (possibly-labelled) DeclStmt.
3661 static bool mightAddDeclToScope(const Stmt *S);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003662
Daniel Dunbar682712c2008-11-12 10:12:14 +00003663 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003664 /// to a constant, or if it does but contains a label, return false. If it
3665 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003666 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3667 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003668
Chris Lattner29911cc2011-02-28 00:18:40 +00003669 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3670 /// to a constant, or if it does but contains a label, return false. If it
3671 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003672 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3673 bool AllowLabels = false);
3674
Chris Lattnercd439292008-11-12 08:04:58 +00003675 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3676 /// if statement) to the specified blocks. Based on the condition, this might
3677 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003678 /// TrueCount should be the number of times we expect the condition to
3679 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003680 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003681 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003682
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003683 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
3684 /// nonnull, if \p LHS is marked _Nonnull.
3685 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
3686
Vedant Kumar175b6d12017-07-13 20:55:26 +00003687 /// An enumeration which makes it easier to specify whether or not an
3688 /// operation is a subtraction.
3689 enum { NotSubtraction = false, IsSubtraction = true };
3690
Vedant Kumara125eb52017-06-01 19:22:18 +00003691 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
3692 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003693 /// \p SignedIndices indicates whether any of the GEP indices are signed.
Vedant Kumar175b6d12017-07-13 20:55:26 +00003694 /// \p IsSubtraction indicates whether the expression used to form the GEP
3695 /// is a subtraction.
Vedant Kumara125eb52017-06-01 19:22:18 +00003696 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
3697 ArrayRef<llvm::Value *> IdxList,
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003698 bool SignedIndices,
Vedant Kumar175b6d12017-07-13 20:55:26 +00003699 bool IsSubtraction,
Vedant Kumara125eb52017-06-01 19:22:18 +00003700 SourceLocation Loc,
3701 const Twine &Name = "");
3702
Vedant Kumar10c31022017-07-29 00:19:51 +00003703 /// Specifies which type of sanitizer check to apply when handling a
3704 /// particular builtin.
3705 enum BuiltinCheckKind {
3706 BCK_CTZPassedZero,
3707 BCK_CLZPassedZero,
3708 };
3709
3710 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
3711 /// enabled, a runtime check specified by \p Kind is also emitted.
3712 llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
3713
Richard Smithe30752c2012-10-09 19:52:38 +00003714 /// \brief Emit a description of a type in a format suitable for passing to
3715 /// a runtime sanitizer handler.
3716 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3717
3718 /// \brief Convert a value into a format suitable for passing to a runtime
3719 /// sanitizer handler.
3720 llvm::Value *EmitCheckValue(llvm::Value *V);
3721
3722 /// \brief Emit a description of a source location in a format suitable for
3723 /// passing to a runtime sanitizer handler.
3724 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3725
Richard Smithde670682012-11-01 22:15:34 +00003726 /// \brief Create a basic block that will call a handler function in a
3727 /// sanitizer runtime with the provided arguments, and create a conditional
3728 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003729 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00003730 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003731 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003732
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003733 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3734 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003735 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3736 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3737 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003738
Richard Smithde670682012-11-01 22:15:34 +00003739 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3740 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003741 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003742
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003743 /// \brief Emit a call to trap or debugtrap and attach function attribute
3744 /// "trap-func-name" if specified.
3745 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3746
Evgeniy Stepanov1a8030e2017-04-07 23:00:38 +00003747 /// \brief Emit a stub for the cross-DSO CFI check function.
3748 void EmitCfiCheckStub();
3749
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003750 /// \brief Emit a cross-DSO CFI failure handling function.
3751 void EmitCfiCheckFail();
3752
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003753 /// \brief Create a check for a function parameter that may potentially be
3754 /// declared as non-null.
3755 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003756 AbstractCallee AC, unsigned ParmNum);
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003757
Anders Carlsson093bdff2010-03-30 03:27:09 +00003758 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003759 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003760
John McCall23f66262010-05-26 22:34:26 +00003761 /// EmitDelegateCallArg - We are performing a delegate call; that
3762 /// is, the current function is delegating to another one. Produce
3763 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003764 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3765 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003766
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003767 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3768 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003769 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003770
Chris Lattnercd439292008-11-12 08:04:58 +00003771private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003772 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003773 void EmitReturnOfRValue(RValue RV, QualType Ty);
3774
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003775 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3776
3777 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3778 DeferredReplacements;
3779
John McCall7f416cc2015-09-08 08:05:57 +00003780 /// Set the address of a local variable.
3781 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3782 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3783 LocalDeclMap.insert({VD, Addr});
3784 }
3785
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003786 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3787 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3788 ///
3789 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003790 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003791 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003792
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003793 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3794 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3795 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3796 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3797 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3798 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003799
Chad Rosier59df25b2012-08-23 20:00:18 +00003800 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003801 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003802
Chad Rosier59df25b2012-08-23 20:00:18 +00003803 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003804 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003805 std::string &ConstraintStr,
3806 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003807
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003808 /// \brief Attempts to statically evaluate the object size of E. If that
3809 /// fails, emits code to figure the size of E out for us. This is
3810 /// pass_object_size aware.
George Burgess IV0d6592a2017-02-23 05:59:56 +00003811 ///
3812 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003813 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003814 llvm::IntegerType *ResType,
3815 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003816
3817 /// \brief Emits the size of E, as required by __builtin_object_size. This
3818 /// function is aware of pass_object_size parameters, and will act accordingly
3819 /// if E is a parameter with the pass_object_size attribute.
3820 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003821 llvm::IntegerType *ResType,
3822 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003823
Reid Kleckner89077a12013-12-17 19:46:40 +00003824public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003825#ifndef NDEBUG
3826 // Determine whether the given argument is an Objective-C method
3827 // that may have type parameters in its signature.
3828 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3829 const DeclContext *dc = method->getDeclContext();
3830 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3831 return classDecl->getTypeParamListAsWritten();
3832 }
3833
3834 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3835 return catDecl->getTypeParamList();
3836 }
3837
3838 return false;
3839 }
3840
3841 template<typename T>
3842 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3843#endif
3844
Richard Smitha560ccf2016-09-29 21:30:12 +00003845 enum class EvaluationOrder {
3846 ///! No language constraints on evaluation order.
3847 Default,
3848 ///! Language semantics require left-to-right evaluation.
3849 ForceLeftToRight,
3850 ///! Language semantics require right-to-left evaluation.
3851 ForceRightToLeft
3852 };
3853
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003854 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003855 template <typename T>
3856 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003857 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003858 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003859 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003860 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003861 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003862 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003863
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003864 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3865 "Can't skip parameters if type info is not provided");
3866 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003867#ifndef NDEBUG
3868 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3869#endif
3870
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003871 // First, use the argument types that the type info knows about
3872 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3873 E = CallArgTypeInfo->param_type_end();
3874 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003875 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003876 assert((isGenericMethod ||
3877 ((*I)->isVariablyModifiedType() ||
3878 (*I).getNonReferenceType()->isObjCRetainableType() ||
3879 getContext()
3880 .getCanonicalType((*I).getNonReferenceType())
3881 .getTypePtr() ==
3882 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003883 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003884 .getTypePtr())) &&
3885 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003886 ArgTypes.push_back(*I);
3887 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003888 }
Mike Stump11289f42009-09-09 15:08:12 +00003889
Reid Kleckner739756c2013-12-04 19:23:12 +00003890 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003891 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003892 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3893 CallArgTypeInfo->isVariadic()) &&
3894 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003895
Anders Carlsson603d6af2009-04-18 20:20:22 +00003896 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003897 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00003898 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003899
Vedant Kumared00ea02017-03-06 05:28:22 +00003900 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003901 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003902
Reid Kleckner739756c2013-12-04 19:23:12 +00003903 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003904 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003905 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003906 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003907 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00003908
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00003909 /// EmitPointerWithAlignment - Given an expression with a pointer type,
3910 /// emit the value and compute our best estimate of the alignment of the
3911 /// pointee.
John McCall7f416cc2015-09-08 08:05:57 +00003912 ///
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00003913 /// \param BaseInfo - If non-null, this will be initialized with
3914 /// information about the source of the alignment and the may-alias
3915 /// attribute. Note that this function will conservatively fall back on
3916 /// the type when it doesn't recognize the expression and may-alias will
3917 /// be set to false.
3918 ///
3919 /// One reasonable way to use this information is when there's a language
3920 /// guarantee that the pointer must be aligned to some stricter value, and
3921 /// we're simply trying to ensure that sufficiently obvious uses of under-
3922 /// aligned objects don't get miscompiled; for example, a placement new
3923 /// into the address of a local variable. In such a case, it's quite
3924 /// reasonable to just ignore the returned alignment when it isn't from an
3925 /// explicit source.
John McCall7f416cc2015-09-08 08:05:57 +00003926 Address EmitPointerWithAlignment(const Expr *Addr,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00003927 LValueBaseInfo *BaseInfo = nullptr,
3928 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003929
Vedant Kumar36347d92017-12-08 01:51:47 +00003930 /// If \p E references a parameter with pass_object_size info or a constant
3931 /// array size modifier, emit the object size divided by the size of \p EltTy.
3932 /// Otherwise return null.
3933 llvm::Value *LoadPassedObjectSize(const Expr *E, QualType EltTy);
3934
Peter Collingbournedc134532016-01-16 00:31:22 +00003935 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3936
Reid Kleckner89077a12013-12-17 19:46:40 +00003937private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003938 QualType getVarArgType(const Expr *Arg);
3939
John McCall09ae0322010-07-06 23:57:41 +00003940 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003941
John McCall7f416cc2015-09-08 08:05:57 +00003942 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3943 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003944
3945 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003946
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003947 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Erich Keane9937b132017-09-01 19:42:45 +00003948 llvm::Value *EmitX86CpuIs(const CallExpr *E);
3949 llvm::Value *EmitX86CpuIs(StringRef CPUStr);
3950 llvm::Value *EmitX86CpuSupports(const CallExpr *E);
3951 llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
Erich Keane1fe643a2017-10-06 16:40:45 +00003952 llvm::Value *EmitX86CpuInit();
Chris Lattnerbed31442007-05-28 01:07:47 +00003953};
Mike Stump11289f42009-09-09 15:08:12 +00003954
John McCallce1de612011-01-26 04:00:11 +00003955/// Helper class with most of the code for saving a value for a
3956/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003957struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003958 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3959
3960 /// Answer whether the given value needs extra work to be saved.
3961 static bool needsSaving(llvm::Value *value) {
3962 // If it's not an instruction, we don't need to save.
3963 if (!isa<llvm::Instruction>(value)) return false;
3964
3965 // If it's an instruction in the entry block, we don't need to save.
3966 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3967 return (block != &block->getParent()->getEntryBlock());
3968 }
3969
3970 /// Try to save the given value.
3971 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3972 if (!needsSaving(value)) return saved_type(value, false);
3973
John McCall7f416cc2015-09-08 08:05:57 +00003974 // Otherwise, we need an alloca.
3975 auto align = CharUnits::fromQuantity(
3976 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3977 Address alloca =
3978 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003979 CGF.Builder.CreateStore(value, alloca);
3980
John McCall7f416cc2015-09-08 08:05:57 +00003981 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003982 }
3983
3984 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003985 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003986 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003987
3988 // Otherwise, it should be an alloca instruction, as set up in save().
3989 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3990 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003991 }
3992};
3993
John McCallcb5f77f2011-01-28 10:53:53 +00003994/// A partial specialization of DominatingValue for llvm::Values that
3995/// might be llvm::Instructions.
3996template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3997 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003998 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003999 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
4000 }
4001};
4002
John McCall7f416cc2015-09-08 08:05:57 +00004003/// A specialization of DominatingValue for Address.
4004template <> struct DominatingValue<Address> {
4005 typedef Address type;
4006
4007 struct saved_type {
4008 DominatingLLVMValue::saved_type SavedValue;
4009 CharUnits Alignment;
4010 };
4011
4012 static bool needsSaving(type value) {
4013 return DominatingLLVMValue::needsSaving(value.getPointer());
4014 }
4015 static saved_type save(CodeGenFunction &CGF, type value) {
4016 return { DominatingLLVMValue::save(CGF, value.getPointer()),
4017 value.getAlignment() };
4018 }
4019 static type restore(CodeGenFunction &CGF, saved_type value) {
4020 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
4021 value.Alignment);
4022 }
4023};
4024
John McCallcb5f77f2011-01-28 10:53:53 +00004025/// A specialization of DominatingValue for RValue.
4026template <> struct DominatingValue<RValue> {
4027 typedef RValue type;
4028 class saved_type {
4029 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
4030 AggregateAddress, ComplexAddress };
4031
4032 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00004033 unsigned K : 3;
4034 unsigned Align : 29;
4035 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
4036 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00004037
4038 public:
4039 static bool needsSaving(RValue value);
4040 static saved_type save(CodeGenFunction &CGF, RValue value);
4041 RValue restore(CodeGenFunction &CGF);
4042
John McCall7f416cc2015-09-08 08:05:57 +00004043 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00004044 };
4045
4046 static bool needsSaving(type value) {
4047 return saved_type::needsSaving(value);
4048 }
4049 static saved_type save(CodeGenFunction &CGF, type value) {
4050 return saved_type::save(CGF, value);
4051 }
4052 static type restore(CodeGenFunction &CGF, saved_type value) {
4053 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00004054 }
4055};
4056
Chris Lattnerbed31442007-05-28 01:07:47 +00004057} // end namespace CodeGen
4058} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00004059
Chris Lattnerbed31442007-05-28 01:07:47 +00004060#endif