blob: 2d919876e23c1799a22bcf4be9dd09db52c57cdf [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
Mike Stumpbee78dd2009-12-04 23:26:17 +0000228 /// CurGD - The GlobalDecl for the current function being compiled.
229 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000230
John McCall31168b02011-06-15 23:02:42 +0000231 /// PrologueCleanupDepth - The cleanup depth enclosing all the
232 /// cleanups associated with the parameters.
233 EHScopeStack::stable_iterator PrologueCleanupDepth;
234
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000235 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000236 JumpDest ReturnBlock;
237
John McCall7f416cc2015-09-08 08:05:57 +0000238 /// ReturnValue - The temporary alloca to hold the return
239 /// value. This is invalid iff the function has no return value.
240 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000241
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000242 /// Return true if a label was seen in the current scope.
243 bool hasLabelBeenSeenInCurrentScope() const {
244 if (CurLexicalScope)
245 return CurLexicalScope->hasLabels();
246 return !LabelMap.empty();
247 }
248
Chris Lattner03df1222007-06-02 04:53:11 +0000249 /// AllocaInsertPoint - This is an instruction in the entry block before which
250 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000251 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000252
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000253 /// \brief API for captured statement code generation.
254 class CGCapturedStmtInfo {
255 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000256 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
257 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000258 explicit CGCapturedStmtInfo(const CapturedStmt &S,
259 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000260 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000261
262 RecordDecl::field_iterator Field =
263 S.getCapturedRecordDecl()->field_begin();
264 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
265 E = S.capture_end();
266 I != E; ++I, ++Field) {
267 if (I->capturesThis())
268 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000269 else if (I->capturesVariable())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000270 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000271 else if (I->capturesVariableByCopy())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000272 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000273 }
274 }
275
276 virtual ~CGCapturedStmtInfo();
277
278 CapturedRegionKind getKind() const { return Kind; }
279
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000280 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000281 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000282 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000283
284 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000285 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000286 return CaptureFields.lookup(VD->getCanonicalDecl());
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000287 }
288
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000289 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
290 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000291
Alexey Bataev18095712014-10-10 12:19:54 +0000292 static bool classof(const CGCapturedStmtInfo *) {
293 return true;
294 }
295
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000296 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000297 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000298 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000299 CGF.EmitStmt(S);
300 }
301
302 /// \brief Get the name of the capture helper.
303 virtual StringRef getHelperName() const { return "__captured_stmt"; }
304
305 private:
306 /// \brief The kind of captured statement being generated.
307 CapturedRegionKind Kind;
308
309 /// \brief Keep the map between VarDecl and FieldDecl.
310 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
311
312 /// \brief The base address of the captured record, passed in as the first
313 /// argument of the parallel region function.
314 llvm::Value *ThisValue;
315
316 /// \brief Captured 'this' type.
317 FieldDecl *CXXThisFieldDecl;
318 };
319 CGCapturedStmtInfo *CapturedStmtInfo;
320
Alexey Bataevd157d472015-06-24 03:35:38 +0000321 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
322 class CGCapturedStmtRAII {
323 private:
324 CodeGenFunction &CGF;
325 CGCapturedStmtInfo *PrevCapturedStmtInfo;
326 public:
327 CGCapturedStmtRAII(CodeGenFunction &CGF,
328 CGCapturedStmtInfo *NewCapturedStmtInfo)
329 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
330 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
331 }
332 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
333 };
334
Vedant Kumared00ea02017-03-06 05:28:22 +0000335 /// An abstract representation of regular/ObjC call/message targets.
336 class AbstractCallee {
337 /// The function declaration of the callee.
338 const Decl *CalleeDecl;
339
340 public:
341 AbstractCallee() : CalleeDecl(nullptr) {}
342 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
343 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
344 bool hasFunctionDecl() const {
345 return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
346 }
347 const Decl *getDecl() const { return CalleeDecl; }
348 unsigned getNumParams() const {
349 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
350 return FD->getNumParams();
351 return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
352 }
353 const ParmVarDecl *getParamDecl(unsigned I) const {
354 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
355 return FD->getParamDecl(I);
356 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
357 }
358 };
359
Alexey Samsonova0416102014-11-11 01:26:14 +0000360 /// \brief Sanitizers enabled for this function.
361 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000362
Alexey Samsonov24cad992014-07-17 18:46:27 +0000363 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
364 bool IsSanitizerScope;
365
366 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
367 class SanitizerScope {
368 CodeGenFunction *CGF;
369 public:
370 SanitizerScope(CodeGenFunction *CGF);
371 ~SanitizerScope();
372 };
373
Reid Kleckner19819442014-07-25 21:39:46 +0000374 /// In C++, whether we are code generating a thunk. This controls whether we
375 /// should emit cleanups.
376 bool CurFuncIsThunk;
377
John McCall31168b02011-06-15 23:02:42 +0000378 /// In ARC, whether we should autorelease the return value.
379 bool AutoreleaseResult;
380
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000381 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
382 /// potentially set the return value.
383 bool SawAsmBlock;
384
David Majnemer25eb1652016-03-01 19:42:53 +0000385 const FunctionDecl *CurSEHParent = nullptr;
386
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000387 /// True if the current function is an outlined SEH helper. This can be a
388 /// finally block or filter expression.
389 bool IsOutlinedSEHHelper;
390
John McCallad7c5c12011-02-08 08:22:06 +0000391 const CodeGen::CGBlockInfo *BlockInfo;
392 llvm::Value *BlockPointer;
393
Eli Friedman9fbeba02012-02-11 02:57:39 +0000394 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
395 FieldDecl *LambdaThisCaptureField;
396
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000397 /// \brief A mapping from NRVO variables to the flags used to indicate
398 /// when the NRVO has been applied to this variable.
399 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000400
John McCallbd309292010-07-06 01:34:17 +0000401 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000402 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000403 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000404
David Majnemer4e52d6f2015-12-12 05:39:21 +0000405 llvm::Instruction *CurrentFuncletPad = nullptr;
406
Tim Shen421119f2016-07-01 21:08:47 +0000407 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
408 llvm::Value *Addr;
409 llvm::Value *Size;
410
411 public:
412 CallLifetimeEnd(Address addr, llvm::Value *size)
413 : Addr(addr.getPointer()), Size(size) {}
414
415 void Emit(CodeGenFunction &CGF, Flags flags) override {
416 CGF.EmitLifetimeEnd(Size, Addr);
417 }
418 };
419
Richard Smith736a9472013-06-12 20:42:33 +0000420 /// Header for data within LifetimeExtendedCleanupStack.
421 struct LifetimeExtendedCleanupHeader {
422 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000423 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000424 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000425 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000426
Justin Bognerbdff2192015-07-01 00:59:27 +0000427 size_t getSize() const { return Size; }
428 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000429 };
John McCallbd309292010-07-06 01:34:17 +0000430
John McCallad5d61e2010-07-23 21:56:41 +0000431 /// i32s containing the indexes of the cleanup destinations.
432 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000433
434 unsigned NextCleanupDestIndex;
435
John McCall08ef4662011-11-10 08:15:53 +0000436 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
437 CGBlockInfo *FirstBlockInfo;
438
John McCall8e4c74b2011-08-11 02:22:43 +0000439 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
440 llvm::BasicBlock *EHResumeBlock;
441
Bill Wendlingf0724e82011-09-19 20:31:14 +0000442 /// The exception slot. All landing pads write the current exception pointer
443 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000444 llvm::Value *ExceptionSlot;
445
Bill Wendlingf0724e82011-09-19 20:31:14 +0000446 /// The selector slot. Under the MandatoryCleanup model, all landing pads
447 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000448 llvm::AllocaInst *EHSelectorSlot;
449
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000450 /// A stack of exception code slots. Entering an __except block pushes a slot
451 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
452 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000453 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000454
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000455 /// Value returned by __exception_info intrinsic.
456 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000457
John McCallbd309292010-07-06 01:34:17 +0000458 /// Emits a landing pad for the current EH stack.
459 llvm::BasicBlock *EmitLandingPad();
460
461 llvm::BasicBlock *getInvokeDestImpl();
462
John McCallce1de612011-01-26 04:00:11 +0000463 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000464 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
465 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000466 }
467
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000468public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000469 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
470 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000471 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000472
John McCall6b0feb72011-06-22 02:32:12 +0000473 /// A class controlling the emission of a finally block.
474 class FinallyInfo {
475 /// Where the catchall's edge through the cleanup should go.
476 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000477
John McCall6b0feb72011-06-22 02:32:12 +0000478 /// A function to call to enter the catch.
479 llvm::Constant *BeginCatchFn;
480
481 /// An i1 variable indicating whether or not the @finally is
482 /// running for an exception.
483 llvm::AllocaInst *ForEHVar;
484
485 /// An i8* variable into which the exception pointer to rethrow
486 /// has been saved.
487 llvm::AllocaInst *SavedExnVar;
488
489 public:
490 void enter(CodeGenFunction &CGF, const Stmt *Finally,
491 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
492 llvm::Constant *rethrowFn);
493 void exit(CodeGenFunction &CGF);
494 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000495
Reid Kleckner11c033e2015-02-12 23:40:45 +0000496 /// Returns true inside SEH __try blocks.
497 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
498
Reid Klecknera002bd52015-10-28 23:06:42 +0000499 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000500 bool isCleanupPadScope() const {
501 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
502 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000503
John McCallce1de612011-01-26 04:00:11 +0000504 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
505 /// current full-expression. Safe against the possibility that
506 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000507 template <class T, class... As>
508 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000509 // If we're not in a conditional branch, or if none of the
510 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000511 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000512 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000513
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000514 // Stash values in a tuple so we can guarantee the order of saves.
515 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
516 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000517
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000518 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000519 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000520 initFullExprCleanup();
521 }
522
Richard Smith736a9472013-06-12 20:42:33 +0000523 /// \brief Queue a cleanup to be pushed after finishing the current
524 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000525 template <class T, class... As>
526 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000527 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
528
529 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
530
531 size_t OldSize = LifetimeExtendedCleanupStack.size();
532 LifetimeExtendedCleanupStack.resize(
533 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
534
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000535 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000536 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000537 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
538 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000539 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000540 }
541
John McCallf4beacd2011-11-10 10:43:54 +0000542 /// Set up the last cleaup that was pushed as a conditional
543 /// full-expression cleanup.
544 void initFullExprCleanup();
545
John McCallbd309292010-07-06 01:34:17 +0000546 /// PushDestructorCleanup - Push a cleanup to call the
547 /// complete-object destructor of an object of the given type at the
548 /// given address. Does nothing if T is not a C++ class type with a
549 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000550 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000551
John McCall8680f872010-07-21 06:29:51 +0000552 /// PushDestructorCleanup - Push a cleanup to call the
553 /// complete-object variant of the given destructor on the object at
554 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000555 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000556
John McCallbd309292010-07-06 01:34:17 +0000557 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
558 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000559 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000560
John McCall824c2f52010-09-14 07:57:04 +0000561 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
562 /// The block cannot be reactivated. Pops it if it's the top of the
563 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000564 ///
565 /// \param DominatingIP - An instruction which is known to
566 /// dominate the current IP (if set) and which lies along
567 /// all paths of execution between the current IP and the
568 /// the point at which the cleanup comes into scope.
569 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
570 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000571
572 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
573 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000574 ///
575 /// \param DominatingIP - An instruction which is known to
576 /// dominate the current IP (if set) and which lies along
577 /// all paths of execution between the current IP and the
578 /// the point at which the cleanup comes into scope.
579 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
580 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000581
John McCallbd309292010-07-06 01:34:17 +0000582 /// \brief Enters a new scope for capturing cleanups, all of which
583 /// will be executed once the scope is exited.
584 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000585 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000586 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000587 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000588 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000589 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000590 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000591
Aaron Ballmanabc18922015-02-15 22:54:08 +0000592 RunCleanupsScope(const RunCleanupsScope &) = delete;
593 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000594
Eric Christophera9d34972011-10-19 00:43:52 +0000595 protected:
596 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000597
Douglas Gregor965f4502009-11-24 16:43:22 +0000598 public:
599 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000600 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000601 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000602 {
John McCallbd309292010-07-06 01:34:17 +0000603 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000604 LifetimeExtendedCleanupStackSize =
605 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000606 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000607 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000608 }
609
Reid Kleckner092d0652017-03-06 22:18:34 +0000610 /// \brief Exit this cleanup scope, emitting any accumulated cleanups.
John McCallbd309292010-07-06 01:34:17 +0000611 ~RunCleanupsScope() {
Reid Kleckner092d0652017-03-06 22:18:34 +0000612 if (PerformCleanup)
613 ForceCleanup();
Douglas Gregor680f8612009-11-24 21:15:44 +0000614 }
615
616 /// \brief Determine whether this scope requires any cleanups.
617 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000618 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000619 }
620
621 /// \brief Force the emission of cleanups now, instead of waiting
622 /// until this object is destroyed.
Reid Kleckner092d0652017-03-06 22:18:34 +0000623 /// \param ValuesToReload - A list of values that need to be available at
624 /// the insertion point after cleanup emission. If cleanup emission created
625 /// a shared cleanup block, these value pointers will be rewritten.
626 /// Otherwise, they not will be modified.
627 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
Douglas Gregor680f8612009-11-24 21:15:44 +0000628 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000629 CGF.DidCallStackSave = OldDidCallStackSave;
Reid Kleckner092d0652017-03-06 22:18:34 +0000630 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
631 ValuesToReload);
Douglas Gregor680f8612009-11-24 21:15:44 +0000632 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000633 }
634 };
635
David Blaikie93be0b22014-08-22 21:37:04 +0000636 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000637 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000638 SmallVector<const LabelDecl*, 4> Labels;
639 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000640
Aaron Ballmanabc18922015-02-15 22:54:08 +0000641 LexicalScope(const LexicalScope &) = delete;
642 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000643
644 public:
645 /// \brief Enter a new cleanup scope.
646 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000647 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
648 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000649 if (CGDebugInfo *DI = CGF.getDebugInfo())
650 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
651 }
652
Nadav Rotem1da30942013-03-23 06:43:35 +0000653 void addLabel(const LabelDecl *label) {
654 assert(PerformCleanup && "adding label to dead scope?");
655 Labels.push_back(label);
656 }
657
Eric Christophera9d34972011-10-19 00:43:52 +0000658 /// \brief Exit this cleanup scope, emitting any accumulated
659 /// cleanups.
660 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000661 if (CGDebugInfo *DI = CGF.getDebugInfo())
662 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
663
Nadav Rotem1da30942013-03-23 06:43:35 +0000664 // If we should perform a cleanup, force them now. Note that
665 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000666 if (PerformCleanup) {
667 ApplyDebugLocation DL(CGF, Range.getEnd());
668 ForceCleanup();
669 }
Eric Christophera9d34972011-10-19 00:43:52 +0000670 }
671
672 /// \brief Force the emission of cleanups now, instead of waiting
673 /// until this object is destroyed.
674 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000675 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000676 RunCleanupsScope::ForceCleanup();
677
Nadav Rotem1da30942013-03-23 06:43:35 +0000678 if (!Labels.empty())
679 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000680 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000681
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000682 bool hasLabels() const {
683 return !Labels.empty();
684 }
685
Nadav Rotem1da30942013-03-23 06:43:35 +0000686 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000687 };
688
John McCall7f416cc2015-09-08 08:05:57 +0000689 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
690
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000691 /// \brief The scope used to remap some variables as private in the OpenMP
692 /// loop body (or other captured region emitted without outlining), and to
693 /// restore old vars back on exit.
694 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000695 DeclMapTy SavedLocals;
696 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000697
698 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000699 OMPPrivateScope(const OMPPrivateScope &) = delete;
700 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000701
702 public:
703 /// \brief Enter a new OpenMP private scope.
704 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
705
706 /// \brief Registers \a LocalVD variable as a private and apply \a
707 /// PrivateGen function for it to generate corresponding private variable.
708 /// \a PrivateGen returns an address of the generated private variable.
709 /// \return true if the variable is registered as private, false if it has
710 /// been privatized already.
711 bool
712 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000713 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000714 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000715
Alexey Bataev6a71f362017-08-22 17:54:52 +0000716 LocalVD = LocalVD->getCanonicalDecl();
John McCall7f416cc2015-09-08 08:05:57 +0000717 // Only save it once.
718 if (SavedLocals.count(LocalVD)) return false;
719
720 // Copy the existing local entry to SavedLocals.
721 auto it = CGF.LocalDeclMap.find(LocalVD);
722 if (it != CGF.LocalDeclMap.end()) {
723 SavedLocals.insert({LocalVD, it->second});
724 } else {
725 SavedLocals.insert({LocalVD, Address::invalid()});
726 }
727
728 // Generate the private entry.
729 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000730 QualType VarTy = LocalVD->getType();
731 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000732 Address Temp = CGF.CreateMemTemp(VarTy);
733 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
734 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000735 }
John McCall7f416cc2015-09-08 08:05:57 +0000736 SavedPrivates.insert({LocalVD, Addr});
737
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000738 return true;
739 }
740
741 /// \brief Privatizes local variables previously registered as private.
742 /// Registration is separate from the actual privatization to allow
743 /// initializers use values of the original variables, not the private one.
744 /// This is important, for example, if the private variable is a class
745 /// variable initialized by a constructor that references other private
746 /// variables. But at initialization original variables must be used, not
747 /// private copies.
748 /// \return true if at least one variable was privatized, false otherwise.
749 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000750 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000751 SavedPrivates.clear();
752 return !SavedLocals.empty();
753 }
754
755 void ForceCleanup() {
756 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000757 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000758 SavedLocals.clear();
759 }
760
761 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000762 ~OMPPrivateScope() {
763 if (PerformCleanup)
764 ForceCleanup();
765 }
John McCall7f416cc2015-09-08 08:05:57 +0000766
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000767 /// Checks if the global variable is captured in current function.
768 bool isGlobalVarCaptured(const VarDecl *VD) const {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000769 VD = VD->getCanonicalDecl();
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000770 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
771 }
772
John McCall7f416cc2015-09-08 08:05:57 +0000773 private:
774 /// Copy all the entries in the source map over the corresponding
775 /// entries in the destination, which must exist.
776 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
777 for (auto &pair : src) {
778 if (!pair.second.isValid()) {
779 dest.erase(pair.first);
780 continue;
781 }
782
783 auto it = dest.find(pair.first);
784 if (it != dest.end()) {
785 it->second = pair.second;
786 } else {
787 dest.insert(pair);
788 }
789 }
790 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000791 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000792
Richard Smith736a9472013-06-12 20:42:33 +0000793 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
794 /// that have been added.
Reid Kleckner092d0652017-03-06 22:18:34 +0000795 void
796 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
797 std::initializer_list<llvm::Value **> ValuesToReload = {});
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000798
Richard Smith736a9472013-06-12 20:42:33 +0000799 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
800 /// that have been added, then adds all lifetime-extended cleanups from
801 /// the given position to the stack.
Reid Kleckner092d0652017-03-06 22:18:34 +0000802 void
803 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
804 size_t OldLifetimeExtendedStackSize,
805 std::initializer_list<llvm::Value **> ValuesToReload = {});
Richard Smith736a9472013-06-12 20:42:33 +0000806
John McCallad5d61e2010-07-23 21:56:41 +0000807 void ResolveBranchFixups(llvm::BasicBlock *Target);
808
John McCallbd309292010-07-06 01:34:17 +0000809 /// The given basic block lies in the current EH scope, but may be a
810 /// target of a potentially scope-crossing jump; get a stable handle
811 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000812 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000813 return JumpDest(Target,
814 EHStack.getInnermostNormalCleanup(),
815 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000816 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000817
John McCallbd309292010-07-06 01:34:17 +0000818 /// The given basic block lies in the current EH scope, but may be a
819 /// target of a potentially scope-crossing jump; get a stable handle
820 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000821 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000822 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000823 }
824
825 /// EmitBranchThroughCleanup - Emit a branch from the current insert
826 /// block through the normal cleanup handling code (if any) and then
827 /// on to \arg Dest.
828 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000829
Justin Bognere25ffdf2014-01-21 00:35:11 +0000830 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
831 /// specified destination obviously has no cleanups to run. 'false' is always
832 /// a conservatively correct answer for this method.
833 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
834
John McCall8e4c74b2011-08-11 02:22:43 +0000835 /// popCatchScope - Pops the catch scope at the top of the EHScope
836 /// stack, emitting any required code (other than the catch handlers
837 /// themselves).
838 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000839
David Chisnall9a837be2012-11-07 16:50:40 +0000840 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000841 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000842 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000843
John McCallce1de612011-01-26 04:00:11 +0000844 /// An object to manage conditionally-evaluated expressions.
845 class ConditionalEvaluation {
846 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000847
John McCallce1de612011-01-26 04:00:11 +0000848 public:
849 ConditionalEvaluation(CodeGenFunction &CGF)
850 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000851
John McCallce1de612011-01-26 04:00:11 +0000852 void begin(CodeGenFunction &CGF) {
853 assert(CGF.OutermostConditional != this);
854 if (!CGF.OutermostConditional)
855 CGF.OutermostConditional = this;
856 }
857
858 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000859 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000860 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000861 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000862 }
863
864 /// Returns a block which will be executed prior to each
865 /// evaluation of the conditional code.
866 llvm::BasicBlock *getStartingBlock() const {
867 return StartBB;
868 }
869 };
Mike Stump11289f42009-09-09 15:08:12 +0000870
John McCall7f9c92a2010-09-17 00:50:28 +0000871 /// isInConditionalBranch - Return true if we're currently emitting
872 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000873 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000874
John McCall7f416cc2015-09-08 08:05:57 +0000875 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000876 assert(isInConditionalBranch());
877 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000878 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
879 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000880 }
881
John McCallce1de612011-01-26 04:00:11 +0000882 /// An RAII object to record that we're evaluating a statement
883 /// expression.
884 class StmtExprEvaluation {
885 CodeGenFunction &CGF;
886
887 /// We have to save the outermost conditional: cleanups in a
888 /// statement expression aren't conditional just because the
889 /// StmtExpr is.
890 ConditionalEvaluation *SavedOutermostConditional;
891
892 public:
893 StmtExprEvaluation(CodeGenFunction &CGF)
894 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000895 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000896 }
897
898 ~StmtExprEvaluation() {
899 CGF.OutermostConditional = SavedOutermostConditional;
900 CGF.EnsureInsertPoint();
901 }
902 };
John McCall1bf58462011-02-16 08:02:54 +0000903
John McCallc07a0c72011-02-17 10:25:35 +0000904 /// An object which temporarily prevents a value from being
905 /// destroyed by aggressive peephole optimizations that assume that
906 /// all uses of a value have been realized in the IR.
907 class PeepholeProtection {
908 llvm::Instruction *Inst;
909 friend class CodeGenFunction;
910
911 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000912 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000913 };
John McCallc07a0c72011-02-17 10:25:35 +0000914
John McCallfe96e0b2011-11-06 09:01:30 +0000915 /// A non-RAII class containing all the information about a bound
916 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
917 /// this which makes individual mappings very simple; using this
918 /// class directly is useful when you have a variable number of
919 /// opaque values or don't want the RAII functionality for some
920 /// reason.
921 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000922 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000923 bool BoundLValue;
924 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000925
John McCallfe96e0b2011-11-06 09:01:30 +0000926 OpaqueValueMappingData(const OpaqueValueExpr *ov,
927 bool boundLValue)
928 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000929 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000930 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000931
John McCallc07a0c72011-02-17 10:25:35 +0000932 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000933 // gl-values should be bound as l-values for obvious reasons.
934 // Records should be bound as l-values because IR generation
935 // always keeps them in memory. Expressions of function type
936 // act exactly like l-values but are formally required to be
937 // r-values in C.
938 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000939 expr->getType()->isFunctionType() ||
940 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000941 }
942
John McCallfe96e0b2011-11-06 09:01:30 +0000943 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
944 const OpaqueValueExpr *ov,
945 const Expr *e) {
946 if (shouldBindAsLValue(ov))
947 return bind(CGF, ov, CGF.EmitLValue(e));
948 return bind(CGF, ov, CGF.EmitAnyExpr(e));
949 }
950
951 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
952 const OpaqueValueExpr *ov,
953 const LValue &lv) {
954 assert(shouldBindAsLValue(ov));
955 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
956 return OpaqueValueMappingData(ov, true);
957 }
958
959 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
960 const OpaqueValueExpr *ov,
961 const RValue &rv) {
962 assert(!shouldBindAsLValue(ov));
963 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
964
965 OpaqueValueMappingData data(ov, false);
966
967 // Work around an extremely aggressive peephole optimization in
968 // EmitScalarConversion which assumes that all other uses of a
969 // value are extant.
970 data.Protection = CGF.protectFromPeepholes(rv);
971
972 return data;
973 }
974
Craig Topper8a13c412014-05-21 05:09:00 +0000975 bool isValid() const { return OpaqueValue != nullptr; }
976 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000977
978 void unbind(CodeGenFunction &CGF) {
979 assert(OpaqueValue && "no data to unbind!");
980
981 if (BoundLValue) {
982 CGF.OpaqueLValues.erase(OpaqueValue);
983 } else {
984 CGF.OpaqueRValues.erase(OpaqueValue);
985 CGF.unprotectFromPeepholes(Protection);
986 }
987 }
988 };
989
990 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
991 class OpaqueValueMapping {
992 CodeGenFunction &CGF;
993 OpaqueValueMappingData Data;
994
995 public:
996 static bool shouldBindAsLValue(const Expr *expr) {
997 return OpaqueValueMappingData::shouldBindAsLValue(expr);
998 }
999
John McCallc07a0c72011-02-17 10:25:35 +00001000 /// Build the opaque value mapping for the given conditional
1001 /// operator if it's the GNU ?: extension. This is a common
1002 /// enough pattern that the convenience operator is really
1003 /// helpful.
1004 ///
1005 OpaqueValueMapping(CodeGenFunction &CGF,
1006 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +00001007 if (isa<ConditionalOperator>(op))
1008 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001009 return;
John McCallc07a0c72011-02-17 10:25:35 +00001010
1011 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001012 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1013 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001014 }
1015
Richard Smith410306b2016-12-12 02:53:20 +00001016 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1017 /// expression is set to the expression the OVE represents.
1018 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1019 : CGF(CGF) {
1020 if (OV) {
1021 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1022 "for OVE with no source expression");
1023 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1024 }
1025 }
1026
John McCall1bf58462011-02-16 08:02:54 +00001027 OpaqueValueMapping(CodeGenFunction &CGF,
1028 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001029 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001030 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001031 }
1032
1033 OpaqueValueMapping(CodeGenFunction &CGF,
1034 const OpaqueValueExpr *opaqueValue,
1035 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001036 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001037 }
1038
1039 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001040 Data.unbind(CGF);
1041 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001042 }
1043
1044 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001045 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001046 }
1047 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +00001048
Chris Lattner2da04b32007-08-24 05:35:26 +00001049private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001050 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001051 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001052
John McCall9b382dd2011-05-28 21:13:02 +00001053 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1054 /// calling llvm.stacksave for multiple VLAs in the same scope.
1055 bool DidCallStackSave;
1056
Mike Stumpe5311b02009-11-30 20:08:49 +00001057 /// IndirectBranch - The first time an indirect goto is seen we create a block
1058 /// with an indirect branch. Every time we see the address of a label taken,
1059 /// we add the label to the indirect goto. Every subsequent indirect goto is
1060 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +00001061 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001062
Mike Stumpfc496822009-02-08 23:14:22 +00001063 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1064 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001065 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001066
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001067 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1068 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1069 /// parameter.
1070 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1071 SizeArguments;
1072
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001073 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001074 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001075 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1076
Chris Lattnerac248202007-05-30 00:13:02 +00001077 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001078 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001079
Mike Stumpfc496822009-02-08 23:14:22 +00001080 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001081 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001082 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001083 BreakContinue(JumpDest Break, JumpDest Continue)
1084 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001085
John McCallbd309292010-07-06 01:34:17 +00001086 JumpDest BreakBlock;
1087 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001088 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001089 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001090
Alexey Bataev957d8562016-11-17 15:12:05 +00001091 /// Handles cancellation exit points in OpenMP-related constructs.
1092 class OpenMPCancelExitStack {
1093 /// Tracks cancellation exit point and join point for cancel-related exit
1094 /// and normal exit.
1095 struct CancelExit {
1096 CancelExit() = default;
1097 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1098 JumpDest ContBlock)
1099 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1100 OpenMPDirectiveKind Kind = OMPD_unknown;
1101 /// true if the exit block has been emitted already by the special
1102 /// emitExit() call, false if the default codegen is used.
1103 bool HasBeenEmitted = false;
1104 JumpDest ExitBlock;
1105 JumpDest ContBlock;
1106 };
1107
1108 SmallVector<CancelExit, 8> Stack;
1109
1110 public:
1111 OpenMPCancelExitStack() : Stack(1) {}
1112 ~OpenMPCancelExitStack() = default;
1113 /// Fetches the exit block for the current OpenMP construct.
1114 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1115 /// Emits exit block with special codegen procedure specific for the related
1116 /// OpenMP construct + emits code for normal construct cleanup.
1117 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1118 const llvm::function_ref<void(CodeGenFunction &)> &CodeGen) {
1119 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1120 assert(CGF.getOMPCancelDestination(Kind).isValid());
1121 assert(CGF.HaveInsertPoint());
1122 assert(!Stack.back().HasBeenEmitted);
1123 auto IP = CGF.Builder.saveAndClearIP();
1124 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1125 CodeGen(CGF);
Erich Keane0026ed22017-07-27 16:28:20 +00001126 CGF.EmitBranch(Stack.back().ContBlock.getBlock());
Alexey Bataev957d8562016-11-17 15:12:05 +00001127 CGF.Builder.restoreIP(IP);
1128 Stack.back().HasBeenEmitted = true;
1129 }
1130 CodeGen(CGF);
1131 }
1132 /// Enter the cancel supporting \a Kind construct.
1133 /// \param Kind OpenMP directive that supports cancel constructs.
1134 /// \param HasCancel true, if the construct has inner cancel directive,
1135 /// false otherwise.
1136 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1137 Stack.push_back({Kind,
1138 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1139 : JumpDest(),
1140 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1141 : JumpDest()});
1142 }
1143 /// Emits default exit point for the cancel construct (if the special one
1144 /// has not be used) + join point for cancel/normal exits.
1145 void exit(CodeGenFunction &CGF) {
1146 if (getExitBlock().isValid()) {
1147 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1148 bool HaveIP = CGF.HaveInsertPoint();
1149 if (!Stack.back().HasBeenEmitted) {
1150 if (HaveIP)
1151 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1152 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1153 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1154 }
1155 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1156 if (!HaveIP) {
1157 CGF.Builder.CreateUnreachable();
1158 CGF.Builder.ClearInsertionPoint();
1159 }
1160 }
1161 Stack.pop_back();
1162 }
1163 };
1164 OpenMPCancelExitStack OMPCancelStack;
1165
1166 /// Controls insertion of cancellation exit blocks in worksharing constructs.
1167 class OMPCancelStackRAII {
1168 CodeGenFunction &CGF;
1169
1170 public:
1171 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1172 bool HasCancel)
1173 : CGF(CGF) {
1174 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
1175 }
1176 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
1177 };
1178
Justin Bogneref512b92014-01-06 22:27:43 +00001179 CodeGenPGO PGO;
1180
Justin Bogner65512642015-05-02 05:00:55 +00001181 /// Calculate branch weights appropriate for PGO data
1182 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1183 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1184 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1185 uint64_t LoopCount);
1186
Justin Bogneref512b92014-01-06 22:27:43 +00001187public:
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001188 /// Increment the profiler's counter for the given statement by \p StepV.
1189 /// If \p StepV is null, the default increment is 1.
1190 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
Rong Xu9837ef52016-02-04 18:39:09 +00001191 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001192 PGO.emitCounterIncrement(Builder, S, StepV);
Justin Bogner66242d62015-04-23 23:06:47 +00001193 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001194 }
Justin Bogner66242d62015-04-23 23:06:47 +00001195
1196 /// Get the profiler's count for the given statement.
1197 uint64_t getProfileCount(const Stmt *S) {
1198 Optional<uint64_t> Count = PGO.getStmtCount(S);
1199 if (!Count.hasValue())
1200 return 0;
1201 return *Count;
1202 }
1203
1204 /// Set the profiler's current count.
1205 void setCurrentProfileCount(uint64_t Count) {
1206 PGO.setCurrentRegionCount(Count);
1207 }
1208
1209 /// Get the profiler's current count. This is generally the count for the most
1210 /// recently incremented counter.
1211 uint64_t getCurrentProfileCount() {
1212 return PGO.getCurrentRegionCount();
1213 }
1214
Justin Bogneref512b92014-01-06 22:27:43 +00001215private:
1216
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001217 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001218 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001219 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001220 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1221 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001222
Mike Stumpfc496822009-02-08 23:14:22 +00001223 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001224 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001225 llvm::BasicBlock *CaseRangeBlock;
1226
John McCallc07a0c72011-02-17 10:25:35 +00001227 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001228 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001229 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1230 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001231
Mike Stumpfc496822009-02-08 23:14:22 +00001232 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001233 // We track this by the size expression rather than the type itself because
1234 // in certain situations, like a const qualifier applied to an VLA typedef,
1235 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001236 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1237 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001238 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001239
John McCallbd309292010-07-06 01:34:17 +00001240 /// A block containing a single 'unreachable' instruction. Created
1241 /// lazily by getUnreachableBlock().
1242 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001243
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001244 /// Counts of the number return expressions in the function.
1245 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001246
1247 /// Count the number of simple (constant) return expressions in the function.
1248 unsigned NumSimpleReturnExprs;
1249
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001250 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001251 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001252
Richard Smith852c9db2013-04-20 22:23:05 +00001253public:
1254 /// A scope within which we are constructing the fields of an object which
1255 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1256 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1257 class FieldConstructionScope {
1258 public:
John McCall7f416cc2015-09-08 08:05:57 +00001259 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001260 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1261 CGF.CXXDefaultInitExprThis = This;
1262 }
1263 ~FieldConstructionScope() {
1264 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1265 }
1266
1267 private:
1268 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001269 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001270 };
1271
1272 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1273 /// is overridden to be the object under construction.
1274 class CXXDefaultInitExprScope {
1275 public:
1276 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001277 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1278 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1279 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1280 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001281 }
1282 ~CXXDefaultInitExprScope() {
1283 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001284 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001285 }
1286
1287 public:
1288 CodeGenFunction &CGF;
1289 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001290 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001291 };
1292
Richard Smith410306b2016-12-12 02:53:20 +00001293 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1294 /// current loop index is overridden.
1295 class ArrayInitLoopExprScope {
1296 public:
1297 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1298 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1299 CGF.ArrayInitIndex = Index;
1300 }
1301 ~ArrayInitLoopExprScope() {
1302 CGF.ArrayInitIndex = OldArrayInitIndex;
1303 }
1304
1305 private:
1306 CodeGenFunction &CGF;
1307 llvm::Value *OldArrayInitIndex;
1308 };
1309
Richard Smith5179eb72016-06-28 19:03:57 +00001310 class InlinedInheritingConstructorScope {
1311 public:
1312 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1313 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1314 OldCurCodeDecl(CGF.CurCodeDecl),
1315 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1316 OldCXXABIThisValue(CGF.CXXABIThisValue),
1317 OldCXXThisValue(CGF.CXXThisValue),
1318 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1319 OldCXXThisAlignment(CGF.CXXThisAlignment),
1320 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1321 OldCXXInheritedCtorInitExprArgs(
1322 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1323 CGF.CurGD = GD;
1324 CGF.CurFuncDecl = CGF.CurCodeDecl =
1325 cast<CXXConstructorDecl>(GD.getDecl());
1326 CGF.CXXABIThisDecl = nullptr;
1327 CGF.CXXABIThisValue = nullptr;
1328 CGF.CXXThisValue = nullptr;
1329 CGF.CXXABIThisAlignment = CharUnits();
1330 CGF.CXXThisAlignment = CharUnits();
1331 CGF.ReturnValue = Address::invalid();
1332 CGF.FnRetTy = QualType();
1333 CGF.CXXInheritedCtorInitExprArgs.clear();
1334 }
1335 ~InlinedInheritingConstructorScope() {
1336 CGF.CurGD = OldCurGD;
1337 CGF.CurFuncDecl = OldCurFuncDecl;
1338 CGF.CurCodeDecl = OldCurCodeDecl;
1339 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1340 CGF.CXXABIThisValue = OldCXXABIThisValue;
1341 CGF.CXXThisValue = OldCXXThisValue;
1342 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1343 CGF.CXXThisAlignment = OldCXXThisAlignment;
1344 CGF.ReturnValue = OldReturnValue;
1345 CGF.FnRetTy = OldFnRetTy;
1346 CGF.CXXInheritedCtorInitExprArgs =
1347 std::move(OldCXXInheritedCtorInitExprArgs);
1348 }
1349
1350 private:
1351 CodeGenFunction &CGF;
1352 GlobalDecl OldCurGD;
1353 const Decl *OldCurFuncDecl;
1354 const Decl *OldCurCodeDecl;
1355 ImplicitParamDecl *OldCXXABIThisDecl;
1356 llvm::Value *OldCXXABIThisValue;
1357 llvm::Value *OldCXXThisValue;
1358 CharUnits OldCXXABIThisAlignment;
1359 CharUnits OldCXXThisAlignment;
1360 Address OldReturnValue;
1361 QualType OldFnRetTy;
1362 CallArgList OldCXXInheritedCtorInitExprArgs;
1363 };
1364
Richard Smith852c9db2013-04-20 22:23:05 +00001365private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001366 /// CXXThisDecl - When generating code for a C++ member function,
1367 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001368 ImplicitParamDecl *CXXABIThisDecl;
1369 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001370 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001371 CharUnits CXXABIThisAlignment;
1372 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001373
Richard Smith852c9db2013-04-20 22:23:05 +00001374 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1375 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001376 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001377
Richard Smith410306b2016-12-12 02:53:20 +00001378 /// The current array initialization index when evaluating an
1379 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1380 llvm::Value *ArrayInitIndex = nullptr;
1381
Richard Smith5179eb72016-06-28 19:03:57 +00001382 /// The values of function arguments to use when evaluating
1383 /// CXXInheritedCtorInitExprs within this context.
1384 CallArgList CXXInheritedCtorInitExprArgs;
1385
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001386 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1387 /// destructor, this will hold the implicit argument (e.g. VTT).
1388 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1389 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001390
John McCallce1de612011-01-26 04:00:11 +00001391 /// OutermostConditional - Points to the outermost active
1392 /// conditional control. This is used so that we know if a
1393 /// temporary should be destroyed conditionally.
1394 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001395
Nadav Rotem1da30942013-03-23 06:43:35 +00001396 /// The current lexical scope.
1397 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001398
Adrian Prantldc237b52013-05-16 00:41:26 +00001399 /// The current source location that should be used for exception
1400 /// handling code.
1401 SourceLocation CurEHLocation;
1402
John McCall7f416cc2015-09-08 08:05:57 +00001403 /// BlockByrefInfos - For each __block variable, contains
1404 /// information about the layout of the variable.
1405 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001406
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001407 /// Used by -fsanitize=nullability-return to determine whether the return
1408 /// value can be checked.
1409 llvm::Value *RetValNullabilityPrecondition = nullptr;
1410
1411 /// Check if -fsanitize=nullability-return instrumentation is required for
1412 /// this function.
1413 bool requiresReturnValueNullabilityCheck() const {
1414 return RetValNullabilityPrecondition;
1415 }
1416
Vedant Kumarc34d3432017-06-23 21:32:38 +00001417 /// Used to store precise source locations for return statements by the
1418 /// runtime return value checks.
1419 Address ReturnLocation = Address::invalid();
1420
1421 /// Check if the return value of this function requires sanitization.
1422 bool requiresReturnValueCheck() const {
1423 return requiresReturnValueNullabilityCheck() ||
1424 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
1425 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
1426 }
1427
John McCallbd309292010-07-06 01:34:17 +00001428 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001429 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001430 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001431
Vitaly Buka1c943322016-10-26 01:59:57 +00001432 /// True if we need emit the life-time markers.
1433 const bool ShouldEmitLifetimeMarkers;
1434
Xiuli Panbe6da4b2017-05-04 07:31:20 +00001435 /// Add OpenCL kernel arg metadata and the kernel attribute meatadata to
1436 /// the function metadata.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001437 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1438 llvm::Function *Fn);
1439
Chris Lattnerbed31442007-05-28 01:07:47 +00001440public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001441 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001442 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001443
John McCall8ed55a52010-09-02 09:58:18 +00001444 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001445 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001446 CGDebugInfo *getDebugInfo() {
1447 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001448 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001449 return DebugInfo;
1450 }
1451 void disableDebugInfo() { DisableDebugInfo = true; }
1452 void enableDebugInfo() { DisableDebugInfo = false; }
1453
John McCall31168b02011-06-15 23:02:42 +00001454 bool shouldUseFusedARCCalls() {
1455 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1456 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001457
David Blaikiebbafb8a2012-03-11 07:00:24 +00001458 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001459
Bill Wendlingf0724e82011-09-19 20:31:14 +00001460 /// Returns a pointer to the function's exception object and selector slot,
1461 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001462 Address getExceptionSlot();
1463 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001464
Bill Wendling79a70e42011-09-15 18:57:19 +00001465 /// Returns the contents of the function's exception object and selector
1466 /// slots.
1467 llvm::Value *getExceptionFromSlot();
1468 llvm::Value *getSelectorFromSlot();
1469
John McCall7f416cc2015-09-08 08:05:57 +00001470 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001471
John McCallbd309292010-07-06 01:34:17 +00001472 llvm::BasicBlock *getUnreachableBlock() {
1473 if (!UnreachableBlock) {
1474 UnreachableBlock = createBasicBlock("unreachable");
1475 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1476 }
1477 return UnreachableBlock;
1478 }
1479
1480 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001481 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001482 return getInvokeDestImpl();
1483 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001484
David Majnemer25eb1652016-03-01 19:42:53 +00001485 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001486
John McCallc8e01702013-04-16 22:48:15 +00001487 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001488 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Yaxun Liucbf647c2017-07-08 13:24:52 +00001489 const TargetCodeGenInfo &getTargetHooks() const {
1490 return CGM.getTargetCodeGenInfo();
1491 }
Owen Andersonae86c192009-07-13 04:10:07 +00001492
Daniel Dunbar12347492009-02-23 17:26:39 +00001493 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001494 // Cleanups
1495 //===--------------------------------------------------------------------===//
1496
John McCall7f416cc2015-09-08 08:05:57 +00001497 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001498
John McCall178360e2011-07-11 08:38:19 +00001499 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001500 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001501 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001502 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001503 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001504 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1505 llvm::Value *arrayEnd,
1506 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001507 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001508 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001509
John McCall4bd0fb12011-07-12 16:41:08 +00001510 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001511 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001512 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001513 Address addr, QualType type);
1514 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001515 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001516 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001517 QualType type, Destroyer *destroyer,
1518 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001519 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1520 llvm::Value *CompletePtr,
1521 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001522 void pushStackRestore(CleanupKind kind, Address SPMem);
1523 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001524 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001525 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001526 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001527 bool useEHCleanupForArray,
1528 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001529 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001530 QualType elementType, CharUnits elementAlign,
1531 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001532 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001533
Peter Collingbourne1425b452012-01-26 03:33:36 +00001534 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001535
John McCall82fe67b2011-07-09 01:37:26 +00001536 /// Determines whether an EH cleanup is required to destroy a type
1537 /// with the given destruction kind.
1538 bool needsEHCleanup(QualType::DestructionKind kind) {
1539 switch (kind) {
1540 case QualType::DK_none:
1541 return false;
1542 case QualType::DK_cxx_destructor:
1543 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001544 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001545 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001546 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001547 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1548 }
1549 llvm_unreachable("bad destruction kind");
1550 }
1551
John McCall4bd0fb12011-07-12 16:41:08 +00001552 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1553 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1554 }
1555
John McCall82fe67b2011-07-09 01:37:26 +00001556 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001557 // Objective-C
1558 //===--------------------------------------------------------------------===//
1559
Chris Lattner4bd55962008-03-30 23:03:07 +00001560 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001561
David Blaikief1425802015-01-14 00:04:42 +00001562 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001563
Mike Stumpfc496822009-02-08 23:14:22 +00001564 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001565 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1566 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001567 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001568 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001569 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001570 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001571
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001572 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1573 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001574
Mike Stumpfc496822009-02-08 23:14:22 +00001575 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1576 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001577 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1578 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001579 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001580 const ObjCPropertyImplDecl *propImpl,
1581 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001582
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001583 //===--------------------------------------------------------------------===//
1584 // Block Bits
1585 //===--------------------------------------------------------------------===//
1586
Yaxun Liuc2a87a02017-10-14 12:23:50 +00001587 /// Emit block literal.
1588 /// \return an LLVM value which is a pointer to a struct which contains
1589 /// information about the block, including the block invoke function, the
1590 /// captured variables, etc.
1591 /// \param InvokeF will contain the block invoke function if it is not
1592 /// nullptr.
1593 llvm::Value *EmitBlockLiteral(const BlockExpr *,
1594 llvm::Function **InvokeF = nullptr);
John McCall08ef4662011-11-10 08:15:53 +00001595 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001596
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001597 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001598 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001599 const DeclMapTy &ldm,
Akira Hatanakaba0367a2017-09-22 21:32:06 +00001600 bool IsLambdaConversionToBlock,
1601 bool BuildGlobalBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001602
John McCallad7c5c12011-02-08 08:22:06 +00001603 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1604 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001605 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1606 const ObjCPropertyImplDecl *PID);
1607 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1608 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001609 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001610
John McCallad7c5c12011-02-08 08:22:06 +00001611 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1612
John McCall73064872011-03-31 01:59:53 +00001613 class AutoVarEmission;
1614
1615 void emitByrefStructureInit(const AutoVarEmission &emission);
1616 void enterByrefCleanup(const AutoVarEmission &emission);
1617
John McCall7f416cc2015-09-08 08:05:57 +00001618 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1619 llvm::Value *ptr);
1620
1621 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001622 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1623
1624 /// BuildBlockByrefAddress - Computes the location of the
1625 /// data in a variable which is declared as __block.
1626 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1627 bool followForward = true);
1628 Address emitBlockByrefAddress(Address baseAddr,
1629 const BlockByrefInfo &info,
1630 bool followForward,
1631 const llvm::Twine &name);
1632
1633 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001634
Richard Smith5179eb72016-06-28 19:03:57 +00001635 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1636
John McCalla738c252011-03-09 04:27:21 +00001637 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1638 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001639 /// \brief Emit code for the start of a function.
1640 /// \param Loc The location to be associated with the function.
1641 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001642 void StartFunction(GlobalDecl GD,
1643 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001644 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001645 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001646 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001647 SourceLocation Loc = SourceLocation(),
1648 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001649
Vedant Kumar7f809b22017-02-24 01:15:19 +00001650 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1651
John McCallb81884d2010-02-19 09:25:03 +00001652 void EmitConstructorBody(FunctionArgList &Args);
1653 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001654 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001655 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001656 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001657
Faisal Vali571df122013-09-29 08:45:24 +00001658 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001659 CallArgList &CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00001660 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001661 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001662 void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001663 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001664
David Blaikiea0a1a872015-01-18 02:48:07 +00001665 /// \brief Emit the unified return block, trying to avoid its emission when
1666 /// possible.
1667 /// \return The debug location of the user written return statement if the
1668 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001669 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001670
Mike Stumpfc496822009-02-08 23:14:22 +00001671 /// FinishFunction - Complete IR generation of the current function. It is
1672 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001673 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001674
Nico Weber1bebad12015-02-11 22:33:32 +00001675 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1676 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001677
John McCallb92ab1a2016-10-26 23:46:34 +00001678 void EmitCallAndReturnForThunk(llvm::Constant *Callee,
1679 const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001680
John McCall7f416cc2015-09-08 08:05:57 +00001681 void FinishThunk();
1682
Reid Klecknerab2090d2014-07-26 01:34:32 +00001683 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1684 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1685 llvm::Value *Callee);
1686
Rafael Espindolad6e66942015-07-13 06:07:58 +00001687 /// Generate a thunk for the given method.
1688 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001689 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001690
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001691 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1692 const CGFunctionInfo &FnInfo,
1693 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001694
Douglas Gregor94f9a482010-05-05 05:51:00 +00001695 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1696 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001697
Richard Smith30e304e2016-12-14 00:03:17 +00001698 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001699
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001700 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1701 struct VPtr {
1702 BaseSubobject Base;
1703 const CXXRecordDecl *NearestVBase;
1704 CharUnits OffsetFromNearestVBase;
1705 const CXXRecordDecl *VTableClass;
1706 };
1707
1708 /// Initialize the vtable pointer of the given subobject.
1709 void InitializeVTablePointer(const VPtr &vptr);
1710
1711 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001712
1713 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001714 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1715
1716 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1717 CharUnits OffsetFromNearestVBase,
1718 bool BaseIsNonVirtualPrimaryBase,
1719 const CXXRecordDecl *VTableClass,
1720 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001721
Anders Carlssond5895932010-03-28 21:07:49 +00001722 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001723
Dan Gohman8fc50c22010-10-26 18:44:08 +00001724 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1725 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001726 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1727 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001728
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001729 enum CFITypeCheckKind {
1730 CFITCK_VCall,
1731 CFITCK_NVCall,
1732 CFITCK_DerivedCast,
1733 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001734 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001735 };
1736
Peter Collingbourned2926c92015-03-14 02:42:25 +00001737 /// \brief Derived is the presumed address of an object of type T after a
1738 /// cast. If T is a polymorphic class type, emit a check that the virtual
1739 /// table for Derived belongs to a class derived from T.
1740 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001741 bool MayBeNull, CFITypeCheckKind TCK,
1742 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001743
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001744 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1745 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001746 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001747 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001748
Peter Collingbourned2926c92015-03-14 02:42:25 +00001749 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001750 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001751 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1752 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001753
Peter Collingbournefb532b92016-02-24 20:46:36 +00001754 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001755 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1756 /// enabled, emit a check that VTable is a member of RD's type identifier.
1757 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1758 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001759
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001760 /// Returns whether we should perform a type checked load when loading a
1761 /// virtual function for virtual calls to members of RD. This is generally
1762 /// true when both vcall CFI and whole-program-vtables are enabled.
1763 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1764
1765 /// Emit a type checked load from the given vtable.
1766 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1767 uint64_t VTableByteOffset);
1768
John McCallf99a6312010-07-21 05:30:47 +00001769 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1770 /// given phase of destruction for a destructor. The end result
1771 /// should call destructors on members and base classes in reverse
1772 /// order of their construction.
1773 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001774
Chris Lattner3c77a352010-06-22 00:03:40 +00001775 /// ShouldInstrumentFunction - Return true if the current function should be
1776 /// instrumented with __cyg_profile_func_* calls
1777 bool ShouldInstrumentFunction();
1778
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001779 /// ShouldXRayInstrument - Return true if the current function should be
1780 /// instrumented with XRay nop sleds.
1781 bool ShouldXRayInstrumentFunction() const;
1782
Chris Lattner3c77a352010-06-22 00:03:40 +00001783 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1784 /// instrumentation function with the current function and the call site, if
1785 /// function instrumentation is enabled.
1786 void EmitFunctionInstrumentation(const char *Fn);
1787
Roman Divacky178e01602011-02-10 16:52:03 +00001788 /// EmitMCountInstrumentation - Emit call to .mcount.
1789 void EmitMCountInstrumentation();
1790
Vedant Kumarbb5d4852017-09-13 00:04:35 +00001791 /// Encode an address into a form suitable for use in a function prologue.
1792 llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
1793 llvm::Constant *Addr);
1794
1795 /// Decode an address used in a function prologue, encoded by \c
1796 /// EncodeAddrForUseInPrologue.
1797 llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
1798 llvm::Value *EncodedAddr);
1799
Mike Stumpfc496822009-02-08 23:14:22 +00001800 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1801 /// arguments for the given function. This is also responsible for naming the
1802 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001803 void EmitFunctionProlog(const CGFunctionInfo &FI,
1804 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001805 const FunctionArgList &Args);
1806
Mike Stumpfc496822009-02-08 23:14:22 +00001807 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1808 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001809 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1810 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001811
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001812 /// Emit a test that checks if the return value \p RV is nonnull.
Vedant Kumarc34d3432017-06-23 21:32:38 +00001813 void EmitReturnValueCheck(llvm::Value *RV);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001814
Mike Stump1d849212009-12-07 23:38:24 +00001815 /// EmitStartEHSpec - Emit the start of the exception spec.
1816 void EmitStartEHSpec(const Decl *D);
1817
1818 /// EmitEndEHSpec - Emit the end of the exception spec.
1819 void EmitEndEHSpec(const Decl *D);
1820
John McCallbd309292010-07-06 01:34:17 +00001821 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1822 llvm::BasicBlock *getTerminateLandingPad();
1823
1824 /// getTerminateHandler - Return a handler (not a landing pad, just
1825 /// a catch handler) that just calls terminate. This is used when
1826 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001827 llvm::BasicBlock *getTerminateHandler();
1828
Chris Lattnera5f58b02011-07-09 17:41:47 +00001829 llvm::Type *ConvertTypeForMem(QualType T);
1830 llvm::Type *ConvertType(QualType T);
1831 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001832 return ConvertType(getContext().getTypeDeclType(T));
1833 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001834
Mike Stumpfc496822009-02-08 23:14:22 +00001835 /// LoadObjCSelf - Load the value of self. This function is only valid while
1836 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001837 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001838
1839 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001840 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001841
Krasimir Georgiev46dfb7a2017-09-08 13:44:51 +00001842 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
John McCall47fb9502013-03-07 21:37:08 +00001843 static TypeEvaluationKind getEvaluationKind(QualType T);
1844
1845 static bool hasScalarEvaluationKind(QualType T) {
1846 return getEvaluationKind(T) == TEK_Scalar;
1847 }
1848
1849 static bool hasAggregateEvaluationKind(QualType T) {
1850 return getEvaluationKind(T) == TEK_Aggregate;
1851 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001852
1853 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001854 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001855 llvm::Function *parent = nullptr,
1856 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001857#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001858 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001859#else
John McCallad7c5c12011-02-08 08:22:06 +00001860 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001861#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001862 }
Mike Stumpfc496822009-02-08 23:14:22 +00001863
Chris Lattnerac248202007-05-30 00:13:02 +00001864 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1865 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001866 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001867
Mike Stumpe5311b02009-11-30 20:08:49 +00001868 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1869 /// another basic block, simplify it. This assumes that no other code could
1870 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001871 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1872
Mike Stumpfc496822009-02-08 23:14:22 +00001873 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1874 /// adding a fall-through branch from the current insert block if
1875 /// necessary. It is legal to call this function even if there is no current
1876 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001877 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001878 /// IsFinished - If true, indicates that the caller has finished emitting
1879 /// branches to the given block and does not expect to emit code into it. This
1880 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001881 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001882
John McCall8e4c74b2011-08-11 02:22:43 +00001883 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1884 /// near its uses, and leave the insertion point in it.
1885 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1886
Mike Stumpfc496822009-02-08 23:14:22 +00001887 /// EmitBranch - Emit a branch to the specified basic block from the current
1888 /// insert block, taking care to avoid creation of branches from dummy
1889 /// blocks. It is legal to call this function even if there is no current
1890 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001891 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001892 /// This function clears the current insertion point. The caller should follow
1893 /// calls to this function with calls to Emit*Block prior to generation new
1894 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001895 void EmitBranch(llvm::BasicBlock *Block);
1896
Mike Stumpfc496822009-02-08 23:14:22 +00001897 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1898 /// indicates that the current code being emitted is unreachable.
1899 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001900 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001901 }
1902
Mike Stumpfc496822009-02-08 23:14:22 +00001903 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1904 /// emitted IR has a place to go. Note that by definition, if this function
1905 /// creates a block then that block is unreachable; callers may do better to
1906 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001907 void EnsureInsertPoint() {
1908 if (!HaveInsertPoint())
1909 EmitBlock(createBasicBlock());
1910 }
Mike Stumpfc496822009-02-08 23:14:22 +00001911
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001912 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001913 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001914 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001915
Chris Lattnere9a64532007-06-22 21:44:33 +00001916 //===--------------------------------------------------------------------===//
1917 // Helpers
1918 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001919
John McCall7f416cc2015-09-08 08:05:57 +00001920 LValue MakeAddrLValue(Address Addr, QualType T,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001921 AlignmentSource Source = AlignmentSource::Type) {
1922 return LValue::MakeAddr(Addr, T, getContext(),
1923 LValueBaseInfo(Source, false),
1924 CGM.getTBAAAccessInfo(T));
1925 }
1926
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001927 LValue MakeAddrLValue(Address Addr, QualType T, LValueBaseInfo BaseInfo,
1928 TBAAAccessInfo TBAAInfo) {
1929 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001930 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001931
John McCall7f416cc2015-09-08 08:05:57 +00001932 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00001933 AlignmentSource Source = AlignmentSource::Type) {
1934 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1935 LValueBaseInfo(Source, false),
1936 CGM.getTBAAAccessInfo(T));
1937 }
1938
1939 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001940 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00001941 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00001942 BaseInfo, TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +00001943 }
1944
1945 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001946 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001947 CharUnits getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001948 LValueBaseInfo *BaseInfo = nullptr,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +00001949 TBAAAccessInfo *TBAAInfo = nullptr,
John McCall7f416cc2015-09-08 08:05:57 +00001950 bool forPointeeType = false);
1951 CharUnits getNaturalPointeeTypeAlignment(QualType T,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00001952 LValueBaseInfo *BaseInfo = nullptr,
1953 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001954
Ivan A. Kosarev9f9d1572017-10-30 11:49:31 +00001955 Address EmitLoadOfReference(LValue RefLVal,
1956 LValueBaseInfo *PointeeBaseInfo = nullptr,
1957 TBAAAccessInfo *PointeeTBAAInfo = nullptr);
1958 LValue EmitLoadOfReferenceLValue(LValue RefLVal);
1959 LValue EmitLoadOfReferenceLValue(Address RefAddr, QualType RefTy,
1960 AlignmentSource Source =
1961 AlignmentSource::Type) {
1962 LValue RefLVal = MakeAddrLValue(RefAddr, RefTy, LValueBaseInfo(Source),
1963 CGM.getTBAAAccessInfo(RefTy));
1964 return EmitLoadOfReferenceLValue(RefLVal);
1965 }
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001966
Alexey Bataev31300ed2016-02-04 11:27:03 +00001967 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
Ivan A. Kosarev90295642017-10-13 16:47:22 +00001968 LValueBaseInfo *BaseInfo = nullptr,
1969 TBAAAccessInfo *TBAAInfo = nullptr);
Alexey Bataev31300ed2016-02-04 11:27:03 +00001970 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1971
Yaxun Liu84744c12017-06-19 17:03:41 +00001972 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
1973 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
1974 /// insertion point of the builder. The caller is responsible for setting an
1975 /// appropriate alignment on
Daniel Dunbara7566f12010-02-09 02:48:28 +00001976 /// the alloca.
Yaxun Liu84744c12017-06-19 17:03:41 +00001977 ///
1978 /// \p ArraySize is the number of array elements to be allocated if it
1979 /// is not nullptr.
1980 ///
1981 /// LangAS::Default is the address space of pointers to local variables and
1982 /// temporaries, as exposed in the source language. In certain
1983 /// configurations, this is not the same as the alloca address space, and a
1984 /// cast is needed to lift the pointer from the alloca AS into
1985 /// LangAS::Default. This can happen when the target uses a restricted
1986 /// address space for the stack but the source language requires
1987 /// LangAS::Default to be a generic address space. The latter condition is
1988 /// common for most programming languages; OpenCL is an exception in that
1989 /// LangAS::Default is the private address space, which naturally maps
1990 /// to the stack.
1991 ///
1992 /// Because the address of a temporary is often exposed to the program in
1993 /// various ways, this function will perform the cast by default. The cast
1994 /// may be avoided by passing false as \p CastToDefaultAddrSpace; this is
1995 /// more efficient if the caller knows that the address will not be exposed.
1996 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
1997 llvm::Value *ArraySize = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001998 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
Yaxun Liu84744c12017-06-19 17:03:41 +00001999 const Twine &Name = "tmp",
2000 llvm::Value *ArraySize = nullptr,
2001 bool CastToDefaultAddrSpace = true);
Mike Stumpfc496822009-02-08 23:14:22 +00002002
John McCall7f416cc2015-09-08 08:05:57 +00002003 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
2004 /// default ABI alignment of the given LLVM type.
2005 ///
2006 /// IMPORTANT NOTE: This is *not* generally the right alignment for
2007 /// any given AST type that happens to have been lowered to the
2008 /// given IR type. This should only ever be used for function-local,
2009 /// IR-driven manipulations like saving and restoring a value. Do
2010 /// not hand this address off to arbitrary IRGen routines, and especially
2011 /// do not pass it as an argument to a function that might expect a
2012 /// properly ABI-aligned value.
2013 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
2014 const Twine &Name = "tmp");
2015
2016 /// InitTempAlloca - Provide an initial value for the given alloca which
2017 /// will be observable at all locations in the function.
2018 ///
2019 /// The address should be something that was returned from one of
2020 /// the CreateTempAlloca or CreateMemTemp routines, and the
2021 /// initializer must be valid in the entry block (i.e. it must
2022 /// either be a constant or an argument value).
2023 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00002024
Daniel Dunbard0049182010-02-16 19:44:13 +00002025 /// CreateIRTemp - Create a temporary IR object of the given type, with
2026 /// appropriate alignment. This routine should only be used when an temporary
2027 /// value needs to be stored into an alloca (for example, to avoid explicit
2028 /// PHI construction), but the type is the IR type, not the type appropriate
2029 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00002030 ///
2031 /// That is, this is exactly equivalent to CreateMemTemp, but calling
2032 /// ConvertType instead of ConvertTypeForMem.
2033 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00002034
Daniel Dunbara7566f12010-02-09 02:48:28 +00002035 /// CreateMemTemp - Create a temporary memory object of the given type, with
Yaxun Liu84744c12017-06-19 17:03:41 +00002036 /// appropriate alignment. Cast it to the default address space if
2037 /// \p CastToDefaultAddrSpace is true.
2038 Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
2039 bool CastToDefaultAddrSpace = true);
2040 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
2041 bool CastToDefaultAddrSpace = true);
Daniel Dunbara7566f12010-02-09 02:48:28 +00002042
John McCall7a626f62010-09-15 10:14:12 +00002043 /// CreateAggTemp - Create a temporary memory object for the given
2044 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00002045 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00002046 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00002047 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00002048 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00002049 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002050 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00002051 }
2052
John McCallad7c5c12011-02-08 08:22:06 +00002053 /// Emit a cast to void* in the appropriate address space.
2054 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2055
Chris Lattner8394d792007-06-05 20:53:16 +00002056 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2057 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00002058 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00002059
John McCalla2342eb2010-12-05 02:00:02 +00002060 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2061 void EmitIgnoredExpr(const Expr *E);
2062
Chris Lattner4647a212007-08-31 22:49:20 +00002063 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2064 /// any type. The result is returned as an RValue struct. If this is an
2065 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2066 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00002067 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00002068 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00002069 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00002070 AggValueSlot aggSlot = AggValueSlot::ignored(),
2071 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00002072
Mike Stumpfc496822009-02-08 23:14:22 +00002073 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2074 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00002075 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002076
Charles Davisc7d5c942015-09-17 20:55:33 +00002077 /// Emit a "reference" to a __builtin_ms_va_list; this is
2078 /// always the value of the expression, because a __builtin_ms_va_list is a
2079 /// pointer to a char.
2080 Address EmitMSVAListRef(const Expr *E);
2081
Gor Nishanov5eb58582017-03-26 02:18:05 +00002082 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
Mike Stumpfc496822009-02-08 23:14:22 +00002083 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00002084 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00002085
John McCall91ca10f2011-03-08 09:11:50 +00002086 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00002087 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00002088 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002089 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00002090
John McCall7f416cc2015-09-08 08:05:57 +00002091 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00002092
John McCall91ca10f2011-03-08 09:11:50 +00002093 /// EmitExprAsInit - Emits the code necessary to initialize a
2094 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00002095 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002096 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00002097
Fariborz Jahanian78652202013-01-25 23:57:05 +00002098 /// hasVolatileMember - returns true if aggregate type has a volatile
2099 /// member.
2100 bool hasVolatileMember(QualType T) {
2101 if (const RecordType *RT = T->getAs<RecordType>()) {
2102 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2103 return RD->hasVolatileMember();
2104 }
2105 return false;
2106 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002107 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002108 ///
2109 /// The difference to EmitAggregateCopy is that tail padding is not copied.
2110 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00002111 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00002112 QualType EltTy) {
2113 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00002114 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002115 }
2116
John McCall7f416cc2015-09-08 08:05:57 +00002117 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
2118 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00002119 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00002120 /*IsAssignment=*/false);
2121 }
2122
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002123 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00002124 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00002125 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00002126 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002127 /// \param isAssignment - If false, allow padding to be copied. This often
2128 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00002129 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00002130 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002131 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00002132
Anders Carlsson9396a892008-09-11 09:15:33 +00002133 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00002134 Address GetAddrOfLocalVar(const VarDecl *VD) {
2135 auto it = LocalDeclMap.find(VD);
2136 assert(it != LocalDeclMap.end() &&
2137 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2138 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00002139 }
Mike Stumpfc496822009-02-08 23:14:22 +00002140
John McCallc07a0c72011-02-17 10:25:35 +00002141 /// getOpaqueLValueMapping - Given an opaque value expression (which
2142 /// must be mapped to an l-value), return its mapping.
2143 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
2144 assert(OpaqueValueMapping::shouldBindAsLValue(e));
2145
2146 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
2147 it = OpaqueLValues.find(e);
2148 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
2149 return it->second;
2150 }
2151
2152 /// getOpaqueRValueMapping - Given an opaque value expression (which
2153 /// must be mapped to an r-value), return its mapping.
2154 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
2155 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
2156
2157 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
2158 it = OpaqueRValues.find(e);
2159 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00002160 return it->second;
2161 }
2162
Richard Smith410306b2016-12-12 02:53:20 +00002163 /// Get the index of the current ArrayInitLoopExpr, if any.
2164 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2165
Dan Gohman75d69da2008-05-22 00:50:06 +00002166 /// getAccessedFieldNo - Given an encoded value and a result number, return
2167 /// the input field number being accessed.
2168 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2169
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002170 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002171 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002172
Vedant Kumarffd7c882017-04-14 22:03:34 +00002173 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2174 static bool IsWrappedCXXThis(const Expr *E);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00002175
Anders Carlssonc0964b62010-05-22 17:35:42 +00002176 /// EmitNullInitialization - Generate code to set a value of the given type to
2177 /// null, If the type contains data member pointers, they will be initialized
2178 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002179 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002180
Charles Davisc7d5c942015-09-17 20:55:33 +00002181 /// Emits a call to an LLVM variable-argument intrinsic, either
2182 /// \c llvm.va_start or \c llvm.va_end.
2183 /// \param ArgValue A reference to the \c va_list as emitted by either
2184 /// \c EmitVAListRef or \c EmitMSVAListRef.
2185 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2186 /// calls \c llvm.va_end.
2187 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2188
2189 /// Generate code to get an argument from the passed in pointer
2190 /// and update it accordingly.
2191 /// \param VE The \c VAArgExpr for which to generate code.
2192 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2193 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2194 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002195 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002196 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002197 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002198
John McCall82fe67b2011-07-09 01:37:26 +00002199 /// emitArrayLength - Compute the length of an array, even if it's a
2200 /// VLA, and drill down to the base element type.
2201 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2202 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002203 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002204
John McCall23c29fe2011-06-24 21:55:10 +00002205 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2206 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002207 ///
2208 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002209 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002210
John McCall23c29fe2011-06-24 21:55:10 +00002211 /// getVLASize - Returns an LLVM value that corresponds to the size,
2212 /// in non-variably-sized elements, of a variable length array type,
2213 /// plus that largest non-variably-sized element type. Assumes that
2214 /// the type has already been emitted with EmitVariablyModifiedType.
2215 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
2216 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002217
Anders Carlssona5d077d2009-04-14 16:58:56 +00002218 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2219 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002220 llvm::Value *LoadCXXThis() {
2221 assert(CXXThisValue && "no 'this' value for this function");
2222 return CXXThisValue;
2223 }
John McCall7f416cc2015-09-08 08:05:57 +00002224 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002225
Anders Carlssone36a6b32010-01-02 01:01:18 +00002226 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2227 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002228 // FIXME: Every place that calls LoadCXXVTT is something
2229 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002230 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002231 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2232 return CXXStructorImplicitParamValue;
2233 }
2234
John McCall6ce74722010-02-16 04:15:37 +00002235 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002236 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002237 Address
2238 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002239 const CXXRecordDecl *Derived,
2240 const CXXRecordDecl *Base,
2241 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002242
John McCall7f416cc2015-09-08 08:05:57 +00002243 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2244
Mike Stumpe5311b02009-11-30 20:08:49 +00002245 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2246 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002247 Address GetAddressOfBaseClass(Address Value,
2248 const CXXRecordDecl *Derived,
2249 CastExpr::path_const_iterator PathBegin,
2250 CastExpr::path_const_iterator PathEnd,
2251 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002252
John McCall7f416cc2015-09-08 08:05:57 +00002253 Address GetAddressOfDerivedClass(Address Value,
2254 const CXXRecordDecl *Derived,
2255 CastExpr::path_const_iterator PathBegin,
2256 CastExpr::path_const_iterator PathEnd,
2257 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002258
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002259 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2260 /// base constructor/destructor with virtual bases.
2261 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2262 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2263 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2264 bool Delegating);
2265
John McCallf8ff7b92010-02-23 00:48:20 +00002266 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2267 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002268 const FunctionArgList &Args,
2269 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002270 // It's important not to confuse this and the previous function. Delegating
2271 // constructors are the C++0x feature. The constructor delegate optimization
2272 // is used to reduce duplication in the base and complete consturctors where
2273 // they are substantially the same.
2274 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2275 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002276
Richard Smith5179eb72016-06-28 19:03:57 +00002277 /// Emit a call to an inheriting constructor (that is, one that invokes a
2278 /// constructor inherited from a base class) by inlining its definition. This
2279 /// is necessary if the ABI does not support forwarding the arguments to the
2280 /// base class constructor (because they're variadic or similar).
2281 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2282 CXXCtorType CtorType,
2283 bool ForVirtualBase,
2284 bool Delegating,
2285 CallArgList &Args);
2286
2287 /// Emit a call to a constructor inherited from a base class, passing the
2288 /// current constructor's arguments along unmodified (without even making
2289 /// a copy).
2290 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2291 bool ForVirtualBase, Address This,
2292 bool InheritedFromVBase,
2293 const CXXInheritedCtorInitExpr *E);
2294
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002295 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002296 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002297 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002298
Richard Smith5179eb72016-06-28 19:03:57 +00002299 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2300 bool ForVirtualBase, bool Delegating,
2301 Address This, CallArgList &Args);
2302
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002303 /// Emit assumption load for all bases. Requires to be be called only on
2304 /// most-derived class and not under construction of the object.
2305 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2306
2307 /// Emit assumption that vptr load == global vtable.
2308 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2309
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002310 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002311 Address This, Address Src,
2312 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002313
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002314 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002315 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002316 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002317 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002318 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002319
Anders Carlssond49844b2009-09-23 02:45:36 +00002320 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2321 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002322 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002323 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002324 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002325
John McCall82fe67b2011-07-09 01:37:26 +00002326 static Destroyer destroyCXXObject;
2327
Anders Carlsson0a637412009-05-29 21:03:38 +00002328 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002329 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002330 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002331
John McCall99210dc2011-09-15 06:49:18 +00002332 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002333 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002334 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002335 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002336
Peter Collingbourne702b2842011-11-27 22:09:22 +00002337 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002338 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002339
David Majnemerdc012fa2015-04-22 21:38:15 +00002340 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2341 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2342
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002343 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002344 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002345
Eli Friedman24f55432009-11-18 00:57:03 +00002346 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002347 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2348 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002349
Richard Smith760520b2014-06-03 23:27:44 +00002350 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2351 const Expr *Arg, bool IsDelete);
2352
John McCall7f416cc2015-09-08 08:05:57 +00002353 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2354 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2355 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002356
Richard Smith69d0d262012-08-24 00:54:33 +00002357 /// \brief Situations in which we might emit a check for the suitability of a
2358 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002359 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002360 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002361 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002362 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002363 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002364 /// Checking the bound value in a reference binding. Must be suitably sized
2365 /// and aligned, but is not required to refer to an object (until the
2366 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002367 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002368 /// Checking the object expression in a non-static data member access. Must
2369 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002370 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002371 /// Checking the 'this' pointer for a call to a non-static member function.
2372 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002373 TCK_MemberCall,
2374 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002375 TCK_ConstructorCall,
2376 /// Checking the operand of a static_cast to a derived pointer type. Must be
2377 /// null or an object within its lifetime.
2378 TCK_DowncastPointer,
2379 /// Checking the operand of a static_cast to a derived reference type. Must
2380 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002381 TCK_DowncastReference,
2382 /// Checking the operand of a cast to a base object. Must be suitably sized
2383 /// and aligned.
2384 TCK_Upcast,
2385 /// Checking the operand of a cast to a virtual base object. Must be an
2386 /// object within its lifetime.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002387 TCK_UpcastToVirtualBase,
2388 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
2389 TCK_NonnullAssign
Richard Smith69d0d262012-08-24 00:54:33 +00002390 };
2391
Vedant Kumar24792e32017-10-03 01:27:25 +00002392 /// Determine whether the pointer type check \p TCK permits null pointers.
2393 static bool isNullPointerAllowed(TypeCheckKind TCK);
2394
2395 /// Determine whether the pointer type check \p TCK requires a vptr check.
2396 static bool isVptrCheckRequired(TypeCheckKind TCK, QualType Ty);
2397
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002398 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2399 /// calls to EmitTypeCheck can be skipped.
2400 bool sanitizePerformTypeCheck() const;
2401
Richard Smith4d1458e2012-09-08 02:08:36 +00002402 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002403 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002404 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002405 QualType Type, CharUnits Alignment = CharUnits::Zero(),
Vedant Kumar18348ea2017-02-17 23:22:55 +00002406 SanitizerSet SkippedChecks = SanitizerSet());
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002407
Richard Smith539e4a72013-02-23 02:53:19 +00002408 /// \brief Emit a check that \p Base points into an array object, which
2409 /// we can access at index \p Index. \p Accessed should be \c false if we
2410 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2411 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2412 QualType IndexType, bool Accessed);
2413
Chris Lattner116ce8f2010-01-09 21:40:03 +00002414 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2415 bool isInc, bool isPre);
2416 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2417 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002418
2419 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002420 llvm::Value *OffsetValue = nullptr) {
2421 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2422 OffsetValue);
2423 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002424
Amara Emerson652795d2016-11-10 14:44:30 +00002425 /// Converts Location to a DebugLoc, if debug information is enabled.
2426 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2427
2428
Chris Lattner8394d792007-06-05 20:53:16 +00002429 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002430 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002431 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002432
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002433 /// EmitDecl - Emit a declaration.
2434 ///
2435 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002436 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002437
John McCall1c9c3fd2010-10-15 04:57:14 +00002438 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002439 ///
2440 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002441 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002442
David Blaikie73ca5692014-12-09 00:32:22 +00002443 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002444 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002445
John McCallbd309292010-07-06 01:34:17 +00002446 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2447 llvm::Value *Address);
2448
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002449 /// \brief Determine whether the given initializer is trivial in the sense
2450 /// that it requires no code to be generated.
2451 bool isTrivialInitializer(const Expr *Init);
2452
John McCall1c9c3fd2010-10-15 04:57:14 +00002453 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002454 ///
2455 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002456 void EmitAutoVarDecl(const VarDecl &D);
2457
2458 class AutoVarEmission {
2459 friend class CodeGenFunction;
2460
John McCall9e2e22f2011-02-22 07:16:58 +00002461 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002462
John McCall7f416cc2015-09-08 08:05:57 +00002463 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002464 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002465 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002466
2467 llvm::Value *NRVOFlag;
2468
2469 /// True if the variable is a __block variable.
2470 bool IsByRef;
2471
2472 /// True if the variable is of aggregate type and has a constant
2473 /// initializer.
2474 bool IsConstantAggregate;
2475
Nadav Rotem1da30942013-03-23 06:43:35 +00002476 /// Non-null if we should use lifetime annotations.
2477 llvm::Value *SizeForLifetimeMarkers;
2478
John McCall9e2e22f2011-02-22 07:16:58 +00002479 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002480 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002481
John McCallc533cb72011-02-22 06:44:22 +00002482 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002483 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002484 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002485 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002486
John McCall7f416cc2015-09-08 08:05:57 +00002487 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002488
2489 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002490 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2491
Craig Topper8a13c412014-05-21 05:09:00 +00002492 bool useLifetimeMarkers() const {
2493 return SizeForLifetimeMarkers != nullptr;
2494 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002495 llvm::Value *getSizeForLifetimeMarkers() const {
2496 assert(useLifetimeMarkers());
2497 return SizeForLifetimeMarkers;
2498 }
2499
2500 /// Returns the raw, allocated address, which is not necessarily
2501 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002502 Address getAllocatedAddress() const {
2503 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002504 }
2505
John McCallc533cb72011-02-22 06:44:22 +00002506 /// Returns the address of the object within this declaration.
2507 /// Note that this does not chase the forwarding pointer for
2508 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002509 Address getObjectAddress(CodeGenFunction &CGF) const {
2510 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002511
John McCall7f416cc2015-09-08 08:05:57 +00002512 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002513 }
2514 };
2515 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2516 void EmitAutoVarInit(const AutoVarEmission &emission);
2517 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002518 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2519 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002520
John McCall1c9c3fd2010-10-15 04:57:14 +00002521 void EmitStaticVarDecl(const VarDecl &D,
2522 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002523
John McCall7f416cc2015-09-08 08:05:57 +00002524 class ParamValue {
2525 llvm::Value *Value;
2526 unsigned Alignment;
2527 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2528 public:
2529 static ParamValue forDirect(llvm::Value *value) {
2530 return ParamValue(value, 0);
2531 }
2532 static ParamValue forIndirect(Address addr) {
2533 assert(!addr.getAlignment().isZero());
2534 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2535 }
2536
2537 bool isIndirect() const { return Alignment != 0; }
2538 llvm::Value *getAnyValue() const { return Value; }
2539
2540 llvm::Value *getDirectValue() const {
2541 assert(!isIndirect());
2542 return Value;
2543 }
2544
2545 Address getIndirectAddress() const {
2546 assert(isIndirect());
2547 return Address(Value, CharUnits::fromQuantity(Alignment));
2548 }
2549 };
2550
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002551 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002552 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002553
John McCallc07a0c72011-02-17 10:25:35 +00002554 /// protectFromPeepholes - Protect a value that we're intending to
2555 /// store to the side, but which will probably be used later, from
2556 /// aggressive peepholing optimizations that might delete it.
2557 ///
2558 /// Pass the result to unprotectFromPeepholes to declare that
2559 /// protection is no longer required.
2560 ///
2561 /// There's no particular reason why this shouldn't apply to
2562 /// l-values, it's just that no existing peepholes work on pointers.
2563 PeepholeProtection protectFromPeepholes(RValue rvalue);
2564 void unprotectFromPeepholes(PeepholeProtection protection);
2565
Erich Keane623efd82017-03-30 21:48:55 +00002566 void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment,
2567 llvm::Value *OffsetValue = nullptr) {
2568 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2569 OffsetValue);
2570 }
2571
Chris Lattner84915fa2007-06-02 04:16:21 +00002572 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002573 // Statement Emission
2574 //===--------------------------------------------------------------------===//
2575
Mike Stumpfc496822009-02-08 23:14:22 +00002576 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002577 void EmitStopPoint(const Stmt *S);
2578
Mike Stumpfc496822009-02-08 23:14:22 +00002579 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2580 /// this function even if there is no current insertion point.
2581 ///
2582 /// This function may clear the current insertion point; callers should use
2583 /// EnsureInsertPoint if they wish to subsequently generate code without first
2584 /// calling EmitBlock, EmitBranch, or EmitStmt.
Karl-Johan Karlsson33e205a2017-09-06 08:47:18 +00002585 void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002586
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002587 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002588 /// necessarily require an insertion point or debug information; typically
2589 /// because the statement amounts to a jump or a container of other
2590 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002591 ///
2592 /// \return True if the statement was handled.
2593 bool EmitSimpleStmt(const Stmt *S);
2594
John McCall7f416cc2015-09-08 08:05:57 +00002595 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2596 AggValueSlot AVS = AggValueSlot::ignored());
2597 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2598 bool GetLast = false,
2599 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002600 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002601
Mike Stumpfc496822009-02-08 23:14:22 +00002602 /// EmitLabel - Emit the block for the given label. It is legal to call this
2603 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002604 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002605
Chris Lattnerac248202007-05-30 00:13:02 +00002606 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002607 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002608 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002609 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002610 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002611
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002612 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002613 ArrayRef<const Attr *> Attrs = None);
2614 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002615 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002616 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002617 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002618 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002619 void EmitBreakStmt(const BreakStmt &S);
2620 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002621 void EmitSwitchStmt(const SwitchStmt &S);
2622 void EmitDefaultStmt(const DefaultStmt &S);
2623 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002624 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002625 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002626
Anders Carlsson2e744e82008-08-30 19:51:14 +00002627 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002628 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2629 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002630 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002631 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002632
Gor Nishanov8df64e92016-10-27 16:28:31 +00002633 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov90be1212017-03-06 21:12:54 +00002634 void EmitCoreturnStmt(const CoreturnStmt &S);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002635 RValue EmitCoawaitExpr(const CoawaitExpr &E,
2636 AggValueSlot aggSlot = AggValueSlot::ignored(),
2637 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002638 LValue EmitCoawaitLValue(const CoawaitExpr *E);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002639 RValue EmitCoyieldExpr(const CoyieldExpr &E,
2640 AggValueSlot aggSlot = AggValueSlot::ignored(),
2641 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002642 LValue EmitCoyieldLValue(const CoyieldExpr *E);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002643 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2644
John McCallb609d3f2010-07-07 06:56:46 +00002645 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2646 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002647
Anders Carlsson52d78a52009-09-27 18:58:34 +00002648 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002649 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002650 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002651 void EnterSEHTryStmt(const SEHTryStmt &S);
2652 void ExitSEHTryStmt(const SEHTryStmt &S);
2653
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002654 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002655 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002656
2657 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2658 const SEHExceptStmt &Except);
2659
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002660 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2661 const SEHFinallyStmt &Finally);
2662
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002663 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2664 llvm::Value *ParentFP,
2665 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002666 llvm::Value *EmitSEHExceptionCode();
2667 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002668 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002669
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002670 /// Scan the outlined statement for captures from the parent function. For
2671 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002672 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002673 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002674 bool IsFilter);
2675
2676 /// Recovers the address of a local in a parent function. ParentVar is the
2677 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002678 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002679 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2680 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002681 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2682 Address ParentVar,
2683 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002684
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002685 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002686 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002687
Alexey Bataev1189bd02016-01-26 12:20:39 +00002688 /// Returns calculated size of the specified type.
2689 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002690 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002691 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002692 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002693 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002694 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002695 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002696 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002697 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2698 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002699 /// \brief Perform element by element copying of arrays with type \a
2700 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2701 /// generated by \a CopyGen.
2702 ///
2703 /// \param DestAddr Address of the destination array.
2704 /// \param SrcAddr Address of the source array.
2705 /// \param OriginalType Type of destination and source arrays.
2706 /// \param CopyGen Copying procedure that copies value of single array element
2707 /// to another single array element.
2708 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002709 Address DestAddr, Address SrcAddr, QualType OriginalType,
2710 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002711 /// \brief Emit proper copying of data from one variable to another.
2712 ///
2713 /// \param OriginalType Original type of the copied variables.
2714 /// \param DestAddr Destination address.
2715 /// \param SrcAddr Source address.
2716 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2717 /// type of the base array element).
2718 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2719 /// the base array element).
2720 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2721 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002722 void EmitOMPCopy(QualType OriginalType,
2723 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002724 const VarDecl *DestVD, const VarDecl *SrcVD,
2725 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002726 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2727 /// \a X = \a E \a BO \a E.
2728 ///
2729 /// \param X Value to be updated.
2730 /// \param E Update value.
2731 /// \param BO Binary operation for update operation.
2732 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2733 /// expression, false otherwise.
2734 /// \param AO Atomic ordering of the generated atomic instructions.
2735 /// \param CommonGen Code generator for complex expressions that cannot be
2736 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002737 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2738 /// generated, <false, RValue::get(nullptr)> otherwise.
2739 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002740 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2741 llvm::AtomicOrdering AO, SourceLocation Loc,
2742 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002743 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002744 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002745 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2746 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002747 void EmitOMPUseDevicePtrClause(
2748 const OMPClause &C, OMPPrivateScope &PrivateScope,
2749 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002750 /// \brief Emit code for copyin clause in \a D directive. The next code is
2751 /// generated at the start of outlined functions for directives:
2752 /// \code
2753 /// threadprivate_var1 = master_threadprivate_var1;
2754 /// operator=(threadprivate_var2, master_threadprivate_var2);
2755 /// ...
2756 /// __kmpc_barrier(&loc, global_tid);
2757 /// \endcode
2758 ///
2759 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2760 /// \returns true if at least one copyin variable is found, false otherwise.
2761 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002762 /// \brief Emit initial code for lastprivate variables. If some variable is
2763 /// not also firstprivate, then the default initialization is used. Otherwise
2764 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2765 /// method.
2766 ///
2767 /// \param D Directive that may have 'lastprivate' directives.
2768 /// \param PrivateScope Private scope for capturing lastprivate variables for
2769 /// proper codegen in internal captured statement.
2770 ///
2771 /// \returns true if there is at least one lastprivate variable, false
2772 /// otherwise.
2773 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2774 OMPPrivateScope &PrivateScope);
2775 /// \brief Emit final copying of lastprivate values to original variables at
2776 /// the end of the worksharing or simd directive.
2777 ///
2778 /// \param D Directive that has at least one 'lastprivate' directives.
2779 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2780 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002781 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002782 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002783 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002784 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002785 /// Emit initial code for linear clauses.
2786 void EmitOMPLinearClause(const OMPLoopDirective &D,
2787 CodeGenFunction::OMPPrivateScope &PrivateScope);
2788 /// Emit final code for linear clauses.
2789 /// \param CondGen Optional conditional code for final part of codegen for
2790 /// linear clause.
2791 void EmitOMPLinearClauseFinal(
2792 const OMPLoopDirective &D,
2793 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002794 /// \brief Emit initial code for reduction variables. Creates reduction copies
2795 /// and initializes them with the values according to OpenMP standard.
2796 ///
2797 /// \param D Directive (possibly) with the 'reduction' clause.
2798 /// \param PrivateScope Private scope for capturing reduction variables for
2799 /// proper codegen in internal captured statement.
2800 ///
2801 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2802 OMPPrivateScope &PrivateScope);
2803 /// \brief Emit final update of reduction values to original variables at
2804 /// the end of the directive.
2805 ///
2806 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00002807 /// \param ReductionKind The kind of reduction to perform.
2808 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
2809 const OpenMPDirectiveKind ReductionKind);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002810 /// \brief Emit initial code for linear variables. Creates private copies
2811 /// and initializes them with the values according to OpenMP standard.
2812 ///
2813 /// \param D Directive (possibly) with the 'linear' clause.
Alexey Bataev8c3edfe2017-08-16 15:58:46 +00002814 /// \return true if at least one linear variable is found that should be
2815 /// initialized with the value of the original variable, false otherwise.
2816 bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002817
Alexey Bataev7292c292016-04-25 12:22:29 +00002818 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2819 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002820 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002821 TaskGenTy;
2822 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2823 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002824 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00002825
Alexey Bataev9959db52014-05-06 10:08:46 +00002826 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002827 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002828 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002829 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002830 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002831 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002832 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002833 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002834 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002835 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002836 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002837 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002838 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002839 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002840 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002841 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002842 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002843 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002844 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002845 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002846 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002847 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002848 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002849 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002850 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002851 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002852 void
2853 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002854 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002855 void
2856 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002857 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002858 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002859 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002860 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002861 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002862 void EmitOMPDistributeParallelForDirective(
2863 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002864 void EmitOMPDistributeParallelForSimdDirective(
2865 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002866 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002867 void EmitOMPTargetParallelForSimdDirective(
2868 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002869 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002870 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00002871 void
2872 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00002873 void EmitOMPTeamsDistributeParallelForSimdDirective(
2874 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00002875 void EmitOMPTeamsDistributeParallelForDirective(
2876 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00002877 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00002878 void EmitOMPTargetTeamsDistributeDirective(
2879 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00002880 void EmitOMPTargetTeamsDistributeParallelForDirective(
2881 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00002882 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
2883 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00002884 void EmitOMPTargetTeamsDistributeSimdDirective(
2885 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002886
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00002887 /// Emit device code for the target directive.
2888 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
2889 StringRef ParentName,
2890 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00002891 static void
2892 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2893 const OMPTargetParallelDirective &S);
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00002894 static void
2895 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2896 const OMPTargetTeamsDirective &S);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002897 /// \brief Emit inner loop of the worksharing/simd construct.
2898 ///
2899 /// \param S Directive, for which the inner loop must be emitted.
2900 /// \param RequiresCleanup true, if directive has some associated private
2901 /// variables.
2902 /// \param LoopCond Bollean condition for loop continuation.
2903 /// \param IncExpr Increment expression for loop control variable.
2904 /// \param BodyGen Generator for the inner body of the inner loop.
2905 /// \param PostIncGen Genrator for post-increment code (required for ordered
2906 /// loop directvies).
2907 void EmitOMPInnerLoop(
2908 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2909 const Expr *IncExpr,
2910 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2911 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002912
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002913 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002914 /// Emit initial code for loop counters of loop-based directives.
2915 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2916 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002917
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002918 /// Helper for the OpenMP loop directives.
2919 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
2920
2921 /// \brief Emit code for the worksharing loop-based directive.
2922 /// \return true, if this construct has any lastprivate clause, false -
2923 /// otherwise.
2924 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
2925 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
2926 const CodeGenDispatchBoundsTy &CGDispatchBounds);
2927
Alexey Bataevf47c4b42017-09-26 13:47:31 +00002928 /// Emits the lvalue for the expression with possibly captured variable.
2929 LValue EmitOMPSharedLValue(const Expr *E);
2930
Alexander Musmanc6388682014-12-15 07:07:06 +00002931private:
Yaxun Liuc2a87a02017-10-14 12:23:50 +00002932 /// Helpers for blocks. Returns invoke function by \p InvokeF if it is not
2933 /// nullptr. It should be called without \p InvokeF if the caller does not
2934 /// need invoke function to be returned.
2935 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info,
2936 llvm::Function **InvokeF = nullptr);
George Burgess IVe3763372016-12-22 02:50:20 +00002937
Alexander Musmanc6388682014-12-15 07:07:06 +00002938 /// Helpers for the OpenMP loop directives.
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002939 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002940 void EmitOMPSimdFinal(
2941 const OMPLoopDirective &D,
2942 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002943
2944 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
2945 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
2946
2947 /// struct with the values to be passed to the OpenMP loop-related functions
2948 struct OMPLoopArguments {
2949 /// loop lower bound
2950 Address LB = Address::invalid();
2951 /// loop upper bound
2952 Address UB = Address::invalid();
2953 /// loop stride
2954 Address ST = Address::invalid();
2955 /// isLastIteration argument for runtime functions
2956 Address IL = Address::invalid();
2957 /// Chunk value generated by sema
2958 llvm::Value *Chunk = nullptr;
2959 /// EnsureUpperBound
2960 Expr *EUB = nullptr;
2961 /// IncrementExpression
2962 Expr *IncExpr = nullptr;
2963 /// Loop initialization
2964 Expr *Init = nullptr;
2965 /// Loop exit condition
2966 Expr *Cond = nullptr;
2967 /// Update of LB after a whole chunk has been executed
2968 Expr *NextLB = nullptr;
2969 /// Update of UB after a whole chunk has been executed
2970 Expr *NextUB = nullptr;
2971 OMPLoopArguments() = default;
2972 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
2973 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
2974 Expr *IncExpr = nullptr, Expr *Init = nullptr,
2975 Expr *Cond = nullptr, Expr *NextLB = nullptr,
2976 Expr *NextUB = nullptr)
2977 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
2978 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
2979 NextUB(NextUB) {}
2980 };
2981 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
2982 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
2983 const OMPLoopArguments &LoopArgs,
2984 const CodeGenLoopTy &CodeGenLoop,
2985 const CodeGenOrderedTy &CodeGenOrdered);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00002986 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002987 bool IsMonotonic, const OMPLoopDirective &S,
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002988 OMPPrivateScope &LoopScope, bool Ordered,
2989 const OMPLoopArguments &LoopArgs,
2990 const CodeGenDispatchBoundsTy &CGDispatchBounds);
2991 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
2992 const OMPLoopDirective &S,
2993 OMPPrivateScope &LoopScope,
2994 const OMPLoopArguments &LoopArgs,
2995 const CodeGenLoopTy &CodeGenLoopContent);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002996 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002997 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002998
2999public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00003000
Chris Lattner208ae962007-05-30 17:57:17 +00003001 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00003002 // LValue Expression Emission
3003 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00003004
Daniel Dunbarc79407f2009-02-05 07:09:07 +00003005 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
3006 RValue GetUndefRValue(QualType Ty);
3007
Daniel Dunbarbb197e42009-01-09 16:50:52 +00003008 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
3009 /// and issue an ErrorUnsupported style diagnostic (using the
3010 /// provided Name).
3011 RValue EmitUnsupportedRValue(const Expr *E,
3012 const char *Name);
3013
Mike Stumpfc496822009-02-08 23:14:22 +00003014 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
3015 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00003016 LValue EmitUnsupportedLValue(const Expr *E,
3017 const char *Name);
3018
Chris Lattner8394d792007-06-05 20:53:16 +00003019 /// EmitLValue - Emit code to compute a designator that specifies the location
3020 /// of the expression.
3021 ///
3022 /// This can return one of two things: a simple address or a bitfield
3023 /// reference. In either case, the LLVM Value* in the LValue structure is
3024 /// guaranteed to be an LLVM pointer type.
3025 ///
3026 /// If this returns a bitfield reference, nothing about the pointee type of
3027 /// the LLVM value is known: For example, it may not be a pointer to an
3028 /// integer.
3029 ///
3030 /// If this returns a normal address, and if the lvalue's C type is fixed
3031 /// size, this method guarantees that the returned pointer type will point to
3032 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
3033 /// variable length type, this is not possible.
3034 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00003035 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003036
Richard Smith4d1458e2012-09-08 02:08:36 +00003037 /// \brief Same as EmitLValue but additionally we generate checking code to
3038 /// guard against undefined behavior. This is only suitable when we know
3039 /// that the address will be used to access the object.
3040 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00003041
John McCall7f416cc2015-09-08 08:05:57 +00003042 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003043 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00003044
John McCalla8ec7eb2013-03-07 21:37:17 +00003045 void EmitAtomicInit(Expr *E, LValue lvalue);
3046
David Majnemera5b195a2015-02-14 01:35:12 +00003047 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00003048
3049 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
3050 AggValueSlot Slot = AggValueSlot::ignored());
3051
Nick Lewycky2d84e842013-10-02 02:29:49 +00003052 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00003053 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00003054 AggValueSlot slot = AggValueSlot::ignored());
3055
3056 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3057
David Majnemera5b195a2015-02-14 01:35:12 +00003058 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3059 bool IsVolatile, bool isInit);
3060
Alexey Bataevb4505a72015-03-30 05:20:59 +00003061 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00003062 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00003063 llvm::AtomicOrdering Success =
3064 llvm::AtomicOrdering::SequentiallyConsistent,
3065 llvm::AtomicOrdering Failure =
3066 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00003067 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3068
Alexey Bataevb4505a72015-03-30 05:20:59 +00003069 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00003070 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00003071 bool IsVolatile);
3072
John McCall3a7f6922010-10-27 20:58:56 +00003073 /// EmitToMemory - Change a scalar value from its value
3074 /// representation to its in-memory representation.
3075 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3076
3077 /// EmitFromMemory - Change a scalar value from its memory
3078 /// representation to its value representation.
3079 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3080
Vedant Kumar5a972652017-02-27 19:46:19 +00003081 /// Check if the scalar \p Value is within the valid range for the given
3082 /// type \p Ty.
3083 ///
3084 /// Returns true if a check is needed (even if the range is unknown).
3085 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3086 SourceLocation Loc);
3087
Daniel Dunbar1d425462009-02-10 00:57:50 +00003088 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3089 /// care to appropriately convert from the memory representation to
3090 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003091 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003092 SourceLocation Loc,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003093 AlignmentSource Source = AlignmentSource::Type,
3094 bool isNontemporal = false) {
3095 return EmitLoadOfScalar(Addr, Volatile, Ty, Loc,
3096 LValueBaseInfo(Source, false),
3097 CGM.getTBAAAccessInfo(Ty), isNontemporal);
3098 }
3099
3100 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3101 SourceLocation Loc, LValueBaseInfo BaseInfo,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003102 TBAAAccessInfo TBAAInfo,
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003103 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003104
3105 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3106 /// care to appropriately convert from the memory representation to
3107 /// the LLVM value representation. The l-value must be a simple
3108 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003109 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003110
3111 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3112 /// care to appropriately convert from the memory representation to
3113 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003114 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3115 bool Volatile, QualType Ty,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003116 AlignmentSource Source = AlignmentSource::Type,
3117 bool isInit = false, bool isNontemporal = false) {
3118 EmitStoreOfScalar(Value, Addr, Volatile, Ty, LValueBaseInfo(Source, false),
3119 CGM.getTBAAAccessInfo(Ty), isInit, isNontemporal);
3120 }
3121
3122 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003123 bool Volatile, QualType Ty,
3124 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo,
Ivan A. Kosareva511ed72017-10-03 10:52:39 +00003125 bool isInit = false, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003126
3127 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3128 /// care to appropriately convert from the memory representation to
3129 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00003130 /// l-value. The isInit flag indicates whether this is an initialization.
3131 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3132 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003133
Chris Lattner8394d792007-06-05 20:53:16 +00003134 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3135 /// this method emits the address of the lvalue, then loads the result as an
3136 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003137 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00003138 RValue EmitLoadOfExtVectorElementLValue(LValue V);
Vedant Kumar129edab2017-03-09 16:06:27 +00003139 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
Renato Golin230c5eb2014-05-19 18:15:42 +00003140 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00003141
Chris Lattner8394d792007-06-05 20:53:16 +00003142 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3143 /// lvalue, where both are guaranteed to the have the same type, and that type
3144 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00003145 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003146 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00003147 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003148
Nick Lewycky2d84e842013-10-02 02:29:49 +00003149 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3150 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003151 ///
Mike Stumpfc496822009-02-08 23:14:22 +00003152 /// \param Result [out] - If non-null, this will be set to a Value* for the
3153 /// bit-field contents after the store, appropriate for use as the result of
3154 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00003155 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00003156 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00003157
John McCall4f29b492010-11-16 23:07:28 +00003158 /// Emit an l-value for an assignment (simple or compound) of complex type.
3159 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003160 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00003161 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3162 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00003163
Chris Lattner57540c52011-04-15 05:22:18 +00003164 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00003165 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003166 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003167 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00003168 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003169 // Note: only available for agg return types
3170 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00003171 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00003172 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00003173 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00003174 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00003175 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00003176 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3177 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00003178 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3179 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00003180 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00003181 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00003182 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00003183 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00003184 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00003185 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00003186 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00003187 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00003188 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00003189
John McCall7f416cc2015-09-08 08:05:57 +00003190 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003191
Nick Lewycky2d84e842013-10-02 02:29:49 +00003192 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00003193
John McCall7f416cc2015-09-08 08:05:57 +00003194 Address EmitArrayToPointerDecay(const Expr *Array,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00003195 LValueBaseInfo *BaseInfo = nullptr,
3196 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003197
John McCall71335052012-03-10 03:05:10 +00003198 class ConstantEmission {
3199 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3200 ConstantEmission(llvm::Constant *C, bool isReference)
3201 : ValueAndIsReference(C, isReference) {}
3202 public:
3203 ConstantEmission() {}
3204 static ConstantEmission forReference(llvm::Constant *C) {
3205 return ConstantEmission(C, true);
3206 }
3207 static ConstantEmission forValue(llvm::Constant *C) {
3208 return ConstantEmission(C, false);
3209 }
3210
Aaron Ballman67347662015-02-15 22:00:28 +00003211 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00003212 return ValueAndIsReference.getOpaqueValue() != nullptr;
3213 }
John McCall71335052012-03-10 03:05:10 +00003214
3215 bool isReference() const { return ValueAndIsReference.getInt(); }
3216 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3217 assert(isReference());
3218 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3219 refExpr->getType());
3220 }
3221
3222 llvm::Constant *getValue() const {
3223 assert(!isReference());
3224 return ValueAndIsReference.getPointer();
3225 }
3226 };
3227
John McCall113bee02012-03-10 09:33:50 +00003228 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
Alex Lorenz6cc83172017-08-25 10:07:00 +00003229 ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
John McCall71335052012-03-10 03:05:10 +00003230
John McCallfe96e0b2011-11-06 09:01:30 +00003231 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3232 AggValueSlot slot = AggValueSlot::ignored());
3233 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3234
Daniel Dunbar722f4242009-04-22 05:08:15 +00003235 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003236 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00003237 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00003238 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003239
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003240 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3241 /// if the Field is a reference, this will return the address of the reference
3242 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003243 LValue EmitLValueForFieldInitialization(LValue Base,
3244 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003245
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003246 LValue EmitLValueForIvar(QualType ObjectTy,
3247 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003248 unsigned CVRQualifiers);
3249
Anders Carlsson3be22e22009-05-30 23:23:33 +00003250 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003251 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00003252 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003253 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003254 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003255
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003256 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003257 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003258 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003259 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003260 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003261 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003262
Chris Lattnerd7f58862007-06-02 05:24:33 +00003263 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003264 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003265 //===--------------------------------------------------------------------===//
3266
Mike Stumpfc496822009-02-08 23:14:22 +00003267 /// EmitCall - Generate a call of the given function, expecting the given
3268 /// result type, and using the given argument list which specifies both the
3269 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003270 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003271 ReturnValueSlot ReturnValue, const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00003272 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003273
John McCallb92ab1a2016-10-26 23:46:34 +00003274 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003275 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00003276 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003277 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003278 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003279 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3280 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003281
Eric Christopherc7e79db2015-11-12 00:44:04 +00003282 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003283
John McCall882987f2013-02-28 19:01:20 +00003284 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3285 const Twine &name = "");
3286 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3287 ArrayRef<llvm::Value*> args,
3288 const Twine &name = "");
3289 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3290 const Twine &name = "");
3291 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3292 ArrayRef<llvm::Value*> args,
3293 const Twine &name = "");
3294
John McCallbd309292010-07-06 01:34:17 +00003295 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003296 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00003297 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00003298 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3299 ArrayRef<llvm::Value*> args,
3300 const Twine &name = "");
3301 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3302 const Twine &name = "");
3303 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3304 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00003305
John McCallb92ab1a2016-10-26 23:46:34 +00003306 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
3307 NestedNameSpecifier *Qual,
3308 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00003309
John McCallb92ab1a2016-10-26 23:46:34 +00003310 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
3311 CXXDtorType Type,
3312 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003313
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003314 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003315 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3316 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003317 ReturnValueSlot ReturnValue, llvm::Value *This,
3318 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003319 QualType ImplicitParamTy, const CallExpr *E,
3320 CallArgList *RtlArgs);
John McCallb92ab1a2016-10-26 23:46:34 +00003321 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3322 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003323 llvm::Value *This, llvm::Value *ImplicitParam,
3324 QualType ImplicitParamTy, const CallExpr *E,
3325 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003326 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3327 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003328 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3329 const CXXMethodDecl *MD,
3330 ReturnValueSlot ReturnValue,
3331 bool HasQualifier,
3332 NestedNameSpecifier *Qualifier,
3333 bool IsArrow, const Expr *Base);
3334 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003335 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3336 llvm::Value *memberPtr,
3337 const MemberPointerType *memberPtrType,
Ivan A. Kosarev229a6d82017-10-13 16:38:32 +00003338 LValueBaseInfo *BaseInfo = nullptr,
3339 TBAAAccessInfo *TBAAInfo = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003340 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3341 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003342
Anders Carlsson4034a952009-05-27 04:18:27 +00003343 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003344 const CXXMethodDecl *MD,
3345 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003346 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003347
Peter Collingbournefe883422011-10-06 18:29:37 +00003348 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3349 ReturnValueSlot ReturnValue);
3350
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003351 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3352 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003353
Mike Stump11289f42009-09-09 15:08:12 +00003354 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00003355 unsigned BuiltinID, const CallExpr *E,
3356 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003357
Akira Hatanaka6b103bc2017-10-06 07:12:46 +00003358 /// Emit IR for __builtin_os_log_format.
3359 RValue emitBuiltinOSLogFormat(const CallExpr &E);
3360
3361 llvm::Function *generateBuiltinOSLogHelperFunction(
3362 const analyze_os_log::OSLogBufferLayout &Layout,
3363 CharUnits BufferAlignment);
3364
Anders Carlssonbfb36712009-12-24 21:13:40 +00003365 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003366
Mike Stumpfc496822009-02-08 23:14:22 +00003367 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3368 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003369 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3370
Kevin Qin1718af62013-11-14 02:45:18 +00003371 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3372 const llvm::CmpInst::Predicate Fp,
3373 const llvm::CmpInst::Predicate Ip,
3374 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00003375 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00003376
3377 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3378 unsigned LLVMIntrinsic,
3379 unsigned AltLLVMIntrinsic,
3380 const char *NameHint,
3381 unsigned Modifier,
3382 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003383 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00003384 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00003385 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3386 unsigned Modifier, llvm::Type *ArgTy,
3387 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003388 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003389 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003390 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003391 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003392 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003393 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003394 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003395 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3396 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003397 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00003398 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003399
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003400 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003401 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3402 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003403 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003404 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003405 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003406 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3407 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003408
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003409private:
3410 enum class MSVCIntrin;
3411
3412public:
3413 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3414
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003415 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3416
Daniel Dunbar66912a12008-08-20 00:28:19 +00003417 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003418 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003419 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003420 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3421 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3422 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003423 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003424 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003425 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3426 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003427
John McCall31168b02011-06-15 23:02:42 +00003428 /// Retrieves the default cleanup kind for an ARC cleanup.
3429 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3430 CleanupKind getARCCleanupKind() {
3431 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3432 ? NormalAndEHCleanup : NormalCleanup;
3433 }
3434
3435 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003436 void EmitARCInitWeak(Address addr, llvm::Value *value);
3437 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003438 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003439 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3440 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3441 void EmitARCCopyWeak(Address dst, Address src);
3442 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003443 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3444 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003445 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003446 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003447 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003448 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003449 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003450 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003451 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003452 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003453 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003454 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003455 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3456 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3457 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003458 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003459
3460 std::pair<LValue,llvm::Value*>
3461 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3462 std::pair<LValue,llvm::Value*>
3463 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003464 std::pair<LValue,llvm::Value*>
3465 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003466
John McCall248512a2011-10-01 10:32:24 +00003467 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003468 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3469 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3470
John McCallff613032011-10-04 06:23:45 +00003471 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003472 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3473 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003474 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3475 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003476 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003477
Craig Topper00bbdcf2014-06-28 23:22:23 +00003478 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003479
John McCall82fe67b2011-07-09 01:37:26 +00003480 static Destroyer destroyARCStrongImprecise;
3481 static Destroyer destroyARCStrongPrecise;
3482 static Destroyer destroyARCWeak;
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00003483 static Destroyer emitARCIntrinsicUse;
John McCall82fe67b2011-07-09 01:37:26 +00003484
John McCall31168b02011-06-15 23:02:42 +00003485 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3486 llvm::Value *EmitObjCAutoreleasePoolPush();
3487 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3488 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3489 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3490
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003491 /// \brief Emits a reference binding to the passed in expression.
3492 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003493
Chris Lattner6278e6a2007-08-11 00:04:45 +00003494 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003495 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003496 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003497
3498 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003499
3500 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3501 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003502 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003503
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003504 /// Emit a conversion from the specified type to the specified destination
3505 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003506 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003507 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003508
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003509 /// Emit a conversion from the specified complex type to the specified
3510 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003511 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003512 QualType DstTy,
3513 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003514
John McCall7a626f62010-09-15 10:14:12 +00003515 /// EmitAggExpr - Emit the computation of the specified expression
3516 /// of aggregate type. The result is computed into the given slot,
3517 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003518 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003519
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003520 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3521 /// aggregate type into a temporary LValue.
3522 LValue EmitAggExprToLValue(const Expr *E);
3523
John McCall1bd25562011-06-24 23:21:27 +00003524 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3525 /// make sure it survives garbage collection until this point.
3526 void EmitExtendGCLifetime(llvm::Value *object);
3527
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003528 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003529 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003530 ComplexPairTy EmitComplexExpr(const Expr *E,
3531 bool IgnoreReal = false,
3532 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003533
John McCall47fb9502013-03-07 21:37:08 +00003534 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3535 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003536 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003537
John McCall47fb9502013-03-07 21:37:08 +00003538 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003539 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003540
3541 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003542 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003543
John McCall7f416cc2015-09-08 08:05:57 +00003544 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3545 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3546
Chandler Carruth84537952012-03-30 19:44:53 +00003547 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3548 /// global variable that has already been created for it. If the initializer
3549 /// has a different type than GV does, this may free GV and return a different
3550 /// one. Otherwise it just returns GV.
3551 llvm::GlobalVariable *
3552 AddInitializerToStaticVarDecl(const VarDecl &D,
3553 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003554
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003555
Anders Carlssonf40886a2009-08-08 21:45:14 +00003556 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3557 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003558 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3559 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003560
David Majnemerb3341ea2014-10-05 05:05:40 +00003561 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3562 llvm::Constant *Addr);
3563
John McCallc84ed6a2012-05-01 06:13:13 +00003564 /// Call atexit() with a function that passes the given argument to
3565 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003566 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3567 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003568
John McCallcdf7ef52010-11-06 09:44:32 +00003569 /// Emit code in this function to perform a guarded variable
3570 /// initialization. Guarded initializations are used when it's not
3571 /// possible to prove that an initialization will be done exactly
3572 /// once, e.g. with a static local variable or a static data member
3573 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003574 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003575 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003576
Richard Smithae8d62c2017-07-26 22:01:09 +00003577 enum class GuardKind { VariableGuard, TlsGuard };
3578
3579 /// Emit a branch to select whether or not to perform guarded initialization.
3580 void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
3581 llvm::BasicBlock *InitBlock,
3582 llvm::BasicBlock *NoInitBlock,
3583 GuardKind Kind, const VarDecl *D);
3584
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003585 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3586 /// variables.
3587 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003588 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003589 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003590
John McCallee08c532012-04-06 18:21:03 +00003591 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003592 /// variables.
Sanjoy Dase369bd92017-05-01 17:08:00 +00003593 void GenerateCXXGlobalDtorsFunc(
3594 llvm::Function *Fn,
3595 const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
3596 &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003597
John McCalla738c252011-03-09 04:27:21 +00003598 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3599 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003600 llvm::GlobalVariable *Addr,
3601 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003602
John McCall7a626f62010-09-15 10:14:12 +00003603 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00003604
John McCall7f416cc2015-09-08 08:05:57 +00003605 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003606
John McCall08ef4662011-11-10 08:15:53 +00003607 void enterFullExpression(const ExprWithCleanups *E) {
3608 if (E->getNumObjects() == 0) return;
3609 enterNonTrivialFullExpression(E);
3610 }
3611 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003612
Richard Smithea852322013-05-07 21:53:22 +00003613 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003614
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003615 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3616
Tim Northovercc2a6e02015-11-09 19:56:35 +00003617 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003618
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003619 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003620 // Annotations Emission
3621 //===--------------------------------------------------------------------===//
3622
3623 /// Emit an annotation call (intrinsic or builtin).
3624 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3625 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003626 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003627 SourceLocation Location);
3628
3629 /// Emit local annotations for the local variable V, declared by D.
3630 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3631
3632 /// Emit field annotations for the given field & value. Returns the
3633 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003634 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003635
3636 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003637 // Internal Helpers
3638 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003639
Chris Lattner5b1964b2008-11-11 07:41:27 +00003640 /// ContainsLabel - Return true if the statement contains a label in it. If
3641 /// this statement is not executed normally, it not containing a label means
3642 /// that we can just remove the code.
3643 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003644
Chris Lattner29911cc2011-02-28 00:18:40 +00003645 /// containsBreak - Return true if the statement contains a break out of it.
3646 /// If the statement (recursively) contains a switch or loop with a break
3647 /// inside of it, this is fine.
3648 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003649
3650 /// Determine if the given statement might introduce a declaration into the
3651 /// current scope, by being a (possibly-labelled) DeclStmt.
3652 static bool mightAddDeclToScope(const Stmt *S);
Chris Lattner29911cc2011-02-28 00:18:40 +00003653
Daniel Dunbar682712c2008-11-12 10:12:14 +00003654 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003655 /// to a constant, or if it does but contains a label, return false. If it
3656 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003657 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3658 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003659
Chris Lattner29911cc2011-02-28 00:18:40 +00003660 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3661 /// to a constant, or if it does but contains a label, return false. If it
3662 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003663 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3664 bool AllowLabels = false);
3665
Chris Lattnercd439292008-11-12 08:04:58 +00003666 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3667 /// if statement) to the specified blocks. Based on the condition, this might
3668 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003669 /// TrueCount should be the number of times we expect the condition to
3670 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003671 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003672 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003673
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003674 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
3675 /// nonnull, if \p LHS is marked _Nonnull.
3676 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
3677
Vedant Kumar175b6d12017-07-13 20:55:26 +00003678 /// An enumeration which makes it easier to specify whether or not an
3679 /// operation is a subtraction.
3680 enum { NotSubtraction = false, IsSubtraction = true };
3681
Vedant Kumara125eb52017-06-01 19:22:18 +00003682 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
3683 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003684 /// \p SignedIndices indicates whether any of the GEP indices are signed.
Vedant Kumar175b6d12017-07-13 20:55:26 +00003685 /// \p IsSubtraction indicates whether the expression used to form the GEP
3686 /// is a subtraction.
Vedant Kumara125eb52017-06-01 19:22:18 +00003687 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
3688 ArrayRef<llvm::Value *> IdxList,
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003689 bool SignedIndices,
Vedant Kumar175b6d12017-07-13 20:55:26 +00003690 bool IsSubtraction,
Vedant Kumara125eb52017-06-01 19:22:18 +00003691 SourceLocation Loc,
3692 const Twine &Name = "");
3693
Vedant Kumar10c31022017-07-29 00:19:51 +00003694 /// Specifies which type of sanitizer check to apply when handling a
3695 /// particular builtin.
3696 enum BuiltinCheckKind {
3697 BCK_CTZPassedZero,
3698 BCK_CLZPassedZero,
3699 };
3700
3701 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
3702 /// enabled, a runtime check specified by \p Kind is also emitted.
3703 llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
3704
Richard Smithe30752c2012-10-09 19:52:38 +00003705 /// \brief Emit a description of a type in a format suitable for passing to
3706 /// a runtime sanitizer handler.
3707 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3708
3709 /// \brief Convert a value into a format suitable for passing to a runtime
3710 /// sanitizer handler.
3711 llvm::Value *EmitCheckValue(llvm::Value *V);
3712
3713 /// \brief Emit a description of a source location in a format suitable for
3714 /// passing to a runtime sanitizer handler.
3715 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3716
Richard Smithde670682012-11-01 22:15:34 +00003717 /// \brief Create a basic block that will call a handler function in a
3718 /// sanitizer runtime with the provided arguments, and create a conditional
3719 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003720 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00003721 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003722 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003723
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003724 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3725 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003726 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3727 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3728 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003729
Richard Smithde670682012-11-01 22:15:34 +00003730 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3731 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003732 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003733
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003734 /// \brief Emit a call to trap or debugtrap and attach function attribute
3735 /// "trap-func-name" if specified.
3736 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3737
Evgeniy Stepanov1a8030e2017-04-07 23:00:38 +00003738 /// \brief Emit a stub for the cross-DSO CFI check function.
3739 void EmitCfiCheckStub();
3740
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003741 /// \brief Emit a cross-DSO CFI failure handling function.
3742 void EmitCfiCheckFail();
3743
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003744 /// \brief Create a check for a function parameter that may potentially be
3745 /// declared as non-null.
3746 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003747 AbstractCallee AC, unsigned ParmNum);
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003748
Anders Carlsson093bdff2010-03-30 03:27:09 +00003749 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003750 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003751
John McCall23f66262010-05-26 22:34:26 +00003752 /// EmitDelegateCallArg - We are performing a delegate call; that
3753 /// is, the current function is delegating to another one. Produce
3754 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003755 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3756 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003757
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003758 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3759 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003760 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003761
Chris Lattnercd439292008-11-12 08:04:58 +00003762private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003763 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003764 void EmitReturnOfRValue(RValue RV, QualType Ty);
3765
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003766 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3767
3768 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3769 DeferredReplacements;
3770
John McCall7f416cc2015-09-08 08:05:57 +00003771 /// Set the address of a local variable.
3772 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3773 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3774 LocalDeclMap.insert({VD, Addr});
3775 }
3776
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003777 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3778 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3779 ///
3780 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003781 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003782 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003783
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003784 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3785 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3786 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3787 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3788 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3789 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003790
Chad Rosier59df25b2012-08-23 20:00:18 +00003791 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003792 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003793
Chad Rosier59df25b2012-08-23 20:00:18 +00003794 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003795 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003796 std::string &ConstraintStr,
3797 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003798
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003799 /// \brief Attempts to statically evaluate the object size of E. If that
3800 /// fails, emits code to figure the size of E out for us. This is
3801 /// pass_object_size aware.
George Burgess IV0d6592a2017-02-23 05:59:56 +00003802 ///
3803 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003804 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003805 llvm::IntegerType *ResType,
3806 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003807
3808 /// \brief Emits the size of E, as required by __builtin_object_size. This
3809 /// function is aware of pass_object_size parameters, and will act accordingly
3810 /// if E is a parameter with the pass_object_size attribute.
3811 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003812 llvm::IntegerType *ResType,
3813 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003814
Reid Kleckner89077a12013-12-17 19:46:40 +00003815public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003816#ifndef NDEBUG
3817 // Determine whether the given argument is an Objective-C method
3818 // that may have type parameters in its signature.
3819 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3820 const DeclContext *dc = method->getDeclContext();
3821 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3822 return classDecl->getTypeParamListAsWritten();
3823 }
3824
3825 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3826 return catDecl->getTypeParamList();
3827 }
3828
3829 return false;
3830 }
3831
3832 template<typename T>
3833 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3834#endif
3835
Richard Smitha560ccf2016-09-29 21:30:12 +00003836 enum class EvaluationOrder {
3837 ///! No language constraints on evaluation order.
3838 Default,
3839 ///! Language semantics require left-to-right evaluation.
3840 ForceLeftToRight,
3841 ///! Language semantics require right-to-left evaluation.
3842 ForceRightToLeft
3843 };
3844
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003845 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003846 template <typename T>
3847 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003848 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003849 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003850 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003851 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003852 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003853 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003854
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003855 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3856 "Can't skip parameters if type info is not provided");
3857 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003858#ifndef NDEBUG
3859 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3860#endif
3861
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003862 // First, use the argument types that the type info knows about
3863 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3864 E = CallArgTypeInfo->param_type_end();
3865 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003866 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003867 assert((isGenericMethod ||
3868 ((*I)->isVariablyModifiedType() ||
3869 (*I).getNonReferenceType()->isObjCRetainableType() ||
3870 getContext()
3871 .getCanonicalType((*I).getNonReferenceType())
3872 .getTypePtr() ==
3873 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003874 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003875 .getTypePtr())) &&
3876 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003877 ArgTypes.push_back(*I);
3878 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003879 }
Mike Stump11289f42009-09-09 15:08:12 +00003880
Reid Kleckner739756c2013-12-04 19:23:12 +00003881 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003882 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003883 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3884 CallArgTypeInfo->isVariadic()) &&
3885 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003886
Anders Carlsson603d6af2009-04-18 20:20:22 +00003887 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003888 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00003889 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003890
Vedant Kumared00ea02017-03-06 05:28:22 +00003891 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003892 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003893
Reid Kleckner739756c2013-12-04 19:23:12 +00003894 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003895 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003896 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003897 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003898 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00003899
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00003900 /// EmitPointerWithAlignment - Given an expression with a pointer type,
3901 /// emit the value and compute our best estimate of the alignment of the
3902 /// pointee.
John McCall7f416cc2015-09-08 08:05:57 +00003903 ///
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00003904 /// \param BaseInfo - If non-null, this will be initialized with
3905 /// information about the source of the alignment and the may-alias
3906 /// attribute. Note that this function will conservatively fall back on
3907 /// the type when it doesn't recognize the expression and may-alias will
3908 /// be set to false.
3909 ///
3910 /// One reasonable way to use this information is when there's a language
3911 /// guarantee that the pointer must be aligned to some stricter value, and
3912 /// we're simply trying to ensure that sufficiently obvious uses of under-
3913 /// aligned objects don't get miscompiled; for example, a placement new
3914 /// into the address of a local variable. In such a case, it's quite
3915 /// reasonable to just ignore the returned alignment when it isn't from an
3916 /// explicit source.
John McCall7f416cc2015-09-08 08:05:57 +00003917 Address EmitPointerWithAlignment(const Expr *Addr,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00003918 LValueBaseInfo *BaseInfo = nullptr,
3919 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003920
Peter Collingbournedc134532016-01-16 00:31:22 +00003921 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3922
Reid Kleckner89077a12013-12-17 19:46:40 +00003923private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003924 QualType getVarArgType(const Expr *Arg);
3925
John McCall09ae0322010-07-06 23:57:41 +00003926 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003927
John McCall7f416cc2015-09-08 08:05:57 +00003928 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3929 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003930
3931 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003932
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003933 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Erich Keane9937b132017-09-01 19:42:45 +00003934 llvm::Value *EmitX86CpuIs(const CallExpr *E);
3935 llvm::Value *EmitX86CpuIs(StringRef CPUStr);
3936 llvm::Value *EmitX86CpuSupports(const CallExpr *E);
3937 llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
Erich Keane1fe643a2017-10-06 16:40:45 +00003938 llvm::Value *EmitX86CpuInit();
Chris Lattnerbed31442007-05-28 01:07:47 +00003939};
Mike Stump11289f42009-09-09 15:08:12 +00003940
John McCallce1de612011-01-26 04:00:11 +00003941/// Helper class with most of the code for saving a value for a
3942/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003943struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003944 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3945
3946 /// Answer whether the given value needs extra work to be saved.
3947 static bool needsSaving(llvm::Value *value) {
3948 // If it's not an instruction, we don't need to save.
3949 if (!isa<llvm::Instruction>(value)) return false;
3950
3951 // If it's an instruction in the entry block, we don't need to save.
3952 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3953 return (block != &block->getParent()->getEntryBlock());
3954 }
3955
3956 /// Try to save the given value.
3957 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3958 if (!needsSaving(value)) return saved_type(value, false);
3959
John McCall7f416cc2015-09-08 08:05:57 +00003960 // Otherwise, we need an alloca.
3961 auto align = CharUnits::fromQuantity(
3962 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3963 Address alloca =
3964 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003965 CGF.Builder.CreateStore(value, alloca);
3966
John McCall7f416cc2015-09-08 08:05:57 +00003967 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003968 }
3969
3970 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003971 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003972 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003973
3974 // Otherwise, it should be an alloca instruction, as set up in save().
3975 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3976 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003977 }
3978};
3979
John McCallcb5f77f2011-01-28 10:53:53 +00003980/// A partial specialization of DominatingValue for llvm::Values that
3981/// might be llvm::Instructions.
3982template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3983 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003984 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003985 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3986 }
3987};
3988
John McCall7f416cc2015-09-08 08:05:57 +00003989/// A specialization of DominatingValue for Address.
3990template <> struct DominatingValue<Address> {
3991 typedef Address type;
3992
3993 struct saved_type {
3994 DominatingLLVMValue::saved_type SavedValue;
3995 CharUnits Alignment;
3996 };
3997
3998 static bool needsSaving(type value) {
3999 return DominatingLLVMValue::needsSaving(value.getPointer());
4000 }
4001 static saved_type save(CodeGenFunction &CGF, type value) {
4002 return { DominatingLLVMValue::save(CGF, value.getPointer()),
4003 value.getAlignment() };
4004 }
4005 static type restore(CodeGenFunction &CGF, saved_type value) {
4006 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
4007 value.Alignment);
4008 }
4009};
4010
John McCallcb5f77f2011-01-28 10:53:53 +00004011/// A specialization of DominatingValue for RValue.
4012template <> struct DominatingValue<RValue> {
4013 typedef RValue type;
4014 class saved_type {
4015 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
4016 AggregateAddress, ComplexAddress };
4017
4018 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00004019 unsigned K : 3;
4020 unsigned Align : 29;
4021 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
4022 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00004023
4024 public:
4025 static bool needsSaving(RValue value);
4026 static saved_type save(CodeGenFunction &CGF, RValue value);
4027 RValue restore(CodeGenFunction &CGF);
4028
John McCall7f416cc2015-09-08 08:05:57 +00004029 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00004030 };
4031
4032 static bool needsSaving(type value) {
4033 return saved_type::needsSaving(value);
4034 }
4035 static saved_type save(CodeGenFunction &CGF, type value) {
4036 return saved_type::save(CGF, value);
4037 }
4038 static type restore(CodeGenFunction &CGF, saved_type value) {
4039 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00004040 }
4041};
4042
Chris Lattnerbed31442007-05-28 01:07:47 +00004043} // end namespace CodeGen
4044} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00004045
Chris Lattnerbed31442007-05-28 01:07:47 +00004046#endif