blob: b830df73ca7d35588581d3ca7193c08cc05178a1 [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
Alexey Samsonova0416102014-11-11 01:26:14 +0000308 /// \brief Sanitizers enabled for this function.
309 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000310
Alexey Samsonov24cad992014-07-17 18:46:27 +0000311 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
312 bool IsSanitizerScope;
313
314 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
315 class SanitizerScope {
316 CodeGenFunction *CGF;
317 public:
318 SanitizerScope(CodeGenFunction *CGF);
319 ~SanitizerScope();
320 };
321
Reid Kleckner19819442014-07-25 21:39:46 +0000322 /// In C++, whether we are code generating a thunk. This controls whether we
323 /// should emit cleanups.
324 bool CurFuncIsThunk;
325
John McCall31168b02011-06-15 23:02:42 +0000326 /// In ARC, whether we should autorelease the return value.
327 bool AutoreleaseResult;
328
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000329 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
330 /// potentially set the return value.
331 bool SawAsmBlock;
332
David Majnemer25eb1652016-03-01 19:42:53 +0000333 const FunctionDecl *CurSEHParent = nullptr;
334
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000335 /// True if the current function is an outlined SEH helper. This can be a
336 /// finally block or filter expression.
337 bool IsOutlinedSEHHelper;
338
John McCallad7c5c12011-02-08 08:22:06 +0000339 const CodeGen::CGBlockInfo *BlockInfo;
340 llvm::Value *BlockPointer;
341
Eli Friedman9fbeba02012-02-11 02:57:39 +0000342 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
343 FieldDecl *LambdaThisCaptureField;
344
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000345 /// \brief A mapping from NRVO variables to the flags used to indicate
346 /// when the NRVO has been applied to this variable.
347 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000348
John McCallbd309292010-07-06 01:34:17 +0000349 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000350 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000351 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000352
David Majnemer4e52d6f2015-12-12 05:39:21 +0000353 llvm::Instruction *CurrentFuncletPad = nullptr;
354
Tim Shen421119f2016-07-01 21:08:47 +0000355 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
356 llvm::Value *Addr;
357 llvm::Value *Size;
358
359 public:
360 CallLifetimeEnd(Address addr, llvm::Value *size)
361 : Addr(addr.getPointer()), Size(size) {}
362
363 void Emit(CodeGenFunction &CGF, Flags flags) override {
364 CGF.EmitLifetimeEnd(Size, Addr);
365 }
366 };
367
Richard Smith736a9472013-06-12 20:42:33 +0000368 /// Header for data within LifetimeExtendedCleanupStack.
369 struct LifetimeExtendedCleanupHeader {
370 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000371 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000372 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000373 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000374
Justin Bognerbdff2192015-07-01 00:59:27 +0000375 size_t getSize() const { return Size; }
376 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000377 };
John McCallbd309292010-07-06 01:34:17 +0000378
John McCallad5d61e2010-07-23 21:56:41 +0000379 /// i32s containing the indexes of the cleanup destinations.
380 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000381
382 unsigned NextCleanupDestIndex;
383
John McCall08ef4662011-11-10 08:15:53 +0000384 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
385 CGBlockInfo *FirstBlockInfo;
386
John McCall8e4c74b2011-08-11 02:22:43 +0000387 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
388 llvm::BasicBlock *EHResumeBlock;
389
Bill Wendlingf0724e82011-09-19 20:31:14 +0000390 /// The exception slot. All landing pads write the current exception pointer
391 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000392 llvm::Value *ExceptionSlot;
393
Bill Wendlingf0724e82011-09-19 20:31:14 +0000394 /// The selector slot. Under the MandatoryCleanup model, all landing pads
395 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000396 llvm::AllocaInst *EHSelectorSlot;
397
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000398 /// A stack of exception code slots. Entering an __except block pushes a slot
399 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
400 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000401 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000402
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000403 /// Value returned by __exception_info intrinsic.
404 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000405
John McCallbd309292010-07-06 01:34:17 +0000406 /// Emits a landing pad for the current EH stack.
407 llvm::BasicBlock *EmitLandingPad();
408
409 llvm::BasicBlock *getInvokeDestImpl();
410
John McCallce1de612011-01-26 04:00:11 +0000411 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000412 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
413 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000414 }
415
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000416public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000417 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
418 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000419 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000420
John McCall6b0feb72011-06-22 02:32:12 +0000421 /// A class controlling the emission of a finally block.
422 class FinallyInfo {
423 /// Where the catchall's edge through the cleanup should go.
424 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000425
John McCall6b0feb72011-06-22 02:32:12 +0000426 /// A function to call to enter the catch.
427 llvm::Constant *BeginCatchFn;
428
429 /// An i1 variable indicating whether or not the @finally is
430 /// running for an exception.
431 llvm::AllocaInst *ForEHVar;
432
433 /// An i8* variable into which the exception pointer to rethrow
434 /// has been saved.
435 llvm::AllocaInst *SavedExnVar;
436
437 public:
438 void enter(CodeGenFunction &CGF, const Stmt *Finally,
439 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
440 llvm::Constant *rethrowFn);
441 void exit(CodeGenFunction &CGF);
442 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000443
Reid Kleckner11c033e2015-02-12 23:40:45 +0000444 /// Returns true inside SEH __try blocks.
445 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
446
Reid Klecknera002bd52015-10-28 23:06:42 +0000447 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000448 bool isCleanupPadScope() const {
449 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
450 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000451
John McCallce1de612011-01-26 04:00:11 +0000452 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
453 /// current full-expression. Safe against the possibility that
454 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000455 template <class T, class... As>
456 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000457 // If we're not in a conditional branch, or if none of the
458 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000459 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000460 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000461
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000462 // Stash values in a tuple so we can guarantee the order of saves.
463 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
464 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000465
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000466 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000467 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000468 initFullExprCleanup();
469 }
470
Richard Smith736a9472013-06-12 20:42:33 +0000471 /// \brief Queue a cleanup to be pushed after finishing the current
472 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000473 template <class T, class... As>
474 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000475 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
476
477 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
478
479 size_t OldSize = LifetimeExtendedCleanupStack.size();
480 LifetimeExtendedCleanupStack.resize(
481 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
482
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000483 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000484 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000485 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
486 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000487 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000488 }
489
John McCallf4beacd2011-11-10 10:43:54 +0000490 /// Set up the last cleaup that was pushed as a conditional
491 /// full-expression cleanup.
492 void initFullExprCleanup();
493
John McCallbd309292010-07-06 01:34:17 +0000494 /// PushDestructorCleanup - Push a cleanup to call the
495 /// complete-object destructor of an object of the given type at the
496 /// given address. Does nothing if T is not a C++ class type with a
497 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000498 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000499
John McCall8680f872010-07-21 06:29:51 +0000500 /// PushDestructorCleanup - Push a cleanup to call the
501 /// complete-object variant of the given destructor on the object at
502 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000503 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000504
John McCallbd309292010-07-06 01:34:17 +0000505 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
506 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000507 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000508
John McCall824c2f52010-09-14 07:57:04 +0000509 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
510 /// The block cannot be reactivated. Pops it if it's the top of the
511 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000512 ///
513 /// \param DominatingIP - An instruction which is known to
514 /// dominate the current IP (if set) and which lies along
515 /// all paths of execution between the current IP and the
516 /// the point at which the cleanup comes into scope.
517 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
518 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000519
520 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
521 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000522 ///
523 /// \param DominatingIP - An instruction which is known to
524 /// dominate the current IP (if set) and which lies along
525 /// all paths of execution between the current IP and the
526 /// the point at which the cleanup comes into scope.
527 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
528 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000529
John McCallbd309292010-07-06 01:34:17 +0000530 /// \brief Enters a new scope for capturing cleanups, all of which
531 /// will be executed once the scope is exited.
532 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000533 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000534 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000535 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000536 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000537 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000538 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000539
Aaron Ballmanabc18922015-02-15 22:54:08 +0000540 RunCleanupsScope(const RunCleanupsScope &) = delete;
541 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000542
Eric Christophera9d34972011-10-19 00:43:52 +0000543 protected:
544 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000545
Douglas Gregor965f4502009-11-24 16:43:22 +0000546 public:
547 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000548 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000549 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000550 {
John McCallbd309292010-07-06 01:34:17 +0000551 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000552 LifetimeExtendedCleanupStackSize =
553 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000554 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000555 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000556 }
557
558 /// \brief Exit this cleanup scope, emitting any accumulated
559 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000560 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000561 if (PerformCleanup) {
562 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000563 CGF.PopCleanupBlocks(CleanupStackDepth,
564 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000565 }
566 }
567
568 /// \brief Determine whether this scope requires any cleanups.
569 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000570 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000571 }
572
573 /// \brief Force the emission of cleanups now, instead of waiting
574 /// until this object is destroyed.
575 void ForceCleanup() {
576 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000577 CGF.DidCallStackSave = OldDidCallStackSave;
Richard Smith736a9472013-06-12 20:42:33 +0000578 CGF.PopCleanupBlocks(CleanupStackDepth,
579 LifetimeExtendedCleanupStackSize);
Douglas Gregor680f8612009-11-24 21:15:44 +0000580 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000581 }
582 };
583
David Blaikie93be0b22014-08-22 21:37:04 +0000584 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000585 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000586 SmallVector<const LabelDecl*, 4> Labels;
587 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000588
Aaron Ballmanabc18922015-02-15 22:54:08 +0000589 LexicalScope(const LexicalScope &) = delete;
590 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000591
592 public:
593 /// \brief Enter a new cleanup scope.
594 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000595 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
596 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000597 if (CGDebugInfo *DI = CGF.getDebugInfo())
598 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
599 }
600
Nadav Rotem1da30942013-03-23 06:43:35 +0000601 void addLabel(const LabelDecl *label) {
602 assert(PerformCleanup && "adding label to dead scope?");
603 Labels.push_back(label);
604 }
605
Eric Christophera9d34972011-10-19 00:43:52 +0000606 /// \brief Exit this cleanup scope, emitting any accumulated
607 /// cleanups.
608 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000609 if (CGDebugInfo *DI = CGF.getDebugInfo())
610 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
611
Nadav Rotem1da30942013-03-23 06:43:35 +0000612 // If we should perform a cleanup, force them now. Note that
613 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000614 if (PerformCleanup) {
615 ApplyDebugLocation DL(CGF, Range.getEnd());
616 ForceCleanup();
617 }
Eric Christophera9d34972011-10-19 00:43:52 +0000618 }
619
620 /// \brief Force the emission of cleanups now, instead of waiting
621 /// until this object is destroyed.
622 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000623 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000624 RunCleanupsScope::ForceCleanup();
625
Nadav Rotem1da30942013-03-23 06:43:35 +0000626 if (!Labels.empty())
627 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000628 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000629
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000630 bool hasLabels() const {
631 return !Labels.empty();
632 }
633
Nadav Rotem1da30942013-03-23 06:43:35 +0000634 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000635 };
636
John McCall7f416cc2015-09-08 08:05:57 +0000637 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
638
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000639 /// \brief The scope used to remap some variables as private in the OpenMP
640 /// loop body (or other captured region emitted without outlining), and to
641 /// restore old vars back on exit.
642 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000643 DeclMapTy SavedLocals;
644 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000645
646 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000647 OMPPrivateScope(const OMPPrivateScope &) = delete;
648 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000649
650 public:
651 /// \brief Enter a new OpenMP private scope.
652 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
653
654 /// \brief Registers \a LocalVD variable as a private and apply \a
655 /// PrivateGen function for it to generate corresponding private variable.
656 /// \a PrivateGen returns an address of the generated private variable.
657 /// \return true if the variable is registered as private, false if it has
658 /// been privatized already.
659 bool
660 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000661 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000662 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000663
664 // Only save it once.
665 if (SavedLocals.count(LocalVD)) return false;
666
667 // Copy the existing local entry to SavedLocals.
668 auto it = CGF.LocalDeclMap.find(LocalVD);
669 if (it != CGF.LocalDeclMap.end()) {
670 SavedLocals.insert({LocalVD, it->second});
671 } else {
672 SavedLocals.insert({LocalVD, Address::invalid()});
673 }
674
675 // Generate the private entry.
676 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000677 QualType VarTy = LocalVD->getType();
678 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000679 Address Temp = CGF.CreateMemTemp(VarTy);
680 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
681 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000682 }
John McCall7f416cc2015-09-08 08:05:57 +0000683 SavedPrivates.insert({LocalVD, Addr});
684
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000685 return true;
686 }
687
688 /// \brief Privatizes local variables previously registered as private.
689 /// Registration is separate from the actual privatization to allow
690 /// initializers use values of the original variables, not the private one.
691 /// This is important, for example, if the private variable is a class
692 /// variable initialized by a constructor that references other private
693 /// variables. But at initialization original variables must be used, not
694 /// private copies.
695 /// \return true if at least one variable was privatized, false otherwise.
696 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000697 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000698 SavedPrivates.clear();
699 return !SavedLocals.empty();
700 }
701
702 void ForceCleanup() {
703 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000704 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000705 SavedLocals.clear();
706 }
707
708 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000709 ~OMPPrivateScope() {
710 if (PerformCleanup)
711 ForceCleanup();
712 }
John McCall7f416cc2015-09-08 08:05:57 +0000713
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000714 /// Checks if the global variable is captured in current function.
715 bool isGlobalVarCaptured(const VarDecl *VD) const {
716 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
717 }
718
John McCall7f416cc2015-09-08 08:05:57 +0000719 private:
720 /// Copy all the entries in the source map over the corresponding
721 /// entries in the destination, which must exist.
722 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
723 for (auto &pair : src) {
724 if (!pair.second.isValid()) {
725 dest.erase(pair.first);
726 continue;
727 }
728
729 auto it = dest.find(pair.first);
730 if (it != dest.end()) {
731 it->second = pair.second;
732 } else {
733 dest.insert(pair);
734 }
735 }
736 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000737 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000738
Richard Smith736a9472013-06-12 20:42:33 +0000739 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
740 /// that have been added.
Adrian Prantldc237b52013-05-16 00:41:26 +0000741 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000742
Richard Smith736a9472013-06-12 20:42:33 +0000743 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
744 /// that have been added, then adds all lifetime-extended cleanups from
745 /// the given position to the stack.
746 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
747 size_t OldLifetimeExtendedStackSize);
748
John McCallad5d61e2010-07-23 21:56:41 +0000749 void ResolveBranchFixups(llvm::BasicBlock *Target);
750
John McCallbd309292010-07-06 01:34:17 +0000751 /// The given basic block lies in the current EH scope, but may be a
752 /// target of a potentially scope-crossing jump; get a stable handle
753 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000754 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000755 return JumpDest(Target,
756 EHStack.getInnermostNormalCleanup(),
757 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000758 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000759
John McCallbd309292010-07-06 01:34:17 +0000760 /// The given basic block lies in the current EH scope, but may be a
761 /// target of a potentially scope-crossing jump; get a stable handle
762 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000763 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000764 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000765 }
766
767 /// EmitBranchThroughCleanup - Emit a branch from the current insert
768 /// block through the normal cleanup handling code (if any) and then
769 /// on to \arg Dest.
770 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000771
Justin Bognere25ffdf2014-01-21 00:35:11 +0000772 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
773 /// specified destination obviously has no cleanups to run. 'false' is always
774 /// a conservatively correct answer for this method.
775 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
776
John McCall8e4c74b2011-08-11 02:22:43 +0000777 /// popCatchScope - Pops the catch scope at the top of the EHScope
778 /// stack, emitting any required code (other than the catch handlers
779 /// themselves).
780 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000781
David Chisnall9a837be2012-11-07 16:50:40 +0000782 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000783 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000784 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000785
John McCallce1de612011-01-26 04:00:11 +0000786 /// An object to manage conditionally-evaluated expressions.
787 class ConditionalEvaluation {
788 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000789
John McCallce1de612011-01-26 04:00:11 +0000790 public:
791 ConditionalEvaluation(CodeGenFunction &CGF)
792 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000793
John McCallce1de612011-01-26 04:00:11 +0000794 void begin(CodeGenFunction &CGF) {
795 assert(CGF.OutermostConditional != this);
796 if (!CGF.OutermostConditional)
797 CGF.OutermostConditional = this;
798 }
799
800 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000801 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000802 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000803 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000804 }
805
806 /// Returns a block which will be executed prior to each
807 /// evaluation of the conditional code.
808 llvm::BasicBlock *getStartingBlock() const {
809 return StartBB;
810 }
811 };
Mike Stump11289f42009-09-09 15:08:12 +0000812
John McCall7f9c92a2010-09-17 00:50:28 +0000813 /// isInConditionalBranch - Return true if we're currently emitting
814 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000815 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000816
John McCall7f416cc2015-09-08 08:05:57 +0000817 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000818 assert(isInConditionalBranch());
819 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000820 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
821 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000822 }
823
John McCallce1de612011-01-26 04:00:11 +0000824 /// An RAII object to record that we're evaluating a statement
825 /// expression.
826 class StmtExprEvaluation {
827 CodeGenFunction &CGF;
828
829 /// We have to save the outermost conditional: cleanups in a
830 /// statement expression aren't conditional just because the
831 /// StmtExpr is.
832 ConditionalEvaluation *SavedOutermostConditional;
833
834 public:
835 StmtExprEvaluation(CodeGenFunction &CGF)
836 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000837 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000838 }
839
840 ~StmtExprEvaluation() {
841 CGF.OutermostConditional = SavedOutermostConditional;
842 CGF.EnsureInsertPoint();
843 }
844 };
John McCall1bf58462011-02-16 08:02:54 +0000845
John McCallc07a0c72011-02-17 10:25:35 +0000846 /// An object which temporarily prevents a value from being
847 /// destroyed by aggressive peephole optimizations that assume that
848 /// all uses of a value have been realized in the IR.
849 class PeepholeProtection {
850 llvm::Instruction *Inst;
851 friend class CodeGenFunction;
852
853 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000854 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000855 };
John McCallc07a0c72011-02-17 10:25:35 +0000856
John McCallfe96e0b2011-11-06 09:01:30 +0000857 /// A non-RAII class containing all the information about a bound
858 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
859 /// this which makes individual mappings very simple; using this
860 /// class directly is useful when you have a variable number of
861 /// opaque values or don't want the RAII functionality for some
862 /// reason.
863 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000864 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000865 bool BoundLValue;
866 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000867
John McCallfe96e0b2011-11-06 09:01:30 +0000868 OpaqueValueMappingData(const OpaqueValueExpr *ov,
869 bool boundLValue)
870 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000871 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000872 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000873
John McCallc07a0c72011-02-17 10:25:35 +0000874 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000875 // gl-values should be bound as l-values for obvious reasons.
876 // Records should be bound as l-values because IR generation
877 // always keeps them in memory. Expressions of function type
878 // act exactly like l-values but are formally required to be
879 // r-values in C.
880 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000881 expr->getType()->isFunctionType() ||
882 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000883 }
884
John McCallfe96e0b2011-11-06 09:01:30 +0000885 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
886 const OpaqueValueExpr *ov,
887 const Expr *e) {
888 if (shouldBindAsLValue(ov))
889 return bind(CGF, ov, CGF.EmitLValue(e));
890 return bind(CGF, ov, CGF.EmitAnyExpr(e));
891 }
892
893 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
894 const OpaqueValueExpr *ov,
895 const LValue &lv) {
896 assert(shouldBindAsLValue(ov));
897 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
898 return OpaqueValueMappingData(ov, true);
899 }
900
901 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
902 const OpaqueValueExpr *ov,
903 const RValue &rv) {
904 assert(!shouldBindAsLValue(ov));
905 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
906
907 OpaqueValueMappingData data(ov, false);
908
909 // Work around an extremely aggressive peephole optimization in
910 // EmitScalarConversion which assumes that all other uses of a
911 // value are extant.
912 data.Protection = CGF.protectFromPeepholes(rv);
913
914 return data;
915 }
916
Craig Topper8a13c412014-05-21 05:09:00 +0000917 bool isValid() const { return OpaqueValue != nullptr; }
918 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000919
920 void unbind(CodeGenFunction &CGF) {
921 assert(OpaqueValue && "no data to unbind!");
922
923 if (BoundLValue) {
924 CGF.OpaqueLValues.erase(OpaqueValue);
925 } else {
926 CGF.OpaqueRValues.erase(OpaqueValue);
927 CGF.unprotectFromPeepholes(Protection);
928 }
929 }
930 };
931
932 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
933 class OpaqueValueMapping {
934 CodeGenFunction &CGF;
935 OpaqueValueMappingData Data;
936
937 public:
938 static bool shouldBindAsLValue(const Expr *expr) {
939 return OpaqueValueMappingData::shouldBindAsLValue(expr);
940 }
941
John McCallc07a0c72011-02-17 10:25:35 +0000942 /// Build the opaque value mapping for the given conditional
943 /// operator if it's the GNU ?: extension. This is a common
944 /// enough pattern that the convenience operator is really
945 /// helpful.
946 ///
947 OpaqueValueMapping(CodeGenFunction &CGF,
948 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +0000949 if (isa<ConditionalOperator>(op))
950 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +0000951 return;
John McCallc07a0c72011-02-17 10:25:35 +0000952
953 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +0000954 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
955 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +0000956 }
957
Richard Smith410306b2016-12-12 02:53:20 +0000958 /// Build the opaque value mapping for an OpaqueValueExpr whose source
959 /// expression is set to the expression the OVE represents.
960 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
961 : CGF(CGF) {
962 if (OV) {
963 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
964 "for OVE with no source expression");
965 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
966 }
967 }
968
John McCall1bf58462011-02-16 08:02:54 +0000969 OpaqueValueMapping(CodeGenFunction &CGF,
970 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +0000971 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000972 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +0000973 }
974
975 OpaqueValueMapping(CodeGenFunction &CGF,
976 const OpaqueValueExpr *opaqueValue,
977 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +0000978 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +0000979 }
980
981 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +0000982 Data.unbind(CGF);
983 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +0000984 }
985
986 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +0000987 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +0000988 }
989 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000990
Chris Lattner2da04b32007-08-24 05:35:26 +0000991private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000992 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +0000993 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000994
John McCall9b382dd2011-05-28 21:13:02 +0000995 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
996 /// calling llvm.stacksave for multiple VLAs in the same scope.
997 bool DidCallStackSave;
998
Mike Stumpe5311b02009-11-30 20:08:49 +0000999 /// IndirectBranch - The first time an indirect goto is seen we create a block
1000 /// with an indirect branch. Every time we see the address of a label taken,
1001 /// we add the label to the indirect goto. Every subsequent indirect goto is
1002 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +00001003 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001004
Mike Stumpfc496822009-02-08 23:14:22 +00001005 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1006 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001007 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001008
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001009 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1010 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1011 /// parameter.
1012 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1013 SizeArguments;
1014
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001015 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001016 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001017 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1018
Chris Lattnerac248202007-05-30 00:13:02 +00001019 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001020 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001021
Mike Stumpfc496822009-02-08 23:14:22 +00001022 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001023 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001024 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001025 BreakContinue(JumpDest Break, JumpDest Continue)
1026 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001027
John McCallbd309292010-07-06 01:34:17 +00001028 JumpDest BreakBlock;
1029 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001030 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001031 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001032
Alexey Bataev957d8562016-11-17 15:12:05 +00001033 /// Handles cancellation exit points in OpenMP-related constructs.
1034 class OpenMPCancelExitStack {
1035 /// Tracks cancellation exit point and join point for cancel-related exit
1036 /// and normal exit.
1037 struct CancelExit {
1038 CancelExit() = default;
1039 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1040 JumpDest ContBlock)
1041 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1042 OpenMPDirectiveKind Kind = OMPD_unknown;
1043 /// true if the exit block has been emitted already by the special
1044 /// emitExit() call, false if the default codegen is used.
1045 bool HasBeenEmitted = false;
1046 JumpDest ExitBlock;
1047 JumpDest ContBlock;
1048 };
1049
1050 SmallVector<CancelExit, 8> Stack;
1051
1052 public:
1053 OpenMPCancelExitStack() : Stack(1) {}
1054 ~OpenMPCancelExitStack() = default;
1055 /// Fetches the exit block for the current OpenMP construct.
1056 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1057 /// Emits exit block with special codegen procedure specific for the related
1058 /// OpenMP construct + emits code for normal construct cleanup.
1059 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1060 const llvm::function_ref<void(CodeGenFunction &)> &CodeGen) {
1061 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1062 assert(CGF.getOMPCancelDestination(Kind).isValid());
1063 assert(CGF.HaveInsertPoint());
1064 assert(!Stack.back().HasBeenEmitted);
1065 auto IP = CGF.Builder.saveAndClearIP();
1066 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1067 CodeGen(CGF);
1068 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1069 CGF.Builder.restoreIP(IP);
1070 Stack.back().HasBeenEmitted = true;
1071 }
1072 CodeGen(CGF);
1073 }
1074 /// Enter the cancel supporting \a Kind construct.
1075 /// \param Kind OpenMP directive that supports cancel constructs.
1076 /// \param HasCancel true, if the construct has inner cancel directive,
1077 /// false otherwise.
1078 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1079 Stack.push_back({Kind,
1080 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1081 : JumpDest(),
1082 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1083 : JumpDest()});
1084 }
1085 /// Emits default exit point for the cancel construct (if the special one
1086 /// has not be used) + join point for cancel/normal exits.
1087 void exit(CodeGenFunction &CGF) {
1088 if (getExitBlock().isValid()) {
1089 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1090 bool HaveIP = CGF.HaveInsertPoint();
1091 if (!Stack.back().HasBeenEmitted) {
1092 if (HaveIP)
1093 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1094 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1095 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1096 }
1097 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1098 if (!HaveIP) {
1099 CGF.Builder.CreateUnreachable();
1100 CGF.Builder.ClearInsertionPoint();
1101 }
1102 }
1103 Stack.pop_back();
1104 }
1105 };
1106 OpenMPCancelExitStack OMPCancelStack;
1107
1108 /// Controls insertion of cancellation exit blocks in worksharing constructs.
1109 class OMPCancelStackRAII {
1110 CodeGenFunction &CGF;
1111
1112 public:
1113 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1114 bool HasCancel)
1115 : CGF(CGF) {
1116 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
1117 }
1118 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
1119 };
1120
Justin Bogneref512b92014-01-06 22:27:43 +00001121 CodeGenPGO PGO;
1122
Justin Bogner65512642015-05-02 05:00:55 +00001123 /// Calculate branch weights appropriate for PGO data
1124 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1125 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1126 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1127 uint64_t LoopCount);
1128
Justin Bogneref512b92014-01-06 22:27:43 +00001129public:
Justin Bogner66242d62015-04-23 23:06:47 +00001130 /// Increment the profiler's counter for the given statement.
1131 void incrementProfileCounter(const Stmt *S) {
Rong Xu9837ef52016-02-04 18:39:09 +00001132 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Justin Bogner66242d62015-04-23 23:06:47 +00001133 PGO.emitCounterIncrement(Builder, S);
1134 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001135 }
Justin Bogner66242d62015-04-23 23:06:47 +00001136
1137 /// Get the profiler's count for the given statement.
1138 uint64_t getProfileCount(const Stmt *S) {
1139 Optional<uint64_t> Count = PGO.getStmtCount(S);
1140 if (!Count.hasValue())
1141 return 0;
1142 return *Count;
1143 }
1144
1145 /// Set the profiler's current count.
1146 void setCurrentProfileCount(uint64_t Count) {
1147 PGO.setCurrentRegionCount(Count);
1148 }
1149
1150 /// Get the profiler's current count. This is generally the count for the most
1151 /// recently incremented counter.
1152 uint64_t getCurrentProfileCount() {
1153 return PGO.getCurrentRegionCount();
1154 }
1155
Justin Bogneref512b92014-01-06 22:27:43 +00001156private:
1157
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001158 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001159 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001160 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001161 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1162 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001163
Mike Stumpfc496822009-02-08 23:14:22 +00001164 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001165 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001166 llvm::BasicBlock *CaseRangeBlock;
1167
John McCallc07a0c72011-02-17 10:25:35 +00001168 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001169 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001170 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1171 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001172
Mike Stumpfc496822009-02-08 23:14:22 +00001173 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001174 // We track this by the size expression rather than the type itself because
1175 // in certain situations, like a const qualifier applied to an VLA typedef,
1176 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001177 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1178 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001179 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001180
John McCallbd309292010-07-06 01:34:17 +00001181 /// A block containing a single 'unreachable' instruction. Created
1182 /// lazily by getUnreachableBlock().
1183 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001184
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001185 /// Counts of the number return expressions in the function.
1186 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001187
1188 /// Count the number of simple (constant) return expressions in the function.
1189 unsigned NumSimpleReturnExprs;
1190
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001191 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001192 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001193
Richard Smith852c9db2013-04-20 22:23:05 +00001194public:
1195 /// A scope within which we are constructing the fields of an object which
1196 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1197 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1198 class FieldConstructionScope {
1199 public:
John McCall7f416cc2015-09-08 08:05:57 +00001200 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001201 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1202 CGF.CXXDefaultInitExprThis = This;
1203 }
1204 ~FieldConstructionScope() {
1205 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1206 }
1207
1208 private:
1209 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001210 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001211 };
1212
1213 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1214 /// is overridden to be the object under construction.
1215 class CXXDefaultInitExprScope {
1216 public:
1217 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001218 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1219 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1220 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1221 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001222 }
1223 ~CXXDefaultInitExprScope() {
1224 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001225 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001226 }
1227
1228 public:
1229 CodeGenFunction &CGF;
1230 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001231 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001232 };
1233
Richard Smith410306b2016-12-12 02:53:20 +00001234 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1235 /// current loop index is overridden.
1236 class ArrayInitLoopExprScope {
1237 public:
1238 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1239 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1240 CGF.ArrayInitIndex = Index;
1241 }
1242 ~ArrayInitLoopExprScope() {
1243 CGF.ArrayInitIndex = OldArrayInitIndex;
1244 }
1245
1246 private:
1247 CodeGenFunction &CGF;
1248 llvm::Value *OldArrayInitIndex;
1249 };
1250
Richard Smith5179eb72016-06-28 19:03:57 +00001251 class InlinedInheritingConstructorScope {
1252 public:
1253 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1254 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1255 OldCurCodeDecl(CGF.CurCodeDecl),
1256 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1257 OldCXXABIThisValue(CGF.CXXABIThisValue),
1258 OldCXXThisValue(CGF.CXXThisValue),
1259 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1260 OldCXXThisAlignment(CGF.CXXThisAlignment),
1261 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1262 OldCXXInheritedCtorInitExprArgs(
1263 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1264 CGF.CurGD = GD;
1265 CGF.CurFuncDecl = CGF.CurCodeDecl =
1266 cast<CXXConstructorDecl>(GD.getDecl());
1267 CGF.CXXABIThisDecl = nullptr;
1268 CGF.CXXABIThisValue = nullptr;
1269 CGF.CXXThisValue = nullptr;
1270 CGF.CXXABIThisAlignment = CharUnits();
1271 CGF.CXXThisAlignment = CharUnits();
1272 CGF.ReturnValue = Address::invalid();
1273 CGF.FnRetTy = QualType();
1274 CGF.CXXInheritedCtorInitExprArgs.clear();
1275 }
1276 ~InlinedInheritingConstructorScope() {
1277 CGF.CurGD = OldCurGD;
1278 CGF.CurFuncDecl = OldCurFuncDecl;
1279 CGF.CurCodeDecl = OldCurCodeDecl;
1280 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1281 CGF.CXXABIThisValue = OldCXXABIThisValue;
1282 CGF.CXXThisValue = OldCXXThisValue;
1283 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1284 CGF.CXXThisAlignment = OldCXXThisAlignment;
1285 CGF.ReturnValue = OldReturnValue;
1286 CGF.FnRetTy = OldFnRetTy;
1287 CGF.CXXInheritedCtorInitExprArgs =
1288 std::move(OldCXXInheritedCtorInitExprArgs);
1289 }
1290
1291 private:
1292 CodeGenFunction &CGF;
1293 GlobalDecl OldCurGD;
1294 const Decl *OldCurFuncDecl;
1295 const Decl *OldCurCodeDecl;
1296 ImplicitParamDecl *OldCXXABIThisDecl;
1297 llvm::Value *OldCXXABIThisValue;
1298 llvm::Value *OldCXXThisValue;
1299 CharUnits OldCXXABIThisAlignment;
1300 CharUnits OldCXXThisAlignment;
1301 Address OldReturnValue;
1302 QualType OldFnRetTy;
1303 CallArgList OldCXXInheritedCtorInitExprArgs;
1304 };
1305
Richard Smith852c9db2013-04-20 22:23:05 +00001306private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001307 /// CXXThisDecl - When generating code for a C++ member function,
1308 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001309 ImplicitParamDecl *CXXABIThisDecl;
1310 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001311 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001312 CharUnits CXXABIThisAlignment;
1313 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001314
Richard Smith852c9db2013-04-20 22:23:05 +00001315 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1316 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001317 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001318
Richard Smith410306b2016-12-12 02:53:20 +00001319 /// The current array initialization index when evaluating an
1320 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1321 llvm::Value *ArrayInitIndex = nullptr;
1322
Richard Smith5179eb72016-06-28 19:03:57 +00001323 /// The values of function arguments to use when evaluating
1324 /// CXXInheritedCtorInitExprs within this context.
1325 CallArgList CXXInheritedCtorInitExprArgs;
1326
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001327 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1328 /// destructor, this will hold the implicit argument (e.g. VTT).
1329 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1330 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001331
John McCallce1de612011-01-26 04:00:11 +00001332 /// OutermostConditional - Points to the outermost active
1333 /// conditional control. This is used so that we know if a
1334 /// temporary should be destroyed conditionally.
1335 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001336
Nadav Rotem1da30942013-03-23 06:43:35 +00001337 /// The current lexical scope.
1338 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001339
Adrian Prantldc237b52013-05-16 00:41:26 +00001340 /// The current source location that should be used for exception
1341 /// handling code.
1342 SourceLocation CurEHLocation;
1343
John McCall7f416cc2015-09-08 08:05:57 +00001344 /// BlockByrefInfos - For each __block variable, contains
1345 /// information about the layout of the variable.
1346 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001347
John McCallbd309292010-07-06 01:34:17 +00001348 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001349 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001350 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001351
Vitaly Buka1c943322016-10-26 01:59:57 +00001352 /// True if we need emit the life-time markers.
1353 const bool ShouldEmitLifetimeMarkers;
1354
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001355 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1356 /// In the kernel metadata node, reference the kernel function and metadata
1357 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001358 /// - A node for the vec_type_hint(<type>) qualifier contains string
1359 /// "vec_type_hint", an undefined value of the <type> data type,
1360 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001361 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1362 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1363 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1364 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1365 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1366 llvm::Function *Fn);
1367
Chris Lattnerbed31442007-05-28 01:07:47 +00001368public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001369 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001370 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001371
John McCall8ed55a52010-09-02 09:58:18 +00001372 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001373 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001374 CGDebugInfo *getDebugInfo() {
1375 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001376 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001377 return DebugInfo;
1378 }
1379 void disableDebugInfo() { DisableDebugInfo = true; }
1380 void enableDebugInfo() { DisableDebugInfo = false; }
1381
John McCall31168b02011-06-15 23:02:42 +00001382 bool shouldUseFusedARCCalls() {
1383 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1384 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001385
David Blaikiebbafb8a2012-03-11 07:00:24 +00001386 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001387
Bill Wendlingf0724e82011-09-19 20:31:14 +00001388 /// Returns a pointer to the function's exception object and selector slot,
1389 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001390 Address getExceptionSlot();
1391 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001392
Bill Wendling79a70e42011-09-15 18:57:19 +00001393 /// Returns the contents of the function's exception object and selector
1394 /// slots.
1395 llvm::Value *getExceptionFromSlot();
1396 llvm::Value *getSelectorFromSlot();
1397
John McCall7f416cc2015-09-08 08:05:57 +00001398 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001399
John McCallbd309292010-07-06 01:34:17 +00001400 llvm::BasicBlock *getUnreachableBlock() {
1401 if (!UnreachableBlock) {
1402 UnreachableBlock = createBasicBlock("unreachable");
1403 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1404 }
1405 return UnreachableBlock;
1406 }
1407
1408 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001409 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001410 return getInvokeDestImpl();
1411 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001412
David Majnemer25eb1652016-03-01 19:42:53 +00001413 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001414
John McCallc8e01702013-04-16 22:48:15 +00001415 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001416 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001417
Daniel Dunbar12347492009-02-23 17:26:39 +00001418 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001419 // Cleanups
1420 //===--------------------------------------------------------------------===//
1421
John McCall7f416cc2015-09-08 08:05:57 +00001422 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001423
John McCall178360e2011-07-11 08:38:19 +00001424 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001425 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001426 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001427 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001428 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001429 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1430 llvm::Value *arrayEnd,
1431 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001432 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001433 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001434
John McCall4bd0fb12011-07-12 16:41:08 +00001435 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001436 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001437 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001438 Address addr, QualType type);
1439 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001440 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001441 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001442 QualType type, Destroyer *destroyer,
1443 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001444 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1445 llvm::Value *CompletePtr,
1446 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001447 void pushStackRestore(CleanupKind kind, Address SPMem);
1448 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001449 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001450 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001451 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001452 bool useEHCleanupForArray,
1453 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001454 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001455 QualType elementType, CharUnits elementAlign,
1456 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001457 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001458
Peter Collingbourne1425b452012-01-26 03:33:36 +00001459 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001460
John McCall82fe67b2011-07-09 01:37:26 +00001461 /// Determines whether an EH cleanup is required to destroy a type
1462 /// with the given destruction kind.
1463 bool needsEHCleanup(QualType::DestructionKind kind) {
1464 switch (kind) {
1465 case QualType::DK_none:
1466 return false;
1467 case QualType::DK_cxx_destructor:
1468 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001469 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001470 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001471 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001472 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1473 }
1474 llvm_unreachable("bad destruction kind");
1475 }
1476
John McCall4bd0fb12011-07-12 16:41:08 +00001477 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1478 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1479 }
1480
John McCall82fe67b2011-07-09 01:37:26 +00001481 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001482 // Objective-C
1483 //===--------------------------------------------------------------------===//
1484
Chris Lattner4bd55962008-03-30 23:03:07 +00001485 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001486
David Blaikief1425802015-01-14 00:04:42 +00001487 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001488
Mike Stumpfc496822009-02-08 23:14:22 +00001489 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001490 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1491 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001492 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001493 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001494 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001495 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001496
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001497 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1498 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001499
Mike Stumpfc496822009-02-08 23:14:22 +00001500 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1501 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001502 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1503 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001504 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001505 const ObjCPropertyImplDecl *propImpl,
1506 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001507
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001508 //===--------------------------------------------------------------------===//
1509 // Block Bits
1510 //===--------------------------------------------------------------------===//
1511
John McCall351762c2011-02-07 10:33:21 +00001512 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001513 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001514
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001515 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001516 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001517 const DeclMapTy &ldm,
1518 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001519
John McCallad7c5c12011-02-08 08:22:06 +00001520 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1521 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001522 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1523 const ObjCPropertyImplDecl *PID);
1524 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1525 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001526 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001527
John McCallad7c5c12011-02-08 08:22:06 +00001528 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1529
John McCall73064872011-03-31 01:59:53 +00001530 class AutoVarEmission;
1531
1532 void emitByrefStructureInit(const AutoVarEmission &emission);
1533 void enterByrefCleanup(const AutoVarEmission &emission);
1534
John McCall7f416cc2015-09-08 08:05:57 +00001535 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1536 llvm::Value *ptr);
1537
1538 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001539 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1540
1541 /// BuildBlockByrefAddress - Computes the location of the
1542 /// data in a variable which is declared as __block.
1543 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1544 bool followForward = true);
1545 Address emitBlockByrefAddress(Address baseAddr,
1546 const BlockByrefInfo &info,
1547 bool followForward,
1548 const llvm::Twine &name);
1549
1550 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001551
Richard Smith5179eb72016-06-28 19:03:57 +00001552 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1553
John McCalla738c252011-03-09 04:27:21 +00001554 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1555 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001556 /// \brief Emit code for the start of a function.
1557 /// \param Loc The location to be associated with the function.
1558 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001559 void StartFunction(GlobalDecl GD,
1560 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001561 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001562 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001563 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001564 SourceLocation Loc = SourceLocation(),
1565 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001566
John McCallb81884d2010-02-19 09:25:03 +00001567 void EmitConstructorBody(FunctionArgList &Args);
1568 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001569 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001570 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001571 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001572
Faisal Vali571df122013-09-29 08:45:24 +00001573 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001574 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001575 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001576 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001577 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1578 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001579 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001580
David Blaikiea0a1a872015-01-18 02:48:07 +00001581 /// \brief Emit the unified return block, trying to avoid its emission when
1582 /// possible.
1583 /// \return The debug location of the user written return statement if the
1584 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001585 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001586
Mike Stumpfc496822009-02-08 23:14:22 +00001587 /// FinishFunction - Complete IR generation of the current function. It is
1588 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001589 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001590
Nico Weber1bebad12015-02-11 22:33:32 +00001591 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1592 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001593
John McCallb92ab1a2016-10-26 23:46:34 +00001594 void EmitCallAndReturnForThunk(llvm::Constant *Callee,
1595 const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001596
John McCall7f416cc2015-09-08 08:05:57 +00001597 void FinishThunk();
1598
Reid Klecknerab2090d2014-07-26 01:34:32 +00001599 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1600 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1601 llvm::Value *Callee);
1602
Rafael Espindolad6e66942015-07-13 06:07:58 +00001603 /// Generate a thunk for the given method.
1604 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001605 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001606
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001607 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1608 const CGFunctionInfo &FnInfo,
1609 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001610
Douglas Gregor94f9a482010-05-05 05:51:00 +00001611 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1612 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001613
Richard Smith30e304e2016-12-14 00:03:17 +00001614 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001615
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001616 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1617 struct VPtr {
1618 BaseSubobject Base;
1619 const CXXRecordDecl *NearestVBase;
1620 CharUnits OffsetFromNearestVBase;
1621 const CXXRecordDecl *VTableClass;
1622 };
1623
1624 /// Initialize the vtable pointer of the given subobject.
1625 void InitializeVTablePointer(const VPtr &vptr);
1626
1627 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001628
1629 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001630 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1631
1632 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1633 CharUnits OffsetFromNearestVBase,
1634 bool BaseIsNonVirtualPrimaryBase,
1635 const CXXRecordDecl *VTableClass,
1636 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001637
Anders Carlssond5895932010-03-28 21:07:49 +00001638 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001639
Dan Gohman8fc50c22010-10-26 18:44:08 +00001640 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1641 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001642 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1643 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001644
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001645 enum CFITypeCheckKind {
1646 CFITCK_VCall,
1647 CFITCK_NVCall,
1648 CFITCK_DerivedCast,
1649 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001650 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001651 };
1652
Peter Collingbourned2926c92015-03-14 02:42:25 +00001653 /// \brief Derived is the presumed address of an object of type T after a
1654 /// cast. If T is a polymorphic class type, emit a check that the virtual
1655 /// table for Derived belongs to a class derived from T.
1656 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001657 bool MayBeNull, CFITypeCheckKind TCK,
1658 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001659
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001660 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1661 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001662 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001663 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001664
Peter Collingbourned2926c92015-03-14 02:42:25 +00001665 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001666 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001667 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1668 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001669
Peter Collingbournefb532b92016-02-24 20:46:36 +00001670 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001671 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1672 /// enabled, emit a check that VTable is a member of RD's type identifier.
1673 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1674 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001675
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001676 /// Returns whether we should perform a type checked load when loading a
1677 /// virtual function for virtual calls to members of RD. This is generally
1678 /// true when both vcall CFI and whole-program-vtables are enabled.
1679 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1680
1681 /// Emit a type checked load from the given vtable.
1682 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1683 uint64_t VTableByteOffset);
1684
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001685 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given
1686 /// expr can be devirtualized.
1687 bool CanDevirtualizeMemberFunctionCall(const Expr *Base,
1688 const CXXMethodDecl *MD);
1689
John McCallf99a6312010-07-21 05:30:47 +00001690 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1691 /// given phase of destruction for a destructor. The end result
1692 /// should call destructors on members and base classes in reverse
1693 /// order of their construction.
1694 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001695
Chris Lattner3c77a352010-06-22 00:03:40 +00001696 /// ShouldInstrumentFunction - Return true if the current function should be
1697 /// instrumented with __cyg_profile_func_* calls
1698 bool ShouldInstrumentFunction();
1699
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001700 /// ShouldXRayInstrument - Return true if the current function should be
1701 /// instrumented with XRay nop sleds.
1702 bool ShouldXRayInstrumentFunction() const;
1703
Chris Lattner3c77a352010-06-22 00:03:40 +00001704 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1705 /// instrumentation function with the current function and the call site, if
1706 /// function instrumentation is enabled.
1707 void EmitFunctionInstrumentation(const char *Fn);
1708
Roman Divacky178e01602011-02-10 16:52:03 +00001709 /// EmitMCountInstrumentation - Emit call to .mcount.
1710 void EmitMCountInstrumentation();
1711
Mike Stumpfc496822009-02-08 23:14:22 +00001712 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1713 /// arguments for the given function. This is also responsible for naming the
1714 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001715 void EmitFunctionProlog(const CGFunctionInfo &FI,
1716 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001717 const FunctionArgList &Args);
1718
Mike Stumpfc496822009-02-08 23:14:22 +00001719 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1720 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001721 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1722 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001723
Mike Stump1d849212009-12-07 23:38:24 +00001724 /// EmitStartEHSpec - Emit the start of the exception spec.
1725 void EmitStartEHSpec(const Decl *D);
1726
1727 /// EmitEndEHSpec - Emit the end of the exception spec.
1728 void EmitEndEHSpec(const Decl *D);
1729
John McCallbd309292010-07-06 01:34:17 +00001730 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1731 llvm::BasicBlock *getTerminateLandingPad();
1732
1733 /// getTerminateHandler - Return a handler (not a landing pad, just
1734 /// a catch handler) that just calls terminate. This is used when
1735 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001736 llvm::BasicBlock *getTerminateHandler();
1737
Chris Lattnera5f58b02011-07-09 17:41:47 +00001738 llvm::Type *ConvertTypeForMem(QualType T);
1739 llvm::Type *ConvertType(QualType T);
1740 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001741 return ConvertType(getContext().getTypeDeclType(T));
1742 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001743
Mike Stumpfc496822009-02-08 23:14:22 +00001744 /// LoadObjCSelf - Load the value of self. This function is only valid while
1745 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001746 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001747
1748 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001749 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001750
Chris Lattner54fb19e2007-06-22 22:02:34 +00001751 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1752 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001753 static TypeEvaluationKind getEvaluationKind(QualType T);
1754
1755 static bool hasScalarEvaluationKind(QualType T) {
1756 return getEvaluationKind(T) == TEK_Scalar;
1757 }
1758
1759 static bool hasAggregateEvaluationKind(QualType T) {
1760 return getEvaluationKind(T) == TEK_Aggregate;
1761 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001762
1763 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001764 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001765 llvm::Function *parent = nullptr,
1766 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001767#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001768 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001769#else
John McCallad7c5c12011-02-08 08:22:06 +00001770 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001771#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001772 }
Mike Stumpfc496822009-02-08 23:14:22 +00001773
Chris Lattnerac248202007-05-30 00:13:02 +00001774 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1775 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001776 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001777
Mike Stumpe5311b02009-11-30 20:08:49 +00001778 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1779 /// another basic block, simplify it. This assumes that no other code could
1780 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001781 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1782
Mike Stumpfc496822009-02-08 23:14:22 +00001783 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1784 /// adding a fall-through branch from the current insert block if
1785 /// necessary. It is legal to call this function even if there is no current
1786 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001787 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001788 /// IsFinished - If true, indicates that the caller has finished emitting
1789 /// branches to the given block and does not expect to emit code into it. This
1790 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001791 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001792
John McCall8e4c74b2011-08-11 02:22:43 +00001793 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1794 /// near its uses, and leave the insertion point in it.
1795 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1796
Mike Stumpfc496822009-02-08 23:14:22 +00001797 /// EmitBranch - Emit a branch to the specified basic block from the current
1798 /// insert block, taking care to avoid creation of branches from dummy
1799 /// blocks. It is legal to call this function even if there is no current
1800 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001801 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001802 /// This function clears the current insertion point. The caller should follow
1803 /// calls to this function with calls to Emit*Block prior to generation new
1804 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001805 void EmitBranch(llvm::BasicBlock *Block);
1806
Mike Stumpfc496822009-02-08 23:14:22 +00001807 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1808 /// indicates that the current code being emitted is unreachable.
1809 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001810 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001811 }
1812
Mike Stumpfc496822009-02-08 23:14:22 +00001813 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1814 /// emitted IR has a place to go. Note that by definition, if this function
1815 /// creates a block then that block is unreachable; callers may do better to
1816 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001817 void EnsureInsertPoint() {
1818 if (!HaveInsertPoint())
1819 EmitBlock(createBasicBlock());
1820 }
Mike Stumpfc496822009-02-08 23:14:22 +00001821
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001822 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001823 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001824 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001825
Chris Lattnere9a64532007-06-22 21:44:33 +00001826 //===--------------------------------------------------------------------===//
1827 // Helpers
1828 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001829
John McCall7f416cc2015-09-08 08:05:57 +00001830 LValue MakeAddrLValue(Address Addr, QualType T,
1831 AlignmentSource AlignSource = AlignmentSource::Type) {
1832 return LValue::MakeAddr(Addr, T, getContext(), AlignSource,
Dan Gohman947c9af2010-10-14 23:06:10 +00001833 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001834 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001835
John McCall7f416cc2015-09-08 08:05:57 +00001836 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
1837 AlignmentSource AlignSource = AlignmentSource::Type) {
1838 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
1839 AlignSource, CGM.getTBAAInfo(T));
1840 }
1841
1842 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001843 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001844 CharUnits getNaturalTypeAlignment(QualType T,
1845 AlignmentSource *Source = nullptr,
1846 bool forPointeeType = false);
1847 CharUnits getNaturalPointeeTypeAlignment(QualType T,
1848 AlignmentSource *Source = nullptr);
1849
1850 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
1851 AlignmentSource *Source = nullptr);
1852 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001853
Alexey Bataev31300ed2016-02-04 11:27:03 +00001854 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
1855 AlignmentSource *Source = nullptr);
1856 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1857
Chris Lattnere9a64532007-06-22 21:44:33 +00001858 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001859 /// block. The caller is responsible for setting an appropriate alignment on
1860 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001861 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001862 const Twine &Name = "tmp");
John McCall7f416cc2015-09-08 08:05:57 +00001863 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
1864 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001865
John McCall7f416cc2015-09-08 08:05:57 +00001866 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1867 /// default ABI alignment of the given LLVM type.
1868 ///
1869 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1870 /// any given AST type that happens to have been lowered to the
1871 /// given IR type. This should only ever be used for function-local,
1872 /// IR-driven manipulations like saving and restoring a value. Do
1873 /// not hand this address off to arbitrary IRGen routines, and especially
1874 /// do not pass it as an argument to a function that might expect a
1875 /// properly ABI-aligned value.
1876 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1877 const Twine &Name = "tmp");
1878
1879 /// InitTempAlloca - Provide an initial value for the given alloca which
1880 /// will be observable at all locations in the function.
1881 ///
1882 /// The address should be something that was returned from one of
1883 /// the CreateTempAlloca or CreateMemTemp routines, and the
1884 /// initializer must be valid in the entry block (i.e. it must
1885 /// either be a constant or an argument value).
1886 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001887
Daniel Dunbard0049182010-02-16 19:44:13 +00001888 /// CreateIRTemp - Create a temporary IR object of the given type, with
1889 /// appropriate alignment. This routine should only be used when an temporary
1890 /// value needs to be stored into an alloca (for example, to avoid explicit
1891 /// PHI construction), but the type is the IR type, not the type appropriate
1892 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001893 ///
1894 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1895 /// ConvertType instead of ConvertTypeForMem.
1896 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001897
Daniel Dunbara7566f12010-02-09 02:48:28 +00001898 /// CreateMemTemp - Create a temporary memory object of the given type, with
1899 /// appropriate alignment.
John McCall7f416cc2015-09-08 08:05:57 +00001900 Address CreateMemTemp(QualType T, const Twine &Name = "tmp");
1901 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001902
John McCall7a626f62010-09-15 10:14:12 +00001903 /// CreateAggTemp - Create a temporary memory object for the given
1904 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001905 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00001906 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001907 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001908 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001909 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001910 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001911 }
1912
John McCallad7c5c12011-02-08 08:22:06 +00001913 /// Emit a cast to void* in the appropriate address space.
1914 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1915
Chris Lattner8394d792007-06-05 20:53:16 +00001916 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1917 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001918 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001919
John McCalla2342eb2010-12-05 02:00:02 +00001920 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1921 void EmitIgnoredExpr(const Expr *E);
1922
Chris Lattner4647a212007-08-31 22:49:20 +00001923 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1924 /// any type. The result is returned as an RValue struct. If this is an
1925 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1926 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001927 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001928 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001929 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001930 AggValueSlot aggSlot = AggValueSlot::ignored(),
1931 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001932
Mike Stumpfc496822009-02-08 23:14:22 +00001933 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1934 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00001935 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001936
Charles Davisc7d5c942015-09-17 20:55:33 +00001937 /// Emit a "reference" to a __builtin_ms_va_list; this is
1938 /// always the value of the expression, because a __builtin_ms_va_list is a
1939 /// pointer to a char.
1940 Address EmitMSVAListRef(const Expr *E);
1941
Mike Stumpfc496822009-02-08 23:14:22 +00001942 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1943 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001944 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001945
John McCall91ca10f2011-03-08 09:11:50 +00001946 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001947 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00001948 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001949 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001950
John McCall7f416cc2015-09-08 08:05:57 +00001951 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00001952
John McCall91ca10f2011-03-08 09:11:50 +00001953 /// EmitExprAsInit - Emits the code necessary to initialize a
1954 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00001955 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00001956 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001957
Fariborz Jahanian78652202013-01-25 23:57:05 +00001958 /// hasVolatileMember - returns true if aggregate type has a volatile
1959 /// member.
1960 bool hasVolatileMember(QualType T) {
1961 if (const RecordType *RT = T->getAs<RecordType>()) {
1962 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1963 return RD->hasVolatileMember();
1964 }
1965 return false;
1966 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001967 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001968 ///
1969 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1970 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00001971 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001972 QualType EltTy) {
1973 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00001974 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001975 }
1976
John McCall7f416cc2015-09-08 08:05:57 +00001977 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
1978 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00001979 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00001980 /*IsAssignment=*/false);
1981 }
1982
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001983 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001984 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001985 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001986 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001987 /// \param isAssignment - If false, allow padding to be copied. This often
1988 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00001989 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001990 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001991 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001992
Anders Carlsson9396a892008-09-11 09:15:33 +00001993 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00001994 Address GetAddrOfLocalVar(const VarDecl *VD) {
1995 auto it = LocalDeclMap.find(VD);
1996 assert(it != LocalDeclMap.end() &&
1997 "Invalid argument to GetAddrOfLocalVar(), no decl!");
1998 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00001999 }
Mike Stumpfc496822009-02-08 23:14:22 +00002000
John McCallc07a0c72011-02-17 10:25:35 +00002001 /// getOpaqueLValueMapping - Given an opaque value expression (which
2002 /// must be mapped to an l-value), return its mapping.
2003 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
2004 assert(OpaqueValueMapping::shouldBindAsLValue(e));
2005
2006 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
2007 it = OpaqueLValues.find(e);
2008 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
2009 return it->second;
2010 }
2011
2012 /// getOpaqueRValueMapping - Given an opaque value expression (which
2013 /// must be mapped to an r-value), return its mapping.
2014 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
2015 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
2016
2017 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
2018 it = OpaqueRValues.find(e);
2019 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00002020 return it->second;
2021 }
2022
Richard Smith410306b2016-12-12 02:53:20 +00002023 /// Get the index of the current ArrayInitLoopExpr, if any.
2024 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2025
Dan Gohman75d69da2008-05-22 00:50:06 +00002026 /// getAccessedFieldNo - Given an encoded value and a result number, return
2027 /// the input field number being accessed.
2028 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2029
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002030 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002031 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002032
Anders Carlssonc0964b62010-05-22 17:35:42 +00002033 /// EmitNullInitialization - Generate code to set a value of the given type to
2034 /// null, If the type contains data member pointers, they will be initialized
2035 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002036 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002037
Charles Davisc7d5c942015-09-17 20:55:33 +00002038 /// Emits a call to an LLVM variable-argument intrinsic, either
2039 /// \c llvm.va_start or \c llvm.va_end.
2040 /// \param ArgValue A reference to the \c va_list as emitted by either
2041 /// \c EmitVAListRef or \c EmitMSVAListRef.
2042 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2043 /// calls \c llvm.va_end.
2044 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2045
2046 /// Generate code to get an argument from the passed in pointer
2047 /// and update it accordingly.
2048 /// \param VE The \c VAArgExpr for which to generate code.
2049 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2050 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2051 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002052 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002053 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002054 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002055
John McCall82fe67b2011-07-09 01:37:26 +00002056 /// emitArrayLength - Compute the length of an array, even if it's a
2057 /// VLA, and drill down to the base element type.
2058 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2059 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002060 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002061
John McCall23c29fe2011-06-24 21:55:10 +00002062 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2063 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002064 ///
2065 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002066 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002067
John McCall23c29fe2011-06-24 21:55:10 +00002068 /// getVLASize - Returns an LLVM value that corresponds to the size,
2069 /// in non-variably-sized elements, of a variable length array type,
2070 /// plus that largest non-variably-sized element type. Assumes that
2071 /// the type has already been emitted with EmitVariablyModifiedType.
2072 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
2073 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002074
Anders Carlssona5d077d2009-04-14 16:58:56 +00002075 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2076 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002077 llvm::Value *LoadCXXThis() {
2078 assert(CXXThisValue && "no 'this' value for this function");
2079 return CXXThisValue;
2080 }
John McCall7f416cc2015-09-08 08:05:57 +00002081 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002082
Anders Carlssone36a6b32010-01-02 01:01:18 +00002083 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2084 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002085 // FIXME: Every place that calls LoadCXXVTT is something
2086 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002087 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002088 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2089 return CXXStructorImplicitParamValue;
2090 }
2091
John McCall6ce74722010-02-16 04:15:37 +00002092 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002093 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002094 Address
2095 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002096 const CXXRecordDecl *Derived,
2097 const CXXRecordDecl *Base,
2098 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002099
John McCall7f416cc2015-09-08 08:05:57 +00002100 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2101
Mike Stumpe5311b02009-11-30 20:08:49 +00002102 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2103 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002104 Address GetAddressOfBaseClass(Address Value,
2105 const CXXRecordDecl *Derived,
2106 CastExpr::path_const_iterator PathBegin,
2107 CastExpr::path_const_iterator PathEnd,
2108 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002109
John McCall7f416cc2015-09-08 08:05:57 +00002110 Address GetAddressOfDerivedClass(Address Value,
2111 const CXXRecordDecl *Derived,
2112 CastExpr::path_const_iterator PathBegin,
2113 CastExpr::path_const_iterator PathEnd,
2114 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002115
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002116 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2117 /// base constructor/destructor with virtual bases.
2118 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2119 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2120 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2121 bool Delegating);
2122
John McCallf8ff7b92010-02-23 00:48:20 +00002123 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2124 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002125 const FunctionArgList &Args,
2126 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002127 // It's important not to confuse this and the previous function. Delegating
2128 // constructors are the C++0x feature. The constructor delegate optimization
2129 // is used to reduce duplication in the base and complete consturctors where
2130 // they are substantially the same.
2131 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2132 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002133
Richard Smith5179eb72016-06-28 19:03:57 +00002134 /// Emit a call to an inheriting constructor (that is, one that invokes a
2135 /// constructor inherited from a base class) by inlining its definition. This
2136 /// is necessary if the ABI does not support forwarding the arguments to the
2137 /// base class constructor (because they're variadic or similar).
2138 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2139 CXXCtorType CtorType,
2140 bool ForVirtualBase,
2141 bool Delegating,
2142 CallArgList &Args);
2143
2144 /// Emit a call to a constructor inherited from a base class, passing the
2145 /// current constructor's arguments along unmodified (without even making
2146 /// a copy).
2147 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2148 bool ForVirtualBase, Address This,
2149 bool InheritedFromVBase,
2150 const CXXInheritedCtorInitExpr *E);
2151
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002152 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002153 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002154 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002155
Richard Smith5179eb72016-06-28 19:03:57 +00002156 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2157 bool ForVirtualBase, bool Delegating,
2158 Address This, CallArgList &Args);
2159
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002160 /// Emit assumption load for all bases. Requires to be be called only on
2161 /// most-derived class and not under construction of the object.
2162 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2163
2164 /// Emit assumption that vptr load == global vtable.
2165 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2166
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002167 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002168 Address This, Address Src,
2169 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002170
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002171 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002172 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002173 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002174 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002175 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002176
Anders Carlssond49844b2009-09-23 02:45:36 +00002177 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2178 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002179 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002180 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002181 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002182
John McCall82fe67b2011-07-09 01:37:26 +00002183 static Destroyer destroyCXXObject;
2184
Anders Carlsson0a637412009-05-29 21:03:38 +00002185 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002186 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002187 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002188
John McCall99210dc2011-09-15 06:49:18 +00002189 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002190 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002191 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002192 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002193
Peter Collingbourne702b2842011-11-27 22:09:22 +00002194 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002195 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002196
David Majnemerdc012fa2015-04-22 21:38:15 +00002197 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2198 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2199
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002200 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002201 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002202
Eli Friedman24f55432009-11-18 00:57:03 +00002203 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002204 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2205 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002206
Richard Smith760520b2014-06-03 23:27:44 +00002207 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2208 const Expr *Arg, bool IsDelete);
2209
John McCall7f416cc2015-09-08 08:05:57 +00002210 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2211 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2212 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002213
Richard Smith69d0d262012-08-24 00:54:33 +00002214 /// \brief Situations in which we might emit a check for the suitability of a
2215 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002216 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002217 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002218 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002219 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002220 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002221 /// Checking the bound value in a reference binding. Must be suitably sized
2222 /// and aligned, but is not required to refer to an object (until the
2223 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002224 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002225 /// Checking the object expression in a non-static data member access. Must
2226 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002227 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002228 /// Checking the 'this' pointer for a call to a non-static member function.
2229 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002230 TCK_MemberCall,
2231 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002232 TCK_ConstructorCall,
2233 /// Checking the operand of a static_cast to a derived pointer type. Must be
2234 /// null or an object within its lifetime.
2235 TCK_DowncastPointer,
2236 /// Checking the operand of a static_cast to a derived reference type. Must
2237 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002238 TCK_DowncastReference,
2239 /// Checking the operand of a cast to a base object. Must be suitably sized
2240 /// and aligned.
2241 TCK_Upcast,
2242 /// Checking the operand of a cast to a virtual base object. Must be an
2243 /// object within its lifetime.
2244 TCK_UpcastToVirtualBase
Richard Smith69d0d262012-08-24 00:54:33 +00002245 };
2246
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002247 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2248 /// calls to EmitTypeCheck can be skipped.
2249 bool sanitizePerformTypeCheck() const;
2250
Richard Smith4d1458e2012-09-08 02:08:36 +00002251 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002252 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002253 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002254 QualType Type, CharUnits Alignment = CharUnits::Zero(),
2255 bool SkipNullCheck = false);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002256
Richard Smith539e4a72013-02-23 02:53:19 +00002257 /// \brief Emit a check that \p Base points into an array object, which
2258 /// we can access at index \p Index. \p Accessed should be \c false if we
2259 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2260 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2261 QualType IndexType, bool Accessed);
2262
Chris Lattner116ce8f2010-01-09 21:40:03 +00002263 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2264 bool isInc, bool isPre);
2265 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2266 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002267
2268 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002269 llvm::Value *OffsetValue = nullptr) {
2270 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2271 OffsetValue);
2272 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002273
Amara Emerson652795d2016-11-10 14:44:30 +00002274 /// Converts Location to a DebugLoc, if debug information is enabled.
2275 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2276
2277
Chris Lattner8394d792007-06-05 20:53:16 +00002278 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002279 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002280 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002281
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002282 /// EmitDecl - Emit a declaration.
2283 ///
2284 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002285 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002286
John McCall1c9c3fd2010-10-15 04:57:14 +00002287 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002288 ///
2289 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002290 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002291
David Blaikie73ca5692014-12-09 00:32:22 +00002292 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002293 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002294
John McCallbd309292010-07-06 01:34:17 +00002295 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2296 llvm::Value *Address);
2297
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002298 /// \brief Determine whether the given initializer is trivial in the sense
2299 /// that it requires no code to be generated.
2300 bool isTrivialInitializer(const Expr *Init);
2301
John McCall1c9c3fd2010-10-15 04:57:14 +00002302 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002303 ///
2304 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002305 void EmitAutoVarDecl(const VarDecl &D);
2306
2307 class AutoVarEmission {
2308 friend class CodeGenFunction;
2309
John McCall9e2e22f2011-02-22 07:16:58 +00002310 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002311
John McCall7f416cc2015-09-08 08:05:57 +00002312 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002313 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002314 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002315
2316 llvm::Value *NRVOFlag;
2317
2318 /// True if the variable is a __block variable.
2319 bool IsByRef;
2320
2321 /// True if the variable is of aggregate type and has a constant
2322 /// initializer.
2323 bool IsConstantAggregate;
2324
Nadav Rotem1da30942013-03-23 06:43:35 +00002325 /// Non-null if we should use lifetime annotations.
2326 llvm::Value *SizeForLifetimeMarkers;
2327
John McCall9e2e22f2011-02-22 07:16:58 +00002328 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002329 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002330
John McCallc533cb72011-02-22 06:44:22 +00002331 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002332 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002333 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002334 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002335
John McCall7f416cc2015-09-08 08:05:57 +00002336 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002337
2338 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002339 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2340
Craig Topper8a13c412014-05-21 05:09:00 +00002341 bool useLifetimeMarkers() const {
2342 return SizeForLifetimeMarkers != nullptr;
2343 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002344 llvm::Value *getSizeForLifetimeMarkers() const {
2345 assert(useLifetimeMarkers());
2346 return SizeForLifetimeMarkers;
2347 }
2348
2349 /// Returns the raw, allocated address, which is not necessarily
2350 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002351 Address getAllocatedAddress() const {
2352 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002353 }
2354
John McCallc533cb72011-02-22 06:44:22 +00002355 /// Returns the address of the object within this declaration.
2356 /// Note that this does not chase the forwarding pointer for
2357 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002358 Address getObjectAddress(CodeGenFunction &CGF) const {
2359 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002360
John McCall7f416cc2015-09-08 08:05:57 +00002361 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002362 }
2363 };
2364 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2365 void EmitAutoVarInit(const AutoVarEmission &emission);
2366 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002367 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2368 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002369
John McCall1c9c3fd2010-10-15 04:57:14 +00002370 void EmitStaticVarDecl(const VarDecl &D,
2371 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002372
John McCall7f416cc2015-09-08 08:05:57 +00002373 class ParamValue {
2374 llvm::Value *Value;
2375 unsigned Alignment;
2376 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2377 public:
2378 static ParamValue forDirect(llvm::Value *value) {
2379 return ParamValue(value, 0);
2380 }
2381 static ParamValue forIndirect(Address addr) {
2382 assert(!addr.getAlignment().isZero());
2383 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2384 }
2385
2386 bool isIndirect() const { return Alignment != 0; }
2387 llvm::Value *getAnyValue() const { return Value; }
2388
2389 llvm::Value *getDirectValue() const {
2390 assert(!isIndirect());
2391 return Value;
2392 }
2393
2394 Address getIndirectAddress() const {
2395 assert(isIndirect());
2396 return Address(Value, CharUnits::fromQuantity(Alignment));
2397 }
2398 };
2399
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002400 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002401 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002402
John McCallc07a0c72011-02-17 10:25:35 +00002403 /// protectFromPeepholes - Protect a value that we're intending to
2404 /// store to the side, but which will probably be used later, from
2405 /// aggressive peepholing optimizations that might delete it.
2406 ///
2407 /// Pass the result to unprotectFromPeepholes to declare that
2408 /// protection is no longer required.
2409 ///
2410 /// There's no particular reason why this shouldn't apply to
2411 /// l-values, it's just that no existing peepholes work on pointers.
2412 PeepholeProtection protectFromPeepholes(RValue rvalue);
2413 void unprotectFromPeepholes(PeepholeProtection protection);
2414
Chris Lattner84915fa2007-06-02 04:16:21 +00002415 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002416 // Statement Emission
2417 //===--------------------------------------------------------------------===//
2418
Mike Stumpfc496822009-02-08 23:14:22 +00002419 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002420 void EmitStopPoint(const Stmt *S);
2421
Mike Stumpfc496822009-02-08 23:14:22 +00002422 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2423 /// this function even if there is no current insertion point.
2424 ///
2425 /// This function may clear the current insertion point; callers should use
2426 /// EnsureInsertPoint if they wish to subsequently generate code without first
2427 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002428 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002429
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002430 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002431 /// necessarily require an insertion point or debug information; typically
2432 /// because the statement amounts to a jump or a container of other
2433 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002434 ///
2435 /// \return True if the statement was handled.
2436 bool EmitSimpleStmt(const Stmt *S);
2437
John McCall7f416cc2015-09-08 08:05:57 +00002438 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2439 AggValueSlot AVS = AggValueSlot::ignored());
2440 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2441 bool GetLast = false,
2442 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002443 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002444
Mike Stumpfc496822009-02-08 23:14:22 +00002445 /// EmitLabel - Emit the block for the given label. It is legal to call this
2446 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002447 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002448
Chris Lattnerac248202007-05-30 00:13:02 +00002449 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002450 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002451 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002452 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002453 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002454
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002455 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002456 ArrayRef<const Attr *> Attrs = None);
2457 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002458 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002459 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002460 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002461 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002462 void EmitBreakStmt(const BreakStmt &S);
2463 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002464 void EmitSwitchStmt(const SwitchStmt &S);
2465 void EmitDefaultStmt(const DefaultStmt &S);
2466 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002467 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002468 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002469
Anders Carlsson2e744e82008-08-30 19:51:14 +00002470 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002471 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2472 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002473 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002474 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002475
Gor Nishanov8df64e92016-10-27 16:28:31 +00002476 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002477 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2478
John McCallb609d3f2010-07-07 06:56:46 +00002479 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2480 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002481
Anders Carlsson52d78a52009-09-27 18:58:34 +00002482 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002483 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002484 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002485 void EnterSEHTryStmt(const SEHTryStmt &S);
2486 void ExitSEHTryStmt(const SEHTryStmt &S);
2487
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002488 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002489 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002490
2491 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2492 const SEHExceptStmt &Except);
2493
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002494 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2495 const SEHFinallyStmt &Finally);
2496
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002497 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2498 llvm::Value *ParentFP,
2499 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002500 llvm::Value *EmitSEHExceptionCode();
2501 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002502 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002503
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002504 /// Scan the outlined statement for captures from the parent function. For
2505 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002506 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002507 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002508 bool IsFilter);
2509
2510 /// Recovers the address of a local in a parent function. ParentVar is the
2511 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002512 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002513 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2514 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002515 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2516 Address ParentVar,
2517 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002518
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002519 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002520 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002521
Alexey Bataev1189bd02016-01-26 12:20:39 +00002522 /// Returns calculated size of the specified type.
2523 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002524 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002525 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002526 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002527 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002528 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002529 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002530 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002531 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2532 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002533 /// \brief Perform element by element copying of arrays with type \a
2534 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2535 /// generated by \a CopyGen.
2536 ///
2537 /// \param DestAddr Address of the destination array.
2538 /// \param SrcAddr Address of the source array.
2539 /// \param OriginalType Type of destination and source arrays.
2540 /// \param CopyGen Copying procedure that copies value of single array element
2541 /// to another single array element.
2542 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002543 Address DestAddr, Address SrcAddr, QualType OriginalType,
2544 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002545 /// \brief Emit proper copying of data from one variable to another.
2546 ///
2547 /// \param OriginalType Original type of the copied variables.
2548 /// \param DestAddr Destination address.
2549 /// \param SrcAddr Source address.
2550 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2551 /// type of the base array element).
2552 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2553 /// the base array element).
2554 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2555 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002556 void EmitOMPCopy(QualType OriginalType,
2557 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002558 const VarDecl *DestVD, const VarDecl *SrcVD,
2559 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002560 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2561 /// \a X = \a E \a BO \a E.
2562 ///
2563 /// \param X Value to be updated.
2564 /// \param E Update value.
2565 /// \param BO Binary operation for update operation.
2566 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2567 /// expression, false otherwise.
2568 /// \param AO Atomic ordering of the generated atomic instructions.
2569 /// \param CommonGen Code generator for complex expressions that cannot be
2570 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002571 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2572 /// generated, <false, RValue::get(nullptr)> otherwise.
2573 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002574 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2575 llvm::AtomicOrdering AO, SourceLocation Loc,
2576 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002577 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002578 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002579 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2580 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002581 void EmitOMPUseDevicePtrClause(
2582 const OMPClause &C, OMPPrivateScope &PrivateScope,
2583 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002584 /// \brief Emit code for copyin clause in \a D directive. The next code is
2585 /// generated at the start of outlined functions for directives:
2586 /// \code
2587 /// threadprivate_var1 = master_threadprivate_var1;
2588 /// operator=(threadprivate_var2, master_threadprivate_var2);
2589 /// ...
2590 /// __kmpc_barrier(&loc, global_tid);
2591 /// \endcode
2592 ///
2593 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2594 /// \returns true if at least one copyin variable is found, false otherwise.
2595 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002596 /// \brief Emit initial code for lastprivate variables. If some variable is
2597 /// not also firstprivate, then the default initialization is used. Otherwise
2598 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2599 /// method.
2600 ///
2601 /// \param D Directive that may have 'lastprivate' directives.
2602 /// \param PrivateScope Private scope for capturing lastprivate variables for
2603 /// proper codegen in internal captured statement.
2604 ///
2605 /// \returns true if there is at least one lastprivate variable, false
2606 /// otherwise.
2607 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2608 OMPPrivateScope &PrivateScope);
2609 /// \brief Emit final copying of lastprivate values to original variables at
2610 /// the end of the worksharing or simd directive.
2611 ///
2612 /// \param D Directive that has at least one 'lastprivate' directives.
2613 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2614 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002615 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002616 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002617 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002618 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002619 /// Emit initial code for linear clauses.
2620 void EmitOMPLinearClause(const OMPLoopDirective &D,
2621 CodeGenFunction::OMPPrivateScope &PrivateScope);
2622 /// Emit final code for linear clauses.
2623 /// \param CondGen Optional conditional code for final part of codegen for
2624 /// linear clause.
2625 void EmitOMPLinearClauseFinal(
2626 const OMPLoopDirective &D,
2627 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002628 /// \brief Emit initial code for reduction variables. Creates reduction copies
2629 /// and initializes them with the values according to OpenMP standard.
2630 ///
2631 /// \param D Directive (possibly) with the 'reduction' clause.
2632 /// \param PrivateScope Private scope for capturing reduction variables for
2633 /// proper codegen in internal captured statement.
2634 ///
2635 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2636 OMPPrivateScope &PrivateScope);
2637 /// \brief Emit final update of reduction values to original variables at
2638 /// the end of the directive.
2639 ///
2640 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00002641 /// \param ReductionKind The kind of reduction to perform.
2642 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
2643 const OpenMPDirectiveKind ReductionKind);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002644 /// \brief Emit initial code for linear variables. Creates private copies
2645 /// and initializes them with the values according to OpenMP standard.
2646 ///
2647 /// \param D Directive (possibly) with the 'linear' clause.
2648 void EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002649
Alexey Bataev7292c292016-04-25 12:22:29 +00002650 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2651 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002652 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002653 TaskGenTy;
2654 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2655 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002656 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00002657
Alexey Bataev9959db52014-05-06 10:08:46 +00002658 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002659 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002660 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002661 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002662 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002663 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002664 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002665 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002666 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002667 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002668 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002669 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002670 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002671 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002672 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002673 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002674 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002675 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002676 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002677 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002678 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002679 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002680 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002681 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002682 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002683 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002684 void
2685 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002686 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002687 void
2688 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002689 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002690 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002691 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002692 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002693 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002694 void EmitOMPDistributeLoop(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002695 void EmitOMPDistributeParallelForDirective(
2696 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002697 void EmitOMPDistributeParallelForSimdDirective(
2698 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002699 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002700 void EmitOMPTargetParallelForSimdDirective(
2701 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002702 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002703 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00002704 void
2705 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00002706 void EmitOMPTeamsDistributeParallelForSimdDirective(
2707 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00002708 void EmitOMPTeamsDistributeParallelForDirective(
2709 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00002710 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00002711 void EmitOMPTargetTeamsDistributeDirective(
2712 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00002713 void EmitOMPTargetTeamsDistributeParallelForDirective(
2714 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00002715 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
2716 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00002717 void EmitOMPTargetTeamsDistributeSimdDirective(
2718 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002719
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00002720 /// Emit device code for the target directive.
2721 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
2722 StringRef ParentName,
2723 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00002724 static void
2725 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2726 const OMPTargetParallelDirective &S);
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00002727 static void
2728 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2729 const OMPTargetTeamsDirective &S);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002730 /// \brief Emit inner loop of the worksharing/simd construct.
2731 ///
2732 /// \param S Directive, for which the inner loop must be emitted.
2733 /// \param RequiresCleanup true, if directive has some associated private
2734 /// variables.
2735 /// \param LoopCond Bollean condition for loop continuation.
2736 /// \param IncExpr Increment expression for loop control variable.
2737 /// \param BodyGen Generator for the inner body of the inner loop.
2738 /// \param PostIncGen Genrator for post-increment code (required for ordered
2739 /// loop directvies).
2740 void EmitOMPInnerLoop(
2741 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2742 const Expr *IncExpr,
2743 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2744 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002745
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002746 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002747 /// Emit initial code for loop counters of loop-based directives.
2748 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2749 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002750
Alexander Musmanc6388682014-12-15 07:07:06 +00002751private:
George Burgess IVe3763372016-12-22 02:50:20 +00002752 /// Helpers for blocks
2753 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
2754
Alexander Musmanc6388682014-12-15 07:07:06 +00002755 /// Helpers for the OpenMP loop directives.
Alexey Bataev0f34da12015-07-02 04:17:07 +00002756 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002757 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002758 void EmitOMPSimdFinal(
2759 const OMPLoopDirective &D,
2760 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev38e89532015-04-16 04:54:05 +00002761 /// \brief Emit code for the worksharing loop-based directive.
2762 /// \return true, if this construct has any lastprivate clause, false -
2763 /// otherwise.
2764 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002765 void EmitOMPOuterLoop(bool IsMonotonic, bool DynamicOrOrdered,
2766 const OMPLoopDirective &S, OMPPrivateScope &LoopScope, bool Ordered,
2767 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00002768 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002769 bool IsMonotonic, const OMPLoopDirective &S,
2770 OMPPrivateScope &LoopScope, bool Ordered, Address LB,
2771 Address UB, Address ST, Address IL,
2772 llvm::Value *Chunk);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00002773 void EmitOMPDistributeOuterLoop(
2774 OpenMPDistScheduleClauseKind ScheduleKind,
2775 const OMPDistributeDirective &S, OMPPrivateScope &LoopScope,
2776 Address LB, Address UB, Address ST, Address IL, llvm::Value *Chunk);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002777 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002778 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002779
2780public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002781
Chris Lattner208ae962007-05-30 17:57:17 +00002782 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002783 // LValue Expression Emission
2784 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002785
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002786 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2787 RValue GetUndefRValue(QualType Ty);
2788
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002789 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2790 /// and issue an ErrorUnsupported style diagnostic (using the
2791 /// provided Name).
2792 RValue EmitUnsupportedRValue(const Expr *E,
2793 const char *Name);
2794
Mike Stumpfc496822009-02-08 23:14:22 +00002795 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2796 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002797 LValue EmitUnsupportedLValue(const Expr *E,
2798 const char *Name);
2799
Chris Lattner8394d792007-06-05 20:53:16 +00002800 /// EmitLValue - Emit code to compute a designator that specifies the location
2801 /// of the expression.
2802 ///
2803 /// This can return one of two things: a simple address or a bitfield
2804 /// reference. In either case, the LLVM Value* in the LValue structure is
2805 /// guaranteed to be an LLVM pointer type.
2806 ///
2807 /// If this returns a bitfield reference, nothing about the pointee type of
2808 /// the LLVM value is known: For example, it may not be a pointer to an
2809 /// integer.
2810 ///
2811 /// If this returns a normal address, and if the lvalue's C type is fixed
2812 /// size, this method guarantees that the returned pointer type will point to
2813 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2814 /// variable length type, this is not possible.
2815 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002816 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002817
Richard Smith4d1458e2012-09-08 02:08:36 +00002818 /// \brief Same as EmitLValue but additionally we generate checking code to
2819 /// guard against undefined behavior. This is only suitable when we know
2820 /// that the address will be used to access the object.
2821 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002822
John McCall7f416cc2015-09-08 08:05:57 +00002823 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002824 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002825
John McCalla8ec7eb2013-03-07 21:37:17 +00002826 void EmitAtomicInit(Expr *E, LValue lvalue);
2827
David Majnemera5b195a2015-02-14 01:35:12 +00002828 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00002829
2830 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2831 AggValueSlot Slot = AggValueSlot::ignored());
2832
Nick Lewycky2d84e842013-10-02 02:29:49 +00002833 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002834 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002835 AggValueSlot slot = AggValueSlot::ignored());
2836
2837 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2838
David Majnemera5b195a2015-02-14 01:35:12 +00002839 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
2840 bool IsVolatile, bool isInit);
2841
Alexey Bataevb4505a72015-03-30 05:20:59 +00002842 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00002843 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00002844 llvm::AtomicOrdering Success =
2845 llvm::AtomicOrdering::SequentiallyConsistent,
2846 llvm::AtomicOrdering Failure =
2847 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00002848 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
2849
Alexey Bataevb4505a72015-03-30 05:20:59 +00002850 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00002851 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00002852 bool IsVolatile);
2853
John McCall3a7f6922010-10-27 20:58:56 +00002854 /// EmitToMemory - Change a scalar value from its value
2855 /// representation to its in-memory representation.
2856 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2857
2858 /// EmitFromMemory - Change a scalar value from its memory
2859 /// representation to its value representation.
2860 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2861
Daniel Dunbar1d425462009-02-10 00:57:50 +00002862 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2863 /// care to appropriately convert from the memory representation to
2864 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002865 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002866 SourceLocation Loc,
John McCall7f416cc2015-09-08 08:05:57 +00002867 AlignmentSource AlignSource =
2868 AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002869 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00002870 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002871 uint64_t TBAAOffset = 0,
2872 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002873
2874 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2875 /// care to appropriately convert from the memory representation to
2876 /// the LLVM value representation. The l-value must be a simple
2877 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002878 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002879
2880 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2881 /// care to appropriately convert from the memory representation to
2882 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00002883 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
2884 bool Volatile, QualType Ty,
2885 AlignmentSource AlignSource = AlignmentSource::Type,
Craig Topper8a13c412014-05-21 05:09:00 +00002886 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00002887 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00002888 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002889
2890 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2891 /// care to appropriately convert from the memory representation to
2892 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002893 /// l-value. The isInit flag indicates whether this is an initialization.
2894 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2895 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002896
Chris Lattner8394d792007-06-05 20:53:16 +00002897 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2898 /// this method emits the address of the lvalue, then loads the result as an
2899 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002900 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00002901 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2902 RValue EmitLoadOfBitfieldLValue(LValue LV);
Renato Golin230c5eb2014-05-19 18:15:42 +00002903 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002904
Chris Lattner8394d792007-06-05 20:53:16 +00002905 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2906 /// lvalue, where both are guaranteed to the have the same type, and that type
2907 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00002908 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00002909 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00002910 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002911
Nick Lewycky2d84e842013-10-02 02:29:49 +00002912 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
2913 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002914 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002915 /// \param Result [out] - If non-null, this will be set to a Value* for the
2916 /// bit-field contents after the store, appropriate for use as the result of
2917 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002918 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00002919 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002920
John McCall4f29b492010-11-16 23:07:28 +00002921 /// Emit an l-value for an assignment (simple or compound) of complex type.
2922 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002923 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00002924 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
2925 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00002926
Chris Lattner57540c52011-04-15 05:22:18 +00002927 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002928 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002929 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002930 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002931 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002932 // Note: only available for agg return types
2933 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002934 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002935 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002936 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002937 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002938 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002939 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2940 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00002941 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
2942 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002943 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002944 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002945 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002946 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002947 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002948 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002949 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002950 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002951 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00002952
John McCall7f416cc2015-09-08 08:05:57 +00002953 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002954
Nick Lewycky2d84e842013-10-02 02:29:49 +00002955 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002956
John McCall7f416cc2015-09-08 08:05:57 +00002957 Address EmitArrayToPointerDecay(const Expr *Array,
2958 AlignmentSource *AlignSource = nullptr);
2959
John McCall71335052012-03-10 03:05:10 +00002960 class ConstantEmission {
2961 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2962 ConstantEmission(llvm::Constant *C, bool isReference)
2963 : ValueAndIsReference(C, isReference) {}
2964 public:
2965 ConstantEmission() {}
2966 static ConstantEmission forReference(llvm::Constant *C) {
2967 return ConstantEmission(C, true);
2968 }
2969 static ConstantEmission forValue(llvm::Constant *C) {
2970 return ConstantEmission(C, false);
2971 }
2972
Aaron Ballman67347662015-02-15 22:00:28 +00002973 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002974 return ValueAndIsReference.getOpaqueValue() != nullptr;
2975 }
John McCall71335052012-03-10 03:05:10 +00002976
2977 bool isReference() const { return ValueAndIsReference.getInt(); }
2978 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2979 assert(isReference());
2980 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2981 refExpr->getType());
2982 }
2983
2984 llvm::Constant *getValue() const {
2985 assert(!isReference());
2986 return ValueAndIsReference.getPointer();
2987 }
2988 };
2989
John McCall113bee02012-03-10 09:33:50 +00002990 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002991
John McCallfe96e0b2011-11-06 09:01:30 +00002992 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2993 AggValueSlot slot = AggValueSlot::ignored());
2994 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2995
Daniel Dunbar722f4242009-04-22 05:08:15 +00002996 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002997 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002998 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00002999 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003000
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003001 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3002 /// if the Field is a reference, this will return the address of the reference
3003 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003004 LValue EmitLValueForFieldInitialization(LValue Base,
3005 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003006
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003007 LValue EmitLValueForIvar(QualType ObjectTy,
3008 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003009 unsigned CVRQualifiers);
3010
Anders Carlsson3be22e22009-05-30 23:23:33 +00003011 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003012 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00003013 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003014 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003015 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003016
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003017 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003018 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003019 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003020 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003021 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003022 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003023
Chris Lattnerd7f58862007-06-02 05:24:33 +00003024 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003025 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003026 //===--------------------------------------------------------------------===//
3027
Mike Stumpfc496822009-02-08 23:14:22 +00003028 /// EmitCall - Generate a call of the given function, expecting the given
3029 /// result type, and using the given argument list which specifies both the
3030 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003031 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003032 ReturnValueSlot ReturnValue, const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00003033 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003034
John McCallb92ab1a2016-10-26 23:46:34 +00003035 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003036 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00003037 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003038 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003039 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003040 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3041 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003042
Eric Christopherc7e79db2015-11-12 00:44:04 +00003043 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003044
John McCall882987f2013-02-28 19:01:20 +00003045 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3046 const Twine &name = "");
3047 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3048 ArrayRef<llvm::Value*> args,
3049 const Twine &name = "");
3050 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3051 const Twine &name = "");
3052 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3053 ArrayRef<llvm::Value*> args,
3054 const Twine &name = "");
3055
John McCallbd309292010-07-06 01:34:17 +00003056 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003057 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00003058 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00003059 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3060 ArrayRef<llvm::Value*> args,
3061 const Twine &name = "");
3062 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3063 const Twine &name = "");
3064 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3065 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00003066
John McCallb92ab1a2016-10-26 23:46:34 +00003067 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
3068 NestedNameSpecifier *Qual,
3069 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00003070
John McCallb92ab1a2016-10-26 23:46:34 +00003071 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
3072 CXXDtorType Type,
3073 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003074
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003075 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003076 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3077 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003078 ReturnValueSlot ReturnValue, llvm::Value *This,
3079 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003080 QualType ImplicitParamTy, const CallExpr *E,
3081 CallArgList *RtlArgs);
John McCallb92ab1a2016-10-26 23:46:34 +00003082 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3083 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003084 llvm::Value *This, llvm::Value *ImplicitParam,
3085 QualType ImplicitParamTy, const CallExpr *E,
3086 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003087 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3088 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003089 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3090 const CXXMethodDecl *MD,
3091 ReturnValueSlot ReturnValue,
3092 bool HasQualifier,
3093 NestedNameSpecifier *Qualifier,
3094 bool IsArrow, const Expr *Base);
3095 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003096 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3097 llvm::Value *memberPtr,
3098 const MemberPointerType *memberPtrType,
3099 AlignmentSource *AlignSource = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003100 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3101 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003102
Anders Carlsson4034a952009-05-27 04:18:27 +00003103 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003104 const CXXMethodDecl *MD,
3105 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003106 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003107
Peter Collingbournefe883422011-10-06 18:29:37 +00003108 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3109 ReturnValueSlot ReturnValue);
3110
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003111 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3112 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003113
Mike Stump11289f42009-09-09 15:08:12 +00003114 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00003115 unsigned BuiltinID, const CallExpr *E,
3116 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003117
Anders Carlssonbfb36712009-12-24 21:13:40 +00003118 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003119
Mike Stumpfc496822009-02-08 23:14:22 +00003120 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3121 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003122 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3123
Kevin Qin1718af62013-11-14 02:45:18 +00003124 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3125 const llvm::CmpInst::Predicate Fp,
3126 const llvm::CmpInst::Predicate Ip,
3127 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00003128 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00003129
3130 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3131 unsigned LLVMIntrinsic,
3132 unsigned AltLLVMIntrinsic,
3133 const char *NameHint,
3134 unsigned Modifier,
3135 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003136 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00003137 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00003138 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3139 unsigned Modifier, llvm::Type *ArgTy,
3140 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003141 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003142 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003143 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003144 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003145 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003146 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003147 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003148 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3149 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003150 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00003151 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003152
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003153 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003154 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3155 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003156 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003157 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003158 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003159 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3160 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003161
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003162private:
3163 enum class MSVCIntrin;
3164
3165public:
3166 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3167
Daniel Dunbar66912a12008-08-20 00:28:19 +00003168 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003169 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003170 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003171 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3172 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3173 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003174 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003175 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003176 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3177 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003178
John McCall31168b02011-06-15 23:02:42 +00003179 /// Retrieves the default cleanup kind for an ARC cleanup.
3180 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3181 CleanupKind getARCCleanupKind() {
3182 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3183 ? NormalAndEHCleanup : NormalCleanup;
3184 }
3185
3186 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003187 void EmitARCInitWeak(Address addr, llvm::Value *value);
3188 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003189 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003190 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3191 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3192 void EmitARCCopyWeak(Address dst, Address src);
3193 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003194 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3195 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003196 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003197 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003198 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003199 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003200 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003201 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003202 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003203 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003204 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003205 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003206 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3207 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3208 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003209 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003210
3211 std::pair<LValue,llvm::Value*>
3212 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3213 std::pair<LValue,llvm::Value*>
3214 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003215 std::pair<LValue,llvm::Value*>
3216 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003217
John McCall248512a2011-10-01 10:32:24 +00003218 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003219 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3220 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3221
John McCallff613032011-10-04 06:23:45 +00003222 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003223 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3224 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003225 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3226 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003227 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003228
Craig Topper00bbdcf2014-06-28 23:22:23 +00003229 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003230
John McCall82fe67b2011-07-09 01:37:26 +00003231 static Destroyer destroyARCStrongImprecise;
3232 static Destroyer destroyARCStrongPrecise;
3233 static Destroyer destroyARCWeak;
3234
John McCall31168b02011-06-15 23:02:42 +00003235 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3236 llvm::Value *EmitObjCAutoreleasePoolPush();
3237 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3238 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3239 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3240
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003241 /// \brief Emits a reference binding to the passed in expression.
3242 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003243
Chris Lattner6278e6a2007-08-11 00:04:45 +00003244 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003245 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003246 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003247
3248 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003249
3250 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3251 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003252 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003253
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003254 /// Emit a conversion from the specified type to the specified destination
3255 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003256 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003257 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003258
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003259 /// Emit a conversion from the specified complex type to the specified
3260 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003261 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003262 QualType DstTy,
3263 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003264
John McCall7a626f62010-09-15 10:14:12 +00003265 /// EmitAggExpr - Emit the computation of the specified expression
3266 /// of aggregate type. The result is computed into the given slot,
3267 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003268 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003269
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003270 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3271 /// aggregate type into a temporary LValue.
3272 LValue EmitAggExprToLValue(const Expr *E);
3273
John McCall1bd25562011-06-24 23:21:27 +00003274 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3275 /// make sure it survives garbage collection until this point.
3276 void EmitExtendGCLifetime(llvm::Value *object);
3277
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003278 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003279 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003280 ComplexPairTy EmitComplexExpr(const Expr *E,
3281 bool IgnoreReal = false,
3282 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003283
John McCall47fb9502013-03-07 21:37:08 +00003284 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3285 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003286 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003287
John McCall47fb9502013-03-07 21:37:08 +00003288 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003289 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003290
3291 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003292 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003293
John McCall7f416cc2015-09-08 08:05:57 +00003294 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3295 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3296
Chandler Carruth84537952012-03-30 19:44:53 +00003297 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3298 /// global variable that has already been created for it. If the initializer
3299 /// has a different type than GV does, this may free GV and return a different
3300 /// one. Otherwise it just returns GV.
3301 llvm::GlobalVariable *
3302 AddInitializerToStaticVarDecl(const VarDecl &D,
3303 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003304
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003305
Anders Carlssonf40886a2009-08-08 21:45:14 +00003306 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3307 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003308 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3309 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003310
David Majnemerb3341ea2014-10-05 05:05:40 +00003311 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3312 llvm::Constant *Addr);
3313
John McCallc84ed6a2012-05-01 06:13:13 +00003314 /// Call atexit() with a function that passes the given argument to
3315 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003316 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3317 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003318
John McCallcdf7ef52010-11-06 09:44:32 +00003319 /// Emit code in this function to perform a guarded variable
3320 /// initialization. Guarded initializations are used when it's not
3321 /// possible to prove that an initialization will be done exactly
3322 /// once, e.g. with a static local variable or a static data member
3323 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003324 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003325 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003326
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003327 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3328 /// variables.
3329 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003330 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003331 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003332
John McCallee08c532012-04-06 18:21:03 +00003333 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003334 /// variables.
John McCallee08c532012-04-06 18:21:03 +00003335 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
3336 const std::vector<std::pair<llvm::WeakVH,
3337 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003338
John McCalla738c252011-03-09 04:27:21 +00003339 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3340 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003341 llvm::GlobalVariable *Addr,
3342 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003343
John McCall7a626f62010-09-15 10:14:12 +00003344 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00003345
John McCall7f416cc2015-09-08 08:05:57 +00003346 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003347
John McCall08ef4662011-11-10 08:15:53 +00003348 void enterFullExpression(const ExprWithCleanups *E) {
3349 if (E->getNumObjects() == 0) return;
3350 enterNonTrivialFullExpression(E);
3351 }
3352 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003353
Richard Smithea852322013-05-07 21:53:22 +00003354 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003355
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003356 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3357
Tim Northovercc2a6e02015-11-09 19:56:35 +00003358 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003359
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003360 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003361 // Annotations Emission
3362 //===--------------------------------------------------------------------===//
3363
3364 /// Emit an annotation call (intrinsic or builtin).
3365 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3366 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003367 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003368 SourceLocation Location);
3369
3370 /// Emit local annotations for the local variable V, declared by D.
3371 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3372
3373 /// Emit field annotations for the given field & value. Returns the
3374 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003375 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003376
3377 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003378 // Internal Helpers
3379 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003380
Chris Lattner5b1964b2008-11-11 07:41:27 +00003381 /// ContainsLabel - Return true if the statement contains a label in it. If
3382 /// this statement is not executed normally, it not containing a label means
3383 /// that we can just remove the code.
3384 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003385
Chris Lattner29911cc2011-02-28 00:18:40 +00003386 /// containsBreak - Return true if the statement contains a break out of it.
3387 /// If the statement (recursively) contains a switch or loop with a break
3388 /// inside of it, this is fine.
3389 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003390
3391 /// Determine if the given statement might introduce a declaration into the
3392 /// current scope, by being a (possibly-labelled) DeclStmt.
3393 static bool mightAddDeclToScope(const Stmt *S);
Chris Lattner29911cc2011-02-28 00:18:40 +00003394
Daniel Dunbar682712c2008-11-12 10:12:14 +00003395 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003396 /// to a constant, or if it does but contains a label, return false. If it
3397 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003398 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3399 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003400
Chris Lattner29911cc2011-02-28 00:18:40 +00003401 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3402 /// to a constant, or if it does but contains a label, return false. If it
3403 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003404 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3405 bool AllowLabels = false);
3406
Chris Lattnercd439292008-11-12 08:04:58 +00003407 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3408 /// if statement) to the specified blocks. Based on the condition, this might
3409 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003410 /// TrueCount should be the number of times we expect the condition to
3411 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003412 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003413 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003414
Richard Smithe30752c2012-10-09 19:52:38 +00003415 /// \brief Emit a description of a type in a format suitable for passing to
3416 /// a runtime sanitizer handler.
3417 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3418
3419 /// \brief Convert a value into a format suitable for passing to a runtime
3420 /// sanitizer handler.
3421 llvm::Value *EmitCheckValue(llvm::Value *V);
3422
3423 /// \brief Emit a description of a source location in a format suitable for
3424 /// passing to a runtime sanitizer handler.
3425 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3426
Richard Smithde670682012-11-01 22:15:34 +00003427 /// \brief Create a basic block that will call a handler function in a
3428 /// sanitizer runtime with the provided arguments, and create a conditional
3429 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003430 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00003431 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003432 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003433
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003434 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3435 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003436 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3437 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3438 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003439
Richard Smithde670682012-11-01 22:15:34 +00003440 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3441 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003442 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003443
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003444 /// \brief Emit a call to trap or debugtrap and attach function attribute
3445 /// "trap-func-name" if specified.
3446 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3447
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003448 /// \brief Emit a cross-DSO CFI failure handling function.
3449 void EmitCfiCheckFail();
3450
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003451 /// \brief Create a check for a function parameter that may potentially be
3452 /// declared as non-null.
3453 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
3454 const FunctionDecl *FD, unsigned ParmNum);
3455
Anders Carlsson093bdff2010-03-30 03:27:09 +00003456 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003457 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003458
John McCall23f66262010-05-26 22:34:26 +00003459 /// EmitDelegateCallArg - We are performing a delegate call; that
3460 /// is, the current function is delegating to another one. Produce
3461 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003462 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3463 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003464
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003465 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3466 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003467 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003468
Chris Lattnercd439292008-11-12 08:04:58 +00003469private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003470 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003471 void EmitReturnOfRValue(RValue RV, QualType Ty);
3472
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003473 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3474
3475 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3476 DeferredReplacements;
3477
John McCall7f416cc2015-09-08 08:05:57 +00003478 /// Set the address of a local variable.
3479 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3480 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3481 LocalDeclMap.insert({VD, Addr});
3482 }
3483
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003484 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3485 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3486 ///
3487 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003488 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003489 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003490
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003491 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3492 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3493 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3494 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3495 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3496 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003497
Chad Rosier59df25b2012-08-23 20:00:18 +00003498 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003499 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003500
Chad Rosier59df25b2012-08-23 20:00:18 +00003501 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003502 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003503 std::string &ConstraintStr,
3504 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003505
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003506 /// \brief Attempts to statically evaluate the object size of E. If that
3507 /// fails, emits code to figure the size of E out for us. This is
3508 /// pass_object_size aware.
3509 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
3510 llvm::IntegerType *ResType);
3511
3512 /// \brief Emits the size of E, as required by __builtin_object_size. This
3513 /// function is aware of pass_object_size parameters, and will act accordingly
3514 /// if E is a parameter with the pass_object_size attribute.
3515 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
3516 llvm::IntegerType *ResType);
3517
Reid Kleckner89077a12013-12-17 19:46:40 +00003518public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003519#ifndef NDEBUG
3520 // Determine whether the given argument is an Objective-C method
3521 // that may have type parameters in its signature.
3522 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3523 const DeclContext *dc = method->getDeclContext();
3524 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3525 return classDecl->getTypeParamListAsWritten();
3526 }
3527
3528 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3529 return catDecl->getTypeParamList();
3530 }
3531
3532 return false;
3533 }
3534
3535 template<typename T>
3536 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3537#endif
3538
Richard Smitha560ccf2016-09-29 21:30:12 +00003539 enum class EvaluationOrder {
3540 ///! No language constraints on evaluation order.
3541 Default,
3542 ///! Language semantics require left-to-right evaluation.
3543 ForceLeftToRight,
3544 ///! Language semantics require right-to-left evaluation.
3545 ForceRightToLeft
3546 };
3547
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003548 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003549 template <typename T>
3550 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003551 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003552 const FunctionDecl *CalleeDecl = nullptr,
Richard Smith762672a2016-09-28 19:09:10 +00003553 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003554 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003555 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003556 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003557
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003558 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3559 "Can't skip parameters if type info is not provided");
3560 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003561#ifndef NDEBUG
3562 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3563#endif
3564
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003565 // First, use the argument types that the type info knows about
3566 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3567 E = CallArgTypeInfo->param_type_end();
3568 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003569 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003570 assert((isGenericMethod ||
3571 ((*I)->isVariablyModifiedType() ||
3572 (*I).getNonReferenceType()->isObjCRetainableType() ||
3573 getContext()
3574 .getCanonicalType((*I).getNonReferenceType())
3575 .getTypePtr() ==
3576 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003577 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003578 .getTypePtr())) &&
3579 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003580 ArgTypes.push_back(*I);
3581 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003582 }
Mike Stump11289f42009-09-09 15:08:12 +00003583
Reid Kleckner739756c2013-12-04 19:23:12 +00003584 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003585 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003586 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3587 CallArgTypeInfo->isVariadic()) &&
3588 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003589
Anders Carlsson603d6af2009-04-18 20:20:22 +00003590 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003591 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00003592 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003593
Richard Smitha560ccf2016-09-29 21:30:12 +00003594 EmitCallArgs(Args, ArgTypes, ArgRange, CalleeDecl, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003595 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003596
Reid Kleckner739756c2013-12-04 19:23:12 +00003597 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003598 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003599 const FunctionDecl *CalleeDecl = nullptr,
Richard Smith762672a2016-09-28 19:09:10 +00003600 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003601 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00003602
John McCall7f416cc2015-09-08 08:05:57 +00003603 /// EmitPointerWithAlignment - Given an expression with a pointer
3604 /// type, emit the value and compute our best estimate of the
3605 /// alignment of the pointee.
3606 ///
3607 /// Note that this function will conservatively fall back on the type
3608 /// when it doesn't
3609 ///
3610 /// \param Source - If non-null, this will be initialized with
3611 /// information about the source of the alignment. Note that this
3612 /// function will conservatively fall back on the type when it
3613 /// doesn't recognize the expression, which means that sometimes
3614 ///
3615 /// a worst-case One
3616 /// reasonable way to use this information is when there's a
3617 /// language guarantee that the pointer must be aligned to some
3618 /// stricter value, and we're simply trying to ensure that
3619 /// sufficiently obvious uses of under-aligned objects don't get
3620 /// miscompiled; for example, a placement new into the address of
3621 /// a local variable. In such a case, it's quite reasonable to
3622 /// just ignore the returned alignment when it isn't from an
3623 /// explicit source.
3624 Address EmitPointerWithAlignment(const Expr *Addr,
3625 AlignmentSource *Source = nullptr);
3626
Peter Collingbournedc134532016-01-16 00:31:22 +00003627 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3628
Reid Kleckner89077a12013-12-17 19:46:40 +00003629private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003630 QualType getVarArgType(const Expr *Arg);
3631
John McCalld4f4b7f2010-03-03 04:15:11 +00003632 const TargetCodeGenInfo &getTargetHooks() const {
3633 return CGM.getTargetCodeGenInfo();
3634 }
John McCall09ae0322010-07-06 23:57:41 +00003635
3636 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003637
John McCall7f416cc2015-09-08 08:05:57 +00003638 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3639 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003640
3641 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003642
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003643 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003644};
Mike Stump11289f42009-09-09 15:08:12 +00003645
John McCallce1de612011-01-26 04:00:11 +00003646/// Helper class with most of the code for saving a value for a
3647/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003648struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003649 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3650
3651 /// Answer whether the given value needs extra work to be saved.
3652 static bool needsSaving(llvm::Value *value) {
3653 // If it's not an instruction, we don't need to save.
3654 if (!isa<llvm::Instruction>(value)) return false;
3655
3656 // If it's an instruction in the entry block, we don't need to save.
3657 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3658 return (block != &block->getParent()->getEntryBlock());
3659 }
3660
3661 /// Try to save the given value.
3662 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3663 if (!needsSaving(value)) return saved_type(value, false);
3664
John McCall7f416cc2015-09-08 08:05:57 +00003665 // Otherwise, we need an alloca.
3666 auto align = CharUnits::fromQuantity(
3667 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3668 Address alloca =
3669 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003670 CGF.Builder.CreateStore(value, alloca);
3671
John McCall7f416cc2015-09-08 08:05:57 +00003672 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003673 }
3674
3675 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003676 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003677 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003678
3679 // Otherwise, it should be an alloca instruction, as set up in save().
3680 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3681 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003682 }
3683};
3684
John McCallcb5f77f2011-01-28 10:53:53 +00003685/// A partial specialization of DominatingValue for llvm::Values that
3686/// might be llvm::Instructions.
3687template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3688 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003689 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003690 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3691 }
3692};
3693
John McCall7f416cc2015-09-08 08:05:57 +00003694/// A specialization of DominatingValue for Address.
3695template <> struct DominatingValue<Address> {
3696 typedef Address type;
3697
3698 struct saved_type {
3699 DominatingLLVMValue::saved_type SavedValue;
3700 CharUnits Alignment;
3701 };
3702
3703 static bool needsSaving(type value) {
3704 return DominatingLLVMValue::needsSaving(value.getPointer());
3705 }
3706 static saved_type save(CodeGenFunction &CGF, type value) {
3707 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3708 value.getAlignment() };
3709 }
3710 static type restore(CodeGenFunction &CGF, saved_type value) {
3711 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3712 value.Alignment);
3713 }
3714};
3715
John McCallcb5f77f2011-01-28 10:53:53 +00003716/// A specialization of DominatingValue for RValue.
3717template <> struct DominatingValue<RValue> {
3718 typedef RValue type;
3719 class saved_type {
3720 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3721 AggregateAddress, ComplexAddress };
3722
3723 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003724 unsigned K : 3;
3725 unsigned Align : 29;
3726 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3727 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003728
3729 public:
3730 static bool needsSaving(RValue value);
3731 static saved_type save(CodeGenFunction &CGF, RValue value);
3732 RValue restore(CodeGenFunction &CGF);
3733
John McCall7f416cc2015-09-08 08:05:57 +00003734 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003735 };
3736
3737 static bool needsSaving(type value) {
3738 return saved_type::needsSaving(value);
3739 }
3740 static saved_type save(CodeGenFunction &CGF, type value) {
3741 return saved_type::save(CGF, value);
3742 }
3743 static type restore(CodeGenFunction &CGF, saved_type value) {
3744 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003745 }
3746};
3747
Chris Lattnerbed31442007-05-28 01:07:47 +00003748} // end namespace CodeGen
3749} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003750
Chris Lattnerbed31442007-05-28 01:07:47 +00003751#endif