blob: 459841aee5a2127e2ab7506d040364407ca4a73f [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) \
114 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
115 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
116 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
117 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000118 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
119 SANITIZER_CHECK(NullabilityReturn, nullability_return, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000120 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
121 SANITIZER_CHECK(NonnullReturn, nonnull_return, 0) \
122 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
123 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
124 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
Filipe Cabecinhasfe5e5af2017-01-06 14:40:12 +0000125 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000126 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
127
128enum SanitizerHandler {
129#define SANITIZER_CHECK(Enum, Name, Version) Enum,
130 LIST_SANITIZER_CHECKS
131#undef SANITIZER_CHECK
132};
133
Chris Lattnerbed31442007-05-28 01:07:47 +0000134/// CodeGenFunction - This class organizes the per-function state that is used
135/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000136class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000137 CodeGenFunction(const CodeGenFunction &) = delete;
138 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000139
140 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000141public:
John McCallad5d61e2010-07-23 21:56:41 +0000142 /// A jump destination is an abstract label, branching to which may
143 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000144 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000145 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000146 JumpDest(llvm::BasicBlock *Block,
147 EHScopeStack::stable_iterator Depth,
148 unsigned Index)
149 : Block(Block), ScopeDepth(Depth), Index(Index) {}
150
Craig Topper8a13c412014-05-21 05:09:00 +0000151 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000152 llvm::BasicBlock *getBlock() const { return Block; }
153 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
154 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000155
Nadav Rotem1da30942013-03-23 06:43:35 +0000156 // This should be used cautiously.
157 void setScopeDepth(EHScopeStack::stable_iterator depth) {
158 ScopeDepth = depth;
159 }
160
John McCallad5d61e2010-07-23 21:56:41 +0000161 private:
John McCallbd309292010-07-06 01:34:17 +0000162 llvm::BasicBlock *Block;
163 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000164 unsigned Index;
165 };
166
Chris Lattnerbed31442007-05-28 01:07:47 +0000167 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000168 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000169
Chris Lattner96d72562007-08-21 16:57:55 +0000170 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000171 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000172 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000173
Vitaly Buka64c80b42016-10-26 05:42:30 +0000174 // Stores variables for which we can't generate correct lifetime markers
175 // because of jumps.
176 VarBypassDetector Bypasses;
177
Carlo Bertollib0ff0a62017-04-25 17:52:12 +0000178 // CodeGen lambda for loops and support for ordered clause
179 typedef llvm::function_ref<void(CodeGenFunction &, const OMPLoopDirective &,
180 JumpDest)>
181 CodeGenLoopTy;
182 typedef llvm::function_ref<void(CodeGenFunction &, SourceLocation,
183 const unsigned, const bool)>
184 CodeGenOrderedTy;
185
186 // Codegen lambda for loop bounds in worksharing loop constructs
187 typedef llvm::function_ref<std::pair<LValue, LValue>(
188 CodeGenFunction &, const OMPExecutableDirective &S)>
189 CodeGenLoopBoundsTy;
190
191 // Codegen lambda for loop bounds in dispatch-based loop implementation
192 typedef llvm::function_ref<std::pair<llvm::Value *, llvm::Value *>(
193 CodeGenFunction &, const OMPExecutableDirective &S, Address LB,
194 Address UB)>
195 CodeGenDispatchBoundsTy;
196
Alexander Musman515ad8c2014-05-22 08:54:05 +0000197 /// \brief CGBuilder insert helper. This function is called after an
198 /// instruction is created using Builder.
199 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
200 llvm::BasicBlock *BB,
201 llvm::BasicBlock::iterator InsertPt) const;
202
John McCalldec348f72013-05-03 07:33:41 +0000203 /// CurFuncDecl - Holds the Decl for the current outermost
204 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000205 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000206 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
207 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000208 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000209 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000210 llvm::Function *CurFn;
211
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000212 // Holds coroutine data if the current function is a coroutine. We use a
213 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
214 // in this header.
215 struct CGCoroInfo {
216 std::unique_ptr<CGCoroData> Data;
217 CGCoroInfo();
218 ~CGCoroInfo();
219 };
220 CGCoroInfo CurCoro;
221
Mike Stumpbee78dd2009-12-04 23:26:17 +0000222 /// CurGD - The GlobalDecl for the current function being compiled.
223 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000224
John McCall31168b02011-06-15 23:02:42 +0000225 /// PrologueCleanupDepth - The cleanup depth enclosing all the
226 /// cleanups associated with the parameters.
227 EHScopeStack::stable_iterator PrologueCleanupDepth;
228
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000229 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000230 JumpDest ReturnBlock;
231
John McCall7f416cc2015-09-08 08:05:57 +0000232 /// ReturnValue - The temporary alloca to hold the return
233 /// value. This is invalid iff the function has no return value.
234 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000235
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000236 /// Return true if a label was seen in the current scope.
237 bool hasLabelBeenSeenInCurrentScope() const {
238 if (CurLexicalScope)
239 return CurLexicalScope->hasLabels();
240 return !LabelMap.empty();
241 }
242
Chris Lattner03df1222007-06-02 04:53:11 +0000243 /// AllocaInsertPoint - This is an instruction in the entry block before which
244 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000245 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000246
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000247 /// \brief API for captured statement code generation.
248 class CGCapturedStmtInfo {
249 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000250 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
251 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000252 explicit CGCapturedStmtInfo(const CapturedStmt &S,
253 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000254 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000255
256 RecordDecl::field_iterator Field =
257 S.getCapturedRecordDecl()->field_begin();
258 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
259 E = S.capture_end();
260 I != E; ++I, ++Field) {
261 if (I->capturesThis())
262 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000263 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000264 CaptureFields[I->getCapturedVar()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000265 else if (I->capturesVariableByCopy())
266 CaptureFields[I->getCapturedVar()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000267 }
268 }
269
270 virtual ~CGCapturedStmtInfo();
271
272 CapturedRegionKind getKind() const { return Kind; }
273
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000274 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000275 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000276 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000277
278 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000279 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000280 return CaptureFields.lookup(VD);
281 }
282
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000283 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
284 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000285
Alexey Bataev18095712014-10-10 12:19:54 +0000286 static bool classof(const CGCapturedStmtInfo *) {
287 return true;
288 }
289
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000290 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000291 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000292 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000293 CGF.EmitStmt(S);
294 }
295
296 /// \brief Get the name of the capture helper.
297 virtual StringRef getHelperName() const { return "__captured_stmt"; }
298
299 private:
300 /// \brief The kind of captured statement being generated.
301 CapturedRegionKind Kind;
302
303 /// \brief Keep the map between VarDecl and FieldDecl.
304 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
305
306 /// \brief The base address of the captured record, passed in as the first
307 /// argument of the parallel region function.
308 llvm::Value *ThisValue;
309
310 /// \brief Captured 'this' type.
311 FieldDecl *CXXThisFieldDecl;
312 };
313 CGCapturedStmtInfo *CapturedStmtInfo;
314
Alexey Bataevd157d472015-06-24 03:35:38 +0000315 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
316 class CGCapturedStmtRAII {
317 private:
318 CodeGenFunction &CGF;
319 CGCapturedStmtInfo *PrevCapturedStmtInfo;
320 public:
321 CGCapturedStmtRAII(CodeGenFunction &CGF,
322 CGCapturedStmtInfo *NewCapturedStmtInfo)
323 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
324 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
325 }
326 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
327 };
328
Vedant Kumared00ea02017-03-06 05:28:22 +0000329 /// An abstract representation of regular/ObjC call/message targets.
330 class AbstractCallee {
331 /// The function declaration of the callee.
332 const Decl *CalleeDecl;
333
334 public:
335 AbstractCallee() : CalleeDecl(nullptr) {}
336 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
337 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
338 bool hasFunctionDecl() const {
339 return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
340 }
341 const Decl *getDecl() const { return CalleeDecl; }
342 unsigned getNumParams() const {
343 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
344 return FD->getNumParams();
345 return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
346 }
347 const ParmVarDecl *getParamDecl(unsigned I) const {
348 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
349 return FD->getParamDecl(I);
350 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
351 }
352 };
353
Alexey Samsonova0416102014-11-11 01:26:14 +0000354 /// \brief Sanitizers enabled for this function.
355 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000356
Alexey Samsonov24cad992014-07-17 18:46:27 +0000357 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
358 bool IsSanitizerScope;
359
360 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
361 class SanitizerScope {
362 CodeGenFunction *CGF;
363 public:
364 SanitizerScope(CodeGenFunction *CGF);
365 ~SanitizerScope();
366 };
367
Reid Kleckner19819442014-07-25 21:39:46 +0000368 /// In C++, whether we are code generating a thunk. This controls whether we
369 /// should emit cleanups.
370 bool CurFuncIsThunk;
371
John McCall31168b02011-06-15 23:02:42 +0000372 /// In ARC, whether we should autorelease the return value.
373 bool AutoreleaseResult;
374
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000375 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
376 /// potentially set the return value.
377 bool SawAsmBlock;
378
David Majnemer25eb1652016-03-01 19:42:53 +0000379 const FunctionDecl *CurSEHParent = nullptr;
380
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000381 /// True if the current function is an outlined SEH helper. This can be a
382 /// finally block or filter expression.
383 bool IsOutlinedSEHHelper;
384
John McCallad7c5c12011-02-08 08:22:06 +0000385 const CodeGen::CGBlockInfo *BlockInfo;
386 llvm::Value *BlockPointer;
387
Eli Friedman9fbeba02012-02-11 02:57:39 +0000388 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
389 FieldDecl *LambdaThisCaptureField;
390
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000391 /// \brief A mapping from NRVO variables to the flags used to indicate
392 /// when the NRVO has been applied to this variable.
393 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000394
John McCallbd309292010-07-06 01:34:17 +0000395 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000396 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000397 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000398
David Majnemer4e52d6f2015-12-12 05:39:21 +0000399 llvm::Instruction *CurrentFuncletPad = nullptr;
400
Tim Shen421119f2016-07-01 21:08:47 +0000401 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
402 llvm::Value *Addr;
403 llvm::Value *Size;
404
405 public:
406 CallLifetimeEnd(Address addr, llvm::Value *size)
407 : Addr(addr.getPointer()), Size(size) {}
408
409 void Emit(CodeGenFunction &CGF, Flags flags) override {
410 CGF.EmitLifetimeEnd(Size, Addr);
411 }
412 };
413
Richard Smith736a9472013-06-12 20:42:33 +0000414 /// Header for data within LifetimeExtendedCleanupStack.
415 struct LifetimeExtendedCleanupHeader {
416 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000417 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000418 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000419 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000420
Justin Bognerbdff2192015-07-01 00:59:27 +0000421 size_t getSize() const { return Size; }
422 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000423 };
John McCallbd309292010-07-06 01:34:17 +0000424
John McCallad5d61e2010-07-23 21:56:41 +0000425 /// i32s containing the indexes of the cleanup destinations.
426 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000427
428 unsigned NextCleanupDestIndex;
429
John McCall08ef4662011-11-10 08:15:53 +0000430 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
431 CGBlockInfo *FirstBlockInfo;
432
John McCall8e4c74b2011-08-11 02:22:43 +0000433 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
434 llvm::BasicBlock *EHResumeBlock;
435
Bill Wendlingf0724e82011-09-19 20:31:14 +0000436 /// The exception slot. All landing pads write the current exception pointer
437 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000438 llvm::Value *ExceptionSlot;
439
Bill Wendlingf0724e82011-09-19 20:31:14 +0000440 /// The selector slot. Under the MandatoryCleanup model, all landing pads
441 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000442 llvm::AllocaInst *EHSelectorSlot;
443
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000444 /// A stack of exception code slots. Entering an __except block pushes a slot
445 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
446 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000447 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000448
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000449 /// Value returned by __exception_info intrinsic.
450 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000451
John McCallbd309292010-07-06 01:34:17 +0000452 /// Emits a landing pad for the current EH stack.
453 llvm::BasicBlock *EmitLandingPad();
454
455 llvm::BasicBlock *getInvokeDestImpl();
456
John McCallce1de612011-01-26 04:00:11 +0000457 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000458 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
459 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000460 }
461
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000462public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000463 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
464 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000465 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000466
John McCall6b0feb72011-06-22 02:32:12 +0000467 /// A class controlling the emission of a finally block.
468 class FinallyInfo {
469 /// Where the catchall's edge through the cleanup should go.
470 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000471
John McCall6b0feb72011-06-22 02:32:12 +0000472 /// A function to call to enter the catch.
473 llvm::Constant *BeginCatchFn;
474
475 /// An i1 variable indicating whether or not the @finally is
476 /// running for an exception.
477 llvm::AllocaInst *ForEHVar;
478
479 /// An i8* variable into which the exception pointer to rethrow
480 /// has been saved.
481 llvm::AllocaInst *SavedExnVar;
482
483 public:
484 void enter(CodeGenFunction &CGF, const Stmt *Finally,
485 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
486 llvm::Constant *rethrowFn);
487 void exit(CodeGenFunction &CGF);
488 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000489
Reid Kleckner11c033e2015-02-12 23:40:45 +0000490 /// Returns true inside SEH __try blocks.
491 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
492
Reid Klecknera002bd52015-10-28 23:06:42 +0000493 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000494 bool isCleanupPadScope() const {
495 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
496 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000497
John McCallce1de612011-01-26 04:00:11 +0000498 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
499 /// current full-expression. Safe against the possibility that
500 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000501 template <class T, class... As>
502 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000503 // If we're not in a conditional branch, or if none of the
504 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000505 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000506 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000507
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000508 // Stash values in a tuple so we can guarantee the order of saves.
509 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
510 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000511
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000512 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000513 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000514 initFullExprCleanup();
515 }
516
Richard Smith736a9472013-06-12 20:42:33 +0000517 /// \brief Queue a cleanup to be pushed after finishing the current
518 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000519 template <class T, class... As>
520 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000521 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
522
523 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
524
525 size_t OldSize = LifetimeExtendedCleanupStack.size();
526 LifetimeExtendedCleanupStack.resize(
527 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
528
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000529 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000530 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000531 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
532 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000533 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000534 }
535
John McCallf4beacd2011-11-10 10:43:54 +0000536 /// Set up the last cleaup that was pushed as a conditional
537 /// full-expression cleanup.
538 void initFullExprCleanup();
539
John McCallbd309292010-07-06 01:34:17 +0000540 /// PushDestructorCleanup - Push a cleanup to call the
541 /// complete-object destructor of an object of the given type at the
542 /// given address. Does nothing if T is not a C++ class type with a
543 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000544 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000545
John McCall8680f872010-07-21 06:29:51 +0000546 /// PushDestructorCleanup - Push a cleanup to call the
547 /// complete-object variant of the given destructor on the object at
548 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000549 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000550
John McCallbd309292010-07-06 01:34:17 +0000551 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
552 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000553 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000554
John McCall824c2f52010-09-14 07:57:04 +0000555 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
556 /// The block cannot be reactivated. Pops it if it's the top of the
557 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000558 ///
559 /// \param DominatingIP - An instruction which is known to
560 /// dominate the current IP (if set) and which lies along
561 /// all paths of execution between the current IP and the
562 /// the point at which the cleanup comes into scope.
563 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
564 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000565
566 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
567 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000568 ///
569 /// \param DominatingIP - An instruction which is known to
570 /// dominate the current IP (if set) and which lies along
571 /// all paths of execution between the current IP and the
572 /// the point at which the cleanup comes into scope.
573 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
574 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000575
John McCallbd309292010-07-06 01:34:17 +0000576 /// \brief Enters a new scope for capturing cleanups, all of which
577 /// will be executed once the scope is exited.
578 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000579 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000580 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000581 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000582 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000583 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000584 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000585
Aaron Ballmanabc18922015-02-15 22:54:08 +0000586 RunCleanupsScope(const RunCleanupsScope &) = delete;
587 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000588
Eric Christophera9d34972011-10-19 00:43:52 +0000589 protected:
590 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000591
Douglas Gregor965f4502009-11-24 16:43:22 +0000592 public:
593 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000594 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000595 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000596 {
John McCallbd309292010-07-06 01:34:17 +0000597 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000598 LifetimeExtendedCleanupStackSize =
599 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000600 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000601 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000602 }
603
Reid Kleckner092d0652017-03-06 22:18:34 +0000604 /// \brief Exit this cleanup scope, emitting any accumulated cleanups.
John McCallbd309292010-07-06 01:34:17 +0000605 ~RunCleanupsScope() {
Reid Kleckner092d0652017-03-06 22:18:34 +0000606 if (PerformCleanup)
607 ForceCleanup();
Douglas Gregor680f8612009-11-24 21:15:44 +0000608 }
609
610 /// \brief Determine whether this scope requires any cleanups.
611 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000612 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000613 }
614
615 /// \brief Force the emission of cleanups now, instead of waiting
616 /// until this object is destroyed.
Reid Kleckner092d0652017-03-06 22:18:34 +0000617 /// \param ValuesToReload - A list of values that need to be available at
618 /// the insertion point after cleanup emission. If cleanup emission created
619 /// a shared cleanup block, these value pointers will be rewritten.
620 /// Otherwise, they not will be modified.
621 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
Douglas Gregor680f8612009-11-24 21:15:44 +0000622 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000623 CGF.DidCallStackSave = OldDidCallStackSave;
Reid Kleckner092d0652017-03-06 22:18:34 +0000624 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
625 ValuesToReload);
Douglas Gregor680f8612009-11-24 21:15:44 +0000626 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000627 }
628 };
629
David Blaikie93be0b22014-08-22 21:37:04 +0000630 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000631 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000632 SmallVector<const LabelDecl*, 4> Labels;
633 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000634
Aaron Ballmanabc18922015-02-15 22:54:08 +0000635 LexicalScope(const LexicalScope &) = delete;
636 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000637
638 public:
639 /// \brief Enter a new cleanup scope.
640 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000641 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
642 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000643 if (CGDebugInfo *DI = CGF.getDebugInfo())
644 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
645 }
646
Nadav Rotem1da30942013-03-23 06:43:35 +0000647 void addLabel(const LabelDecl *label) {
648 assert(PerformCleanup && "adding label to dead scope?");
649 Labels.push_back(label);
650 }
651
Eric Christophera9d34972011-10-19 00:43:52 +0000652 /// \brief Exit this cleanup scope, emitting any accumulated
653 /// cleanups.
654 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000655 if (CGDebugInfo *DI = CGF.getDebugInfo())
656 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
657
Nadav Rotem1da30942013-03-23 06:43:35 +0000658 // If we should perform a cleanup, force them now. Note that
659 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000660 if (PerformCleanup) {
661 ApplyDebugLocation DL(CGF, Range.getEnd());
662 ForceCleanup();
663 }
Eric Christophera9d34972011-10-19 00:43:52 +0000664 }
665
666 /// \brief Force the emission of cleanups now, instead of waiting
667 /// until this object is destroyed.
668 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000669 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000670 RunCleanupsScope::ForceCleanup();
671
Nadav Rotem1da30942013-03-23 06:43:35 +0000672 if (!Labels.empty())
673 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000674 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000675
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000676 bool hasLabels() const {
677 return !Labels.empty();
678 }
679
Nadav Rotem1da30942013-03-23 06:43:35 +0000680 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000681 };
682
John McCall7f416cc2015-09-08 08:05:57 +0000683 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
684
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000685 /// \brief The scope used to remap some variables as private in the OpenMP
686 /// loop body (or other captured region emitted without outlining), and to
687 /// restore old vars back on exit.
688 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000689 DeclMapTy SavedLocals;
690 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000691
692 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000693 OMPPrivateScope(const OMPPrivateScope &) = delete;
694 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000695
696 public:
697 /// \brief Enter a new OpenMP private scope.
698 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
699
700 /// \brief Registers \a LocalVD variable as a private and apply \a
701 /// PrivateGen function for it to generate corresponding private variable.
702 /// \a PrivateGen returns an address of the generated private variable.
703 /// \return true if the variable is registered as private, false if it has
704 /// been privatized already.
705 bool
706 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000707 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000708 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000709
710 // Only save it once.
711 if (SavedLocals.count(LocalVD)) return false;
712
713 // Copy the existing local entry to SavedLocals.
714 auto it = CGF.LocalDeclMap.find(LocalVD);
715 if (it != CGF.LocalDeclMap.end()) {
716 SavedLocals.insert({LocalVD, it->second});
717 } else {
718 SavedLocals.insert({LocalVD, Address::invalid()});
719 }
720
721 // Generate the private entry.
722 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000723 QualType VarTy = LocalVD->getType();
724 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000725 Address Temp = CGF.CreateMemTemp(VarTy);
726 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
727 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000728 }
John McCall7f416cc2015-09-08 08:05:57 +0000729 SavedPrivates.insert({LocalVD, Addr});
730
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000731 return true;
732 }
733
734 /// \brief Privatizes local variables previously registered as private.
735 /// Registration is separate from the actual privatization to allow
736 /// initializers use values of the original variables, not the private one.
737 /// This is important, for example, if the private variable is a class
738 /// variable initialized by a constructor that references other private
739 /// variables. But at initialization original variables must be used, not
740 /// private copies.
741 /// \return true if at least one variable was privatized, false otherwise.
742 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000743 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000744 SavedPrivates.clear();
745 return !SavedLocals.empty();
746 }
747
748 void ForceCleanup() {
749 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000750 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000751 SavedLocals.clear();
752 }
753
754 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000755 ~OMPPrivateScope() {
756 if (PerformCleanup)
757 ForceCleanup();
758 }
John McCall7f416cc2015-09-08 08:05:57 +0000759
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000760 /// Checks if the global variable is captured in current function.
761 bool isGlobalVarCaptured(const VarDecl *VD) const {
762 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
763 }
764
John McCall7f416cc2015-09-08 08:05:57 +0000765 private:
766 /// Copy all the entries in the source map over the corresponding
767 /// entries in the destination, which must exist.
768 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
769 for (auto &pair : src) {
770 if (!pair.second.isValid()) {
771 dest.erase(pair.first);
772 continue;
773 }
774
775 auto it = dest.find(pair.first);
776 if (it != dest.end()) {
777 it->second = pair.second;
778 } else {
779 dest.insert(pair);
780 }
781 }
782 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000783 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000784
Richard Smith736a9472013-06-12 20:42:33 +0000785 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
786 /// that have been added.
Reid Kleckner092d0652017-03-06 22:18:34 +0000787 void
788 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
789 std::initializer_list<llvm::Value **> ValuesToReload = {});
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000790
Richard Smith736a9472013-06-12 20:42:33 +0000791 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
792 /// that have been added, then adds all lifetime-extended cleanups from
793 /// the given position to the stack.
Reid Kleckner092d0652017-03-06 22:18:34 +0000794 void
795 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
796 size_t OldLifetimeExtendedStackSize,
797 std::initializer_list<llvm::Value **> ValuesToReload = {});
Richard Smith736a9472013-06-12 20:42:33 +0000798
John McCallad5d61e2010-07-23 21:56:41 +0000799 void ResolveBranchFixups(llvm::BasicBlock *Target);
800
John McCallbd309292010-07-06 01:34:17 +0000801 /// The given basic block lies in the current EH scope, but may be a
802 /// target of a potentially scope-crossing jump; get a stable handle
803 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000804 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000805 return JumpDest(Target,
806 EHStack.getInnermostNormalCleanup(),
807 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000808 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000809
John McCallbd309292010-07-06 01:34:17 +0000810 /// The given basic block lies in the current EH scope, but may be a
811 /// target of a potentially scope-crossing jump; get a stable handle
812 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000813 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000814 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000815 }
816
817 /// EmitBranchThroughCleanup - Emit a branch from the current insert
818 /// block through the normal cleanup handling code (if any) and then
819 /// on to \arg Dest.
820 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000821
Justin Bognere25ffdf2014-01-21 00:35:11 +0000822 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
823 /// specified destination obviously has no cleanups to run. 'false' is always
824 /// a conservatively correct answer for this method.
825 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
826
John McCall8e4c74b2011-08-11 02:22:43 +0000827 /// popCatchScope - Pops the catch scope at the top of the EHScope
828 /// stack, emitting any required code (other than the catch handlers
829 /// themselves).
830 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000831
David Chisnall9a837be2012-11-07 16:50:40 +0000832 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000833 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000834 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000835
John McCallce1de612011-01-26 04:00:11 +0000836 /// An object to manage conditionally-evaluated expressions.
837 class ConditionalEvaluation {
838 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000839
John McCallce1de612011-01-26 04:00:11 +0000840 public:
841 ConditionalEvaluation(CodeGenFunction &CGF)
842 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000843
John McCallce1de612011-01-26 04:00:11 +0000844 void begin(CodeGenFunction &CGF) {
845 assert(CGF.OutermostConditional != this);
846 if (!CGF.OutermostConditional)
847 CGF.OutermostConditional = this;
848 }
849
850 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000851 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000852 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000853 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000854 }
855
856 /// Returns a block which will be executed prior to each
857 /// evaluation of the conditional code.
858 llvm::BasicBlock *getStartingBlock() const {
859 return StartBB;
860 }
861 };
Mike Stump11289f42009-09-09 15:08:12 +0000862
John McCall7f9c92a2010-09-17 00:50:28 +0000863 /// isInConditionalBranch - Return true if we're currently emitting
864 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000865 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000866
John McCall7f416cc2015-09-08 08:05:57 +0000867 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000868 assert(isInConditionalBranch());
869 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000870 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
871 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000872 }
873
John McCallce1de612011-01-26 04:00:11 +0000874 /// An RAII object to record that we're evaluating a statement
875 /// expression.
876 class StmtExprEvaluation {
877 CodeGenFunction &CGF;
878
879 /// We have to save the outermost conditional: cleanups in a
880 /// statement expression aren't conditional just because the
881 /// StmtExpr is.
882 ConditionalEvaluation *SavedOutermostConditional;
883
884 public:
885 StmtExprEvaluation(CodeGenFunction &CGF)
886 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000887 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000888 }
889
890 ~StmtExprEvaluation() {
891 CGF.OutermostConditional = SavedOutermostConditional;
892 CGF.EnsureInsertPoint();
893 }
894 };
John McCall1bf58462011-02-16 08:02:54 +0000895
John McCallc07a0c72011-02-17 10:25:35 +0000896 /// An object which temporarily prevents a value from being
897 /// destroyed by aggressive peephole optimizations that assume that
898 /// all uses of a value have been realized in the IR.
899 class PeepholeProtection {
900 llvm::Instruction *Inst;
901 friend class CodeGenFunction;
902
903 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000904 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000905 };
John McCallc07a0c72011-02-17 10:25:35 +0000906
John McCallfe96e0b2011-11-06 09:01:30 +0000907 /// A non-RAII class containing all the information about a bound
908 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
909 /// this which makes individual mappings very simple; using this
910 /// class directly is useful when you have a variable number of
911 /// opaque values or don't want the RAII functionality for some
912 /// reason.
913 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000914 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000915 bool BoundLValue;
916 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000917
John McCallfe96e0b2011-11-06 09:01:30 +0000918 OpaqueValueMappingData(const OpaqueValueExpr *ov,
919 bool boundLValue)
920 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000921 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000922 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000923
John McCallc07a0c72011-02-17 10:25:35 +0000924 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000925 // gl-values should be bound as l-values for obvious reasons.
926 // Records should be bound as l-values because IR generation
927 // always keeps them in memory. Expressions of function type
928 // act exactly like l-values but are formally required to be
929 // r-values in C.
930 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000931 expr->getType()->isFunctionType() ||
932 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000933 }
934
John McCallfe96e0b2011-11-06 09:01:30 +0000935 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
936 const OpaqueValueExpr *ov,
937 const Expr *e) {
938 if (shouldBindAsLValue(ov))
939 return bind(CGF, ov, CGF.EmitLValue(e));
940 return bind(CGF, ov, CGF.EmitAnyExpr(e));
941 }
942
943 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
944 const OpaqueValueExpr *ov,
945 const LValue &lv) {
946 assert(shouldBindAsLValue(ov));
947 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
948 return OpaqueValueMappingData(ov, true);
949 }
950
951 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
952 const OpaqueValueExpr *ov,
953 const RValue &rv) {
954 assert(!shouldBindAsLValue(ov));
955 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
956
957 OpaqueValueMappingData data(ov, false);
958
959 // Work around an extremely aggressive peephole optimization in
960 // EmitScalarConversion which assumes that all other uses of a
961 // value are extant.
962 data.Protection = CGF.protectFromPeepholes(rv);
963
964 return data;
965 }
966
Craig Topper8a13c412014-05-21 05:09:00 +0000967 bool isValid() const { return OpaqueValue != nullptr; }
968 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000969
970 void unbind(CodeGenFunction &CGF) {
971 assert(OpaqueValue && "no data to unbind!");
972
973 if (BoundLValue) {
974 CGF.OpaqueLValues.erase(OpaqueValue);
975 } else {
976 CGF.OpaqueRValues.erase(OpaqueValue);
977 CGF.unprotectFromPeepholes(Protection);
978 }
979 }
980 };
981
982 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
983 class OpaqueValueMapping {
984 CodeGenFunction &CGF;
985 OpaqueValueMappingData Data;
986
987 public:
988 static bool shouldBindAsLValue(const Expr *expr) {
989 return OpaqueValueMappingData::shouldBindAsLValue(expr);
990 }
991
John McCallc07a0c72011-02-17 10:25:35 +0000992 /// Build the opaque value mapping for the given conditional
993 /// operator if it's the GNU ?: extension. This is a common
994 /// enough pattern that the convenience operator is really
995 /// helpful.
996 ///
997 OpaqueValueMapping(CodeGenFunction &CGF,
998 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000999 if (isa<ConditionalOperator>(op))
1000 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001001 return;
John McCallc07a0c72011-02-17 10:25:35 +00001002
1003 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001004 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1005 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001006 }
1007
Richard Smith410306b2016-12-12 02:53:20 +00001008 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1009 /// expression is set to the expression the OVE represents.
1010 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1011 : CGF(CGF) {
1012 if (OV) {
1013 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1014 "for OVE with no source expression");
1015 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1016 }
1017 }
1018
John McCall1bf58462011-02-16 08:02:54 +00001019 OpaqueValueMapping(CodeGenFunction &CGF,
1020 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001021 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001022 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001023 }
1024
1025 OpaqueValueMapping(CodeGenFunction &CGF,
1026 const OpaqueValueExpr *opaqueValue,
1027 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001028 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001029 }
1030
1031 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001032 Data.unbind(CGF);
1033 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001034 }
1035
1036 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001037 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001038 }
1039 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +00001040
Chris Lattner2da04b32007-08-24 05:35:26 +00001041private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001042 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001043 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001044
John McCall9b382dd2011-05-28 21:13:02 +00001045 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1046 /// calling llvm.stacksave for multiple VLAs in the same scope.
1047 bool DidCallStackSave;
1048
Mike Stumpe5311b02009-11-30 20:08:49 +00001049 /// IndirectBranch - The first time an indirect goto is seen we create a block
1050 /// with an indirect branch. Every time we see the address of a label taken,
1051 /// we add the label to the indirect goto. Every subsequent indirect goto is
1052 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +00001053 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001054
Mike Stumpfc496822009-02-08 23:14:22 +00001055 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1056 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001057 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001058
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001059 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1060 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1061 /// parameter.
1062 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1063 SizeArguments;
1064
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001065 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001066 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001067 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1068
Chris Lattnerac248202007-05-30 00:13:02 +00001069 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001070 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001071
Mike Stumpfc496822009-02-08 23:14:22 +00001072 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001073 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001074 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001075 BreakContinue(JumpDest Break, JumpDest Continue)
1076 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001077
John McCallbd309292010-07-06 01:34:17 +00001078 JumpDest BreakBlock;
1079 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001080 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001081 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001082
Alexey Bataev957d8562016-11-17 15:12:05 +00001083 /// Handles cancellation exit points in OpenMP-related constructs.
1084 class OpenMPCancelExitStack {
1085 /// Tracks cancellation exit point and join point for cancel-related exit
1086 /// and normal exit.
1087 struct CancelExit {
1088 CancelExit() = default;
1089 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1090 JumpDest ContBlock)
1091 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1092 OpenMPDirectiveKind Kind = OMPD_unknown;
1093 /// true if the exit block has been emitted already by the special
1094 /// emitExit() call, false if the default codegen is used.
1095 bool HasBeenEmitted = false;
1096 JumpDest ExitBlock;
1097 JumpDest ContBlock;
1098 };
1099
1100 SmallVector<CancelExit, 8> Stack;
1101
1102 public:
1103 OpenMPCancelExitStack() : Stack(1) {}
1104 ~OpenMPCancelExitStack() = default;
1105 /// Fetches the exit block for the current OpenMP construct.
1106 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1107 /// Emits exit block with special codegen procedure specific for the related
1108 /// OpenMP construct + emits code for normal construct cleanup.
1109 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1110 const llvm::function_ref<void(CodeGenFunction &)> &CodeGen) {
1111 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1112 assert(CGF.getOMPCancelDestination(Kind).isValid());
1113 assert(CGF.HaveInsertPoint());
1114 assert(!Stack.back().HasBeenEmitted);
1115 auto IP = CGF.Builder.saveAndClearIP();
1116 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1117 CodeGen(CGF);
1118 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1119 CGF.Builder.restoreIP(IP);
1120 Stack.back().HasBeenEmitted = true;
1121 }
1122 CodeGen(CGF);
1123 }
1124 /// Enter the cancel supporting \a Kind construct.
1125 /// \param Kind OpenMP directive that supports cancel constructs.
1126 /// \param HasCancel true, if the construct has inner cancel directive,
1127 /// false otherwise.
1128 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1129 Stack.push_back({Kind,
1130 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1131 : JumpDest(),
1132 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1133 : JumpDest()});
1134 }
1135 /// Emits default exit point for the cancel construct (if the special one
1136 /// has not be used) + join point for cancel/normal exits.
1137 void exit(CodeGenFunction &CGF) {
1138 if (getExitBlock().isValid()) {
1139 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1140 bool HaveIP = CGF.HaveInsertPoint();
1141 if (!Stack.back().HasBeenEmitted) {
1142 if (HaveIP)
1143 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1144 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1145 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1146 }
1147 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1148 if (!HaveIP) {
1149 CGF.Builder.CreateUnreachable();
1150 CGF.Builder.ClearInsertionPoint();
1151 }
1152 }
1153 Stack.pop_back();
1154 }
1155 };
1156 OpenMPCancelExitStack OMPCancelStack;
1157
1158 /// Controls insertion of cancellation exit blocks in worksharing constructs.
1159 class OMPCancelStackRAII {
1160 CodeGenFunction &CGF;
1161
1162 public:
1163 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1164 bool HasCancel)
1165 : CGF(CGF) {
1166 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
1167 }
1168 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
1169 };
1170
Justin Bogneref512b92014-01-06 22:27:43 +00001171 CodeGenPGO PGO;
1172
Justin Bogner65512642015-05-02 05:00:55 +00001173 /// Calculate branch weights appropriate for PGO data
1174 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1175 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1176 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1177 uint64_t LoopCount);
1178
Justin Bogneref512b92014-01-06 22:27:43 +00001179public:
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001180 /// Increment the profiler's counter for the given statement by \p StepV.
1181 /// If \p StepV is null, the default increment is 1.
1182 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
Rong Xu9837ef52016-02-04 18:39:09 +00001183 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001184 PGO.emitCounterIncrement(Builder, S, StepV);
Justin Bogner66242d62015-04-23 23:06:47 +00001185 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001186 }
Justin Bogner66242d62015-04-23 23:06:47 +00001187
1188 /// Get the profiler's count for the given statement.
1189 uint64_t getProfileCount(const Stmt *S) {
1190 Optional<uint64_t> Count = PGO.getStmtCount(S);
1191 if (!Count.hasValue())
1192 return 0;
1193 return *Count;
1194 }
1195
1196 /// Set the profiler's current count.
1197 void setCurrentProfileCount(uint64_t Count) {
1198 PGO.setCurrentRegionCount(Count);
1199 }
1200
1201 /// Get the profiler's current count. This is generally the count for the most
1202 /// recently incremented counter.
1203 uint64_t getCurrentProfileCount() {
1204 return PGO.getCurrentRegionCount();
1205 }
1206
Justin Bogneref512b92014-01-06 22:27:43 +00001207private:
1208
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001209 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001210 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001211 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001212 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1213 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001214
Mike Stumpfc496822009-02-08 23:14:22 +00001215 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001216 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001217 llvm::BasicBlock *CaseRangeBlock;
1218
John McCallc07a0c72011-02-17 10:25:35 +00001219 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001220 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001221 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1222 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001223
Mike Stumpfc496822009-02-08 23:14:22 +00001224 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001225 // We track this by the size expression rather than the type itself because
1226 // in certain situations, like a const qualifier applied to an VLA typedef,
1227 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001228 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1229 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001230 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001231
John McCallbd309292010-07-06 01:34:17 +00001232 /// A block containing a single 'unreachable' instruction. Created
1233 /// lazily by getUnreachableBlock().
1234 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001235
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001236 /// Counts of the number return expressions in the function.
1237 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001238
1239 /// Count the number of simple (constant) return expressions in the function.
1240 unsigned NumSimpleReturnExprs;
1241
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001242 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001243 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001244
Richard Smith852c9db2013-04-20 22:23:05 +00001245public:
1246 /// A scope within which we are constructing the fields of an object which
1247 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1248 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1249 class FieldConstructionScope {
1250 public:
John McCall7f416cc2015-09-08 08:05:57 +00001251 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001252 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1253 CGF.CXXDefaultInitExprThis = This;
1254 }
1255 ~FieldConstructionScope() {
1256 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1257 }
1258
1259 private:
1260 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001261 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001262 };
1263
1264 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1265 /// is overridden to be the object under construction.
1266 class CXXDefaultInitExprScope {
1267 public:
1268 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001269 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1270 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1271 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1272 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001273 }
1274 ~CXXDefaultInitExprScope() {
1275 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001276 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001277 }
1278
1279 public:
1280 CodeGenFunction &CGF;
1281 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001282 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001283 };
1284
Richard Smith410306b2016-12-12 02:53:20 +00001285 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1286 /// current loop index is overridden.
1287 class ArrayInitLoopExprScope {
1288 public:
1289 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1290 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1291 CGF.ArrayInitIndex = Index;
1292 }
1293 ~ArrayInitLoopExprScope() {
1294 CGF.ArrayInitIndex = OldArrayInitIndex;
1295 }
1296
1297 private:
1298 CodeGenFunction &CGF;
1299 llvm::Value *OldArrayInitIndex;
1300 };
1301
Richard Smith5179eb72016-06-28 19:03:57 +00001302 class InlinedInheritingConstructorScope {
1303 public:
1304 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1305 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1306 OldCurCodeDecl(CGF.CurCodeDecl),
1307 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1308 OldCXXABIThisValue(CGF.CXXABIThisValue),
1309 OldCXXThisValue(CGF.CXXThisValue),
1310 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1311 OldCXXThisAlignment(CGF.CXXThisAlignment),
1312 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1313 OldCXXInheritedCtorInitExprArgs(
1314 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1315 CGF.CurGD = GD;
1316 CGF.CurFuncDecl = CGF.CurCodeDecl =
1317 cast<CXXConstructorDecl>(GD.getDecl());
1318 CGF.CXXABIThisDecl = nullptr;
1319 CGF.CXXABIThisValue = nullptr;
1320 CGF.CXXThisValue = nullptr;
1321 CGF.CXXABIThisAlignment = CharUnits();
1322 CGF.CXXThisAlignment = CharUnits();
1323 CGF.ReturnValue = Address::invalid();
1324 CGF.FnRetTy = QualType();
1325 CGF.CXXInheritedCtorInitExprArgs.clear();
1326 }
1327 ~InlinedInheritingConstructorScope() {
1328 CGF.CurGD = OldCurGD;
1329 CGF.CurFuncDecl = OldCurFuncDecl;
1330 CGF.CurCodeDecl = OldCurCodeDecl;
1331 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1332 CGF.CXXABIThisValue = OldCXXABIThisValue;
1333 CGF.CXXThisValue = OldCXXThisValue;
1334 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1335 CGF.CXXThisAlignment = OldCXXThisAlignment;
1336 CGF.ReturnValue = OldReturnValue;
1337 CGF.FnRetTy = OldFnRetTy;
1338 CGF.CXXInheritedCtorInitExprArgs =
1339 std::move(OldCXXInheritedCtorInitExprArgs);
1340 }
1341
1342 private:
1343 CodeGenFunction &CGF;
1344 GlobalDecl OldCurGD;
1345 const Decl *OldCurFuncDecl;
1346 const Decl *OldCurCodeDecl;
1347 ImplicitParamDecl *OldCXXABIThisDecl;
1348 llvm::Value *OldCXXABIThisValue;
1349 llvm::Value *OldCXXThisValue;
1350 CharUnits OldCXXABIThisAlignment;
1351 CharUnits OldCXXThisAlignment;
1352 Address OldReturnValue;
1353 QualType OldFnRetTy;
1354 CallArgList OldCXXInheritedCtorInitExprArgs;
1355 };
1356
Richard Smith852c9db2013-04-20 22:23:05 +00001357private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001358 /// CXXThisDecl - When generating code for a C++ member function,
1359 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001360 ImplicitParamDecl *CXXABIThisDecl;
1361 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001362 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001363 CharUnits CXXABIThisAlignment;
1364 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001365
Richard Smith852c9db2013-04-20 22:23:05 +00001366 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1367 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001368 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001369
Richard Smith410306b2016-12-12 02:53:20 +00001370 /// The current array initialization index when evaluating an
1371 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1372 llvm::Value *ArrayInitIndex = nullptr;
1373
Richard Smith5179eb72016-06-28 19:03:57 +00001374 /// The values of function arguments to use when evaluating
1375 /// CXXInheritedCtorInitExprs within this context.
1376 CallArgList CXXInheritedCtorInitExprArgs;
1377
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001378 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1379 /// destructor, this will hold the implicit argument (e.g. VTT).
1380 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1381 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001382
John McCallce1de612011-01-26 04:00:11 +00001383 /// OutermostConditional - Points to the outermost active
1384 /// conditional control. This is used so that we know if a
1385 /// temporary should be destroyed conditionally.
1386 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001387
Nadav Rotem1da30942013-03-23 06:43:35 +00001388 /// The current lexical scope.
1389 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001390
Adrian Prantldc237b52013-05-16 00:41:26 +00001391 /// The current source location that should be used for exception
1392 /// handling code.
1393 SourceLocation CurEHLocation;
1394
John McCall7f416cc2015-09-08 08:05:57 +00001395 /// BlockByrefInfos - For each __block variable, contains
1396 /// information about the layout of the variable.
1397 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001398
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001399 /// Used by -fsanitize=nullability-return to determine whether the return
1400 /// value can be checked.
1401 llvm::Value *RetValNullabilityPrecondition = nullptr;
1402
1403 /// Check if -fsanitize=nullability-return instrumentation is required for
1404 /// this function.
1405 bool requiresReturnValueNullabilityCheck() const {
1406 return RetValNullabilityPrecondition;
1407 }
1408
John McCallbd309292010-07-06 01:34:17 +00001409 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001410 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001411 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001412
Vitaly Buka1c943322016-10-26 01:59:57 +00001413 /// True if we need emit the life-time markers.
1414 const bool ShouldEmitLifetimeMarkers;
1415
Xiuli Panbe6da4b2017-05-04 07:31:20 +00001416 /// Add OpenCL kernel arg metadata and the kernel attribute meatadata to
1417 /// the function metadata.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001418 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1419 llvm::Function *Fn);
1420
Chris Lattnerbed31442007-05-28 01:07:47 +00001421public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001422 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001423 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001424
John McCall8ed55a52010-09-02 09:58:18 +00001425 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001426 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001427 CGDebugInfo *getDebugInfo() {
1428 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001429 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001430 return DebugInfo;
1431 }
1432 void disableDebugInfo() { DisableDebugInfo = true; }
1433 void enableDebugInfo() { DisableDebugInfo = false; }
1434
John McCall31168b02011-06-15 23:02:42 +00001435 bool shouldUseFusedARCCalls() {
1436 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1437 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001438
David Blaikiebbafb8a2012-03-11 07:00:24 +00001439 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001440
Bill Wendlingf0724e82011-09-19 20:31:14 +00001441 /// Returns a pointer to the function's exception object and selector slot,
1442 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001443 Address getExceptionSlot();
1444 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001445
Bill Wendling79a70e42011-09-15 18:57:19 +00001446 /// Returns the contents of the function's exception object and selector
1447 /// slots.
1448 llvm::Value *getExceptionFromSlot();
1449 llvm::Value *getSelectorFromSlot();
1450
John McCall7f416cc2015-09-08 08:05:57 +00001451 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001452
John McCallbd309292010-07-06 01:34:17 +00001453 llvm::BasicBlock *getUnreachableBlock() {
1454 if (!UnreachableBlock) {
1455 UnreachableBlock = createBasicBlock("unreachable");
1456 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1457 }
1458 return UnreachableBlock;
1459 }
1460
1461 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001462 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001463 return getInvokeDestImpl();
1464 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001465
David Majnemer25eb1652016-03-01 19:42:53 +00001466 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001467
John McCallc8e01702013-04-16 22:48:15 +00001468 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001469 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001470
Daniel Dunbar12347492009-02-23 17:26:39 +00001471 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001472 // Cleanups
1473 //===--------------------------------------------------------------------===//
1474
John McCall7f416cc2015-09-08 08:05:57 +00001475 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001476
John McCall178360e2011-07-11 08:38:19 +00001477 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001478 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001479 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001480 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001481 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001482 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1483 llvm::Value *arrayEnd,
1484 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001485 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001486 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001487
John McCall4bd0fb12011-07-12 16:41:08 +00001488 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001489 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001490 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001491 Address addr, QualType type);
1492 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001493 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001494 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001495 QualType type, Destroyer *destroyer,
1496 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001497 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1498 llvm::Value *CompletePtr,
1499 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001500 void pushStackRestore(CleanupKind kind, Address SPMem);
1501 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001502 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001503 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001504 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001505 bool useEHCleanupForArray,
1506 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001507 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001508 QualType elementType, CharUnits elementAlign,
1509 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001510 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001511
Peter Collingbourne1425b452012-01-26 03:33:36 +00001512 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001513
John McCall82fe67b2011-07-09 01:37:26 +00001514 /// Determines whether an EH cleanup is required to destroy a type
1515 /// with the given destruction kind.
1516 bool needsEHCleanup(QualType::DestructionKind kind) {
1517 switch (kind) {
1518 case QualType::DK_none:
1519 return false;
1520 case QualType::DK_cxx_destructor:
1521 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001522 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001523 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001524 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001525 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1526 }
1527 llvm_unreachable("bad destruction kind");
1528 }
1529
John McCall4bd0fb12011-07-12 16:41:08 +00001530 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1531 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1532 }
1533
John McCall82fe67b2011-07-09 01:37:26 +00001534 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001535 // Objective-C
1536 //===--------------------------------------------------------------------===//
1537
Chris Lattner4bd55962008-03-30 23:03:07 +00001538 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001539
David Blaikief1425802015-01-14 00:04:42 +00001540 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001541
Mike Stumpfc496822009-02-08 23:14:22 +00001542 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001543 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1544 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001545 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001546 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001547 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001548 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001549
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001550 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1551 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001552
Mike Stumpfc496822009-02-08 23:14:22 +00001553 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1554 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001555 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1556 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001557 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001558 const ObjCPropertyImplDecl *propImpl,
1559 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001560
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001561 //===--------------------------------------------------------------------===//
1562 // Block Bits
1563 //===--------------------------------------------------------------------===//
1564
John McCall351762c2011-02-07 10:33:21 +00001565 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001566 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001567
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001568 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001569 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001570 const DeclMapTy &ldm,
1571 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001572
John McCallad7c5c12011-02-08 08:22:06 +00001573 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1574 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001575 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1576 const ObjCPropertyImplDecl *PID);
1577 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1578 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001579 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001580
John McCallad7c5c12011-02-08 08:22:06 +00001581 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1582
John McCall73064872011-03-31 01:59:53 +00001583 class AutoVarEmission;
1584
1585 void emitByrefStructureInit(const AutoVarEmission &emission);
1586 void enterByrefCleanup(const AutoVarEmission &emission);
1587
John McCall7f416cc2015-09-08 08:05:57 +00001588 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1589 llvm::Value *ptr);
1590
1591 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001592 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1593
1594 /// BuildBlockByrefAddress - Computes the location of the
1595 /// data in a variable which is declared as __block.
1596 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1597 bool followForward = true);
1598 Address emitBlockByrefAddress(Address baseAddr,
1599 const BlockByrefInfo &info,
1600 bool followForward,
1601 const llvm::Twine &name);
1602
1603 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001604
Richard Smith5179eb72016-06-28 19:03:57 +00001605 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1606
John McCalla738c252011-03-09 04:27:21 +00001607 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1608 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001609 /// \brief Emit code for the start of a function.
1610 /// \param Loc The location to be associated with the function.
1611 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001612 void StartFunction(GlobalDecl GD,
1613 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001614 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001615 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001616 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001617 SourceLocation Loc = SourceLocation(),
1618 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001619
Vedant Kumar7f809b22017-02-24 01:15:19 +00001620 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1621
John McCallb81884d2010-02-19 09:25:03 +00001622 void EmitConstructorBody(FunctionArgList &Args);
1623 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001624 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001625 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001626 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001627
Faisal Vali571df122013-09-29 08:45:24 +00001628 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001629 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001630 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001631 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001632 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1633 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001634 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001635
David Blaikiea0a1a872015-01-18 02:48:07 +00001636 /// \brief Emit the unified return block, trying to avoid its emission when
1637 /// possible.
1638 /// \return The debug location of the user written return statement if the
1639 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001640 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001641
Mike Stumpfc496822009-02-08 23:14:22 +00001642 /// FinishFunction - Complete IR generation of the current function. It is
1643 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001644 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001645
Nico Weber1bebad12015-02-11 22:33:32 +00001646 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1647 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001648
John McCallb92ab1a2016-10-26 23:46:34 +00001649 void EmitCallAndReturnForThunk(llvm::Constant *Callee,
1650 const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001651
John McCall7f416cc2015-09-08 08:05:57 +00001652 void FinishThunk();
1653
Reid Klecknerab2090d2014-07-26 01:34:32 +00001654 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1655 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1656 llvm::Value *Callee);
1657
Rafael Espindolad6e66942015-07-13 06:07:58 +00001658 /// Generate a thunk for the given method.
1659 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001660 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001661
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001662 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1663 const CGFunctionInfo &FnInfo,
1664 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001665
Douglas Gregor94f9a482010-05-05 05:51:00 +00001666 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1667 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001668
Richard Smith30e304e2016-12-14 00:03:17 +00001669 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001670
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001671 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1672 struct VPtr {
1673 BaseSubobject Base;
1674 const CXXRecordDecl *NearestVBase;
1675 CharUnits OffsetFromNearestVBase;
1676 const CXXRecordDecl *VTableClass;
1677 };
1678
1679 /// Initialize the vtable pointer of the given subobject.
1680 void InitializeVTablePointer(const VPtr &vptr);
1681
1682 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001683
1684 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001685 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1686
1687 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1688 CharUnits OffsetFromNearestVBase,
1689 bool BaseIsNonVirtualPrimaryBase,
1690 const CXXRecordDecl *VTableClass,
1691 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001692
Anders Carlssond5895932010-03-28 21:07:49 +00001693 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001694
Dan Gohman8fc50c22010-10-26 18:44:08 +00001695 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1696 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001697 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1698 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001699
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001700 enum CFITypeCheckKind {
1701 CFITCK_VCall,
1702 CFITCK_NVCall,
1703 CFITCK_DerivedCast,
1704 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001705 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001706 };
1707
Peter Collingbourned2926c92015-03-14 02:42:25 +00001708 /// \brief Derived is the presumed address of an object of type T after a
1709 /// cast. If T is a polymorphic class type, emit a check that the virtual
1710 /// table for Derived belongs to a class derived from T.
1711 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001712 bool MayBeNull, CFITypeCheckKind TCK,
1713 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001714
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001715 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1716 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001717 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001718 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001719
Peter Collingbourned2926c92015-03-14 02:42:25 +00001720 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001721 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001722 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1723 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001724
Peter Collingbournefb532b92016-02-24 20:46:36 +00001725 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001726 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1727 /// enabled, emit a check that VTable is a member of RD's type identifier.
1728 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1729 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001730
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001731 /// Returns whether we should perform a type checked load when loading a
1732 /// virtual function for virtual calls to members of RD. This is generally
1733 /// true when both vcall CFI and whole-program-vtables are enabled.
1734 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1735
1736 /// Emit a type checked load from the given vtable.
1737 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1738 uint64_t VTableByteOffset);
1739
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001740 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1741 /// expr can be devirtualized.
1742 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1743 const CXXMethodDecl *MD);
1744
John McCallf99a6312010-07-21 05:30:47 +00001745 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1746 /// given phase of destruction for a destructor. The end result
1747 /// should call destructors on members and base classes in reverse
1748 /// order of their construction.
1749 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001750
Chris Lattner3c77a352010-06-22 00:03:40 +00001751 /// ShouldInstrumentFunction - Return true if the current function should be
1752 /// instrumented with __cyg_profile_func_* calls
1753 bool ShouldInstrumentFunction();
1754
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001755 /// ShouldXRayInstrument - Return true if the current function should be
1756 /// instrumented with XRay nop sleds.
1757 bool ShouldXRayInstrumentFunction() const;
1758
Chris Lattner3c77a352010-06-22 00:03:40 +00001759 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1760 /// instrumentation function with the current function and the call site, if
1761 /// function instrumentation is enabled.
1762 void EmitFunctionInstrumentation(const char *Fn);
1763
Roman Divacky178e01602011-02-10 16:52:03 +00001764 /// EmitMCountInstrumentation - Emit call to .mcount.
1765 void EmitMCountInstrumentation();
1766
Mike Stumpfc496822009-02-08 23:14:22 +00001767 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1768 /// arguments for the given function. This is also responsible for naming the
1769 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001770 void EmitFunctionProlog(const CGFunctionInfo &FI,
1771 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001772 const FunctionArgList &Args);
1773
Mike Stumpfc496822009-02-08 23:14:22 +00001774 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1775 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001776 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1777 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001778
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001779 /// Emit a test that checks if the return value \p RV is nonnull.
1780 void EmitReturnValueCheck(llvm::Value *RV, SourceLocation EndLoc);
1781
Mike Stump1d849212009-12-07 23:38:24 +00001782 /// EmitStartEHSpec - Emit the start of the exception spec.
1783 void EmitStartEHSpec(const Decl *D);
1784
1785 /// EmitEndEHSpec - Emit the end of the exception spec.
1786 void EmitEndEHSpec(const Decl *D);
1787
John McCallbd309292010-07-06 01:34:17 +00001788 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1789 llvm::BasicBlock *getTerminateLandingPad();
1790
1791 /// getTerminateHandler - Return a handler (not a landing pad, just
1792 /// a catch handler) that just calls terminate. This is used when
1793 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001794 llvm::BasicBlock *getTerminateHandler();
1795
Chris Lattnera5f58b02011-07-09 17:41:47 +00001796 llvm::Type *ConvertTypeForMem(QualType T);
1797 llvm::Type *ConvertType(QualType T);
1798 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001799 return ConvertType(getContext().getTypeDeclType(T));
1800 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001801
Mike Stumpfc496822009-02-08 23:14:22 +00001802 /// LoadObjCSelf - Load the value of self. This function is only valid while
1803 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001804 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001805
1806 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001807 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001808
Chris Lattner54fb19e2007-06-22 22:02:34 +00001809 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1810 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001811 static TypeEvaluationKind getEvaluationKind(QualType T);
1812
1813 static bool hasScalarEvaluationKind(QualType T) {
1814 return getEvaluationKind(T) == TEK_Scalar;
1815 }
1816
1817 static bool hasAggregateEvaluationKind(QualType T) {
1818 return getEvaluationKind(T) == TEK_Aggregate;
1819 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001820
1821 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001822 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001823 llvm::Function *parent = nullptr,
1824 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001825#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001826 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001827#else
John McCallad7c5c12011-02-08 08:22:06 +00001828 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001829#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001830 }
Mike Stumpfc496822009-02-08 23:14:22 +00001831
Chris Lattnerac248202007-05-30 00:13:02 +00001832 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1833 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001834 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001835
Mike Stumpe5311b02009-11-30 20:08:49 +00001836 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1837 /// another basic block, simplify it. This assumes that no other code could
1838 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001839 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1840
Mike Stumpfc496822009-02-08 23:14:22 +00001841 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1842 /// adding a fall-through branch from the current insert block if
1843 /// necessary. It is legal to call this function even if there is no current
1844 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001845 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001846 /// IsFinished - If true, indicates that the caller has finished emitting
1847 /// branches to the given block and does not expect to emit code into it. This
1848 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001849 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001850
John McCall8e4c74b2011-08-11 02:22:43 +00001851 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1852 /// near its uses, and leave the insertion point in it.
1853 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1854
Mike Stumpfc496822009-02-08 23:14:22 +00001855 /// EmitBranch - Emit a branch to the specified basic block from the current
1856 /// insert block, taking care to avoid creation of branches from dummy
1857 /// blocks. It is legal to call this function even if there is no current
1858 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001859 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001860 /// This function clears the current insertion point. The caller should follow
1861 /// calls to this function with calls to Emit*Block prior to generation new
1862 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001863 void EmitBranch(llvm::BasicBlock *Block);
1864
Mike Stumpfc496822009-02-08 23:14:22 +00001865 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1866 /// indicates that the current code being emitted is unreachable.
1867 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001868 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001869 }
1870
Mike Stumpfc496822009-02-08 23:14:22 +00001871 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1872 /// emitted IR has a place to go. Note that by definition, if this function
1873 /// creates a block then that block is unreachable; callers may do better to
1874 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001875 void EnsureInsertPoint() {
1876 if (!HaveInsertPoint())
1877 EmitBlock(createBasicBlock());
1878 }
Mike Stumpfc496822009-02-08 23:14:22 +00001879
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001880 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001881 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001882 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001883
Chris Lattnere9a64532007-06-22 21:44:33 +00001884 //===--------------------------------------------------------------------===//
1885 // Helpers
1886 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001887
John McCall7f416cc2015-09-08 08:05:57 +00001888 LValue MakeAddrLValue(Address Addr, QualType T,
1889 AlignmentSource AlignSource = AlignmentSource::Type) {
1890 return LValue::MakeAddr(Addr, T, getContext(), AlignSource,
Dan Gohman947c9af2010-10-14 23:06:10 +00001891 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001892 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001893
John McCall7f416cc2015-09-08 08:05:57 +00001894 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1895 AlignmentSource AlignSource = AlignmentSource::Type) {
1896 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1897 AlignSource, CGM.getTBAAInfo(T));
1898 }
1899
1900 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001901 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001902 CharUnits getNaturalTypeAlignment(QualType T,
1903 AlignmentSource *Source = nullptr,
1904 bool forPointeeType = false);
1905 CharUnits getNaturalPointeeTypeAlignment(QualType T,
1906 AlignmentSource *Source = nullptr);
1907
1908 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
1909 AlignmentSource *Source = nullptr);
1910 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001911
Alexey Bataev31300ed2016-02-04 11:27:03 +00001912 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
1913 AlignmentSource *Source = nullptr);
1914 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1915
Chris Lattnere9a64532007-06-22 21:44:33 +00001916 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001917 /// block. The caller is responsible for setting an appropriate alignment on
1918 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001919 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001920 const Twine &Name = "tmp");
John McCall7f416cc2015-09-08 08:05:57 +00001921 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
1922 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001923
John McCall7f416cc2015-09-08 08:05:57 +00001924 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1925 /// default ABI alignment of the given LLVM type.
1926 ///
1927 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1928 /// any given AST type that happens to have been lowered to the
1929 /// given IR type. This should only ever be used for function-local,
1930 /// IR-driven manipulations like saving and restoring a value. Do
1931 /// not hand this address off to arbitrary IRGen routines, and especially
1932 /// do not pass it as an argument to a function that might expect a
1933 /// properly ABI-aligned value.
1934 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1935 const Twine &Name = "tmp");
1936
1937 /// InitTempAlloca - Provide an initial value for the given alloca which
1938 /// will be observable at all locations in the function.
1939 ///
1940 /// The address should be something that was returned from one of
1941 /// the CreateTempAlloca or CreateMemTemp routines, and the
1942 /// initializer must be valid in the entry block (i.e. it must
1943 /// either be a constant or an argument value).
1944 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001945
Daniel Dunbard0049182010-02-16 19:44:13 +00001946 /// CreateIRTemp - Create a temporary IR object of the given type, with
1947 /// appropriate alignment. This routine should only be used when an temporary
1948 /// value needs to be stored into an alloca (for example, to avoid explicit
1949 /// PHI construction), but the type is the IR type, not the type appropriate
1950 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001951 ///
1952 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1953 /// ConvertType instead of ConvertTypeForMem.
1954 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001955
Daniel Dunbara7566f12010-02-09 02:48:28 +00001956 /// CreateMemTemp - Create a temporary memory object of the given type, with
1957 /// appropriate alignment.
John McCall7f416cc2015-09-08 08:05:57 +00001958 Address CreateMemTemp(QualType T, const Twine &Name = "tmp");
1959 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001960
John McCall7a626f62010-09-15 10:14:12 +00001961 /// CreateAggTemp - Create a temporary memory object for the given
1962 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001963 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00001964 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001965 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001966 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001967 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001968 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001969 }
1970
John McCallad7c5c12011-02-08 08:22:06 +00001971 /// Emit a cast to void* in the appropriate address space.
1972 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1973
Chris Lattner8394d792007-06-05 20:53:16 +00001974 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1975 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001976 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001977
John McCalla2342eb2010-12-05 02:00:02 +00001978 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1979 void EmitIgnoredExpr(const Expr *E);
1980
Chris Lattner4647a212007-08-31 22:49:20 +00001981 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1982 /// any type. The result is returned as an RValue struct. If this is an
1983 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1984 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001985 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001986 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001987 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001988 AggValueSlot aggSlot = AggValueSlot::ignored(),
1989 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001990
Mike Stumpfc496822009-02-08 23:14:22 +00001991 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1992 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00001993 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001994
Charles Davisc7d5c942015-09-17 20:55:33 +00001995 /// Emit a "reference" to a __builtin_ms_va_list; this is
1996 /// always the value of the expression, because a __builtin_ms_va_list is a
1997 /// pointer to a char.
1998 Address EmitMSVAListRef(const Expr *E);
1999
Gor Nishanov5eb58582017-03-26 02:18:05 +00002000 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
Mike Stumpfc496822009-02-08 23:14:22 +00002001 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00002002 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00002003
John McCall91ca10f2011-03-08 09:11:50 +00002004 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00002005 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00002006 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002007 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00002008
John McCall7f416cc2015-09-08 08:05:57 +00002009 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00002010
John McCall91ca10f2011-03-08 09:11:50 +00002011 /// EmitExprAsInit - Emits the code necessary to initialize a
2012 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00002013 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002014 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00002015
Fariborz Jahanian78652202013-01-25 23:57:05 +00002016 /// hasVolatileMember - returns true if aggregate type has a volatile
2017 /// member.
2018 bool hasVolatileMember(QualType T) {
2019 if (const RecordType *RT = T->getAs<RecordType>()) {
2020 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2021 return RD->hasVolatileMember();
2022 }
2023 return false;
2024 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002025 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002026 ///
2027 /// The difference to EmitAggregateCopy is that tail padding is not copied.
2028 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00002029 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00002030 QualType EltTy) {
2031 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00002032 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002033 }
2034
John McCall7f416cc2015-09-08 08:05:57 +00002035 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
2036 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00002037 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00002038 /*IsAssignment=*/false);
2039 }
2040
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002041 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00002042 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00002043 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00002044 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002045 /// \param isAssignment - If false, allow padding to be copied. This often
2046 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00002047 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00002048 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002049 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00002050
Anders Carlsson9396a892008-09-11 09:15:33 +00002051 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00002052 Address GetAddrOfLocalVar(const VarDecl *VD) {
2053 auto it = LocalDeclMap.find(VD);
2054 assert(it != LocalDeclMap.end() &&
2055 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2056 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00002057 }
Mike Stumpfc496822009-02-08 23:14:22 +00002058
John McCallc07a0c72011-02-17 10:25:35 +00002059 /// getOpaqueLValueMapping - Given an opaque value expression (which
2060 /// must be mapped to an l-value), return its mapping.
2061 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
2062 assert(OpaqueValueMapping::shouldBindAsLValue(e));
2063
2064 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
2065 it = OpaqueLValues.find(e);
2066 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
2067 return it->second;
2068 }
2069
2070 /// getOpaqueRValueMapping - Given an opaque value expression (which
2071 /// must be mapped to an r-value), return its mapping.
2072 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
2073 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
2074
2075 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
2076 it = OpaqueRValues.find(e);
2077 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00002078 return it->second;
2079 }
2080
Richard Smith410306b2016-12-12 02:53:20 +00002081 /// Get the index of the current ArrayInitLoopExpr, if any.
2082 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2083
Dan Gohman75d69da2008-05-22 00:50:06 +00002084 /// getAccessedFieldNo - Given an encoded value and a result number, return
2085 /// the input field number being accessed.
2086 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2087
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002088 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002089 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002090
Vedant Kumarffd7c882017-04-14 22:03:34 +00002091 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2092 static bool IsWrappedCXXThis(const Expr *E);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00002093
Anders Carlssonc0964b62010-05-22 17:35:42 +00002094 /// EmitNullInitialization - Generate code to set a value of the given type to
2095 /// null, If the type contains data member pointers, they will be initialized
2096 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002097 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002098
Charles Davisc7d5c942015-09-17 20:55:33 +00002099 /// Emits a call to an LLVM variable-argument intrinsic, either
2100 /// \c llvm.va_start or \c llvm.va_end.
2101 /// \param ArgValue A reference to the \c va_list as emitted by either
2102 /// \c EmitVAListRef or \c EmitMSVAListRef.
2103 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2104 /// calls \c llvm.va_end.
2105 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2106
2107 /// Generate code to get an argument from the passed in pointer
2108 /// and update it accordingly.
2109 /// \param VE The \c VAArgExpr for which to generate code.
2110 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2111 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2112 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002113 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002114 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002115 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002116
John McCall82fe67b2011-07-09 01:37:26 +00002117 /// emitArrayLength - Compute the length of an array, even if it's a
2118 /// VLA, and drill down to the base element type.
2119 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2120 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002121 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002122
John McCall23c29fe2011-06-24 21:55:10 +00002123 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2124 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002125 ///
2126 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002127 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002128
John McCall23c29fe2011-06-24 21:55:10 +00002129 /// getVLASize - Returns an LLVM value that corresponds to the size,
2130 /// in non-variably-sized elements, of a variable length array type,
2131 /// plus that largest non-variably-sized element type. Assumes that
2132 /// the type has already been emitted with EmitVariablyModifiedType.
2133 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
2134 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002135
Anders Carlssona5d077d2009-04-14 16:58:56 +00002136 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2137 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002138 llvm::Value *LoadCXXThis() {
2139 assert(CXXThisValue && "no 'this' value for this function");
2140 return CXXThisValue;
2141 }
John McCall7f416cc2015-09-08 08:05:57 +00002142 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002143
Anders Carlssone36a6b32010-01-02 01:01:18 +00002144 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2145 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002146 // FIXME: Every place that calls LoadCXXVTT is something
2147 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002148 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002149 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2150 return CXXStructorImplicitParamValue;
2151 }
2152
John McCall6ce74722010-02-16 04:15:37 +00002153 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002154 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002155 Address
2156 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002157 const CXXRecordDecl *Derived,
2158 const CXXRecordDecl *Base,
2159 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002160
John McCall7f416cc2015-09-08 08:05:57 +00002161 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2162
Mike Stumpe5311b02009-11-30 20:08:49 +00002163 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2164 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002165 Address GetAddressOfBaseClass(Address Value,
2166 const CXXRecordDecl *Derived,
2167 CastExpr::path_const_iterator PathBegin,
2168 CastExpr::path_const_iterator PathEnd,
2169 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002170
John McCall7f416cc2015-09-08 08:05:57 +00002171 Address GetAddressOfDerivedClass(Address Value,
2172 const CXXRecordDecl *Derived,
2173 CastExpr::path_const_iterator PathBegin,
2174 CastExpr::path_const_iterator PathEnd,
2175 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002176
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002177 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2178 /// base constructor/destructor with virtual bases.
2179 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2180 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2181 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2182 bool Delegating);
2183
John McCallf8ff7b92010-02-23 00:48:20 +00002184 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2185 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002186 const FunctionArgList &Args,
2187 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002188 // It's important not to confuse this and the previous function. Delegating
2189 // constructors are the C++0x feature. The constructor delegate optimization
2190 // is used to reduce duplication in the base and complete consturctors where
2191 // they are substantially the same.
2192 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2193 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002194
Richard Smith5179eb72016-06-28 19:03:57 +00002195 /// Emit a call to an inheriting constructor (that is, one that invokes a
2196 /// constructor inherited from a base class) by inlining its definition. This
2197 /// is necessary if the ABI does not support forwarding the arguments to the
2198 /// base class constructor (because they're variadic or similar).
2199 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2200 CXXCtorType CtorType,
2201 bool ForVirtualBase,
2202 bool Delegating,
2203 CallArgList &Args);
2204
2205 /// Emit a call to a constructor inherited from a base class, passing the
2206 /// current constructor's arguments along unmodified (without even making
2207 /// a copy).
2208 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2209 bool ForVirtualBase, Address This,
2210 bool InheritedFromVBase,
2211 const CXXInheritedCtorInitExpr *E);
2212
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002213 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002214 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002215 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002216
Richard Smith5179eb72016-06-28 19:03:57 +00002217 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2218 bool ForVirtualBase, bool Delegating,
2219 Address This, CallArgList &Args);
2220
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002221 /// Emit assumption load for all bases. Requires to be be called only on
2222 /// most-derived class and not under construction of the object.
2223 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2224
2225 /// Emit assumption that vptr load == global vtable.
2226 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2227
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002228 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002229 Address This, Address Src,
2230 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002231
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002232 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002233 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002234 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002235 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002236 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002237
Anders Carlssond49844b2009-09-23 02:45:36 +00002238 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2239 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002240 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002241 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002242 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002243
John McCall82fe67b2011-07-09 01:37:26 +00002244 static Destroyer destroyCXXObject;
2245
Anders Carlsson0a637412009-05-29 21:03:38 +00002246 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002247 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002248 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002249
John McCall99210dc2011-09-15 06:49:18 +00002250 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002251 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002252 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002253 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002254
Peter Collingbourne702b2842011-11-27 22:09:22 +00002255 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002256 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002257
David Majnemerdc012fa2015-04-22 21:38:15 +00002258 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2259 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2260
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002261 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002262 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002263
Eli Friedman24f55432009-11-18 00:57:03 +00002264 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002265 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2266 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002267
Richard Smith760520b2014-06-03 23:27:44 +00002268 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2269 const Expr *Arg, bool IsDelete);
2270
John McCall7f416cc2015-09-08 08:05:57 +00002271 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2272 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2273 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002274
Richard Smith69d0d262012-08-24 00:54:33 +00002275 /// \brief Situations in which we might emit a check for the suitability of a
2276 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002277 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002278 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002279 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002280 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002281 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002282 /// Checking the bound value in a reference binding. Must be suitably sized
2283 /// and aligned, but is not required to refer to an object (until the
2284 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002285 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002286 /// Checking the object expression in a non-static data member access. Must
2287 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002288 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002289 /// Checking the 'this' pointer for a call to a non-static member function.
2290 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002291 TCK_MemberCall,
2292 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002293 TCK_ConstructorCall,
2294 /// Checking the operand of a static_cast to a derived pointer type. Must be
2295 /// null or an object within its lifetime.
2296 TCK_DowncastPointer,
2297 /// Checking the operand of a static_cast to a derived reference type. Must
2298 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002299 TCK_DowncastReference,
2300 /// Checking the operand of a cast to a base object. Must be suitably sized
2301 /// and aligned.
2302 TCK_Upcast,
2303 /// Checking the operand of a cast to a virtual base object. Must be an
2304 /// object within its lifetime.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002305 TCK_UpcastToVirtualBase,
2306 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
2307 TCK_NonnullAssign
Richard Smith69d0d262012-08-24 00:54:33 +00002308 };
2309
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002310 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2311 /// calls to EmitTypeCheck can be skipped.
2312 bool sanitizePerformTypeCheck() const;
2313
Richard Smith4d1458e2012-09-08 02:08:36 +00002314 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002315 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002316 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002317 QualType Type, CharUnits Alignment = CharUnits::Zero(),
Vedant Kumar18348ea2017-02-17 23:22:55 +00002318 SanitizerSet SkippedChecks = SanitizerSet());
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002319
Richard Smith539e4a72013-02-23 02:53:19 +00002320 /// \brief Emit a check that \p Base points into an array object, which
2321 /// we can access at index \p Index. \p Accessed should be \c false if we
2322 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2323 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2324 QualType IndexType, bool Accessed);
2325
Chris Lattner116ce8f2010-01-09 21:40:03 +00002326 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2327 bool isInc, bool isPre);
2328 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2329 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002330
2331 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002332 llvm::Value *OffsetValue = nullptr) {
2333 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2334 OffsetValue);
2335 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002336
Amara Emerson652795d2016-11-10 14:44:30 +00002337 /// Converts Location to a DebugLoc, if debug information is enabled.
2338 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2339
2340
Chris Lattner8394d792007-06-05 20:53:16 +00002341 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002342 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002343 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002344
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002345 /// EmitDecl - Emit a declaration.
2346 ///
2347 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002348 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002349
John McCall1c9c3fd2010-10-15 04:57:14 +00002350 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002351 ///
2352 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002353 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002354
David Blaikie73ca5692014-12-09 00:32:22 +00002355 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002356 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002357
John McCallbd309292010-07-06 01:34:17 +00002358 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2359 llvm::Value *Address);
2360
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002361 /// \brief Determine whether the given initializer is trivial in the sense
2362 /// that it requires no code to be generated.
2363 bool isTrivialInitializer(const Expr *Init);
2364
John McCall1c9c3fd2010-10-15 04:57:14 +00002365 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002366 ///
2367 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002368 void EmitAutoVarDecl(const VarDecl &D);
2369
2370 class AutoVarEmission {
2371 friend class CodeGenFunction;
2372
John McCall9e2e22f2011-02-22 07:16:58 +00002373 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002374
John McCall7f416cc2015-09-08 08:05:57 +00002375 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002376 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002377 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002378
2379 llvm::Value *NRVOFlag;
2380
2381 /// True if the variable is a __block variable.
2382 bool IsByRef;
2383
2384 /// True if the variable is of aggregate type and has a constant
2385 /// initializer.
2386 bool IsConstantAggregate;
2387
Nadav Rotem1da30942013-03-23 06:43:35 +00002388 /// Non-null if we should use lifetime annotations.
2389 llvm::Value *SizeForLifetimeMarkers;
2390
John McCall9e2e22f2011-02-22 07:16:58 +00002391 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002392 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002393
John McCallc533cb72011-02-22 06:44:22 +00002394 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002395 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002396 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002397 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002398
John McCall7f416cc2015-09-08 08:05:57 +00002399 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002400
2401 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002402 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2403
Craig Topper8a13c412014-05-21 05:09:00 +00002404 bool useLifetimeMarkers() const {
2405 return SizeForLifetimeMarkers != nullptr;
2406 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002407 llvm::Value *getSizeForLifetimeMarkers() const {
2408 assert(useLifetimeMarkers());
2409 return SizeForLifetimeMarkers;
2410 }
2411
2412 /// Returns the raw, allocated address, which is not necessarily
2413 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002414 Address getAllocatedAddress() const {
2415 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002416 }
2417
John McCallc533cb72011-02-22 06:44:22 +00002418 /// Returns the address of the object within this declaration.
2419 /// Note that this does not chase the forwarding pointer for
2420 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002421 Address getObjectAddress(CodeGenFunction &CGF) const {
2422 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002423
John McCall7f416cc2015-09-08 08:05:57 +00002424 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002425 }
2426 };
2427 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2428 void EmitAutoVarInit(const AutoVarEmission &emission);
2429 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002430 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2431 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002432
John McCall1c9c3fd2010-10-15 04:57:14 +00002433 void EmitStaticVarDecl(const VarDecl &D,
2434 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002435
John McCall7f416cc2015-09-08 08:05:57 +00002436 class ParamValue {
2437 llvm::Value *Value;
2438 unsigned Alignment;
2439 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2440 public:
2441 static ParamValue forDirect(llvm::Value *value) {
2442 return ParamValue(value, 0);
2443 }
2444 static ParamValue forIndirect(Address addr) {
2445 assert(!addr.getAlignment().isZero());
2446 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2447 }
2448
2449 bool isIndirect() const { return Alignment != 0; }
2450 llvm::Value *getAnyValue() const { return Value; }
2451
2452 llvm::Value *getDirectValue() const {
2453 assert(!isIndirect());
2454 return Value;
2455 }
2456
2457 Address getIndirectAddress() const {
2458 assert(isIndirect());
2459 return Address(Value, CharUnits::fromQuantity(Alignment));
2460 }
2461 };
2462
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002463 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002464 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002465
John McCallc07a0c72011-02-17 10:25:35 +00002466 /// protectFromPeepholes - Protect a value that we're intending to
2467 /// store to the side, but which will probably be used later, from
2468 /// aggressive peepholing optimizations that might delete it.
2469 ///
2470 /// Pass the result to unprotectFromPeepholes to declare that
2471 /// protection is no longer required.
2472 ///
2473 /// There's no particular reason why this shouldn't apply to
2474 /// l-values, it's just that no existing peepholes work on pointers.
2475 PeepholeProtection protectFromPeepholes(RValue rvalue);
2476 void unprotectFromPeepholes(PeepholeProtection protection);
2477
Erich Keane623efd82017-03-30 21:48:55 +00002478 void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment,
2479 llvm::Value *OffsetValue = nullptr) {
2480 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2481 OffsetValue);
2482 }
2483
Chris Lattner84915fa2007-06-02 04:16:21 +00002484 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002485 // Statement Emission
2486 //===--------------------------------------------------------------------===//
2487
Mike Stumpfc496822009-02-08 23:14:22 +00002488 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002489 void EmitStopPoint(const Stmt *S);
2490
Mike Stumpfc496822009-02-08 23:14:22 +00002491 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2492 /// this function even if there is no current insertion point.
2493 ///
2494 /// This function may clear the current insertion point; callers should use
2495 /// EnsureInsertPoint if they wish to subsequently generate code without first
2496 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002497 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002498
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002499 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002500 /// necessarily require an insertion point or debug information; typically
2501 /// because the statement amounts to a jump or a container of other
2502 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002503 ///
2504 /// \return True if the statement was handled.
2505 bool EmitSimpleStmt(const Stmt *S);
2506
John McCall7f416cc2015-09-08 08:05:57 +00002507 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2508 AggValueSlot AVS = AggValueSlot::ignored());
2509 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2510 bool GetLast = false,
2511 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002512 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002513
Mike Stumpfc496822009-02-08 23:14:22 +00002514 /// EmitLabel - Emit the block for the given label. It is legal to call this
2515 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002516 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002517
Chris Lattnerac248202007-05-30 00:13:02 +00002518 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002519 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002520 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002521 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002522 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002523
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002524 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002525 ArrayRef<const Attr *> Attrs = None);
2526 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002527 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002528 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002529 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002530 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002531 void EmitBreakStmt(const BreakStmt &S);
2532 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002533 void EmitSwitchStmt(const SwitchStmt &S);
2534 void EmitDefaultStmt(const DefaultStmt &S);
2535 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002536 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002537 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002538
Anders Carlsson2e744e82008-08-30 19:51:14 +00002539 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002540 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2541 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002542 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002543 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002544
Gor Nishanov8df64e92016-10-27 16:28:31 +00002545 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov90be1212017-03-06 21:12:54 +00002546 void EmitCoreturnStmt(const CoreturnStmt &S);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002547 RValue EmitCoawaitExpr(const CoawaitExpr &E,
2548 AggValueSlot aggSlot = AggValueSlot::ignored(),
2549 bool ignoreResult = false);
2550 RValue EmitCoyieldExpr(const CoyieldExpr &E,
2551 AggValueSlot aggSlot = AggValueSlot::ignored(),
2552 bool ignoreResult = false);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002553 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2554
John McCallb609d3f2010-07-07 06:56:46 +00002555 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2556 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002557
Anders Carlsson52d78a52009-09-27 18:58:34 +00002558 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002559 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002560 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002561 void EnterSEHTryStmt(const SEHTryStmt &S);
2562 void ExitSEHTryStmt(const SEHTryStmt &S);
2563
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002564 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002565 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002566
2567 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2568 const SEHExceptStmt &Except);
2569
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002570 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2571 const SEHFinallyStmt &Finally);
2572
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002573 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2574 llvm::Value *ParentFP,
2575 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002576 llvm::Value *EmitSEHExceptionCode();
2577 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002578 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002579
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002580 /// Scan the outlined statement for captures from the parent function. For
2581 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002582 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002583 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002584 bool IsFilter);
2585
2586 /// Recovers the address of a local in a parent function. ParentVar is the
2587 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002588 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002589 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2590 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002591 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2592 Address ParentVar,
2593 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002594
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002595 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002596 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002597
Alexey Bataev1189bd02016-01-26 12:20:39 +00002598 /// Returns calculated size of the specified type.
2599 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002600 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002601 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002602 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002603 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002604 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002605 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002606 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002607 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2608 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002609 /// \brief Perform element by element copying of arrays with type \a
2610 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2611 /// generated by \a CopyGen.
2612 ///
2613 /// \param DestAddr Address of the destination array.
2614 /// \param SrcAddr Address of the source array.
2615 /// \param OriginalType Type of destination and source arrays.
2616 /// \param CopyGen Copying procedure that copies value of single array element
2617 /// to another single array element.
2618 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002619 Address DestAddr, Address SrcAddr, QualType OriginalType,
2620 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002621 /// \brief Emit proper copying of data from one variable to another.
2622 ///
2623 /// \param OriginalType Original type of the copied variables.
2624 /// \param DestAddr Destination address.
2625 /// \param SrcAddr Source address.
2626 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2627 /// type of the base array element).
2628 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2629 /// the base array element).
2630 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2631 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002632 void EmitOMPCopy(QualType OriginalType,
2633 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002634 const VarDecl *DestVD, const VarDecl *SrcVD,
2635 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002636 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2637 /// \a X = \a E \a BO \a E.
2638 ///
2639 /// \param X Value to be updated.
2640 /// \param E Update value.
2641 /// \param BO Binary operation for update operation.
2642 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2643 /// expression, false otherwise.
2644 /// \param AO Atomic ordering of the generated atomic instructions.
2645 /// \param CommonGen Code generator for complex expressions that cannot be
2646 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002647 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2648 /// generated, <false, RValue::get(nullptr)> otherwise.
2649 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002650 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2651 llvm::AtomicOrdering AO, SourceLocation Loc,
2652 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002653 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002654 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002655 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2656 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002657 void EmitOMPUseDevicePtrClause(
2658 const OMPClause &C, OMPPrivateScope &PrivateScope,
2659 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002660 /// \brief Emit code for copyin clause in \a D directive. The next code is
2661 /// generated at the start of outlined functions for directives:
2662 /// \code
2663 /// threadprivate_var1 = master_threadprivate_var1;
2664 /// operator=(threadprivate_var2, master_threadprivate_var2);
2665 /// ...
2666 /// __kmpc_barrier(&loc, global_tid);
2667 /// \endcode
2668 ///
2669 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2670 /// \returns true if at least one copyin variable is found, false otherwise.
2671 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002672 /// \brief Emit initial code for lastprivate variables. If some variable is
2673 /// not also firstprivate, then the default initialization is used. Otherwise
2674 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2675 /// method.
2676 ///
2677 /// \param D Directive that may have 'lastprivate' directives.
2678 /// \param PrivateScope Private scope for capturing lastprivate variables for
2679 /// proper codegen in internal captured statement.
2680 ///
2681 /// \returns true if there is at least one lastprivate variable, false
2682 /// otherwise.
2683 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2684 OMPPrivateScope &PrivateScope);
2685 /// \brief Emit final copying of lastprivate values to original variables at
2686 /// the end of the worksharing or simd directive.
2687 ///
2688 /// \param D Directive that has at least one 'lastprivate' directives.
2689 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2690 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002691 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002692 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002693 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002694 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002695 /// Emit initial code for linear clauses.
2696 void EmitOMPLinearClause(const OMPLoopDirective &D,
2697 CodeGenFunction::OMPPrivateScope &PrivateScope);
2698 /// Emit final code for linear clauses.
2699 /// \param CondGen Optional conditional code for final part of codegen for
2700 /// linear clause.
2701 void EmitOMPLinearClauseFinal(
2702 const OMPLoopDirective &D,
2703 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002704 /// \brief Emit initial code for reduction variables. Creates reduction copies
2705 /// and initializes them with the values according to OpenMP standard.
2706 ///
2707 /// \param D Directive (possibly) with the 'reduction' clause.
2708 /// \param PrivateScope Private scope for capturing reduction variables for
2709 /// proper codegen in internal captured statement.
2710 ///
2711 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2712 OMPPrivateScope &PrivateScope);
2713 /// \brief Emit final update of reduction values to original variables at
2714 /// the end of the directive.
2715 ///
2716 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00002717 /// \param ReductionKind The kind of reduction to perform.
2718 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
2719 const OpenMPDirectiveKind ReductionKind);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002720 /// \brief Emit initial code for linear variables. Creates private copies
2721 /// and initializes them with the values according to OpenMP standard.
2722 ///
2723 /// \param D Directive (possibly) with the 'linear' clause.
2724 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002725
Alexey Bataev7292c292016-04-25 12:22:29 +00002726 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2727 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002728 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002729 TaskGenTy;
2730 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2731 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002732 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00002733
Alexey Bataev9959db52014-05-06 10:08:46 +00002734 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002735 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002736 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002737 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002738 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002739 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002740 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002741 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002742 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002743 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002744 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002745 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002746 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002747 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002748 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002749 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002750 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002751 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002752 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002753 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002754 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002755 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002756 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002757 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002758 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002759 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002760 void
2761 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002762 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002763 void
2764 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002765 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002766 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002767 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002768 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002769 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002770 void EmitOMPDistributeParallelForDirective(
2771 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002772 void EmitOMPDistributeParallelForSimdDirective(
2773 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002774 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002775 void EmitOMPTargetParallelForSimdDirective(
2776 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002777 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002778 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00002779 void
2780 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00002781 void EmitOMPTeamsDistributeParallelForSimdDirective(
2782 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00002783 void EmitOMPTeamsDistributeParallelForDirective(
2784 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00002785 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00002786 void EmitOMPTargetTeamsDistributeDirective(
2787 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00002788 void EmitOMPTargetTeamsDistributeParallelForDirective(
2789 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00002790 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
2791 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00002792 void EmitOMPTargetTeamsDistributeSimdDirective(
2793 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002794
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00002795 /// Emit device code for the target directive.
2796 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
2797 StringRef ParentName,
2798 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00002799 static void
2800 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2801 const OMPTargetParallelDirective &S);
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00002802 static void
2803 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2804 const OMPTargetTeamsDirective &S);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002805 /// \brief Emit inner loop of the worksharing/simd construct.
2806 ///
2807 /// \param S Directive, for which the inner loop must be emitted.
2808 /// \param RequiresCleanup true, if directive has some associated private
2809 /// variables.
2810 /// \param LoopCond Bollean condition for loop continuation.
2811 /// \param IncExpr Increment expression for loop control variable.
2812 /// \param BodyGen Generator for the inner body of the inner loop.
2813 /// \param PostIncGen Genrator for post-increment code (required for ordered
2814 /// loop directvies).
2815 void EmitOMPInnerLoop(
2816 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2817 const Expr *IncExpr,
2818 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2819 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002820
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002821 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002822 /// Emit initial code for loop counters of loop-based directives.
2823 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2824 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002825
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002826 /// Helper for the OpenMP loop directives.
2827 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
2828
2829 /// \brief Emit code for the worksharing loop-based directive.
2830 /// \return true, if this construct has any lastprivate clause, false -
2831 /// otherwise.
2832 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
2833 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
2834 const CodeGenDispatchBoundsTy &CGDispatchBounds);
2835
Alexander Musmanc6388682014-12-15 07:07:06 +00002836private:
George Burgess IVe3763372016-12-22 02:50:20 +00002837 /// Helpers for blocks
2838 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
2839
Alexander Musmanc6388682014-12-15 07:07:06 +00002840 /// Helpers for the OpenMP loop directives.
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002841 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002842 void EmitOMPSimdFinal(
2843 const OMPLoopDirective &D,
2844 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002845
2846 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
2847 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
2848
2849 /// struct with the values to be passed to the OpenMP loop-related functions
2850 struct OMPLoopArguments {
2851 /// loop lower bound
2852 Address LB = Address::invalid();
2853 /// loop upper bound
2854 Address UB = Address::invalid();
2855 /// loop stride
2856 Address ST = Address::invalid();
2857 /// isLastIteration argument for runtime functions
2858 Address IL = Address::invalid();
2859 /// Chunk value generated by sema
2860 llvm::Value *Chunk = nullptr;
2861 /// EnsureUpperBound
2862 Expr *EUB = nullptr;
2863 /// IncrementExpression
2864 Expr *IncExpr = nullptr;
2865 /// Loop initialization
2866 Expr *Init = nullptr;
2867 /// Loop exit condition
2868 Expr *Cond = nullptr;
2869 /// Update of LB after a whole chunk has been executed
2870 Expr *NextLB = nullptr;
2871 /// Update of UB after a whole chunk has been executed
2872 Expr *NextUB = nullptr;
2873 OMPLoopArguments() = default;
2874 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
2875 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
2876 Expr *IncExpr = nullptr, Expr *Init = nullptr,
2877 Expr *Cond = nullptr, Expr *NextLB = nullptr,
2878 Expr *NextUB = nullptr)
2879 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
2880 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
2881 NextUB(NextUB) {}
2882 };
2883 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
2884 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
2885 const OMPLoopArguments &LoopArgs,
2886 const CodeGenLoopTy &CodeGenLoop,
2887 const CodeGenOrderedTy &CodeGenOrdered);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00002888 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002889 bool IsMonotonic, const OMPLoopDirective &S,
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002890 OMPPrivateScope &LoopScope, bool Ordered,
2891 const OMPLoopArguments &LoopArgs,
2892 const CodeGenDispatchBoundsTy &CGDispatchBounds);
2893 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
2894 const OMPLoopDirective &S,
2895 OMPPrivateScope &LoopScope,
2896 const OMPLoopArguments &LoopArgs,
2897 const CodeGenLoopTy &CodeGenLoopContent);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002898 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002899 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002900
2901public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002902
Chris Lattner208ae962007-05-30 17:57:17 +00002903 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002904 // LValue Expression Emission
2905 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002906
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002907 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2908 RValue GetUndefRValue(QualType Ty);
2909
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002910 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2911 /// and issue an ErrorUnsupported style diagnostic (using the
2912 /// provided Name).
2913 RValue EmitUnsupportedRValue(const Expr *E,
2914 const char *Name);
2915
Mike Stumpfc496822009-02-08 23:14:22 +00002916 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2917 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002918 LValue EmitUnsupportedLValue(const Expr *E,
2919 const char *Name);
2920
Chris Lattner8394d792007-06-05 20:53:16 +00002921 /// EmitLValue - Emit code to compute a designator that specifies the location
2922 /// of the expression.
2923 ///
2924 /// This can return one of two things: a simple address or a bitfield
2925 /// reference. In either case, the LLVM Value* in the LValue structure is
2926 /// guaranteed to be an LLVM pointer type.
2927 ///
2928 /// If this returns a bitfield reference, nothing about the pointee type of
2929 /// the LLVM value is known: For example, it may not be a pointer to an
2930 /// integer.
2931 ///
2932 /// If this returns a normal address, and if the lvalue's C type is fixed
2933 /// size, this method guarantees that the returned pointer type will point to
2934 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2935 /// variable length type, this is not possible.
2936 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002937 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002938
Richard Smith4d1458e2012-09-08 02:08:36 +00002939 /// \brief Same as EmitLValue but additionally we generate checking code to
2940 /// guard against undefined behavior. This is only suitable when we know
2941 /// that the address will be used to access the object.
2942 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002943
John McCall7f416cc2015-09-08 08:05:57 +00002944 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002945 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002946
John McCalla8ec7eb2013-03-07 21:37:17 +00002947 void EmitAtomicInit(Expr *E, LValue lvalue);
2948
David Majnemera5b195a2015-02-14 01:35:12 +00002949 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00002950
2951 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2952 AggValueSlot Slot = AggValueSlot::ignored());
2953
Nick Lewycky2d84e842013-10-02 02:29:49 +00002954 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002955 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002956 AggValueSlot slot = AggValueSlot::ignored());
2957
2958 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2959
David Majnemera5b195a2015-02-14 01:35:12 +00002960 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2961 bool IsVolatile, bool isInit);
2962
Alexey Bataevb4505a72015-03-30 05:20:59 +00002963 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002964 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00002965 llvm::AtomicOrdering Success =
2966 llvm::AtomicOrdering::SequentiallyConsistent,
2967 llvm::AtomicOrdering Failure =
2968 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00002969 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2970
Alexey Bataevb4505a72015-03-30 05:20:59 +00002971 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002972 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002973 bool IsVolatile);
2974
John McCall3a7f6922010-10-27 20:58:56 +00002975 /// EmitToMemory - Change a scalar value from its value
2976 /// representation to its in-memory representation.
2977 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2978
2979 /// EmitFromMemory - Change a scalar value from its memory
2980 /// representation to its value representation.
2981 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2982
Vedant Kumar5a972652017-02-27 19:46:19 +00002983 /// Check if the scalar \p Value is within the valid range for the given
2984 /// type \p Ty.
2985 ///
2986 /// Returns true if a check is needed (even if the range is unknown).
2987 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
2988 SourceLocation Loc);
2989
Daniel Dunbar1d425462009-02-10 00:57:50 +00002990 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2991 /// care to appropriately convert from the memory representation to
2992 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002993 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002994 SourceLocation Loc,
John McCall7f416cc2015-09-08 08:05:57 +00002995 AlignmentSource AlignSource =
2996 AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002997 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002998 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002999 uint64_t TBAAOffset = 0,
3000 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003001
3002 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3003 /// care to appropriately convert from the memory representation to
3004 /// the LLVM value representation. The l-value must be a simple
3005 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003006 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003007
3008 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3009 /// care to appropriately convert from the memory representation to
3010 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003011 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3012 bool Volatile, QualType Ty,
3013 AlignmentSource AlignSource = AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00003014 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00003015 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003016 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003017
3018 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3019 /// care to appropriately convert from the memory representation to
3020 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00003021 /// l-value. The isInit flag indicates whether this is an initialization.
3022 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3023 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003024
Chris Lattner8394d792007-06-05 20:53:16 +00003025 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3026 /// this method emits the address of the lvalue, then loads the result as an
3027 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003028 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00003029 RValue EmitLoadOfExtVectorElementLValue(LValue V);
Vedant Kumar129edab2017-03-09 16:06:27 +00003030 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
Renato Golin230c5eb2014-05-19 18:15:42 +00003031 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00003032
Chris Lattner8394d792007-06-05 20:53:16 +00003033 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3034 /// lvalue, where both are guaranteed to the have the same type, and that type
3035 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00003036 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003037 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00003038 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003039
Nick Lewycky2d84e842013-10-02 02:29:49 +00003040 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3041 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003042 ///
Mike Stumpfc496822009-02-08 23:14:22 +00003043 /// \param Result [out] - If non-null, this will be set to a Value* for the
3044 /// bit-field contents after the store, appropriate for use as the result of
3045 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00003046 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00003047 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00003048
John McCall4f29b492010-11-16 23:07:28 +00003049 /// Emit an l-value for an assignment (simple or compound) of complex type.
3050 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003051 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00003052 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3053 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00003054
Chris Lattner57540c52011-04-15 05:22:18 +00003055 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00003056 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003057 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003058 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00003059 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003060 // Note: only available for agg return types
3061 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00003062 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00003063 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00003064 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00003065 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00003066 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00003067 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3068 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00003069 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3070 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00003071 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00003072 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00003073 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00003074 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00003075 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00003076 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00003077 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00003078 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00003079 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00003080
John McCall7f416cc2015-09-08 08:05:57 +00003081 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003082
Nick Lewycky2d84e842013-10-02 02:29:49 +00003083 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00003084
John McCall7f416cc2015-09-08 08:05:57 +00003085 Address EmitArrayToPointerDecay(const Expr *Array,
3086 AlignmentSource *AlignSource = nullptr);
3087
John McCall71335052012-03-10 03:05:10 +00003088 class ConstantEmission {
3089 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3090 ConstantEmission(llvm::Constant *C, bool isReference)
3091 : ValueAndIsReference(C, isReference) {}
3092 public:
3093 ConstantEmission() {}
3094 static ConstantEmission forReference(llvm::Constant *C) {
3095 return ConstantEmission(C, true);
3096 }
3097 static ConstantEmission forValue(llvm::Constant *C) {
3098 return ConstantEmission(C, false);
3099 }
3100
Aaron Ballman67347662015-02-15 22:00:28 +00003101 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00003102 return ValueAndIsReference.getOpaqueValue() != nullptr;
3103 }
John McCall71335052012-03-10 03:05:10 +00003104
3105 bool isReference() const { return ValueAndIsReference.getInt(); }
3106 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3107 assert(isReference());
3108 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3109 refExpr->getType());
3110 }
3111
3112 llvm::Constant *getValue() const {
3113 assert(!isReference());
3114 return ValueAndIsReference.getPointer();
3115 }
3116 };
3117
John McCall113bee02012-03-10 09:33:50 +00003118 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00003119
John McCallfe96e0b2011-11-06 09:01:30 +00003120 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3121 AggValueSlot slot = AggValueSlot::ignored());
3122 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3123
Daniel Dunbar722f4242009-04-22 05:08:15 +00003124 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003125 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00003126 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00003127 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003128
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003129 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3130 /// if the Field is a reference, this will return the address of the reference
3131 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003132 LValue EmitLValueForFieldInitialization(LValue Base,
3133 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003134
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003135 LValue EmitLValueForIvar(QualType ObjectTy,
3136 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003137 unsigned CVRQualifiers);
3138
Anders Carlsson3be22e22009-05-30 23:23:33 +00003139 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003140 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00003141 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003142 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003143 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003144
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003145 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003146 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003147 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003148 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003149 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003150 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003151
Chris Lattnerd7f58862007-06-02 05:24:33 +00003152 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003153 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003154 //===--------------------------------------------------------------------===//
3155
Mike Stumpfc496822009-02-08 23:14:22 +00003156 /// EmitCall - Generate a call of the given function, expecting the given
3157 /// result type, and using the given argument list which specifies both the
3158 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003159 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003160 ReturnValueSlot ReturnValue, const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00003161 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003162
John McCallb92ab1a2016-10-26 23:46:34 +00003163 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003164 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00003165 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003166 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003167 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003168 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3169 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003170
Eric Christopherc7e79db2015-11-12 00:44:04 +00003171 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003172
John McCall882987f2013-02-28 19:01:20 +00003173 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3174 const Twine &name = "");
3175 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3176 ArrayRef<llvm::Value*> args,
3177 const Twine &name = "");
3178 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3179 const Twine &name = "");
3180 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3181 ArrayRef<llvm::Value*> args,
3182 const Twine &name = "");
3183
John McCallbd309292010-07-06 01:34:17 +00003184 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003185 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00003186 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00003187 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3188 ArrayRef<llvm::Value*> args,
3189 const Twine &name = "");
3190 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3191 const Twine &name = "");
3192 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3193 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00003194
John McCallb92ab1a2016-10-26 23:46:34 +00003195 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
3196 NestedNameSpecifier *Qual,
3197 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00003198
John McCallb92ab1a2016-10-26 23:46:34 +00003199 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
3200 CXXDtorType Type,
3201 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003202
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003203 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003204 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3205 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003206 ReturnValueSlot ReturnValue, llvm::Value *This,
3207 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003208 QualType ImplicitParamTy, const CallExpr *E,
3209 CallArgList *RtlArgs);
John McCallb92ab1a2016-10-26 23:46:34 +00003210 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3211 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003212 llvm::Value *This, llvm::Value *ImplicitParam,
3213 QualType ImplicitParamTy, const CallExpr *E,
3214 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003215 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3216 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003217 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3218 const CXXMethodDecl *MD,
3219 ReturnValueSlot ReturnValue,
3220 bool HasQualifier,
3221 NestedNameSpecifier *Qualifier,
3222 bool IsArrow, const Expr *Base);
3223 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003224 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3225 llvm::Value *memberPtr,
3226 const MemberPointerType *memberPtrType,
3227 AlignmentSource *AlignSource = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003228 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3229 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003230
Anders Carlsson4034a952009-05-27 04:18:27 +00003231 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003232 const CXXMethodDecl *MD,
3233 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003234 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003235
Peter Collingbournefe883422011-10-06 18:29:37 +00003236 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3237 ReturnValueSlot ReturnValue);
3238
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003239 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3240 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003241
Mike Stump11289f42009-09-09 15:08:12 +00003242 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00003243 unsigned BuiltinID, const CallExpr *E,
3244 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003245
Anders Carlssonbfb36712009-12-24 21:13:40 +00003246 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003247
Mike Stumpfc496822009-02-08 23:14:22 +00003248 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3249 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003250 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3251
Kevin Qin1718af62013-11-14 02:45:18 +00003252 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3253 const llvm::CmpInst::Predicate Fp,
3254 const llvm::CmpInst::Predicate Ip,
3255 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00003256 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00003257
3258 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3259 unsigned LLVMIntrinsic,
3260 unsigned AltLLVMIntrinsic,
3261 const char *NameHint,
3262 unsigned Modifier,
3263 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003264 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00003265 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00003266 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3267 unsigned Modifier, llvm::Type *ArgTy,
3268 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003269 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003270 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003271 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003272 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003273 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003274 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003275 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003276 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3277 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003278 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00003279 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003280
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003281 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003282 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3283 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003284 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003285 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003286 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003287 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3288 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003289
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003290private:
3291 enum class MSVCIntrin;
3292
3293public:
3294 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3295
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003296 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3297
Daniel Dunbar66912a12008-08-20 00:28:19 +00003298 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003299 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003300 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003301 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3302 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3303 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003304 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003305 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003306 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3307 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003308
John McCall31168b02011-06-15 23:02:42 +00003309 /// Retrieves the default cleanup kind for an ARC cleanup.
3310 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3311 CleanupKind getARCCleanupKind() {
3312 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3313 ? NormalAndEHCleanup : NormalCleanup;
3314 }
3315
3316 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003317 void EmitARCInitWeak(Address addr, llvm::Value *value);
3318 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003319 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003320 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3321 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3322 void EmitARCCopyWeak(Address dst, Address src);
3323 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003324 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3325 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003326 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003327 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003328 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003329 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003330 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003331 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003332 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003333 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003334 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003335 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003336 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3337 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3338 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003339 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003340
3341 std::pair<LValue,llvm::Value*>
3342 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3343 std::pair<LValue,llvm::Value*>
3344 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003345 std::pair<LValue,llvm::Value*>
3346 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003347
John McCall248512a2011-10-01 10:32:24 +00003348 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003349 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3350 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3351
John McCallff613032011-10-04 06:23:45 +00003352 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003353 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3354 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003355 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3356 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003357 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003358
Craig Topper00bbdcf2014-06-28 23:22:23 +00003359 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003360
John McCall82fe67b2011-07-09 01:37:26 +00003361 static Destroyer destroyARCStrongImprecise;
3362 static Destroyer destroyARCStrongPrecise;
3363 static Destroyer destroyARCWeak;
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00003364 static Destroyer emitARCIntrinsicUse;
John McCall82fe67b2011-07-09 01:37:26 +00003365
John McCall31168b02011-06-15 23:02:42 +00003366 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3367 llvm::Value *EmitObjCAutoreleasePoolPush();
3368 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3369 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3370 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3371
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003372 /// \brief Emits a reference binding to the passed in expression.
3373 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003374
Chris Lattner6278e6a2007-08-11 00:04:45 +00003375 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003376 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003377 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003378
3379 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003380
3381 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3382 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003383 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003384
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003385 /// Emit a conversion from the specified type to the specified destination
3386 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003387 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003388 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003389
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003390 /// Emit a conversion from the specified complex type to the specified
3391 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003392 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003393 QualType DstTy,
3394 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003395
John McCall7a626f62010-09-15 10:14:12 +00003396 /// EmitAggExpr - Emit the computation of the specified expression
3397 /// of aggregate type. The result is computed into the given slot,
3398 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003399 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003400
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003401 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3402 /// aggregate type into a temporary LValue.
3403 LValue EmitAggExprToLValue(const Expr *E);
3404
John McCall1bd25562011-06-24 23:21:27 +00003405 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3406 /// make sure it survives garbage collection until this point.
3407 void EmitExtendGCLifetime(llvm::Value *object);
3408
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003409 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003410 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003411 ComplexPairTy EmitComplexExpr(const Expr *E,
3412 bool IgnoreReal = false,
3413 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003414
John McCall47fb9502013-03-07 21:37:08 +00003415 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3416 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003417 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003418
John McCall47fb9502013-03-07 21:37:08 +00003419 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003420 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003421
3422 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003423 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003424
John McCall7f416cc2015-09-08 08:05:57 +00003425 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3426 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3427
Chandler Carruth84537952012-03-30 19:44:53 +00003428 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3429 /// global variable that has already been created for it. If the initializer
3430 /// has a different type than GV does, this may free GV and return a different
3431 /// one. Otherwise it just returns GV.
3432 llvm::GlobalVariable *
3433 AddInitializerToStaticVarDecl(const VarDecl &D,
3434 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003435
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003436
Anders Carlssonf40886a2009-08-08 21:45:14 +00003437 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3438 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003439 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3440 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003441
David Majnemerb3341ea2014-10-05 05:05:40 +00003442 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3443 llvm::Constant *Addr);
3444
John McCallc84ed6a2012-05-01 06:13:13 +00003445 /// Call atexit() with a function that passes the given argument to
3446 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003447 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3448 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003449
John McCallcdf7ef52010-11-06 09:44:32 +00003450 /// Emit code in this function to perform a guarded variable
3451 /// initialization. Guarded initializations are used when it's not
3452 /// possible to prove that an initialization will be done exactly
3453 /// once, e.g. with a static local variable or a static data member
3454 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003455 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003456 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003457
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003458 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3459 /// variables.
3460 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003461 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003462 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003463
John McCallee08c532012-04-06 18:21:03 +00003464 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003465 /// variables.
Sanjoy Dase369bd92017-05-01 17:08:00 +00003466 void GenerateCXXGlobalDtorsFunc(
3467 llvm::Function *Fn,
3468 const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
3469 &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003470
John McCalla738c252011-03-09 04:27:21 +00003471 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3472 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003473 llvm::GlobalVariable *Addr,
3474 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003475
John McCall7a626f62010-09-15 10:14:12 +00003476 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00003477
John McCall7f416cc2015-09-08 08:05:57 +00003478 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003479
John McCall08ef4662011-11-10 08:15:53 +00003480 void enterFullExpression(const ExprWithCleanups *E) {
3481 if (E->getNumObjects() == 0) return;
3482 enterNonTrivialFullExpression(E);
3483 }
3484 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003485
Richard Smithea852322013-05-07 21:53:22 +00003486 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003487
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003488 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3489
Tim Northovercc2a6e02015-11-09 19:56:35 +00003490 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003491
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003492 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003493 // Annotations Emission
3494 //===--------------------------------------------------------------------===//
3495
3496 /// Emit an annotation call (intrinsic or builtin).
3497 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3498 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003499 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003500 SourceLocation Location);
3501
3502 /// Emit local annotations for the local variable V, declared by D.
3503 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3504
3505 /// Emit field annotations for the given field & value. Returns the
3506 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003507 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003508
3509 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003510 // Internal Helpers
3511 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003512
Chris Lattner5b1964b2008-11-11 07:41:27 +00003513 /// ContainsLabel - Return true if the statement contains a label in it. If
3514 /// this statement is not executed normally, it not containing a label means
3515 /// that we can just remove the code.
3516 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003517
Chris Lattner29911cc2011-02-28 00:18:40 +00003518 /// containsBreak - Return true if the statement contains a break out of it.
3519 /// If the statement (recursively) contains a switch or loop with a break
3520 /// inside of it, this is fine.
3521 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003522
3523 /// Determine if the given statement might introduce a declaration into the
3524 /// current scope, by being a (possibly-labelled) DeclStmt.
3525 static bool mightAddDeclToScope(const Stmt *S);
Chris Lattner29911cc2011-02-28 00:18:40 +00003526
Daniel Dunbar682712c2008-11-12 10:12:14 +00003527 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003528 /// to a constant, or if it does but contains a label, return false. If it
3529 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003530 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3531 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003532
Chris Lattner29911cc2011-02-28 00:18:40 +00003533 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3534 /// to a constant, or if it does but contains a label, return false. If it
3535 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003536 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3537 bool AllowLabels = false);
3538
Chris Lattnercd439292008-11-12 08:04:58 +00003539 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3540 /// if statement) to the specified blocks. Based on the condition, this might
3541 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003542 /// TrueCount should be the number of times we expect the condition to
3543 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003544 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003545 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003546
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003547 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
3548 /// nonnull, if \p LHS is marked _Nonnull.
3549 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
3550
Richard Smithe30752c2012-10-09 19:52:38 +00003551 /// \brief Emit a description of a type in a format suitable for passing to
3552 /// a runtime sanitizer handler.
3553 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3554
3555 /// \brief Convert a value into a format suitable for passing to a runtime
3556 /// sanitizer handler.
3557 llvm::Value *EmitCheckValue(llvm::Value *V);
3558
3559 /// \brief Emit a description of a source location in a format suitable for
3560 /// passing to a runtime sanitizer handler.
3561 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3562
Richard Smithde670682012-11-01 22:15:34 +00003563 /// \brief Create a basic block that will call a handler function in a
3564 /// sanitizer runtime with the provided arguments, and create a conditional
3565 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003566 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00003567 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003568 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003569
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003570 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3571 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003572 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3573 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3574 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003575
Richard Smithde670682012-11-01 22:15:34 +00003576 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3577 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003578 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003579
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003580 /// \brief Emit a call to trap or debugtrap and attach function attribute
3581 /// "trap-func-name" if specified.
3582 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3583
Evgeniy Stepanov1a8030e2017-04-07 23:00:38 +00003584 /// \brief Emit a stub for the cross-DSO CFI check function.
3585 void EmitCfiCheckStub();
3586
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003587 /// \brief Emit a cross-DSO CFI failure handling function.
3588 void EmitCfiCheckFail();
3589
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003590 /// \brief Create a check for a function parameter that may potentially be
3591 /// declared as non-null.
3592 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003593 AbstractCallee AC, unsigned ParmNum);
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003594
Anders Carlsson093bdff2010-03-30 03:27:09 +00003595 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003596 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003597
John McCall23f66262010-05-26 22:34:26 +00003598 /// EmitDelegateCallArg - We are performing a delegate call; that
3599 /// is, the current function is delegating to another one. Produce
3600 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003601 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3602 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003603
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003604 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3605 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003606 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003607
Chris Lattnercd439292008-11-12 08:04:58 +00003608private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003609 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003610 void EmitReturnOfRValue(RValue RV, QualType Ty);
3611
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003612 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3613
3614 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3615 DeferredReplacements;
3616
John McCall7f416cc2015-09-08 08:05:57 +00003617 /// Set the address of a local variable.
3618 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3619 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3620 LocalDeclMap.insert({VD, Addr});
3621 }
3622
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003623 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3624 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3625 ///
3626 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003627 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003628 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003629
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003630 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3631 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3632 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3633 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3634 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3635 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003636
Chad Rosier59df25b2012-08-23 20:00:18 +00003637 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003638 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003639
Chad Rosier59df25b2012-08-23 20:00:18 +00003640 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003641 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003642 std::string &ConstraintStr,
3643 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003644
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003645 /// \brief Attempts to statically evaluate the object size of E. If that
3646 /// fails, emits code to figure the size of E out for us. This is
3647 /// pass_object_size aware.
George Burgess IV0d6592a2017-02-23 05:59:56 +00003648 ///
3649 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003650 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003651 llvm::IntegerType *ResType,
3652 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003653
3654 /// \brief Emits the size of E, as required by __builtin_object_size. This
3655 /// function is aware of pass_object_size parameters, and will act accordingly
3656 /// if E is a parameter with the pass_object_size attribute.
3657 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003658 llvm::IntegerType *ResType,
3659 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003660
Reid Kleckner89077a12013-12-17 19:46:40 +00003661public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003662#ifndef NDEBUG
3663 // Determine whether the given argument is an Objective-C method
3664 // that may have type parameters in its signature.
3665 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3666 const DeclContext *dc = method->getDeclContext();
3667 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3668 return classDecl->getTypeParamListAsWritten();
3669 }
3670
3671 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3672 return catDecl->getTypeParamList();
3673 }
3674
3675 return false;
3676 }
3677
3678 template<typename T>
3679 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3680#endif
3681
Richard Smitha560ccf2016-09-29 21:30:12 +00003682 enum class EvaluationOrder {
3683 ///! No language constraints on evaluation order.
3684 Default,
3685 ///! Language semantics require left-to-right evaluation.
3686 ForceLeftToRight,
3687 ///! Language semantics require right-to-left evaluation.
3688 ForceRightToLeft
3689 };
3690
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003691 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003692 template <typename T>
3693 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003694 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003695 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003696 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003697 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003698 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003699 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003700
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003701 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3702 "Can't skip parameters if type info is not provided");
3703 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003704#ifndef NDEBUG
3705 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3706#endif
3707
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003708 // First, use the argument types that the type info knows about
3709 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3710 E = CallArgTypeInfo->param_type_end();
3711 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003712 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003713 assert((isGenericMethod ||
3714 ((*I)->isVariablyModifiedType() ||
3715 (*I).getNonReferenceType()->isObjCRetainableType() ||
3716 getContext()
3717 .getCanonicalType((*I).getNonReferenceType())
3718 .getTypePtr() ==
3719 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003720 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003721 .getTypePtr())) &&
3722 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003723 ArgTypes.push_back(*I);
3724 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003725 }
Mike Stump11289f42009-09-09 15:08:12 +00003726
Reid Kleckner739756c2013-12-04 19:23:12 +00003727 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003728 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003729 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3730 CallArgTypeInfo->isVariadic()) &&
3731 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003732
Anders Carlsson603d6af2009-04-18 20:20:22 +00003733 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003734 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00003735 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003736
Vedant Kumared00ea02017-03-06 05:28:22 +00003737 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003738 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003739
Reid Kleckner739756c2013-12-04 19:23:12 +00003740 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003741 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003742 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003743 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003744 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00003745
John McCall7f416cc2015-09-08 08:05:57 +00003746 /// EmitPointerWithAlignment - Given an expression with a pointer
3747 /// type, emit the value and compute our best estimate of the
3748 /// alignment of the pointee.
3749 ///
3750 /// Note that this function will conservatively fall back on the type
3751 /// when it doesn't
3752 ///
3753 /// \param Source - If non-null, this will be initialized with
3754 /// information about the source of the alignment. Note that this
3755 /// function will conservatively fall back on the type when it
3756 /// doesn't recognize the expression, which means that sometimes
3757 ///
3758 /// a worst-case One
3759 /// reasonable way to use this information is when there's a
3760 /// language guarantee that the pointer must be aligned to some
3761 /// stricter value, and we're simply trying to ensure that
3762 /// sufficiently obvious uses of under-aligned objects don't get
3763 /// miscompiled; for example, a placement new into the address of
3764 /// a local variable. In such a case, it's quite reasonable to
3765 /// just ignore the returned alignment when it isn't from an
3766 /// explicit source.
3767 Address EmitPointerWithAlignment(const Expr *Addr,
3768 AlignmentSource *Source = nullptr);
3769
Peter Collingbournedc134532016-01-16 00:31:22 +00003770 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3771
Reid Kleckner89077a12013-12-17 19:46:40 +00003772private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003773 QualType getVarArgType(const Expr *Arg);
3774
John McCalld4f4b7f2010-03-03 04:15:11 +00003775 const TargetCodeGenInfo &getTargetHooks() const {
3776 return CGM.getTargetCodeGenInfo();
3777 }
John McCall09ae0322010-07-06 23:57:41 +00003778
3779 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003780
John McCall7f416cc2015-09-08 08:05:57 +00003781 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3782 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003783
3784 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003785
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003786 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003787};
Mike Stump11289f42009-09-09 15:08:12 +00003788
John McCallce1de612011-01-26 04:00:11 +00003789/// Helper class with most of the code for saving a value for a
3790/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003791struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003792 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3793
3794 /// Answer whether the given value needs extra work to be saved.
3795 static bool needsSaving(llvm::Value *value) {
3796 // If it's not an instruction, we don't need to save.
3797 if (!isa<llvm::Instruction>(value)) return false;
3798
3799 // If it's an instruction in the entry block, we don't need to save.
3800 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3801 return (block != &block->getParent()->getEntryBlock());
3802 }
3803
3804 /// Try to save the given value.
3805 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3806 if (!needsSaving(value)) return saved_type(value, false);
3807
John McCall7f416cc2015-09-08 08:05:57 +00003808 // Otherwise, we need an alloca.
3809 auto align = CharUnits::fromQuantity(
3810 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3811 Address alloca =
3812 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003813 CGF.Builder.CreateStore(value, alloca);
3814
John McCall7f416cc2015-09-08 08:05:57 +00003815 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003816 }
3817
3818 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003819 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003820 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003821
3822 // Otherwise, it should be an alloca instruction, as set up in save().
3823 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3824 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003825 }
3826};
3827
John McCallcb5f77f2011-01-28 10:53:53 +00003828/// A partial specialization of DominatingValue for llvm::Values that
3829/// might be llvm::Instructions.
3830template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3831 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003832 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003833 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3834 }
3835};
3836
John McCall7f416cc2015-09-08 08:05:57 +00003837/// A specialization of DominatingValue for Address.
3838template <> struct DominatingValue<Address> {
3839 typedef Address type;
3840
3841 struct saved_type {
3842 DominatingLLVMValue::saved_type SavedValue;
3843 CharUnits Alignment;
3844 };
3845
3846 static bool needsSaving(type value) {
3847 return DominatingLLVMValue::needsSaving(value.getPointer());
3848 }
3849 static saved_type save(CodeGenFunction &CGF, type value) {
3850 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3851 value.getAlignment() };
3852 }
3853 static type restore(CodeGenFunction &CGF, saved_type value) {
3854 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3855 value.Alignment);
3856 }
3857};
3858
John McCallcb5f77f2011-01-28 10:53:53 +00003859/// A specialization of DominatingValue for RValue.
3860template <> struct DominatingValue<RValue> {
3861 typedef RValue type;
3862 class saved_type {
3863 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3864 AggregateAddress, ComplexAddress };
3865
3866 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003867 unsigned K : 3;
3868 unsigned Align : 29;
3869 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3870 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003871
3872 public:
3873 static bool needsSaving(RValue value);
3874 static saved_type save(CodeGenFunction &CGF, RValue value);
3875 RValue restore(CodeGenFunction &CGF);
3876
John McCall7f416cc2015-09-08 08:05:57 +00003877 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003878 };
3879
3880 static bool needsSaving(type value) {
3881 return saved_type::needsSaving(value);
3882 }
3883 static saved_type save(CodeGenFunction &CGF, type value) {
3884 return saved_type::save(CGF, value);
3885 }
3886 static type restore(CodeGenFunction &CGF, saved_type value) {
3887 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003888 }
3889};
3890
Chris Lattnerbed31442007-05-28 01:07:47 +00003891} // end namespace CodeGen
3892} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003893
Chris Lattnerbed31442007-05-28 01:07:47 +00003894#endif