blob: c87e4d15c5e645090014d7815de87d068e01d58e [file] [log] [blame]
Daniel Dunbar9c426522008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Chris Lattnerbed31442007-05-28 01:07:47 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattnerbed31442007-05-28 01:07:47 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stumpfc496822009-02-08 23:14:22 +000010// This is the internal per-function state used for llvm translation.
Chris Lattnerbed31442007-05-28 01:07:47 +000011//
12//===----------------------------------------------------------------------===//
13
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000014#ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
15#define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
Chris Lattnerbed31442007-05-28 01:07:47 +000016
Daniel Dunbarcb463852008-11-01 01:53:16 +000017#include "CGBuilder.h"
Eric Christophera9d34972011-10-19 00:43:52 +000018#include "CGDebugInfo.h"
Alexander Musman515ad8c2014-05-22 08:54:05 +000019#include "CGLoopInfo.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000020#include "CGValue.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "CodeGenModule.h"
Justin Bogneref512b92014-01-06 22:27:43 +000022#include "CodeGenPGO.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000023#include "EHScopeStack.h"
Vitaly Buka64c80b42016-10-26 05:42:30 +000024#include "VarBypassDetector.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000025#include "clang/AST/CharUnits.h"
26#include "clang/AST/ExprCXX.h"
27#include "clang/AST/ExprObjC.h"
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +000028#include "clang/AST/ExprOpenMP.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000029#include "clang/AST/Type.h"
30#include "clang/Basic/ABI.h"
Ben Langmuir3b4c30b2013-05-09 19:17:11 +000031#include "clang/Basic/CapturedStmt.h"
Alexander Musmandf7a8e22015-01-22 08:49:35 +000032#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000033#include "clang/Basic/TargetInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000034#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000035#include "llvm/ADT/ArrayRef.h"
36#include "llvm/ADT/DenseMap.h"
37#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000038#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000039#include "llvm/Support/Debug.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000040#include "llvm/Transforms/Utils/SanitizerStats.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000041
Chris Lattnerbed31442007-05-28 01:07:47 +000042namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000043class BasicBlock;
44class LLVMContext;
45class MDNode;
46class Module;
47class SwitchInst;
48class Twine;
49class Value;
50class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000051}
52
Chris Lattnerbed31442007-05-28 01:07:47 +000053namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000054class ASTContext;
55class BlockDecl;
56class CXXDestructorDecl;
57class CXXForRangeStmt;
58class CXXTryStmt;
59class Decl;
60class LabelDecl;
61class EnumConstantDecl;
62class FunctionDecl;
63class FunctionProtoType;
64class LabelStmt;
65class ObjCContainerDecl;
66class ObjCInterfaceDecl;
67class ObjCIvarDecl;
68class ObjCMethodDecl;
69class ObjCImplementationDecl;
70class ObjCPropertyImplDecl;
71class TargetInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000072class VarDecl;
73class ObjCForCollectionStmt;
74class ObjCAtTryStmt;
75class ObjCAtThrowStmt;
76class ObjCAtSynchronizedStmt;
77class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000078
Chris Lattnerbed31442007-05-28 01:07:47 +000079namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000080class CodeGenTypes;
John McCallb92ab1a2016-10-26 23:46:34 +000081class CGCallee;
Rafael Espindola42ae7452014-05-09 00:57:59 +000082class CGFunctionInfo;
83class CGRecordLayout;
84class CGBlockInfo;
85class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000086class BlockByrefHelpers;
87class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000088class BlockFlags;
89class BlockFieldFlags;
Alexey Bataev7292c292016-04-25 12:22:29 +000090class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000091class TargetCodeGenInfo;
Alexey Bataev24b5bae2016-04-28 09:23:51 +000092struct OMPTaskDataTy;
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000093struct CGCoroData;
Mike Stumpfc496822009-02-08 23:14:22 +000094
John McCall47fb9502013-03-07 21:37:08 +000095/// The kind of evaluation to perform on values of a particular
96/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
97/// CGExprAgg?
98///
99/// TODO: should vectors maybe be split out into their own thing?
100enum TypeEvaluationKind {
101 TEK_Scalar,
102 TEK_Complex,
103 TEK_Aggregate
104};
105
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000106#define LIST_SANITIZER_CHECKS \
107 SANITIZER_CHECK(AddOverflow, add_overflow, 0) \
108 SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \
109 SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \
110 SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \
111 SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \
112 SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \
113 SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0) \
Vedant Kumar10c31022017-07-29 00:19:51 +0000114 SANITIZER_CHECK(InvalidBuiltin, invalid_builtin, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000115 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
116 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
117 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
118 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000119 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000120 SANITIZER_CHECK(NullabilityReturn, nullability_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000121 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000122 SANITIZER_CHECK(NonnullReturn, nonnull_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000123 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
Vedant Kumara125eb52017-06-01 19:22:18 +0000124 SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000125 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
126 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
Filipe Cabecinhasfe5e5af2017-01-06 14:40:12 +0000127 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000128 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
129
130enum SanitizerHandler {
131#define SANITIZER_CHECK(Enum, Name, Version) Enum,
132 LIST_SANITIZER_CHECKS
133#undef SANITIZER_CHECK
134};
135
Chris Lattnerbed31442007-05-28 01:07:47 +0000136/// CodeGenFunction - This class organizes the per-function state that is used
137/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000138class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000139 CodeGenFunction(const CodeGenFunction &) = delete;
140 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000141
142 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000143public:
John McCallad5d61e2010-07-23 21:56:41 +0000144 /// A jump destination is an abstract label, branching to which may
145 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000146 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000147 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000148 JumpDest(llvm::BasicBlock *Block,
149 EHScopeStack::stable_iterator Depth,
150 unsigned Index)
151 : Block(Block), ScopeDepth(Depth), Index(Index) {}
152
Craig Topper8a13c412014-05-21 05:09:00 +0000153 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000154 llvm::BasicBlock *getBlock() const { return Block; }
155 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
156 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000157
Nadav Rotem1da30942013-03-23 06:43:35 +0000158 // This should be used cautiously.
159 void setScopeDepth(EHScopeStack::stable_iterator depth) {
160 ScopeDepth = depth;
161 }
162
John McCallad5d61e2010-07-23 21:56:41 +0000163 private:
John McCallbd309292010-07-06 01:34:17 +0000164 llvm::BasicBlock *Block;
165 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000166 unsigned Index;
167 };
168
Chris Lattnerbed31442007-05-28 01:07:47 +0000169 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000170 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000171
Chris Lattner96d72562007-08-21 16:57:55 +0000172 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000173 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000174 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000175
Vitaly Buka64c80b42016-10-26 05:42:30 +0000176 // Stores variables for which we can't generate correct lifetime markers
177 // because of jumps.
178 VarBypassDetector Bypasses;
179
Carlo Bertollib0ff0a62017-04-25 17:52:12 +0000180 // CodeGen lambda for loops and support for ordered clause
181 typedef llvm::function_ref<void(CodeGenFunction &, const OMPLoopDirective &,
182 JumpDest)>
183 CodeGenLoopTy;
184 typedef llvm::function_ref<void(CodeGenFunction &, SourceLocation,
185 const unsigned, const bool)>
186 CodeGenOrderedTy;
187
188 // Codegen lambda for loop bounds in worksharing loop constructs
189 typedef llvm::function_ref<std::pair<LValue, LValue>(
190 CodeGenFunction &, const OMPExecutableDirective &S)>
191 CodeGenLoopBoundsTy;
192
193 // Codegen lambda for loop bounds in dispatch-based loop implementation
194 typedef llvm::function_ref<std::pair<llvm::Value *, llvm::Value *>(
195 CodeGenFunction &, const OMPExecutableDirective &S, Address LB,
196 Address UB)>
197 CodeGenDispatchBoundsTy;
198
Alexander Musman515ad8c2014-05-22 08:54:05 +0000199 /// \brief CGBuilder insert helper. This function is called after an
200 /// instruction is created using Builder.
201 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
202 llvm::BasicBlock *BB,
203 llvm::BasicBlock::iterator InsertPt) const;
204
John McCalldec348f72013-05-03 07:33:41 +0000205 /// CurFuncDecl - Holds the Decl for the current outermost
206 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000207 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000208 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
209 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000210 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000211 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000212 llvm::Function *CurFn;
213
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000214 // Holds coroutine data if the current function is a coroutine. We use a
215 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
216 // in this header.
217 struct CGCoroInfo {
218 std::unique_ptr<CGCoroData> Data;
219 CGCoroInfo();
220 ~CGCoroInfo();
221 };
222 CGCoroInfo CurCoro;
223
Mike Stumpbee78dd2009-12-04 23:26:17 +0000224 /// CurGD - The GlobalDecl for the current function being compiled.
225 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000226
John McCall31168b02011-06-15 23:02:42 +0000227 /// PrologueCleanupDepth - The cleanup depth enclosing all the
228 /// cleanups associated with the parameters.
229 EHScopeStack::stable_iterator PrologueCleanupDepth;
230
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000231 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000232 JumpDest ReturnBlock;
233
John McCall7f416cc2015-09-08 08:05:57 +0000234 /// ReturnValue - The temporary alloca to hold the return
235 /// value. This is invalid iff the function has no return value.
236 Address ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000237
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000238 /// Return true if a label was seen in the current scope.
239 bool hasLabelBeenSeenInCurrentScope() const {
240 if (CurLexicalScope)
241 return CurLexicalScope->hasLabels();
242 return !LabelMap.empty();
243 }
244
Chris Lattner03df1222007-06-02 04:53:11 +0000245 /// AllocaInsertPoint - This is an instruction in the entry block before which
246 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000247 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000248
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000249 /// \brief API for captured statement code generation.
250 class CGCapturedStmtInfo {
251 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000252 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
253 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000254 explicit CGCapturedStmtInfo(const CapturedStmt &S,
255 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000256 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000257
258 RecordDecl::field_iterator Field =
259 S.getCapturedRecordDecl()->field_begin();
260 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
261 E = S.capture_end();
262 I != E; ++I, ++Field) {
263 if (I->capturesThis())
264 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000265 else if (I->capturesVariable())
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000266 CaptureFields[I->getCapturedVar()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000267 else if (I->capturesVariableByCopy())
268 CaptureFields[I->getCapturedVar()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000269 }
270 }
271
272 virtual ~CGCapturedStmtInfo();
273
274 CapturedRegionKind getKind() const { return Kind; }
275
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000276 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000277 // \brief Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000278 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000279
280 /// \brief Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000281 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000282 return CaptureFields.lookup(VD);
283 }
284
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000285 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
286 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000287
Alexey Bataev18095712014-10-10 12:19:54 +0000288 static bool classof(const CGCapturedStmtInfo *) {
289 return true;
290 }
291
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000292 /// \brief Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000293 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000294 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000295 CGF.EmitStmt(S);
296 }
297
298 /// \brief Get the name of the capture helper.
299 virtual StringRef getHelperName() const { return "__captured_stmt"; }
300
301 private:
302 /// \brief The kind of captured statement being generated.
303 CapturedRegionKind Kind;
304
305 /// \brief Keep the map between VarDecl and FieldDecl.
306 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
307
308 /// \brief The base address of the captured record, passed in as the first
309 /// argument of the parallel region function.
310 llvm::Value *ThisValue;
311
312 /// \brief Captured 'this' type.
313 FieldDecl *CXXThisFieldDecl;
314 };
315 CGCapturedStmtInfo *CapturedStmtInfo;
316
Alexey Bataevd157d472015-06-24 03:35:38 +0000317 /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
318 class CGCapturedStmtRAII {
319 private:
320 CodeGenFunction &CGF;
321 CGCapturedStmtInfo *PrevCapturedStmtInfo;
322 public:
323 CGCapturedStmtRAII(CodeGenFunction &CGF,
324 CGCapturedStmtInfo *NewCapturedStmtInfo)
325 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
326 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
327 }
328 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
329 };
330
Vedant Kumared00ea02017-03-06 05:28:22 +0000331 /// An abstract representation of regular/ObjC call/message targets.
332 class AbstractCallee {
333 /// The function declaration of the callee.
334 const Decl *CalleeDecl;
335
336 public:
337 AbstractCallee() : CalleeDecl(nullptr) {}
338 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
339 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
340 bool hasFunctionDecl() const {
341 return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
342 }
343 const Decl *getDecl() const { return CalleeDecl; }
344 unsigned getNumParams() const {
345 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
346 return FD->getNumParams();
347 return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
348 }
349 const ParmVarDecl *getParamDecl(unsigned I) const {
350 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
351 return FD->getParamDecl(I);
352 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
353 }
354 };
355
Alexey Samsonova0416102014-11-11 01:26:14 +0000356 /// \brief Sanitizers enabled for this function.
357 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000358
Alexey Samsonov24cad992014-07-17 18:46:27 +0000359 /// \brief True if CodeGen currently emits code implementing sanitizer checks.
360 bool IsSanitizerScope;
361
362 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
363 class SanitizerScope {
364 CodeGenFunction *CGF;
365 public:
366 SanitizerScope(CodeGenFunction *CGF);
367 ~SanitizerScope();
368 };
369
Reid Kleckner19819442014-07-25 21:39:46 +0000370 /// In C++, whether we are code generating a thunk. This controls whether we
371 /// should emit cleanups.
372 bool CurFuncIsThunk;
373
John McCall31168b02011-06-15 23:02:42 +0000374 /// In ARC, whether we should autorelease the return value.
375 bool AutoreleaseResult;
376
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000377 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
378 /// potentially set the return value.
379 bool SawAsmBlock;
380
David Majnemer25eb1652016-03-01 19:42:53 +0000381 const FunctionDecl *CurSEHParent = nullptr;
382
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000383 /// True if the current function is an outlined SEH helper. This can be a
384 /// finally block or filter expression.
385 bool IsOutlinedSEHHelper;
386
John McCallad7c5c12011-02-08 08:22:06 +0000387 const CodeGen::CGBlockInfo *BlockInfo;
388 llvm::Value *BlockPointer;
389
Eli Friedman9fbeba02012-02-11 02:57:39 +0000390 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
391 FieldDecl *LambdaThisCaptureField;
392
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000393 /// \brief A mapping from NRVO variables to the flags used to indicate
394 /// when the NRVO has been applied to this variable.
395 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000396
John McCallbd309292010-07-06 01:34:17 +0000397 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000398 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000399 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000400
David Majnemer4e52d6f2015-12-12 05:39:21 +0000401 llvm::Instruction *CurrentFuncletPad = nullptr;
402
Tim Shen421119f2016-07-01 21:08:47 +0000403 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
404 llvm::Value *Addr;
405 llvm::Value *Size;
406
407 public:
408 CallLifetimeEnd(Address addr, llvm::Value *size)
409 : Addr(addr.getPointer()), Size(size) {}
410
411 void Emit(CodeGenFunction &CGF, Flags flags) override {
412 CGF.EmitLifetimeEnd(Size, Addr);
413 }
414 };
415
Richard Smith736a9472013-06-12 20:42:33 +0000416 /// Header for data within LifetimeExtendedCleanupStack.
417 struct LifetimeExtendedCleanupHeader {
418 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000419 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000420 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Justin Bognerbdff2192015-07-01 00:59:27 +0000421 CleanupKind Kind;
Richard Smith736a9472013-06-12 20:42:33 +0000422
Justin Bognerbdff2192015-07-01 00:59:27 +0000423 size_t getSize() const { return Size; }
424 CleanupKind getKind() const { return Kind; }
Richard Smith736a9472013-06-12 20:42:33 +0000425 };
John McCallbd309292010-07-06 01:34:17 +0000426
John McCallad5d61e2010-07-23 21:56:41 +0000427 /// i32s containing the indexes of the cleanup destinations.
428 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000429
430 unsigned NextCleanupDestIndex;
431
John McCall08ef4662011-11-10 08:15:53 +0000432 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
433 CGBlockInfo *FirstBlockInfo;
434
John McCall8e4c74b2011-08-11 02:22:43 +0000435 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
436 llvm::BasicBlock *EHResumeBlock;
437
Bill Wendlingf0724e82011-09-19 20:31:14 +0000438 /// The exception slot. All landing pads write the current exception pointer
439 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000440 llvm::Value *ExceptionSlot;
441
Bill Wendlingf0724e82011-09-19 20:31:14 +0000442 /// The selector slot. Under the MandatoryCleanup model, all landing pads
443 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000444 llvm::AllocaInst *EHSelectorSlot;
445
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000446 /// A stack of exception code slots. Entering an __except block pushes a slot
447 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
448 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000449 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000450
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000451 /// Value returned by __exception_info intrinsic.
452 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000453
John McCallbd309292010-07-06 01:34:17 +0000454 /// Emits a landing pad for the current EH stack.
455 llvm::BasicBlock *EmitLandingPad();
456
457 llvm::BasicBlock *getInvokeDestImpl();
458
John McCallce1de612011-01-26 04:00:11 +0000459 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000460 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
461 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000462 }
463
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000464public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000465 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
466 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000467 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000468
John McCall6b0feb72011-06-22 02:32:12 +0000469 /// A class controlling the emission of a finally block.
470 class FinallyInfo {
471 /// Where the catchall's edge through the cleanup should go.
472 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000473
John McCall6b0feb72011-06-22 02:32:12 +0000474 /// A function to call to enter the catch.
475 llvm::Constant *BeginCatchFn;
476
477 /// An i1 variable indicating whether or not the @finally is
478 /// running for an exception.
479 llvm::AllocaInst *ForEHVar;
480
481 /// An i8* variable into which the exception pointer to rethrow
482 /// has been saved.
483 llvm::AllocaInst *SavedExnVar;
484
485 public:
486 void enter(CodeGenFunction &CGF, const Stmt *Finally,
487 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
488 llvm::Constant *rethrowFn);
489 void exit(CodeGenFunction &CGF);
490 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000491
Reid Kleckner11c033e2015-02-12 23:40:45 +0000492 /// Returns true inside SEH __try blocks.
493 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
494
Reid Klecknera002bd52015-10-28 23:06:42 +0000495 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000496 bool isCleanupPadScope() const {
497 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
498 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000499
John McCallce1de612011-01-26 04:00:11 +0000500 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
501 /// current full-expression. Safe against the possibility that
502 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000503 template <class T, class... As>
504 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000505 // If we're not in a conditional branch, or if none of the
506 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000507 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000508 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000509
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000510 // Stash values in a tuple so we can guarantee the order of saves.
511 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
512 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000513
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000514 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000515 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000516 initFullExprCleanup();
517 }
518
Richard Smith736a9472013-06-12 20:42:33 +0000519 /// \brief Queue a cleanup to be pushed after finishing the current
520 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000521 template <class T, class... As>
522 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smith736a9472013-06-12 20:42:33 +0000523 assert(!isInConditionalBranch() && "can't defer conditional cleanup");
524
525 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
526
527 size_t OldSize = LifetimeExtendedCleanupStack.size();
528 LifetimeExtendedCleanupStack.resize(
529 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
530
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000531 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000532 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000533 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
534 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000535 new (Buffer + sizeof(Header)) T(A...);
Richard Smith736a9472013-06-12 20:42:33 +0000536 }
537
John McCallf4beacd2011-11-10 10:43:54 +0000538 /// Set up the last cleaup that was pushed as a conditional
539 /// full-expression cleanup.
540 void initFullExprCleanup();
541
John McCallbd309292010-07-06 01:34:17 +0000542 /// PushDestructorCleanup - Push a cleanup to call the
543 /// complete-object destructor of an object of the given type at the
544 /// given address. Does nothing if T is not a C++ class type with a
545 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000546 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000547
John McCall8680f872010-07-21 06:29:51 +0000548 /// PushDestructorCleanup - Push a cleanup to call the
549 /// complete-object variant of the given destructor on the object at
550 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000551 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000552
John McCallbd309292010-07-06 01:34:17 +0000553 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
554 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000555 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000556
John McCall824c2f52010-09-14 07:57:04 +0000557 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
558 /// The block cannot be reactivated. Pops it if it's the top of the
559 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000560 ///
561 /// \param DominatingIP - An instruction which is known to
562 /// dominate the current IP (if set) and which lies along
563 /// all paths of execution between the current IP and the
564 /// the point at which the cleanup comes into scope.
565 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
566 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000567
568 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
569 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000570 ///
571 /// \param DominatingIP - An instruction which is known to
572 /// dominate the current IP (if set) and which lies along
573 /// all paths of execution between the current IP and the
574 /// the point at which the cleanup comes into scope.
575 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
576 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000577
John McCallbd309292010-07-06 01:34:17 +0000578 /// \brief Enters a new scope for capturing cleanups, all of which
579 /// will be executed once the scope is exited.
580 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000581 EHScopeStack::stable_iterator CleanupStackDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000582 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000583 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000584 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000585 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000586 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000587
Aaron Ballmanabc18922015-02-15 22:54:08 +0000588 RunCleanupsScope(const RunCleanupsScope &) = delete;
589 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000590
Eric Christophera9d34972011-10-19 00:43:52 +0000591 protected:
592 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000593
Douglas Gregor965f4502009-11-24 16:43:22 +0000594 public:
595 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000596 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000597 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000598 {
John McCallbd309292010-07-06 01:34:17 +0000599 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000600 LifetimeExtendedCleanupStackSize =
601 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000602 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000603 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000604 }
605
Reid Kleckner092d0652017-03-06 22:18:34 +0000606 /// \brief Exit this cleanup scope, emitting any accumulated cleanups.
John McCallbd309292010-07-06 01:34:17 +0000607 ~RunCleanupsScope() {
Reid Kleckner092d0652017-03-06 22:18:34 +0000608 if (PerformCleanup)
609 ForceCleanup();
Douglas Gregor680f8612009-11-24 21:15:44 +0000610 }
611
612 /// \brief Determine whether this scope requires any cleanups.
613 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000614 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000615 }
616
617 /// \brief Force the emission of cleanups now, instead of waiting
618 /// until this object is destroyed.
Reid Kleckner092d0652017-03-06 22:18:34 +0000619 /// \param ValuesToReload - A list of values that need to be available at
620 /// the insertion point after cleanup emission. If cleanup emission created
621 /// a shared cleanup block, these value pointers will be rewritten.
622 /// Otherwise, they not will be modified.
623 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
Douglas Gregor680f8612009-11-24 21:15:44 +0000624 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000625 CGF.DidCallStackSave = OldDidCallStackSave;
Reid Kleckner092d0652017-03-06 22:18:34 +0000626 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
627 ValuesToReload);
Douglas Gregor680f8612009-11-24 21:15:44 +0000628 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000629 }
630 };
631
David Blaikie93be0b22014-08-22 21:37:04 +0000632 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000633 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000634 SmallVector<const LabelDecl*, 4> Labels;
635 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000636
Aaron Ballmanabc18922015-02-15 22:54:08 +0000637 LexicalScope(const LexicalScope &) = delete;
638 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000639
640 public:
641 /// \brief Enter a new cleanup scope.
642 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000643 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
644 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000645 if (CGDebugInfo *DI = CGF.getDebugInfo())
646 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
647 }
648
Nadav Rotem1da30942013-03-23 06:43:35 +0000649 void addLabel(const LabelDecl *label) {
650 assert(PerformCleanup && "adding label to dead scope?");
651 Labels.push_back(label);
652 }
653
Eric Christophera9d34972011-10-19 00:43:52 +0000654 /// \brief Exit this cleanup scope, emitting any accumulated
655 /// cleanups.
656 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000657 if (CGDebugInfo *DI = CGF.getDebugInfo())
658 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
659
Nadav Rotem1da30942013-03-23 06:43:35 +0000660 // If we should perform a cleanup, force them now. Note that
661 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000662 if (PerformCleanup) {
663 ApplyDebugLocation DL(CGF, Range.getEnd());
664 ForceCleanup();
665 }
Eric Christophera9d34972011-10-19 00:43:52 +0000666 }
667
668 /// \brief Force the emission of cleanups now, instead of waiting
669 /// until this object is destroyed.
670 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000671 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000672 RunCleanupsScope::ForceCleanup();
673
Nadav Rotem1da30942013-03-23 06:43:35 +0000674 if (!Labels.empty())
675 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000676 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000677
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000678 bool hasLabels() const {
679 return !Labels.empty();
680 }
681
Nadav Rotem1da30942013-03-23 06:43:35 +0000682 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000683 };
684
John McCall7f416cc2015-09-08 08:05:57 +0000685 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
686
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000687 /// \brief The scope used to remap some variables as private in the OpenMP
688 /// loop body (or other captured region emitted without outlining), and to
689 /// restore old vars back on exit.
690 class OMPPrivateScope : public RunCleanupsScope {
John McCall7f416cc2015-09-08 08:05:57 +0000691 DeclMapTy SavedLocals;
692 DeclMapTy SavedPrivates;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000693
694 private:
Aaron Ballmanabc18922015-02-15 22:54:08 +0000695 OMPPrivateScope(const OMPPrivateScope &) = delete;
696 void operator=(const OMPPrivateScope &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000697
698 public:
699 /// \brief Enter a new OpenMP private scope.
700 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
701
702 /// \brief Registers \a LocalVD variable as a private and apply \a
703 /// PrivateGen function for it to generate corresponding private variable.
704 /// \a PrivateGen returns an address of the generated private variable.
705 /// \return true if the variable is registered as private, false if it has
706 /// been privatized already.
707 bool
708 addPrivate(const VarDecl *LocalVD,
John McCall7f416cc2015-09-08 08:05:57 +0000709 llvm::function_ref<Address()> PrivateGen) {
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000710 assert(PerformCleanup && "adding private to dead scope");
John McCall7f416cc2015-09-08 08:05:57 +0000711
712 // Only save it once.
713 if (SavedLocals.count(LocalVD)) return false;
714
715 // Copy the existing local entry to SavedLocals.
716 auto it = CGF.LocalDeclMap.find(LocalVD);
717 if (it != CGF.LocalDeclMap.end()) {
718 SavedLocals.insert({LocalVD, it->second});
719 } else {
720 SavedLocals.insert({LocalVD, Address::invalid()});
721 }
722
723 // Generate the private entry.
724 Address Addr = PrivateGen();
Alexey Bataevcaacd532015-09-04 11:26:21 +0000725 QualType VarTy = LocalVD->getType();
726 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000727 Address Temp = CGF.CreateMemTemp(VarTy);
728 CGF.Builder.CreateStore(Addr.getPointer(), Temp);
729 Addr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000730 }
John McCall7f416cc2015-09-08 08:05:57 +0000731 SavedPrivates.insert({LocalVD, Addr});
732
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000733 return true;
734 }
735
736 /// \brief Privatizes local variables previously registered as private.
737 /// Registration is separate from the actual privatization to allow
738 /// initializers use values of the original variables, not the private one.
739 /// This is important, for example, if the private variable is a class
740 /// variable initialized by a constructor that references other private
741 /// variables. But at initialization original variables must be used, not
742 /// private copies.
743 /// \return true if at least one variable was privatized, false otherwise.
744 bool Privatize() {
John McCall7f416cc2015-09-08 08:05:57 +0000745 copyInto(SavedPrivates, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000746 SavedPrivates.clear();
747 return !SavedLocals.empty();
748 }
749
750 void ForceCleanup() {
751 RunCleanupsScope::ForceCleanup();
John McCall7f416cc2015-09-08 08:05:57 +0000752 copyInto(SavedLocals, CGF.LocalDeclMap);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000753 SavedLocals.clear();
754 }
755
756 /// \brief Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000757 ~OMPPrivateScope() {
758 if (PerformCleanup)
759 ForceCleanup();
760 }
John McCall7f416cc2015-09-08 08:05:57 +0000761
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000762 /// Checks if the global variable is captured in current function.
763 bool isGlobalVarCaptured(const VarDecl *VD) const {
764 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
765 }
766
John McCall7f416cc2015-09-08 08:05:57 +0000767 private:
768 /// Copy all the entries in the source map over the corresponding
769 /// entries in the destination, which must exist.
770 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
771 for (auto &pair : src) {
772 if (!pair.second.isValid()) {
773 dest.erase(pair.first);
774 continue;
775 }
776
777 auto it = dest.find(pair.first);
778 if (it != dest.end()) {
779 it->second = pair.second;
780 } else {
781 dest.insert(pair);
782 }
783 }
784 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000785 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000786
Richard Smith736a9472013-06-12 20:42:33 +0000787 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
788 /// that have been added.
Reid Kleckner092d0652017-03-06 22:18:34 +0000789 void
790 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
791 std::initializer_list<llvm::Value **> ValuesToReload = {});
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000792
Richard Smith736a9472013-06-12 20:42:33 +0000793 /// \brief Takes the old cleanup stack size and emits the cleanup blocks
794 /// that have been added, then adds all lifetime-extended cleanups from
795 /// the given position to the stack.
Reid Kleckner092d0652017-03-06 22:18:34 +0000796 void
797 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
798 size_t OldLifetimeExtendedStackSize,
799 std::initializer_list<llvm::Value **> ValuesToReload = {});
Richard Smith736a9472013-06-12 20:42:33 +0000800
John McCallad5d61e2010-07-23 21:56:41 +0000801 void ResolveBranchFixups(llvm::BasicBlock *Target);
802
John McCallbd309292010-07-06 01:34:17 +0000803 /// The given basic block lies in the current EH scope, but may be a
804 /// target of a potentially scope-crossing jump; get a stable handle
805 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000806 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000807 return JumpDest(Target,
808 EHStack.getInnermostNormalCleanup(),
809 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000810 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000811
John McCallbd309292010-07-06 01:34:17 +0000812 /// The given basic block lies in the current EH scope, but may be a
813 /// target of a potentially scope-crossing jump; get a stable handle
814 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000815 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000816 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000817 }
818
819 /// EmitBranchThroughCleanup - Emit a branch from the current insert
820 /// block through the normal cleanup handling code (if any) and then
821 /// on to \arg Dest.
822 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000823
Justin Bognere25ffdf2014-01-21 00:35:11 +0000824 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
825 /// specified destination obviously has no cleanups to run. 'false' is always
826 /// a conservatively correct answer for this method.
827 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
828
John McCall8e4c74b2011-08-11 02:22:43 +0000829 /// popCatchScope - Pops the catch scope at the top of the EHScope
830 /// stack, emitting any required code (other than the catch handlers
831 /// themselves).
832 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000833
David Chisnall9a837be2012-11-07 16:50:40 +0000834 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000835 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
David Majnemerdbf10452015-07-31 17:58:45 +0000836 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000837
John McCallce1de612011-01-26 04:00:11 +0000838 /// An object to manage conditionally-evaluated expressions.
839 class ConditionalEvaluation {
840 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000841
John McCallce1de612011-01-26 04:00:11 +0000842 public:
843 ConditionalEvaluation(CodeGenFunction &CGF)
844 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000845
John McCallce1de612011-01-26 04:00:11 +0000846 void begin(CodeGenFunction &CGF) {
847 assert(CGF.OutermostConditional != this);
848 if (!CGF.OutermostConditional)
849 CGF.OutermostConditional = this;
850 }
851
852 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +0000853 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +0000854 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +0000855 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000856 }
857
858 /// Returns a block which will be executed prior to each
859 /// evaluation of the conditional code.
860 llvm::BasicBlock *getStartingBlock() const {
861 return StartBB;
862 }
863 };
Mike Stump11289f42009-09-09 15:08:12 +0000864
John McCall7f9c92a2010-09-17 00:50:28 +0000865 /// isInConditionalBranch - Return true if we're currently emitting
866 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +0000867 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +0000868
John McCall7f416cc2015-09-08 08:05:57 +0000869 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +0000870 assert(isInConditionalBranch());
871 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000872 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
873 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +0000874 }
875
John McCallce1de612011-01-26 04:00:11 +0000876 /// An RAII object to record that we're evaluating a statement
877 /// expression.
878 class StmtExprEvaluation {
879 CodeGenFunction &CGF;
880
881 /// We have to save the outermost conditional: cleanups in a
882 /// statement expression aren't conditional just because the
883 /// StmtExpr is.
884 ConditionalEvaluation *SavedOutermostConditional;
885
886 public:
887 StmtExprEvaluation(CodeGenFunction &CGF)
888 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +0000889 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +0000890 }
891
892 ~StmtExprEvaluation() {
893 CGF.OutermostConditional = SavedOutermostConditional;
894 CGF.EnsureInsertPoint();
895 }
896 };
John McCall1bf58462011-02-16 08:02:54 +0000897
John McCallc07a0c72011-02-17 10:25:35 +0000898 /// An object which temporarily prevents a value from being
899 /// destroyed by aggressive peephole optimizations that assume that
900 /// all uses of a value have been realized in the IR.
901 class PeepholeProtection {
902 llvm::Instruction *Inst;
903 friend class CodeGenFunction;
904
905 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000906 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000907 };
John McCallc07a0c72011-02-17 10:25:35 +0000908
John McCallfe96e0b2011-11-06 09:01:30 +0000909 /// A non-RAII class containing all the information about a bound
910 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
911 /// this which makes individual mappings very simple; using this
912 /// class directly is useful when you have a variable number of
913 /// opaque values or don't want the RAII functionality for some
914 /// reason.
915 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000916 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000917 bool BoundLValue;
918 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000919
John McCallfe96e0b2011-11-06 09:01:30 +0000920 OpaqueValueMappingData(const OpaqueValueExpr *ov,
921 bool boundLValue)
922 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000923 public:
Craig Topper8a13c412014-05-21 05:09:00 +0000924 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000925
John McCallc07a0c72011-02-17 10:25:35 +0000926 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000927 // gl-values should be bound as l-values for obvious reasons.
928 // Records should be bound as l-values because IR generation
929 // always keeps them in memory. Expressions of function type
930 // act exactly like l-values but are formally required to be
931 // r-values in C.
932 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +0000933 expr->getType()->isFunctionType() ||
934 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +0000935 }
936
John McCallfe96e0b2011-11-06 09:01:30 +0000937 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
938 const OpaqueValueExpr *ov,
939 const Expr *e) {
940 if (shouldBindAsLValue(ov))
941 return bind(CGF, ov, CGF.EmitLValue(e));
942 return bind(CGF, ov, CGF.EmitAnyExpr(e));
943 }
944
945 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
946 const OpaqueValueExpr *ov,
947 const LValue &lv) {
948 assert(shouldBindAsLValue(ov));
949 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
950 return OpaqueValueMappingData(ov, true);
951 }
952
953 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
954 const OpaqueValueExpr *ov,
955 const RValue &rv) {
956 assert(!shouldBindAsLValue(ov));
957 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
958
959 OpaqueValueMappingData data(ov, false);
960
961 // Work around an extremely aggressive peephole optimization in
962 // EmitScalarConversion which assumes that all other uses of a
963 // value are extant.
964 data.Protection = CGF.protectFromPeepholes(rv);
965
966 return data;
967 }
968
Craig Topper8a13c412014-05-21 05:09:00 +0000969 bool isValid() const { return OpaqueValue != nullptr; }
970 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +0000971
972 void unbind(CodeGenFunction &CGF) {
973 assert(OpaqueValue && "no data to unbind!");
974
975 if (BoundLValue) {
976 CGF.OpaqueLValues.erase(OpaqueValue);
977 } else {
978 CGF.OpaqueRValues.erase(OpaqueValue);
979 CGF.unprotectFromPeepholes(Protection);
980 }
981 }
982 };
983
984 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
985 class OpaqueValueMapping {
986 CodeGenFunction &CGF;
987 OpaqueValueMappingData Data;
988
989 public:
990 static bool shouldBindAsLValue(const Expr *expr) {
991 return OpaqueValueMappingData::shouldBindAsLValue(expr);
992 }
993
John McCallc07a0c72011-02-17 10:25:35 +0000994 /// Build the opaque value mapping for the given conditional
995 /// operator if it's the GNU ?: extension. This is a common
996 /// enough pattern that the convenience operator is really
997 /// helpful.
998 ///
999 OpaqueValueMapping(CodeGenFunction &CGF,
1000 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +00001001 if (isa<ConditionalOperator>(op))
1002 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001003 return;
John McCallc07a0c72011-02-17 10:25:35 +00001004
1005 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001006 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1007 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001008 }
1009
Richard Smith410306b2016-12-12 02:53:20 +00001010 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1011 /// expression is set to the expression the OVE represents.
1012 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1013 : CGF(CGF) {
1014 if (OV) {
1015 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1016 "for OVE with no source expression");
1017 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1018 }
1019 }
1020
John McCall1bf58462011-02-16 08:02:54 +00001021 OpaqueValueMapping(CodeGenFunction &CGF,
1022 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001023 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001024 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001025 }
1026
1027 OpaqueValueMapping(CodeGenFunction &CGF,
1028 const OpaqueValueExpr *opaqueValue,
1029 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001030 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001031 }
1032
1033 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001034 Data.unbind(CGF);
1035 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001036 }
1037
1038 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001039 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001040 }
1041 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +00001042
Chris Lattner2da04b32007-08-24 05:35:26 +00001043private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001044 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001045 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001046
John McCall9b382dd2011-05-28 21:13:02 +00001047 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1048 /// calling llvm.stacksave for multiple VLAs in the same scope.
1049 bool DidCallStackSave;
1050
Mike Stumpe5311b02009-11-30 20:08:49 +00001051 /// IndirectBranch - The first time an indirect goto is seen we create a block
1052 /// with an indirect branch. Every time we see the address of a label taken,
1053 /// we add the label to the indirect goto. Every subsequent indirect goto is
1054 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +00001055 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001056
Mike Stumpfc496822009-02-08 23:14:22 +00001057 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1058 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001059 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001060
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001061 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1062 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1063 /// parameter.
1064 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1065 SizeArguments;
1066
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001067 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001068 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001069 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1070
Chris Lattnerac248202007-05-30 00:13:02 +00001071 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001072 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001073
Mike Stumpfc496822009-02-08 23:14:22 +00001074 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001075 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001076 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001077 BreakContinue(JumpDest Break, JumpDest Continue)
1078 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001079
John McCallbd309292010-07-06 01:34:17 +00001080 JumpDest BreakBlock;
1081 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001082 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001083 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001084
Alexey Bataev957d8562016-11-17 15:12:05 +00001085 /// Handles cancellation exit points in OpenMP-related constructs.
1086 class OpenMPCancelExitStack {
1087 /// Tracks cancellation exit point and join point for cancel-related exit
1088 /// and normal exit.
1089 struct CancelExit {
1090 CancelExit() = default;
1091 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1092 JumpDest ContBlock)
1093 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1094 OpenMPDirectiveKind Kind = OMPD_unknown;
1095 /// true if the exit block has been emitted already by the special
1096 /// emitExit() call, false if the default codegen is used.
1097 bool HasBeenEmitted = false;
1098 JumpDest ExitBlock;
1099 JumpDest ContBlock;
1100 };
1101
1102 SmallVector<CancelExit, 8> Stack;
1103
1104 public:
1105 OpenMPCancelExitStack() : Stack(1) {}
1106 ~OpenMPCancelExitStack() = default;
1107 /// Fetches the exit block for the current OpenMP construct.
1108 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1109 /// Emits exit block with special codegen procedure specific for the related
1110 /// OpenMP construct + emits code for normal construct cleanup.
1111 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1112 const llvm::function_ref<void(CodeGenFunction &)> &CodeGen) {
1113 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1114 assert(CGF.getOMPCancelDestination(Kind).isValid());
1115 assert(CGF.HaveInsertPoint());
1116 assert(!Stack.back().HasBeenEmitted);
1117 auto IP = CGF.Builder.saveAndClearIP();
1118 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1119 CodeGen(CGF);
Erich Keane0026ed22017-07-27 16:28:20 +00001120 CGF.EmitBranch(Stack.back().ContBlock.getBlock());
Alexey Bataev957d8562016-11-17 15:12:05 +00001121 CGF.Builder.restoreIP(IP);
1122 Stack.back().HasBeenEmitted = true;
1123 }
1124 CodeGen(CGF);
1125 }
1126 /// Enter the cancel supporting \a Kind construct.
1127 /// \param Kind OpenMP directive that supports cancel constructs.
1128 /// \param HasCancel true, if the construct has inner cancel directive,
1129 /// false otherwise.
1130 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1131 Stack.push_back({Kind,
1132 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1133 : JumpDest(),
1134 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1135 : JumpDest()});
1136 }
1137 /// Emits default exit point for the cancel construct (if the special one
1138 /// has not be used) + join point for cancel/normal exits.
1139 void exit(CodeGenFunction &CGF) {
1140 if (getExitBlock().isValid()) {
1141 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1142 bool HaveIP = CGF.HaveInsertPoint();
1143 if (!Stack.back().HasBeenEmitted) {
1144 if (HaveIP)
1145 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1146 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1147 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1148 }
1149 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1150 if (!HaveIP) {
1151 CGF.Builder.CreateUnreachable();
1152 CGF.Builder.ClearInsertionPoint();
1153 }
1154 }
1155 Stack.pop_back();
1156 }
1157 };
1158 OpenMPCancelExitStack OMPCancelStack;
1159
1160 /// Controls insertion of cancellation exit blocks in worksharing constructs.
1161 class OMPCancelStackRAII {
1162 CodeGenFunction &CGF;
1163
1164 public:
1165 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1166 bool HasCancel)
1167 : CGF(CGF) {
1168 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
1169 }
1170 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
1171 };
1172
Justin Bogneref512b92014-01-06 22:27:43 +00001173 CodeGenPGO PGO;
1174
Justin Bogner65512642015-05-02 05:00:55 +00001175 /// Calculate branch weights appropriate for PGO data
1176 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1177 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1178 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1179 uint64_t LoopCount);
1180
Justin Bogneref512b92014-01-06 22:27:43 +00001181public:
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001182 /// Increment the profiler's counter for the given statement by \p StepV.
1183 /// If \p StepV is null, the default increment is 1.
1184 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
Rong Xu9837ef52016-02-04 18:39:09 +00001185 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001186 PGO.emitCounterIncrement(Builder, S, StepV);
Justin Bogner66242d62015-04-23 23:06:47 +00001187 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001188 }
Justin Bogner66242d62015-04-23 23:06:47 +00001189
1190 /// Get the profiler's count for the given statement.
1191 uint64_t getProfileCount(const Stmt *S) {
1192 Optional<uint64_t> Count = PGO.getStmtCount(S);
1193 if (!Count.hasValue())
1194 return 0;
1195 return *Count;
1196 }
1197
1198 /// Set the profiler's current count.
1199 void setCurrentProfileCount(uint64_t Count) {
1200 PGO.setCurrentRegionCount(Count);
1201 }
1202
1203 /// Get the profiler's current count. This is generally the count for the most
1204 /// recently incremented counter.
1205 uint64_t getCurrentProfileCount() {
1206 return PGO.getCurrentRegionCount();
1207 }
1208
Justin Bogneref512b92014-01-06 22:27:43 +00001209private:
1210
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001211 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001212 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001213 llvm::SwitchInst *SwitchInsn;
Justin Bogneref512b92014-01-06 22:27:43 +00001214 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1215 SmallVector<uint64_t, 16> *SwitchWeights;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001216
Mike Stumpfc496822009-02-08 23:14:22 +00001217 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001218 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001219 llvm::BasicBlock *CaseRangeBlock;
1220
John McCallc07a0c72011-02-17 10:25:35 +00001221 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001222 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001223 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1224 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001225
Mike Stumpfc496822009-02-08 23:14:22 +00001226 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001227 // We track this by the size expression rather than the type itself because
1228 // in certain situations, like a const qualifier applied to an VLA typedef,
1229 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001230 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1231 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001232 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001233
John McCallbd309292010-07-06 01:34:17 +00001234 /// A block containing a single 'unreachable' instruction. Created
1235 /// lazily by getUnreachableBlock().
1236 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001237
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001238 /// Counts of the number return expressions in the function.
1239 unsigned NumReturnExprs;
Adrian Prantl3be10542013-05-02 17:30:20 +00001240
1241 /// Count the number of simple (constant) return expressions in the function.
1242 unsigned NumSimpleReturnExprs;
1243
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001244 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001245 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001246
Richard Smith852c9db2013-04-20 22:23:05 +00001247public:
1248 /// A scope within which we are constructing the fields of an object which
1249 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1250 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1251 class FieldConstructionScope {
1252 public:
John McCall7f416cc2015-09-08 08:05:57 +00001253 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001254 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1255 CGF.CXXDefaultInitExprThis = This;
1256 }
1257 ~FieldConstructionScope() {
1258 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1259 }
1260
1261 private:
1262 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001263 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001264 };
1265
1266 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1267 /// is overridden to be the object under construction.
1268 class CXXDefaultInitExprScope {
1269 public:
1270 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001271 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1272 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1273 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1274 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001275 }
1276 ~CXXDefaultInitExprScope() {
1277 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001278 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001279 }
1280
1281 public:
1282 CodeGenFunction &CGF;
1283 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001284 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001285 };
1286
Richard Smith410306b2016-12-12 02:53:20 +00001287 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1288 /// current loop index is overridden.
1289 class ArrayInitLoopExprScope {
1290 public:
1291 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1292 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1293 CGF.ArrayInitIndex = Index;
1294 }
1295 ~ArrayInitLoopExprScope() {
1296 CGF.ArrayInitIndex = OldArrayInitIndex;
1297 }
1298
1299 private:
1300 CodeGenFunction &CGF;
1301 llvm::Value *OldArrayInitIndex;
1302 };
1303
Richard Smith5179eb72016-06-28 19:03:57 +00001304 class InlinedInheritingConstructorScope {
1305 public:
1306 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1307 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1308 OldCurCodeDecl(CGF.CurCodeDecl),
1309 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1310 OldCXXABIThisValue(CGF.CXXABIThisValue),
1311 OldCXXThisValue(CGF.CXXThisValue),
1312 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1313 OldCXXThisAlignment(CGF.CXXThisAlignment),
1314 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1315 OldCXXInheritedCtorInitExprArgs(
1316 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1317 CGF.CurGD = GD;
1318 CGF.CurFuncDecl = CGF.CurCodeDecl =
1319 cast<CXXConstructorDecl>(GD.getDecl());
1320 CGF.CXXABIThisDecl = nullptr;
1321 CGF.CXXABIThisValue = nullptr;
1322 CGF.CXXThisValue = nullptr;
1323 CGF.CXXABIThisAlignment = CharUnits();
1324 CGF.CXXThisAlignment = CharUnits();
1325 CGF.ReturnValue = Address::invalid();
1326 CGF.FnRetTy = QualType();
1327 CGF.CXXInheritedCtorInitExprArgs.clear();
1328 }
1329 ~InlinedInheritingConstructorScope() {
1330 CGF.CurGD = OldCurGD;
1331 CGF.CurFuncDecl = OldCurFuncDecl;
1332 CGF.CurCodeDecl = OldCurCodeDecl;
1333 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1334 CGF.CXXABIThisValue = OldCXXABIThisValue;
1335 CGF.CXXThisValue = OldCXXThisValue;
1336 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1337 CGF.CXXThisAlignment = OldCXXThisAlignment;
1338 CGF.ReturnValue = OldReturnValue;
1339 CGF.FnRetTy = OldFnRetTy;
1340 CGF.CXXInheritedCtorInitExprArgs =
1341 std::move(OldCXXInheritedCtorInitExprArgs);
1342 }
1343
1344 private:
1345 CodeGenFunction &CGF;
1346 GlobalDecl OldCurGD;
1347 const Decl *OldCurFuncDecl;
1348 const Decl *OldCurCodeDecl;
1349 ImplicitParamDecl *OldCXXABIThisDecl;
1350 llvm::Value *OldCXXABIThisValue;
1351 llvm::Value *OldCXXThisValue;
1352 CharUnits OldCXXABIThisAlignment;
1353 CharUnits OldCXXThisAlignment;
1354 Address OldReturnValue;
1355 QualType OldFnRetTy;
1356 CallArgList OldCXXInheritedCtorInitExprArgs;
1357 };
1358
Richard Smith852c9db2013-04-20 22:23:05 +00001359private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001360 /// CXXThisDecl - When generating code for a C++ member function,
1361 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001362 ImplicitParamDecl *CXXABIThisDecl;
1363 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001364 llvm::Value *CXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001365 CharUnits CXXABIThisAlignment;
1366 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001367
Richard Smith852c9db2013-04-20 22:23:05 +00001368 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1369 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001370 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001371
Richard Smith410306b2016-12-12 02:53:20 +00001372 /// The current array initialization index when evaluating an
1373 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1374 llvm::Value *ArrayInitIndex = nullptr;
1375
Richard Smith5179eb72016-06-28 19:03:57 +00001376 /// The values of function arguments to use when evaluating
1377 /// CXXInheritedCtorInitExprs within this context.
1378 CallArgList CXXInheritedCtorInitExprArgs;
1379
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001380 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1381 /// destructor, this will hold the implicit argument (e.g. VTT).
1382 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1383 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001384
John McCallce1de612011-01-26 04:00:11 +00001385 /// OutermostConditional - Points to the outermost active
1386 /// conditional control. This is used so that we know if a
1387 /// temporary should be destroyed conditionally.
1388 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001389
Nadav Rotem1da30942013-03-23 06:43:35 +00001390 /// The current lexical scope.
1391 LexicalScope *CurLexicalScope;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001392
Adrian Prantldc237b52013-05-16 00:41:26 +00001393 /// The current source location that should be used for exception
1394 /// handling code.
1395 SourceLocation CurEHLocation;
1396
John McCall7f416cc2015-09-08 08:05:57 +00001397 /// BlockByrefInfos - For each __block variable, contains
1398 /// information about the layout of the variable.
1399 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001400
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001401 /// Used by -fsanitize=nullability-return to determine whether the return
1402 /// value can be checked.
1403 llvm::Value *RetValNullabilityPrecondition = nullptr;
1404
1405 /// Check if -fsanitize=nullability-return instrumentation is required for
1406 /// this function.
1407 bool requiresReturnValueNullabilityCheck() const {
1408 return RetValNullabilityPrecondition;
1409 }
1410
Vedant Kumarc34d3432017-06-23 21:32:38 +00001411 /// Used to store precise source locations for return statements by the
1412 /// runtime return value checks.
1413 Address ReturnLocation = Address::invalid();
1414
1415 /// Check if the return value of this function requires sanitization.
1416 bool requiresReturnValueCheck() const {
1417 return requiresReturnValueNullabilityCheck() ||
1418 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
1419 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
1420 }
1421
John McCallbd309292010-07-06 01:34:17 +00001422 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001423 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001424 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001425
Vitaly Buka1c943322016-10-26 01:59:57 +00001426 /// True if we need emit the life-time markers.
1427 const bool ShouldEmitLifetimeMarkers;
1428
Xiuli Panbe6da4b2017-05-04 07:31:20 +00001429 /// Add OpenCL kernel arg metadata and the kernel attribute meatadata to
1430 /// the function metadata.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001431 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1432 llvm::Function *Fn);
1433
Chris Lattnerbed31442007-05-28 01:07:47 +00001434public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001435 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001436 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001437
John McCall8ed55a52010-09-02 09:58:18 +00001438 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001439 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001440 CGDebugInfo *getDebugInfo() {
1441 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001442 return nullptr;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001443 return DebugInfo;
1444 }
1445 void disableDebugInfo() { DisableDebugInfo = true; }
1446 void enableDebugInfo() { DisableDebugInfo = false; }
1447
John McCall31168b02011-06-15 23:02:42 +00001448 bool shouldUseFusedARCCalls() {
1449 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1450 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001451
David Blaikiebbafb8a2012-03-11 07:00:24 +00001452 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001453
Bill Wendlingf0724e82011-09-19 20:31:14 +00001454 /// Returns a pointer to the function's exception object and selector slot,
1455 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001456 Address getExceptionSlot();
1457 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001458
Bill Wendling79a70e42011-09-15 18:57:19 +00001459 /// Returns the contents of the function's exception object and selector
1460 /// slots.
1461 llvm::Value *getExceptionFromSlot();
1462 llvm::Value *getSelectorFromSlot();
1463
John McCall7f416cc2015-09-08 08:05:57 +00001464 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001465
John McCallbd309292010-07-06 01:34:17 +00001466 llvm::BasicBlock *getUnreachableBlock() {
1467 if (!UnreachableBlock) {
1468 UnreachableBlock = createBasicBlock("unreachable");
1469 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1470 }
1471 return UnreachableBlock;
1472 }
1473
1474 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001475 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001476 return getInvokeDestImpl();
1477 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001478
David Majnemer25eb1652016-03-01 19:42:53 +00001479 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001480
John McCallc8e01702013-04-16 22:48:15 +00001481 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001482 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Yaxun Liucbf647c2017-07-08 13:24:52 +00001483 const TargetCodeGenInfo &getTargetHooks() const {
1484 return CGM.getTargetCodeGenInfo();
1485 }
Owen Andersonae86c192009-07-13 04:10:07 +00001486
Daniel Dunbar12347492009-02-23 17:26:39 +00001487 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001488 // Cleanups
1489 //===--------------------------------------------------------------------===//
1490
John McCall7f416cc2015-09-08 08:05:57 +00001491 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001492
John McCall178360e2011-07-11 08:38:19 +00001493 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001494 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001495 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001496 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001497 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001498 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1499 llvm::Value *arrayEnd,
1500 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001501 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001502 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001503
John McCall4bd0fb12011-07-12 16:41:08 +00001504 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001505 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001506 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001507 Address addr, QualType type);
1508 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001509 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001510 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001511 QualType type, Destroyer *destroyer,
1512 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001513 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1514 llvm::Value *CompletePtr,
1515 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001516 void pushStackRestore(CleanupKind kind, Address SPMem);
1517 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001518 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001519 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001520 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001521 bool useEHCleanupForArray,
1522 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001523 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001524 QualType elementType, CharUnits elementAlign,
1525 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001526 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001527
Peter Collingbourne1425b452012-01-26 03:33:36 +00001528 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001529
John McCall82fe67b2011-07-09 01:37:26 +00001530 /// Determines whether an EH cleanup is required to destroy a type
1531 /// with the given destruction kind.
1532 bool needsEHCleanup(QualType::DestructionKind kind) {
1533 switch (kind) {
1534 case QualType::DK_none:
1535 return false;
1536 case QualType::DK_cxx_destructor:
1537 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001538 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001539 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001540 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001541 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1542 }
1543 llvm_unreachable("bad destruction kind");
1544 }
1545
John McCall4bd0fb12011-07-12 16:41:08 +00001546 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1547 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1548 }
1549
John McCall82fe67b2011-07-09 01:37:26 +00001550 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001551 // Objective-C
1552 //===--------------------------------------------------------------------===//
1553
Chris Lattner4bd55962008-03-30 23:03:07 +00001554 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001555
David Blaikief1425802015-01-14 00:04:42 +00001556 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001557
Mike Stumpfc496822009-02-08 23:14:22 +00001558 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001559 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1560 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001561 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001562 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001563 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001564 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001565
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001566 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1567 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001568
Mike Stumpfc496822009-02-08 23:14:22 +00001569 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1570 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001571 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1572 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001573 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001574 const ObjCPropertyImplDecl *propImpl,
1575 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001576
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001577 //===--------------------------------------------------------------------===//
1578 // Block Bits
1579 //===--------------------------------------------------------------------===//
1580
John McCall351762c2011-02-07 10:33:21 +00001581 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001582 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001583
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001584 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001585 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001586 const DeclMapTy &ldm,
1587 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001588
John McCallad7c5c12011-02-08 08:22:06 +00001589 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1590 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001591 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1592 const ObjCPropertyImplDecl *PID);
1593 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1594 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001595 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001596
John McCallad7c5c12011-02-08 08:22:06 +00001597 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1598
John McCall73064872011-03-31 01:59:53 +00001599 class AutoVarEmission;
1600
1601 void emitByrefStructureInit(const AutoVarEmission &emission);
1602 void enterByrefCleanup(const AutoVarEmission &emission);
1603
John McCall7f416cc2015-09-08 08:05:57 +00001604 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1605 llvm::Value *ptr);
1606
1607 Address LoadBlockStruct();
John McCall7f416cc2015-09-08 08:05:57 +00001608 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1609
1610 /// BuildBlockByrefAddress - Computes the location of the
1611 /// data in a variable which is declared as __block.
1612 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1613 bool followForward = true);
1614 Address emitBlockByrefAddress(Address baseAddr,
1615 const BlockByrefInfo &info,
1616 bool followForward,
1617 const llvm::Twine &name);
1618
1619 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001620
Richard Smith5179eb72016-06-28 19:03:57 +00001621 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1622
John McCalla738c252011-03-09 04:27:21 +00001623 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1624 const CGFunctionInfo &FnInfo);
Adrian Prantl42d71b92014-04-10 23:21:53 +00001625 /// \brief Emit code for the start of a function.
1626 /// \param Loc The location to be associated with the function.
1627 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001628 void StartFunction(GlobalDecl GD,
1629 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001630 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001631 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001632 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001633 SourceLocation Loc = SourceLocation(),
1634 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001635
Vedant Kumar7f809b22017-02-24 01:15:19 +00001636 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1637
John McCallb81884d2010-02-19 09:25:03 +00001638 void EmitConstructorBody(FunctionArgList &Args);
1639 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001640 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001641 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001642 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001643
Faisal Vali571df122013-09-29 08:45:24 +00001644 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001645 CallArgList &CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00001646 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001647 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001648 void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001649 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001650
David Blaikiea0a1a872015-01-18 02:48:07 +00001651 /// \brief Emit the unified return block, trying to avoid its emission when
1652 /// possible.
1653 /// \return The debug location of the user written return statement if the
1654 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001655 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001656
Mike Stumpfc496822009-02-08 23:14:22 +00001657 /// FinishFunction - Complete IR generation of the current function. It is
1658 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001659 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001660
Nico Weber1bebad12015-02-11 22:33:32 +00001661 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1662 const CGFunctionInfo &FnInfo);
Hans Wennborg88497d62013-11-15 17:24:45 +00001663
John McCallb92ab1a2016-10-26 23:46:34 +00001664 void EmitCallAndReturnForThunk(llvm::Constant *Callee,
1665 const ThunkInfo *Thunk);
Hans Wennborg88497d62013-11-15 17:24:45 +00001666
John McCall7f416cc2015-09-08 08:05:57 +00001667 void FinishThunk();
1668
Reid Klecknerab2090d2014-07-26 01:34:32 +00001669 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1670 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1671 llvm::Value *Callee);
1672
Rafael Espindolad6e66942015-07-13 06:07:58 +00001673 /// Generate a thunk for the given method.
1674 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
John McCalla738c252011-03-09 04:27:21 +00001675 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001676
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001677 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1678 const CGFunctionInfo &FnInfo,
1679 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001680
Douglas Gregor94f9a482010-05-05 05:51:00 +00001681 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1682 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001683
Richard Smith30e304e2016-12-14 00:03:17 +00001684 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001685
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001686 /// Struct with all informations about dynamic [sub]class needed to set vptr.
1687 struct VPtr {
1688 BaseSubobject Base;
1689 const CXXRecordDecl *NearestVBase;
1690 CharUnits OffsetFromNearestVBase;
1691 const CXXRecordDecl *VTableClass;
1692 };
1693
1694 /// Initialize the vtable pointer of the given subobject.
1695 void InitializeVTablePointer(const VPtr &vptr);
1696
1697 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001698
1699 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001700 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1701
1702 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1703 CharUnits OffsetFromNearestVBase,
1704 bool BaseIsNonVirtualPrimaryBase,
1705 const CXXRecordDecl *VTableClass,
1706 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001707
Anders Carlssond5895932010-03-28 21:07:49 +00001708 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001709
Dan Gohman8fc50c22010-10-26 18:44:08 +00001710 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1711 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001712 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1713 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001714
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001715 enum CFITypeCheckKind {
1716 CFITCK_VCall,
1717 CFITCK_NVCall,
1718 CFITCK_DerivedCast,
1719 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001720 CFITCK_ICall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001721 };
1722
Peter Collingbourned2926c92015-03-14 02:42:25 +00001723 /// \brief Derived is the presumed address of an object of type T after a
1724 /// cast. If T is a polymorphic class type, emit a check that the virtual
1725 /// table for Derived belongs to a class derived from T.
1726 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001727 bool MayBeNull, CFITypeCheckKind TCK,
1728 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001729
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001730 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1731 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001732 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001733 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001734
Peter Collingbourned2926c92015-03-14 02:42:25 +00001735 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001736 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001737 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1738 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001739
Peter Collingbournefb532b92016-02-24 20:46:36 +00001740 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001741 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1742 /// enabled, emit a check that VTable is a member of RD's type identifier.
1743 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1744 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001745
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001746 /// Returns whether we should perform a type checked load when loading a
1747 /// virtual function for virtual calls to members of RD. This is generally
1748 /// true when both vcall CFI and whole-program-vtables are enabled.
1749 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1750
1751 /// Emit a type checked load from the given vtable.
1752 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1753 uint64_t VTableByteOffset);
1754
John McCallf99a6312010-07-21 05:30:47 +00001755 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1756 /// given phase of destruction for a destructor. The end result
1757 /// should call destructors on members and base classes in reverse
1758 /// order of their construction.
1759 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001760
Chris Lattner3c77a352010-06-22 00:03:40 +00001761 /// ShouldInstrumentFunction - Return true if the current function should be
1762 /// instrumented with __cyg_profile_func_* calls
1763 bool ShouldInstrumentFunction();
1764
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001765 /// ShouldXRayInstrument - Return true if the current function should be
1766 /// instrumented with XRay nop sleds.
1767 bool ShouldXRayInstrumentFunction() const;
1768
Chris Lattner3c77a352010-06-22 00:03:40 +00001769 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1770 /// instrumentation function with the current function and the call site, if
1771 /// function instrumentation is enabled.
1772 void EmitFunctionInstrumentation(const char *Fn);
1773
Roman Divacky178e01602011-02-10 16:52:03 +00001774 /// EmitMCountInstrumentation - Emit call to .mcount.
1775 void EmitMCountInstrumentation();
1776
Mike Stumpfc496822009-02-08 23:14:22 +00001777 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1778 /// arguments for the given function. This is also responsible for naming the
1779 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001780 void EmitFunctionProlog(const CGFunctionInfo &FI,
1781 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001782 const FunctionArgList &Args);
1783
Mike Stumpfc496822009-02-08 23:14:22 +00001784 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1785 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001786 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1787 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001788
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001789 /// Emit a test that checks if the return value \p RV is nonnull.
Vedant Kumarc34d3432017-06-23 21:32:38 +00001790 void EmitReturnValueCheck(llvm::Value *RV);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001791
Mike Stump1d849212009-12-07 23:38:24 +00001792 /// EmitStartEHSpec - Emit the start of the exception spec.
1793 void EmitStartEHSpec(const Decl *D);
1794
1795 /// EmitEndEHSpec - Emit the end of the exception spec.
1796 void EmitEndEHSpec(const Decl *D);
1797
John McCallbd309292010-07-06 01:34:17 +00001798 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1799 llvm::BasicBlock *getTerminateLandingPad();
1800
1801 /// getTerminateHandler - Return a handler (not a landing pad, just
1802 /// a catch handler) that just calls terminate. This is used when
1803 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001804 llvm::BasicBlock *getTerminateHandler();
1805
Chris Lattnera5f58b02011-07-09 17:41:47 +00001806 llvm::Type *ConvertTypeForMem(QualType T);
1807 llvm::Type *ConvertType(QualType T);
1808 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001809 return ConvertType(getContext().getTypeDeclType(T));
1810 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001811
Mike Stumpfc496822009-02-08 23:14:22 +00001812 /// LoadObjCSelf - Load the value of self. This function is only valid while
1813 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001814 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001815
1816 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001817 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001818
Chris Lattner54fb19e2007-06-22 22:02:34 +00001819 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1820 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001821 static TypeEvaluationKind getEvaluationKind(QualType T);
1822
1823 static bool hasScalarEvaluationKind(QualType T) {
1824 return getEvaluationKind(T) == TEK_Scalar;
1825 }
1826
1827 static bool hasAggregateEvaluationKind(QualType T) {
1828 return getEvaluationKind(T) == TEK_Aggregate;
1829 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001830
1831 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001832 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00001833 llvm::Function *parent = nullptr,
1834 llvm::BasicBlock *before = nullptr) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001835#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001836 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001837#else
John McCallad7c5c12011-02-08 08:22:06 +00001838 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001839#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001840 }
Mike Stumpfc496822009-02-08 23:14:22 +00001841
Chris Lattnerac248202007-05-30 00:13:02 +00001842 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1843 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001844 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001845
Mike Stumpe5311b02009-11-30 20:08:49 +00001846 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1847 /// another basic block, simplify it. This assumes that no other code could
1848 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001849 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1850
Mike Stumpfc496822009-02-08 23:14:22 +00001851 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1852 /// adding a fall-through branch from the current insert block if
1853 /// necessary. It is legal to call this function even if there is no current
1854 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001855 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001856 /// IsFinished - If true, indicates that the caller has finished emitting
1857 /// branches to the given block and does not expect to emit code into it. This
1858 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001859 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001860
John McCall8e4c74b2011-08-11 02:22:43 +00001861 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1862 /// near its uses, and leave the insertion point in it.
1863 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1864
Mike Stumpfc496822009-02-08 23:14:22 +00001865 /// EmitBranch - Emit a branch to the specified basic block from the current
1866 /// insert block, taking care to avoid creation of branches from dummy
1867 /// blocks. It is legal to call this function even if there is no current
1868 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001869 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001870 /// This function clears the current insertion point. The caller should follow
1871 /// calls to this function with calls to Emit*Block prior to generation new
1872 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001873 void EmitBranch(llvm::BasicBlock *Block);
1874
Mike Stumpfc496822009-02-08 23:14:22 +00001875 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1876 /// indicates that the current code being emitted is unreachable.
1877 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00001878 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001879 }
1880
Mike Stumpfc496822009-02-08 23:14:22 +00001881 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1882 /// emitted IR has a place to go. Note that by definition, if this function
1883 /// creates a block then that block is unreachable; callers may do better to
1884 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001885 void EnsureInsertPoint() {
1886 if (!HaveInsertPoint())
1887 EmitBlock(createBasicBlock());
1888 }
Mike Stumpfc496822009-02-08 23:14:22 +00001889
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001890 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001891 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001892 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00001893
Chris Lattnere9a64532007-06-22 21:44:33 +00001894 //===--------------------------------------------------------------------===//
1895 // Helpers
1896 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001897
John McCall7f416cc2015-09-08 08:05:57 +00001898 LValue MakeAddrLValue(Address Addr, QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001899 LValueBaseInfo BaseInfo =
1900 LValueBaseInfo(AlignmentSource::Type)) {
1901 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo,
Dan Gohman947c9af2010-10-14 23:06:10 +00001902 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001903 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001904
John McCall7f416cc2015-09-08 08:05:57 +00001905 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001906 LValueBaseInfo BaseInfo =
1907 LValueBaseInfo(AlignmentSource::Type)) {
John McCall7f416cc2015-09-08 08:05:57 +00001908 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001909 BaseInfo, CGM.getTBAAInfo(T));
John McCall7f416cc2015-09-08 08:05:57 +00001910 }
1911
1912 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00001913 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00001914 CharUnits getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001915 LValueBaseInfo *BaseInfo = nullptr,
John McCall7f416cc2015-09-08 08:05:57 +00001916 bool forPointeeType = false);
1917 CharUnits getNaturalPointeeTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001918 LValueBaseInfo *BaseInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001919
1920 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001921 LValueBaseInfo *BaseInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001922 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001923
Alexey Bataev31300ed2016-02-04 11:27:03 +00001924 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001925 LValueBaseInfo *BaseInfo = nullptr);
Alexey Bataev31300ed2016-02-04 11:27:03 +00001926 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
1927
Yaxun Liu84744c12017-06-19 17:03:41 +00001928 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
1929 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
1930 /// insertion point of the builder. The caller is responsible for setting an
1931 /// appropriate alignment on
Daniel Dunbara7566f12010-02-09 02:48:28 +00001932 /// the alloca.
Yaxun Liu84744c12017-06-19 17:03:41 +00001933 ///
1934 /// \p ArraySize is the number of array elements to be allocated if it
1935 /// is not nullptr.
1936 ///
1937 /// LangAS::Default is the address space of pointers to local variables and
1938 /// temporaries, as exposed in the source language. In certain
1939 /// configurations, this is not the same as the alloca address space, and a
1940 /// cast is needed to lift the pointer from the alloca AS into
1941 /// LangAS::Default. This can happen when the target uses a restricted
1942 /// address space for the stack but the source language requires
1943 /// LangAS::Default to be a generic address space. The latter condition is
1944 /// common for most programming languages; OpenCL is an exception in that
1945 /// LangAS::Default is the private address space, which naturally maps
1946 /// to the stack.
1947 ///
1948 /// Because the address of a temporary is often exposed to the program in
1949 /// various ways, this function will perform the cast by default. The cast
1950 /// may be avoided by passing false as \p CastToDefaultAddrSpace; this is
1951 /// more efficient if the caller knows that the address will not be exposed.
1952 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
1953 llvm::Value *ArraySize = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00001954 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
Yaxun Liu84744c12017-06-19 17:03:41 +00001955 const Twine &Name = "tmp",
1956 llvm::Value *ArraySize = nullptr,
1957 bool CastToDefaultAddrSpace = true);
Mike Stumpfc496822009-02-08 23:14:22 +00001958
John McCall7f416cc2015-09-08 08:05:57 +00001959 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
1960 /// default ABI alignment of the given LLVM type.
1961 ///
1962 /// IMPORTANT NOTE: This is *not* generally the right alignment for
1963 /// any given AST type that happens to have been lowered to the
1964 /// given IR type. This should only ever be used for function-local,
1965 /// IR-driven manipulations like saving and restoring a value. Do
1966 /// not hand this address off to arbitrary IRGen routines, and especially
1967 /// do not pass it as an argument to a function that might expect a
1968 /// properly ABI-aligned value.
1969 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
1970 const Twine &Name = "tmp");
1971
1972 /// InitTempAlloca - Provide an initial value for the given alloca which
1973 /// will be observable at all locations in the function.
1974 ///
1975 /// The address should be something that was returned from one of
1976 /// the CreateTempAlloca or CreateMemTemp routines, and the
1977 /// initializer must be valid in the entry block (i.e. it must
1978 /// either be a constant or an argument value).
1979 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00001980
Daniel Dunbard0049182010-02-16 19:44:13 +00001981 /// CreateIRTemp - Create a temporary IR object of the given type, with
1982 /// appropriate alignment. This routine should only be used when an temporary
1983 /// value needs to be stored into an alloca (for example, to avoid explicit
1984 /// PHI construction), but the type is the IR type, not the type appropriate
1985 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00001986 ///
1987 /// That is, this is exactly equivalent to CreateMemTemp, but calling
1988 /// ConvertType instead of ConvertTypeForMem.
1989 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001990
Daniel Dunbara7566f12010-02-09 02:48:28 +00001991 /// CreateMemTemp - Create a temporary memory object of the given type, with
Yaxun Liu84744c12017-06-19 17:03:41 +00001992 /// appropriate alignment. Cast it to the default address space if
1993 /// \p CastToDefaultAddrSpace is true.
1994 Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
1995 bool CastToDefaultAddrSpace = true);
1996 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
1997 bool CastToDefaultAddrSpace = true);
Daniel Dunbara7566f12010-02-09 02:48:28 +00001998
John McCall7a626f62010-09-15 10:14:12 +00001999 /// CreateAggTemp - Create a temporary memory object for the given
2000 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00002001 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00002002 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00002003 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00002004 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00002005 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002006 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00002007 }
2008
John McCallad7c5c12011-02-08 08:22:06 +00002009 /// Emit a cast to void* in the appropriate address space.
2010 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2011
Chris Lattner8394d792007-06-05 20:53:16 +00002012 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2013 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00002014 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00002015
John McCalla2342eb2010-12-05 02:00:02 +00002016 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2017 void EmitIgnoredExpr(const Expr *E);
2018
Chris Lattner4647a212007-08-31 22:49:20 +00002019 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2020 /// any type. The result is returned as an RValue struct. If this is an
2021 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2022 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00002023 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00002024 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00002025 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00002026 AggValueSlot aggSlot = AggValueSlot::ignored(),
2027 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00002028
Mike Stumpfc496822009-02-08 23:14:22 +00002029 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2030 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00002031 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002032
Charles Davisc7d5c942015-09-17 20:55:33 +00002033 /// Emit a "reference" to a __builtin_ms_va_list; this is
2034 /// always the value of the expression, because a __builtin_ms_va_list is a
2035 /// pointer to a char.
2036 Address EmitMSVAListRef(const Expr *E);
2037
Gor Nishanov5eb58582017-03-26 02:18:05 +00002038 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
Mike Stumpfc496822009-02-08 23:14:22 +00002039 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00002040 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00002041
John McCall91ca10f2011-03-08 09:11:50 +00002042 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00002043 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00002044 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002045 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00002046
John McCall7f416cc2015-09-08 08:05:57 +00002047 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00002048
John McCall91ca10f2011-03-08 09:11:50 +00002049 /// EmitExprAsInit - Emits the code necessary to initialize a
2050 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00002051 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002052 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00002053
Fariborz Jahanian78652202013-01-25 23:57:05 +00002054 /// hasVolatileMember - returns true if aggregate type has a volatile
2055 /// member.
2056 bool hasVolatileMember(QualType T) {
2057 if (const RecordType *RT = T->getAs<RecordType>()) {
2058 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2059 return RD->hasVolatileMember();
2060 }
2061 return false;
2062 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002063 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002064 ///
2065 /// The difference to EmitAggregateCopy is that tail padding is not copied.
2066 /// This is required for correctness when assigning non-POD structures in C++.
John McCall7f416cc2015-09-08 08:05:57 +00002067 void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00002068 QualType EltTy) {
2069 bool IsVolatile = hasVolatileMember(EltTy);
John McCall7f416cc2015-09-08 08:05:57 +00002070 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002071 }
2072
John McCall7f416cc2015-09-08 08:05:57 +00002073 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
2074 QualType DestTy, QualType SrcTy) {
David Majnemerfd1e7392015-02-03 23:04:06 +00002075 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
David Majnemerfd1e7392015-02-03 23:04:06 +00002076 /*IsAssignment=*/false);
2077 }
2078
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002079 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00002080 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00002081 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00002082 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002083 /// \param isAssignment - If false, allow padding to be copied. This often
2084 /// yields more efficient.
John McCall7f416cc2015-09-08 08:05:57 +00002085 void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00002086 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002087 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00002088
Anders Carlsson9396a892008-09-11 09:15:33 +00002089 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00002090 Address GetAddrOfLocalVar(const VarDecl *VD) {
2091 auto it = LocalDeclMap.find(VD);
2092 assert(it != LocalDeclMap.end() &&
2093 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2094 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00002095 }
Mike Stumpfc496822009-02-08 23:14:22 +00002096
John McCallc07a0c72011-02-17 10:25:35 +00002097 /// getOpaqueLValueMapping - Given an opaque value expression (which
2098 /// must be mapped to an l-value), return its mapping.
2099 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
2100 assert(OpaqueValueMapping::shouldBindAsLValue(e));
2101
2102 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
2103 it = OpaqueLValues.find(e);
2104 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
2105 return it->second;
2106 }
2107
2108 /// getOpaqueRValueMapping - Given an opaque value expression (which
2109 /// must be mapped to an r-value), return its mapping.
2110 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
2111 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
2112
2113 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
2114 it = OpaqueRValues.find(e);
2115 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00002116 return it->second;
2117 }
2118
Richard Smith410306b2016-12-12 02:53:20 +00002119 /// Get the index of the current ArrayInitLoopExpr, if any.
2120 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2121
Dan Gohman75d69da2008-05-22 00:50:06 +00002122 /// getAccessedFieldNo - Given an encoded value and a result number, return
2123 /// the input field number being accessed.
2124 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2125
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002126 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002127 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002128
Vedant Kumarffd7c882017-04-14 22:03:34 +00002129 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2130 static bool IsWrappedCXXThis(const Expr *E);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00002131
Anders Carlssonc0964b62010-05-22 17:35:42 +00002132 /// EmitNullInitialization - Generate code to set a value of the given type to
2133 /// null, If the type contains data member pointers, they will be initialized
2134 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002135 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002136
Charles Davisc7d5c942015-09-17 20:55:33 +00002137 /// Emits a call to an LLVM variable-argument intrinsic, either
2138 /// \c llvm.va_start or \c llvm.va_end.
2139 /// \param ArgValue A reference to the \c va_list as emitted by either
2140 /// \c EmitVAListRef or \c EmitMSVAListRef.
2141 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2142 /// calls \c llvm.va_end.
2143 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2144
2145 /// Generate code to get an argument from the passed in pointer
2146 /// and update it accordingly.
2147 /// \param VE The \c VAArgExpr for which to generate code.
2148 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2149 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2150 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002151 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002152 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002153 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002154
John McCall82fe67b2011-07-09 01:37:26 +00002155 /// emitArrayLength - Compute the length of an array, even if it's a
2156 /// VLA, and drill down to the base element type.
2157 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2158 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002159 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002160
John McCall23c29fe2011-06-24 21:55:10 +00002161 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2162 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002163 ///
2164 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002165 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002166
John McCall23c29fe2011-06-24 21:55:10 +00002167 /// getVLASize - Returns an LLVM value that corresponds to the size,
2168 /// in non-variably-sized elements, of a variable length array type,
2169 /// plus that largest non-variably-sized element type. Assumes that
2170 /// the type has already been emitted with EmitVariablyModifiedType.
2171 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
2172 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002173
Anders Carlssona5d077d2009-04-14 16:58:56 +00002174 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2175 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002176 llvm::Value *LoadCXXThis() {
2177 assert(CXXThisValue && "no 'this' value for this function");
2178 return CXXThisValue;
2179 }
John McCall7f416cc2015-09-08 08:05:57 +00002180 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002181
Anders Carlssone36a6b32010-01-02 01:01:18 +00002182 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2183 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002184 // FIXME: Every place that calls LoadCXXVTT is something
2185 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002186 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002187 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2188 return CXXStructorImplicitParamValue;
2189 }
2190
John McCall6ce74722010-02-16 04:15:37 +00002191 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002192 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002193 Address
2194 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002195 const CXXRecordDecl *Derived,
2196 const CXXRecordDecl *Base,
2197 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002198
John McCall7f416cc2015-09-08 08:05:57 +00002199 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2200
Mike Stumpe5311b02009-11-30 20:08:49 +00002201 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2202 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002203 Address GetAddressOfBaseClass(Address Value,
2204 const CXXRecordDecl *Derived,
2205 CastExpr::path_const_iterator PathBegin,
2206 CastExpr::path_const_iterator PathEnd,
2207 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002208
John McCall7f416cc2015-09-08 08:05:57 +00002209 Address GetAddressOfDerivedClass(Address Value,
2210 const CXXRecordDecl *Derived,
2211 CastExpr::path_const_iterator PathBegin,
2212 CastExpr::path_const_iterator PathEnd,
2213 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002214
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002215 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2216 /// base constructor/destructor with virtual bases.
2217 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2218 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2219 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2220 bool Delegating);
2221
John McCallf8ff7b92010-02-23 00:48:20 +00002222 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2223 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002224 const FunctionArgList &Args,
2225 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002226 // It's important not to confuse this and the previous function. Delegating
2227 // constructors are the C++0x feature. The constructor delegate optimization
2228 // is used to reduce duplication in the base and complete consturctors where
2229 // they are substantially the same.
2230 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2231 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002232
Richard Smith5179eb72016-06-28 19:03:57 +00002233 /// Emit a call to an inheriting constructor (that is, one that invokes a
2234 /// constructor inherited from a base class) by inlining its definition. This
2235 /// is necessary if the ABI does not support forwarding the arguments to the
2236 /// base class constructor (because they're variadic or similar).
2237 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2238 CXXCtorType CtorType,
2239 bool ForVirtualBase,
2240 bool Delegating,
2241 CallArgList &Args);
2242
2243 /// Emit a call to a constructor inherited from a base class, passing the
2244 /// current constructor's arguments along unmodified (without even making
2245 /// a copy).
2246 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2247 bool ForVirtualBase, Address This,
2248 bool InheritedFromVBase,
2249 const CXXInheritedCtorInitExpr *E);
2250
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002251 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002252 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002253 Address This, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002254
Richard Smith5179eb72016-06-28 19:03:57 +00002255 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2256 bool ForVirtualBase, bool Delegating,
2257 Address This, CallArgList &Args);
2258
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002259 /// Emit assumption load for all bases. Requires to be be called only on
2260 /// most-derived class and not under construction of the object.
2261 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2262
2263 /// Emit assumption that vptr load == global vtable.
2264 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2265
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002266 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002267 Address This, Address Src,
2268 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002269
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002270 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002271 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002272 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002273 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002274 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002275
Anders Carlssond49844b2009-09-23 02:45:36 +00002276 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2277 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002278 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002279 const CXXConstructExpr *E,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002280 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002281
John McCall82fe67b2011-07-09 01:37:26 +00002282 static Destroyer destroyCXXObject;
2283
Anders Carlsson0a637412009-05-29 21:03:38 +00002284 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002285 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002286 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002287
John McCall99210dc2011-09-15 06:49:18 +00002288 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002289 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002290 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002291 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002292
Peter Collingbourne702b2842011-11-27 22:09:22 +00002293 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002294 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002295
David Majnemerdc012fa2015-04-22 21:38:15 +00002296 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2297 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2298
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002299 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002300 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002301
Eli Friedman24f55432009-11-18 00:57:03 +00002302 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002303 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2304 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002305
Richard Smith760520b2014-06-03 23:27:44 +00002306 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2307 const Expr *Arg, bool IsDelete);
2308
John McCall7f416cc2015-09-08 08:05:57 +00002309 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2310 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2311 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002312
Richard Smith69d0d262012-08-24 00:54:33 +00002313 /// \brief Situations in which we might emit a check for the suitability of a
2314 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002315 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002316 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002317 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002318 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002319 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002320 /// Checking the bound value in a reference binding. Must be suitably sized
2321 /// and aligned, but is not required to refer to an object (until the
2322 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002323 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002324 /// Checking the object expression in a non-static data member access. Must
2325 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002326 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002327 /// Checking the 'this' pointer for a call to a non-static member function.
2328 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002329 TCK_MemberCall,
2330 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002331 TCK_ConstructorCall,
2332 /// Checking the operand of a static_cast to a derived pointer type. Must be
2333 /// null or an object within its lifetime.
2334 TCK_DowncastPointer,
2335 /// Checking the operand of a static_cast to a derived reference type. Must
2336 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002337 TCK_DowncastReference,
2338 /// Checking the operand of a cast to a base object. Must be suitably sized
2339 /// and aligned.
2340 TCK_Upcast,
2341 /// Checking the operand of a cast to a virtual base object. Must be an
2342 /// object within its lifetime.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002343 TCK_UpcastToVirtualBase,
2344 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
2345 TCK_NonnullAssign
Richard Smith69d0d262012-08-24 00:54:33 +00002346 };
2347
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002348 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
2349 /// calls to EmitTypeCheck can be skipped.
2350 bool sanitizePerformTypeCheck() const;
2351
Richard Smith4d1458e2012-09-08 02:08:36 +00002352 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002353 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002354 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002355 QualType Type, CharUnits Alignment = CharUnits::Zero(),
Vedant Kumar18348ea2017-02-17 23:22:55 +00002356 SanitizerSet SkippedChecks = SanitizerSet());
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002357
Richard Smith539e4a72013-02-23 02:53:19 +00002358 /// \brief Emit a check that \p Base points into an array object, which
2359 /// we can access at index \p Index. \p Accessed should be \c false if we
2360 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2361 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2362 QualType IndexType, bool Accessed);
2363
Chris Lattner116ce8f2010-01-09 21:40:03 +00002364 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2365 bool isInc, bool isPre);
2366 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2367 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002368
2369 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002370 llvm::Value *OffsetValue = nullptr) {
2371 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2372 OffsetValue);
2373 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002374
Amara Emerson652795d2016-11-10 14:44:30 +00002375 /// Converts Location to a DebugLoc, if debug information is enabled.
2376 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2377
2378
Chris Lattner8394d792007-06-05 20:53:16 +00002379 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002380 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002381 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002382
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002383 /// EmitDecl - Emit a declaration.
2384 ///
2385 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002386 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002387
John McCall1c9c3fd2010-10-15 04:57:14 +00002388 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002389 ///
2390 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002391 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002392
David Blaikie73ca5692014-12-09 00:32:22 +00002393 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002394 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002395
John McCallbd309292010-07-06 01:34:17 +00002396 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2397 llvm::Value *Address);
2398
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002399 /// \brief Determine whether the given initializer is trivial in the sense
2400 /// that it requires no code to be generated.
2401 bool isTrivialInitializer(const Expr *Init);
2402
John McCall1c9c3fd2010-10-15 04:57:14 +00002403 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002404 ///
2405 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002406 void EmitAutoVarDecl(const VarDecl &D);
2407
2408 class AutoVarEmission {
2409 friend class CodeGenFunction;
2410
John McCall9e2e22f2011-02-22 07:16:58 +00002411 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002412
John McCall7f416cc2015-09-08 08:05:57 +00002413 /// The address of the alloca. Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002414 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002415 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002416
2417 llvm::Value *NRVOFlag;
2418
2419 /// True if the variable is a __block variable.
2420 bool IsByRef;
2421
2422 /// True if the variable is of aggregate type and has a constant
2423 /// initializer.
2424 bool IsConstantAggregate;
2425
Nadav Rotem1da30942013-03-23 06:43:35 +00002426 /// Non-null if we should use lifetime annotations.
2427 llvm::Value *SizeForLifetimeMarkers;
2428
John McCall9e2e22f2011-02-22 07:16:58 +00002429 struct Invalid {};
John McCall7f416cc2015-09-08 08:05:57 +00002430 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002431
John McCallc533cb72011-02-22 06:44:22 +00002432 AutoVarEmission(const VarDecl &variable)
John McCall7f416cc2015-09-08 08:05:57 +00002433 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Nadav Rotem1da30942013-03-23 06:43:35 +00002434 IsByRef(false), IsConstantAggregate(false),
Craig Topper8a13c412014-05-21 05:09:00 +00002435 SizeForLifetimeMarkers(nullptr) {}
John McCallc533cb72011-02-22 06:44:22 +00002436
John McCall7f416cc2015-09-08 08:05:57 +00002437 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002438
2439 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002440 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2441
Craig Topper8a13c412014-05-21 05:09:00 +00002442 bool useLifetimeMarkers() const {
2443 return SizeForLifetimeMarkers != nullptr;
2444 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002445 llvm::Value *getSizeForLifetimeMarkers() const {
2446 assert(useLifetimeMarkers());
2447 return SizeForLifetimeMarkers;
2448 }
2449
2450 /// Returns the raw, allocated address, which is not necessarily
2451 /// the address of the object itself.
John McCall7f416cc2015-09-08 08:05:57 +00002452 Address getAllocatedAddress() const {
2453 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002454 }
2455
John McCallc533cb72011-02-22 06:44:22 +00002456 /// Returns the address of the object within this declaration.
2457 /// Note that this does not chase the forwarding pointer for
2458 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002459 Address getObjectAddress(CodeGenFunction &CGF) const {
2460 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002461
John McCall7f416cc2015-09-08 08:05:57 +00002462 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002463 }
2464 };
2465 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2466 void EmitAutoVarInit(const AutoVarEmission &emission);
2467 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002468 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2469 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002470
John McCall1c9c3fd2010-10-15 04:57:14 +00002471 void EmitStaticVarDecl(const VarDecl &D,
2472 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002473
John McCall7f416cc2015-09-08 08:05:57 +00002474 class ParamValue {
2475 llvm::Value *Value;
2476 unsigned Alignment;
2477 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2478 public:
2479 static ParamValue forDirect(llvm::Value *value) {
2480 return ParamValue(value, 0);
2481 }
2482 static ParamValue forIndirect(Address addr) {
2483 assert(!addr.getAlignment().isZero());
2484 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2485 }
2486
2487 bool isIndirect() const { return Alignment != 0; }
2488 llvm::Value *getAnyValue() const { return Value; }
2489
2490 llvm::Value *getDirectValue() const {
2491 assert(!isIndirect());
2492 return Value;
2493 }
2494
2495 Address getIndirectAddress() const {
2496 assert(isIndirect());
2497 return Address(Value, CharUnits::fromQuantity(Alignment));
2498 }
2499 };
2500
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002501 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002502 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002503
John McCallc07a0c72011-02-17 10:25:35 +00002504 /// protectFromPeepholes - Protect a value that we're intending to
2505 /// store to the side, but which will probably be used later, from
2506 /// aggressive peepholing optimizations that might delete it.
2507 ///
2508 /// Pass the result to unprotectFromPeepholes to declare that
2509 /// protection is no longer required.
2510 ///
2511 /// There's no particular reason why this shouldn't apply to
2512 /// l-values, it's just that no existing peepholes work on pointers.
2513 PeepholeProtection protectFromPeepholes(RValue rvalue);
2514 void unprotectFromPeepholes(PeepholeProtection protection);
2515
Erich Keane623efd82017-03-30 21:48:55 +00002516 void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment,
2517 llvm::Value *OffsetValue = nullptr) {
2518 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2519 OffsetValue);
2520 }
2521
Chris Lattner84915fa2007-06-02 04:16:21 +00002522 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002523 // Statement Emission
2524 //===--------------------------------------------------------------------===//
2525
Mike Stumpfc496822009-02-08 23:14:22 +00002526 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002527 void EmitStopPoint(const Stmt *S);
2528
Mike Stumpfc496822009-02-08 23:14:22 +00002529 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2530 /// this function even if there is no current insertion point.
2531 ///
2532 /// This function may clear the current insertion point; callers should use
2533 /// EnsureInsertPoint if they wish to subsequently generate code without first
2534 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002535 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002536
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002537 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002538 /// necessarily require an insertion point or debug information; typically
2539 /// because the statement amounts to a jump or a container of other
2540 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002541 ///
2542 /// \return True if the statement was handled.
2543 bool EmitSimpleStmt(const Stmt *S);
2544
John McCall7f416cc2015-09-08 08:05:57 +00002545 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2546 AggValueSlot AVS = AggValueSlot::ignored());
2547 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2548 bool GetLast = false,
2549 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002550 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002551
Mike Stumpfc496822009-02-08 23:14:22 +00002552 /// EmitLabel - Emit the block for the given label. It is legal to call this
2553 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002554 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002555
Chris Lattnerac248202007-05-30 00:13:02 +00002556 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002557 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002558 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002559 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002560 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002561
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002562 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002563 ArrayRef<const Attr *> Attrs = None);
2564 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002565 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002566 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002567 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002568 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002569 void EmitBreakStmt(const BreakStmt &S);
2570 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002571 void EmitSwitchStmt(const SwitchStmt &S);
2572 void EmitDefaultStmt(const DefaultStmt &S);
2573 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002574 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002575 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002576
Anders Carlsson2e744e82008-08-30 19:51:14 +00002577 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002578 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2579 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002580 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002581 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002582
Gor Nishanov8df64e92016-10-27 16:28:31 +00002583 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov90be1212017-03-06 21:12:54 +00002584 void EmitCoreturnStmt(const CoreturnStmt &S);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002585 RValue EmitCoawaitExpr(const CoawaitExpr &E,
2586 AggValueSlot aggSlot = AggValueSlot::ignored(),
2587 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002588 LValue EmitCoawaitLValue(const CoawaitExpr *E);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002589 RValue EmitCoyieldExpr(const CoyieldExpr &E,
2590 AggValueSlot aggSlot = AggValueSlot::ignored(),
2591 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002592 LValue EmitCoyieldLValue(const CoyieldExpr *E);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002593 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2594
John McCallb609d3f2010-07-07 06:56:46 +00002595 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2596 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002597
Anders Carlsson52d78a52009-09-27 18:58:34 +00002598 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002599 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002600 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002601 void EnterSEHTryStmt(const SEHTryStmt &S);
2602 void ExitSEHTryStmt(const SEHTryStmt &S);
2603
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002604 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002605 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002606
2607 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2608 const SEHExceptStmt &Except);
2609
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002610 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2611 const SEHFinallyStmt &Finally);
2612
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002613 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2614 llvm::Value *ParentFP,
2615 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002616 llvm::Value *EmitSEHExceptionCode();
2617 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002618 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002619
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002620 /// Scan the outlined statement for captures from the parent function. For
2621 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002622 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002623 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002624 bool IsFilter);
2625
2626 /// Recovers the address of a local in a parent function. ParentVar is the
2627 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002628 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002629 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2630 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002631 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2632 Address ParentVar,
2633 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002634
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002635 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002636 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002637
Alexey Bataev1189bd02016-01-26 12:20:39 +00002638 /// Returns calculated size of the specified type.
2639 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002640 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002641 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002642 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002643 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002644 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002645 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002646 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002647 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2648 SourceLocation Loc);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002649 /// \brief Perform element by element copying of arrays with type \a
2650 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2651 /// generated by \a CopyGen.
2652 ///
2653 /// \param DestAddr Address of the destination array.
2654 /// \param SrcAddr Address of the source array.
2655 /// \param OriginalType Type of destination and source arrays.
2656 /// \param CopyGen Copying procedure that copies value of single array element
2657 /// to another single array element.
2658 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002659 Address DestAddr, Address SrcAddr, QualType OriginalType,
2660 const llvm::function_ref<void(Address, Address)> &CopyGen);
Alexey Bataev420d45b2015-04-14 05:11:24 +00002661 /// \brief Emit proper copying of data from one variable to another.
2662 ///
2663 /// \param OriginalType Original type of the copied variables.
2664 /// \param DestAddr Destination address.
2665 /// \param SrcAddr Source address.
2666 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2667 /// type of the base array element).
2668 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2669 /// the base array element).
2670 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2671 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002672 void EmitOMPCopy(QualType OriginalType,
2673 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002674 const VarDecl *DestVD, const VarDecl *SrcVD,
2675 const Expr *Copy);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002676 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2677 /// \a X = \a E \a BO \a E.
2678 ///
2679 /// \param X Value to be updated.
2680 /// \param E Update value.
2681 /// \param BO Binary operation for update operation.
2682 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2683 /// expression, false otherwise.
2684 /// \param AO Atomic ordering of the generated atomic instructions.
2685 /// \param CommonGen Code generator for complex expressions that cannot be
2686 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002687 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2688 /// generated, <false, RValue::get(nullptr)> otherwise.
2689 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002690 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2691 llvm::AtomicOrdering AO, SourceLocation Loc,
2692 const llvm::function_ref<RValue(RValue)> &CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002693 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002694 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002695 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2696 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00002697 void EmitOMPUseDevicePtrClause(
2698 const OMPClause &C, OMPPrivateScope &PrivateScope,
2699 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002700 /// \brief Emit code for copyin clause in \a D directive. The next code is
2701 /// generated at the start of outlined functions for directives:
2702 /// \code
2703 /// threadprivate_var1 = master_threadprivate_var1;
2704 /// operator=(threadprivate_var2, master_threadprivate_var2);
2705 /// ...
2706 /// __kmpc_barrier(&loc, global_tid);
2707 /// \endcode
2708 ///
2709 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2710 /// \returns true if at least one copyin variable is found, false otherwise.
2711 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Alexey Bataev38e89532015-04-16 04:54:05 +00002712 /// \brief Emit initial code for lastprivate variables. If some variable is
2713 /// not also firstprivate, then the default initialization is used. Otherwise
2714 /// initialization of this variable is performed by EmitOMPFirstprivateClause
2715 /// method.
2716 ///
2717 /// \param D Directive that may have 'lastprivate' directives.
2718 /// \param PrivateScope Private scope for capturing lastprivate variables for
2719 /// proper codegen in internal captured statement.
2720 ///
2721 /// \returns true if there is at least one lastprivate variable, false
2722 /// otherwise.
2723 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
2724 OMPPrivateScope &PrivateScope);
2725 /// \brief Emit final copying of lastprivate values to original variables at
2726 /// the end of the worksharing or simd directive.
2727 ///
2728 /// \param D Directive that has at least one 'lastprivate' directives.
2729 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
2730 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002731 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00002732 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002733 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00002734 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002735 /// Emit initial code for linear clauses.
2736 void EmitOMPLinearClause(const OMPLoopDirective &D,
2737 CodeGenFunction::OMPPrivateScope &PrivateScope);
2738 /// Emit final code for linear clauses.
2739 /// \param CondGen Optional conditional code for final part of codegen for
2740 /// linear clause.
2741 void EmitOMPLinearClauseFinal(
2742 const OMPLoopDirective &D,
2743 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002744 /// \brief Emit initial code for reduction variables. Creates reduction copies
2745 /// and initializes them with the values according to OpenMP standard.
2746 ///
2747 /// \param D Directive (possibly) with the 'reduction' clause.
2748 /// \param PrivateScope Private scope for capturing reduction variables for
2749 /// proper codegen in internal captured statement.
2750 ///
2751 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
2752 OMPPrivateScope &PrivateScope);
2753 /// \brief Emit final update of reduction values to original variables at
2754 /// the end of the directive.
2755 ///
2756 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00002757 /// \param ReductionKind The kind of reduction to perform.
2758 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
2759 const OpenMPDirectiveKind ReductionKind);
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00002760 /// \brief Emit initial code for linear variables. Creates private copies
2761 /// and initializes them with the values according to OpenMP standard.
2762 ///
2763 /// \param D Directive (possibly) with the 'linear' clause.
Alexey Bataev8c3edfe2017-08-16 15:58:46 +00002764 /// \return true if at least one linear variable is found that should be
2765 /// initialized with the value of the original variable, false otherwise.
2766 bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00002767
Alexey Bataev7292c292016-04-25 12:22:29 +00002768 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
2769 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002770 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00002771 TaskGenTy;
2772 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
2773 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00002774 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00002775
Alexey Bataev9959db52014-05-06 10:08:46 +00002776 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002777 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002778 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002779 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002780 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002781 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002782 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00002783 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002784 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002785 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002786 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002787 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002788 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00002789 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002790 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002791 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002792 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00002793 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002794 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00002795 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002796 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00002797 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002798 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00002799 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00002800 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002801 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002802 void
2803 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002804 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002805 void
2806 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00002807 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00002808 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002809 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002810 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002811 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002812 void EmitOMPDistributeParallelForDirective(
2813 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00002814 void EmitOMPDistributeParallelForSimdDirective(
2815 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002816 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00002817 void EmitOMPTargetParallelForSimdDirective(
2818 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00002819 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00002820 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00002821 void
2822 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00002823 void EmitOMPTeamsDistributeParallelForSimdDirective(
2824 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00002825 void EmitOMPTeamsDistributeParallelForDirective(
2826 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00002827 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00002828 void EmitOMPTargetTeamsDistributeDirective(
2829 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00002830 void EmitOMPTargetTeamsDistributeParallelForDirective(
2831 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00002832 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
2833 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00002834 void EmitOMPTargetTeamsDistributeSimdDirective(
2835 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002836
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00002837 /// Emit device code for the target directive.
2838 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
2839 StringRef ParentName,
2840 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00002841 static void
2842 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2843 const OMPTargetParallelDirective &S);
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00002844 static void
2845 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
2846 const OMPTargetTeamsDirective &S);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00002847 /// \brief Emit inner loop of the worksharing/simd construct.
2848 ///
2849 /// \param S Directive, for which the inner loop must be emitted.
2850 /// \param RequiresCleanup true, if directive has some associated private
2851 /// variables.
2852 /// \param LoopCond Bollean condition for loop continuation.
2853 /// \param IncExpr Increment expression for loop control variable.
2854 /// \param BodyGen Generator for the inner body of the inner loop.
2855 /// \param PostIncGen Genrator for post-increment code (required for ordered
2856 /// loop directvies).
2857 void EmitOMPInnerLoop(
2858 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
2859 const Expr *IncExpr,
2860 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
2861 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00002862
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002863 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00002864 /// Emit initial code for loop counters of loop-based directives.
2865 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
2866 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00002867
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002868 /// Helper for the OpenMP loop directives.
2869 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
2870
2871 /// \brief Emit code for the worksharing loop-based directive.
2872 /// \return true, if this construct has any lastprivate clause, false -
2873 /// otherwise.
2874 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
2875 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
2876 const CodeGenDispatchBoundsTy &CGDispatchBounds);
2877
Alexander Musmanc6388682014-12-15 07:07:06 +00002878private:
George Burgess IVe3763372016-12-22 02:50:20 +00002879 /// Helpers for blocks
2880 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
2881
Alexander Musmanc6388682014-12-15 07:07:06 +00002882 /// Helpers for the OpenMP loop directives.
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002883 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
Alexey Bataevef549a82016-03-09 09:49:09 +00002884 void EmitOMPSimdFinal(
2885 const OMPLoopDirective &D,
2886 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002887
2888 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
2889 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
2890
2891 /// struct with the values to be passed to the OpenMP loop-related functions
2892 struct OMPLoopArguments {
2893 /// loop lower bound
2894 Address LB = Address::invalid();
2895 /// loop upper bound
2896 Address UB = Address::invalid();
2897 /// loop stride
2898 Address ST = Address::invalid();
2899 /// isLastIteration argument for runtime functions
2900 Address IL = Address::invalid();
2901 /// Chunk value generated by sema
2902 llvm::Value *Chunk = nullptr;
2903 /// EnsureUpperBound
2904 Expr *EUB = nullptr;
2905 /// IncrementExpression
2906 Expr *IncExpr = nullptr;
2907 /// Loop initialization
2908 Expr *Init = nullptr;
2909 /// Loop exit condition
2910 Expr *Cond = nullptr;
2911 /// Update of LB after a whole chunk has been executed
2912 Expr *NextLB = nullptr;
2913 /// Update of UB after a whole chunk has been executed
2914 Expr *NextUB = nullptr;
2915 OMPLoopArguments() = default;
2916 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
2917 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
2918 Expr *IncExpr = nullptr, Expr *Init = nullptr,
2919 Expr *Cond = nullptr, Expr *NextLB = nullptr,
2920 Expr *NextUB = nullptr)
2921 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
2922 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
2923 NextUB(NextUB) {}
2924 };
2925 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
2926 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
2927 const OMPLoopArguments &LoopArgs,
2928 const CodeGenLoopTy &CodeGenLoop,
2929 const CodeGenOrderedTy &CodeGenOrdered);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00002930 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00002931 bool IsMonotonic, const OMPLoopDirective &S,
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00002932 OMPPrivateScope &LoopScope, bool Ordered,
2933 const OMPLoopArguments &LoopArgs,
2934 const CodeGenDispatchBoundsTy &CGDispatchBounds);
2935 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
2936 const OMPLoopDirective &S,
2937 OMPPrivateScope &LoopScope,
2938 const OMPLoopArguments &LoopArgs,
2939 const CodeGenLoopTy &CodeGenLoopContent);
Alexey Bataev0f34da12015-07-02 04:17:07 +00002940 /// \brief Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00002941 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00002942
2943public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00002944
Chris Lattner208ae962007-05-30 17:57:17 +00002945 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002946 // LValue Expression Emission
2947 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002948
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002949 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2950 RValue GetUndefRValue(QualType Ty);
2951
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002952 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2953 /// and issue an ErrorUnsupported style diagnostic (using the
2954 /// provided Name).
2955 RValue EmitUnsupportedRValue(const Expr *E,
2956 const char *Name);
2957
Mike Stumpfc496822009-02-08 23:14:22 +00002958 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2959 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002960 LValue EmitUnsupportedLValue(const Expr *E,
2961 const char *Name);
2962
Chris Lattner8394d792007-06-05 20:53:16 +00002963 /// EmitLValue - Emit code to compute a designator that specifies the location
2964 /// of the expression.
2965 ///
2966 /// This can return one of two things: a simple address or a bitfield
2967 /// reference. In either case, the LLVM Value* in the LValue structure is
2968 /// guaranteed to be an LLVM pointer type.
2969 ///
2970 /// If this returns a bitfield reference, nothing about the pointee type of
2971 /// the LLVM value is known: For example, it may not be a pointer to an
2972 /// integer.
2973 ///
2974 /// If this returns a normal address, and if the lvalue's C type is fixed
2975 /// size, this method guarantees that the returned pointer type will point to
2976 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2977 /// variable length type, this is not possible.
2978 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002979 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002980
Richard Smith4d1458e2012-09-08 02:08:36 +00002981 /// \brief Same as EmitLValue but additionally we generate checking code to
2982 /// guard against undefined behavior. This is only suitable when we know
2983 /// that the address will be used to access the object.
2984 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002985
John McCall7f416cc2015-09-08 08:05:57 +00002986 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002987 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00002988
John McCalla8ec7eb2013-03-07 21:37:17 +00002989 void EmitAtomicInit(Expr *E, LValue lvalue);
2990
David Majnemera5b195a2015-02-14 01:35:12 +00002991 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00002992
2993 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
2994 AggValueSlot Slot = AggValueSlot::ignored());
2995
Nick Lewycky2d84e842013-10-02 02:29:49 +00002996 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00002997 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00002998 AggValueSlot slot = AggValueSlot::ignored());
2999
3000 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3001
David Majnemera5b195a2015-02-14 01:35:12 +00003002 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3003 bool IsVolatile, bool isInit);
3004
Alexey Bataevb4505a72015-03-30 05:20:59 +00003005 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00003006 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00003007 llvm::AtomicOrdering Success =
3008 llvm::AtomicOrdering::SequentiallyConsistent,
3009 llvm::AtomicOrdering Failure =
3010 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00003011 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3012
Alexey Bataevb4505a72015-03-30 05:20:59 +00003013 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00003014 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00003015 bool IsVolatile);
3016
John McCall3a7f6922010-10-27 20:58:56 +00003017 /// EmitToMemory - Change a scalar value from its value
3018 /// representation to its in-memory representation.
3019 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3020
3021 /// EmitFromMemory - Change a scalar value from its memory
3022 /// representation to its value representation.
3023 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3024
Vedant Kumar5a972652017-02-27 19:46:19 +00003025 /// Check if the scalar \p Value is within the valid range for the given
3026 /// type \p Ty.
3027 ///
3028 /// Returns true if a check is needed (even if the range is unknown).
3029 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3030 SourceLocation Loc);
3031
Daniel Dunbar1d425462009-02-10 00:57:50 +00003032 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3033 /// care to appropriately convert from the memory representation to
3034 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003035 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003036 SourceLocation Loc,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00003037 LValueBaseInfo BaseInfo =
3038 LValueBaseInfo(AlignmentSource::Type),
Craig Topper8a13c412014-05-21 05:09:00 +00003039 llvm::MDNode *TBAAInfo = nullptr,
Manman Renc451e572013-04-04 21:53:22 +00003040 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003041 uint64_t TBAAOffset = 0,
3042 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003043
3044 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3045 /// care to appropriately convert from the memory representation to
3046 /// the LLVM value representation. The l-value must be a simple
3047 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003048 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003049
3050 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3051 /// care to appropriately convert from the memory representation to
3052 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003053 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3054 bool Volatile, QualType Ty,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00003055 LValueBaseInfo BaseInfo =
3056 LValueBaseInfo(AlignmentSource::Type),
Craig Topper8a13c412014-05-21 05:09:00 +00003057 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false,
Manman Renc451e572013-04-04 21:53:22 +00003058 QualType TBAABaseTy = QualType(),
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003059 uint64_t TBAAOffset = 0, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003060
3061 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3062 /// care to appropriately convert from the memory representation to
3063 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00003064 /// l-value. The isInit flag indicates whether this is an initialization.
3065 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3066 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003067
Chris Lattner8394d792007-06-05 20:53:16 +00003068 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3069 /// this method emits the address of the lvalue, then loads the result as an
3070 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003071 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00003072 RValue EmitLoadOfExtVectorElementLValue(LValue V);
Vedant Kumar129edab2017-03-09 16:06:27 +00003073 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
Renato Golin230c5eb2014-05-19 18:15:42 +00003074 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00003075
Chris Lattner8394d792007-06-05 20:53:16 +00003076 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3077 /// lvalue, where both are guaranteed to the have the same type, and that type
3078 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00003079 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003080 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00003081 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003082
Nick Lewycky2d84e842013-10-02 02:29:49 +00003083 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3084 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003085 ///
Mike Stumpfc496822009-02-08 23:14:22 +00003086 /// \param Result [out] - If non-null, this will be set to a Value* for the
3087 /// bit-field contents after the store, appropriate for use as the result of
3088 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00003089 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00003090 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00003091
John McCall4f29b492010-11-16 23:07:28 +00003092 /// Emit an l-value for an assignment (simple or compound) of complex type.
3093 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003094 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00003095 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3096 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00003097
Chris Lattner57540c52011-04-15 05:22:18 +00003098 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00003099 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003100 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003101 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00003102 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003103 // Note: only available for agg return types
3104 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00003105 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00003106 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00003107 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00003108 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00003109 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00003110 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3111 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00003112 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3113 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00003114 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00003115 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00003116 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00003117 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00003118 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00003119 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00003120 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00003121 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00003122 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Fariborz Jahanian91b2fa22014-08-19 17:17:40 +00003123
John McCall7f416cc2015-09-08 08:05:57 +00003124 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003125
Nick Lewycky2d84e842013-10-02 02:29:49 +00003126 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00003127
John McCall7f416cc2015-09-08 08:05:57 +00003128 Address EmitArrayToPointerDecay(const Expr *Array,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00003129 LValueBaseInfo *BaseInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003130
John McCall71335052012-03-10 03:05:10 +00003131 class ConstantEmission {
3132 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3133 ConstantEmission(llvm::Constant *C, bool isReference)
3134 : ValueAndIsReference(C, isReference) {}
3135 public:
3136 ConstantEmission() {}
3137 static ConstantEmission forReference(llvm::Constant *C) {
3138 return ConstantEmission(C, true);
3139 }
3140 static ConstantEmission forValue(llvm::Constant *C) {
3141 return ConstantEmission(C, false);
3142 }
3143
Aaron Ballman67347662015-02-15 22:00:28 +00003144 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00003145 return ValueAndIsReference.getOpaqueValue() != nullptr;
3146 }
John McCall71335052012-03-10 03:05:10 +00003147
3148 bool isReference() const { return ValueAndIsReference.getInt(); }
3149 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3150 assert(isReference());
3151 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3152 refExpr->getType());
3153 }
3154
3155 llvm::Constant *getValue() const {
3156 assert(!isReference());
3157 return ValueAndIsReference.getPointer();
3158 }
3159 };
3160
John McCall113bee02012-03-10 09:33:50 +00003161 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00003162
John McCallfe96e0b2011-11-06 09:01:30 +00003163 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3164 AggValueSlot slot = AggValueSlot::ignored());
3165 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3166
Daniel Dunbar722f4242009-04-22 05:08:15 +00003167 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003168 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00003169 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00003170 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003171
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003172 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3173 /// if the Field is a reference, this will return the address of the reference
3174 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003175 LValue EmitLValueForFieldInitialization(LValue Base,
3176 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003177
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003178 LValue EmitLValueForIvar(QualType ObjectTy,
3179 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003180 unsigned CVRQualifiers);
3181
Anders Carlsson3be22e22009-05-30 23:23:33 +00003182 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003183 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00003184 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003185 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003186 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003187
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003188 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003189 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003190 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003191 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003192 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003193 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003194
Chris Lattnerd7f58862007-06-02 05:24:33 +00003195 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003196 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003197 //===--------------------------------------------------------------------===//
3198
Mike Stumpfc496822009-02-08 23:14:22 +00003199 /// EmitCall - Generate a call of the given function, expecting the given
3200 /// result type, and using the given argument list which specifies both the
3201 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003202 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003203 ReturnValueSlot ReturnValue, const CallArgList &Args,
Craig Topper8a13c412014-05-21 05:09:00 +00003204 llvm::Instruction **callOrInvoke = nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003205
John McCallb92ab1a2016-10-26 23:46:34 +00003206 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003207 ReturnValueSlot ReturnValue,
Peter Collingbournef7706832014-12-12 23:41:25 +00003208 llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003209 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003210 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003211 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3212 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003213
Eric Christopherc7e79db2015-11-12 00:44:04 +00003214 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003215
John McCall882987f2013-02-28 19:01:20 +00003216 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3217 const Twine &name = "");
3218 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3219 ArrayRef<llvm::Value*> args,
3220 const Twine &name = "");
3221 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3222 const Twine &name = "");
3223 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3224 ArrayRef<llvm::Value*> args,
3225 const Twine &name = "");
3226
John McCallbd309292010-07-06 01:34:17 +00003227 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003228 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00003229 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00003230 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3231 ArrayRef<llvm::Value*> args,
3232 const Twine &name = "");
3233 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3234 const Twine &name = "");
3235 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3236 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00003237
John McCallb92ab1a2016-10-26 23:46:34 +00003238 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
3239 NestedNameSpecifier *Qual,
3240 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00003241
John McCallb92ab1a2016-10-26 23:46:34 +00003242 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
3243 CXXDtorType Type,
3244 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003245
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003246 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003247 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3248 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003249 ReturnValueSlot ReturnValue, llvm::Value *This,
3250 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003251 QualType ImplicitParamTy, const CallExpr *E,
3252 CallArgList *RtlArgs);
John McCallb92ab1a2016-10-26 23:46:34 +00003253 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3254 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003255 llvm::Value *This, llvm::Value *ImplicitParam,
3256 QualType ImplicitParamTy, const CallExpr *E,
3257 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003258 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3259 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003260 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3261 const CXXMethodDecl *MD,
3262 ReturnValueSlot ReturnValue,
3263 bool HasQualifier,
3264 NestedNameSpecifier *Qualifier,
3265 bool IsArrow, const Expr *Base);
3266 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003267 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3268 llvm::Value *memberPtr,
3269 const MemberPointerType *memberPtrType,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00003270 LValueBaseInfo *BaseInfo = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003271 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3272 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003273
Anders Carlsson4034a952009-05-27 04:18:27 +00003274 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003275 const CXXMethodDecl *MD,
3276 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003277 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003278
Peter Collingbournefe883422011-10-06 18:29:37 +00003279 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3280 ReturnValueSlot ReturnValue);
3281
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003282 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3283 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003284
Mike Stump11289f42009-09-09 15:08:12 +00003285 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00003286 unsigned BuiltinID, const CallExpr *E,
3287 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003288
Anders Carlssonbfb36712009-12-24 21:13:40 +00003289 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003290
Mike Stumpfc496822009-02-08 23:14:22 +00003291 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3292 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003293 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3294
Kevin Qin1718af62013-11-14 02:45:18 +00003295 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3296 const llvm::CmpInst::Predicate Fp,
3297 const llvm::CmpInst::Predicate Ip,
3298 const llvm::Twine &Name = "");
Chris Lattner5cc15e02010-03-03 19:03:45 +00003299 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tim Northover8fe03d62014-02-21 11:57:24 +00003300
3301 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3302 unsigned LLVMIntrinsic,
3303 unsigned AltLLVMIntrinsic,
3304 const char *NameHint,
3305 unsigned Modifier,
3306 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003307 SmallVectorImpl<llvm::Value *> &Ops,
John McCall7f416cc2015-09-08 08:05:57 +00003308 Address PtrOp0, Address PtrOp1);
Tim Northover8fe03d62014-02-21 11:57:24 +00003309 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3310 unsigned Modifier, llvm::Type *ArgTy,
3311 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003312 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003313 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003314 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003315 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003316 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003317 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003318 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003319 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3320 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003321 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Tim Northover573cbee2014-05-24 12:52:07 +00003322 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003323
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003324 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003325 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3326 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003327 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003328 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003329 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003330 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3331 const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003332
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003333private:
3334 enum class MSVCIntrin;
3335
3336public:
3337 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3338
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003339 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3340
Daniel Dunbar66912a12008-08-20 00:28:19 +00003341 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003342 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003343 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003344 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3345 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3346 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003347 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003348 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003349 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3350 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003351
John McCall31168b02011-06-15 23:02:42 +00003352 /// Retrieves the default cleanup kind for an ARC cleanup.
3353 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3354 CleanupKind getARCCleanupKind() {
3355 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3356 ? NormalAndEHCleanup : NormalCleanup;
3357 }
3358
3359 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003360 void EmitARCInitWeak(Address addr, llvm::Value *value);
3361 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003362 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003363 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3364 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3365 void EmitARCCopyWeak(Address dst, Address src);
3366 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003367 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3368 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003369 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003370 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003371 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003372 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003373 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003374 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003375 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003376 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003377 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003378 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003379 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3380 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3381 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003382 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003383
3384 std::pair<LValue,llvm::Value*>
3385 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3386 std::pair<LValue,llvm::Value*>
3387 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003388 std::pair<LValue,llvm::Value*>
3389 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003390
John McCall248512a2011-10-01 10:32:24 +00003391 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003392 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3393 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3394
John McCallff613032011-10-04 06:23:45 +00003395 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003396 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3397 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003398 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3399 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003400 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003401
Craig Topper00bbdcf2014-06-28 23:22:23 +00003402 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003403
John McCall82fe67b2011-07-09 01:37:26 +00003404 static Destroyer destroyARCStrongImprecise;
3405 static Destroyer destroyARCStrongPrecise;
3406 static Destroyer destroyARCWeak;
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00003407 static Destroyer emitARCIntrinsicUse;
John McCall82fe67b2011-07-09 01:37:26 +00003408
John McCall31168b02011-06-15 23:02:42 +00003409 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3410 llvm::Value *EmitObjCAutoreleasePoolPush();
3411 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3412 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3413 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3414
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003415 /// \brief Emits a reference binding to the passed in expression.
3416 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003417
Chris Lattner6278e6a2007-08-11 00:04:45 +00003418 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003419 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003420 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003421
3422 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003423
3424 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3425 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003426 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003427
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003428 /// Emit a conversion from the specified type to the specified destination
3429 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003430 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003431 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003432
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003433 /// Emit a conversion from the specified complex type to the specified
3434 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003435 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003436 QualType DstTy,
3437 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003438
John McCall7a626f62010-09-15 10:14:12 +00003439 /// EmitAggExpr - Emit the computation of the specified expression
3440 /// of aggregate type. The result is computed into the given slot,
3441 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003442 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003443
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003444 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3445 /// aggregate type into a temporary LValue.
3446 LValue EmitAggExprToLValue(const Expr *E);
3447
John McCall1bd25562011-06-24 23:21:27 +00003448 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3449 /// make sure it survives garbage collection until this point.
3450 void EmitExtendGCLifetime(llvm::Value *object);
3451
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003452 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003453 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003454 ComplexPairTy EmitComplexExpr(const Expr *E,
3455 bool IgnoreReal = false,
3456 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003457
John McCall47fb9502013-03-07 21:37:08 +00003458 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3459 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003460 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003461
John McCall47fb9502013-03-07 21:37:08 +00003462 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003463 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003464
3465 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003466 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003467
John McCall7f416cc2015-09-08 08:05:57 +00003468 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3469 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3470
Chandler Carruth84537952012-03-30 19:44:53 +00003471 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3472 /// global variable that has already been created for it. If the initializer
3473 /// has a different type than GV does, this may free GV and return a different
3474 /// one. Otherwise it just returns GV.
3475 llvm::GlobalVariable *
3476 AddInitializerToStaticVarDecl(const VarDecl &D,
3477 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003478
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003479
Anders Carlssonf40886a2009-08-08 21:45:14 +00003480 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3481 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003482 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3483 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003484
David Majnemerb3341ea2014-10-05 05:05:40 +00003485 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3486 llvm::Constant *Addr);
3487
John McCallc84ed6a2012-05-01 06:13:13 +00003488 /// Call atexit() with a function that passes the given argument to
3489 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003490 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3491 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003492
John McCallcdf7ef52010-11-06 09:44:32 +00003493 /// Emit code in this function to perform a guarded variable
3494 /// initialization. Guarded initializations are used when it's not
3495 /// possible to prove that an initialization will be done exactly
3496 /// once, e.g. with a static local variable or a static data member
3497 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003498 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003499 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003500
Richard Smithae8d62c2017-07-26 22:01:09 +00003501 enum class GuardKind { VariableGuard, TlsGuard };
3502
3503 /// Emit a branch to select whether or not to perform guarded initialization.
3504 void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
3505 llvm::BasicBlock *InitBlock,
3506 llvm::BasicBlock *NoInitBlock,
3507 GuardKind Kind, const VarDecl *D);
3508
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003509 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3510 /// variables.
3511 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003512 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003513 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003514
John McCallee08c532012-04-06 18:21:03 +00003515 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003516 /// variables.
Sanjoy Dase369bd92017-05-01 17:08:00 +00003517 void GenerateCXXGlobalDtorsFunc(
3518 llvm::Function *Fn,
3519 const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
3520 &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003521
John McCalla738c252011-03-09 04:27:21 +00003522 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3523 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003524 llvm::GlobalVariable *Addr,
3525 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003526
John McCall7a626f62010-09-15 10:14:12 +00003527 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00003528
John McCall7f416cc2015-09-08 08:05:57 +00003529 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003530
John McCall08ef4662011-11-10 08:15:53 +00003531 void enterFullExpression(const ExprWithCleanups *E) {
3532 if (E->getNumObjects() == 0) return;
3533 enterNonTrivialFullExpression(E);
3534 }
3535 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003536
Richard Smithea852322013-05-07 21:53:22 +00003537 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003538
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003539 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3540
Tim Northovercc2a6e02015-11-09 19:56:35 +00003541 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003542
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003543 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003544 // Annotations Emission
3545 //===--------------------------------------------------------------------===//
3546
3547 /// Emit an annotation call (intrinsic or builtin).
3548 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3549 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003550 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003551 SourceLocation Location);
3552
3553 /// Emit local annotations for the local variable V, declared by D.
3554 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3555
3556 /// Emit field annotations for the given field & value. Returns the
3557 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003558 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003559
3560 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003561 // Internal Helpers
3562 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003563
Chris Lattner5b1964b2008-11-11 07:41:27 +00003564 /// ContainsLabel - Return true if the statement contains a label in it. If
3565 /// this statement is not executed normally, it not containing a label means
3566 /// that we can just remove the code.
3567 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003568
Chris Lattner29911cc2011-02-28 00:18:40 +00003569 /// containsBreak - Return true if the statement contains a break out of it.
3570 /// If the statement (recursively) contains a switch or loop with a break
3571 /// inside of it, this is fine.
3572 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003573
3574 /// Determine if the given statement might introduce a declaration into the
3575 /// current scope, by being a (possibly-labelled) DeclStmt.
3576 static bool mightAddDeclToScope(const Stmt *S);
Chris Lattner29911cc2011-02-28 00:18:40 +00003577
Daniel Dunbar682712c2008-11-12 10:12:14 +00003578 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003579 /// to a constant, or if it does but contains a label, return false. If it
3580 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003581 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3582 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003583
Chris Lattner29911cc2011-02-28 00:18:40 +00003584 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3585 /// to a constant, or if it does but contains a label, return false. If it
3586 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00003587 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3588 bool AllowLabels = false);
3589
Chris Lattnercd439292008-11-12 08:04:58 +00003590 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3591 /// if statement) to the specified blocks. Based on the condition, this might
3592 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00003593 /// TrueCount should be the number of times we expect the condition to
3594 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00003595 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00003596 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00003597
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003598 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
3599 /// nonnull, if \p LHS is marked _Nonnull.
3600 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
3601
Vedant Kumar175b6d12017-07-13 20:55:26 +00003602 /// An enumeration which makes it easier to specify whether or not an
3603 /// operation is a subtraction.
3604 enum { NotSubtraction = false, IsSubtraction = true };
3605
Vedant Kumara125eb52017-06-01 19:22:18 +00003606 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
3607 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003608 /// \p SignedIndices indicates whether any of the GEP indices are signed.
Vedant Kumar175b6d12017-07-13 20:55:26 +00003609 /// \p IsSubtraction indicates whether the expression used to form the GEP
3610 /// is a subtraction.
Vedant Kumara125eb52017-06-01 19:22:18 +00003611 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
3612 ArrayRef<llvm::Value *> IdxList,
Vedant Kumar6dbf4272017-06-12 18:42:51 +00003613 bool SignedIndices,
Vedant Kumar175b6d12017-07-13 20:55:26 +00003614 bool IsSubtraction,
Vedant Kumara125eb52017-06-01 19:22:18 +00003615 SourceLocation Loc,
3616 const Twine &Name = "");
3617
Vedant Kumar10c31022017-07-29 00:19:51 +00003618 /// Specifies which type of sanitizer check to apply when handling a
3619 /// particular builtin.
3620 enum BuiltinCheckKind {
3621 BCK_CTZPassedZero,
3622 BCK_CLZPassedZero,
3623 };
3624
3625 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
3626 /// enabled, a runtime check specified by \p Kind is also emitted.
3627 llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
3628
Richard Smithe30752c2012-10-09 19:52:38 +00003629 /// \brief Emit a description of a type in a format suitable for passing to
3630 /// a runtime sanitizer handler.
3631 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
3632
3633 /// \brief Convert a value into a format suitable for passing to a runtime
3634 /// sanitizer handler.
3635 llvm::Value *EmitCheckValue(llvm::Value *V);
3636
3637 /// \brief Emit a description of a source location in a format suitable for
3638 /// passing to a runtime sanitizer handler.
3639 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
3640
Richard Smithde670682012-11-01 22:15:34 +00003641 /// \brief Create a basic block that will call a handler function in a
3642 /// sanitizer runtime with the provided arguments, and create a conditional
3643 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00003644 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00003645 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00003646 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003647
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003648 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
3649 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003650 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
3651 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
3652 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00003653
Richard Smithde670682012-11-01 22:15:34 +00003654 /// \brief Create a basic block that will call the trap intrinsic, and emit a
3655 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00003656 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00003657
Akira Hatanaka85365cd2015-07-02 22:15:41 +00003658 /// \brief Emit a call to trap or debugtrap and attach function attribute
3659 /// "trap-func-name" if specified.
3660 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
3661
Evgeniy Stepanov1a8030e2017-04-07 23:00:38 +00003662 /// \brief Emit a stub for the cross-DSO CFI check function.
3663 void EmitCfiCheckStub();
3664
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00003665 /// \brief Emit a cross-DSO CFI failure handling function.
3666 void EmitCfiCheckFail();
3667
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003668 /// \brief Create a check for a function parameter that may potentially be
3669 /// declared as non-null.
3670 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003671 AbstractCallee AC, unsigned ParmNum);
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003672
Anders Carlsson093bdff2010-03-30 03:27:09 +00003673 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00003674 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00003675
John McCall23f66262010-05-26 22:34:26 +00003676 /// EmitDelegateCallArg - We are performing a delegate call; that
3677 /// is, the current function is delegating to another one. Produce
3678 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003679 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
3680 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00003681
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003682 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
3683 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00003684 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00003685
Chris Lattnercd439292008-11-12 08:04:58 +00003686private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00003687 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003688 void EmitReturnOfRValue(RValue RV, QualType Ty);
3689
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003690 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
3691
3692 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
3693 DeferredReplacements;
3694
John McCall7f416cc2015-09-08 08:05:57 +00003695 /// Set the address of a local variable.
3696 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
3697 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
3698 LocalDeclMap.insert({VD, Addr});
3699 }
3700
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003701 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
3702 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
3703 ///
3704 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003705 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00003706 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003707
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003708 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
3709 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
3710 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
3711 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
3712 SmallVectorImpl<llvm::Value *> &IRCallArgs,
3713 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00003714
Chad Rosier59df25b2012-08-23 20:00:18 +00003715 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00003716 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00003717
Chad Rosier59df25b2012-08-23 20:00:18 +00003718 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00003719 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003720 std::string &ConstraintStr,
3721 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00003722
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003723 /// \brief Attempts to statically evaluate the object size of E. If that
3724 /// fails, emits code to figure the size of E out for us. This is
3725 /// pass_object_size aware.
George Burgess IV0d6592a2017-02-23 05:59:56 +00003726 ///
3727 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003728 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003729 llvm::IntegerType *ResType,
3730 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003731
3732 /// \brief Emits the size of E, as required by __builtin_object_size. This
3733 /// function is aware of pass_object_size parameters, and will act accordingly
3734 /// if E is a parameter with the pass_object_size attribute.
3735 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003736 llvm::IntegerType *ResType,
3737 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003738
Reid Kleckner89077a12013-12-17 19:46:40 +00003739public:
Douglas Gregore83b9562015-07-07 03:57:53 +00003740#ifndef NDEBUG
3741 // Determine whether the given argument is an Objective-C method
3742 // that may have type parameters in its signature.
3743 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
3744 const DeclContext *dc = method->getDeclContext();
3745 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
3746 return classDecl->getTypeParamListAsWritten();
3747 }
3748
3749 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
3750 return catDecl->getTypeParamList();
3751 }
3752
3753 return false;
3754 }
3755
3756 template<typename T>
3757 static bool isObjCMethodWithTypeParams(const T *) { return false; }
3758#endif
3759
Richard Smitha560ccf2016-09-29 21:30:12 +00003760 enum class EvaluationOrder {
3761 ///! No language constraints on evaluation order.
3762 Default,
3763 ///! Language semantics require left-to-right evaluation.
3764 ForceLeftToRight,
3765 ///! Language semantics require right-to-left evaluation.
3766 ForceRightToLeft
3767 };
3768
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003769 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00003770 template <typename T>
3771 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00003772 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003773 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003774 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003775 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003776 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00003777 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003778
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003779 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
3780 "Can't skip parameters if type info is not provided");
3781 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00003782#ifndef NDEBUG
3783 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
3784#endif
3785
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003786 // First, use the argument types that the type info knows about
3787 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
3788 E = CallArgTypeInfo->param_type_end();
3789 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00003790 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003791 assert((isGenericMethod ||
3792 ((*I)->isVariablyModifiedType() ||
3793 (*I).getNonReferenceType()->isObjCRetainableType() ||
3794 getContext()
3795 .getCanonicalType((*I).getNonReferenceType())
3796 .getTypePtr() ==
3797 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00003798 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00003799 .getTypePtr())) &&
3800 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003801 ArgTypes.push_back(*I);
3802 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00003803 }
Mike Stump11289f42009-09-09 15:08:12 +00003804
Reid Kleckner739756c2013-12-04 19:23:12 +00003805 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00003806 // function.
David Blaikief05779e2015-07-21 18:37:18 +00003807 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
3808 CallArgTypeInfo->isVariadic()) &&
3809 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00003810
Anders Carlsson603d6af2009-04-18 20:20:22 +00003811 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00003812 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00003813 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00003814
Vedant Kumared00ea02017-03-06 05:28:22 +00003815 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00003816 }
John McCalld4f4b7f2010-03-03 04:15:11 +00003817
Reid Kleckner739756c2013-12-04 19:23:12 +00003818 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00003819 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003820 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00003821 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00003822 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00003823
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00003824 /// EmitPointerWithAlignment - Given an expression with a pointer type,
3825 /// emit the value and compute our best estimate of the alignment of the
3826 /// pointee.
John McCall7f416cc2015-09-08 08:05:57 +00003827 ///
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00003828 /// \param BaseInfo - If non-null, this will be initialized with
3829 /// information about the source of the alignment and the may-alias
3830 /// attribute. Note that this function will conservatively fall back on
3831 /// the type when it doesn't recognize the expression and may-alias will
3832 /// be set to false.
3833 ///
3834 /// One reasonable way to use this information is when there's a language
3835 /// guarantee that the pointer must be aligned to some stricter value, and
3836 /// we're simply trying to ensure that sufficiently obvious uses of under-
3837 /// aligned objects don't get miscompiled; for example, a placement new
3838 /// into the address of a local variable. In such a case, it's quite
3839 /// reasonable to just ignore the returned alignment when it isn't from an
3840 /// explicit source.
John McCall7f416cc2015-09-08 08:05:57 +00003841 Address EmitPointerWithAlignment(const Expr *Addr,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00003842 LValueBaseInfo *BaseInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003843
Peter Collingbournedc134532016-01-16 00:31:22 +00003844 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
3845
Reid Kleckner89077a12013-12-17 19:46:40 +00003846private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003847 QualType getVarArgType(const Expr *Arg);
3848
John McCall09ae0322010-07-06 23:57:41 +00003849 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00003850
John McCall7f416cc2015-09-08 08:05:57 +00003851 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
3852 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00003853
3854 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00003855
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00003856 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Chris Lattnerbed31442007-05-28 01:07:47 +00003857};
Mike Stump11289f42009-09-09 15:08:12 +00003858
John McCallce1de612011-01-26 04:00:11 +00003859/// Helper class with most of the code for saving a value for a
3860/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00003861struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00003862 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
3863
3864 /// Answer whether the given value needs extra work to be saved.
3865 static bool needsSaving(llvm::Value *value) {
3866 // If it's not an instruction, we don't need to save.
3867 if (!isa<llvm::Instruction>(value)) return false;
3868
3869 // If it's an instruction in the entry block, we don't need to save.
3870 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
3871 return (block != &block->getParent()->getEntryBlock());
3872 }
3873
3874 /// Try to save the given value.
3875 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
3876 if (!needsSaving(value)) return saved_type(value, false);
3877
John McCall7f416cc2015-09-08 08:05:57 +00003878 // Otherwise, we need an alloca.
3879 auto align = CharUnits::fromQuantity(
3880 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
3881 Address alloca =
3882 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
John McCallce1de612011-01-26 04:00:11 +00003883 CGF.Builder.CreateStore(value, alloca);
3884
John McCall7f416cc2015-09-08 08:05:57 +00003885 return saved_type(alloca.getPointer(), true);
John McCallce1de612011-01-26 04:00:11 +00003886 }
3887
3888 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
John McCall7f416cc2015-09-08 08:05:57 +00003889 // If the value says it wasn't saved, trust that it's still dominating.
John McCallce1de612011-01-26 04:00:11 +00003890 if (!value.getInt()) return value.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003891
3892 // Otherwise, it should be an alloca instruction, as set up in save().
3893 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
3894 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
John McCallce1de612011-01-26 04:00:11 +00003895 }
3896};
3897
John McCallcb5f77f2011-01-28 10:53:53 +00003898/// A partial specialization of DominatingValue for llvm::Values that
3899/// might be llvm::Instructions.
3900template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3901 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00003902 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00003903 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3904 }
3905};
3906
John McCall7f416cc2015-09-08 08:05:57 +00003907/// A specialization of DominatingValue for Address.
3908template <> struct DominatingValue<Address> {
3909 typedef Address type;
3910
3911 struct saved_type {
3912 DominatingLLVMValue::saved_type SavedValue;
3913 CharUnits Alignment;
3914 };
3915
3916 static bool needsSaving(type value) {
3917 return DominatingLLVMValue::needsSaving(value.getPointer());
3918 }
3919 static saved_type save(CodeGenFunction &CGF, type value) {
3920 return { DominatingLLVMValue::save(CGF, value.getPointer()),
3921 value.getAlignment() };
3922 }
3923 static type restore(CodeGenFunction &CGF, saved_type value) {
3924 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
3925 value.Alignment);
3926 }
3927};
3928
John McCallcb5f77f2011-01-28 10:53:53 +00003929/// A specialization of DominatingValue for RValue.
3930template <> struct DominatingValue<RValue> {
3931 typedef RValue type;
3932 class saved_type {
3933 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3934 AggregateAddress, ComplexAddress };
3935
3936 llvm::Value *Value;
John McCall7f416cc2015-09-08 08:05:57 +00003937 unsigned K : 3;
3938 unsigned Align : 29;
3939 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
3940 : Value(v), K(k), Align(a) {}
John McCallcb5f77f2011-01-28 10:53:53 +00003941
3942 public:
3943 static bool needsSaving(RValue value);
3944 static saved_type save(CodeGenFunction &CGF, RValue value);
3945 RValue restore(CodeGenFunction &CGF);
3946
John McCall7f416cc2015-09-08 08:05:57 +00003947 // implementations in CGCleanup.cpp
John McCallcb5f77f2011-01-28 10:53:53 +00003948 };
3949
3950 static bool needsSaving(type value) {
3951 return saved_type::needsSaving(value);
3952 }
3953 static saved_type save(CodeGenFunction &CGF, type value) {
3954 return saved_type::save(CGF, value);
3955 }
3956 static type restore(CodeGenFunction &CGF, saved_type value) {
3957 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00003958 }
3959};
3960
Chris Lattnerbed31442007-05-28 01:07:47 +00003961} // end namespace CodeGen
3962} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00003963
Chris Lattnerbed31442007-05-28 01:07:47 +00003964#endif