blob: 2db8a18ceff4edc1ab3464f821e74ee701f37b2d [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) \
118 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
119 SANITIZER_CHECK(NonnullReturn, nonnull_return, 0) \
120 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
121 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
122 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
Filipe Cabecinhasfe5e5af2017-01-06 14:40:12 +0000123 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000124 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
125
126enum SanitizerHandler {
127#define SANITIZER_CHECK(Enum, Name, Version) Enum,
128 LIST_SANITIZER_CHECKS
129#undef SANITIZER_CHECK
130};
131
Chris Lattnerbed31442007-05-28 01:07:47 +0000132/// CodeGenFunction - This class organizes the per-function state that is used
133/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000134class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000135 CodeGenFunction(const CodeGenFunction &) = delete;
136 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000137
138 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000139public:
John McCallad5d61e2010-07-23 21:56:41 +0000140 /// A jump destination is an abstract label, branching to which may
141 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000142 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000143 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000144 JumpDest(llvm::BasicBlock *Block,
145 EHScopeStack::stable_iterator Depth,
146 unsigned Index)
147 : Block(Block), ScopeDepth(Depth), Index(Index) {}
148
Craig Topper8a13c412014-05-21 05:09:00 +0000149 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000150 llvm::BasicBlock *getBlock() const { return Block; }
151 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
152 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000153
Nadav Rotem1da30942013-03-23 06:43:35 +0000154 // This should be used cautiously.
155 void setScopeDepth(EHScopeStack::stable_iterator depth) {
156 ScopeDepth = depth;
157 }
158
John McCallad5d61e2010-07-23 21:56:41 +0000159 private:
John McCallbd309292010-07-06 01:34:17 +0000160 llvm::BasicBlock *Block;
161 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000162 unsigned Index;
163 };
164
Chris Lattnerbed31442007-05-28 01:07:47 +0000165 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000166 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000167
Chris Lattner96d72562007-08-21 16:57:55 +0000168 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000169 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000170 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000171
Vitaly Buka64c80b42016-10-26 05:42:30 +0000172 // Stores variables for which we can't generate correct lifetime markers
173 // because of jumps.
174 VarBypassDetector Bypasses;
175
Alexander Musman515ad8c2014-05-22 08:54:05 +0000176 /// \brief CGBuilder insert helper. This function is called after an
177 /// instruction is created using Builder.
178 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
179 llvm::BasicBlock *BB,
180 llvm::BasicBlock::iterator InsertPt) const;
181
John McCalldec348f72013-05-03 07:33:41 +0000182 /// CurFuncDecl - Holds the Decl for the current outermost
183 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000184 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000185 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
186 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000187 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000188 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000189 llvm::Function *CurFn;
190
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000191 // Holds coroutine data if the current function is a coroutine. We use a
192 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
193 // in this header.
194 struct CGCoroInfo {
195 std::unique_ptr<CGCoroData> Data;
196 CGCoroInfo();
197 ~CGCoroInfo();
198 };
199 CGCoroInfo CurCoro;
200
Mike Stumpbee78dd2009-12-04 23:26:17 +0000201 /// CurGD - The GlobalDecl for the current function being compiled.
202 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000203
John McCall31168b02011-06-15 23:02:42 +0000204 /// PrologueCleanupDepth - The cleanup depth enclosing all the
205 /// cleanups associated with the parameters.
206 EHScopeStack::stable_iterator PrologueCleanupDepth;
207
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000208 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000209 JumpDest ReturnBlock;
210
John McCall7f416cc2015-09-08 08:05:57 +0000211 /// ReturnValue - The temporary alloca to hold the return
212 /// value. This is invalid iff the function has no return value.
213 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000214
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000215 /// Return true if a label was seen in the current scope.
216 bool hasLabelBeenSeenInCurrentScope() const {
217 if (CurLexicalScope)
218 return CurLexicalScope->hasLabels();
219 return !LabelMap.empty();
220 }
221
Chris Lattner03df1222007-06-02 04:53:11 +0000222 /// AllocaInsertPoint - This is an instruction in the entry block before which
223 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000224 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000225
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000226 /// \brief API for captured statement code generation.
227 class CGCapturedStmtInfo {
228 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000229 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
230 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000231 explicit CGCapturedStmtInfo(const CapturedStmt &S,
232 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000233 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000234
235 RecordDecl::field_iterator Field =
236 S.getCapturedRecordDecl()->field_begin();
237 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
238 E = S.capture_end();
239 I != E; ++I, ++Field) {
240 if (I->capturesThis())
241 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000242 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000243 CaptureFields[I->getCapturedVar()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000244 else if (I->capturesVariableByCopy())
245 CaptureFields[I->getCapturedVar()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000246 }
247 }
248
249 virtual ~CGCapturedStmtInfo();
250
251 CapturedRegionKind getKind() const { return Kind; }
252
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000253 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000254 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000255 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000256
257 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000258 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000259 return CaptureFields.lookup(VD);
260 }
261
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000262 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
263 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000264
Alexey Bataev18095712014-10-10 12:19:54 +0000265 static bool classof(const CGCapturedStmtInfo *) {
266 return true;
267 }
268
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000269 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000270 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000271 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000272 CGF.EmitStmt(S);
273 }
274
275 /// \brief Get the name of the capture helper.
276 virtual StringRef getHelperName() const { return "__captured_stmt"; }
277
278 private:
279 /// \brief The kind of captured statement being generated.
280 CapturedRegionKind Kind;
281
282 /// \brief Keep the map between VarDecl and FieldDecl.
283 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
284
285 /// \brief The base address of the captured record, passed in as the first
286 /// argument of the parallel region function.
287 llvm::Value *ThisValue;
288
289 /// \brief Captured 'this' type.
290 FieldDecl *CXXThisFieldDecl;
291 };
292 CGCapturedStmtInfo *CapturedStmtInfo;
293
Alexey Bataevd157d472015-06-24 03:35:38 +0000294 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
295 class CGCapturedStmtRAII {
296 private:
297 CodeGenFunction &CGF;
298 CGCapturedStmtInfo *PrevCapturedStmtInfo;
299 public:
300 CGCapturedStmtRAII(CodeGenFunction &CGF,
301 CGCapturedStmtInfo *NewCapturedStmtInfo)
302 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
303 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
304 }
305 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
306 };
307
Vedant Kumared00ea02017-03-06 05:28:22 +0000308 /// An abstract representation of regular/ObjC call/message targets.
309 class AbstractCallee {
310 /// The function declaration of the callee.
311 const Decl *CalleeDecl;
312
313 public:
314 AbstractCallee() : CalleeDecl(nullptr) {}
315 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
316 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
317 bool hasFunctionDecl() const {
318 return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
319 }
320 const Decl *getDecl() const { return CalleeDecl; }
321 unsigned getNumParams() const {
322 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
323 return FD->getNumParams();
324 return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
325 }
326 const ParmVarDecl *getParamDecl(unsigned I) const {
327 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
328 return FD->getParamDecl(I);
329 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
330 }
331 };
332
Alexey Samsonova0416102014-11-11 01:26:14 +0000333 /// \brief Sanitizers enabled for this function.
334 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000335
Alexey Samsonov24cad992014-07-17 18:46:27 +0000336 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
337 bool IsSanitizerScope;
338
339 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
340 class SanitizerScope {
341 CodeGenFunction *CGF;
342 public:
343 SanitizerScope(CodeGenFunction *CGF);
344 ~SanitizerScope();
345 };
346
Reid Kleckner19819442014-07-25 21:39:46 +0000347 /// In C++, whether we are code generating a thunk. This controls whether we
348 /// should emit cleanups.
349 bool CurFuncIsThunk;
350
John McCall31168b02011-06-15 23:02:42 +0000351 /// In ARC, whether we should autorelease the return value.
352 bool AutoreleaseResult;
353
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000354 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
355 /// potentially set the return value.
356 bool SawAsmBlock;
357
David Majnemer25eb1652016-03-01 19:42:53 +0000358 const FunctionDecl *CurSEHParent = nullptr;
359
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000360 /// True if the current function is an outlined SEH helper. This can be a
361 /// finally block or filter expression.
362 bool IsOutlinedSEHHelper;
363
John McCallad7c5c12011-02-08 08:22:06 +0000364 const CodeGen::CGBlockInfo *BlockInfo;
365 llvm::Value *BlockPointer;
366
Eli Friedman9fbeba02012-02-11 02:57:39 +0000367 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
368 FieldDecl *LambdaThisCaptureField;
369
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000370 /// \brief A mapping from NRVO variables to the flags used to indicate
371 /// when the NRVO has been applied to this variable.
372 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000373
John McCallbd309292010-07-06 01:34:17 +0000374 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000375 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000376 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000377
David Majnemer4e52d6f2015-12-12 05:39:21 +0000378 llvm::Instruction *CurrentFuncletPad = nullptr;
379
Tim Shen421119f2016-07-01 21:08:47 +0000380 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
381 llvm::Value *Addr;
382 llvm::Value *Size;
383
384 public:
385 CallLifetimeEnd(Address addr, llvm::Value *size)
386 : Addr(addr.getPointer()), Size(size) {}
387
388 void Emit(CodeGenFunction &CGF, Flags flags) override {
389 CGF.EmitLifetimeEnd(Size, Addr);
390 }
391 };
392
Richard Smith736a9472013-06-12 20:42:33 +0000393 /// Header for data within LifetimeExtendedCleanupStack.
394 struct LifetimeExtendedCleanupHeader {
395 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000396 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000397 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000398 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000399
Justin Bognerbdff2192015-07-01 00:59:27 +0000400 size_t getSize() const { return Size; }
401 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000402 };
John McCallbd309292010-07-06 01:34:17 +0000403
John McCallad5d61e2010-07-23 21:56:41 +0000404 /// i32s containing the indexes of the cleanup destinations.
405 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000406
407 unsigned NextCleanupDestIndex;
408
John McCall08ef4662011-11-10 08:15:53 +0000409 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
410 CGBlockInfo *FirstBlockInfo;
411
John McCall8e4c74b2011-08-11 02:22:43 +0000412 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
413 llvm::BasicBlock *EHResumeBlock;
414
Bill Wendlingf0724e82011-09-19 20:31:14 +0000415 /// The exception slot. All landing pads write the current exception pointer
416 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000417 llvm::Value *ExceptionSlot;
418
Bill Wendlingf0724e82011-09-19 20:31:14 +0000419 /// The selector slot. Under the MandatoryCleanup model, all landing pads
420 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000421 llvm::AllocaInst *EHSelectorSlot;
422
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000423 /// A stack of exception code slots. Entering an __except block pushes a slot
424 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
425 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000426 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000427
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000428 /// Value returned by __exception_info intrinsic.
429 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000430
John McCallbd309292010-07-06 01:34:17 +0000431 /// Emits a landing pad for the current EH stack.
432 llvm::BasicBlock *EmitLandingPad();
433
434 llvm::BasicBlock *getInvokeDestImpl();
435
John McCallce1de612011-01-26 04:00:11 +0000436 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000437 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
438 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000439 }
440
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000441public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000442 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
443 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000444 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000445
John McCall6b0feb72011-06-22 02:32:12 +0000446 /// A class controlling the emission of a finally block.
447 class FinallyInfo {
448 /// Where the catchall's edge through the cleanup should go.
449 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000450
John McCall6b0feb72011-06-22 02:32:12 +0000451 /// A function to call to enter the catch.
452 llvm::Constant *BeginCatchFn;
453
454 /// An i1 variable indicating whether or not the @finally is
455 /// running for an exception.
456 llvm::AllocaInst *ForEHVar;
457
458 /// An i8* variable into which the exception pointer to rethrow
459 /// has been saved.
460 llvm::AllocaInst *SavedExnVar;
461
462 public:
463 void enter(CodeGenFunction &CGF, const Stmt *Finally,
464 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
465 llvm::Constant *rethrowFn);
466 void exit(CodeGenFunction &CGF);
467 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000468
Reid Kleckner11c033e2015-02-12 23:40:45 +0000469 /// Returns true inside SEH __try blocks.
470 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
471
Reid Klecknera002bd52015-10-28 23:06:42 +0000472 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000473 bool isCleanupPadScope() const {
474 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
475 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000476
John McCallce1de612011-01-26 04:00:11 +0000477 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
478 /// current full-expression. Safe against the possibility that
479 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000480 template <class T, class... As>
481 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000482 // If we're not in a conditional branch, or if none of the
483 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000484 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000485 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000486
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000487 // Stash values in a tuple so we can guarantee the order of saves.
488 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
489 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000490
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000491 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000492 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000493 initFullExprCleanup();
494 }
495
Richard Smith736a9472013-06-12 20:42:33 +0000496 /// \brief Queue a cleanup to be pushed after finishing the current
497 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000498 template <class T, class... As>
499 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000500 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
501
502 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
503
504 size_t OldSize = LifetimeExtendedCleanupStack.size();
505 LifetimeExtendedCleanupStack.resize(
506 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
507
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000508 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000509 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000510 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
511 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000512 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000513 }
514
John McCallf4beacd2011-11-10 10:43:54 +0000515 /// Set up the last cleaup that was pushed as a conditional
516 /// full-expression cleanup.
517 void initFullExprCleanup();
518
John McCallbd309292010-07-06 01:34:17 +0000519 /// PushDestructorCleanup - Push a cleanup to call the
520 /// complete-object destructor of an object of the given type at the
521 /// given address. Does nothing if T is not a C++ class type with a
522 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000523 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000524
John McCall8680f872010-07-21 06:29:51 +0000525 /// PushDestructorCleanup - Push a cleanup to call the
526 /// complete-object variant of the given destructor on the object at
527 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000528 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000529
John McCallbd309292010-07-06 01:34:17 +0000530 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
531 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000532 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000533
John McCall824c2f52010-09-14 07:57:04 +0000534 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
535 /// The block cannot be reactivated. Pops it if it's the top of the
536 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000537 ///
538 /// \param DominatingIP - An instruction which is known to
539 /// dominate the current IP (if set) and which lies along
540 /// all paths of execution between the current IP and the
541 /// the point at which the cleanup comes into scope.
542 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
543 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000544
545 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
546 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000547 ///
548 /// \param DominatingIP - An instruction which is known to
549 /// dominate the current IP (if set) and which lies along
550 /// all paths of execution between the current IP and the
551 /// the point at which the cleanup comes into scope.
552 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
553 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000554
John McCallbd309292010-07-06 01:34:17 +0000555 /// \brief Enters a new scope for capturing cleanups, all of which
556 /// will be executed once the scope is exited.
557 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000558 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000559 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000560 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000561 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000562 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000563 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000564
Aaron Ballmanabc18922015-02-15 22:54:08 +0000565 RunCleanupsScope(const RunCleanupsScope &) = delete;
566 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000567
Eric Christophera9d34972011-10-19 00:43:52 +0000568 protected:
569 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000570
Douglas Gregor965f4502009-11-24 16:43:22 +0000571 public:
572 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000573 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000574 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000575 {
John McCallbd309292010-07-06 01:34:17 +0000576 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000577 LifetimeExtendedCleanupStackSize =
578 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000579 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000580 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000581 }
582
Reid Kleckner092d0652017-03-06 22:18:34 +0000583 /// \brief Exit this cleanup scope, emitting any accumulated cleanups.
John McCallbd309292010-07-06 01:34:17 +0000584 ~RunCleanupsScope() {
Reid Kleckner092d0652017-03-06 22:18:34 +0000585 if (PerformCleanup)
586 ForceCleanup();
Douglas Gregor680f8612009-11-24 21:15:44 +0000587 }
588
589 /// \brief Determine whether this scope requires any cleanups.
590 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000591 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000592 }
593
594 /// \brief Force the emission of cleanups now, instead of waiting
595 /// until this object is destroyed.
Reid Kleckner092d0652017-03-06 22:18:34 +0000596 /// \param ValuesToReload - A list of values that need to be available at
597 /// the insertion point after cleanup emission. If cleanup emission created
598 /// a shared cleanup block, these value pointers will be rewritten.
599 /// Otherwise, they not will be modified.
600 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
Douglas Gregor680f8612009-11-24 21:15:44 +0000601 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000602 CGF.DidCallStackSave = OldDidCallStackSave;
Reid Kleckner092d0652017-03-06 22:18:34 +0000603 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
604 ValuesToReload);
Douglas Gregor680f8612009-11-24 21:15:44 +0000605 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000606 }
607 };
608
David Blaikie93be0b22014-08-22 21:37:04 +0000609 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000610 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000611 SmallVector<const LabelDecl*, 4> Labels;
612 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000613
Aaron Ballmanabc18922015-02-15 22:54:08 +0000614 LexicalScope(const LexicalScope &) = delete;
615 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000616
617 public:
618 /// \brief Enter a new cleanup scope.
619 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000620 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
621 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000622 if (CGDebugInfo *DI = CGF.getDebugInfo())
623 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
624 }
625
Nadav Rotem1da30942013-03-23 06:43:35 +0000626 void addLabel(const LabelDecl *label) {
627 assert(PerformCleanup && "adding label to dead scope?");
628 Labels.push_back(label);
629 }
630
Eric Christophera9d34972011-10-19 00:43:52 +0000631 /// \brief Exit this cleanup scope, emitting any accumulated
632 /// cleanups.
633 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000634 if (CGDebugInfo *DI = CGF.getDebugInfo())
635 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
636
Nadav Rotem1da30942013-03-23 06:43:35 +0000637 // If we should perform a cleanup, force them now. Note that
638 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000639 if (PerformCleanup) {
640 ApplyDebugLocation DL(CGF, Range.getEnd());
641 ForceCleanup();
642 }
Eric Christophera9d34972011-10-19 00:43:52 +0000643 }
644
645 /// \brief Force the emission of cleanups now, instead of waiting
646 /// until this object is destroyed.
647 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000648 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000649 RunCleanupsScope::ForceCleanup();
650
Nadav Rotem1da30942013-03-23 06:43:35 +0000651 if (!Labels.empty())
652 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000653 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000654
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000655 bool hasLabels() const {
656 return !Labels.empty();
657 }
658
Nadav Rotem1da30942013-03-23 06:43:35 +0000659 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000660 };
661
John McCall7f416cc2015-09-08 08:05:57 +0000662 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
663
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000664 /// \brief The scope used to remap some variables as private in the OpenMP
665 /// loop body (or other captured region emitted without outlining), and to
666 /// restore old vars back on exit.
667 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000668 DeclMapTy SavedLocals;
669 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000670
671 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000672 OMPPrivateScope(const OMPPrivateScope &) = delete;
673 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000674
675 public:
676 /// \brief Enter a new OpenMP private scope.
677 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
678
679 /// \brief Registers \a LocalVD variable as a private and apply \a
680 /// PrivateGen function for it to generate corresponding private variable.
681 /// \a PrivateGen returns an address of the generated private variable.
682 /// \return true if the variable is registered as private, false if it has
683 /// been privatized already.
684 bool
685 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000686 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000687 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000688
689 // Only save it once.
690 if (SavedLocals.count(LocalVD)) return false;
691
692 // Copy the existing local entry to SavedLocals.
693 auto it = CGF.LocalDeclMap.find(LocalVD);
694 if (it != CGF.LocalDeclMap.end()) {
695 SavedLocals.insert({LocalVD, it->second});
696 } else {
697 SavedLocals.insert({LocalVD, Address::invalid()});
698 }
699
700 // Generate the private entry.
701 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000702 QualType VarTy = LocalVD->getType();
703 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000704 Address Temp = CGF.CreateMemTemp(VarTy);
705 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
706 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000707 }
John McCall7f416cc2015-09-08 08:05:57 +0000708 SavedPrivates.insert({LocalVD, Addr});
709
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000710 return true;
711 }
712
713 /// \brief Privatizes local variables previously registered as private.
714 /// Registration is separate from the actual privatization to allow
715 /// initializers use values of the original variables, not the private one.
716 /// This is important, for example, if the private variable is a class
717 /// variable initialized by a constructor that references other private
718 /// variables. But at initialization original variables must be used, not
719 /// private copies.
720 /// \return true if at least one variable was privatized, false otherwise.
721 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000722 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000723 SavedPrivates.clear();
724 return !SavedLocals.empty();
725 }
726
727 void ForceCleanup() {
728 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000729 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000730 SavedLocals.clear();
731 }
732
733 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000734 ~OMPPrivateScope() {
735 if (PerformCleanup)
736 ForceCleanup();
737 }
John McCall7f416cc2015-09-08 08:05:57 +0000738
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000739 /// Checks if the global variable is captured in current function.
740 bool isGlobalVarCaptured(const VarDecl *VD) const {
741 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
742 }
743
John McCall7f416cc2015-09-08 08:05:57 +0000744 private:
745 /// Copy all the entries in the source map over the corresponding
746 /// entries in the destination, which must exist.
747 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
748 for (auto &pair : src) {
749 if (!pair.second.isValid()) {
750 dest.erase(pair.first);
751 continue;
752 }
753
754 auto it = dest.find(pair.first);
755 if (it != dest.end()) {
756 it->second = pair.second;
757 } else {
758 dest.insert(pair);
759 }
760 }
761 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000762 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000763
Richard Smith736a9472013-06-12 20:42:33 +0000764 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
765 /// that have been added.
Reid Kleckner092d0652017-03-06 22:18:34 +0000766 void
767 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
768 std::initializer_list<llvm::Value **> ValuesToReload = {});
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000769
Richard Smith736a9472013-06-12 20:42:33 +0000770 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
771 /// that have been added, then adds all lifetime-extended cleanups from
772 /// the given position to the stack.
Reid Kleckner092d0652017-03-06 22:18:34 +0000773 void
774 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
775 size_t OldLifetimeExtendedStackSize,
776 std::initializer_list<llvm::Value **> ValuesToReload = {});
Richard Smith736a9472013-06-12 20:42:33 +0000777
John McCallad5d61e2010-07-23 21:56:41 +0000778 void ResolveBranchFixups(llvm::BasicBlock *Target);
779
John McCallbd309292010-07-06 01:34:17 +0000780 /// The given basic block lies in the current EH scope, but may be a
781 /// target of a potentially scope-crossing jump; get a stable handle
782 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000783 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000784 return JumpDest(Target,
785 EHStack.getInnermostNormalCleanup(),
786 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000787 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000788
John McCallbd309292010-07-06 01:34:17 +0000789 /// The given basic block lies in the current EH scope, but may be a
790 /// target of a potentially scope-crossing jump; get a stable handle
791 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000792 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000793 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000794 }
795
796 /// EmitBranchThroughCleanup - Emit a branch from the current insert
797 /// block through the normal cleanup handling code (if any) and then
798 /// on to \arg Dest.
799 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000800
Justin Bognere25ffdf2014-01-21 00:35:11 +0000801 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
802 /// specified destination obviously has no cleanups to run. 'false' is always
803 /// a conservatively correct answer for this method.
804 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
805
John McCall8e4c74b2011-08-11 02:22:43 +0000806 /// popCatchScope - Pops the catch scope at the top of the EHScope
807 /// stack, emitting any required code (other than the catch handlers
808 /// themselves).
809 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000810
David Chisnall9a837be2012-11-07 16:50:40 +0000811 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000812 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000813 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000814
John McCallce1de612011-01-26 04:00:11 +0000815 /// An object to manage conditionally-evaluated expressions.
816 class ConditionalEvaluation {
817 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000818
John McCallce1de612011-01-26 04:00:11 +0000819 public:
820 ConditionalEvaluation(CodeGenFunction &CGF)
821 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000822
John McCallce1de612011-01-26 04:00:11 +0000823 void begin(CodeGenFunction &CGF) {
824 assert(CGF.OutermostConditional != this);
825 if (!CGF.OutermostConditional)
826 CGF.OutermostConditional = this;
827 }
828
829 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000830 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000831 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000832 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000833 }
834
835 /// Returns a block which will be executed prior to each
836 /// evaluation of the conditional code.
837 llvm::BasicBlock *getStartingBlock() const {
838 return StartBB;
839 }
840 };
Mike Stump11289f42009-09-09 15:08:12 +0000841
John McCall7f9c92a2010-09-17 00:50:28 +0000842 /// isInConditionalBranch - Return true if we're currently emitting
843 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000844 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000845
John McCall7f416cc2015-09-08 08:05:57 +0000846 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000847 assert(isInConditionalBranch());
848 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000849 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
850 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000851 }
852
John McCallce1de612011-01-26 04:00:11 +0000853 /// An RAII object to record that we're evaluating a statement
854 /// expression.
855 class StmtExprEvaluation {
856 CodeGenFunction &CGF;
857
858 /// We have to save the outermost conditional: cleanups in a
859 /// statement expression aren't conditional just because the
860 /// StmtExpr is.
861 ConditionalEvaluation *SavedOutermostConditional;
862
863 public:
864 StmtExprEvaluation(CodeGenFunction &CGF)
865 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000866 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000867 }
868
869 ~StmtExprEvaluation() {
870 CGF.OutermostConditional = SavedOutermostConditional;
871 CGF.EnsureInsertPoint();
872 }
873 };
John McCall1bf58462011-02-16 08:02:54 +0000874
John McCallc07a0c72011-02-17 10:25:35 +0000875 /// An object which temporarily prevents a value from being
876 /// destroyed by aggressive peephole optimizations that assume that
877 /// all uses of a value have been realized in the IR.
878 class PeepholeProtection {
879 llvm::Instruction *Inst;
880 friend class CodeGenFunction;
881
882 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000883 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000884 };
John McCallc07a0c72011-02-17 10:25:35 +0000885
John McCallfe96e0b2011-11-06 09:01:30 +0000886 /// A non-RAII class containing all the information about a bound
887 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
888 /// this which makes individual mappings very simple; using this
889 /// class directly is useful when you have a variable number of
890 /// opaque values or don't want the RAII functionality for some
891 /// reason.
892 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000893 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000894 bool BoundLValue;
895 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000896
John McCallfe96e0b2011-11-06 09:01:30 +0000897 OpaqueValueMappingData(const OpaqueValueExpr *ov,
898 bool boundLValue)
899 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000900 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000901 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000902
John McCallc07a0c72011-02-17 10:25:35 +0000903 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000904 // gl-values should be bound as l-values for obvious reasons.
905 // Records should be bound as l-values because IR generation
906 // always keeps them in memory. Expressions of function type
907 // act exactly like l-values but are formally required to be
908 // r-values in C.
909 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000910 expr->getType()->isFunctionType() ||
911 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000912 }
913
John McCallfe96e0b2011-11-06 09:01:30 +0000914 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
915 const OpaqueValueExpr *ov,
916 const Expr *e) {
917 if (shouldBindAsLValue(ov))
918 return bind(CGF, ov, CGF.EmitLValue(e));
919 return bind(CGF, ov, CGF.EmitAnyExpr(e));
920 }
921
922 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
923 const OpaqueValueExpr *ov,
924 const LValue &lv) {
925 assert(shouldBindAsLValue(ov));
926 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
927 return OpaqueValueMappingData(ov, true);
928 }
929
930 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
931 const OpaqueValueExpr *ov,
932 const RValue &rv) {
933 assert(!shouldBindAsLValue(ov));
934 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
935
936 OpaqueValueMappingData data(ov, false);
937
938 // Work around an extremely aggressive peephole optimization in
939 // EmitScalarConversion which assumes that all other uses of a
940 // value are extant.
941 data.Protection = CGF.protectFromPeepholes(rv);
942
943 return data;
944 }
945
Craig Topper8a13c412014-05-21 05:09:00 +0000946 bool isValid() const { return OpaqueValue != nullptr; }
947 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000948
949 void unbind(CodeGenFunction &CGF) {
950 assert(OpaqueValue && "no data to unbind!");
951
952 if (BoundLValue) {
953 CGF.OpaqueLValues.erase(OpaqueValue);
954 } else {
955 CGF.OpaqueRValues.erase(OpaqueValue);
956 CGF.unprotectFromPeepholes(Protection);
957 }
958 }
959 };
960
961 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
962 class OpaqueValueMapping {
963 CodeGenFunction &CGF;
964 OpaqueValueMappingData Data;
965
966 public:
967 static bool shouldBindAsLValue(const Expr *expr) {
968 return OpaqueValueMappingData::shouldBindAsLValue(expr);
969 }
970
John McCallc07a0c72011-02-17 10:25:35 +0000971 /// Build the opaque value mapping for the given conditional
972 /// operator if it's the GNU ?: extension. This is a common
973 /// enough pattern that the convenience operator is really
974 /// helpful.
975 ///
976 OpaqueValueMapping(CodeGenFunction &CGF,
977 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000978 if (isa<ConditionalOperator>(op))
979 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000980 return;
John McCallc07a0c72011-02-17 10:25:35 +0000981
982 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000983 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
984 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000985 }
986
Richard Smith410306b2016-12-12 02:53:20 +0000987 /// Build the opaque value mapping for an OpaqueValueExpr whose source
988 /// expression is set to the expression the OVE represents.
989 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
990 : CGF(CGF) {
991 if (OV) {
992 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
993 "for OVE with no source expression");
994 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
995 }
996 }
997
John McCall1bf58462011-02-16 08:02:54 +0000998 OpaqueValueMapping(CodeGenFunction &CGF,
999 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001000 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001001 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001002 }
1003
1004 OpaqueValueMapping(CodeGenFunction &CGF,
1005 const OpaqueValueExpr *opaqueValue,
1006 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001007 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001008 }
1009
1010 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001011 Data.unbind(CGF);
1012 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001013 }
1014
1015 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001016 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001017 }
1018 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +00001019
Chris Lattner2da04b32007-08-24 05:35:26 +00001020private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001021 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001022 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001023
John McCall9b382dd2011-05-28 21:13:02 +00001024 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1025 /// calling llvm.stacksave for multiple VLAs in the same scope.
1026 bool DidCallStackSave;
1027
Mike Stumpe5311b02009-11-30 20:08:49 +00001028 /// IndirectBranch - The first time an indirect goto is seen we create a block
1029 /// with an indirect branch. Every time we see the address of a label taken,
1030 /// we add the label to the indirect goto. Every subsequent indirect goto is
1031 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +00001032 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001033
Mike Stumpfc496822009-02-08 23:14:22 +00001034 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1035 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001036 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001037
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001038 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1039 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1040 /// parameter.
1041 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1042 SizeArguments;
1043
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001044 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001045 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001046 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1047
Chris Lattnerac248202007-05-30 00:13:02 +00001048 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001049 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001050
Mike Stumpfc496822009-02-08 23:14:22 +00001051 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001052 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001053 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001054 BreakContinue(JumpDest Break, JumpDest Continue)
1055 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001056
John McCallbd309292010-07-06 01:34:17 +00001057 JumpDest BreakBlock;
1058 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001059 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001060 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001061
Alexey Bataev957d8562016-11-17 15:12:05 +00001062 /// Handles cancellation exit points in OpenMP-related constructs.
1063 class OpenMPCancelExitStack {
1064 /// Tracks cancellation exit point and join point for cancel-related exit
1065 /// and normal exit.
1066 struct CancelExit {
1067 CancelExit() = default;
1068 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1069 JumpDest ContBlock)
1070 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1071 OpenMPDirectiveKind Kind = OMPD_unknown;
1072 /// true if the exit block has been emitted already by the special
1073 /// emitExit() call, false if the default codegen is used.
1074 bool HasBeenEmitted = false;
1075 JumpDest ExitBlock;
1076 JumpDest ContBlock;
1077 };
1078
1079 SmallVector<CancelExit, 8> Stack;
1080
1081 public:
1082 OpenMPCancelExitStack() : Stack(1) {}
1083 ~OpenMPCancelExitStack() = default;
1084 /// Fetches the exit block for the current OpenMP construct.
1085 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1086 /// Emits exit block with special codegen procedure specific for the related
1087 /// OpenMP construct + emits code for normal construct cleanup.
1088 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1089 const llvm::function_ref<void(CodeGenFunction &)> &CodeGen) {
1090 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1091 assert(CGF.getOMPCancelDestination(Kind).isValid());
1092 assert(CGF.HaveInsertPoint());
1093 assert(!Stack.back().HasBeenEmitted);
1094 auto IP = CGF.Builder.saveAndClearIP();
1095 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1096 CodeGen(CGF);
1097 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1098 CGF.Builder.restoreIP(IP);
1099 Stack.back().HasBeenEmitted = true;
1100 }
1101 CodeGen(CGF);
1102 }
1103 /// Enter the cancel supporting \a Kind construct.
1104 /// \param Kind OpenMP directive that supports cancel constructs.
1105 /// \param HasCancel true, if the construct has inner cancel directive,
1106 /// false otherwise.
1107 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1108 Stack.push_back({Kind,
1109 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1110 : JumpDest(),
1111 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1112 : JumpDest()});
1113 }
1114 /// Emits default exit point for the cancel construct (if the special one
1115 /// has not be used) + join point for cancel/normal exits.
1116 void exit(CodeGenFunction &CGF) {
1117 if (getExitBlock().isValid()) {
1118 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1119 bool HaveIP = CGF.HaveInsertPoint();
1120 if (!Stack.back().HasBeenEmitted) {
1121 if (HaveIP)
1122 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1123 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1124 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1125 }
1126 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1127 if (!HaveIP) {
1128 CGF.Builder.CreateUnreachable();
1129 CGF.Builder.ClearInsertionPoint();
1130 }
1131 }
1132 Stack.pop_back();
1133 }
1134 };
1135 OpenMPCancelExitStack OMPCancelStack;
1136
1137 /// Controls insertion of cancellation exit blocks in worksharing constructs.
1138 class OMPCancelStackRAII {
1139 CodeGenFunction &CGF;
1140
1141 public:
1142 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1143 bool HasCancel)
1144 : CGF(CGF) {
1145 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
1146 }
1147 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
1148 };
1149
Justin Bogneref512b92014-01-06 22:27:43 +00001150 CodeGenPGO PGO;
1151
Justin Bogner65512642015-05-02 05:00:55 +00001152 /// Calculate branch weights appropriate for PGO data
1153 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1154 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1155 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1156 uint64_t LoopCount);
1157
Justin Bogneref512b92014-01-06 22:27:43 +00001158public:
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001159 /// Increment the profiler's counter for the given statement by \p StepV.
1160 /// If \p StepV is null, the default increment is 1.
1161 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
Rong Xu9837ef52016-02-04 18:39:09 +00001162 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001163 PGO.emitCounterIncrement(Builder, S, StepV);
Justin Bogner66242d62015-04-23 23:06:47 +00001164 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001165 }
Justin Bogner66242d62015-04-23 23:06:47 +00001166
1167 /// Get the profiler's count for the given statement.
1168 uint64_t getProfileCount(const Stmt *S) {
1169 Optional<uint64_t> Count = PGO.getStmtCount(S);
1170 if (!Count.hasValue())
1171 return 0;
1172 return *Count;
1173 }
1174
1175 /// Set the profiler's current count.
1176 void setCurrentProfileCount(uint64_t Count) {
1177 PGO.setCurrentRegionCount(Count);
1178 }
1179
1180 /// Get the profiler's current count. This is generally the count for the most
1181 /// recently incremented counter.
1182 uint64_t getCurrentProfileCount() {
1183 return PGO.getCurrentRegionCount();
1184 }
1185
Justin Bogneref512b92014-01-06 22:27:43 +00001186private:
1187
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001188 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001189 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001190 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001191 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1192 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001193
Mike Stumpfc496822009-02-08 23:14:22 +00001194 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001195 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001196 llvm::BasicBlock *CaseRangeBlock;
1197
John McCallc07a0c72011-02-17 10:25:35 +00001198 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001199 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001200 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1201 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001202
Mike Stumpfc496822009-02-08 23:14:22 +00001203 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001204 // We track this by the size expression rather than the type itself because
1205 // in certain situations, like a const qualifier applied to an VLA typedef,
1206 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001207 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1208 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001209 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001210
John McCallbd309292010-07-06 01:34:17 +00001211 /// A block containing a single 'unreachable' instruction. Created
1212 /// lazily by getUnreachableBlock().
1213 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001214
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001215 /// Counts of the number return expressions in the function.
1216 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001217
1218 /// Count the number of simple (constant) return expressions in the function.
1219 unsigned NumSimpleReturnExprs;
1220
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001221 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001222 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001223
Richard Smith852c9db2013-04-20 22:23:05 +00001224public:
1225 /// A scope within which we are constructing the fields of an object which
1226 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1227 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1228 class FieldConstructionScope {
1229 public:
John McCall7f416cc2015-09-08 08:05:57 +00001230 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001231 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1232 CGF.CXXDefaultInitExprThis = This;
1233 }
1234 ~FieldConstructionScope() {
1235 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1236 }
1237
1238 private:
1239 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001240 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001241 };
1242
1243 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1244 /// is overridden to be the object under construction.
1245 class CXXDefaultInitExprScope {
1246 public:
1247 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001248 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1249 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1250 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1251 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001252 }
1253 ~CXXDefaultInitExprScope() {
1254 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001255 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001256 }
1257
1258 public:
1259 CodeGenFunction &CGF;
1260 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001261 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001262 };
1263
Richard Smith410306b2016-12-12 02:53:20 +00001264 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1265 /// current loop index is overridden.
1266 class ArrayInitLoopExprScope {
1267 public:
1268 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1269 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1270 CGF.ArrayInitIndex = Index;
1271 }
1272 ~ArrayInitLoopExprScope() {
1273 CGF.ArrayInitIndex = OldArrayInitIndex;
1274 }
1275
1276 private:
1277 CodeGenFunction &CGF;
1278 llvm::Value *OldArrayInitIndex;
1279 };
1280
Richard Smith5179eb72016-06-28 19:03:57 +00001281 class InlinedInheritingConstructorScope {
1282 public:
1283 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1284 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1285 OldCurCodeDecl(CGF.CurCodeDecl),
1286 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1287 OldCXXABIThisValue(CGF.CXXABIThisValue),
1288 OldCXXThisValue(CGF.CXXThisValue),
1289 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1290 OldCXXThisAlignment(CGF.CXXThisAlignment),
1291 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1292 OldCXXInheritedCtorInitExprArgs(
1293 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1294 CGF.CurGD = GD;
1295 CGF.CurFuncDecl = CGF.CurCodeDecl =
1296 cast<CXXConstructorDecl>(GD.getDecl());
1297 CGF.CXXABIThisDecl = nullptr;
1298 CGF.CXXABIThisValue = nullptr;
1299 CGF.CXXThisValue = nullptr;
1300 CGF.CXXABIThisAlignment = CharUnits();
1301 CGF.CXXThisAlignment = CharUnits();
1302 CGF.ReturnValue = Address::invalid();
1303 CGF.FnRetTy = QualType();
1304 CGF.CXXInheritedCtorInitExprArgs.clear();
1305 }
1306 ~InlinedInheritingConstructorScope() {
1307 CGF.CurGD = OldCurGD;
1308 CGF.CurFuncDecl = OldCurFuncDecl;
1309 CGF.CurCodeDecl = OldCurCodeDecl;
1310 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1311 CGF.CXXABIThisValue = OldCXXABIThisValue;
1312 CGF.CXXThisValue = OldCXXThisValue;
1313 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1314 CGF.CXXThisAlignment = OldCXXThisAlignment;
1315 CGF.ReturnValue = OldReturnValue;
1316 CGF.FnRetTy = OldFnRetTy;
1317 CGF.CXXInheritedCtorInitExprArgs =
1318 std::move(OldCXXInheritedCtorInitExprArgs);
1319 }
1320
1321 private:
1322 CodeGenFunction &CGF;
1323 GlobalDecl OldCurGD;
1324 const Decl *OldCurFuncDecl;
1325 const Decl *OldCurCodeDecl;
1326 ImplicitParamDecl *OldCXXABIThisDecl;
1327 llvm::Value *OldCXXABIThisValue;
1328 llvm::Value *OldCXXThisValue;
1329 CharUnits OldCXXABIThisAlignment;
1330 CharUnits OldCXXThisAlignment;
1331 Address OldReturnValue;
1332 QualType OldFnRetTy;
1333 CallArgList OldCXXInheritedCtorInitExprArgs;
1334 };
1335
Richard Smith852c9db2013-04-20 22:23:05 +00001336private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001337 /// CXXThisDecl - When generating code for a C++ member function,
1338 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001339 ImplicitParamDecl *CXXABIThisDecl;
1340 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001341 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001342 CharUnits CXXABIThisAlignment;
1343 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001344
Richard Smith852c9db2013-04-20 22:23:05 +00001345 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1346 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001347 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001348
Richard Smith410306b2016-12-12 02:53:20 +00001349 /// The current array initialization index when evaluating an
1350 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1351 llvm::Value *ArrayInitIndex = nullptr;
1352
Richard Smith5179eb72016-06-28 19:03:57 +00001353 /// The values of function arguments to use when evaluating
1354 /// CXXInheritedCtorInitExprs within this context.
1355 CallArgList CXXInheritedCtorInitExprArgs;
1356
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001357 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1358 /// destructor, this will hold the implicit argument (e.g. VTT).
1359 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1360 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001361
John McCallce1de612011-01-26 04:00:11 +00001362 /// OutermostConditional - Points to the outermost active
1363 /// conditional control. This is used so that we know if a
1364 /// temporary should be destroyed conditionally.
1365 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001366
Nadav Rotem1da30942013-03-23 06:43:35 +00001367 /// The current lexical scope.
1368 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001369
Adrian Prantldc237b52013-05-16 00:41:26 +00001370 /// The current source location that should be used for exception
1371 /// handling code.
1372 SourceLocation CurEHLocation;
1373
John McCall7f416cc2015-09-08 08:05:57 +00001374 /// BlockByrefInfos - For each __block variable, contains
1375 /// information about the layout of the variable.
1376 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001377
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001378 /// Used by -fsanitize=nullability-return to determine whether the return
1379 /// value can be checked.
1380 llvm::Value *RetValNullabilityPrecondition = nullptr;
1381
1382 /// Check if -fsanitize=nullability-return instrumentation is required for
1383 /// this function.
1384 bool requiresReturnValueNullabilityCheck() const {
1385 return RetValNullabilityPrecondition;
1386 }
1387
John McCallbd309292010-07-06 01:34:17 +00001388 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001389 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001390 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001391
Vitaly Buka1c943322016-10-26 01:59:57 +00001392 /// True if we need emit the life-time markers.
1393 const bool ShouldEmitLifetimeMarkers;
1394
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001395 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1396 /// In the kernel metadata node, reference the kernel function and metadata
1397 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001398 /// - A node for the vec_type_hint(<type>) qualifier contains string
1399 /// "vec_type_hint", an undefined value of the <type> data type,
1400 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001401 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1402 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1403 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1404 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1405 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1406 llvm::Function *Fn);
1407
Chris Lattnerbed31442007-05-28 01:07:47 +00001408public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001409 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001410 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001411
John McCall8ed55a52010-09-02 09:58:18 +00001412 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001413 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001414 CGDebugInfo *getDebugInfo() {
1415 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001416 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001417 return DebugInfo;
1418 }
1419 void disableDebugInfo() { DisableDebugInfo = true; }
1420 void enableDebugInfo() { DisableDebugInfo = false; }
1421
John McCall31168b02011-06-15 23:02:42 +00001422 bool shouldUseFusedARCCalls() {
1423 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1424 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001425
David Blaikiebbafb8a2012-03-11 07:00:24 +00001426 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001427
Bill Wendlingf0724e82011-09-19 20:31:14 +00001428 /// Returns a pointer to the function's exception object and selector slot,
1429 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001430 Address getExceptionSlot();
1431 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001432
Bill Wendling79a70e42011-09-15 18:57:19 +00001433 /// Returns the contents of the function's exception object and selector
1434 /// slots.
1435 llvm::Value *getExceptionFromSlot();
1436 llvm::Value *getSelectorFromSlot();
1437
John McCall7f416cc2015-09-08 08:05:57 +00001438 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001439
John McCallbd309292010-07-06 01:34:17 +00001440 llvm::BasicBlock *getUnreachableBlock() {
1441 if (!UnreachableBlock) {
1442 UnreachableBlock = createBasicBlock("unreachable");
1443 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1444 }
1445 return UnreachableBlock;
1446 }
1447
1448 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001449 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001450 return getInvokeDestImpl();
1451 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001452
David Majnemer25eb1652016-03-01 19:42:53 +00001453 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001454
John McCallc8e01702013-04-16 22:48:15 +00001455 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001456 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001457
Daniel Dunbar12347492009-02-23 17:26:39 +00001458 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001459 // Cleanups
1460 //===--------------------------------------------------------------------===//
1461
John McCall7f416cc2015-09-08 08:05:57 +00001462 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001463
John McCall178360e2011-07-11 08:38:19 +00001464 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001465 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001466 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001467 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001468 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001469 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1470 llvm::Value *arrayEnd,
1471 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001472 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001473 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001474
John McCall4bd0fb12011-07-12 16:41:08 +00001475 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001476 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001477 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001478 Address addr, QualType type);
1479 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001480 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001481 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001482 QualType type, Destroyer *destroyer,
1483 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001484 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1485 llvm::Value *CompletePtr,
1486 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001487 void pushStackRestore(CleanupKind kind, Address SPMem);
1488 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001489 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001490 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001491 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001492 bool useEHCleanupForArray,
1493 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001494 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001495 QualType elementType, CharUnits elementAlign,
1496 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001497 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001498
Peter Collingbourne1425b452012-01-26 03:33:36 +00001499 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001500
John McCall82fe67b2011-07-09 01:37:26 +00001501 /// Determines whether an EH cleanup is required to destroy a type
1502 /// with the given destruction kind.
1503 bool needsEHCleanup(QualType::DestructionKind kind) {
1504 switch (kind) {
1505 case QualType::DK_none:
1506 return false;
1507 case QualType::DK_cxx_destructor:
1508 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001509 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001510 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001511 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001512 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1513 }
1514 llvm_unreachable("bad destruction kind");
1515 }
1516
John McCall4bd0fb12011-07-12 16:41:08 +00001517 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1518 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1519 }
1520
John McCall82fe67b2011-07-09 01:37:26 +00001521 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001522 // Objective-C
1523 //===--------------------------------------------------------------------===//
1524
Chris Lattner4bd55962008-03-30 23:03:07 +00001525 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001526
David Blaikief1425802015-01-14 00:04:42 +00001527 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001528
Mike Stumpfc496822009-02-08 23:14:22 +00001529 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001530 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1531 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001532 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001533 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001534 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001535 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001536
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001537 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1538 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001539
Mike Stumpfc496822009-02-08 23:14:22 +00001540 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1541 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001542 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1543 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001544 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001545 const ObjCPropertyImplDecl *propImpl,
1546 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001547
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001548 //===--------------------------------------------------------------------===//
1549 // Block Bits
1550 //===--------------------------------------------------------------------===//
1551
John McCall351762c2011-02-07 10:33:21 +00001552 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001553 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001554
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001555 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001556 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001557 const DeclMapTy &ldm,
1558 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001559
John McCallad7c5c12011-02-08 08:22:06 +00001560 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1561 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001562 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1563 const ObjCPropertyImplDecl *PID);
1564 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1565 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001566 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001567
John McCallad7c5c12011-02-08 08:22:06 +00001568 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1569
John McCall73064872011-03-31 01:59:53 +00001570 class AutoVarEmission;
1571
1572 void emitByrefStructureInit(const AutoVarEmission &emission);
1573 void enterByrefCleanup(const AutoVarEmission &emission);
1574
John McCall7f416cc2015-09-08 08:05:57 +00001575 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1576 llvm::Value *ptr);
1577
1578 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001579 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1580
1581 /// BuildBlockByrefAddress - Computes the location of the
1582 /// data in a variable which is declared as __block.
1583 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1584 bool followForward = true);
1585 Address emitBlockByrefAddress(Address baseAddr,
1586 const BlockByrefInfo &info,
1587 bool followForward,
1588 const llvm::Twine &name);
1589
1590 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001591
Richard Smith5179eb72016-06-28 19:03:57 +00001592 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1593
John McCalla738c252011-03-09 04:27:21 +00001594 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1595 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001596 /// \brief Emit code for the start of a function.
1597 /// \param Loc The location to be associated with the function.
1598 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001599 void StartFunction(GlobalDecl GD,
1600 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001601 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001602 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001603 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001604 SourceLocation Loc = SourceLocation(),
1605 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001606
Vedant Kumar7f809b22017-02-24 01:15:19 +00001607 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1608
John McCallb81884d2010-02-19 09:25:03 +00001609 void EmitConstructorBody(FunctionArgList &Args);
1610 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001611 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001612 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001613 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001614
Faisal Vali571df122013-09-29 08:45:24 +00001615 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001616 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001617 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001618 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001619 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1620 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001621 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001622
David Blaikiea0a1a872015-01-18 02:48:07 +00001623 /// \brief Emit the unified return block, trying to avoid its emission when
1624 /// possible.
1625 /// \return The debug location of the user written return statement if the
1626 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001627 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001628
Mike Stumpfc496822009-02-08 23:14:22 +00001629 /// FinishFunction - Complete IR generation of the current function. It is
1630 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001631 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001632
Nico Weber1bebad12015-02-11 22:33:32 +00001633 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1634 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001635
John McCallb92ab1a2016-10-26 23:46:34 +00001636 void EmitCallAndReturnForThunk(llvm::Constant *Callee,
1637 const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001638
John McCall7f416cc2015-09-08 08:05:57 +00001639 void FinishThunk();
1640
Reid Klecknerab2090d2014-07-26 01:34:32 +00001641 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1642 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1643 llvm::Value *Callee);
1644
Rafael Espindolad6e66942015-07-13 06:07:58 +00001645 /// Generate a thunk for the given method.
1646 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001647 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001648
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001649 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1650 const CGFunctionInfo &FnInfo,
1651 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001652
Douglas Gregor94f9a482010-05-05 05:51:00 +00001653 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1654 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001655
Richard Smith30e304e2016-12-14 00:03:17 +00001656 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001657
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001658 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1659 struct VPtr {
1660 BaseSubobject Base;
1661 const CXXRecordDecl *NearestVBase;
1662 CharUnits OffsetFromNearestVBase;
1663 const CXXRecordDecl *VTableClass;
1664 };
1665
1666 /// Initialize the vtable pointer of the given subobject.
1667 void InitializeVTablePointer(const VPtr &vptr);
1668
1669 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001670
1671 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001672 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1673
1674 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1675 CharUnits OffsetFromNearestVBase,
1676 bool BaseIsNonVirtualPrimaryBase,
1677 const CXXRecordDecl *VTableClass,
1678 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001679
Anders Carlssond5895932010-03-28 21:07:49 +00001680 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001681
Dan Gohman8fc50c22010-10-26 18:44:08 +00001682 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1683 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001684 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1685 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001686
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001687 enum CFITypeCheckKind {
1688 CFITCK_VCall,
1689 CFITCK_NVCall,
1690 CFITCK_DerivedCast,
1691 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001692 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001693 };
1694
Peter Collingbourned2926c92015-03-14 02:42:25 +00001695 /// \brief Derived is the presumed address of an object of type T after a
1696 /// cast. If T is a polymorphic class type, emit a check that the virtual
1697 /// table for Derived belongs to a class derived from T.
1698 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001699 bool MayBeNull, CFITypeCheckKind TCK,
1700 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001701
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001702 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1703 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001704 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001705 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001706
Peter Collingbourned2926c92015-03-14 02:42:25 +00001707 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001708 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001709 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1710 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001711
Peter Collingbournefb532b92016-02-24 20:46:36 +00001712 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001713 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1714 /// enabled, emit a check that VTable is a member of RD's type identifier.
1715 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1716 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001717
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001718 /// Returns whether we should perform a type checked load when loading a
1719 /// virtual function for virtual calls to members of RD. This is generally
1720 /// true when both vcall CFI and whole-program-vtables are enabled.
1721 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1722
1723 /// Emit a type checked load from the given vtable.
1724 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1725 uint64_t VTableByteOffset);
1726
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001727 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1728 /// expr can be devirtualized.
1729 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1730 const CXXMethodDecl *MD);
1731
John McCallf99a6312010-07-21 05:30:47 +00001732 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1733 /// given phase of destruction for a destructor. The end result
1734 /// should call destructors on members and base classes in reverse
1735 /// order of their construction.
1736 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001737
Chris Lattner3c77a352010-06-22 00:03:40 +00001738 /// ShouldInstrumentFunction - Return true if the current function should be
1739 /// instrumented with __cyg_profile_func_* calls
1740 bool ShouldInstrumentFunction();
1741
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001742 /// ShouldXRayInstrument - Return true if the current function should be
1743 /// instrumented with XRay nop sleds.
1744 bool ShouldXRayInstrumentFunction() const;
1745
Chris Lattner3c77a352010-06-22 00:03:40 +00001746 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1747 /// instrumentation function with the current function and the call site, if
1748 /// function instrumentation is enabled.
1749 void EmitFunctionInstrumentation(const char *Fn);
1750
Roman Divacky178e01602011-02-10 16:52:03 +00001751 /// EmitMCountInstrumentation - Emit call to .mcount.
1752 void EmitMCountInstrumentation();
1753
Mike Stumpfc496822009-02-08 23:14:22 +00001754 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1755 /// arguments for the given function. This is also responsible for naming the
1756 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001757 void EmitFunctionProlog(const CGFunctionInfo &FI,
1758 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001759 const FunctionArgList &Args);
1760
Mike Stumpfc496822009-02-08 23:14:22 +00001761 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1762 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001763 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1764 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001765
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001766 /// Emit a test that checks if the return value \p RV is nonnull.
1767 void EmitReturnValueCheck(llvm::Value *RV, SourceLocation EndLoc);
1768
Mike Stump1d849212009-12-07 23:38:24 +00001769 /// EmitStartEHSpec - Emit the start of the exception spec.
1770 void EmitStartEHSpec(const Decl *D);
1771
1772 /// EmitEndEHSpec - Emit the end of the exception spec.
1773 void EmitEndEHSpec(const Decl *D);
1774
John McCallbd309292010-07-06 01:34:17 +00001775 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1776 llvm::BasicBlock *getTerminateLandingPad();
1777
1778 /// getTerminateHandler - Return a handler (not a landing pad, just
1779 /// a catch handler) that just calls terminate. This is used when
1780 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001781 llvm::BasicBlock *getTerminateHandler();
1782
Chris Lattnera5f58b02011-07-09 17:41:47 +00001783 llvm::Type *ConvertTypeForMem(QualType T);
1784 llvm::Type *ConvertType(QualType T);
1785 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001786 return ConvertType(getContext().getTypeDeclType(T));
1787 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001788
Mike Stumpfc496822009-02-08 23:14:22 +00001789 /// LoadObjCSelf - Load the value of self. This function is only valid while
1790 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001791 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001792
1793 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001794 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001795
Chris Lattner54fb19e2007-06-22 22:02:34 +00001796 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1797 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001798 static TypeEvaluationKind getEvaluationKind(QualType T);
1799
1800 static bool hasScalarEvaluationKind(QualType T) {
1801 return getEvaluationKind(T) == TEK_Scalar;
1802 }
1803
1804 static bool hasAggregateEvaluationKind(QualType T) {
1805 return getEvaluationKind(T) == TEK_Aggregate;
1806 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001807
1808 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001809 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001810 llvm::Function *parent = nullptr,
1811 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001812#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001813 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001814#else
John McCallad7c5c12011-02-08 08:22:06 +00001815 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001816#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001817 }
Mike Stumpfc496822009-02-08 23:14:22 +00001818
Chris Lattnerac248202007-05-30 00:13:02 +00001819 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1820 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001821 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001822
Mike Stumpe5311b02009-11-30 20:08:49 +00001823 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1824 /// another basic block, simplify it. This assumes that no other code could
1825 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001826 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1827
Mike Stumpfc496822009-02-08 23:14:22 +00001828 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1829 /// adding a fall-through branch from the current insert block if
1830 /// necessary. It is legal to call this function even if there is no current
1831 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001832 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001833 /// IsFinished - If true, indicates that the caller has finished emitting
1834 /// branches to the given block and does not expect to emit code into it. This
1835 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001836 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001837
John McCall8e4c74b2011-08-11 02:22:43 +00001838 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1839 /// near its uses, and leave the insertion point in it.
1840 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1841
Mike Stumpfc496822009-02-08 23:14:22 +00001842 /// EmitBranch - Emit a branch to the specified basic block from the current
1843 /// insert block, taking care to avoid creation of branches from dummy
1844 /// blocks. It is legal to call this function even if there is no current
1845 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001846 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001847 /// This function clears the current insertion point. The caller should follow
1848 /// calls to this function with calls to Emit*Block prior to generation new
1849 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001850 void EmitBranch(llvm::BasicBlock *Block);
1851
Mike Stumpfc496822009-02-08 23:14:22 +00001852 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1853 /// indicates that the current code being emitted is unreachable.
1854 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001855 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001856 }
1857
Mike Stumpfc496822009-02-08 23:14:22 +00001858 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1859 /// emitted IR has a place to go. Note that by definition, if this function
1860 /// creates a block then that block is unreachable; callers may do better to
1861 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001862 void EnsureInsertPoint() {
1863 if (!HaveInsertPoint())
1864 EmitBlock(createBasicBlock());
1865 }
Mike Stumpfc496822009-02-08 23:14:22 +00001866
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001867 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001868 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001869 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001870
Chris Lattnere9a64532007-06-22 21:44:33 +00001871 //===--------------------------------------------------------------------===//
1872 // Helpers
1873 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001874
John McCall7f416cc2015-09-08 08:05:57 +00001875 LValue MakeAddrLValue(Address Addr, QualType T,
1876 AlignmentSource AlignSource = AlignmentSource::Type) {
1877 return LValue::MakeAddr(Addr, T, getContext(), AlignSource,
Dan Gohman947c9af2010-10-14 23:06:10 +00001878 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001879 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001880
John McCall7f416cc2015-09-08 08:05:57 +00001881 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1882 AlignmentSource AlignSource = AlignmentSource::Type) {
1883 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1884 AlignSource, CGM.getTBAAInfo(T));
1885 }
1886
1887 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001888 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001889 CharUnits getNaturalTypeAlignment(QualType T,
1890 AlignmentSource *Source = nullptr,
1891 bool forPointeeType = false);
1892 CharUnits getNaturalPointeeTypeAlignment(QualType T,
1893 AlignmentSource *Source = nullptr);
1894
1895 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
1896 AlignmentSource *Source = nullptr);
1897 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001898
Alexey Bataev31300ed2016-02-04 11:27:03 +00001899 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
1900 AlignmentSource *Source = nullptr);
1901 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1902
Chris Lattnere9a64532007-06-22 21:44:33 +00001903 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001904 /// block. The caller is responsible for setting an appropriate alignment on
1905 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001906 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001907 const Twine &Name = "tmp");
John McCall7f416cc2015-09-08 08:05:57 +00001908 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
1909 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001910
John McCall7f416cc2015-09-08 08:05:57 +00001911 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1912 /// default ABI alignment of the given LLVM type.
1913 ///
1914 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1915 /// any given AST type that happens to have been lowered to the
1916 /// given IR type. This should only ever be used for function-local,
1917 /// IR-driven manipulations like saving and restoring a value. Do
1918 /// not hand this address off to arbitrary IRGen routines, and especially
1919 /// do not pass it as an argument to a function that might expect a
1920 /// properly ABI-aligned value.
1921 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1922 const Twine &Name = "tmp");
1923
1924 /// InitTempAlloca - Provide an initial value for the given alloca which
1925 /// will be observable at all locations in the function.
1926 ///
1927 /// The address should be something that was returned from one of
1928 /// the CreateTempAlloca or CreateMemTemp routines, and the
1929 /// initializer must be valid in the entry block (i.e. it must
1930 /// either be a constant or an argument value).
1931 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001932
Daniel Dunbard0049182010-02-16 19:44:13 +00001933 /// CreateIRTemp - Create a temporary IR object of the given type, with
1934 /// appropriate alignment. This routine should only be used when an temporary
1935 /// value needs to be stored into an alloca (for example, to avoid explicit
1936 /// PHI construction), but the type is the IR type, not the type appropriate
1937 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001938 ///
1939 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1940 /// ConvertType instead of ConvertTypeForMem.
1941 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001942
Daniel Dunbara7566f12010-02-09 02:48:28 +00001943 /// CreateMemTemp - Create a temporary memory object of the given type, with
1944 /// appropriate alignment.
John McCall7f416cc2015-09-08 08:05:57 +00001945 Address CreateMemTemp(QualType T, const Twine &Name = "tmp");
1946 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001947
John McCall7a626f62010-09-15 10:14:12 +00001948 /// CreateAggTemp - Create a temporary memory object for the given
1949 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001950 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00001951 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001952 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001953 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001954 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001955 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001956 }
1957
John McCallad7c5c12011-02-08 08:22:06 +00001958 /// Emit a cast to void* in the appropriate address space.
1959 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1960
Chris Lattner8394d792007-06-05 20:53:16 +00001961 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1962 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001963 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001964
John McCalla2342eb2010-12-05 02:00:02 +00001965 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1966 void EmitIgnoredExpr(const Expr *E);
1967
Chris Lattner4647a212007-08-31 22:49:20 +00001968 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1969 /// any type. The result is returned as an RValue struct. If this is an
1970 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1971 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001972 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001973 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001974 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001975 AggValueSlot aggSlot = AggValueSlot::ignored(),
1976 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001977
Mike Stumpfc496822009-02-08 23:14:22 +00001978 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1979 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00001980 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001981
Charles Davisc7d5c942015-09-17 20:55:33 +00001982 /// Emit a "reference" to a __builtin_ms_va_list; this is
1983 /// always the value of the expression, because a __builtin_ms_va_list is a
1984 /// pointer to a char.
1985 Address EmitMSVAListRef(const Expr *E);
1986
Mike Stumpfc496822009-02-08 23:14:22 +00001987 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1988 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001989 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001990
John McCall91ca10f2011-03-08 09:11:50 +00001991 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001992 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00001993 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001994 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001995
John McCall7f416cc2015-09-08 08:05:57 +00001996 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00001997
John McCall91ca10f2011-03-08 09:11:50 +00001998 /// EmitExprAsInit - Emits the code necessary to initialize a
1999 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00002000 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002001 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00002002
Fariborz Jahanian78652202013-01-25 23:57:05 +00002003 /// hasVolatileMember - returns true if aggregate type has a volatile
2004 /// member.
2005 bool hasVolatileMember(QualType T) {
2006 if (const RecordType *RT = T->getAs<RecordType>()) {
2007 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2008 return RD->hasVolatileMember();
2009 }
2010 return false;
2011 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002012 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002013 ///
2014 /// The difference to EmitAggregateCopy is that tail padding is not copied.
2015 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00002016 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00002017 QualType EltTy) {
2018 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00002019 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002020 }
2021
John McCall7f416cc2015-09-08 08:05:57 +00002022 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
2023 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00002024 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00002025 /*IsAssignment=*/false);
2026 }
2027
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002028 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00002029 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00002030 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00002031 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002032 /// \param isAssignment - If false, allow padding to be copied. This often
2033 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00002034 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00002035 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002036 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00002037
Anders Carlsson9396a892008-09-11 09:15:33 +00002038 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00002039 Address GetAddrOfLocalVar(const VarDecl *VD) {
2040 auto it = LocalDeclMap.find(VD);
2041 assert(it != LocalDeclMap.end() &&
2042 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2043 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00002044 }
Mike Stumpfc496822009-02-08 23:14:22 +00002045
John McCallc07a0c72011-02-17 10:25:35 +00002046 /// getOpaqueLValueMapping - Given an opaque value expression (which
2047 /// must be mapped to an l-value), return its mapping.
2048 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
2049 assert(OpaqueValueMapping::shouldBindAsLValue(e));
2050
2051 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
2052 it = OpaqueLValues.find(e);
2053 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
2054 return it->second;
2055 }
2056
2057 /// getOpaqueRValueMapping - Given an opaque value expression (which
2058 /// must be mapped to an r-value), return its mapping.
2059 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
2060 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
2061
2062 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
2063 it = OpaqueRValues.find(e);
2064 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00002065 return it->second;
2066 }
2067
Richard Smith410306b2016-12-12 02:53:20 +00002068 /// Get the index of the current ArrayInitLoopExpr, if any.
2069 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2070
Dan Gohman75d69da2008-05-22 00:50:06 +00002071 /// getAccessedFieldNo - Given an encoded value and a result number, return
2072 /// the input field number being accessed.
2073 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2074
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002075 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002076 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002077
Vedant Kumare550d112017-02-23 01:22:38 +00002078 /// Check if \p E is a reference, or a C++ "this" pointer wrapped in value-
2079 /// preserving casts.
2080 static bool IsDeclRefOrWrappedCXXThis(const Expr *E);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00002081
Anders Carlssonc0964b62010-05-22 17:35:42 +00002082 /// EmitNullInitialization - Generate code to set a value of the given type to
2083 /// null, If the type contains data member pointers, they will be initialized
2084 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002085 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002086
Charles Davisc7d5c942015-09-17 20:55:33 +00002087 /// Emits a call to an LLVM variable-argument intrinsic, either
2088 /// \c llvm.va_start or \c llvm.va_end.
2089 /// \param ArgValue A reference to the \c va_list as emitted by either
2090 /// \c EmitVAListRef or \c EmitMSVAListRef.
2091 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2092 /// calls \c llvm.va_end.
2093 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2094
2095 /// Generate code to get an argument from the passed in pointer
2096 /// and update it accordingly.
2097 /// \param VE The \c VAArgExpr for which to generate code.
2098 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2099 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2100 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002101 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002102 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002103 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002104
John McCall82fe67b2011-07-09 01:37:26 +00002105 /// emitArrayLength - Compute the length of an array, even if it's a
2106 /// VLA, and drill down to the base element type.
2107 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2108 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002109 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002110
John McCall23c29fe2011-06-24 21:55:10 +00002111 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2112 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002113 ///
2114 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002115 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002116
John McCall23c29fe2011-06-24 21:55:10 +00002117 /// getVLASize - Returns an LLVM value that corresponds to the size,
2118 /// in non-variably-sized elements, of a variable length array type,
2119 /// plus that largest non-variably-sized element type. Assumes that
2120 /// the type has already been emitted with EmitVariablyModifiedType.
2121 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
2122 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002123
Anders Carlssona5d077d2009-04-14 16:58:56 +00002124 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2125 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002126 llvm::Value *LoadCXXThis() {
2127 assert(CXXThisValue && "no 'this' value for this function");
2128 return CXXThisValue;
2129 }
John McCall7f416cc2015-09-08 08:05:57 +00002130 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002131
Anders Carlssone36a6b32010-01-02 01:01:18 +00002132 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2133 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002134 // FIXME: Every place that calls LoadCXXVTT is something
2135 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002136 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002137 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2138 return CXXStructorImplicitParamValue;
2139 }
2140
John McCall6ce74722010-02-16 04:15:37 +00002141 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002142 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002143 Address
2144 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002145 const CXXRecordDecl *Derived,
2146 const CXXRecordDecl *Base,
2147 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002148
John McCall7f416cc2015-09-08 08:05:57 +00002149 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2150
Mike Stumpe5311b02009-11-30 20:08:49 +00002151 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2152 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002153 Address GetAddressOfBaseClass(Address Value,
2154 const CXXRecordDecl *Derived,
2155 CastExpr::path_const_iterator PathBegin,
2156 CastExpr::path_const_iterator PathEnd,
2157 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002158
John McCall7f416cc2015-09-08 08:05:57 +00002159 Address GetAddressOfDerivedClass(Address Value,
2160 const CXXRecordDecl *Derived,
2161 CastExpr::path_const_iterator PathBegin,
2162 CastExpr::path_const_iterator PathEnd,
2163 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002164
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002165 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2166 /// base constructor/destructor with virtual bases.
2167 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2168 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2169 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2170 bool Delegating);
2171
John McCallf8ff7b92010-02-23 00:48:20 +00002172 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2173 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002174 const FunctionArgList &Args,
2175 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002176 // It's important not to confuse this and the previous function. Delegating
2177 // constructors are the C++0x feature. The constructor delegate optimization
2178 // is used to reduce duplication in the base and complete consturctors where
2179 // they are substantially the same.
2180 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2181 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002182
Richard Smith5179eb72016-06-28 19:03:57 +00002183 /// Emit a call to an inheriting constructor (that is, one that invokes a
2184 /// constructor inherited from a base class) by inlining its definition. This
2185 /// is necessary if the ABI does not support forwarding the arguments to the
2186 /// base class constructor (because they're variadic or similar).
2187 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2188 CXXCtorType CtorType,
2189 bool ForVirtualBase,
2190 bool Delegating,
2191 CallArgList &Args);
2192
2193 /// Emit a call to a constructor inherited from a base class, passing the
2194 /// current constructor's arguments along unmodified (without even making
2195 /// a copy).
2196 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2197 bool ForVirtualBase, Address This,
2198 bool InheritedFromVBase,
2199 const CXXInheritedCtorInitExpr *E);
2200
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002201 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002202 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002203 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002204
Richard Smith5179eb72016-06-28 19:03:57 +00002205 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2206 bool ForVirtualBase, bool Delegating,
2207 Address This, CallArgList &Args);
2208
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002209 /// Emit assumption load for all bases. Requires to be be called only on
2210 /// most-derived class and not under construction of the object.
2211 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2212
2213 /// Emit assumption that vptr load == global vtable.
2214 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2215
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002216 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002217 Address This, Address Src,
2218 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002219
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002220 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002221 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002222 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002223 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002224 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002225
Anders Carlssond49844b2009-09-23 02:45:36 +00002226 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2227 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002228 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002229 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002230 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002231
John McCall82fe67b2011-07-09 01:37:26 +00002232 static Destroyer destroyCXXObject;
2233
Anders Carlsson0a637412009-05-29 21:03:38 +00002234 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002235 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002236 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002237
John McCall99210dc2011-09-15 06:49:18 +00002238 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002239 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002240 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002241 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002242
Peter Collingbourne702b2842011-11-27 22:09:22 +00002243 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002244 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002245
David Majnemerdc012fa2015-04-22 21:38:15 +00002246 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2247 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2248
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002249 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002250 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002251
Eli Friedman24f55432009-11-18 00:57:03 +00002252 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002253 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2254 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002255
Richard Smith760520b2014-06-03 23:27:44 +00002256 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2257 const Expr *Arg, bool IsDelete);
2258
John McCall7f416cc2015-09-08 08:05:57 +00002259 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2260 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2261 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002262
Richard Smith69d0d262012-08-24 00:54:33 +00002263 /// \brief Situations in which we might emit a check for the suitability of a
2264 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002265 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002266 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002267 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002268 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002269 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002270 /// Checking the bound value in a reference binding. Must be suitably sized
2271 /// and aligned, but is not required to refer to an object (until the
2272 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002273 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002274 /// Checking the object expression in a non-static data member access. Must
2275 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002276 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002277 /// Checking the 'this' pointer for a call to a non-static member function.
2278 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002279 TCK_MemberCall,
2280 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002281 TCK_ConstructorCall,
2282 /// Checking the operand of a static_cast to a derived pointer type. Must be
2283 /// null or an object within its lifetime.
2284 TCK_DowncastPointer,
2285 /// Checking the operand of a static_cast to a derived reference type. Must
2286 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002287 TCK_DowncastReference,
2288 /// Checking the operand of a cast to a base object. Must be suitably sized
2289 /// and aligned.
2290 TCK_Upcast,
2291 /// Checking the operand of a cast to a virtual base object. Must be an
2292 /// object within its lifetime.
2293 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00002294 };
2295
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002296 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2297 /// calls to EmitTypeCheck can be skipped.
2298 bool sanitizePerformTypeCheck() const;
2299
Richard Smith4d1458e2012-09-08 02:08:36 +00002300 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002301 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002302 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002303 QualType Type, CharUnits Alignment = CharUnits::Zero(),
Vedant Kumar18348ea2017-02-17 23:22:55 +00002304 SanitizerSet SkippedChecks = SanitizerSet());
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002305
Richard Smith539e4a72013-02-23 02:53:19 +00002306 /// \brief Emit a check that \p Base points into an array object, which
2307 /// we can access at index \p Index. \p Accessed should be \c false if we
2308 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2309 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2310 QualType IndexType, bool Accessed);
2311
Chris Lattner116ce8f2010-01-09 21:40:03 +00002312 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2313 bool isInc, bool isPre);
2314 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2315 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002316
2317 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002318 llvm::Value *OffsetValue = nullptr) {
2319 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2320 OffsetValue);
2321 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002322
Amara Emerson652795d2016-11-10 14:44:30 +00002323 /// Converts Location to a DebugLoc, if debug information is enabled.
2324 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2325
2326
Chris Lattner8394d792007-06-05 20:53:16 +00002327 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002328 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002329 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002330
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002331 /// EmitDecl - Emit a declaration.
2332 ///
2333 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002334 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002335
John McCall1c9c3fd2010-10-15 04:57:14 +00002336 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002337 ///
2338 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002339 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002340
David Blaikie73ca5692014-12-09 00:32:22 +00002341 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002342 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002343
John McCallbd309292010-07-06 01:34:17 +00002344 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2345 llvm::Value *Address);
2346
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002347 /// \brief Determine whether the given initializer is trivial in the sense
2348 /// that it requires no code to be generated.
2349 bool isTrivialInitializer(const Expr *Init);
2350
John McCall1c9c3fd2010-10-15 04:57:14 +00002351 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002352 ///
2353 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002354 void EmitAutoVarDecl(const VarDecl &D);
2355
2356 class AutoVarEmission {
2357 friend class CodeGenFunction;
2358
John McCall9e2e22f2011-02-22 07:16:58 +00002359 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002360
John McCall7f416cc2015-09-08 08:05:57 +00002361 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002362 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002363 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002364
2365 llvm::Value *NRVOFlag;
2366
2367 /// True if the variable is a __block variable.
2368 bool IsByRef;
2369
2370 /// True if the variable is of aggregate type and has a constant
2371 /// initializer.
2372 bool IsConstantAggregate;
2373
Nadav Rotem1da30942013-03-23 06:43:35 +00002374 /// Non-null if we should use lifetime annotations.
2375 llvm::Value *SizeForLifetimeMarkers;
2376
John McCall9e2e22f2011-02-22 07:16:58 +00002377 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002378 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002379
John McCallc533cb72011-02-22 06:44:22 +00002380 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002381 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002382 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002383 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002384
John McCall7f416cc2015-09-08 08:05:57 +00002385 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002386
2387 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002388 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2389
Craig Topper8a13c412014-05-21 05:09:00 +00002390 bool useLifetimeMarkers() const {
2391 return SizeForLifetimeMarkers != nullptr;
2392 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002393 llvm::Value *getSizeForLifetimeMarkers() const {
2394 assert(useLifetimeMarkers());
2395 return SizeForLifetimeMarkers;
2396 }
2397
2398 /// Returns the raw, allocated address, which is not necessarily
2399 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002400 Address getAllocatedAddress() const {
2401 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002402 }
2403
John McCallc533cb72011-02-22 06:44:22 +00002404 /// Returns the address of the object within this declaration.
2405 /// Note that this does not chase the forwarding pointer for
2406 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002407 Address getObjectAddress(CodeGenFunction &CGF) const {
2408 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002409
John McCall7f416cc2015-09-08 08:05:57 +00002410 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002411 }
2412 };
2413 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2414 void EmitAutoVarInit(const AutoVarEmission &emission);
2415 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002416 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2417 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002418
John McCall1c9c3fd2010-10-15 04:57:14 +00002419 void EmitStaticVarDecl(const VarDecl &D,
2420 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002421
John McCall7f416cc2015-09-08 08:05:57 +00002422 class ParamValue {
2423 llvm::Value *Value;
2424 unsigned Alignment;
2425 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2426 public:
2427 static ParamValue forDirect(llvm::Value *value) {
2428 return ParamValue(value, 0);
2429 }
2430 static ParamValue forIndirect(Address addr) {
2431 assert(!addr.getAlignment().isZero());
2432 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2433 }
2434
2435 bool isIndirect() const { return Alignment != 0; }
2436 llvm::Value *getAnyValue() const { return Value; }
2437
2438 llvm::Value *getDirectValue() const {
2439 assert(!isIndirect());
2440 return Value;
2441 }
2442
2443 Address getIndirectAddress() const {
2444 assert(isIndirect());
2445 return Address(Value, CharUnits::fromQuantity(Alignment));
2446 }
2447 };
2448
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002449 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002450 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002451
John McCallc07a0c72011-02-17 10:25:35 +00002452 /// protectFromPeepholes - Protect a value that we're intending to
2453 /// store to the side, but which will probably be used later, from
2454 /// aggressive peepholing optimizations that might delete it.
2455 ///
2456 /// Pass the result to unprotectFromPeepholes to declare that
2457 /// protection is no longer required.
2458 ///
2459 /// There's no particular reason why this shouldn't apply to
2460 /// l-values, it's just that no existing peepholes work on pointers.
2461 PeepholeProtection protectFromPeepholes(RValue rvalue);
2462 void unprotectFromPeepholes(PeepholeProtection protection);
2463
Chris Lattner84915fa2007-06-02 04:16:21 +00002464 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002465 // Statement Emission
2466 //===--------------------------------------------------------------------===//
2467
Mike Stumpfc496822009-02-08 23:14:22 +00002468 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002469 void EmitStopPoint(const Stmt *S);
2470
Mike Stumpfc496822009-02-08 23:14:22 +00002471 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2472 /// this function even if there is no current insertion point.
2473 ///
2474 /// This function may clear the current insertion point; callers should use
2475 /// EnsureInsertPoint if they wish to subsequently generate code without first
2476 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002477 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002478
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002479 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002480 /// necessarily require an insertion point or debug information; typically
2481 /// because the statement amounts to a jump or a container of other
2482 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002483 ///
2484 /// \return True if the statement was handled.
2485 bool EmitSimpleStmt(const Stmt *S);
2486
John McCall7f416cc2015-09-08 08:05:57 +00002487 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2488 AggValueSlot AVS = AggValueSlot::ignored());
2489 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2490 bool GetLast = false,
2491 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002492 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002493
Mike Stumpfc496822009-02-08 23:14:22 +00002494 /// EmitLabel - Emit the block for the given label. It is legal to call this
2495 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002496 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002497
Chris Lattnerac248202007-05-30 00:13:02 +00002498 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002499 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002500 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002501 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002502 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002503
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002504 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002505 ArrayRef<const Attr *> Attrs = None);
2506 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002507 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002508 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002509 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002510 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002511 void EmitBreakStmt(const BreakStmt &S);
2512 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002513 void EmitSwitchStmt(const SwitchStmt &S);
2514 void EmitDefaultStmt(const DefaultStmt &S);
2515 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002516 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002517 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002518
Anders Carlsson2e744e82008-08-30 19:51:14 +00002519 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002520 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2521 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002522 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002523 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002524
Gor Nishanov8df64e92016-10-27 16:28:31 +00002525 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov90be1212017-03-06 21:12:54 +00002526 void EmitCoreturnStmt(const CoreturnStmt &S);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002527 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2528
John McCallb609d3f2010-07-07 06:56:46 +00002529 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2530 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002531
Anders Carlsson52d78a52009-09-27 18:58:34 +00002532 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002533 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002534 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002535 void EnterSEHTryStmt(const SEHTryStmt &S);
2536 void ExitSEHTryStmt(const SEHTryStmt &S);
2537
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002538 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002539 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002540
2541 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2542 const SEHExceptStmt &Except);
2543
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002544 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2545 const SEHFinallyStmt &Finally);
2546
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002547 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2548 llvm::Value *ParentFP,
2549 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002550 llvm::Value *EmitSEHExceptionCode();
2551 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002552 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002553
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002554 /// Scan the outlined statement for captures from the parent function. For
2555 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002556 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002557 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002558 bool IsFilter);
2559
2560 /// Recovers the address of a local in a parent function. ParentVar is the
2561 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002562 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002563 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2564 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002565 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2566 Address ParentVar,
2567 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002568
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002569 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002570 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002571
Alexey Bataev1189bd02016-01-26 12:20:39 +00002572 /// Returns calculated size of the specified type.
2573 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002574 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002575 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002576 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002577 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002578 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002579 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002580 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002581 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2582 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002583 /// \brief Perform element by element copying of arrays with type \a
2584 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2585 /// generated by \a CopyGen.
2586 ///
2587 /// \param DestAddr Address of the destination array.
2588 /// \param SrcAddr Address of the source array.
2589 /// \param OriginalType Type of destination and source arrays.
2590 /// \param CopyGen Copying procedure that copies value of single array element
2591 /// to another single array element.
2592 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002593 Address DestAddr, Address SrcAddr, QualType OriginalType,
2594 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002595 /// \brief Emit proper copying of data from one variable to another.
2596 ///
2597 /// \param OriginalType Original type of the copied variables.
2598 /// \param DestAddr Destination address.
2599 /// \param SrcAddr Source address.
2600 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2601 /// type of the base array element).
2602 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2603 /// the base array element).
2604 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2605 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002606 void EmitOMPCopy(QualType OriginalType,
2607 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002608 const VarDecl *DestVD, const VarDecl *SrcVD,
2609 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002610 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2611 /// \a X = \a E \a BO \a E.
2612 ///
2613 /// \param X Value to be updated.
2614 /// \param E Update value.
2615 /// \param BO Binary operation for update operation.
2616 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2617 /// expression, false otherwise.
2618 /// \param AO Atomic ordering of the generated atomic instructions.
2619 /// \param CommonGen Code generator for complex expressions that cannot be
2620 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002621 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2622 /// generated, <false, RValue::get(nullptr)> otherwise.
2623 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002624 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2625 llvm::AtomicOrdering AO, SourceLocation Loc,
2626 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002627 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002628 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002629 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2630 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002631 void EmitOMPUseDevicePtrClause(
2632 const OMPClause &C, OMPPrivateScope &PrivateScope,
2633 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002634 /// \brief Emit code for copyin clause in \a D directive. The next code is
2635 /// generated at the start of outlined functions for directives:
2636 /// \code
2637 /// threadprivate_var1 = master_threadprivate_var1;
2638 /// operator=(threadprivate_var2, master_threadprivate_var2);
2639 /// ...
2640 /// __kmpc_barrier(&loc, global_tid);
2641 /// \endcode
2642 ///
2643 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2644 /// \returns true if at least one copyin variable is found, false otherwise.
2645 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002646 /// \brief Emit initial code for lastprivate variables. If some variable is
2647 /// not also firstprivate, then the default initialization is used. Otherwise
2648 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2649 /// method.
2650 ///
2651 /// \param D Directive that may have 'lastprivate' directives.
2652 /// \param PrivateScope Private scope for capturing lastprivate variables for
2653 /// proper codegen in internal captured statement.
2654 ///
2655 /// \returns true if there is at least one lastprivate variable, false
2656 /// otherwise.
2657 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2658 OMPPrivateScope &PrivateScope);
2659 /// \brief Emit final copying of lastprivate values to original variables at
2660 /// the end of the worksharing or simd directive.
2661 ///
2662 /// \param D Directive that has at least one 'lastprivate' directives.
2663 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2664 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002665 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002666 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002667 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002668 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002669 /// Emit initial code for linear clauses.
2670 void EmitOMPLinearClause(const OMPLoopDirective &D,
2671 CodeGenFunction::OMPPrivateScope &PrivateScope);
2672 /// Emit final code for linear clauses.
2673 /// \param CondGen Optional conditional code for final part of codegen for
2674 /// linear clause.
2675 void EmitOMPLinearClauseFinal(
2676 const OMPLoopDirective &D,
2677 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002678 /// \brief Emit initial code for reduction variables. Creates reduction copies
2679 /// and initializes them with the values according to OpenMP standard.
2680 ///
2681 /// \param D Directive (possibly) with the 'reduction' clause.
2682 /// \param PrivateScope Private scope for capturing reduction variables for
2683 /// proper codegen in internal captured statement.
2684 ///
2685 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2686 OMPPrivateScope &PrivateScope);
2687 /// \brief Emit final update of reduction values to original variables at
2688 /// the end of the directive.
2689 ///
2690 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00002691 /// \param ReductionKind The kind of reduction to perform.
2692 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
2693 const OpenMPDirectiveKind ReductionKind);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002694 /// \brief Emit initial code for linear variables. Creates private copies
2695 /// and initializes them with the values according to OpenMP standard.
2696 ///
2697 /// \param D Directive (possibly) with the 'linear' clause.
2698 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002699
Alexey Bataev7292c292016-04-25 12:22:29 +00002700 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2701 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002702 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002703 TaskGenTy;
2704 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2705 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002706 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00002707
Alexey Bataev9959db52014-05-06 10:08:46 +00002708 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002709 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002710 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002711 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002712 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002713 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002714 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002715 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002716 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002717 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002718 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002719 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002720 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002721 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002722 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002723 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002724 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002725 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002726 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002727 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002728 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002729 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002730 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002731 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002732 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002733 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002734 void
2735 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002736 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002737 void
2738 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002739 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002740 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002741 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002742 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002743 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002744 void EmitOMPDistributeLoop(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002745 void EmitOMPDistributeParallelForDirective(
2746 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002747 void EmitOMPDistributeParallelForSimdDirective(
2748 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002749 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002750 void EmitOMPTargetParallelForSimdDirective(
2751 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002752 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002753 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00002754 void
2755 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00002756 void EmitOMPTeamsDistributeParallelForSimdDirective(
2757 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00002758 void EmitOMPTeamsDistributeParallelForDirective(
2759 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00002760 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00002761 void EmitOMPTargetTeamsDistributeDirective(
2762 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00002763 void EmitOMPTargetTeamsDistributeParallelForDirective(
2764 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00002765 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
2766 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00002767 void EmitOMPTargetTeamsDistributeSimdDirective(
2768 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002769
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00002770 /// Emit device code for the target directive.
2771 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
2772 StringRef ParentName,
2773 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00002774 static void
2775 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2776 const OMPTargetParallelDirective &S);
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00002777 static void
2778 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2779 const OMPTargetTeamsDirective &S);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002780 /// \brief Emit inner loop of the worksharing/simd construct.
2781 ///
2782 /// \param S Directive, for which the inner loop must be emitted.
2783 /// \param RequiresCleanup true, if directive has some associated private
2784 /// variables.
2785 /// \param LoopCond Bollean condition for loop continuation.
2786 /// \param IncExpr Increment expression for loop control variable.
2787 /// \param BodyGen Generator for the inner body of the inner loop.
2788 /// \param PostIncGen Genrator for post-increment code (required for ordered
2789 /// loop directvies).
2790 void EmitOMPInnerLoop(
2791 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2792 const Expr *IncExpr,
2793 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2794 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002795
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002796 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002797 /// Emit initial code for loop counters of loop-based directives.
2798 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2799 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002800
Alexander Musmanc6388682014-12-15 07:07:06 +00002801private:
George Burgess IVe3763372016-12-22 02:50:20 +00002802 /// Helpers for blocks
2803 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
2804
Alexander Musmanc6388682014-12-15 07:07:06 +00002805 /// Helpers for the OpenMP loop directives.
Alexey Bataev0f34da12015-07-02 04:17:07 +00002806 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002807 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002808 void EmitOMPSimdFinal(
2809 const OMPLoopDirective &D,
2810 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev38e89532015-04-16 04:54:05 +00002811 /// \brief Emit code for the worksharing loop-based directive.
2812 /// \return true, if this construct has any lastprivate clause, false -
2813 /// otherwise.
2814 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002815 void EmitOMPOuterLoop(bool IsMonotonic, bool DynamicOrOrdered,
2816 const OMPLoopDirective &S, OMPPrivateScope &LoopScope, bool Ordered,
2817 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00002818 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002819 bool IsMonotonic, const OMPLoopDirective &S,
2820 OMPPrivateScope &LoopScope, bool Ordered, Address LB,
2821 Address UB, Address ST, Address IL,
2822 llvm::Value *Chunk);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002823 void EmitOMPDistributeOuterLoop(
2824 OpenMPDistScheduleClauseKind ScheduleKind,
2825 const OMPDistributeDirective &S, OMPPrivateScope &LoopScope,
2826 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002827 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002828 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002829
2830public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002831
Chris Lattner208ae962007-05-30 17:57:17 +00002832 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002833 // LValue Expression Emission
2834 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002835
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002836 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2837 RValue GetUndefRValue(QualType Ty);
2838
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002839 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2840 /// and issue an ErrorUnsupported style diagnostic (using the
2841 /// provided Name).
2842 RValue EmitUnsupportedRValue(const Expr *E,
2843 const char *Name);
2844
Mike Stumpfc496822009-02-08 23:14:22 +00002845 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2846 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002847 LValue EmitUnsupportedLValue(const Expr *E,
2848 const char *Name);
2849
Chris Lattner8394d792007-06-05 20:53:16 +00002850 /// EmitLValue - Emit code to compute a designator that specifies the location
2851 /// of the expression.
2852 ///
2853 /// This can return one of two things: a simple address or a bitfield
2854 /// reference. In either case, the LLVM Value* in the LValue structure is
2855 /// guaranteed to be an LLVM pointer type.
2856 ///
2857 /// If this returns a bitfield reference, nothing about the pointee type of
2858 /// the LLVM value is known: For example, it may not be a pointer to an
2859 /// integer.
2860 ///
2861 /// If this returns a normal address, and if the lvalue's C type is fixed
2862 /// size, this method guarantees that the returned pointer type will point to
2863 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2864 /// variable length type, this is not possible.
2865 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002866 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002867
Richard Smith4d1458e2012-09-08 02:08:36 +00002868 /// \brief Same as EmitLValue but additionally we generate checking code to
2869 /// guard against undefined behavior. This is only suitable when we know
2870 /// that the address will be used to access the object.
2871 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002872
John McCall7f416cc2015-09-08 08:05:57 +00002873 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002874 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002875
John McCalla8ec7eb2013-03-07 21:37:17 +00002876 void EmitAtomicInit(Expr *E, LValue lvalue);
2877
David Majnemera5b195a2015-02-14 01:35:12 +00002878 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00002879
2880 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2881 AggValueSlot Slot = AggValueSlot::ignored());
2882
Nick Lewycky2d84e842013-10-02 02:29:49 +00002883 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002884 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002885 AggValueSlot slot = AggValueSlot::ignored());
2886
2887 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2888
David Majnemera5b195a2015-02-14 01:35:12 +00002889 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2890 bool IsVolatile, bool isInit);
2891
Alexey Bataevb4505a72015-03-30 05:20:59 +00002892 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002893 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00002894 llvm::AtomicOrdering Success =
2895 llvm::AtomicOrdering::SequentiallyConsistent,
2896 llvm::AtomicOrdering Failure =
2897 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00002898 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2899
Alexey Bataevb4505a72015-03-30 05:20:59 +00002900 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002901 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002902 bool IsVolatile);
2903
John McCall3a7f6922010-10-27 20:58:56 +00002904 /// EmitToMemory - Change a scalar value from its value
2905 /// representation to its in-memory representation.
2906 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2907
2908 /// EmitFromMemory - Change a scalar value from its memory
2909 /// representation to its value representation.
2910 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2911
Vedant Kumar5a972652017-02-27 19:46:19 +00002912 /// Check if the scalar \p Value is within the valid range for the given
2913 /// type \p Ty.
2914 ///
2915 /// Returns true if a check is needed (even if the range is unknown).
2916 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
2917 SourceLocation Loc);
2918
Daniel Dunbar1d425462009-02-10 00:57:50 +00002919 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2920 /// care to appropriately convert from the memory representation to
2921 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002922 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002923 SourceLocation Loc,
John McCall7f416cc2015-09-08 08:05:57 +00002924 AlignmentSource AlignSource =
2925 AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002926 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002927 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002928 uint64_t TBAAOffset = 0,
2929 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002930
2931 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2932 /// care to appropriately convert from the memory representation to
2933 /// the LLVM value representation. The l-value must be a simple
2934 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002935 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002936
2937 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2938 /// care to appropriately convert from the memory representation to
2939 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002940 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
2941 bool Volatile, QualType Ty,
2942 AlignmentSource AlignSource = AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002943 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002944 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002945 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002946
2947 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2948 /// care to appropriately convert from the memory representation to
2949 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002950 /// l-value. The isInit flag indicates whether this is an initialization.
2951 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2952 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002953
Chris Lattner8394d792007-06-05 20:53:16 +00002954 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2955 /// this method emits the address of the lvalue, then loads the result as an
2956 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002957 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002958 RValue EmitLoadOfExtVectorElementLValue(LValue V);
Vedant Kumar129edab2017-03-09 16:06:27 +00002959 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
Renato Golin230c5eb2014-05-19 18:15:42 +00002960 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002961
Chris Lattner8394d792007-06-05 20:53:16 +00002962 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2963 /// lvalue, where both are guaranteed to the have the same type, and that type
2964 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002965 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002966 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002967 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002968
Nick Lewycky2d84e842013-10-02 02:29:49 +00002969 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2970 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002971 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002972 /// \param Result [out] - If non-null, this will be set to a Value* for the
2973 /// bit-field contents after the store, appropriate for use as the result of
2974 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002975 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002976 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002977
John McCall4f29b492010-11-16 23:07:28 +00002978 /// Emit an l-value for an assignment (simple or compound) of complex type.
2979 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002980 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002981 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2982 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002983
Chris Lattner57540c52011-04-15 05:22:18 +00002984 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002985 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002986 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002987 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002988 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002989 // Note: only available for agg return types
2990 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002991 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002992 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002993 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002994 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002995 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002996 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2997 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00002998 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
2999 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00003000 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00003001 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00003002 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00003003 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00003004 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00003005 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00003006 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00003007 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00003008 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00003009
John McCall7f416cc2015-09-08 08:05:57 +00003010 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003011
Nick Lewycky2d84e842013-10-02 02:29:49 +00003012 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00003013
John McCall7f416cc2015-09-08 08:05:57 +00003014 Address EmitArrayToPointerDecay(const Expr *Array,
3015 AlignmentSource *AlignSource = nullptr);
3016
John McCall71335052012-03-10 03:05:10 +00003017 class ConstantEmission {
3018 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3019 ConstantEmission(llvm::Constant *C, bool isReference)
3020 : ValueAndIsReference(C, isReference) {}
3021 public:
3022 ConstantEmission() {}
3023 static ConstantEmission forReference(llvm::Constant *C) {
3024 return ConstantEmission(C, true);
3025 }
3026 static ConstantEmission forValue(llvm::Constant *C) {
3027 return ConstantEmission(C, false);
3028 }
3029
Aaron Ballman67347662015-02-15 22:00:28 +00003030 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00003031 return ValueAndIsReference.getOpaqueValue() != nullptr;
3032 }
John McCall71335052012-03-10 03:05:10 +00003033
3034 bool isReference() const { return ValueAndIsReference.getInt(); }
3035 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3036 assert(isReference());
3037 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3038 refExpr->getType());
3039 }
3040
3041 llvm::Constant *getValue() const {
3042 assert(!isReference());
3043 return ValueAndIsReference.getPointer();
3044 }
3045 };
3046
John McCall113bee02012-03-10 09:33:50 +00003047 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00003048
John McCallfe96e0b2011-11-06 09:01:30 +00003049 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3050 AggValueSlot slot = AggValueSlot::ignored());
3051 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3052
Daniel Dunbar722f4242009-04-22 05:08:15 +00003053 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003054 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00003055 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00003056 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003057
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003058 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3059 /// if the Field is a reference, this will return the address of the reference
3060 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003061 LValue EmitLValueForFieldInitialization(LValue Base,
3062 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003063
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003064 LValue EmitLValueForIvar(QualType ObjectTy,
3065 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003066 unsigned CVRQualifiers);
3067
Anders Carlsson3be22e22009-05-30 23:23:33 +00003068 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003069 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00003070 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003071 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003072 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003073
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003074 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003075 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003076 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003077 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003078 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003079 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003080
Chris Lattnerd7f58862007-06-02 05:24:33 +00003081 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003082 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003083 //===--------------------------------------------------------------------===//
3084
Mike Stumpfc496822009-02-08 23:14:22 +00003085 /// EmitCall - Generate a call of the given function, expecting the given
3086 /// result type, and using the given argument list which specifies both the
3087 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003088 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003089 ReturnValueSlot ReturnValue, const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00003090 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003091
John McCallb92ab1a2016-10-26 23:46:34 +00003092 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003093 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00003094 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003095 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003096 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003097 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3098 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003099
Eric Christopherc7e79db2015-11-12 00:44:04 +00003100 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003101
John McCall882987f2013-02-28 19:01:20 +00003102 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3103 const Twine &name = "");
3104 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3105 ArrayRef<llvm::Value*> args,
3106 const Twine &name = "");
3107 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3108 const Twine &name = "");
3109 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3110 ArrayRef<llvm::Value*> args,
3111 const Twine &name = "");
3112
John McCallbd309292010-07-06 01:34:17 +00003113 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003114 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00003115 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00003116 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3117 ArrayRef<llvm::Value*> args,
3118 const Twine &name = "");
3119 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3120 const Twine &name = "");
3121 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3122 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00003123
John McCallb92ab1a2016-10-26 23:46:34 +00003124 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
3125 NestedNameSpecifier *Qual,
3126 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00003127
John McCallb92ab1a2016-10-26 23:46:34 +00003128 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
3129 CXXDtorType Type,
3130 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003131
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003132 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003133 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3134 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003135 ReturnValueSlot ReturnValue, llvm::Value *This,
3136 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003137 QualType ImplicitParamTy, const CallExpr *E,
3138 CallArgList *RtlArgs);
John McCallb92ab1a2016-10-26 23:46:34 +00003139 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3140 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003141 llvm::Value *This, llvm::Value *ImplicitParam,
3142 QualType ImplicitParamTy, const CallExpr *E,
3143 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003144 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3145 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003146 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3147 const CXXMethodDecl *MD,
3148 ReturnValueSlot ReturnValue,
3149 bool HasQualifier,
3150 NestedNameSpecifier *Qualifier,
3151 bool IsArrow, const Expr *Base);
3152 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003153 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3154 llvm::Value *memberPtr,
3155 const MemberPointerType *memberPtrType,
3156 AlignmentSource *AlignSource = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003157 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3158 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003159
Anders Carlsson4034a952009-05-27 04:18:27 +00003160 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003161 const CXXMethodDecl *MD,
3162 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003163 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003164
Peter Collingbournefe883422011-10-06 18:29:37 +00003165 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3166 ReturnValueSlot ReturnValue);
3167
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003168 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3169 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003170
Mike Stump11289f42009-09-09 15:08:12 +00003171 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00003172 unsigned BuiltinID, const CallExpr *E,
3173 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003174
Anders Carlssonbfb36712009-12-24 21:13:40 +00003175 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003176
Mike Stumpfc496822009-02-08 23:14:22 +00003177 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3178 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003179 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3180
Kevin Qin1718af62013-11-14 02:45:18 +00003181 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3182 const llvm::CmpInst::Predicate Fp,
3183 const llvm::CmpInst::Predicate Ip,
3184 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00003185 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00003186
3187 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3188 unsigned LLVMIntrinsic,
3189 unsigned AltLLVMIntrinsic,
3190 const char *NameHint,
3191 unsigned Modifier,
3192 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003193 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00003194 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00003195 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3196 unsigned Modifier, llvm::Type *ArgTy,
3197 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003198 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003199 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003200 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003201 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003202 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003203 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003204 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003205 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3206 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003207 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00003208 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003209
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003210 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003211 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3212 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003213 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003214 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003215 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003216 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3217 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003218
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003219private:
3220 enum class MSVCIntrin;
3221
3222public:
3223 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3224
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003225 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3226
Daniel Dunbar66912a12008-08-20 00:28:19 +00003227 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003228 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003229 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003230 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3231 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3232 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003233 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003234 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003235 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3236 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003237
John McCall31168b02011-06-15 23:02:42 +00003238 /// Retrieves the default cleanup kind for an ARC cleanup.
3239 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3240 CleanupKind getARCCleanupKind() {
3241 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3242 ? NormalAndEHCleanup : NormalCleanup;
3243 }
3244
3245 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003246 void EmitARCInitWeak(Address addr, llvm::Value *value);
3247 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003248 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003249 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3250 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3251 void EmitARCCopyWeak(Address dst, Address src);
3252 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003253 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3254 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003255 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003256 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003257 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003258 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003259 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003260 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003261 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003262 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003263 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003264 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003265 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3266 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3267 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003268 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003269
3270 std::pair<LValue,llvm::Value*>
3271 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3272 std::pair<LValue,llvm::Value*>
3273 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003274 std::pair<LValue,llvm::Value*>
3275 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003276
John McCall248512a2011-10-01 10:32:24 +00003277 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003278 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3279 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3280
John McCallff613032011-10-04 06:23:45 +00003281 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003282 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3283 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003284 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3285 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003286 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003287
Craig Topper00bbdcf2014-06-28 23:22:23 +00003288 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003289
John McCall82fe67b2011-07-09 01:37:26 +00003290 static Destroyer destroyARCStrongImprecise;
3291 static Destroyer destroyARCStrongPrecise;
3292 static Destroyer destroyARCWeak;
3293
John McCall31168b02011-06-15 23:02:42 +00003294 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3295 llvm::Value *EmitObjCAutoreleasePoolPush();
3296 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3297 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3298 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3299
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003300 /// \brief Emits a reference binding to the passed in expression.
3301 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003302
Chris Lattner6278e6a2007-08-11 00:04:45 +00003303 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003304 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003305 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003306
3307 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003308
3309 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3310 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003311 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003312
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003313 /// Emit a conversion from the specified type to the specified destination
3314 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003315 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003316 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003317
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003318 /// Emit a conversion from the specified complex type to the specified
3319 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003320 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003321 QualType DstTy,
3322 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003323
John McCall7a626f62010-09-15 10:14:12 +00003324 /// EmitAggExpr - Emit the computation of the specified expression
3325 /// of aggregate type. The result is computed into the given slot,
3326 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003327 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003328
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003329 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3330 /// aggregate type into a temporary LValue.
3331 LValue EmitAggExprToLValue(const Expr *E);
3332
John McCall1bd25562011-06-24 23:21:27 +00003333 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3334 /// make sure it survives garbage collection until this point.
3335 void EmitExtendGCLifetime(llvm::Value *object);
3336
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003337 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003338 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003339 ComplexPairTy EmitComplexExpr(const Expr *E,
3340 bool IgnoreReal = false,
3341 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003342
John McCall47fb9502013-03-07 21:37:08 +00003343 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3344 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003345 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003346
John McCall47fb9502013-03-07 21:37:08 +00003347 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003348 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003349
3350 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003351 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003352
John McCall7f416cc2015-09-08 08:05:57 +00003353 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3354 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3355
Chandler Carruth84537952012-03-30 19:44:53 +00003356 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3357 /// global variable that has already been created for it. If the initializer
3358 /// has a different type than GV does, this may free GV and return a different
3359 /// one. Otherwise it just returns GV.
3360 llvm::GlobalVariable *
3361 AddInitializerToStaticVarDecl(const VarDecl &D,
3362 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003363
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003364
Anders Carlssonf40886a2009-08-08 21:45:14 +00003365 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3366 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003367 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3368 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003369
David Majnemerb3341ea2014-10-05 05:05:40 +00003370 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3371 llvm::Constant *Addr);
3372
John McCallc84ed6a2012-05-01 06:13:13 +00003373 /// Call atexit() with a function that passes the given argument to
3374 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003375 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3376 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003377
John McCallcdf7ef52010-11-06 09:44:32 +00003378 /// Emit code in this function to perform a guarded variable
3379 /// initialization. Guarded initializations are used when it's not
3380 /// possible to prove that an initialization will be done exactly
3381 /// once, e.g. with a static local variable or a static data member
3382 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003383 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003384 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003385
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003386 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3387 /// variables.
3388 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003389 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003390 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003391
John McCallee08c532012-04-06 18:21:03 +00003392 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003393 /// variables.
John McCallee08c532012-04-06 18:21:03 +00003394 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
3395 const std::vector<std::pair<llvm::WeakVH,
3396 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003397
John McCalla738c252011-03-09 04:27:21 +00003398 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3399 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003400 llvm::GlobalVariable *Addr,
3401 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003402
John McCall7a626f62010-09-15 10:14:12 +00003403 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00003404
John McCall7f416cc2015-09-08 08:05:57 +00003405 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003406
John McCall08ef4662011-11-10 08:15:53 +00003407 void enterFullExpression(const ExprWithCleanups *E) {
3408 if (E->getNumObjects() == 0) return;
3409 enterNonTrivialFullExpression(E);
3410 }
3411 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003412
Richard Smithea852322013-05-07 21:53:22 +00003413 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003414
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003415 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3416
Tim Northovercc2a6e02015-11-09 19:56:35 +00003417 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003418
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003419 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003420 // Annotations Emission
3421 //===--------------------------------------------------------------------===//
3422
3423 /// Emit an annotation call (intrinsic or builtin).
3424 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3425 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003426 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003427 SourceLocation Location);
3428
3429 /// Emit local annotations for the local variable V, declared by D.
3430 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3431
3432 /// Emit field annotations for the given field & value. Returns the
3433 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003434 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003435
3436 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003437 // Internal Helpers
3438 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003439
Chris Lattner5b1964b2008-11-11 07:41:27 +00003440 /// ContainsLabel - Return true if the statement contains a label in it. If
3441 /// this statement is not executed normally, it not containing a label means
3442 /// that we can just remove the code.
3443 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003444
Chris Lattner29911cc2011-02-28 00:18:40 +00003445 /// containsBreak - Return true if the statement contains a break out of it.
3446 /// If the statement (recursively) contains a switch or loop with a break
3447 /// inside of it, this is fine.
3448 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003449
3450 /// Determine if the given statement might introduce a declaration into the
3451 /// current scope, by being a (possibly-labelled) DeclStmt.
3452 static bool mightAddDeclToScope(const Stmt *S);
Chris Lattner29911cc2011-02-28 00:18:40 +00003453
Daniel Dunbar682712c2008-11-12 10:12:14 +00003454 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003455 /// to a constant, or if it does but contains a label, return false. If it
3456 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003457 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3458 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003459
Chris Lattner29911cc2011-02-28 00:18:40 +00003460 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3461 /// to a constant, or if it does but contains a label, return false. If it
3462 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003463 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3464 bool AllowLabels = false);
3465
Chris Lattnercd439292008-11-12 08:04:58 +00003466 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3467 /// if statement) to the specified blocks. Based on the condition, this might
3468 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003469 /// TrueCount should be the number of times we expect the condition to
3470 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003471 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003472 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003473
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003474 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
3475 /// nonnull, if \p LHS is marked _Nonnull.
3476 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
3477
Richard Smithe30752c2012-10-09 19:52:38 +00003478 /// \brief Emit a description of a type in a format suitable for passing to
3479 /// a runtime sanitizer handler.
3480 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3481
3482 /// \brief Convert a value into a format suitable for passing to a runtime
3483 /// sanitizer handler.
3484 llvm::Value *EmitCheckValue(llvm::Value *V);
3485
3486 /// \brief Emit a description of a source location in a format suitable for
3487 /// passing to a runtime sanitizer handler.
3488 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3489
Richard Smithde670682012-11-01 22:15:34 +00003490 /// \brief Create a basic block that will call a handler function in a
3491 /// sanitizer runtime with the provided arguments, and create a conditional
3492 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003493 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00003494 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003495 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003496
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003497 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3498 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003499 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3500 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3501 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003502
Richard Smithde670682012-11-01 22:15:34 +00003503 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3504 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003505 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003506
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003507 /// \brief Emit a call to trap or debugtrap and attach function attribute
3508 /// "trap-func-name" if specified.
3509 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3510
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003511 /// \brief Emit a cross-DSO CFI failure handling function.
3512 void EmitCfiCheckFail();
3513
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003514 /// \brief Create a check for a function parameter that may potentially be
3515 /// declared as non-null.
3516 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003517 AbstractCallee AC, unsigned ParmNum);
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003518
Anders Carlsson093bdff2010-03-30 03:27:09 +00003519 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003520 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003521
John McCall23f66262010-05-26 22:34:26 +00003522 /// EmitDelegateCallArg - We are performing a delegate call; that
3523 /// is, the current function is delegating to another one. Produce
3524 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003525 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3526 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003527
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003528 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3529 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003530 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003531
Chris Lattnercd439292008-11-12 08:04:58 +00003532private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003533 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003534 void EmitReturnOfRValue(RValue RV, QualType Ty);
3535
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003536 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3537
3538 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3539 DeferredReplacements;
3540
John McCall7f416cc2015-09-08 08:05:57 +00003541 /// Set the address of a local variable.
3542 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3543 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3544 LocalDeclMap.insert({VD, Addr});
3545 }
3546
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003547 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3548 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3549 ///
3550 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003551 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003552 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003553
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003554 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3555 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3556 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3557 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3558 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3559 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003560
Chad Rosier59df25b2012-08-23 20:00:18 +00003561 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003562 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003563
Chad Rosier59df25b2012-08-23 20:00:18 +00003564 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003565 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003566 std::string &ConstraintStr,
3567 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003568
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003569 /// \brief Attempts to statically evaluate the object size of E. If that
3570 /// fails, emits code to figure the size of E out for us. This is
3571 /// pass_object_size aware.
George Burgess IV0d6592a2017-02-23 05:59:56 +00003572 ///
3573 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003574 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003575 llvm::IntegerType *ResType,
3576 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003577
3578 /// \brief Emits the size of E, as required by __builtin_object_size. This
3579 /// function is aware of pass_object_size parameters, and will act accordingly
3580 /// if E is a parameter with the pass_object_size attribute.
3581 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003582 llvm::IntegerType *ResType,
3583 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003584
Reid Kleckner89077a12013-12-17 19:46:40 +00003585public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003586#ifndef NDEBUG
3587 // Determine whether the given argument is an Objective-C method
3588 // that may have type parameters in its signature.
3589 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3590 const DeclContext *dc = method->getDeclContext();
3591 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3592 return classDecl->getTypeParamListAsWritten();
3593 }
3594
3595 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3596 return catDecl->getTypeParamList();
3597 }
3598
3599 return false;
3600 }
3601
3602 template<typename T>
3603 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3604#endif
3605
Richard Smitha560ccf2016-09-29 21:30:12 +00003606 enum class EvaluationOrder {
3607 ///! No language constraints on evaluation order.
3608 Default,
3609 ///! Language semantics require left-to-right evaluation.
3610 ForceLeftToRight,
3611 ///! Language semantics require right-to-left evaluation.
3612 ForceRightToLeft
3613 };
3614
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003615 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003616 template <typename T>
3617 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003618 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003619 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003620 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003621 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003622 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003623 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003624
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003625 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3626 "Can't skip parameters if type info is not provided");
3627 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003628#ifndef NDEBUG
3629 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3630#endif
3631
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003632 // First, use the argument types that the type info knows about
3633 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3634 E = CallArgTypeInfo->param_type_end();
3635 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003636 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003637 assert((isGenericMethod ||
3638 ((*I)->isVariablyModifiedType() ||
3639 (*I).getNonReferenceType()->isObjCRetainableType() ||
3640 getContext()
3641 .getCanonicalType((*I).getNonReferenceType())
3642 .getTypePtr() ==
3643 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003644 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003645 .getTypePtr())) &&
3646 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003647 ArgTypes.push_back(*I);
3648 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003649 }
Mike Stump11289f42009-09-09 15:08:12 +00003650
Reid Kleckner739756c2013-12-04 19:23:12 +00003651 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003652 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003653 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3654 CallArgTypeInfo->isVariadic()) &&
3655 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003656
Anders Carlsson603d6af2009-04-18 20:20:22 +00003657 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003658 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00003659 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003660
Vedant Kumared00ea02017-03-06 05:28:22 +00003661 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003662 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003663
Reid Kleckner739756c2013-12-04 19:23:12 +00003664 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003665 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003666 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003667 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003668 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00003669
John McCall7f416cc2015-09-08 08:05:57 +00003670 /// EmitPointerWithAlignment - Given an expression with a pointer
3671 /// type, emit the value and compute our best estimate of the
3672 /// alignment of the pointee.
3673 ///
3674 /// Note that this function will conservatively fall back on the type
3675 /// when it doesn't
3676 ///
3677 /// \param Source - If non-null, this will be initialized with
3678 /// information about the source of the alignment. Note that this
3679 /// function will conservatively fall back on the type when it
3680 /// doesn't recognize the expression, which means that sometimes
3681 ///
3682 /// a worst-case One
3683 /// reasonable way to use this information is when there's a
3684 /// language guarantee that the pointer must be aligned to some
3685 /// stricter value, and we're simply trying to ensure that
3686 /// sufficiently obvious uses of under-aligned objects don't get
3687 /// miscompiled; for example, a placement new into the address of
3688 /// a local variable. In such a case, it's quite reasonable to
3689 /// just ignore the returned alignment when it isn't from an
3690 /// explicit source.
3691 Address EmitPointerWithAlignment(const Expr *Addr,
3692 AlignmentSource *Source = nullptr);
3693
Peter Collingbournedc134532016-01-16 00:31:22 +00003694 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3695
Reid Kleckner89077a12013-12-17 19:46:40 +00003696private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003697 QualType getVarArgType(const Expr *Arg);
3698
John McCalld4f4b7f2010-03-03 04:15:11 +00003699 const TargetCodeGenInfo &getTargetHooks() const {
3700 return CGM.getTargetCodeGenInfo();
3701 }
John McCall09ae0322010-07-06 23:57:41 +00003702
3703 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003704
John McCall7f416cc2015-09-08 08:05:57 +00003705 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3706 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003707
3708 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003709
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003710 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003711};
Mike Stump11289f42009-09-09 15:08:12 +00003712
John McCallce1de612011-01-26 04:00:11 +00003713/// Helper class with most of the code for saving a value for a
3714/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003715struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003716 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3717
3718 /// Answer whether the given value needs extra work to be saved.
3719 static bool needsSaving(llvm::Value *value) {
3720 // If it's not an instruction, we don't need to save.
3721 if (!isa<llvm::Instruction>(value)) return false;
3722
3723 // If it's an instruction in the entry block, we don't need to save.
3724 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3725 return (block != &block->getParent()->getEntryBlock());
3726 }
3727
3728 /// Try to save the given value.
3729 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3730 if (!needsSaving(value)) return saved_type(value, false);
3731
John McCall7f416cc2015-09-08 08:05:57 +00003732 // Otherwise, we need an alloca.
3733 auto align = CharUnits::fromQuantity(
3734 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3735 Address alloca =
3736 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003737 CGF.Builder.CreateStore(value, alloca);
3738
John McCall7f416cc2015-09-08 08:05:57 +00003739 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003740 }
3741
3742 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003743 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003744 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003745
3746 // Otherwise, it should be an alloca instruction, as set up in save().
3747 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3748 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003749 }
3750};
3751
John McCallcb5f77f2011-01-28 10:53:53 +00003752/// A partial specialization of DominatingValue for llvm::Values that
3753/// might be llvm::Instructions.
3754template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3755 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003756 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003757 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3758 }
3759};
3760
John McCall7f416cc2015-09-08 08:05:57 +00003761/// A specialization of DominatingValue for Address.
3762template <> struct DominatingValue<Address> {
3763 typedef Address type;
3764
3765 struct saved_type {
3766 DominatingLLVMValue::saved_type SavedValue;
3767 CharUnits Alignment;
3768 };
3769
3770 static bool needsSaving(type value) {
3771 return DominatingLLVMValue::needsSaving(value.getPointer());
3772 }
3773 static saved_type save(CodeGenFunction &CGF, type value) {
3774 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3775 value.getAlignment() };
3776 }
3777 static type restore(CodeGenFunction &CGF, saved_type value) {
3778 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3779 value.Alignment);
3780 }
3781};
3782
John McCallcb5f77f2011-01-28 10:53:53 +00003783/// A specialization of DominatingValue for RValue.
3784template <> struct DominatingValue<RValue> {
3785 typedef RValue type;
3786 class saved_type {
3787 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3788 AggregateAddress, ComplexAddress };
3789
3790 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003791 unsigned K : 3;
3792 unsigned Align : 29;
3793 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3794 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003795
3796 public:
3797 static bool needsSaving(RValue value);
3798 static saved_type save(CodeGenFunction &CGF, RValue value);
3799 RValue restore(CodeGenFunction &CGF);
3800
John McCall7f416cc2015-09-08 08:05:57 +00003801 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003802 };
3803
3804 static bool needsSaving(type value) {
3805 return saved_type::needsSaving(value);
3806 }
3807 static saved_type save(CodeGenFunction &CGF, type value) {
3808 return saved_type::save(CGF, value);
3809 }
3810 static type restore(CodeGenFunction &CGF, saved_type value) {
3811 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003812 }
3813};
3814
Chris Lattnerbed31442007-05-28 01:07:47 +00003815} // end namespace CodeGen
3816} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003817
Chris Lattnerbed31442007-05-28 01:07:47 +00003818#endif