blob: ade60f29c8d54f2b50bdff4bd0a176fe6efb9f17 [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
Chris Lattnerbed31442007-05-28 01:07:47 +000079namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000080class CodeGenTypes;
John McCallb92ab1a2016-10-26 23:46:34 +000081class CGCallee;
Rafael Espindola42ae7452014-05-09 00:57:59 +000082class CGFunctionInfo;
83class CGRecordLayout;
84class CGBlockInfo;
85class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000086class BlockByrefHelpers;
87class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000088class BlockFlags;
89class BlockFieldFlags;
Alexey Bataev7292c292016-04-25 12:22:29 +000090class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000091class TargetCodeGenInfo;
Alexey Bataev24b5bae2016-04-28 09:23:51 +000092struct OMPTaskDataTy;
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000093struct CGCoroData;
Mike Stumpfc496822009-02-08 23:14:22 +000094
John McCall47fb9502013-03-07 21:37:08 +000095/// The kind of evaluation to perform on values of a particular
96/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
97/// CGExprAgg?
98///
99/// TODO: should vectors maybe be split out into their own thing?
100enum TypeEvaluationKind {
101 TEK_Scalar,
102 TEK_Complex,
103 TEK_Aggregate
104};
105
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000106#define LIST_SANITIZER_CHECKS \
107 SANITIZER_CHECK(AddOverflow, add_overflow, 0) \
108 SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \
109 SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \
110 SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \
111 SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \
112 SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \
113 SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0) \
Vedant Kumar10c31022017-07-29 00:19:51 +0000114 SANITIZER_CHECK(InvalidBuiltin, invalid_builtin, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000115 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
116 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
117 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
118 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000119 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000120 SANITIZER_CHECK(NullabilityReturn, nullability_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000121 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000122 SANITIZER_CHECK(NonnullReturn, nonnull_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000123 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
Vedant Kumara125eb52017-06-01 19:22:18 +0000124 SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000125 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
126 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
Filipe Cabecinhasfe5e5af2017-01-06 14:40:12 +0000127 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000128 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
129
130enum SanitizerHandler {
131#define SANITIZER_CHECK(Enum, Name, Version) Enum,
132 LIST_SANITIZER_CHECKS
133#undef SANITIZER_CHECK
134};
135
Chris Lattnerbed31442007-05-28 01:07:47 +0000136/// CodeGenFunction - This class organizes the per-function state that is used
137/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000138class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000139 CodeGenFunction(const CodeGenFunction &) = delete;
140 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000141
142 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000143public:
John McCallad5d61e2010-07-23 21:56:41 +0000144 /// A jump destination is an abstract label, branching to which may
145 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000146 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000147 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000148 JumpDest(llvm::BasicBlock *Block,
149 EHScopeStack::stable_iterator Depth,
150 unsigned Index)
151 : Block(Block), ScopeDepth(Depth), Index(Index) {}
152
Craig Topper8a13c412014-05-21 05:09:00 +0000153 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000154 llvm::BasicBlock *getBlock() const { return Block; }
155 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
156 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000157
Nadav Rotem1da30942013-03-23 06:43:35 +0000158 // This should be used cautiously.
159 void setScopeDepth(EHScopeStack::stable_iterator depth) {
160 ScopeDepth = depth;
161 }
162
John McCallad5d61e2010-07-23 21:56:41 +0000163 private:
John McCallbd309292010-07-06 01:34:17 +0000164 llvm::BasicBlock *Block;
165 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000166 unsigned Index;
167 };
168
Chris Lattnerbed31442007-05-28 01:07:47 +0000169 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000170 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000171
Chris Lattner96d72562007-08-21 16:57:55 +0000172 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000173 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000174 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000175
Vitaly Buka64c80b42016-10-26 05:42:30 +0000176 // Stores variables for which we can't generate correct lifetime markers
177 // because of jumps.
178 VarBypassDetector Bypasses;
179
Carlo Bertollib0ff0a62017-04-25 17:52:12 +0000180 // CodeGen lambda for loops and support for ordered clause
181 typedef llvm::function_ref<void(CodeGenFunction &, const OMPLoopDirective &,
182 JumpDest)>
183 CodeGenLoopTy;
184 typedef llvm::function_ref<void(CodeGenFunction &, SourceLocation,
185 const unsigned, const bool)>
186 CodeGenOrderedTy;
187
188 // Codegen lambda for loop bounds in worksharing loop constructs
189 typedef llvm::function_ref<std::pair<LValue, LValue>(
190 CodeGenFunction &, const OMPExecutableDirective &S)>
191 CodeGenLoopBoundsTy;
192
193 // Codegen lambda for loop bounds in dispatch-based loop implementation
194 typedef llvm::function_ref<std::pair<llvm::Value *, llvm::Value *>(
195 CodeGenFunction &, const OMPExecutableDirective &S, Address LB,
196 Address UB)>
197 CodeGenDispatchBoundsTy;
198
Alexander Musman515ad8c2014-05-22 08:54:05 +0000199 /// \brief CGBuilder insert helper. This function is called after an
200 /// instruction is created using Builder.
201 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
202 llvm::BasicBlock *BB,
203 llvm::BasicBlock::iterator InsertPt) const;
204
John McCalldec348f72013-05-03 07:33:41 +0000205 /// CurFuncDecl - Holds the Decl for the current outermost
206 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000207 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000208 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
209 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000210 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000211 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000212 llvm::Function *CurFn;
213
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000214 // Holds coroutine data if the current function is a coroutine. We use a
215 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
216 // in this header.
217 struct CGCoroInfo {
218 std::unique_ptr<CGCoroData> Data;
219 CGCoroInfo();
220 ~CGCoroInfo();
221 };
222 CGCoroInfo CurCoro;
223
Mike Stumpbee78dd2009-12-04 23:26:17 +0000224 /// CurGD - The GlobalDecl for the current function being compiled.
225 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000226
John McCall31168b02011-06-15 23:02:42 +0000227 /// PrologueCleanupDepth - The cleanup depth enclosing all the
228 /// cleanups associated with the parameters.
229 EHScopeStack::stable_iterator PrologueCleanupDepth;
230
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000231 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000232 JumpDest ReturnBlock;
233
John McCall7f416cc2015-09-08 08:05:57 +0000234 /// ReturnValue - The temporary alloca to hold the return
235 /// value. This is invalid iff the function has no return value.
236 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000237
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000238 /// Return true if a label was seen in the current scope.
239 bool hasLabelBeenSeenInCurrentScope() const {
240 if (CurLexicalScope)
241 return CurLexicalScope->hasLabels();
242 return !LabelMap.empty();
243 }
244
Chris Lattner03df1222007-06-02 04:53:11 +0000245 /// AllocaInsertPoint - This is an instruction in the entry block before which
246 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000247 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000248
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000249 /// \brief API for captured statement code generation.
250 class CGCapturedStmtInfo {
251 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000252 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
253 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000254 explicit CGCapturedStmtInfo(const CapturedStmt &S,
255 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000256 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000257
258 RecordDecl::field_iterator Field =
259 S.getCapturedRecordDecl()->field_begin();
260 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
261 E = S.capture_end();
262 I != E; ++I, ++Field) {
263 if (I->capturesThis())
264 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000265 else if (I->capturesVariable())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000266 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000267 else if (I->capturesVariableByCopy())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000268 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000269 }
270 }
271
272 virtual ~CGCapturedStmtInfo();
273
274 CapturedRegionKind getKind() const { return Kind; }
275
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000276 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000277 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000278 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000279
280 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000281 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000282 return CaptureFields.lookup(VD->getCanonicalDecl());
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000283 }
284
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000285 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
286 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000287
Alexey Bataev18095712014-10-10 12:19:54 +0000288 static bool classof(const CGCapturedStmtInfo *) {
289 return true;
290 }
291
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000292 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000293 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000294 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000295 CGF.EmitStmt(S);
296 }
297
298 /// \brief Get the name of the capture helper.
299 virtual StringRef getHelperName() const { return "__captured_stmt"; }
300
301 private:
302 /// \brief The kind of captured statement being generated.
303 CapturedRegionKind Kind;
304
305 /// \brief Keep the map between VarDecl and FieldDecl.
306 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
307
308 /// \brief The base address of the captured record, passed in as the first
309 /// argument of the parallel region function.
310 llvm::Value *ThisValue;
311
312 /// \brief Captured 'this' type.
313 FieldDecl *CXXThisFieldDecl;
314 };
315 CGCapturedStmtInfo *CapturedStmtInfo;
316
Alexey Bataevd157d472015-06-24 03:35:38 +0000317 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
318 class CGCapturedStmtRAII {
319 private:
320 CodeGenFunction &CGF;
321 CGCapturedStmtInfo *PrevCapturedStmtInfo;
322 public:
323 CGCapturedStmtRAII(CodeGenFunction &CGF,
324 CGCapturedStmtInfo *NewCapturedStmtInfo)
325 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
326 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
327 }
328 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
329 };
330
Vedant Kumared00ea02017-03-06 05:28:22 +0000331 /// An abstract representation of regular/ObjC call/message targets.
332 class AbstractCallee {
333 /// The function declaration of the callee.
334 const Decl *CalleeDecl;
335
336 public:
337 AbstractCallee() : CalleeDecl(nullptr) {}
338 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
339 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
340 bool hasFunctionDecl() const {
341 return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
342 }
343 const Decl *getDecl() const { return CalleeDecl; }
344 unsigned getNumParams() const {
345 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
346 return FD->getNumParams();
347 return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
348 }
349 const ParmVarDecl *getParamDecl(unsigned I) const {
350 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
351 return FD->getParamDecl(I);
352 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
353 }
354 };
355
Alexey Samsonova0416102014-11-11 01:26:14 +0000356 /// \brief Sanitizers enabled for this function.
357 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000358
Alexey Samsonov24cad992014-07-17 18:46:27 +0000359 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
360 bool IsSanitizerScope;
361
362 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
363 class SanitizerScope {
364 CodeGenFunction *CGF;
365 public:
366 SanitizerScope(CodeGenFunction *CGF);
367 ~SanitizerScope();
368 };
369
Reid Kleckner19819442014-07-25 21:39:46 +0000370 /// In C++, whether we are code generating a thunk. This controls whether we
371 /// should emit cleanups.
372 bool CurFuncIsThunk;
373
John McCall31168b02011-06-15 23:02:42 +0000374 /// In ARC, whether we should autorelease the return value.
375 bool AutoreleaseResult;
376
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000377 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
378 /// potentially set the return value.
379 bool SawAsmBlock;
380
David Majnemer25eb1652016-03-01 19:42:53 +0000381 const FunctionDecl *CurSEHParent = nullptr;
382
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000383 /// True if the current function is an outlined SEH helper. This can be a
384 /// finally block or filter expression.
385 bool IsOutlinedSEHHelper;
386
John McCallad7c5c12011-02-08 08:22:06 +0000387 const CodeGen::CGBlockInfo *BlockInfo;
388 llvm::Value *BlockPointer;
389
Eli Friedman9fbeba02012-02-11 02:57:39 +0000390 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
391 FieldDecl *LambdaThisCaptureField;
392
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000393 /// \brief A mapping from NRVO variables to the flags used to indicate
394 /// when the NRVO has been applied to this variable.
395 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000396
John McCallbd309292010-07-06 01:34:17 +0000397 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000398 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000399 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000400
David Majnemer4e52d6f2015-12-12 05:39:21 +0000401 llvm::Instruction *CurrentFuncletPad = nullptr;
402
Tim Shen421119f2016-07-01 21:08:47 +0000403 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
404 llvm::Value *Addr;
405 llvm::Value *Size;
406
407 public:
408 CallLifetimeEnd(Address addr, llvm::Value *size)
409 : Addr(addr.getPointer()), Size(size) {}
410
411 void Emit(CodeGenFunction &CGF, Flags flags) override {
412 CGF.EmitLifetimeEnd(Size, Addr);
413 }
414 };
415
Richard Smith736a9472013-06-12 20:42:33 +0000416 /// Header for data within LifetimeExtendedCleanupStack.
417 struct LifetimeExtendedCleanupHeader {
418 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000419 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000420 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000421 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000422
Justin Bognerbdff2192015-07-01 00:59:27 +0000423 size_t getSize() const { return Size; }
424 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000425 };
John McCallbd309292010-07-06 01:34:17 +0000426
John McCallad5d61e2010-07-23 21:56:41 +0000427 /// i32s containing the indexes of the cleanup destinations.
428 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000429
430 unsigned NextCleanupDestIndex;
431
John McCall08ef4662011-11-10 08:15:53 +0000432 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
433 CGBlockInfo *FirstBlockInfo;
434
John McCall8e4c74b2011-08-11 02:22:43 +0000435 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
436 llvm::BasicBlock *EHResumeBlock;
437
Bill Wendlingf0724e82011-09-19 20:31:14 +0000438 /// The exception slot. All landing pads write the current exception pointer
439 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000440 llvm::Value *ExceptionSlot;
441
Bill Wendlingf0724e82011-09-19 20:31:14 +0000442 /// The selector slot. Under the MandatoryCleanup model, all landing pads
443 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000444 llvm::AllocaInst *EHSelectorSlot;
445
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000446 /// A stack of exception code slots. Entering an __except block pushes a slot
447 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
448 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000449 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000450
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000451 /// Value returned by __exception_info intrinsic.
452 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000453
John McCallbd309292010-07-06 01:34:17 +0000454 /// Emits a landing pad for the current EH stack.
455 llvm::BasicBlock *EmitLandingPad();
456
457 llvm::BasicBlock *getInvokeDestImpl();
458
John McCallce1de612011-01-26 04:00:11 +0000459 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000460 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
461 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000462 }
463
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000464public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000465 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
466 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000467 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000468
John McCall6b0feb72011-06-22 02:32:12 +0000469 /// A class controlling the emission of a finally block.
470 class FinallyInfo {
471 /// Where the catchall's edge through the cleanup should go.
472 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000473
John McCall6b0feb72011-06-22 02:32:12 +0000474 /// A function to call to enter the catch.
475 llvm::Constant *BeginCatchFn;
476
477 /// An i1 variable indicating whether or not the @finally is
478 /// running for an exception.
479 llvm::AllocaInst *ForEHVar;
480
481 /// An i8* variable into which the exception pointer to rethrow
482 /// has been saved.
483 llvm::AllocaInst *SavedExnVar;
484
485 public:
486 void enter(CodeGenFunction &CGF, const Stmt *Finally,
487 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
488 llvm::Constant *rethrowFn);
489 void exit(CodeGenFunction &CGF);
490 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000491
Reid Kleckner11c033e2015-02-12 23:40:45 +0000492 /// Returns true inside SEH __try blocks.
493 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
494
Reid Klecknera002bd52015-10-28 23:06:42 +0000495 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000496 bool isCleanupPadScope() const {
497 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
498 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000499
John McCallce1de612011-01-26 04:00:11 +0000500 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
501 /// current full-expression. Safe against the possibility that
502 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000503 template <class T, class... As>
504 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000505 // If we're not in a conditional branch, or if none of the
506 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000507 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000508 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000509
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000510 // Stash values in a tuple so we can guarantee the order of saves.
511 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
512 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000513
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000514 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000515 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000516 initFullExprCleanup();
517 }
518
Richard Smith736a9472013-06-12 20:42:33 +0000519 /// \brief Queue a cleanup to be pushed after finishing the current
520 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000521 template <class T, class... As>
522 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000523 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
524
525 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
526
527 size_t OldSize = LifetimeExtendedCleanupStack.size();
528 LifetimeExtendedCleanupStack.resize(
529 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
530
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000531 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000532 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000533 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
534 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000535 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000536 }
537
John McCallf4beacd2011-11-10 10:43:54 +0000538 /// Set up the last cleaup that was pushed as a conditional
539 /// full-expression cleanup.
540 void initFullExprCleanup();
541
John McCallbd309292010-07-06 01:34:17 +0000542 /// PushDestructorCleanup - Push a cleanup to call the
543 /// complete-object destructor of an object of the given type at the
544 /// given address. Does nothing if T is not a C++ class type with a
545 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000546 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000547
John McCall8680f872010-07-21 06:29:51 +0000548 /// PushDestructorCleanup - Push a cleanup to call the
549 /// complete-object variant of the given destructor on the object at
550 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000551 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000552
John McCallbd309292010-07-06 01:34:17 +0000553 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
554 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000555 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000556
John McCall824c2f52010-09-14 07:57:04 +0000557 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
558 /// The block cannot be reactivated. Pops it if it's the top of the
559 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000560 ///
561 /// \param DominatingIP - An instruction which is known to
562 /// dominate the current IP (if set) and which lies along
563 /// all paths of execution between the current IP and the
564 /// the point at which the cleanup comes into scope.
565 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
566 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000567
568 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
569 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000570 ///
571 /// \param DominatingIP - An instruction which is known to
572 /// dominate the current IP (if set) and which lies along
573 /// all paths of execution between the current IP and the
574 /// the point at which the cleanup comes into scope.
575 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
576 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000577
John McCallbd309292010-07-06 01:34:17 +0000578 /// \brief Enters a new scope for capturing cleanups, all of which
579 /// will be executed once the scope is exited.
580 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000581 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000582 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000583 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000584 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000585 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000586 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000587
Aaron Ballmanabc18922015-02-15 22:54:08 +0000588 RunCleanupsScope(const RunCleanupsScope &) = delete;
589 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000590
Eric Christophera9d34972011-10-19 00:43:52 +0000591 protected:
592 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000593
Douglas Gregor965f4502009-11-24 16:43:22 +0000594 public:
595 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000596 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000597 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000598 {
John McCallbd309292010-07-06 01:34:17 +0000599 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000600 LifetimeExtendedCleanupStackSize =
601 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000602 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000603 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000604 }
605
Reid Kleckner092d0652017-03-06 22:18:34 +0000606 /// \brief Exit this cleanup scope, emitting any accumulated cleanups.
John McCallbd309292010-07-06 01:34:17 +0000607 ~RunCleanupsScope() {
Reid Kleckner092d0652017-03-06 22:18:34 +0000608 if (PerformCleanup)
609 ForceCleanup();
Douglas Gregor680f8612009-11-24 21:15:44 +0000610 }
611
612 /// \brief Determine whether this scope requires any cleanups.
613 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000614 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000615 }
616
617 /// \brief Force the emission of cleanups now, instead of waiting
618 /// until this object is destroyed.
Reid Kleckner092d0652017-03-06 22:18:34 +0000619 /// \param ValuesToReload - A list of values that need to be available at
620 /// the insertion point after cleanup emission. If cleanup emission created
621 /// a shared cleanup block, these value pointers will be rewritten.
622 /// Otherwise, they not will be modified.
623 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
Douglas Gregor680f8612009-11-24 21:15:44 +0000624 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000625 CGF.DidCallStackSave = OldDidCallStackSave;
Reid Kleckner092d0652017-03-06 22:18:34 +0000626 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
627 ValuesToReload);
Douglas Gregor680f8612009-11-24 21:15:44 +0000628 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000629 }
630 };
631
David Blaikie93be0b22014-08-22 21:37:04 +0000632 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000633 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000634 SmallVector<const LabelDecl*, 4> Labels;
635 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000636
Aaron Ballmanabc18922015-02-15 22:54:08 +0000637 LexicalScope(const LexicalScope &) = delete;
638 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000639
640 public:
641 /// \brief Enter a new cleanup scope.
642 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000643 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
644 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000645 if (CGDebugInfo *DI = CGF.getDebugInfo())
646 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
647 }
648
Nadav Rotem1da30942013-03-23 06:43:35 +0000649 void addLabel(const LabelDecl *label) {
650 assert(PerformCleanup && "adding label to dead scope?");
651 Labels.push_back(label);
652 }
653
Eric Christophera9d34972011-10-19 00:43:52 +0000654 /// \brief Exit this cleanup scope, emitting any accumulated
655 /// cleanups.
656 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000657 if (CGDebugInfo *DI = CGF.getDebugInfo())
658 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
659
Nadav Rotem1da30942013-03-23 06:43:35 +0000660 // If we should perform a cleanup, force them now. Note that
661 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000662 if (PerformCleanup) {
663 ApplyDebugLocation DL(CGF, Range.getEnd());
664 ForceCleanup();
665 }
Eric Christophera9d34972011-10-19 00:43:52 +0000666 }
667
668 /// \brief Force the emission of cleanups now, instead of waiting
669 /// until this object is destroyed.
670 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000671 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000672 RunCleanupsScope::ForceCleanup();
673
Nadav Rotem1da30942013-03-23 06:43:35 +0000674 if (!Labels.empty())
675 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000676 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000677
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000678 bool hasLabels() const {
679 return !Labels.empty();
680 }
681
Nadav Rotem1da30942013-03-23 06:43:35 +0000682 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000683 };
684
John McCall7f416cc2015-09-08 08:05:57 +0000685 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
686
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000687 /// \brief The scope used to remap some variables as private in the OpenMP
688 /// loop body (or other captured region emitted without outlining), and to
689 /// restore old vars back on exit.
690 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000691 DeclMapTy SavedLocals;
692 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000693
694 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000695 OMPPrivateScope(const OMPPrivateScope &) = delete;
696 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000697
698 public:
699 /// \brief Enter a new OpenMP private scope.
700 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
701
702 /// \brief Registers \a LocalVD variable as a private and apply \a
703 /// PrivateGen function for it to generate corresponding private variable.
704 /// \a PrivateGen returns an address of the generated private variable.
705 /// \return true if the variable is registered as private, false if it has
706 /// been privatized already.
707 bool
708 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000709 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000710 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000711
Alexey Bataev6a71f362017-08-22 17:54:52 +0000712 LocalVD = LocalVD->getCanonicalDecl();
John McCall7f416cc2015-09-08 08:05:57 +0000713 // Only save it once.
714 if (SavedLocals.count(LocalVD)) return false;
715
716 // Copy the existing local entry to SavedLocals.
717 auto it = CGF.LocalDeclMap.find(LocalVD);
718 if (it != CGF.LocalDeclMap.end()) {
719 SavedLocals.insert({LocalVD, it->second});
720 } else {
721 SavedLocals.insert({LocalVD, Address::invalid()});
722 }
723
724 // Generate the private entry.
725 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000726 QualType VarTy = LocalVD->getType();
727 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000728 Address Temp = CGF.CreateMemTemp(VarTy);
729 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
730 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000731 }
John McCall7f416cc2015-09-08 08:05:57 +0000732 SavedPrivates.insert({LocalVD, Addr});
733
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000734 return true;
735 }
736
737 /// \brief Privatizes local variables previously registered as private.
738 /// Registration is separate from the actual privatization to allow
739 /// initializers use values of the original variables, not the private one.
740 /// This is important, for example, if the private variable is a class
741 /// variable initialized by a constructor that references other private
742 /// variables. But at initialization original variables must be used, not
743 /// private copies.
744 /// \return true if at least one variable was privatized, false otherwise.
745 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000746 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000747 SavedPrivates.clear();
748 return !SavedLocals.empty();
749 }
750
751 void ForceCleanup() {
752 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000753 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000754 SavedLocals.clear();
755 }
756
757 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000758 ~OMPPrivateScope() {
759 if (PerformCleanup)
760 ForceCleanup();
761 }
John McCall7f416cc2015-09-08 08:05:57 +0000762
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000763 /// Checks if the global variable is captured in current function.
764 bool isGlobalVarCaptured(const VarDecl *VD) const {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000765 VD = VD->getCanonicalDecl();
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000766 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
767 }
768
John McCall7f416cc2015-09-08 08:05:57 +0000769 private:
770 /// Copy all the entries in the source map over the corresponding
771 /// entries in the destination, which must exist.
772 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
773 for (auto &pair : src) {
774 if (!pair.second.isValid()) {
775 dest.erase(pair.first);
776 continue;
777 }
778
779 auto it = dest.find(pair.first);
780 if (it != dest.end()) {
781 it->second = pair.second;
782 } else {
783 dest.insert(pair);
784 }
785 }
786 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000787 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000788
Richard Smith736a9472013-06-12 20:42:33 +0000789 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
790 /// that have been added.
Reid Kleckner092d0652017-03-06 22:18:34 +0000791 void
792 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
793 std::initializer_list<llvm::Value **> ValuesToReload = {});
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000794
Richard Smith736a9472013-06-12 20:42:33 +0000795 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
796 /// that have been added, then adds all lifetime-extended cleanups from
797 /// the given position to the stack.
Reid Kleckner092d0652017-03-06 22:18:34 +0000798 void
799 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
800 size_t OldLifetimeExtendedStackSize,
801 std::initializer_list<llvm::Value **> ValuesToReload = {});
Richard Smith736a9472013-06-12 20:42:33 +0000802
John McCallad5d61e2010-07-23 21:56:41 +0000803 void ResolveBranchFixups(llvm::BasicBlock *Target);
804
John McCallbd309292010-07-06 01:34:17 +0000805 /// The given basic block lies in the current EH scope, but may be a
806 /// target of a potentially scope-crossing jump; get a stable handle
807 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000808 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000809 return JumpDest(Target,
810 EHStack.getInnermostNormalCleanup(),
811 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000812 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000813
John McCallbd309292010-07-06 01:34:17 +0000814 /// The given basic block lies in the current EH scope, but may be a
815 /// target of a potentially scope-crossing jump; get a stable handle
816 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000817 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000818 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000819 }
820
821 /// EmitBranchThroughCleanup - Emit a branch from the current insert
822 /// block through the normal cleanup handling code (if any) and then
823 /// on to \arg Dest.
824 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000825
Justin Bognere25ffdf2014-01-21 00:35:11 +0000826 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
827 /// specified destination obviously has no cleanups to run. 'false' is always
828 /// a conservatively correct answer for this method.
829 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
830
John McCall8e4c74b2011-08-11 02:22:43 +0000831 /// popCatchScope - Pops the catch scope at the top of the EHScope
832 /// stack, emitting any required code (other than the catch handlers
833 /// themselves).
834 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000835
David Chisnall9a837be2012-11-07 16:50:40 +0000836 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000837 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000838 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000839
John McCallce1de612011-01-26 04:00:11 +0000840 /// An object to manage conditionally-evaluated expressions.
841 class ConditionalEvaluation {
842 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000843
John McCallce1de612011-01-26 04:00:11 +0000844 public:
845 ConditionalEvaluation(CodeGenFunction &CGF)
846 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000847
John McCallce1de612011-01-26 04:00:11 +0000848 void begin(CodeGenFunction &CGF) {
849 assert(CGF.OutermostConditional != this);
850 if (!CGF.OutermostConditional)
851 CGF.OutermostConditional = this;
852 }
853
854 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000855 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000856 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000857 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000858 }
859
860 /// Returns a block which will be executed prior to each
861 /// evaluation of the conditional code.
862 llvm::BasicBlock *getStartingBlock() const {
863 return StartBB;
864 }
865 };
Mike Stump11289f42009-09-09 15:08:12 +0000866
John McCall7f9c92a2010-09-17 00:50:28 +0000867 /// isInConditionalBranch - Return true if we're currently emitting
868 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000869 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000870
John McCall7f416cc2015-09-08 08:05:57 +0000871 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000872 assert(isInConditionalBranch());
873 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000874 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
875 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000876 }
877
John McCallce1de612011-01-26 04:00:11 +0000878 /// An RAII object to record that we're evaluating a statement
879 /// expression.
880 class StmtExprEvaluation {
881 CodeGenFunction &CGF;
882
883 /// We have to save the outermost conditional: cleanups in a
884 /// statement expression aren't conditional just because the
885 /// StmtExpr is.
886 ConditionalEvaluation *SavedOutermostConditional;
887
888 public:
889 StmtExprEvaluation(CodeGenFunction &CGF)
890 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000891 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000892 }
893
894 ~StmtExprEvaluation() {
895 CGF.OutermostConditional = SavedOutermostConditional;
896 CGF.EnsureInsertPoint();
897 }
898 };
John McCall1bf58462011-02-16 08:02:54 +0000899
John McCallc07a0c72011-02-17 10:25:35 +0000900 /// An object which temporarily prevents a value from being
901 /// destroyed by aggressive peephole optimizations that assume that
902 /// all uses of a value have been realized in the IR.
903 class PeepholeProtection {
904 llvm::Instruction *Inst;
905 friend class CodeGenFunction;
906
907 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000908 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000909 };
John McCallc07a0c72011-02-17 10:25:35 +0000910
John McCallfe96e0b2011-11-06 09:01:30 +0000911 /// A non-RAII class containing all the information about a bound
912 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
913 /// this which makes individual mappings very simple; using this
914 /// class directly is useful when you have a variable number of
915 /// opaque values or don't want the RAII functionality for some
916 /// reason.
917 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000918 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000919 bool BoundLValue;
920 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000921
John McCallfe96e0b2011-11-06 09:01:30 +0000922 OpaqueValueMappingData(const OpaqueValueExpr *ov,
923 bool boundLValue)
924 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000925 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000926 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000927
John McCallc07a0c72011-02-17 10:25:35 +0000928 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000929 // gl-values should be bound as l-values for obvious reasons.
930 // Records should be bound as l-values because IR generation
931 // always keeps them in memory. Expressions of function type
932 // act exactly like l-values but are formally required to be
933 // r-values in C.
934 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000935 expr->getType()->isFunctionType() ||
936 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000937 }
938
John McCallfe96e0b2011-11-06 09:01:30 +0000939 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
940 const OpaqueValueExpr *ov,
941 const Expr *e) {
942 if (shouldBindAsLValue(ov))
943 return bind(CGF, ov, CGF.EmitLValue(e));
944 return bind(CGF, ov, CGF.EmitAnyExpr(e));
945 }
946
947 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
948 const OpaqueValueExpr *ov,
949 const LValue &lv) {
950 assert(shouldBindAsLValue(ov));
951 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
952 return OpaqueValueMappingData(ov, true);
953 }
954
955 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
956 const OpaqueValueExpr *ov,
957 const RValue &rv) {
958 assert(!shouldBindAsLValue(ov));
959 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
960
961 OpaqueValueMappingData data(ov, false);
962
963 // Work around an extremely aggressive peephole optimization in
964 // EmitScalarConversion which assumes that all other uses of a
965 // value are extant.
966 data.Protection = CGF.protectFromPeepholes(rv);
967
968 return data;
969 }
970
Craig Topper8a13c412014-05-21 05:09:00 +0000971 bool isValid() const { return OpaqueValue != nullptr; }
972 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000973
974 void unbind(CodeGenFunction &CGF) {
975 assert(OpaqueValue && "no data to unbind!");
976
977 if (BoundLValue) {
978 CGF.OpaqueLValues.erase(OpaqueValue);
979 } else {
980 CGF.OpaqueRValues.erase(OpaqueValue);
981 CGF.unprotectFromPeepholes(Protection);
982 }
983 }
984 };
985
986 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
987 class OpaqueValueMapping {
988 CodeGenFunction &CGF;
989 OpaqueValueMappingData Data;
990
991 public:
992 static bool shouldBindAsLValue(const Expr *expr) {
993 return OpaqueValueMappingData::shouldBindAsLValue(expr);
994 }
995
John McCallc07a0c72011-02-17 10:25:35 +0000996 /// Build the opaque value mapping for the given conditional
997 /// operator if it's the GNU ?: extension. This is a common
998 /// enough pattern that the convenience operator is really
999 /// helpful.
1000 ///
1001 OpaqueValueMapping(CodeGenFunction &CGF,
1002 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +00001003 if (isa<ConditionalOperator>(op))
1004 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001005 return;
John McCallc07a0c72011-02-17 10:25:35 +00001006
1007 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001008 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1009 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001010 }
1011
Richard Smith410306b2016-12-12 02:53:20 +00001012 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1013 /// expression is set to the expression the OVE represents.
1014 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1015 : CGF(CGF) {
1016 if (OV) {
1017 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1018 "for OVE with no source expression");
1019 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1020 }
1021 }
1022
John McCall1bf58462011-02-16 08:02:54 +00001023 OpaqueValueMapping(CodeGenFunction &CGF,
1024 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001025 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001026 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001027 }
1028
1029 OpaqueValueMapping(CodeGenFunction &CGF,
1030 const OpaqueValueExpr *opaqueValue,
1031 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001032 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001033 }
1034
1035 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001036 Data.unbind(CGF);
1037 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001038 }
1039
1040 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001041 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001042 }
1043 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +00001044
Chris Lattner2da04b32007-08-24 05:35:26 +00001045private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001046 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001047 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001048
John McCall9b382dd2011-05-28 21:13:02 +00001049 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1050 /// calling llvm.stacksave for multiple VLAs in the same scope.
1051 bool DidCallStackSave;
1052
Mike Stumpe5311b02009-11-30 20:08:49 +00001053 /// IndirectBranch - The first time an indirect goto is seen we create a block
1054 /// with an indirect branch. Every time we see the address of a label taken,
1055 /// we add the label to the indirect goto. Every subsequent indirect goto is
1056 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +00001057 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001058
Mike Stumpfc496822009-02-08 23:14:22 +00001059 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1060 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001061 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001062
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001063 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1064 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1065 /// parameter.
1066 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1067 SizeArguments;
1068
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001069 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001070 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001071 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1072
Chris Lattnerac248202007-05-30 00:13:02 +00001073 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001074 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001075
Mike Stumpfc496822009-02-08 23:14:22 +00001076 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001077 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001078 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001079 BreakContinue(JumpDest Break, JumpDest Continue)
1080 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001081
John McCallbd309292010-07-06 01:34:17 +00001082 JumpDest BreakBlock;
1083 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001084 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001085 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001086
Alexey Bataev957d8562016-11-17 15:12:05 +00001087 /// Handles cancellation exit points in OpenMP-related constructs.
1088 class OpenMPCancelExitStack {
1089 /// Tracks cancellation exit point and join point for cancel-related exit
1090 /// and normal exit.
1091 struct CancelExit {
1092 CancelExit() = default;
1093 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1094 JumpDest ContBlock)
1095 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1096 OpenMPDirectiveKind Kind = OMPD_unknown;
1097 /// true if the exit block has been emitted already by the special
1098 /// emitExit() call, false if the default codegen is used.
1099 bool HasBeenEmitted = false;
1100 JumpDest ExitBlock;
1101 JumpDest ContBlock;
1102 };
1103
1104 SmallVector<CancelExit, 8> Stack;
1105
1106 public:
1107 OpenMPCancelExitStack() : Stack(1) {}
1108 ~OpenMPCancelExitStack() = default;
1109 /// Fetches the exit block for the current OpenMP construct.
1110 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1111 /// Emits exit block with special codegen procedure specific for the related
1112 /// OpenMP construct + emits code for normal construct cleanup.
1113 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1114 const llvm::function_ref<void(CodeGenFunction &)> &CodeGen) {
1115 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1116 assert(CGF.getOMPCancelDestination(Kind).isValid());
1117 assert(CGF.HaveInsertPoint());
1118 assert(!Stack.back().HasBeenEmitted);
1119 auto IP = CGF.Builder.saveAndClearIP();
1120 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1121 CodeGen(CGF);
Erich Keane0026ed22017-07-27 16:28:20 +00001122 CGF.EmitBranch(Stack.back().ContBlock.getBlock());
Alexey Bataev957d8562016-11-17 15:12:05 +00001123 CGF.Builder.restoreIP(IP);
1124 Stack.back().HasBeenEmitted = true;
1125 }
1126 CodeGen(CGF);
1127 }
1128 /// Enter the cancel supporting \a Kind construct.
1129 /// \param Kind OpenMP directive that supports cancel constructs.
1130 /// \param HasCancel true, if the construct has inner cancel directive,
1131 /// false otherwise.
1132 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1133 Stack.push_back({Kind,
1134 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1135 : JumpDest(),
1136 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1137 : JumpDest()});
1138 }
1139 /// Emits default exit point for the cancel construct (if the special one
1140 /// has not be used) + join point for cancel/normal exits.
1141 void exit(CodeGenFunction &CGF) {
1142 if (getExitBlock().isValid()) {
1143 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1144 bool HaveIP = CGF.HaveInsertPoint();
1145 if (!Stack.back().HasBeenEmitted) {
1146 if (HaveIP)
1147 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1148 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1149 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1150 }
1151 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1152 if (!HaveIP) {
1153 CGF.Builder.CreateUnreachable();
1154 CGF.Builder.ClearInsertionPoint();
1155 }
1156 }
1157 Stack.pop_back();
1158 }
1159 };
1160 OpenMPCancelExitStack OMPCancelStack;
1161
1162 /// Controls insertion of cancellation exit blocks in worksharing constructs.
1163 class OMPCancelStackRAII {
1164 CodeGenFunction &CGF;
1165
1166 public:
1167 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1168 bool HasCancel)
1169 : CGF(CGF) {
1170 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
1171 }
1172 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
1173 };
1174
Justin Bogneref512b92014-01-06 22:27:43 +00001175 CodeGenPGO PGO;
1176
Justin Bogner65512642015-05-02 05:00:55 +00001177 /// Calculate branch weights appropriate for PGO data
1178 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1179 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1180 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1181 uint64_t LoopCount);
1182
Justin Bogneref512b92014-01-06 22:27:43 +00001183public:
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001184 /// Increment the profiler's counter for the given statement by \p StepV.
1185 /// If \p StepV is null, the default increment is 1.
1186 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
Rong Xu9837ef52016-02-04 18:39:09 +00001187 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001188 PGO.emitCounterIncrement(Builder, S, StepV);
Justin Bogner66242d62015-04-23 23:06:47 +00001189 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001190 }
Justin Bogner66242d62015-04-23 23:06:47 +00001191
1192 /// Get the profiler's count for the given statement.
1193 uint64_t getProfileCount(const Stmt *S) {
1194 Optional<uint64_t> Count = PGO.getStmtCount(S);
1195 if (!Count.hasValue())
1196 return 0;
1197 return *Count;
1198 }
1199
1200 /// Set the profiler's current count.
1201 void setCurrentProfileCount(uint64_t Count) {
1202 PGO.setCurrentRegionCount(Count);
1203 }
1204
1205 /// Get the profiler's current count. This is generally the count for the most
1206 /// recently incremented counter.
1207 uint64_t getCurrentProfileCount() {
1208 return PGO.getCurrentRegionCount();
1209 }
1210
Justin Bogneref512b92014-01-06 22:27:43 +00001211private:
1212
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001213 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001214 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001215 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001216 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1217 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001218
Mike Stumpfc496822009-02-08 23:14:22 +00001219 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001220 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001221 llvm::BasicBlock *CaseRangeBlock;
1222
John McCallc07a0c72011-02-17 10:25:35 +00001223 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001224 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001225 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1226 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001227
Mike Stumpfc496822009-02-08 23:14:22 +00001228 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001229 // We track this by the size expression rather than the type itself because
1230 // in certain situations, like a const qualifier applied to an VLA typedef,
1231 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001232 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1233 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001234 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001235
John McCallbd309292010-07-06 01:34:17 +00001236 /// A block containing a single 'unreachable' instruction. Created
1237 /// lazily by getUnreachableBlock().
1238 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001239
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001240 /// Counts of the number return expressions in the function.
1241 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001242
1243 /// Count the number of simple (constant) return expressions in the function.
1244 unsigned NumSimpleReturnExprs;
1245
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001246 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001247 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001248
Richard Smith852c9db2013-04-20 22:23:05 +00001249public:
1250 /// A scope within which we are constructing the fields of an object which
1251 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1252 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1253 class FieldConstructionScope {
1254 public:
John McCall7f416cc2015-09-08 08:05:57 +00001255 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001256 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1257 CGF.CXXDefaultInitExprThis = This;
1258 }
1259 ~FieldConstructionScope() {
1260 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1261 }
1262
1263 private:
1264 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001265 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001266 };
1267
1268 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1269 /// is overridden to be the object under construction.
1270 class CXXDefaultInitExprScope {
1271 public:
1272 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001273 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1274 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1275 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1276 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001277 }
1278 ~CXXDefaultInitExprScope() {
1279 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001280 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001281 }
1282
1283 public:
1284 CodeGenFunction &CGF;
1285 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001286 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001287 };
1288
Richard Smith410306b2016-12-12 02:53:20 +00001289 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1290 /// current loop index is overridden.
1291 class ArrayInitLoopExprScope {
1292 public:
1293 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1294 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1295 CGF.ArrayInitIndex = Index;
1296 }
1297 ~ArrayInitLoopExprScope() {
1298 CGF.ArrayInitIndex = OldArrayInitIndex;
1299 }
1300
1301 private:
1302 CodeGenFunction &CGF;
1303 llvm::Value *OldArrayInitIndex;
1304 };
1305
Richard Smith5179eb72016-06-28 19:03:57 +00001306 class InlinedInheritingConstructorScope {
1307 public:
1308 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1309 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1310 OldCurCodeDecl(CGF.CurCodeDecl),
1311 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1312 OldCXXABIThisValue(CGF.CXXABIThisValue),
1313 OldCXXThisValue(CGF.CXXThisValue),
1314 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1315 OldCXXThisAlignment(CGF.CXXThisAlignment),
1316 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1317 OldCXXInheritedCtorInitExprArgs(
1318 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1319 CGF.CurGD = GD;
1320 CGF.CurFuncDecl = CGF.CurCodeDecl =
1321 cast<CXXConstructorDecl>(GD.getDecl());
1322 CGF.CXXABIThisDecl = nullptr;
1323 CGF.CXXABIThisValue = nullptr;
1324 CGF.CXXThisValue = nullptr;
1325 CGF.CXXABIThisAlignment = CharUnits();
1326 CGF.CXXThisAlignment = CharUnits();
1327 CGF.ReturnValue = Address::invalid();
1328 CGF.FnRetTy = QualType();
1329 CGF.CXXInheritedCtorInitExprArgs.clear();
1330 }
1331 ~InlinedInheritingConstructorScope() {
1332 CGF.CurGD = OldCurGD;
1333 CGF.CurFuncDecl = OldCurFuncDecl;
1334 CGF.CurCodeDecl = OldCurCodeDecl;
1335 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1336 CGF.CXXABIThisValue = OldCXXABIThisValue;
1337 CGF.CXXThisValue = OldCXXThisValue;
1338 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1339 CGF.CXXThisAlignment = OldCXXThisAlignment;
1340 CGF.ReturnValue = OldReturnValue;
1341 CGF.FnRetTy = OldFnRetTy;
1342 CGF.CXXInheritedCtorInitExprArgs =
1343 std::move(OldCXXInheritedCtorInitExprArgs);
1344 }
1345
1346 private:
1347 CodeGenFunction &CGF;
1348 GlobalDecl OldCurGD;
1349 const Decl *OldCurFuncDecl;
1350 const Decl *OldCurCodeDecl;
1351 ImplicitParamDecl *OldCXXABIThisDecl;
1352 llvm::Value *OldCXXABIThisValue;
1353 llvm::Value *OldCXXThisValue;
1354 CharUnits OldCXXABIThisAlignment;
1355 CharUnits OldCXXThisAlignment;
1356 Address OldReturnValue;
1357 QualType OldFnRetTy;
1358 CallArgList OldCXXInheritedCtorInitExprArgs;
1359 };
1360
Richard Smith852c9db2013-04-20 22:23:05 +00001361private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001362 /// CXXThisDecl - When generating code for a C++ member function,
1363 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001364 ImplicitParamDecl *CXXABIThisDecl;
1365 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001366 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001367 CharUnits CXXABIThisAlignment;
1368 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001369
Richard Smith852c9db2013-04-20 22:23:05 +00001370 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1371 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001372 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001373
Richard Smith410306b2016-12-12 02:53:20 +00001374 /// The current array initialization index when evaluating an
1375 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1376 llvm::Value *ArrayInitIndex = nullptr;
1377
Richard Smith5179eb72016-06-28 19:03:57 +00001378 /// The values of function arguments to use when evaluating
1379 /// CXXInheritedCtorInitExprs within this context.
1380 CallArgList CXXInheritedCtorInitExprArgs;
1381
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001382 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1383 /// destructor, this will hold the implicit argument (e.g. VTT).
1384 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1385 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001386
John McCallce1de612011-01-26 04:00:11 +00001387 /// OutermostConditional - Points to the outermost active
1388 /// conditional control. This is used so that we know if a
1389 /// temporary should be destroyed conditionally.
1390 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001391
Nadav Rotem1da30942013-03-23 06:43:35 +00001392 /// The current lexical scope.
1393 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001394
Adrian Prantldc237b52013-05-16 00:41:26 +00001395 /// The current source location that should be used for exception
1396 /// handling code.
1397 SourceLocation CurEHLocation;
1398
John McCall7f416cc2015-09-08 08:05:57 +00001399 /// BlockByrefInfos - For each __block variable, contains
1400 /// information about the layout of the variable.
1401 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001402
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001403 /// Used by -fsanitize=nullability-return to determine whether the return
1404 /// value can be checked.
1405 llvm::Value *RetValNullabilityPrecondition = nullptr;
1406
1407 /// Check if -fsanitize=nullability-return instrumentation is required for
1408 /// this function.
1409 bool requiresReturnValueNullabilityCheck() const {
1410 return RetValNullabilityPrecondition;
1411 }
1412
Vedant Kumarc34d3432017-06-23 21:32:38 +00001413 /// Used to store precise source locations for return statements by the
1414 /// runtime return value checks.
1415 Address ReturnLocation = Address::invalid();
1416
1417 /// Check if the return value of this function requires sanitization.
1418 bool requiresReturnValueCheck() const {
1419 return requiresReturnValueNullabilityCheck() ||
1420 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
1421 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
1422 }
1423
John McCallbd309292010-07-06 01:34:17 +00001424 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001425 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001426 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001427
Vitaly Buka1c943322016-10-26 01:59:57 +00001428 /// True if we need emit the life-time markers.
1429 const bool ShouldEmitLifetimeMarkers;
1430
Xiuli Panbe6da4b2017-05-04 07:31:20 +00001431 /// Add OpenCL kernel arg metadata and the kernel attribute meatadata to
1432 /// the function metadata.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001433 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1434 llvm::Function *Fn);
1435
Chris Lattnerbed31442007-05-28 01:07:47 +00001436public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001437 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001438 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001439
John McCall8ed55a52010-09-02 09:58:18 +00001440 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001441 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001442 CGDebugInfo *getDebugInfo() {
1443 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001444 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001445 return DebugInfo;
1446 }
1447 void disableDebugInfo() { DisableDebugInfo = true; }
1448 void enableDebugInfo() { DisableDebugInfo = false; }
1449
John McCall31168b02011-06-15 23:02:42 +00001450 bool shouldUseFusedARCCalls() {
1451 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1452 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001453
David Blaikiebbafb8a2012-03-11 07:00:24 +00001454 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001455
Bill Wendlingf0724e82011-09-19 20:31:14 +00001456 /// Returns a pointer to the function's exception object and selector slot,
1457 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001458 Address getExceptionSlot();
1459 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001460
Bill Wendling79a70e42011-09-15 18:57:19 +00001461 /// Returns the contents of the function's exception object and selector
1462 /// slots.
1463 llvm::Value *getExceptionFromSlot();
1464 llvm::Value *getSelectorFromSlot();
1465
John McCall7f416cc2015-09-08 08:05:57 +00001466 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001467
John McCallbd309292010-07-06 01:34:17 +00001468 llvm::BasicBlock *getUnreachableBlock() {
1469 if (!UnreachableBlock) {
1470 UnreachableBlock = createBasicBlock("unreachable");
1471 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1472 }
1473 return UnreachableBlock;
1474 }
1475
1476 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001477 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001478 return getInvokeDestImpl();
1479 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001480
David Majnemer25eb1652016-03-01 19:42:53 +00001481 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001482
John McCallc8e01702013-04-16 22:48:15 +00001483 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001484 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Yaxun Liucbf647c2017-07-08 13:24:52 +00001485 const TargetCodeGenInfo &getTargetHooks() const {
1486 return CGM.getTargetCodeGenInfo();
1487 }
Owen Andersonae86c192009-07-13 04:10:07 +00001488
Daniel Dunbar12347492009-02-23 17:26:39 +00001489 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001490 // Cleanups
1491 //===--------------------------------------------------------------------===//
1492
John McCall7f416cc2015-09-08 08:05:57 +00001493 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001494
John McCall178360e2011-07-11 08:38:19 +00001495 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001496 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001497 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001498 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001499 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001500 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1501 llvm::Value *arrayEnd,
1502 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001503 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001504 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001505
John McCall4bd0fb12011-07-12 16:41:08 +00001506 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001507 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001508 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001509 Address addr, QualType type);
1510 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001511 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001512 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001513 QualType type, Destroyer *destroyer,
1514 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001515 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1516 llvm::Value *CompletePtr,
1517 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001518 void pushStackRestore(CleanupKind kind, Address SPMem);
1519 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001520 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001521 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001522 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001523 bool useEHCleanupForArray,
1524 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001525 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001526 QualType elementType, CharUnits elementAlign,
1527 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001528 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001529
Peter Collingbourne1425b452012-01-26 03:33:36 +00001530 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001531
John McCall82fe67b2011-07-09 01:37:26 +00001532 /// Determines whether an EH cleanup is required to destroy a type
1533 /// with the given destruction kind.
1534 bool needsEHCleanup(QualType::DestructionKind kind) {
1535 switch (kind) {
1536 case QualType::DK_none:
1537 return false;
1538 case QualType::DK_cxx_destructor:
1539 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001540 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001541 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001542 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001543 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1544 }
1545 llvm_unreachable("bad destruction kind");
1546 }
1547
John McCall4bd0fb12011-07-12 16:41:08 +00001548 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1549 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1550 }
1551
John McCall82fe67b2011-07-09 01:37:26 +00001552 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001553 // Objective-C
1554 //===--------------------------------------------------------------------===//
1555
Chris Lattner4bd55962008-03-30 23:03:07 +00001556 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001557
David Blaikief1425802015-01-14 00:04:42 +00001558 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001559
Mike Stumpfc496822009-02-08 23:14:22 +00001560 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001561 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1562 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001563 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001564 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001565 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001566 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001567
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001568 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1569 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001570
Mike Stumpfc496822009-02-08 23:14:22 +00001571 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1572 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001573 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1574 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001575 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001576 const ObjCPropertyImplDecl *propImpl,
1577 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001578
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001579 //===--------------------------------------------------------------------===//
1580 // Block Bits
1581 //===--------------------------------------------------------------------===//
1582
John McCall351762c2011-02-07 10:33:21 +00001583 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001584 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001585
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001586 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001587 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001588 const DeclMapTy &ldm,
Akira Hatanakaba0367a2017-09-22 21:32:06 +00001589 bool IsLambdaConversionToBlock,
1590 bool BuildGlobalBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001591
John McCallad7c5c12011-02-08 08:22:06 +00001592 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1593 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001594 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1595 const ObjCPropertyImplDecl *PID);
1596 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1597 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001598 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001599
John McCallad7c5c12011-02-08 08:22:06 +00001600 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1601
John McCall73064872011-03-31 01:59:53 +00001602 class AutoVarEmission;
1603
1604 void emitByrefStructureInit(const AutoVarEmission &emission);
1605 void enterByrefCleanup(const AutoVarEmission &emission);
1606
John McCall7f416cc2015-09-08 08:05:57 +00001607 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1608 llvm::Value *ptr);
1609
1610 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001611 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1612
1613 /// BuildBlockByrefAddress - Computes the location of the
1614 /// data in a variable which is declared as __block.
1615 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1616 bool followForward = true);
1617 Address emitBlockByrefAddress(Address baseAddr,
1618 const BlockByrefInfo &info,
1619 bool followForward,
1620 const llvm::Twine &name);
1621
1622 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001623
Richard Smith5179eb72016-06-28 19:03:57 +00001624 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1625
John McCalla738c252011-03-09 04:27:21 +00001626 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1627 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001628 /// \brief Emit code for the start of a function.
1629 /// \param Loc The location to be associated with the function.
1630 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001631 void StartFunction(GlobalDecl GD,
1632 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001633 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001634 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001635 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001636 SourceLocation Loc = SourceLocation(),
1637 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001638
Vedant Kumar7f809b22017-02-24 01:15:19 +00001639 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1640
John McCallb81884d2010-02-19 09:25:03 +00001641 void EmitConstructorBody(FunctionArgList &Args);
1642 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001643 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001644 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001645 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001646
Faisal Vali571df122013-09-29 08:45:24 +00001647 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001648 CallArgList &CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00001649 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001650 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001651 void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001652 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001653
David Blaikiea0a1a872015-01-18 02:48:07 +00001654 /// \brief Emit the unified return block, trying to avoid its emission when
1655 /// possible.
1656 /// \return The debug location of the user written return statement if the
1657 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001658 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001659
Mike Stumpfc496822009-02-08 23:14:22 +00001660 /// FinishFunction - Complete IR generation of the current function. It is
1661 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001662 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001663
Nico Weber1bebad12015-02-11 22:33:32 +00001664 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1665 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001666
John McCallb92ab1a2016-10-26 23:46:34 +00001667 void EmitCallAndReturnForThunk(llvm::Constant *Callee,
1668 const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001669
John McCall7f416cc2015-09-08 08:05:57 +00001670 void FinishThunk();
1671
Reid Klecknerab2090d2014-07-26 01:34:32 +00001672 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1673 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1674 llvm::Value *Callee);
1675
Rafael Espindolad6e66942015-07-13 06:07:58 +00001676 /// Generate a thunk for the given method.
1677 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001678 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001679
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001680 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1681 const CGFunctionInfo &FnInfo,
1682 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001683
Douglas Gregor94f9a482010-05-05 05:51:00 +00001684 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1685 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001686
Richard Smith30e304e2016-12-14 00:03:17 +00001687 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001688
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001689 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1690 struct VPtr {
1691 BaseSubobject Base;
1692 const CXXRecordDecl *NearestVBase;
1693 CharUnits OffsetFromNearestVBase;
1694 const CXXRecordDecl *VTableClass;
1695 };
1696
1697 /// Initialize the vtable pointer of the given subobject.
1698 void InitializeVTablePointer(const VPtr &vptr);
1699
1700 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001701
1702 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001703 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1704
1705 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1706 CharUnits OffsetFromNearestVBase,
1707 bool BaseIsNonVirtualPrimaryBase,
1708 const CXXRecordDecl *VTableClass,
1709 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001710
Anders Carlssond5895932010-03-28 21:07:49 +00001711 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001712
Dan Gohman8fc50c22010-10-26 18:44:08 +00001713 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1714 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001715 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1716 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001717
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001718 enum CFITypeCheckKind {
1719 CFITCK_VCall,
1720 CFITCK_NVCall,
1721 CFITCK_DerivedCast,
1722 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001723 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001724 };
1725
Peter Collingbourned2926c92015-03-14 02:42:25 +00001726 /// \brief Derived is the presumed address of an object of type T after a
1727 /// cast. If T is a polymorphic class type, emit a check that the virtual
1728 /// table for Derived belongs to a class derived from T.
1729 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001730 bool MayBeNull, CFITypeCheckKind TCK,
1731 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001732
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001733 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1734 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001735 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001736 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001737
Peter Collingbourned2926c92015-03-14 02:42:25 +00001738 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001739 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001740 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1741 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001742
Peter Collingbournefb532b92016-02-24 20:46:36 +00001743 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001744 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1745 /// enabled, emit a check that VTable is a member of RD's type identifier.
1746 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1747 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001748
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001749 /// Returns whether we should perform a type checked load when loading a
1750 /// virtual function for virtual calls to members of RD. This is generally
1751 /// true when both vcall CFI and whole-program-vtables are enabled.
1752 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1753
1754 /// Emit a type checked load from the given vtable.
1755 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1756 uint64_t VTableByteOffset);
1757
John McCallf99a6312010-07-21 05:30:47 +00001758 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1759 /// given phase of destruction for a destructor. The end result
1760 /// should call destructors on members and base classes in reverse
1761 /// order of their construction.
1762 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001763
Chris Lattner3c77a352010-06-22 00:03:40 +00001764 /// ShouldInstrumentFunction - Return true if the current function should be
1765 /// instrumented with __cyg_profile_func_* calls
1766 bool ShouldInstrumentFunction();
1767
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001768 /// ShouldXRayInstrument - Return true if the current function should be
1769 /// instrumented with XRay nop sleds.
1770 bool ShouldXRayInstrumentFunction() const;
1771
Chris Lattner3c77a352010-06-22 00:03:40 +00001772 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1773 /// instrumentation function with the current function and the call site, if
1774 /// function instrumentation is enabled.
1775 void EmitFunctionInstrumentation(const char *Fn);
1776
Roman Divacky178e01602011-02-10 16:52:03 +00001777 /// EmitMCountInstrumentation - Emit call to .mcount.
1778 void EmitMCountInstrumentation();
1779
Vedant Kumarbb5d4852017-09-13 00:04:35 +00001780 /// Encode an address into a form suitable for use in a function prologue.
1781 llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
1782 llvm::Constant *Addr);
1783
1784 /// Decode an address used in a function prologue, encoded by \c
1785 /// EncodeAddrForUseInPrologue.
1786 llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
1787 llvm::Value *EncodedAddr);
1788
Mike Stumpfc496822009-02-08 23:14:22 +00001789 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1790 /// arguments for the given function. This is also responsible for naming the
1791 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001792 void EmitFunctionProlog(const CGFunctionInfo &FI,
1793 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001794 const FunctionArgList &Args);
1795
Mike Stumpfc496822009-02-08 23:14:22 +00001796 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1797 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001798 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1799 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001800
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001801 /// Emit a test that checks if the return value \p RV is nonnull.
Vedant Kumarc34d3432017-06-23 21:32:38 +00001802 void EmitReturnValueCheck(llvm::Value *RV);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001803
Mike Stump1d849212009-12-07 23:38:24 +00001804 /// EmitStartEHSpec - Emit the start of the exception spec.
1805 void EmitStartEHSpec(const Decl *D);
1806
1807 /// EmitEndEHSpec - Emit the end of the exception spec.
1808 void EmitEndEHSpec(const Decl *D);
1809
John McCallbd309292010-07-06 01:34:17 +00001810 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1811 llvm::BasicBlock *getTerminateLandingPad();
1812
1813 /// getTerminateHandler - Return a handler (not a landing pad, just
1814 /// a catch handler) that just calls terminate. This is used when
1815 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001816 llvm::BasicBlock *getTerminateHandler();
1817
Chris Lattnera5f58b02011-07-09 17:41:47 +00001818 llvm::Type *ConvertTypeForMem(QualType T);
1819 llvm::Type *ConvertType(QualType T);
1820 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001821 return ConvertType(getContext().getTypeDeclType(T));
1822 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001823
Mike Stumpfc496822009-02-08 23:14:22 +00001824 /// LoadObjCSelf - Load the value of self. This function is only valid while
1825 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001826 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001827
1828 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001829 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001830
Krasimir Georgiev46dfb7a2017-09-08 13:44:51 +00001831 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
John McCall47fb9502013-03-07 21:37:08 +00001832 static TypeEvaluationKind getEvaluationKind(QualType T);
1833
1834 static bool hasScalarEvaluationKind(QualType T) {
1835 return getEvaluationKind(T) == TEK_Scalar;
1836 }
1837
1838 static bool hasAggregateEvaluationKind(QualType T) {
1839 return getEvaluationKind(T) == TEK_Aggregate;
1840 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001841
1842 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001843 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001844 llvm::Function *parent = nullptr,
1845 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001846#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001847 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001848#else
John McCallad7c5c12011-02-08 08:22:06 +00001849 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001850#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001851 }
Mike Stumpfc496822009-02-08 23:14:22 +00001852
Chris Lattnerac248202007-05-30 00:13:02 +00001853 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1854 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001855 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001856
Mike Stumpe5311b02009-11-30 20:08:49 +00001857 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1858 /// another basic block, simplify it. This assumes that no other code could
1859 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001860 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1861
Mike Stumpfc496822009-02-08 23:14:22 +00001862 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1863 /// adding a fall-through branch from the current insert block if
1864 /// necessary. It is legal to call this function even if there is no current
1865 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001866 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001867 /// IsFinished - If true, indicates that the caller has finished emitting
1868 /// branches to the given block and does not expect to emit code into it. This
1869 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001870 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001871
John McCall8e4c74b2011-08-11 02:22:43 +00001872 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1873 /// near its uses, and leave the insertion point in it.
1874 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1875
Mike Stumpfc496822009-02-08 23:14:22 +00001876 /// EmitBranch - Emit a branch to the specified basic block from the current
1877 /// insert block, taking care to avoid creation of branches from dummy
1878 /// blocks. It is legal to call this function even if there is no current
1879 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001880 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001881 /// This function clears the current insertion point. The caller should follow
1882 /// calls to this function with calls to Emit*Block prior to generation new
1883 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001884 void EmitBranch(llvm::BasicBlock *Block);
1885
Mike Stumpfc496822009-02-08 23:14:22 +00001886 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1887 /// indicates that the current code being emitted is unreachable.
1888 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001889 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001890 }
1891
Mike Stumpfc496822009-02-08 23:14:22 +00001892 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1893 /// emitted IR has a place to go. Note that by definition, if this function
1894 /// creates a block then that block is unreachable; callers may do better to
1895 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001896 void EnsureInsertPoint() {
1897 if (!HaveInsertPoint())
1898 EmitBlock(createBasicBlock());
1899 }
Mike Stumpfc496822009-02-08 23:14:22 +00001900
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001901 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001902 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001903 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001904
Chris Lattnere9a64532007-06-22 21:44:33 +00001905 //===--------------------------------------------------------------------===//
1906 // Helpers
1907 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001908
John McCall7f416cc2015-09-08 08:05:57 +00001909 LValue MakeAddrLValue(Address Addr, QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001910 LValueBaseInfo BaseInfo =
1911 LValueBaseInfo(AlignmentSource::Type)) {
1912 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo,
Ivan A. Kosarev289574e2017-10-02 09:54:47 +00001913 CGM.getTBAATypeInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001914 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001915
John McCall7f416cc2015-09-08 08:05:57 +00001916 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001917 LValueBaseInfo BaseInfo =
1918 LValueBaseInfo(AlignmentSource::Type)) {
John McCall7f416cc2015-09-08 08:05:57 +00001919 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarev289574e2017-10-02 09:54:47 +00001920 BaseInfo, CGM.getTBAATypeInfo(T));
John McCall7f416cc2015-09-08 08:05:57 +00001921 }
1922
1923 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001924 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001925 CharUnits getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001926 LValueBaseInfo *BaseInfo = nullptr,
John McCall7f416cc2015-09-08 08:05:57 +00001927 bool forPointeeType = false);
1928 CharUnits getNaturalPointeeTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001929 LValueBaseInfo *BaseInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001930
1931 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001932 LValueBaseInfo *BaseInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001933 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001934
Alexey Bataev31300ed2016-02-04 11:27:03 +00001935 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001936 LValueBaseInfo *BaseInfo = nullptr);
Alexey Bataev31300ed2016-02-04 11:27:03 +00001937 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1938
Yaxun Liu84744c12017-06-19 17:03:41 +00001939 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
1940 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
1941 /// insertion point of the builder. The caller is responsible for setting an
1942 /// appropriate alignment on
Daniel Dunbara7566f12010-02-09 02:48:28 +00001943 /// the alloca.
Yaxun Liu84744c12017-06-19 17:03:41 +00001944 ///
1945 /// \p ArraySize is the number of array elements to be allocated if it
1946 /// is not nullptr.
1947 ///
1948 /// LangAS::Default is the address space of pointers to local variables and
1949 /// temporaries, as exposed in the source language. In certain
1950 /// configurations, this is not the same as the alloca address space, and a
1951 /// cast is needed to lift the pointer from the alloca AS into
1952 /// LangAS::Default. This can happen when the target uses a restricted
1953 /// address space for the stack but the source language requires
1954 /// LangAS::Default to be a generic address space. The latter condition is
1955 /// common for most programming languages; OpenCL is an exception in that
1956 /// LangAS::Default is the private address space, which naturally maps
1957 /// to the stack.
1958 ///
1959 /// Because the address of a temporary is often exposed to the program in
1960 /// various ways, this function will perform the cast by default. The cast
1961 /// may be avoided by passing false as \p CastToDefaultAddrSpace; this is
1962 /// more efficient if the caller knows that the address will not be exposed.
1963 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
1964 llvm::Value *ArraySize = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001965 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
Yaxun Liu84744c12017-06-19 17:03:41 +00001966 const Twine &Name = "tmp",
1967 llvm::Value *ArraySize = nullptr,
1968 bool CastToDefaultAddrSpace = true);
Mike Stumpfc496822009-02-08 23:14:22 +00001969
John McCall7f416cc2015-09-08 08:05:57 +00001970 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1971 /// default ABI alignment of the given LLVM type.
1972 ///
1973 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1974 /// any given AST type that happens to have been lowered to the
1975 /// given IR type. This should only ever be used for function-local,
1976 /// IR-driven manipulations like saving and restoring a value. Do
1977 /// not hand this address off to arbitrary IRGen routines, and especially
1978 /// do not pass it as an argument to a function that might expect a
1979 /// properly ABI-aligned value.
1980 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1981 const Twine &Name = "tmp");
1982
1983 /// InitTempAlloca - Provide an initial value for the given alloca which
1984 /// will be observable at all locations in the function.
1985 ///
1986 /// The address should be something that was returned from one of
1987 /// the CreateTempAlloca or CreateMemTemp routines, and the
1988 /// initializer must be valid in the entry block (i.e. it must
1989 /// either be a constant or an argument value).
1990 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001991
Daniel Dunbard0049182010-02-16 19:44:13 +00001992 /// CreateIRTemp - Create a temporary IR object of the given type, with
1993 /// appropriate alignment. This routine should only be used when an temporary
1994 /// value needs to be stored into an alloca (for example, to avoid explicit
1995 /// PHI construction), but the type is the IR type, not the type appropriate
1996 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001997 ///
1998 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1999 /// ConvertType instead of ConvertTypeForMem.
2000 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00002001
Daniel Dunbara7566f12010-02-09 02:48:28 +00002002 /// CreateMemTemp - Create a temporary memory object of the given type, with
Yaxun Liu84744c12017-06-19 17:03:41 +00002003 /// appropriate alignment. Cast it to the default address space if
2004 /// \p CastToDefaultAddrSpace is true.
2005 Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
2006 bool CastToDefaultAddrSpace = true);
2007 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
2008 bool CastToDefaultAddrSpace = true);
Daniel Dunbara7566f12010-02-09 02:48:28 +00002009
John McCall7a626f62010-09-15 10:14:12 +00002010 /// CreateAggTemp - Create a temporary memory object for the given
2011 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00002012 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00002013 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00002014 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00002015 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00002016 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002017 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00002018 }
2019
John McCallad7c5c12011-02-08 08:22:06 +00002020 /// Emit a cast to void* in the appropriate address space.
2021 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2022
Chris Lattner8394d792007-06-05 20:53:16 +00002023 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2024 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00002025 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00002026
John McCalla2342eb2010-12-05 02:00:02 +00002027 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2028 void EmitIgnoredExpr(const Expr *E);
2029
Chris Lattner4647a212007-08-31 22:49:20 +00002030 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2031 /// any type. The result is returned as an RValue struct. If this is an
2032 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2033 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00002034 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00002035 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00002036 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00002037 AggValueSlot aggSlot = AggValueSlot::ignored(),
2038 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00002039
Mike Stumpfc496822009-02-08 23:14:22 +00002040 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2041 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00002042 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002043
Charles Davisc7d5c942015-09-17 20:55:33 +00002044 /// Emit a "reference" to a __builtin_ms_va_list; this is
2045 /// always the value of the expression, because a __builtin_ms_va_list is a
2046 /// pointer to a char.
2047 Address EmitMSVAListRef(const Expr *E);
2048
Gor Nishanov5eb58582017-03-26 02:18:05 +00002049 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
Mike Stumpfc496822009-02-08 23:14:22 +00002050 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00002051 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00002052
John McCall91ca10f2011-03-08 09:11:50 +00002053 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00002054 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00002055 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002056 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00002057
John McCall7f416cc2015-09-08 08:05:57 +00002058 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00002059
John McCall91ca10f2011-03-08 09:11:50 +00002060 /// EmitExprAsInit - Emits the code necessary to initialize a
2061 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00002062 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002063 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00002064
Fariborz Jahanian78652202013-01-25 23:57:05 +00002065 /// hasVolatileMember - returns true if aggregate type has a volatile
2066 /// member.
2067 bool hasVolatileMember(QualType T) {
2068 if (const RecordType *RT = T->getAs<RecordType>()) {
2069 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2070 return RD->hasVolatileMember();
2071 }
2072 return false;
2073 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002074 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002075 ///
2076 /// The difference to EmitAggregateCopy is that tail padding is not copied.
2077 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00002078 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00002079 QualType EltTy) {
2080 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00002081 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002082 }
2083
John McCall7f416cc2015-09-08 08:05:57 +00002084 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
2085 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00002086 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00002087 /*IsAssignment=*/false);
2088 }
2089
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002090 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00002091 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00002092 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00002093 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002094 /// \param isAssignment - If false, allow padding to be copied. This often
2095 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00002096 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00002097 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002098 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00002099
Anders Carlsson9396a892008-09-11 09:15:33 +00002100 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00002101 Address GetAddrOfLocalVar(const VarDecl *VD) {
2102 auto it = LocalDeclMap.find(VD);
2103 assert(it != LocalDeclMap.end() &&
2104 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2105 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00002106 }
Mike Stumpfc496822009-02-08 23:14:22 +00002107
John McCallc07a0c72011-02-17 10:25:35 +00002108 /// getOpaqueLValueMapping - Given an opaque value expression (which
2109 /// must be mapped to an l-value), return its mapping.
2110 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
2111 assert(OpaqueValueMapping::shouldBindAsLValue(e));
2112
2113 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
2114 it = OpaqueLValues.find(e);
2115 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
2116 return it->second;
2117 }
2118
2119 /// getOpaqueRValueMapping - Given an opaque value expression (which
2120 /// must be mapped to an r-value), return its mapping.
2121 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
2122 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
2123
2124 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
2125 it = OpaqueRValues.find(e);
2126 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00002127 return it->second;
2128 }
2129
Richard Smith410306b2016-12-12 02:53:20 +00002130 /// Get the index of the current ArrayInitLoopExpr, if any.
2131 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2132
Dan Gohman75d69da2008-05-22 00:50:06 +00002133 /// getAccessedFieldNo - Given an encoded value and a result number, return
2134 /// the input field number being accessed.
2135 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2136
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002137 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002138 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002139
Vedant Kumarffd7c882017-04-14 22:03:34 +00002140 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2141 static bool IsWrappedCXXThis(const Expr *E);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00002142
Anders Carlssonc0964b62010-05-22 17:35:42 +00002143 /// EmitNullInitialization - Generate code to set a value of the given type to
2144 /// null, If the type contains data member pointers, they will be initialized
2145 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002146 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002147
Charles Davisc7d5c942015-09-17 20:55:33 +00002148 /// Emits a call to an LLVM variable-argument intrinsic, either
2149 /// \c llvm.va_start or \c llvm.va_end.
2150 /// \param ArgValue A reference to the \c va_list as emitted by either
2151 /// \c EmitVAListRef or \c EmitMSVAListRef.
2152 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2153 /// calls \c llvm.va_end.
2154 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2155
2156 /// Generate code to get an argument from the passed in pointer
2157 /// and update it accordingly.
2158 /// \param VE The \c VAArgExpr for which to generate code.
2159 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2160 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2161 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002162 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002163 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002164 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002165
John McCall82fe67b2011-07-09 01:37:26 +00002166 /// emitArrayLength - Compute the length of an array, even if it's a
2167 /// VLA, and drill down to the base element type.
2168 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2169 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002170 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002171
John McCall23c29fe2011-06-24 21:55:10 +00002172 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2173 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002174 ///
2175 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002176 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002177
John McCall23c29fe2011-06-24 21:55:10 +00002178 /// getVLASize - Returns an LLVM value that corresponds to the size,
2179 /// in non-variably-sized elements, of a variable length array type,
2180 /// plus that largest non-variably-sized element type. Assumes that
2181 /// the type has already been emitted with EmitVariablyModifiedType.
2182 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
2183 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002184
Anders Carlssona5d077d2009-04-14 16:58:56 +00002185 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2186 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002187 llvm::Value *LoadCXXThis() {
2188 assert(CXXThisValue && "no 'this' value for this function");
2189 return CXXThisValue;
2190 }
John McCall7f416cc2015-09-08 08:05:57 +00002191 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002192
Anders Carlssone36a6b32010-01-02 01:01:18 +00002193 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2194 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002195 // FIXME: Every place that calls LoadCXXVTT is something
2196 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002197 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002198 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2199 return CXXStructorImplicitParamValue;
2200 }
2201
John McCall6ce74722010-02-16 04:15:37 +00002202 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002203 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002204 Address
2205 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002206 const CXXRecordDecl *Derived,
2207 const CXXRecordDecl *Base,
2208 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002209
John McCall7f416cc2015-09-08 08:05:57 +00002210 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2211
Mike Stumpe5311b02009-11-30 20:08:49 +00002212 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2213 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002214 Address GetAddressOfBaseClass(Address Value,
2215 const CXXRecordDecl *Derived,
2216 CastExpr::path_const_iterator PathBegin,
2217 CastExpr::path_const_iterator PathEnd,
2218 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002219
John McCall7f416cc2015-09-08 08:05:57 +00002220 Address GetAddressOfDerivedClass(Address Value,
2221 const CXXRecordDecl *Derived,
2222 CastExpr::path_const_iterator PathBegin,
2223 CastExpr::path_const_iterator PathEnd,
2224 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002225
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002226 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2227 /// base constructor/destructor with virtual bases.
2228 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2229 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2230 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2231 bool Delegating);
2232
John McCallf8ff7b92010-02-23 00:48:20 +00002233 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2234 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002235 const FunctionArgList &Args,
2236 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002237 // It's important not to confuse this and the previous function. Delegating
2238 // constructors are the C++0x feature. The constructor delegate optimization
2239 // is used to reduce duplication in the base and complete consturctors where
2240 // they are substantially the same.
2241 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2242 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002243
Richard Smith5179eb72016-06-28 19:03:57 +00002244 /// Emit a call to an inheriting constructor (that is, one that invokes a
2245 /// constructor inherited from a base class) by inlining its definition. This
2246 /// is necessary if the ABI does not support forwarding the arguments to the
2247 /// base class constructor (because they're variadic or similar).
2248 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2249 CXXCtorType CtorType,
2250 bool ForVirtualBase,
2251 bool Delegating,
2252 CallArgList &Args);
2253
2254 /// Emit a call to a constructor inherited from a base class, passing the
2255 /// current constructor's arguments along unmodified (without even making
2256 /// a copy).
2257 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2258 bool ForVirtualBase, Address This,
2259 bool InheritedFromVBase,
2260 const CXXInheritedCtorInitExpr *E);
2261
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002262 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002263 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002264 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002265
Richard Smith5179eb72016-06-28 19:03:57 +00002266 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2267 bool ForVirtualBase, bool Delegating,
2268 Address This, CallArgList &Args);
2269
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002270 /// Emit assumption load for all bases. Requires to be be called only on
2271 /// most-derived class and not under construction of the object.
2272 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2273
2274 /// Emit assumption that vptr load == global vtable.
2275 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2276
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002277 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002278 Address This, Address Src,
2279 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002280
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002281 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002282 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002283 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002284 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002285 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002286
Anders Carlssond49844b2009-09-23 02:45:36 +00002287 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2288 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002289 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002290 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002291 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002292
John McCall82fe67b2011-07-09 01:37:26 +00002293 static Destroyer destroyCXXObject;
2294
Anders Carlsson0a637412009-05-29 21:03:38 +00002295 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002296 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002297 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002298
John McCall99210dc2011-09-15 06:49:18 +00002299 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002300 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002301 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002302 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002303
Peter Collingbourne702b2842011-11-27 22:09:22 +00002304 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002305 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002306
David Majnemerdc012fa2015-04-22 21:38:15 +00002307 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2308 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2309
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002310 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002311 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002312
Eli Friedman24f55432009-11-18 00:57:03 +00002313 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002314 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2315 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002316
Richard Smith760520b2014-06-03 23:27:44 +00002317 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2318 const Expr *Arg, bool IsDelete);
2319
John McCall7f416cc2015-09-08 08:05:57 +00002320 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2321 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2322 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002323
Richard Smith69d0d262012-08-24 00:54:33 +00002324 /// \brief Situations in which we might emit a check for the suitability of a
2325 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002326 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002327 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002328 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002329 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002330 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002331 /// Checking the bound value in a reference binding. Must be suitably sized
2332 /// and aligned, but is not required to refer to an object (until the
2333 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002334 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002335 /// Checking the object expression in a non-static data member access. Must
2336 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002337 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002338 /// Checking the 'this' pointer for a call to a non-static member function.
2339 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002340 TCK_MemberCall,
2341 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002342 TCK_ConstructorCall,
2343 /// Checking the operand of a static_cast to a derived pointer type. Must be
2344 /// null or an object within its lifetime.
2345 TCK_DowncastPointer,
2346 /// Checking the operand of a static_cast to a derived reference type. Must
2347 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002348 TCK_DowncastReference,
2349 /// Checking the operand of a cast to a base object. Must be suitably sized
2350 /// and aligned.
2351 TCK_Upcast,
2352 /// Checking the operand of a cast to a virtual base object. Must be an
2353 /// object within its lifetime.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002354 TCK_UpcastToVirtualBase,
2355 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
2356 TCK_NonnullAssign
Richard Smith69d0d262012-08-24 00:54:33 +00002357 };
2358
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002359 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2360 /// calls to EmitTypeCheck can be skipped.
2361 bool sanitizePerformTypeCheck() const;
2362
Richard Smith4d1458e2012-09-08 02:08:36 +00002363 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002364 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002365 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002366 QualType Type, CharUnits Alignment = CharUnits::Zero(),
Vedant Kumar18348ea2017-02-17 23:22:55 +00002367 SanitizerSet SkippedChecks = SanitizerSet());
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002368
Richard Smith539e4a72013-02-23 02:53:19 +00002369 /// \brief Emit a check that \p Base points into an array object, which
2370 /// we can access at index \p Index. \p Accessed should be \c false if we
2371 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2372 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2373 QualType IndexType, bool Accessed);
2374
Chris Lattner116ce8f2010-01-09 21:40:03 +00002375 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2376 bool isInc, bool isPre);
2377 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2378 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002379
2380 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002381 llvm::Value *OffsetValue = nullptr) {
2382 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2383 OffsetValue);
2384 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002385
Amara Emerson652795d2016-11-10 14:44:30 +00002386 /// Converts Location to a DebugLoc, if debug information is enabled.
2387 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2388
2389
Chris Lattner8394d792007-06-05 20:53:16 +00002390 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002391 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002392 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002393
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002394 /// EmitDecl - Emit a declaration.
2395 ///
2396 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002397 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002398
John McCall1c9c3fd2010-10-15 04:57:14 +00002399 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002400 ///
2401 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002402 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002403
David Blaikie73ca5692014-12-09 00:32:22 +00002404 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002405 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002406
John McCallbd309292010-07-06 01:34:17 +00002407 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2408 llvm::Value *Address);
2409
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002410 /// \brief Determine whether the given initializer is trivial in the sense
2411 /// that it requires no code to be generated.
2412 bool isTrivialInitializer(const Expr *Init);
2413
John McCall1c9c3fd2010-10-15 04:57:14 +00002414 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002415 ///
2416 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002417 void EmitAutoVarDecl(const VarDecl &D);
2418
2419 class AutoVarEmission {
2420 friend class CodeGenFunction;
2421
John McCall9e2e22f2011-02-22 07:16:58 +00002422 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002423
John McCall7f416cc2015-09-08 08:05:57 +00002424 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002425 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002426 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002427
2428 llvm::Value *NRVOFlag;
2429
2430 /// True if the variable is a __block variable.
2431 bool IsByRef;
2432
2433 /// True if the variable is of aggregate type and has a constant
2434 /// initializer.
2435 bool IsConstantAggregate;
2436
Nadav Rotem1da30942013-03-23 06:43:35 +00002437 /// Non-null if we should use lifetime annotations.
2438 llvm::Value *SizeForLifetimeMarkers;
2439
John McCall9e2e22f2011-02-22 07:16:58 +00002440 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002441 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002442
John McCallc533cb72011-02-22 06:44:22 +00002443 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002444 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002445 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002446 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002447
John McCall7f416cc2015-09-08 08:05:57 +00002448 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002449
2450 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002451 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2452
Craig Topper8a13c412014-05-21 05:09:00 +00002453 bool useLifetimeMarkers() const {
2454 return SizeForLifetimeMarkers != nullptr;
2455 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002456 llvm::Value *getSizeForLifetimeMarkers() const {
2457 assert(useLifetimeMarkers());
2458 return SizeForLifetimeMarkers;
2459 }
2460
2461 /// Returns the raw, allocated address, which is not necessarily
2462 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002463 Address getAllocatedAddress() const {
2464 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002465 }
2466
John McCallc533cb72011-02-22 06:44:22 +00002467 /// Returns the address of the object within this declaration.
2468 /// Note that this does not chase the forwarding pointer for
2469 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002470 Address getObjectAddress(CodeGenFunction &CGF) const {
2471 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002472
John McCall7f416cc2015-09-08 08:05:57 +00002473 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002474 }
2475 };
2476 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2477 void EmitAutoVarInit(const AutoVarEmission &emission);
2478 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002479 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2480 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002481
John McCall1c9c3fd2010-10-15 04:57:14 +00002482 void EmitStaticVarDecl(const VarDecl &D,
2483 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002484
John McCall7f416cc2015-09-08 08:05:57 +00002485 class ParamValue {
2486 llvm::Value *Value;
2487 unsigned Alignment;
2488 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2489 public:
2490 static ParamValue forDirect(llvm::Value *value) {
2491 return ParamValue(value, 0);
2492 }
2493 static ParamValue forIndirect(Address addr) {
2494 assert(!addr.getAlignment().isZero());
2495 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2496 }
2497
2498 bool isIndirect() const { return Alignment != 0; }
2499 llvm::Value *getAnyValue() const { return Value; }
2500
2501 llvm::Value *getDirectValue() const {
2502 assert(!isIndirect());
2503 return Value;
2504 }
2505
2506 Address getIndirectAddress() const {
2507 assert(isIndirect());
2508 return Address(Value, CharUnits::fromQuantity(Alignment));
2509 }
2510 };
2511
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002512 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002513 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002514
John McCallc07a0c72011-02-17 10:25:35 +00002515 /// protectFromPeepholes - Protect a value that we're intending to
2516 /// store to the side, but which will probably be used later, from
2517 /// aggressive peepholing optimizations that might delete it.
2518 ///
2519 /// Pass the result to unprotectFromPeepholes to declare that
2520 /// protection is no longer required.
2521 ///
2522 /// There's no particular reason why this shouldn't apply to
2523 /// l-values, it's just that no existing peepholes work on pointers.
2524 PeepholeProtection protectFromPeepholes(RValue rvalue);
2525 void unprotectFromPeepholes(PeepholeProtection protection);
2526
Erich Keane623efd82017-03-30 21:48:55 +00002527 void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment,
2528 llvm::Value *OffsetValue = nullptr) {
2529 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2530 OffsetValue);
2531 }
2532
Chris Lattner84915fa2007-06-02 04:16:21 +00002533 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002534 // Statement Emission
2535 //===--------------------------------------------------------------------===//
2536
Mike Stumpfc496822009-02-08 23:14:22 +00002537 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002538 void EmitStopPoint(const Stmt *S);
2539
Mike Stumpfc496822009-02-08 23:14:22 +00002540 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2541 /// this function even if there is no current insertion point.
2542 ///
2543 /// This function may clear the current insertion point; callers should use
2544 /// EnsureInsertPoint if they wish to subsequently generate code without first
2545 /// calling EmitBlock, EmitBranch, or EmitStmt.
Karl-Johan Karlsson33e205a2017-09-06 08:47:18 +00002546 void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002547
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002548 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002549 /// necessarily require an insertion point or debug information; typically
2550 /// because the statement amounts to a jump or a container of other
2551 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002552 ///
2553 /// \return True if the statement was handled.
2554 bool EmitSimpleStmt(const Stmt *S);
2555
John McCall7f416cc2015-09-08 08:05:57 +00002556 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2557 AggValueSlot AVS = AggValueSlot::ignored());
2558 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2559 bool GetLast = false,
2560 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002561 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002562
Mike Stumpfc496822009-02-08 23:14:22 +00002563 /// EmitLabel - Emit the block for the given label. It is legal to call this
2564 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002565 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002566
Chris Lattnerac248202007-05-30 00:13:02 +00002567 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002568 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002569 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002570 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002571 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002572
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002573 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002574 ArrayRef<const Attr *> Attrs = None);
2575 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002576 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002577 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002578 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002579 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002580 void EmitBreakStmt(const BreakStmt &S);
2581 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002582 void EmitSwitchStmt(const SwitchStmt &S);
2583 void EmitDefaultStmt(const DefaultStmt &S);
2584 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002585 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002586 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002587
Anders Carlsson2e744e82008-08-30 19:51:14 +00002588 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002589 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2590 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002591 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002592 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002593
Gor Nishanov8df64e92016-10-27 16:28:31 +00002594 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov90be1212017-03-06 21:12:54 +00002595 void EmitCoreturnStmt(const CoreturnStmt &S);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002596 RValue EmitCoawaitExpr(const CoawaitExpr &E,
2597 AggValueSlot aggSlot = AggValueSlot::ignored(),
2598 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002599 LValue EmitCoawaitLValue(const CoawaitExpr *E);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002600 RValue EmitCoyieldExpr(const CoyieldExpr &E,
2601 AggValueSlot aggSlot = AggValueSlot::ignored(),
2602 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002603 LValue EmitCoyieldLValue(const CoyieldExpr *E);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002604 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2605
John McCallb609d3f2010-07-07 06:56:46 +00002606 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2607 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002608
Anders Carlsson52d78a52009-09-27 18:58:34 +00002609 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002610 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002611 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002612 void EnterSEHTryStmt(const SEHTryStmt &S);
2613 void ExitSEHTryStmt(const SEHTryStmt &S);
2614
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002615 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002616 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002617
2618 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2619 const SEHExceptStmt &Except);
2620
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002621 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2622 const SEHFinallyStmt &Finally);
2623
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002624 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2625 llvm::Value *ParentFP,
2626 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002627 llvm::Value *EmitSEHExceptionCode();
2628 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002629 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002630
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002631 /// Scan the outlined statement for captures from the parent function. For
2632 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002633 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002634 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002635 bool IsFilter);
2636
2637 /// Recovers the address of a local in a parent function. ParentVar is the
2638 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002639 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002640 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2641 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002642 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2643 Address ParentVar,
2644 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002645
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002646 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002647 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002648
Alexey Bataev1189bd02016-01-26 12:20:39 +00002649 /// Returns calculated size of the specified type.
2650 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002651 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002652 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002653 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002654 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002655 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002656 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002657 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002658 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2659 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002660 /// \brief Perform element by element copying of arrays with type \a
2661 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2662 /// generated by \a CopyGen.
2663 ///
2664 /// \param DestAddr Address of the destination array.
2665 /// \param SrcAddr Address of the source array.
2666 /// \param OriginalType Type of destination and source arrays.
2667 /// \param CopyGen Copying procedure that copies value of single array element
2668 /// to another single array element.
2669 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002670 Address DestAddr, Address SrcAddr, QualType OriginalType,
2671 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002672 /// \brief Emit proper copying of data from one variable to another.
2673 ///
2674 /// \param OriginalType Original type of the copied variables.
2675 /// \param DestAddr Destination address.
2676 /// \param SrcAddr Source address.
2677 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2678 /// type of the base array element).
2679 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2680 /// the base array element).
2681 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2682 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002683 void EmitOMPCopy(QualType OriginalType,
2684 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002685 const VarDecl *DestVD, const VarDecl *SrcVD,
2686 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002687 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2688 /// \a X = \a E \a BO \a E.
2689 ///
2690 /// \param X Value to be updated.
2691 /// \param E Update value.
2692 /// \param BO Binary operation for update operation.
2693 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2694 /// expression, false otherwise.
2695 /// \param AO Atomic ordering of the generated atomic instructions.
2696 /// \param CommonGen Code generator for complex expressions that cannot be
2697 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002698 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2699 /// generated, <false, RValue::get(nullptr)> otherwise.
2700 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002701 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2702 llvm::AtomicOrdering AO, SourceLocation Loc,
2703 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002704 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002705 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002706 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2707 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002708 void EmitOMPUseDevicePtrClause(
2709 const OMPClause &C, OMPPrivateScope &PrivateScope,
2710 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002711 /// \brief Emit code for copyin clause in \a D directive. The next code is
2712 /// generated at the start of outlined functions for directives:
2713 /// \code
2714 /// threadprivate_var1 = master_threadprivate_var1;
2715 /// operator=(threadprivate_var2, master_threadprivate_var2);
2716 /// ...
2717 /// __kmpc_barrier(&loc, global_tid);
2718 /// \endcode
2719 ///
2720 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2721 /// \returns true if at least one copyin variable is found, false otherwise.
2722 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002723 /// \brief Emit initial code for lastprivate variables. If some variable is
2724 /// not also firstprivate, then the default initialization is used. Otherwise
2725 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2726 /// method.
2727 ///
2728 /// \param D Directive that may have 'lastprivate' directives.
2729 /// \param PrivateScope Private scope for capturing lastprivate variables for
2730 /// proper codegen in internal captured statement.
2731 ///
2732 /// \returns true if there is at least one lastprivate variable, false
2733 /// otherwise.
2734 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2735 OMPPrivateScope &PrivateScope);
2736 /// \brief Emit final copying of lastprivate values to original variables at
2737 /// the end of the worksharing or simd directive.
2738 ///
2739 /// \param D Directive that has at least one 'lastprivate' directives.
2740 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2741 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002742 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002743 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002744 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002745 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002746 /// Emit initial code for linear clauses.
2747 void EmitOMPLinearClause(const OMPLoopDirective &D,
2748 CodeGenFunction::OMPPrivateScope &PrivateScope);
2749 /// Emit final code for linear clauses.
2750 /// \param CondGen Optional conditional code for final part of codegen for
2751 /// linear clause.
2752 void EmitOMPLinearClauseFinal(
2753 const OMPLoopDirective &D,
2754 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002755 /// \brief Emit initial code for reduction variables. Creates reduction copies
2756 /// and initializes them with the values according to OpenMP standard.
2757 ///
2758 /// \param D Directive (possibly) with the 'reduction' clause.
2759 /// \param PrivateScope Private scope for capturing reduction variables for
2760 /// proper codegen in internal captured statement.
2761 ///
2762 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2763 OMPPrivateScope &PrivateScope);
2764 /// \brief Emit final update of reduction values to original variables at
2765 /// the end of the directive.
2766 ///
2767 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00002768 /// \param ReductionKind The kind of reduction to perform.
2769 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
2770 const OpenMPDirectiveKind ReductionKind);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002771 /// \brief Emit initial code for linear variables. Creates private copies
2772 /// and initializes them with the values according to OpenMP standard.
2773 ///
2774 /// \param D Directive (possibly) with the 'linear' clause.
Alexey Bataev8c3edfe2017-08-16 15:58:46 +00002775 /// \return true if at least one linear variable is found that should be
2776 /// initialized with the value of the original variable, false otherwise.
2777 bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002778
Alexey Bataev7292c292016-04-25 12:22:29 +00002779 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2780 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002781 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002782 TaskGenTy;
2783 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2784 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002785 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00002786
Alexey Bataev9959db52014-05-06 10:08:46 +00002787 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002788 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002789 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002790 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002791 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002792 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002793 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002794 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002795 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002796 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002797 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002798 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002799 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002800 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002801 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002802 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002803 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002804 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002805 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002806 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002807 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002808 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002809 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002810 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002811 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002812 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002813 void
2814 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002815 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002816 void
2817 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002818 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002819 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002820 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002821 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002822 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002823 void EmitOMPDistributeParallelForDirective(
2824 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002825 void EmitOMPDistributeParallelForSimdDirective(
2826 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002827 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002828 void EmitOMPTargetParallelForSimdDirective(
2829 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002830 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002831 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00002832 void
2833 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00002834 void EmitOMPTeamsDistributeParallelForSimdDirective(
2835 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00002836 void EmitOMPTeamsDistributeParallelForDirective(
2837 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00002838 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00002839 void EmitOMPTargetTeamsDistributeDirective(
2840 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00002841 void EmitOMPTargetTeamsDistributeParallelForDirective(
2842 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00002843 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
2844 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00002845 void EmitOMPTargetTeamsDistributeSimdDirective(
2846 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002847
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00002848 /// Emit device code for the target directive.
2849 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
2850 StringRef ParentName,
2851 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00002852 static void
2853 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2854 const OMPTargetParallelDirective &S);
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00002855 static void
2856 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2857 const OMPTargetTeamsDirective &S);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002858 /// \brief Emit inner loop of the worksharing/simd construct.
2859 ///
2860 /// \param S Directive, for which the inner loop must be emitted.
2861 /// \param RequiresCleanup true, if directive has some associated private
2862 /// variables.
2863 /// \param LoopCond Bollean condition for loop continuation.
2864 /// \param IncExpr Increment expression for loop control variable.
2865 /// \param BodyGen Generator for the inner body of the inner loop.
2866 /// \param PostIncGen Genrator for post-increment code (required for ordered
2867 /// loop directvies).
2868 void EmitOMPInnerLoop(
2869 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2870 const Expr *IncExpr,
2871 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2872 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002873
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002874 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002875 /// Emit initial code for loop counters of loop-based directives.
2876 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2877 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002878
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002879 /// Helper for the OpenMP loop directives.
2880 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
2881
2882 /// \brief Emit code for the worksharing loop-based directive.
2883 /// \return true, if this construct has any lastprivate clause, false -
2884 /// otherwise.
2885 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
2886 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
2887 const CodeGenDispatchBoundsTy &CGDispatchBounds);
2888
Alexey Bataevf47c4b42017-09-26 13:47:31 +00002889 /// Emits the lvalue for the expression with possibly captured variable.
2890 LValue EmitOMPSharedLValue(const Expr *E);
2891
Alexander Musmanc6388682014-12-15 07:07:06 +00002892private:
George Burgess IVe3763372016-12-22 02:50:20 +00002893 /// Helpers for blocks
2894 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
2895
Alexander Musmanc6388682014-12-15 07:07:06 +00002896 /// Helpers for the OpenMP loop directives.
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002897 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002898 void EmitOMPSimdFinal(
2899 const OMPLoopDirective &D,
2900 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002901
2902 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
2903 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
2904
2905 /// struct with the values to be passed to the OpenMP loop-related functions
2906 struct OMPLoopArguments {
2907 /// loop lower bound
2908 Address LB = Address::invalid();
2909 /// loop upper bound
2910 Address UB = Address::invalid();
2911 /// loop stride
2912 Address ST = Address::invalid();
2913 /// isLastIteration argument for runtime functions
2914 Address IL = Address::invalid();
2915 /// Chunk value generated by sema
2916 llvm::Value *Chunk = nullptr;
2917 /// EnsureUpperBound
2918 Expr *EUB = nullptr;
2919 /// IncrementExpression
2920 Expr *IncExpr = nullptr;
2921 /// Loop initialization
2922 Expr *Init = nullptr;
2923 /// Loop exit condition
2924 Expr *Cond = nullptr;
2925 /// Update of LB after a whole chunk has been executed
2926 Expr *NextLB = nullptr;
2927 /// Update of UB after a whole chunk has been executed
2928 Expr *NextUB = nullptr;
2929 OMPLoopArguments() = default;
2930 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
2931 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
2932 Expr *IncExpr = nullptr, Expr *Init = nullptr,
2933 Expr *Cond = nullptr, Expr *NextLB = nullptr,
2934 Expr *NextUB = nullptr)
2935 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
2936 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
2937 NextUB(NextUB) {}
2938 };
2939 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
2940 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
2941 const OMPLoopArguments &LoopArgs,
2942 const CodeGenLoopTy &CodeGenLoop,
2943 const CodeGenOrderedTy &CodeGenOrdered);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00002944 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002945 bool IsMonotonic, const OMPLoopDirective &S,
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002946 OMPPrivateScope &LoopScope, bool Ordered,
2947 const OMPLoopArguments &LoopArgs,
2948 const CodeGenDispatchBoundsTy &CGDispatchBounds);
2949 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
2950 const OMPLoopDirective &S,
2951 OMPPrivateScope &LoopScope,
2952 const OMPLoopArguments &LoopArgs,
2953 const CodeGenLoopTy &CodeGenLoopContent);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002954 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002955 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002956
2957public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002958
Chris Lattner208ae962007-05-30 17:57:17 +00002959 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002960 // LValue Expression Emission
2961 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002962
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002963 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2964 RValue GetUndefRValue(QualType Ty);
2965
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002966 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2967 /// and issue an ErrorUnsupported style diagnostic (using the
2968 /// provided Name).
2969 RValue EmitUnsupportedRValue(const Expr *E,
2970 const char *Name);
2971
Mike Stumpfc496822009-02-08 23:14:22 +00002972 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2973 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002974 LValue EmitUnsupportedLValue(const Expr *E,
2975 const char *Name);
2976
Chris Lattner8394d792007-06-05 20:53:16 +00002977 /// EmitLValue - Emit code to compute a designator that specifies the location
2978 /// of the expression.
2979 ///
2980 /// This can return one of two things: a simple address or a bitfield
2981 /// reference. In either case, the LLVM Value* in the LValue structure is
2982 /// guaranteed to be an LLVM pointer type.
2983 ///
2984 /// If this returns a bitfield reference, nothing about the pointee type of
2985 /// the LLVM value is known: For example, it may not be a pointer to an
2986 /// integer.
2987 ///
2988 /// If this returns a normal address, and if the lvalue's C type is fixed
2989 /// size, this method guarantees that the returned pointer type will point to
2990 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2991 /// variable length type, this is not possible.
2992 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002993 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002994
Richard Smith4d1458e2012-09-08 02:08:36 +00002995 /// \brief Same as EmitLValue but additionally we generate checking code to
2996 /// guard against undefined behavior. This is only suitable when we know
2997 /// that the address will be used to access the object.
2998 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002999
John McCall7f416cc2015-09-08 08:05:57 +00003000 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003001 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00003002
John McCalla8ec7eb2013-03-07 21:37:17 +00003003 void EmitAtomicInit(Expr *E, LValue lvalue);
3004
David Majnemera5b195a2015-02-14 01:35:12 +00003005 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00003006
3007 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
3008 AggValueSlot Slot = AggValueSlot::ignored());
3009
Nick Lewycky2d84e842013-10-02 02:29:49 +00003010 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00003011 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00003012 AggValueSlot slot = AggValueSlot::ignored());
3013
3014 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3015
David Majnemera5b195a2015-02-14 01:35:12 +00003016 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3017 bool IsVolatile, bool isInit);
3018
Alexey Bataevb4505a72015-03-30 05:20:59 +00003019 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00003020 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00003021 llvm::AtomicOrdering Success =
3022 llvm::AtomicOrdering::SequentiallyConsistent,
3023 llvm::AtomicOrdering Failure =
3024 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00003025 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3026
Alexey Bataevb4505a72015-03-30 05:20:59 +00003027 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00003028 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00003029 bool IsVolatile);
3030
John McCall3a7f6922010-10-27 20:58:56 +00003031 /// EmitToMemory - Change a scalar value from its value
3032 /// representation to its in-memory representation.
3033 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3034
3035 /// EmitFromMemory - Change a scalar value from its memory
3036 /// representation to its value representation.
3037 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3038
Vedant Kumar5a972652017-02-27 19:46:19 +00003039 /// Check if the scalar \p Value is within the valid range for the given
3040 /// type \p Ty.
3041 ///
3042 /// Returns true if a check is needed (even if the range is unknown).
3043 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3044 SourceLocation Loc);
3045
Daniel Dunbar1d425462009-02-10 00:57:50 +00003046 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3047 /// care to appropriately convert from the memory representation to
3048 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003049 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003050 SourceLocation Loc,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00003051 LValueBaseInfo BaseInfo =
3052 LValueBaseInfo(AlignmentSource::Type),
Ivan A. Kosarev289574e2017-10-02 09:54:47 +00003053 llvm::MDNode *TBAAAccessType = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00003054 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003055 uint64_t TBAAOffset = 0,
3056 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003057
3058 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3059 /// care to appropriately convert from the memory representation to
3060 /// the LLVM value representation. The l-value must be a simple
3061 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003062 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003063
3064 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3065 /// care to appropriately convert from the memory representation to
3066 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003067 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3068 bool Volatile, QualType Ty,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00003069 LValueBaseInfo BaseInfo =
3070 LValueBaseInfo(AlignmentSource::Type),
Ivan A. Kosarev289574e2017-10-02 09:54:47 +00003071 llvm::MDNode *TBAAAccessType = nullptr,
3072 bool isInit = false, QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003073 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003074
3075 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3076 /// care to appropriately convert from the memory representation to
3077 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00003078 /// l-value. The isInit flag indicates whether this is an initialization.
3079 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3080 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003081
Chris Lattner8394d792007-06-05 20:53:16 +00003082 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3083 /// this method emits the address of the lvalue, then loads the result as an
3084 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003085 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00003086 RValue EmitLoadOfExtVectorElementLValue(LValue V);
Vedant Kumar129edab2017-03-09 16:06:27 +00003087 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
Renato Golin230c5eb2014-05-19 18:15:42 +00003088 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00003089
Chris Lattner8394d792007-06-05 20:53:16 +00003090 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3091 /// lvalue, where both are guaranteed to the have the same type, and that type
3092 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00003093 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003094 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00003095 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003096
Nick Lewycky2d84e842013-10-02 02:29:49 +00003097 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3098 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003099 ///
Mike Stumpfc496822009-02-08 23:14:22 +00003100 /// \param Result [out] - If non-null, this will be set to a Value* for the
3101 /// bit-field contents after the store, appropriate for use as the result of
3102 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00003103 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00003104 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00003105
John McCall4f29b492010-11-16 23:07:28 +00003106 /// Emit an l-value for an assignment (simple or compound) of complex type.
3107 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003108 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00003109 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3110 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00003111
Chris Lattner57540c52011-04-15 05:22:18 +00003112 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00003113 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003114 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003115 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00003116 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003117 // Note: only available for agg return types
3118 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00003119 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00003120 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00003121 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00003122 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00003123 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00003124 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3125 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00003126 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3127 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00003128 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00003129 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00003130 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00003131 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00003132 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00003133 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00003134 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00003135 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00003136 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00003137
John McCall7f416cc2015-09-08 08:05:57 +00003138 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003139
Nick Lewycky2d84e842013-10-02 02:29:49 +00003140 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00003141
John McCall7f416cc2015-09-08 08:05:57 +00003142 Address EmitArrayToPointerDecay(const Expr *Array,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00003143 LValueBaseInfo *BaseInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003144
John McCall71335052012-03-10 03:05:10 +00003145 class ConstantEmission {
3146 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3147 ConstantEmission(llvm::Constant *C, bool isReference)
3148 : ValueAndIsReference(C, isReference) {}
3149 public:
3150 ConstantEmission() {}
3151 static ConstantEmission forReference(llvm::Constant *C) {
3152 return ConstantEmission(C, true);
3153 }
3154 static ConstantEmission forValue(llvm::Constant *C) {
3155 return ConstantEmission(C, false);
3156 }
3157
Aaron Ballman67347662015-02-15 22:00:28 +00003158 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00003159 return ValueAndIsReference.getOpaqueValue() != nullptr;
3160 }
John McCall71335052012-03-10 03:05:10 +00003161
3162 bool isReference() const { return ValueAndIsReference.getInt(); }
3163 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3164 assert(isReference());
3165 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3166 refExpr->getType());
3167 }
3168
3169 llvm::Constant *getValue() const {
3170 assert(!isReference());
3171 return ValueAndIsReference.getPointer();
3172 }
3173 };
3174
John McCall113bee02012-03-10 09:33:50 +00003175 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
Alex Lorenz6cc83172017-08-25 10:07:00 +00003176 ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
John McCall71335052012-03-10 03:05:10 +00003177
John McCallfe96e0b2011-11-06 09:01:30 +00003178 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3179 AggValueSlot slot = AggValueSlot::ignored());
3180 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3181
Daniel Dunbar722f4242009-04-22 05:08:15 +00003182 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003183 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00003184 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00003185 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003186
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003187 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3188 /// if the Field is a reference, this will return the address of the reference
3189 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003190 LValue EmitLValueForFieldInitialization(LValue Base,
3191 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003192
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003193 LValue EmitLValueForIvar(QualType ObjectTy,
3194 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003195 unsigned CVRQualifiers);
3196
Anders Carlsson3be22e22009-05-30 23:23:33 +00003197 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003198 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00003199 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003200 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003201 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003202
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003203 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003204 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003205 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003206 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003207 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003208 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003209
Chris Lattnerd7f58862007-06-02 05:24:33 +00003210 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003211 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003212 //===--------------------------------------------------------------------===//
3213
Mike Stumpfc496822009-02-08 23:14:22 +00003214 /// EmitCall - Generate a call of the given function, expecting the given
3215 /// result type, and using the given argument list which specifies both the
3216 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003217 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003218 ReturnValueSlot ReturnValue, const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00003219 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003220
John McCallb92ab1a2016-10-26 23:46:34 +00003221 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003222 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00003223 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003224 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003225 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003226 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3227 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003228
Eric Christopherc7e79db2015-11-12 00:44:04 +00003229 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003230
John McCall882987f2013-02-28 19:01:20 +00003231 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3232 const Twine &name = "");
3233 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3234 ArrayRef<llvm::Value*> args,
3235 const Twine &name = "");
3236 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3237 const Twine &name = "");
3238 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3239 ArrayRef<llvm::Value*> args,
3240 const Twine &name = "");
3241
John McCallbd309292010-07-06 01:34:17 +00003242 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003243 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00003244 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00003245 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3246 ArrayRef<llvm::Value*> args,
3247 const Twine &name = "");
3248 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3249 const Twine &name = "");
3250 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3251 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00003252
John McCallb92ab1a2016-10-26 23:46:34 +00003253 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
3254 NestedNameSpecifier *Qual,
3255 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00003256
John McCallb92ab1a2016-10-26 23:46:34 +00003257 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
3258 CXXDtorType Type,
3259 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003260
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003261 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003262 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3263 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003264 ReturnValueSlot ReturnValue, llvm::Value *This,
3265 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003266 QualType ImplicitParamTy, const CallExpr *E,
3267 CallArgList *RtlArgs);
John McCallb92ab1a2016-10-26 23:46:34 +00003268 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3269 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003270 llvm::Value *This, llvm::Value *ImplicitParam,
3271 QualType ImplicitParamTy, const CallExpr *E,
3272 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003273 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3274 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003275 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3276 const CXXMethodDecl *MD,
3277 ReturnValueSlot ReturnValue,
3278 bool HasQualifier,
3279 NestedNameSpecifier *Qualifier,
3280 bool IsArrow, const Expr *Base);
3281 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003282 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3283 llvm::Value *memberPtr,
3284 const MemberPointerType *memberPtrType,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00003285 LValueBaseInfo *BaseInfo = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003286 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3287 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003288
Anders Carlsson4034a952009-05-27 04:18:27 +00003289 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003290 const CXXMethodDecl *MD,
3291 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003292 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003293
Peter Collingbournefe883422011-10-06 18:29:37 +00003294 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3295 ReturnValueSlot ReturnValue);
3296
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003297 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3298 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003299
Mike Stump11289f42009-09-09 15:08:12 +00003300 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00003301 unsigned BuiltinID, const CallExpr *E,
3302 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003303
Anders Carlssonbfb36712009-12-24 21:13:40 +00003304 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003305
Mike Stumpfc496822009-02-08 23:14:22 +00003306 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3307 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003308 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3309
Kevin Qin1718af62013-11-14 02:45:18 +00003310 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3311 const llvm::CmpInst::Predicate Fp,
3312 const llvm::CmpInst::Predicate Ip,
3313 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00003314 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00003315
3316 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3317 unsigned LLVMIntrinsic,
3318 unsigned AltLLVMIntrinsic,
3319 const char *NameHint,
3320 unsigned Modifier,
3321 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003322 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00003323 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00003324 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3325 unsigned Modifier, llvm::Type *ArgTy,
3326 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003327 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003328 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003329 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003330 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003331 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003332 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003333 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003334 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3335 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003336 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00003337 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003338
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003339 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003340 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3341 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003342 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003343 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003344 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003345 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3346 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003347
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003348private:
3349 enum class MSVCIntrin;
3350
3351public:
3352 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3353
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003354 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3355
Daniel Dunbar66912a12008-08-20 00:28:19 +00003356 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003357 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003358 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003359 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3360 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3361 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003362 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003363 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003364 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3365 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003366
John McCall31168b02011-06-15 23:02:42 +00003367 /// Retrieves the default cleanup kind for an ARC cleanup.
3368 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3369 CleanupKind getARCCleanupKind() {
3370 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3371 ? NormalAndEHCleanup : NormalCleanup;
3372 }
3373
3374 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003375 void EmitARCInitWeak(Address addr, llvm::Value *value);
3376 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003377 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003378 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3379 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3380 void EmitARCCopyWeak(Address dst, Address src);
3381 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003382 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3383 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003384 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003385 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003386 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003387 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003388 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003389 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003390 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003391 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003392 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003393 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003394 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3395 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3396 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003397 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003398
3399 std::pair<LValue,llvm::Value*>
3400 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3401 std::pair<LValue,llvm::Value*>
3402 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003403 std::pair<LValue,llvm::Value*>
3404 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003405
John McCall248512a2011-10-01 10:32:24 +00003406 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003407 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3408 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3409
John McCallff613032011-10-04 06:23:45 +00003410 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003411 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3412 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003413 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3414 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003415 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003416
Craig Topper00bbdcf2014-06-28 23:22:23 +00003417 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003418
John McCall82fe67b2011-07-09 01:37:26 +00003419 static Destroyer destroyARCStrongImprecise;
3420 static Destroyer destroyARCStrongPrecise;
3421 static Destroyer destroyARCWeak;
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00003422 static Destroyer emitARCIntrinsicUse;
John McCall82fe67b2011-07-09 01:37:26 +00003423
John McCall31168b02011-06-15 23:02:42 +00003424 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3425 llvm::Value *EmitObjCAutoreleasePoolPush();
3426 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3427 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3428 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3429
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003430 /// \brief Emits a reference binding to the passed in expression.
3431 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003432
Chris Lattner6278e6a2007-08-11 00:04:45 +00003433 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003434 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003435 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003436
3437 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003438
3439 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3440 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003441 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003442
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003443 /// Emit a conversion from the specified type to the specified destination
3444 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003445 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003446 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003447
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003448 /// Emit a conversion from the specified complex type to the specified
3449 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003450 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003451 QualType DstTy,
3452 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003453
John McCall7a626f62010-09-15 10:14:12 +00003454 /// EmitAggExpr - Emit the computation of the specified expression
3455 /// of aggregate type. The result is computed into the given slot,
3456 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003457 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003458
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003459 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3460 /// aggregate type into a temporary LValue.
3461 LValue EmitAggExprToLValue(const Expr *E);
3462
John McCall1bd25562011-06-24 23:21:27 +00003463 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3464 /// make sure it survives garbage collection until this point.
3465 void EmitExtendGCLifetime(llvm::Value *object);
3466
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003467 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003468 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003469 ComplexPairTy EmitComplexExpr(const Expr *E,
3470 bool IgnoreReal = false,
3471 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003472
John McCall47fb9502013-03-07 21:37:08 +00003473 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3474 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003475 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003476
John McCall47fb9502013-03-07 21:37:08 +00003477 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003478 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003479
3480 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003481 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003482
John McCall7f416cc2015-09-08 08:05:57 +00003483 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3484 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3485
Chandler Carruth84537952012-03-30 19:44:53 +00003486 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3487 /// global variable that has already been created for it. If the initializer
3488 /// has a different type than GV does, this may free GV and return a different
3489 /// one. Otherwise it just returns GV.
3490 llvm::GlobalVariable *
3491 AddInitializerToStaticVarDecl(const VarDecl &D,
3492 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003493
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003494
Anders Carlssonf40886a2009-08-08 21:45:14 +00003495 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3496 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003497 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3498 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003499
David Majnemerb3341ea2014-10-05 05:05:40 +00003500 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3501 llvm::Constant *Addr);
3502
John McCallc84ed6a2012-05-01 06:13:13 +00003503 /// Call atexit() with a function that passes the given argument to
3504 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003505 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3506 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003507
John McCallcdf7ef52010-11-06 09:44:32 +00003508 /// Emit code in this function to perform a guarded variable
3509 /// initialization. Guarded initializations are used when it's not
3510 /// possible to prove that an initialization will be done exactly
3511 /// once, e.g. with a static local variable or a static data member
3512 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003513 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003514 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003515
Richard Smithae8d62c2017-07-26 22:01:09 +00003516 enum class GuardKind { VariableGuard, TlsGuard };
3517
3518 /// Emit a branch to select whether or not to perform guarded initialization.
3519 void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
3520 llvm::BasicBlock *InitBlock,
3521 llvm::BasicBlock *NoInitBlock,
3522 GuardKind Kind, const VarDecl *D);
3523
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003524 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3525 /// variables.
3526 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003527 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003528 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003529
John McCallee08c532012-04-06 18:21:03 +00003530 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003531 /// variables.
Sanjoy Dase369bd92017-05-01 17:08:00 +00003532 void GenerateCXXGlobalDtorsFunc(
3533 llvm::Function *Fn,
3534 const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
3535 &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003536
John McCalla738c252011-03-09 04:27:21 +00003537 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3538 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003539 llvm::GlobalVariable *Addr,
3540 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003541
John McCall7a626f62010-09-15 10:14:12 +00003542 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00003543
John McCall7f416cc2015-09-08 08:05:57 +00003544 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003545
John McCall08ef4662011-11-10 08:15:53 +00003546 void enterFullExpression(const ExprWithCleanups *E) {
3547 if (E->getNumObjects() == 0) return;
3548 enterNonTrivialFullExpression(E);
3549 }
3550 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003551
Richard Smithea852322013-05-07 21:53:22 +00003552 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003553
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003554 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3555
Tim Northovercc2a6e02015-11-09 19:56:35 +00003556 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003557
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003558 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003559 // Annotations Emission
3560 //===--------------------------------------------------------------------===//
3561
3562 /// Emit an annotation call (intrinsic or builtin).
3563 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3564 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003565 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003566 SourceLocation Location);
3567
3568 /// Emit local annotations for the local variable V, declared by D.
3569 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3570
3571 /// Emit field annotations for the given field & value. Returns the
3572 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003573 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003574
3575 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003576 // Internal Helpers
3577 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003578
Chris Lattner5b1964b2008-11-11 07:41:27 +00003579 /// ContainsLabel - Return true if the statement contains a label in it. If
3580 /// this statement is not executed normally, it not containing a label means
3581 /// that we can just remove the code.
3582 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003583
Chris Lattner29911cc2011-02-28 00:18:40 +00003584 /// containsBreak - Return true if the statement contains a break out of it.
3585 /// If the statement (recursively) contains a switch or loop with a break
3586 /// inside of it, this is fine.
3587 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003588
3589 /// Determine if the given statement might introduce a declaration into the
3590 /// current scope, by being a (possibly-labelled) DeclStmt.
3591 static bool mightAddDeclToScope(const Stmt *S);
Chris Lattner29911cc2011-02-28 00:18:40 +00003592
Daniel Dunbar682712c2008-11-12 10:12:14 +00003593 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003594 /// to a constant, or if it does but contains a label, return false. If it
3595 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003596 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3597 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003598
Chris Lattner29911cc2011-02-28 00:18:40 +00003599 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3600 /// to a constant, or if it does but contains a label, return false. If it
3601 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003602 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3603 bool AllowLabels = false);
3604
Chris Lattnercd439292008-11-12 08:04:58 +00003605 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3606 /// if statement) to the specified blocks. Based on the condition, this might
3607 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003608 /// TrueCount should be the number of times we expect the condition to
3609 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003610 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003611 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003612
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003613 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
3614 /// nonnull, if \p LHS is marked _Nonnull.
3615 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
3616
Vedant Kumar175b6d12017-07-13 20:55:26 +00003617 /// An enumeration which makes it easier to specify whether or not an
3618 /// operation is a subtraction.
3619 enum { NotSubtraction = false, IsSubtraction = true };
3620
Vedant Kumara125eb52017-06-01 19:22:18 +00003621 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
3622 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003623 /// \p SignedIndices indicates whether any of the GEP indices are signed.
Vedant Kumar175b6d12017-07-13 20:55:26 +00003624 /// \p IsSubtraction indicates whether the expression used to form the GEP
3625 /// is a subtraction.
Vedant Kumara125eb52017-06-01 19:22:18 +00003626 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
3627 ArrayRef<llvm::Value *> IdxList,
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003628 bool SignedIndices,
Vedant Kumar175b6d12017-07-13 20:55:26 +00003629 bool IsSubtraction,
Vedant Kumara125eb52017-06-01 19:22:18 +00003630 SourceLocation Loc,
3631 const Twine &Name = "");
3632
Vedant Kumar10c31022017-07-29 00:19:51 +00003633 /// Specifies which type of sanitizer check to apply when handling a
3634 /// particular builtin.
3635 enum BuiltinCheckKind {
3636 BCK_CTZPassedZero,
3637 BCK_CLZPassedZero,
3638 };
3639
3640 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
3641 /// enabled, a runtime check specified by \p Kind is also emitted.
3642 llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
3643
Richard Smithe30752c2012-10-09 19:52:38 +00003644 /// \brief Emit a description of a type in a format suitable for passing to
3645 /// a runtime sanitizer handler.
3646 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3647
3648 /// \brief Convert a value into a format suitable for passing to a runtime
3649 /// sanitizer handler.
3650 llvm::Value *EmitCheckValue(llvm::Value *V);
3651
3652 /// \brief Emit a description of a source location in a format suitable for
3653 /// passing to a runtime sanitizer handler.
3654 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3655
Richard Smithde670682012-11-01 22:15:34 +00003656 /// \brief Create a basic block that will call a handler function in a
3657 /// sanitizer runtime with the provided arguments, and create a conditional
3658 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003659 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00003660 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003661 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003662
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003663 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3664 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003665 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3666 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3667 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003668
Richard Smithde670682012-11-01 22:15:34 +00003669 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3670 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003671 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003672
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003673 /// \brief Emit a call to trap or debugtrap and attach function attribute
3674 /// "trap-func-name" if specified.
3675 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3676
Evgeniy Stepanov1a8030e2017-04-07 23:00:38 +00003677 /// \brief Emit a stub for the cross-DSO CFI check function.
3678 void EmitCfiCheckStub();
3679
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003680 /// \brief Emit a cross-DSO CFI failure handling function.
3681 void EmitCfiCheckFail();
3682
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003683 /// \brief Create a check for a function parameter that may potentially be
3684 /// declared as non-null.
3685 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003686 AbstractCallee AC, unsigned ParmNum);
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003687
Anders Carlsson093bdff2010-03-30 03:27:09 +00003688 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003689 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003690
John McCall23f66262010-05-26 22:34:26 +00003691 /// EmitDelegateCallArg - We are performing a delegate call; that
3692 /// is, the current function is delegating to another one. Produce
3693 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003694 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3695 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003696
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003697 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3698 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003699 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003700
Chris Lattnercd439292008-11-12 08:04:58 +00003701private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003702 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003703 void EmitReturnOfRValue(RValue RV, QualType Ty);
3704
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003705 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3706
3707 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3708 DeferredReplacements;
3709
John McCall7f416cc2015-09-08 08:05:57 +00003710 /// Set the address of a local variable.
3711 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3712 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3713 LocalDeclMap.insert({VD, Addr});
3714 }
3715
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003716 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3717 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3718 ///
3719 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003720 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003721 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003722
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003723 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3724 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3725 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3726 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3727 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3728 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003729
Chad Rosier59df25b2012-08-23 20:00:18 +00003730 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003731 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003732
Chad Rosier59df25b2012-08-23 20:00:18 +00003733 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003734 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003735 std::string &ConstraintStr,
3736 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003737
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003738 /// \brief Attempts to statically evaluate the object size of E. If that
3739 /// fails, emits code to figure the size of E out for us. This is
3740 /// pass_object_size aware.
George Burgess IV0d6592a2017-02-23 05:59:56 +00003741 ///
3742 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003743 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003744 llvm::IntegerType *ResType,
3745 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003746
3747 /// \brief Emits the size of E, as required by __builtin_object_size. This
3748 /// function is aware of pass_object_size parameters, and will act accordingly
3749 /// if E is a parameter with the pass_object_size attribute.
3750 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003751 llvm::IntegerType *ResType,
3752 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003753
Reid Kleckner89077a12013-12-17 19:46:40 +00003754public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003755#ifndef NDEBUG
3756 // Determine whether the given argument is an Objective-C method
3757 // that may have type parameters in its signature.
3758 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3759 const DeclContext *dc = method->getDeclContext();
3760 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3761 return classDecl->getTypeParamListAsWritten();
3762 }
3763
3764 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3765 return catDecl->getTypeParamList();
3766 }
3767
3768 return false;
3769 }
3770
3771 template<typename T>
3772 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3773#endif
3774
Richard Smitha560ccf2016-09-29 21:30:12 +00003775 enum class EvaluationOrder {
3776 ///! No language constraints on evaluation order.
3777 Default,
3778 ///! Language semantics require left-to-right evaluation.
3779 ForceLeftToRight,
3780 ///! Language semantics require right-to-left evaluation.
3781 ForceRightToLeft
3782 };
3783
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003784 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003785 template <typename T>
3786 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003787 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003788 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003789 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003790 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003791 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003792 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003793
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003794 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3795 "Can't skip parameters if type info is not provided");
3796 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003797#ifndef NDEBUG
3798 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3799#endif
3800
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003801 // First, use the argument types that the type info knows about
3802 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3803 E = CallArgTypeInfo->param_type_end();
3804 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003805 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003806 assert((isGenericMethod ||
3807 ((*I)->isVariablyModifiedType() ||
3808 (*I).getNonReferenceType()->isObjCRetainableType() ||
3809 getContext()
3810 .getCanonicalType((*I).getNonReferenceType())
3811 .getTypePtr() ==
3812 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003813 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003814 .getTypePtr())) &&
3815 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003816 ArgTypes.push_back(*I);
3817 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003818 }
Mike Stump11289f42009-09-09 15:08:12 +00003819
Reid Kleckner739756c2013-12-04 19:23:12 +00003820 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003821 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003822 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3823 CallArgTypeInfo->isVariadic()) &&
3824 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003825
Anders Carlsson603d6af2009-04-18 20:20:22 +00003826 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003827 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00003828 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003829
Vedant Kumared00ea02017-03-06 05:28:22 +00003830 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003831 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003832
Reid Kleckner739756c2013-12-04 19:23:12 +00003833 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003834 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003835 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003836 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003837 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00003838
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00003839 /// EmitPointerWithAlignment - Given an expression with a pointer type,
3840 /// emit the value and compute our best estimate of the alignment of the
3841 /// pointee.
John McCall7f416cc2015-09-08 08:05:57 +00003842 ///
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00003843 /// \param BaseInfo - If non-null, this will be initialized with
3844 /// information about the source of the alignment and the may-alias
3845 /// attribute. Note that this function will conservatively fall back on
3846 /// the type when it doesn't recognize the expression and may-alias will
3847 /// be set to false.
3848 ///
3849 /// One reasonable way to use this information is when there's a language
3850 /// guarantee that the pointer must be aligned to some stricter value, and
3851 /// we're simply trying to ensure that sufficiently obvious uses of under-
3852 /// aligned objects don't get miscompiled; for example, a placement new
3853 /// into the address of a local variable. In such a case, it's quite
3854 /// reasonable to just ignore the returned alignment when it isn't from an
3855 /// explicit source.
John McCall7f416cc2015-09-08 08:05:57 +00003856 Address EmitPointerWithAlignment(const Expr *Addr,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00003857 LValueBaseInfo *BaseInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003858
Peter Collingbournedc134532016-01-16 00:31:22 +00003859 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3860
Reid Kleckner89077a12013-12-17 19:46:40 +00003861private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003862 QualType getVarArgType(const Expr *Arg);
3863
John McCall09ae0322010-07-06 23:57:41 +00003864 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003865
John McCall7f416cc2015-09-08 08:05:57 +00003866 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3867 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003868
3869 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003870
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003871 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Erich Keane9937b132017-09-01 19:42:45 +00003872 llvm::Value *EmitX86CpuIs(const CallExpr *E);
3873 llvm::Value *EmitX86CpuIs(StringRef CPUStr);
3874 llvm::Value *EmitX86CpuSupports(const CallExpr *E);
3875 llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
Chris Lattnerbed31442007-05-28 01:07:47 +00003876};
Mike Stump11289f42009-09-09 15:08:12 +00003877
John McCallce1de612011-01-26 04:00:11 +00003878/// Helper class with most of the code for saving a value for a
3879/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003880struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003881 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3882
3883 /// Answer whether the given value needs extra work to be saved.
3884 static bool needsSaving(llvm::Value *value) {
3885 // If it's not an instruction, we don't need to save.
3886 if (!isa<llvm::Instruction>(value)) return false;
3887
3888 // If it's an instruction in the entry block, we don't need to save.
3889 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3890 return (block != &block->getParent()->getEntryBlock());
3891 }
3892
3893 /// Try to save the given value.
3894 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3895 if (!needsSaving(value)) return saved_type(value, false);
3896
John McCall7f416cc2015-09-08 08:05:57 +00003897 // Otherwise, we need an alloca.
3898 auto align = CharUnits::fromQuantity(
3899 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3900 Address alloca =
3901 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003902 CGF.Builder.CreateStore(value, alloca);
3903
John McCall7f416cc2015-09-08 08:05:57 +00003904 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003905 }
3906
3907 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003908 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003909 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003910
3911 // Otherwise, it should be an alloca instruction, as set up in save().
3912 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3913 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003914 }
3915};
3916
John McCallcb5f77f2011-01-28 10:53:53 +00003917/// A partial specialization of DominatingValue for llvm::Values that
3918/// might be llvm::Instructions.
3919template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3920 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003921 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003922 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3923 }
3924};
3925
John McCall7f416cc2015-09-08 08:05:57 +00003926/// A specialization of DominatingValue for Address.
3927template <> struct DominatingValue<Address> {
3928 typedef Address type;
3929
3930 struct saved_type {
3931 DominatingLLVMValue::saved_type SavedValue;
3932 CharUnits Alignment;
3933 };
3934
3935 static bool needsSaving(type value) {
3936 return DominatingLLVMValue::needsSaving(value.getPointer());
3937 }
3938 static saved_type save(CodeGenFunction &CGF, type value) {
3939 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3940 value.getAlignment() };
3941 }
3942 static type restore(CodeGenFunction &CGF, saved_type value) {
3943 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3944 value.Alignment);
3945 }
3946};
3947
John McCallcb5f77f2011-01-28 10:53:53 +00003948/// A specialization of DominatingValue for RValue.
3949template <> struct DominatingValue<RValue> {
3950 typedef RValue type;
3951 class saved_type {
3952 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3953 AggregateAddress, ComplexAddress };
3954
3955 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003956 unsigned K : 3;
3957 unsigned Align : 29;
3958 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3959 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003960
3961 public:
3962 static bool needsSaving(RValue value);
3963 static saved_type save(CodeGenFunction &CGF, RValue value);
3964 RValue restore(CodeGenFunction &CGF);
3965
John McCall7f416cc2015-09-08 08:05:57 +00003966 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003967 };
3968
3969 static bool needsSaving(type value) {
3970 return saved_type::needsSaving(value);
3971 }
3972 static saved_type save(CodeGenFunction &CGF, type value) {
3973 return saved_type::save(CGF, value);
3974 }
3975 static type restore(CodeGenFunction &CGF, saved_type value) {
3976 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003977 }
3978};
3979
Chris Lattnerbed31442007-05-28 01:07:47 +00003980} // end namespace CodeGen
3981} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003982
Chris Lattnerbed31442007-05-28 01:07:47 +00003983#endif