blob: a51a9711ff170d646034a50a447b1272be525215 [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//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Chris Lattnerbed31442007-05-28 01:07:47 +00006//
7//===----------------------------------------------------------------------===//
8//
Mike Stumpfc496822009-02-08 23:14:22 +00009// This is the internal per-function state used for llvm translation.
Chris Lattnerbed31442007-05-28 01:07:47 +000010//
11//===----------------------------------------------------------------------===//
12
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000013#ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
14#define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
Chris Lattnerbed31442007-05-28 01:07:47 +000015
Daniel Dunbarcb463852008-11-01 01:53:16 +000016#include "CGBuilder.h"
Eric Christophera9d34972011-10-19 00:43:52 +000017#include "CGDebugInfo.h"
Alexander Musman515ad8c2014-05-22 08:54:05 +000018#include "CGLoopInfo.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000019#include "CGValue.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000020#include "CodeGenModule.h"
Justin Bogneref512b92014-01-06 22:27:43 +000021#include "CodeGenPGO.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000022#include "EHScopeStack.h"
Vitaly Buka64c80b42016-10-26 05:42:30 +000023#include "VarBypassDetector.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000024#include "clang/AST/CharUnits.h"
Eric Fiselier708afb52019-05-16 21:04:15 +000025#include "clang/AST/CurrentSourceLocExprScope.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000026#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"
Richard Trieu63688182018-12-11 03:18:39 +000032#include "clang/Basic/CodeGenOptions.h"
Alexander Musmandf7a8e22015-01-22 08:49:35 +000033#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000034#include "clang/Basic/TargetInfo.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000035#include "llvm/ADT/ArrayRef.h"
36#include "llvm/ADT/DenseMap.h"
Reid Kleckner06f19a02018-01-02 21:34:16 +000037#include "llvm/ADT/MapVector.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000038#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000039#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000040#include "llvm/Support/Debug.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000041#include "llvm/Transforms/Utils/SanitizerStats.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000042
Chris Lattnerbed31442007-05-28 01:07:47 +000043namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000044class BasicBlock;
45class LLVMContext;
46class MDNode;
47class Module;
48class SwitchInst;
49class Twine;
50class Value;
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
Akira Hatanaka6b103bc2017-10-06 07:12:46 +000079namespace analyze_os_log {
80class OSLogBufferLayout;
81}
82
Chris Lattnerbed31442007-05-28 01:07:47 +000083namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000084class CodeGenTypes;
John McCallb92ab1a2016-10-26 23:46:34 +000085class CGCallee;
Rafael Espindola42ae7452014-05-09 00:57:59 +000086class CGFunctionInfo;
87class CGRecordLayout;
88class CGBlockInfo;
89class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000090class BlockByrefHelpers;
91class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000092class BlockFlags;
93class BlockFieldFlags;
Alexey Bataev7292c292016-04-25 12:22:29 +000094class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000095class TargetCodeGenInfo;
Alexey Bataev24b5bae2016-04-28 09:23:51 +000096struct OMPTaskDataTy;
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000097struct CGCoroData;
Mike Stumpfc496822009-02-08 23:14:22 +000098
John McCall47fb9502013-03-07 21:37:08 +000099/// The kind of evaluation to perform on values of a particular
100/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
101/// CGExprAgg?
102///
103/// TODO: should vectors maybe be split out into their own thing?
104enum TypeEvaluationKind {
105 TEK_Scalar,
106 TEK_Complex,
107 TEK_Aggregate
108};
109
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000110#define LIST_SANITIZER_CHECKS \
111 SANITIZER_CHECK(AddOverflow, add_overflow, 0) \
112 SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \
113 SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \
114 SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \
115 SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \
116 SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \
117 SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0) \
Roman Lebedevb69ba222018-07-30 18:58:30 +0000118 SANITIZER_CHECK(ImplicitConversion, implicit_conversion, 0) \
Vedant Kumar10c31022017-07-29 00:19:51 +0000119 SANITIZER_CHECK(InvalidBuiltin, invalid_builtin, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000120 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
121 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
122 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
123 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000124 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000125 SANITIZER_CHECK(NullabilityReturn, nullability_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000126 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000127 SANITIZER_CHECK(NonnullReturn, nonnull_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000128 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
Vedant Kumara125eb52017-06-01 19:22:18 +0000129 SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000130 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
131 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
Filipe Cabecinhasfe5e5af2017-01-06 14:40:12 +0000132 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
Roman Lebedevbd1c0872019-01-15 09:44:25 +0000133 SANITIZER_CHECK(AlignmentAssumption, alignment_assumption, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000134 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
135
136enum SanitizerHandler {
137#define SANITIZER_CHECK(Enum, Name, Version) Enum,
138 LIST_SANITIZER_CHECKS
139#undef SANITIZER_CHECK
140};
141
Richard Smithf66e4f72018-07-23 22:56:45 +0000142/// Helper class with most of the code for saving a value for a
143/// conditional expression cleanup.
144struct DominatingLLVMValue {
145 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
146
147 /// Answer whether the given value needs extra work to be saved.
148 static bool needsSaving(llvm::Value *value) {
149 // If it's not an instruction, we don't need to save.
150 if (!isa<llvm::Instruction>(value)) return false;
151
152 // If it's an instruction in the entry block, we don't need to save.
153 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
154 return (block != &block->getParent()->getEntryBlock());
155 }
156
157 static saved_type save(CodeGenFunction &CGF, llvm::Value *value);
158 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value);
159};
160
161/// A partial specialization of DominatingValue for llvm::Values that
162/// might be llvm::Instructions.
163template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
164 typedef T *type;
165 static type restore(CodeGenFunction &CGF, saved_type value) {
166 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
167 }
168};
169
170/// A specialization of DominatingValue for Address.
171template <> struct DominatingValue<Address> {
172 typedef Address type;
173
174 struct saved_type {
175 DominatingLLVMValue::saved_type SavedValue;
176 CharUnits Alignment;
177 };
178
179 static bool needsSaving(type value) {
180 return DominatingLLVMValue::needsSaving(value.getPointer());
181 }
182 static saved_type save(CodeGenFunction &CGF, type value) {
183 return { DominatingLLVMValue::save(CGF, value.getPointer()),
184 value.getAlignment() };
185 }
186 static type restore(CodeGenFunction &CGF, saved_type value) {
187 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
188 value.Alignment);
189 }
190};
191
192/// A specialization of DominatingValue for RValue.
193template <> struct DominatingValue<RValue> {
194 typedef RValue type;
195 class saved_type {
196 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
197 AggregateAddress, ComplexAddress };
198
199 llvm::Value *Value;
200 unsigned K : 3;
201 unsigned Align : 29;
202 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
203 : Value(v), K(k), Align(a) {}
204
205 public:
206 static bool needsSaving(RValue value);
207 static saved_type save(CodeGenFunction &CGF, RValue value);
208 RValue restore(CodeGenFunction &CGF);
209
210 // implementations in CGCleanup.cpp
211 };
212
213 static bool needsSaving(type value) {
214 return saved_type::needsSaving(value);
215 }
216 static saved_type save(CodeGenFunction &CGF, type value) {
217 return saved_type::save(CGF, value);
218 }
219 static type restore(CodeGenFunction &CGF, saved_type value) {
220 return value.restore(CGF);
221 }
222};
223
Chris Lattnerbed31442007-05-28 01:07:47 +0000224/// CodeGenFunction - This class organizes the per-function state that is used
225/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000226class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000227 CodeGenFunction(const CodeGenFunction &) = delete;
228 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000229
230 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000231public:
John McCallad5d61e2010-07-23 21:56:41 +0000232 /// A jump destination is an abstract label, branching to which may
233 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000234 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000235 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000236 JumpDest(llvm::BasicBlock *Block,
237 EHScopeStack::stable_iterator Depth,
238 unsigned Index)
239 : Block(Block), ScopeDepth(Depth), Index(Index) {}
240
Craig Topper8a13c412014-05-21 05:09:00 +0000241 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000242 llvm::BasicBlock *getBlock() const { return Block; }
243 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
244 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000245
Nadav Rotem1da30942013-03-23 06:43:35 +0000246 // This should be used cautiously.
247 void setScopeDepth(EHScopeStack::stable_iterator depth) {
248 ScopeDepth = depth;
249 }
250
John McCallad5d61e2010-07-23 21:56:41 +0000251 private:
John McCallbd309292010-07-06 01:34:17 +0000252 llvm::BasicBlock *Block;
253 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000254 unsigned Index;
255 };
256
Chris Lattnerbed31442007-05-28 01:07:47 +0000257 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000258 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000259
Chris Lattner96d72562007-08-21 16:57:55 +0000260 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000261 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000262 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000263
Vitaly Buka64c80b42016-10-26 05:42:30 +0000264 // Stores variables for which we can't generate correct lifetime markers
265 // because of jumps.
266 VarBypassDetector Bypasses;
267
Carlo Bertollib0ff0a62017-04-25 17:52:12 +0000268 // CodeGen lambda for loops and support for ordered clause
269 typedef llvm::function_ref<void(CodeGenFunction &, const OMPLoopDirective &,
270 JumpDest)>
271 CodeGenLoopTy;
272 typedef llvm::function_ref<void(CodeGenFunction &, SourceLocation,
273 const unsigned, const bool)>
274 CodeGenOrderedTy;
275
276 // Codegen lambda for loop bounds in worksharing loop constructs
277 typedef llvm::function_ref<std::pair<LValue, LValue>(
278 CodeGenFunction &, const OMPExecutableDirective &S)>
279 CodeGenLoopBoundsTy;
280
281 // Codegen lambda for loop bounds in dispatch-based loop implementation
282 typedef llvm::function_ref<std::pair<llvm::Value *, llvm::Value *>(
283 CodeGenFunction &, const OMPExecutableDirective &S, Address LB,
284 Address UB)>
285 CodeGenDispatchBoundsTy;
286
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000287 /// CGBuilder insert helper. This function is called after an
Alexander Musman515ad8c2014-05-22 08:54:05 +0000288 /// instruction is created using Builder.
289 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
290 llvm::BasicBlock *BB,
291 llvm::BasicBlock::iterator InsertPt) const;
292
John McCalldec348f72013-05-03 07:33:41 +0000293 /// CurFuncDecl - Holds the Decl for the current outermost
294 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000295 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000296 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
297 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000298 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000299 QualType FnRetTy;
Erich Keanebe65e872018-07-10 21:07:50 +0000300 llvm::Function *CurFn = nullptr;
Chris Lattnerac248202007-05-30 00:13:02 +0000301
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000302 // Holds coroutine data if the current function is a coroutine. We use a
303 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
304 // in this header.
305 struct CGCoroInfo {
306 std::unique_ptr<CGCoroData> Data;
307 CGCoroInfo();
308 ~CGCoroInfo();
309 };
310 CGCoroInfo CurCoro;
311
Gor Nishanov04491bd2017-11-11 17:00:43 +0000312 bool isCoroutine() const {
313 return CurCoro.Data != nullptr;
314 }
315
Mike Stumpbee78dd2009-12-04 23:26:17 +0000316 /// CurGD - The GlobalDecl for the current function being compiled.
317 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000318
John McCall31168b02011-06-15 23:02:42 +0000319 /// PrologueCleanupDepth - The cleanup depth enclosing all the
320 /// cleanups associated with the parameters.
321 EHScopeStack::stable_iterator PrologueCleanupDepth;
322
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000323 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000324 JumpDest ReturnBlock;
325
John McCall7f416cc2015-09-08 08:05:57 +0000326 /// ReturnValue - The temporary alloca to hold the return
327 /// value. This is invalid iff the function has no return value.
Erich Keanebe65e872018-07-10 21:07:50 +0000328 Address ReturnValue = Address::invalid();
Mike Stumpfc496822009-02-08 23:14:22 +0000329
Amy Huang7fac5c82019-06-20 17:15:21 +0000330 /// ReturnValuePointer - The temporary alloca to hold a pointer to sret.
331 /// This is invalid if sret is not in use.
332 Address ReturnValuePointer = Address::invalid();
333
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000334 /// Return true if a label was seen in the current scope.
335 bool hasLabelBeenSeenInCurrentScope() const {
336 if (CurLexicalScope)
337 return CurLexicalScope->hasLabels();
338 return !LabelMap.empty();
339 }
340
Chris Lattner03df1222007-06-02 04:53:11 +0000341 /// AllocaInsertPoint - This is an instruction in the entry block before which
342 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000343 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000344
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000345 /// API for captured statement code generation.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000346 class CGCapturedStmtInfo {
347 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000348 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
349 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000350 explicit CGCapturedStmtInfo(const CapturedStmt &S,
351 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000352 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000353
354 RecordDecl::field_iterator Field =
355 S.getCapturedRecordDecl()->field_begin();
356 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
357 E = S.capture_end();
358 I != E; ++I, ++Field) {
359 if (I->capturesThis())
360 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000361 else if (I->capturesVariable())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000362 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000363 else if (I->capturesVariableByCopy())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000364 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000365 }
366 }
367
368 virtual ~CGCapturedStmtInfo();
369
370 CapturedRegionKind getKind() const { return Kind; }
371
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000372 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000373 // Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000374 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000375
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000376 /// Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000377 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000378 return CaptureFields.lookup(VD->getCanonicalDecl());
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000379 }
380
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000381 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
382 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000383
Alexey Bataev18095712014-10-10 12:19:54 +0000384 static bool classof(const CGCapturedStmtInfo *) {
385 return true;
386 }
387
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000388 /// Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000389 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000390 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000391 CGF.EmitStmt(S);
392 }
393
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000394 /// Get the name of the capture helper.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000395 virtual StringRef getHelperName() const { return "__captured_stmt"; }
396
397 private:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000398 /// The kind of captured statement being generated.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000399 CapturedRegionKind Kind;
400
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000401 /// Keep the map between VarDecl and FieldDecl.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000402 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
403
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000404 /// The base address of the captured record, passed in as the first
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000405 /// argument of the parallel region function.
406 llvm::Value *ThisValue;
407
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000408 /// Captured 'this' type.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000409 FieldDecl *CXXThisFieldDecl;
410 };
Erich Keanebe65e872018-07-10 21:07:50 +0000411 CGCapturedStmtInfo *CapturedStmtInfo = nullptr;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000412
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000413 /// RAII for correct setting/restoring of CapturedStmtInfo.
Alexey Bataevd157d472015-06-24 03:35:38 +0000414 class CGCapturedStmtRAII {
415 private:
416 CodeGenFunction &CGF;
417 CGCapturedStmtInfo *PrevCapturedStmtInfo;
418 public:
419 CGCapturedStmtRAII(CodeGenFunction &CGF,
420 CGCapturedStmtInfo *NewCapturedStmtInfo)
421 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
422 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
423 }
424 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
425 };
426
Vedant Kumared00ea02017-03-06 05:28:22 +0000427 /// An abstract representation of regular/ObjC call/message targets.
428 class AbstractCallee {
429 /// The function declaration of the callee.
430 const Decl *CalleeDecl;
431
432 public:
433 AbstractCallee() : CalleeDecl(nullptr) {}
434 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
435 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
436 bool hasFunctionDecl() const {
437 return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
438 }
439 const Decl *getDecl() const { return CalleeDecl; }
440 unsigned getNumParams() const {
441 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
442 return FD->getNumParams();
443 return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
444 }
445 const ParmVarDecl *getParamDecl(unsigned I) const {
446 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
447 return FD->getParamDecl(I);
448 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
449 }
450 };
451
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000452 /// Sanitizers enabled for this function.
Alexey Samsonova0416102014-11-11 01:26:14 +0000453 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000454
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000455 /// True if CodeGen currently emits code implementing sanitizer checks.
Erich Keanebe65e872018-07-10 21:07:50 +0000456 bool IsSanitizerScope = false;
Alexey Samsonov24cad992014-07-17 18:46:27 +0000457
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000458 /// RAII object to set/unset CodeGenFunction::IsSanitizerScope.
Alexey Samsonov24cad992014-07-17 18:46:27 +0000459 class SanitizerScope {
460 CodeGenFunction *CGF;
461 public:
462 SanitizerScope(CodeGenFunction *CGF);
463 ~SanitizerScope();
464 };
465
Reid Kleckner19819442014-07-25 21:39:46 +0000466 /// In C++, whether we are code generating a thunk. This controls whether we
467 /// should emit cleanups.
Erich Keanebe65e872018-07-10 21:07:50 +0000468 bool CurFuncIsThunk = false;
Reid Kleckner19819442014-07-25 21:39:46 +0000469
John McCall31168b02011-06-15 23:02:42 +0000470 /// In ARC, whether we should autorelease the return value.
Erich Keanebe65e872018-07-10 21:07:50 +0000471 bool AutoreleaseResult = false;
John McCall31168b02011-06-15 23:02:42 +0000472
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000473 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
474 /// potentially set the return value.
Erich Keanebe65e872018-07-10 21:07:50 +0000475 bool SawAsmBlock = false;
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000476
David Chisnall93ce0182018-08-10 12:53:13 +0000477 const NamedDecl *CurSEHParent = nullptr;
David Majnemer25eb1652016-03-01 19:42:53 +0000478
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000479 /// True if the current function is an outlined SEH helper. This can be a
480 /// finally block or filter expression.
Erich Keanebe65e872018-07-10 21:07:50 +0000481 bool IsOutlinedSEHHelper = false;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000482
Yonghong Song048493f2019-07-09 04:21:50 +0000483 /// True if CodeGen currently emits code inside presereved access index
484 /// region.
485 bool IsInPreservedAIRegion = false;
486
Erich Keanebe65e872018-07-10 21:07:50 +0000487 const CodeGen::CGBlockInfo *BlockInfo = nullptr;
488 llvm::Value *BlockPointer = nullptr;
John McCallad7c5c12011-02-08 08:22:06 +0000489
Eli Friedman9fbeba02012-02-11 02:57:39 +0000490 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
Erich Keanebe65e872018-07-10 21:07:50 +0000491 FieldDecl *LambdaThisCaptureField = nullptr;
Eli Friedman9fbeba02012-02-11 02:57:39 +0000492
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000493 /// A mapping from NRVO variables to the flags used to indicate
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000494 /// when the NRVO has been applied to this variable.
495 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000496
John McCallbd309292010-07-06 01:34:17 +0000497 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000498 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000499 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000500
David Majnemer4e52d6f2015-12-12 05:39:21 +0000501 llvm::Instruction *CurrentFuncletPad = nullptr;
502
Tim Shen421119f2016-07-01 21:08:47 +0000503 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
504 llvm::Value *Addr;
505 llvm::Value *Size;
506
507 public:
508 CallLifetimeEnd(Address addr, llvm::Value *size)
509 : Addr(addr.getPointer()), Size(size) {}
510
511 void Emit(CodeGenFunction &CGF, Flags flags) override {
512 CGF.EmitLifetimeEnd(Size, Addr);
513 }
514 };
515
Richard Smith736a9472013-06-12 20:42:33 +0000516 /// Header for data within LifetimeExtendedCleanupStack.
517 struct LifetimeExtendedCleanupHeader {
518 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000519 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000520 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Richard Smithf66e4f72018-07-23 22:56:45 +0000521 unsigned Kind : 31;
522 /// Whether this is a conditional cleanup.
523 unsigned IsConditional : 1;
Richard Smith736a9472013-06-12 20:42:33 +0000524
Justin Bognerbdff2192015-07-01 00:59:27 +0000525 size_t getSize() const { return Size; }
Richard Smithf66e4f72018-07-23 22:56:45 +0000526 CleanupKind getKind() const { return (CleanupKind)Kind; }
527 bool isConditional() const { return IsConditional; }
Richard Smith736a9472013-06-12 20:42:33 +0000528 };
John McCallbd309292010-07-06 01:34:17 +0000529
John McCallad5d61e2010-07-23 21:56:41 +0000530 /// i32s containing the indexes of the cleanup destinations.
Erich Keanebe65e872018-07-10 21:07:50 +0000531 Address NormalCleanupDest = Address::invalid();
John McCallad5d61e2010-07-23 21:56:41 +0000532
Erich Keanebe65e872018-07-10 21:07:50 +0000533 unsigned NextCleanupDestIndex = 1;
John McCallad5d61e2010-07-23 21:56:41 +0000534
John McCall08ef4662011-11-10 08:15:53 +0000535 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
Erich Keanebe65e872018-07-10 21:07:50 +0000536 CGBlockInfo *FirstBlockInfo = nullptr;
John McCall08ef4662011-11-10 08:15:53 +0000537
John McCall8e4c74b2011-08-11 02:22:43 +0000538 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
Erich Keanebe65e872018-07-10 21:07:50 +0000539 llvm::BasicBlock *EHResumeBlock = nullptr;
John McCall8e4c74b2011-08-11 02:22:43 +0000540
Bill Wendlingf0724e82011-09-19 20:31:14 +0000541 /// The exception slot. All landing pads write the current exception pointer
542 /// into this alloca.
Erich Keanebe65e872018-07-10 21:07:50 +0000543 llvm::Value *ExceptionSlot = nullptr;
John McCallbd309292010-07-06 01:34:17 +0000544
Bill Wendlingf0724e82011-09-19 20:31:14 +0000545 /// The selector slot. Under the MandatoryCleanup model, all landing pads
546 /// write the current selector value into this alloca.
Erich Keanebe65e872018-07-10 21:07:50 +0000547 llvm::AllocaInst *EHSelectorSlot = nullptr;
John McCall9b382dd2011-05-28 21:13:02 +0000548
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000549 /// A stack of exception code slots. Entering an __except block pushes a slot
550 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
551 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000552 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000553
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000554 /// Value returned by __exception_info intrinsic.
555 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000556
John McCallbd309292010-07-06 01:34:17 +0000557 /// Emits a landing pad for the current EH stack.
558 llvm::BasicBlock *EmitLandingPad();
559
560 llvm::BasicBlock *getInvokeDestImpl();
561
John McCallce1de612011-01-26 04:00:11 +0000562 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000563 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
564 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000565 }
566
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000567public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000568 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
569 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000570 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000571
John McCall6b0feb72011-06-22 02:32:12 +0000572 /// A class controlling the emission of a finally block.
573 class FinallyInfo {
574 /// Where the catchall's edge through the cleanup should go.
575 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000576
John McCall6b0feb72011-06-22 02:32:12 +0000577 /// A function to call to enter the catch.
James Y Knight9871db02019-02-05 16:42:33 +0000578 llvm::FunctionCallee BeginCatchFn;
John McCall6b0feb72011-06-22 02:32:12 +0000579
580 /// An i1 variable indicating whether or not the @finally is
581 /// running for an exception.
582 llvm::AllocaInst *ForEHVar;
583
584 /// An i8* variable into which the exception pointer to rethrow
585 /// has been saved.
586 llvm::AllocaInst *SavedExnVar;
587
588 public:
589 void enter(CodeGenFunction &CGF, const Stmt *Finally,
James Y Knight9871db02019-02-05 16:42:33 +0000590 llvm::FunctionCallee beginCatchFn,
591 llvm::FunctionCallee endCatchFn, llvm::FunctionCallee rethrowFn);
John McCall6b0feb72011-06-22 02:32:12 +0000592 void exit(CodeGenFunction &CGF);
593 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000594
Reid Kleckner11c033e2015-02-12 23:40:45 +0000595 /// Returns true inside SEH __try blocks.
596 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
597
Reid Klecknera002bd52015-10-28 23:06:42 +0000598 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000599 bool isCleanupPadScope() const {
600 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
601 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000602
John McCallce1de612011-01-26 04:00:11 +0000603 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
604 /// current full-expression. Safe against the possibility that
605 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000606 template <class T, class... As>
607 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000608 // If we're not in a conditional branch, or if none of the
609 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000610 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000611 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000612
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000613 // Stash values in a tuple so we can guarantee the order of saves.
614 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
615 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000616
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000617 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000618 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000619 initFullExprCleanup();
620 }
621
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000622 /// Queue a cleanup to be pushed after finishing the current
Richard Smith736a9472013-06-12 20:42:33 +0000623 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000624 template <class T, class... As>
625 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smithf66e4f72018-07-23 22:56:45 +0000626 if (!isInConditionalBranch())
627 return pushCleanupAfterFullExprImpl<T>(Kind, Address::invalid(), A...);
Richard Smith736a9472013-06-12 20:42:33 +0000628
Richard Smithf66e4f72018-07-23 22:56:45 +0000629 Address ActiveFlag = createCleanupActiveFlag();
630 assert(!DominatingValue<Address>::needsSaving(ActiveFlag) &&
631 "cleanup active flag should never need saving");
632
633 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
634 SavedTuple Saved{saveValueInCond(A)...};
635
636 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
637 pushCleanupAfterFullExprImpl<CleanupType>(Kind, ActiveFlag, Saved);
638 }
639
640 template <class T, class... As>
641 void pushCleanupAfterFullExprImpl(CleanupKind Kind, Address ActiveFlag,
642 As... A) {
643 LifetimeExtendedCleanupHeader Header = {sizeof(T), Kind,
644 ActiveFlag.isValid()};
Richard Smith736a9472013-06-12 20:42:33 +0000645
646 size_t OldSize = LifetimeExtendedCleanupStack.size();
647 LifetimeExtendedCleanupStack.resize(
Richard Smithf66e4f72018-07-23 22:56:45 +0000648 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size +
649 (Header.IsConditional ? sizeof(ActiveFlag) : 0));
Richard Smith736a9472013-06-12 20:42:33 +0000650
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000651 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000652 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000653 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
654 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000655 new (Buffer + sizeof(Header)) T(A...);
Richard Smithf66e4f72018-07-23 22:56:45 +0000656 if (Header.IsConditional)
657 new (Buffer + sizeof(Header) + sizeof(T)) Address(ActiveFlag);
Richard Smith736a9472013-06-12 20:42:33 +0000658 }
659
Richard Smithf66e4f72018-07-23 22:56:45 +0000660 /// Set up the last cleanup that was pushed as a conditional
John McCallf4beacd2011-11-10 10:43:54 +0000661 /// full-expression cleanup.
Richard Smithf66e4f72018-07-23 22:56:45 +0000662 void initFullExprCleanup() {
663 initFullExprCleanupWithFlag(createCleanupActiveFlag());
664 }
665
666 void initFullExprCleanupWithFlag(Address ActiveFlag);
667 Address createCleanupActiveFlag();
John McCallf4beacd2011-11-10 10:43:54 +0000668
John McCallbd309292010-07-06 01:34:17 +0000669 /// PushDestructorCleanup - Push a cleanup to call the
670 /// complete-object destructor of an object of the given type at the
671 /// given address. Does nothing if T is not a C++ class type with a
672 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000673 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000674
John McCall8680f872010-07-21 06:29:51 +0000675 /// PushDestructorCleanup - Push a cleanup to call the
676 /// complete-object variant of the given destructor on the object at
677 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000678 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000679
John McCallbd309292010-07-06 01:34:17 +0000680 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
681 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000682 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000683
John McCall824c2f52010-09-14 07:57:04 +0000684 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
685 /// The block cannot be reactivated. Pops it if it's the top of the
686 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000687 ///
688 /// \param DominatingIP - An instruction which is known to
689 /// dominate the current IP (if set) and which lies along
690 /// all paths of execution between the current IP and the
691 /// the point at which the cleanup comes into scope.
692 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
693 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000694
695 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
696 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000697 ///
698 /// \param DominatingIP - An instruction which is known to
699 /// dominate the current IP (if set) and which lies along
700 /// all paths of execution between the current IP and the
701 /// the point at which the cleanup comes into scope.
702 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
703 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000704
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000705 /// Enters a new scope for capturing cleanups, all of which
John McCallbd309292010-07-06 01:34:17 +0000706 /// will be executed once the scope is exited.
707 class RunCleanupsScope {
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000708 EHScopeStack::stable_iterator CleanupStackDepth, OldCleanupScopeDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000709 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000710 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000711 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000712 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000713 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000714
Aaron Ballmanabc18922015-02-15 22:54:08 +0000715 RunCleanupsScope(const RunCleanupsScope &) = delete;
716 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000717
Eric Christophera9d34972011-10-19 00:43:52 +0000718 protected:
719 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000720
Douglas Gregor965f4502009-11-24 16:43:22 +0000721 public:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000722 /// Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000723 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000724 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000725 {
John McCallbd309292010-07-06 01:34:17 +0000726 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000727 LifetimeExtendedCleanupStackSize =
728 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000729 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000730 CGF.DidCallStackSave = false;
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000731 OldCleanupScopeDepth = CGF.CurrentCleanupScopeDepth;
732 CGF.CurrentCleanupScopeDepth = CleanupStackDepth;
Douglas Gregor965f4502009-11-24 16:43:22 +0000733 }
734
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000735 /// Exit this cleanup scope, emitting any accumulated cleanups.
John McCallbd309292010-07-06 01:34:17 +0000736 ~RunCleanupsScope() {
Reid Kleckner092d0652017-03-06 22:18:34 +0000737 if (PerformCleanup)
738 ForceCleanup();
Douglas Gregor680f8612009-11-24 21:15:44 +0000739 }
740
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000741 /// Determine whether this scope requires any cleanups.
Douglas Gregor680f8612009-11-24 21:15:44 +0000742 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000743 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000744 }
745
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000746 /// Force the emission of cleanups now, instead of waiting
Douglas Gregor680f8612009-11-24 21:15:44 +0000747 /// until this object is destroyed.
Reid Kleckner092d0652017-03-06 22:18:34 +0000748 /// \param ValuesToReload - A list of values that need to be available at
749 /// the insertion point after cleanup emission. If cleanup emission created
750 /// a shared cleanup block, these value pointers will be rewritten.
751 /// Otherwise, they not will be modified.
752 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
Douglas Gregor680f8612009-11-24 21:15:44 +0000753 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000754 CGF.DidCallStackSave = OldDidCallStackSave;
Reid Kleckner092d0652017-03-06 22:18:34 +0000755 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
756 ValuesToReload);
Douglas Gregor680f8612009-11-24 21:15:44 +0000757 PerformCleanup = false;
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000758 CGF.CurrentCleanupScopeDepth = OldCleanupScopeDepth;
Douglas Gregor965f4502009-11-24 16:43:22 +0000759 }
760 };
761
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000762 // Cleanup stack depth of the RunCleanupsScope that was pushed most recently.
763 EHScopeStack::stable_iterator CurrentCleanupScopeDepth =
764 EHScopeStack::stable_end();
765
David Blaikie93be0b22014-08-22 21:37:04 +0000766 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000767 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000768 SmallVector<const LabelDecl*, 4> Labels;
769 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000770
Aaron Ballmanabc18922015-02-15 22:54:08 +0000771 LexicalScope(const LexicalScope &) = delete;
772 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000773
774 public:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000775 /// Enter a new cleanup scope.
Eric Christophera9d34972011-10-19 00:43:52 +0000776 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000777 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
778 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000779 if (CGDebugInfo *DI = CGF.getDebugInfo())
780 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
781 }
782
Nadav Rotem1da30942013-03-23 06:43:35 +0000783 void addLabel(const LabelDecl *label) {
784 assert(PerformCleanup && "adding label to dead scope?");
785 Labels.push_back(label);
786 }
787
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000788 /// Exit this cleanup scope, emitting any accumulated
Eric Christophera9d34972011-10-19 00:43:52 +0000789 /// cleanups.
790 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000791 if (CGDebugInfo *DI = CGF.getDebugInfo())
792 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
793
Nadav Rotem1da30942013-03-23 06:43:35 +0000794 // If we should perform a cleanup, force them now. Note that
795 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000796 if (PerformCleanup) {
Calixte Denizetfcd661d2018-09-24 18:24:18 +0000797 ApplyDebugLocation DL(CGF, Range.getEnd());
David Blaikie4d524432015-02-04 19:47:54 +0000798 ForceCleanup();
799 }
Eric Christophera9d34972011-10-19 00:43:52 +0000800 }
801
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000802 /// Force the emission of cleanups now, instead of waiting
Eric Christophera9d34972011-10-19 00:43:52 +0000803 /// until this object is destroyed.
804 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000805 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000806 RunCleanupsScope::ForceCleanup();
807
Nadav Rotem1da30942013-03-23 06:43:35 +0000808 if (!Labels.empty())
809 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000810 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000811
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000812 bool hasLabels() const {
813 return !Labels.empty();
814 }
815
Nadav Rotem1da30942013-03-23 06:43:35 +0000816 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000817 };
818
John McCall7f416cc2015-09-08 08:05:57 +0000819 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
820
Alexey Bataevab4ea222018-03-07 18:17:06 +0000821 /// The class used to assign some variables some temporarily addresses.
822 class OMPMapVars {
John McCall7f416cc2015-09-08 08:05:57 +0000823 DeclMapTy SavedLocals;
Alexey Bataevab4ea222018-03-07 18:17:06 +0000824 DeclMapTy SavedTempAddresses;
825 OMPMapVars(const OMPMapVars &) = delete;
826 void operator=(const OMPMapVars &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000827
828 public:
Alexey Bataevab4ea222018-03-07 18:17:06 +0000829 explicit OMPMapVars() = default;
830 ~OMPMapVars() {
831 assert(SavedLocals.empty() && "Did not restored original addresses.");
832 };
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000833
Alexey Bataevab4ea222018-03-07 18:17:06 +0000834 /// Sets the address of the variable \p LocalVD to be \p TempAddr in
835 /// function \p CGF.
836 /// \return true if at least one variable was set already, false otherwise.
837 bool setVarAddr(CodeGenFunction &CGF, const VarDecl *LocalVD,
838 Address TempAddr) {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000839 LocalVD = LocalVD->getCanonicalDecl();
John McCall7f416cc2015-09-08 08:05:57 +0000840 // Only save it once.
841 if (SavedLocals.count(LocalVD)) return false;
842
843 // Copy the existing local entry to SavedLocals.
844 auto it = CGF.LocalDeclMap.find(LocalVD);
Alexey Bataevab4ea222018-03-07 18:17:06 +0000845 if (it != CGF.LocalDeclMap.end())
846 SavedLocals.try_emplace(LocalVD, it->second);
847 else
848 SavedLocals.try_emplace(LocalVD, Address::invalid());
John McCall7f416cc2015-09-08 08:05:57 +0000849
850 // Generate the private entry.
Alexey Bataevcaacd532015-09-04 11:26:21 +0000851 QualType VarTy = LocalVD->getType();
852 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000853 Address Temp = CGF.CreateMemTemp(VarTy);
Alexey Bataevab4ea222018-03-07 18:17:06 +0000854 CGF.Builder.CreateStore(TempAddr.getPointer(), Temp);
855 TempAddr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000856 }
Alexey Bataevab4ea222018-03-07 18:17:06 +0000857 SavedTempAddresses.try_emplace(LocalVD, TempAddr);
John McCall7f416cc2015-09-08 08:05:57 +0000858
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000859 return true;
860 }
861
Alexey Bataevab4ea222018-03-07 18:17:06 +0000862 /// Applies new addresses to the list of the variables.
863 /// \return true if at least one variable is using new address, false
864 /// otherwise.
865 bool apply(CodeGenFunction &CGF) {
866 copyInto(SavedTempAddresses, CGF.LocalDeclMap);
867 SavedTempAddresses.clear();
868 return !SavedLocals.empty();
869 }
870
871 /// Restores original addresses of the variables.
872 void restore(CodeGenFunction &CGF) {
873 if (!SavedLocals.empty()) {
874 copyInto(SavedLocals, CGF.LocalDeclMap);
875 SavedLocals.clear();
876 }
877 }
878
879 private:
880 /// Copy all the entries in the source map over the corresponding
881 /// entries in the destination, which must exist.
882 static void copyInto(const DeclMapTy &Src, DeclMapTy &Dest) {
883 for (auto &Pair : Src) {
884 if (!Pair.second.isValid()) {
885 Dest.erase(Pair.first);
886 continue;
887 }
888
889 auto I = Dest.find(Pair.first);
890 if (I != Dest.end())
891 I->second = Pair.second;
892 else
893 Dest.insert(Pair);
894 }
895 }
896 };
897
898 /// The scope used to remap some variables as private in the OpenMP loop body
899 /// (or other captured region emitted without outlining), and to restore old
900 /// vars back on exit.
901 class OMPPrivateScope : public RunCleanupsScope {
902 OMPMapVars MappedVars;
903 OMPPrivateScope(const OMPPrivateScope &) = delete;
904 void operator=(const OMPPrivateScope &) = delete;
905
906 public:
907 /// Enter a new OpenMP private scope.
908 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
909
910 /// Registers \p LocalVD variable as a private and apply \p PrivateGen
911 /// function for it to generate corresponding private variable. \p
912 /// PrivateGen returns an address of the generated private variable.
913 /// \return true if the variable is registered as private, false if it has
914 /// been privatized already.
915 bool addPrivate(const VarDecl *LocalVD,
Alexey Bataevddf3db92018-04-13 17:31:06 +0000916 const llvm::function_ref<Address()> PrivateGen) {
Alexey Bataevab4ea222018-03-07 18:17:06 +0000917 assert(PerformCleanup && "adding private to dead scope");
918 return MappedVars.setVarAddr(CGF, LocalVD, PrivateGen());
919 }
920
921 /// Privatizes local variables previously registered as private.
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000922 /// Registration is separate from the actual privatization to allow
923 /// initializers use values of the original variables, not the private one.
924 /// This is important, for example, if the private variable is a class
925 /// variable initialized by a constructor that references other private
926 /// variables. But at initialization original variables must be used, not
927 /// private copies.
928 /// \return true if at least one variable was privatized, false otherwise.
Alexey Bataevab4ea222018-03-07 18:17:06 +0000929 bool Privatize() { return MappedVars.apply(CGF); }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000930
931 void ForceCleanup() {
932 RunCleanupsScope::ForceCleanup();
Alexey Bataevab4ea222018-03-07 18:17:06 +0000933 MappedVars.restore(CGF);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000934 }
935
Alexey Bataevab4ea222018-03-07 18:17:06 +0000936 /// Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000937 ~OMPPrivateScope() {
938 if (PerformCleanup)
939 ForceCleanup();
940 }
John McCall7f416cc2015-09-08 08:05:57 +0000941
Gor Nishanov04491bd2017-11-11 17:00:43 +0000942 /// Checks if the global variable is captured in current function.
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000943 bool isGlobalVarCaptured(const VarDecl *VD) const {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000944 VD = VD->getCanonicalDecl();
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000945 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
946 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000947 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000948
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000949 /// Takes the old cleanup stack size and emits the cleanup blocks
Richard Smith736a9472013-06-12 20:42:33 +0000950 /// that have been added.
Reid Kleckner092d0652017-03-06 22:18:34 +0000951 void
952 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
953 std::initializer_list<llvm::Value **> ValuesToReload = {});
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000954
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000955 /// Takes the old cleanup stack size and emits the cleanup blocks
Richard Smith736a9472013-06-12 20:42:33 +0000956 /// that have been added, then adds all lifetime-extended cleanups from
957 /// the given position to the stack.
Reid Kleckner092d0652017-03-06 22:18:34 +0000958 void
959 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
960 size_t OldLifetimeExtendedStackSize,
961 std::initializer_list<llvm::Value **> ValuesToReload = {});
Richard Smith736a9472013-06-12 20:42:33 +0000962
John McCallad5d61e2010-07-23 21:56:41 +0000963 void ResolveBranchFixups(llvm::BasicBlock *Target);
964
John McCallbd309292010-07-06 01:34:17 +0000965 /// The given basic block lies in the current EH scope, but may be a
966 /// target of a potentially scope-crossing jump; get a stable handle
967 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000968 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000969 return JumpDest(Target,
970 EHStack.getInnermostNormalCleanup(),
971 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000972 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000973
John McCallbd309292010-07-06 01:34:17 +0000974 /// The given basic block lies in the current EH scope, but may be a
975 /// target of a potentially scope-crossing jump; get a stable handle
976 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000977 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000978 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000979 }
980
981 /// EmitBranchThroughCleanup - Emit a branch from the current insert
982 /// block through the normal cleanup handling code (if any) and then
983 /// on to \arg Dest.
984 void EmitBranchThroughCleanup(JumpDest Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +0000985
Justin Bognere25ffdf2014-01-21 00:35:11 +0000986 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
987 /// specified destination obviously has no cleanups to run. 'false' is always
988 /// a conservatively correct answer for this method.
989 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
990
John McCall8e4c74b2011-08-11 02:22:43 +0000991 /// popCatchScope - Pops the catch scope at the top of the EHScope
992 /// stack, emitting any required code (other than the catch handlers
993 /// themselves).
994 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000995
David Chisnall9a837be2012-11-07 16:50:40 +0000996 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000997 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Heejin Ahnc6479192018-05-31 22:18:13 +0000998 llvm::BasicBlock *
999 getFuncletEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +00001000
John McCallce1de612011-01-26 04:00:11 +00001001 /// An object to manage conditionally-evaluated expressions.
1002 class ConditionalEvaluation {
1003 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +00001004
John McCallce1de612011-01-26 04:00:11 +00001005 public:
1006 ConditionalEvaluation(CodeGenFunction &CGF)
1007 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001008
John McCallce1de612011-01-26 04:00:11 +00001009 void begin(CodeGenFunction &CGF) {
1010 assert(CGF.OutermostConditional != this);
1011 if (!CGF.OutermostConditional)
1012 CGF.OutermostConditional = this;
1013 }
1014
1015 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +00001016 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +00001017 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +00001018 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +00001019 }
1020
1021 /// Returns a block which will be executed prior to each
1022 /// evaluation of the conditional code.
1023 llvm::BasicBlock *getStartingBlock() const {
1024 return StartBB;
1025 }
1026 };
Mike Stump11289f42009-09-09 15:08:12 +00001027
John McCall7f9c92a2010-09-17 00:50:28 +00001028 /// isInConditionalBranch - Return true if we're currently emitting
1029 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +00001030 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +00001031
John McCall7f416cc2015-09-08 08:05:57 +00001032 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +00001033 assert(isInConditionalBranch());
1034 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +00001035 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
1036 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +00001037 }
1038
John McCallce1de612011-01-26 04:00:11 +00001039 /// An RAII object to record that we're evaluating a statement
1040 /// expression.
1041 class StmtExprEvaluation {
1042 CodeGenFunction &CGF;
1043
1044 /// We have to save the outermost conditional: cleanups in a
1045 /// statement expression aren't conditional just because the
1046 /// StmtExpr is.
1047 ConditionalEvaluation *SavedOutermostConditional;
1048
1049 public:
1050 StmtExprEvaluation(CodeGenFunction &CGF)
1051 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +00001052 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +00001053 }
1054
1055 ~StmtExprEvaluation() {
1056 CGF.OutermostConditional = SavedOutermostConditional;
1057 CGF.EnsureInsertPoint();
1058 }
1059 };
John McCall1bf58462011-02-16 08:02:54 +00001060
John McCallc07a0c72011-02-17 10:25:35 +00001061 /// An object which temporarily prevents a value from being
1062 /// destroyed by aggressive peephole optimizations that assume that
1063 /// all uses of a value have been realized in the IR.
1064 class PeepholeProtection {
1065 llvm::Instruction *Inst;
1066 friend class CodeGenFunction;
1067
1068 public:
Craig Topper8a13c412014-05-21 05:09:00 +00001069 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +00001070 };
John McCallc07a0c72011-02-17 10:25:35 +00001071
John McCallfe96e0b2011-11-06 09:01:30 +00001072 /// A non-RAII class containing all the information about a bound
1073 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
1074 /// this which makes individual mappings very simple; using this
1075 /// class directly is useful when you have a variable number of
1076 /// opaque values or don't want the RAII functionality for some
1077 /// reason.
1078 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +00001079 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +00001080 bool BoundLValue;
1081 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +00001082
John McCallfe96e0b2011-11-06 09:01:30 +00001083 OpaqueValueMappingData(const OpaqueValueExpr *ov,
1084 bool boundLValue)
1085 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +00001086 public:
Craig Topper8a13c412014-05-21 05:09:00 +00001087 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +00001088
John McCallc07a0c72011-02-17 10:25:35 +00001089 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +00001090 // gl-values should be bound as l-values for obvious reasons.
1091 // Records should be bound as l-values because IR generation
1092 // always keeps them in memory. Expressions of function type
1093 // act exactly like l-values but are formally required to be
1094 // r-values in C.
1095 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +00001096 expr->getType()->isFunctionType() ||
1097 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +00001098 }
1099
John McCallfe96e0b2011-11-06 09:01:30 +00001100 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1101 const OpaqueValueExpr *ov,
1102 const Expr *e) {
1103 if (shouldBindAsLValue(ov))
1104 return bind(CGF, ov, CGF.EmitLValue(e));
1105 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1106 }
1107
1108 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1109 const OpaqueValueExpr *ov,
1110 const LValue &lv) {
1111 assert(shouldBindAsLValue(ov));
1112 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1113 return OpaqueValueMappingData(ov, true);
1114 }
1115
1116 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1117 const OpaqueValueExpr *ov,
1118 const RValue &rv) {
1119 assert(!shouldBindAsLValue(ov));
1120 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1121
1122 OpaqueValueMappingData data(ov, false);
1123
1124 // Work around an extremely aggressive peephole optimization in
1125 // EmitScalarConversion which assumes that all other uses of a
1126 // value are extant.
1127 data.Protection = CGF.protectFromPeepholes(rv);
1128
1129 return data;
1130 }
1131
Craig Topper8a13c412014-05-21 05:09:00 +00001132 bool isValid() const { return OpaqueValue != nullptr; }
1133 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +00001134
1135 void unbind(CodeGenFunction &CGF) {
1136 assert(OpaqueValue && "no data to unbind!");
1137
1138 if (BoundLValue) {
1139 CGF.OpaqueLValues.erase(OpaqueValue);
1140 } else {
1141 CGF.OpaqueRValues.erase(OpaqueValue);
1142 CGF.unprotectFromPeepholes(Protection);
1143 }
1144 }
1145 };
1146
1147 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1148 class OpaqueValueMapping {
1149 CodeGenFunction &CGF;
1150 OpaqueValueMappingData Data;
1151
1152 public:
1153 static bool shouldBindAsLValue(const Expr *expr) {
1154 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1155 }
1156
John McCallc07a0c72011-02-17 10:25:35 +00001157 /// Build the opaque value mapping for the given conditional
1158 /// operator if it's the GNU ?: extension. This is a common
1159 /// enough pattern that the convenience operator is really
1160 /// helpful.
1161 ///
1162 OpaqueValueMapping(CodeGenFunction &CGF,
1163 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +00001164 if (isa<ConditionalOperator>(op))
1165 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001166 return;
John McCallc07a0c72011-02-17 10:25:35 +00001167
1168 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001169 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1170 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001171 }
1172
Richard Smith410306b2016-12-12 02:53:20 +00001173 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1174 /// expression is set to the expression the OVE represents.
1175 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1176 : CGF(CGF) {
1177 if (OV) {
1178 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1179 "for OVE with no source expression");
1180 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1181 }
1182 }
1183
John McCall1bf58462011-02-16 08:02:54 +00001184 OpaqueValueMapping(CodeGenFunction &CGF,
1185 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001186 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001187 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001188 }
1189
1190 OpaqueValueMapping(CodeGenFunction &CGF,
1191 const OpaqueValueExpr *opaqueValue,
1192 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001193 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001194 }
1195
1196 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001197 Data.unbind(CGF);
1198 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001199 }
1200
1201 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001202 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001203 }
1204 };
Gor Nishanov04491bd2017-11-11 17:00:43 +00001205
Chris Lattner2da04b32007-08-24 05:35:26 +00001206private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001207 CGDebugInfo *DebugInfo;
Adrian Prantla40cce82018-11-09 19:17:56 +00001208 /// Used to create unique names for artificial VLA size debug info variables.
1209 unsigned VLAExprCounter = 0;
Erich Keanebe65e872018-07-10 21:07:50 +00001210 bool DisableDebugInfo = false;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001211
John McCall9b382dd2011-05-28 21:13:02 +00001212 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1213 /// calling llvm.stacksave for multiple VLAs in the same scope.
Erich Keanebe65e872018-07-10 21:07:50 +00001214 bool DidCallStackSave = false;
John McCall9b382dd2011-05-28 21:13:02 +00001215
Mike Stumpe5311b02009-11-30 20:08:49 +00001216 /// IndirectBranch - The first time an indirect goto is seen we create a block
1217 /// with an indirect branch. Every time we see the address of a label taken,
1218 /// we add the label to the indirect goto. Every subsequent indirect goto is
1219 /// codegen'd as a jump to the IndirectBranch's basic block.
Erich Keanebe65e872018-07-10 21:07:50 +00001220 llvm::IndirectBrInst *IndirectBranch = nullptr;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001221
Mike Stumpfc496822009-02-08 23:14:22 +00001222 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1223 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001224 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001225
Akira Hatanakaccda3d22018-04-27 06:57:00 +00001226 // Keep track of the cleanups for callee-destructed parameters pushed to the
1227 // cleanup stack so that they can be deactivated later.
1228 llvm::DenseMap<const ParmVarDecl *, EHScopeStack::stable_iterator>
1229 CalleeDestructedParamCleanups;
1230
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001231 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1232 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1233 /// parameter.
1234 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1235 SizeArguments;
1236
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001237 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001238 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001239 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1240
Chris Lattnerac248202007-05-30 00:13:02 +00001241 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001242 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001243
Mike Stumpfc496822009-02-08 23:14:22 +00001244 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001245 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001246 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001247 BreakContinue(JumpDest Break, JumpDest Continue)
1248 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001249
John McCallbd309292010-07-06 01:34:17 +00001250 JumpDest BreakBlock;
1251 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001252 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001253 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001254
Alexey Bataev957d8562016-11-17 15:12:05 +00001255 /// Handles cancellation exit points in OpenMP-related constructs.
1256 class OpenMPCancelExitStack {
1257 /// Tracks cancellation exit point and join point for cancel-related exit
1258 /// and normal exit.
1259 struct CancelExit {
1260 CancelExit() = default;
1261 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1262 JumpDest ContBlock)
1263 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1264 OpenMPDirectiveKind Kind = OMPD_unknown;
1265 /// true if the exit block has been emitted already by the special
1266 /// emitExit() call, false if the default codegen is used.
1267 bool HasBeenEmitted = false;
1268 JumpDest ExitBlock;
1269 JumpDest ContBlock;
1270 };
1271
1272 SmallVector<CancelExit, 8> Stack;
1273
1274 public:
1275 OpenMPCancelExitStack() : Stack(1) {}
1276 ~OpenMPCancelExitStack() = default;
1277 /// Fetches the exit block for the current OpenMP construct.
1278 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1279 /// Emits exit block with special codegen procedure specific for the related
1280 /// OpenMP construct + emits code for normal construct cleanup.
1281 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
Alexey Bataevddf3db92018-04-13 17:31:06 +00001282 const llvm::function_ref<void(CodeGenFunction &)> CodeGen) {
Alexey Bataev957d8562016-11-17 15:12:05 +00001283 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1284 assert(CGF.getOMPCancelDestination(Kind).isValid());
1285 assert(CGF.HaveInsertPoint());
1286 assert(!Stack.back().HasBeenEmitted);
1287 auto IP = CGF.Builder.saveAndClearIP();
1288 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1289 CodeGen(CGF);
Erich Keane0026ed22017-07-27 16:28:20 +00001290 CGF.EmitBranch(Stack.back().ContBlock.getBlock());
Alexey Bataev957d8562016-11-17 15:12:05 +00001291 CGF.Builder.restoreIP(IP);
1292 Stack.back().HasBeenEmitted = true;
1293 }
1294 CodeGen(CGF);
1295 }
1296 /// Enter the cancel supporting \a Kind construct.
1297 /// \param Kind OpenMP directive that supports cancel constructs.
1298 /// \param HasCancel true, if the construct has inner cancel directive,
1299 /// false otherwise.
1300 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1301 Stack.push_back({Kind,
1302 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1303 : JumpDest(),
1304 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1305 : JumpDest()});
1306 }
1307 /// Emits default exit point for the cancel construct (if the special one
1308 /// has not be used) + join point for cancel/normal exits.
1309 void exit(CodeGenFunction &CGF) {
1310 if (getExitBlock().isValid()) {
1311 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1312 bool HaveIP = CGF.HaveInsertPoint();
1313 if (!Stack.back().HasBeenEmitted) {
1314 if (HaveIP)
1315 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1316 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1317 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1318 }
1319 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1320 if (!HaveIP) {
1321 CGF.Builder.CreateUnreachable();
1322 CGF.Builder.ClearInsertionPoint();
1323 }
1324 }
1325 Stack.pop_back();
1326 }
1327 };
1328 OpenMPCancelExitStack OMPCancelStack;
1329
Justin Bogneref512b92014-01-06 22:27:43 +00001330 CodeGenPGO PGO;
1331
Justin Bogner65512642015-05-02 05:00:55 +00001332 /// Calculate branch weights appropriate for PGO data
1333 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1334 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1335 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1336 uint64_t LoopCount);
1337
Justin Bogneref512b92014-01-06 22:27:43 +00001338public:
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001339 /// Increment the profiler's counter for the given statement by \p StepV.
1340 /// If \p StepV is null, the default increment is 1.
1341 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
Rong Xu9837ef52016-02-04 18:39:09 +00001342 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001343 PGO.emitCounterIncrement(Builder, S, StepV);
Justin Bogner66242d62015-04-23 23:06:47 +00001344 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001345 }
Justin Bogner66242d62015-04-23 23:06:47 +00001346
1347 /// Get the profiler's count for the given statement.
1348 uint64_t getProfileCount(const Stmt *S) {
1349 Optional<uint64_t> Count = PGO.getStmtCount(S);
1350 if (!Count.hasValue())
1351 return 0;
1352 return *Count;
1353 }
1354
1355 /// Set the profiler's current count.
1356 void setCurrentProfileCount(uint64_t Count) {
1357 PGO.setCurrentRegionCount(Count);
1358 }
1359
1360 /// Get the profiler's current count. This is generally the count for the most
1361 /// recently incremented counter.
1362 uint64_t getCurrentProfileCount() {
1363 return PGO.getCurrentRegionCount();
1364 }
1365
Justin Bogneref512b92014-01-06 22:27:43 +00001366private:
1367
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001368 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001369 /// current context is not in a switch.
Erich Keanebe65e872018-07-10 21:07:50 +00001370 llvm::SwitchInst *SwitchInsn = nullptr;
Justin Bogneref512b92014-01-06 22:27:43 +00001371 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
Erich Keanebe65e872018-07-10 21:07:50 +00001372 SmallVector<uint64_t, 16> *SwitchWeights = nullptr;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001373
Mike Stumpfc496822009-02-08 23:14:22 +00001374 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001375 /// statement range in current switch instruction.
Erich Keanebe65e872018-07-10 21:07:50 +00001376 llvm::BasicBlock *CaseRangeBlock = nullptr;
Devang Patel11663122007-10-08 20:57:48 +00001377
John McCallc07a0c72011-02-17 10:25:35 +00001378 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001379 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001380 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1381 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001382
Mike Stumpfc496822009-02-08 23:14:22 +00001383 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001384 // We track this by the size expression rather than the type itself because
1385 // in certain situations, like a const qualifier applied to an VLA typedef,
1386 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001387 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1388 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001389 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001390
John McCallbd309292010-07-06 01:34:17 +00001391 /// A block containing a single 'unreachable' instruction. Created
1392 /// lazily by getUnreachableBlock().
Erich Keanebe65e872018-07-10 21:07:50 +00001393 llvm::BasicBlock *UnreachableBlock = nullptr;
Mike Stumpfc496822009-02-08 23:14:22 +00001394
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001395 /// Counts of the number return expressions in the function.
Erich Keanebe65e872018-07-10 21:07:50 +00001396 unsigned NumReturnExprs = 0;
Adrian Prantl3be10542013-05-02 17:30:20 +00001397
1398 /// Count the number of simple (constant) return expressions in the function.
Erich Keanebe65e872018-07-10 21:07:50 +00001399 unsigned NumSimpleReturnExprs = 0;
Adrian Prantl3be10542013-05-02 17:30:20 +00001400
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001401 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001402 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001403
Richard Smith852c9db2013-04-20 22:23:05 +00001404public:
Eric Fiselier708afb52019-05-16 21:04:15 +00001405 /// Source location information about the default argument or member
1406 /// initializer expression we're evaluating, if any.
1407 CurrentSourceLocExprScope CurSourceLocExprScope;
1408 using SourceLocExprScopeGuard =
1409 CurrentSourceLocExprScope::SourceLocExprScopeGuard;
1410
Richard Smith852c9db2013-04-20 22:23:05 +00001411 /// A scope within which we are constructing the fields of an object which
1412 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1413 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1414 class FieldConstructionScope {
1415 public:
John McCall7f416cc2015-09-08 08:05:57 +00001416 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001417 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1418 CGF.CXXDefaultInitExprThis = This;
1419 }
1420 ~FieldConstructionScope() {
1421 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1422 }
1423
1424 private:
1425 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001426 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001427 };
1428
1429 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1430 /// is overridden to be the object under construction.
Eric Fiselier708afb52019-05-16 21:04:15 +00001431 class CXXDefaultInitExprScope {
Richard Smith852c9db2013-04-20 22:23:05 +00001432 public:
Eric Fiselier708afb52019-05-16 21:04:15 +00001433 CXXDefaultInitExprScope(CodeGenFunction &CGF, const CXXDefaultInitExpr *E)
1434 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1435 OldCXXThisAlignment(CGF.CXXThisAlignment),
1436 SourceLocScope(E, CGF.CurSourceLocExprScope) {
John McCall7f416cc2015-09-08 08:05:57 +00001437 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1438 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001439 }
1440 ~CXXDefaultInitExprScope() {
1441 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001442 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001443 }
1444
1445 public:
1446 CodeGenFunction &CGF;
1447 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001448 CharUnits OldCXXThisAlignment;
Eric Fiselier708afb52019-05-16 21:04:15 +00001449 SourceLocExprScopeGuard SourceLocScope;
1450 };
1451
1452 struct CXXDefaultArgExprScope : SourceLocExprScopeGuard {
1453 CXXDefaultArgExprScope(CodeGenFunction &CGF, const CXXDefaultArgExpr *E)
1454 : SourceLocExprScopeGuard(E, CGF.CurSourceLocExprScope) {}
Richard Smith852c9db2013-04-20 22:23:05 +00001455 };
1456
Richard Smith410306b2016-12-12 02:53:20 +00001457 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1458 /// current loop index is overridden.
1459 class ArrayInitLoopExprScope {
1460 public:
1461 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1462 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1463 CGF.ArrayInitIndex = Index;
1464 }
1465 ~ArrayInitLoopExprScope() {
1466 CGF.ArrayInitIndex = OldArrayInitIndex;
1467 }
1468
1469 private:
1470 CodeGenFunction &CGF;
1471 llvm::Value *OldArrayInitIndex;
1472 };
1473
Richard Smith5179eb72016-06-28 19:03:57 +00001474 class InlinedInheritingConstructorScope {
1475 public:
1476 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1477 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1478 OldCurCodeDecl(CGF.CurCodeDecl),
1479 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1480 OldCXXABIThisValue(CGF.CXXABIThisValue),
1481 OldCXXThisValue(CGF.CXXThisValue),
1482 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1483 OldCXXThisAlignment(CGF.CXXThisAlignment),
1484 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1485 OldCXXInheritedCtorInitExprArgs(
1486 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1487 CGF.CurGD = GD;
1488 CGF.CurFuncDecl = CGF.CurCodeDecl =
1489 cast<CXXConstructorDecl>(GD.getDecl());
1490 CGF.CXXABIThisDecl = nullptr;
1491 CGF.CXXABIThisValue = nullptr;
1492 CGF.CXXThisValue = nullptr;
1493 CGF.CXXABIThisAlignment = CharUnits();
1494 CGF.CXXThisAlignment = CharUnits();
1495 CGF.ReturnValue = Address::invalid();
1496 CGF.FnRetTy = QualType();
1497 CGF.CXXInheritedCtorInitExprArgs.clear();
1498 }
1499 ~InlinedInheritingConstructorScope() {
1500 CGF.CurGD = OldCurGD;
1501 CGF.CurFuncDecl = OldCurFuncDecl;
1502 CGF.CurCodeDecl = OldCurCodeDecl;
1503 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1504 CGF.CXXABIThisValue = OldCXXABIThisValue;
1505 CGF.CXXThisValue = OldCXXThisValue;
1506 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1507 CGF.CXXThisAlignment = OldCXXThisAlignment;
1508 CGF.ReturnValue = OldReturnValue;
1509 CGF.FnRetTy = OldFnRetTy;
1510 CGF.CXXInheritedCtorInitExprArgs =
1511 std::move(OldCXXInheritedCtorInitExprArgs);
1512 }
1513
1514 private:
1515 CodeGenFunction &CGF;
1516 GlobalDecl OldCurGD;
1517 const Decl *OldCurFuncDecl;
1518 const Decl *OldCurCodeDecl;
1519 ImplicitParamDecl *OldCXXABIThisDecl;
1520 llvm::Value *OldCXXABIThisValue;
1521 llvm::Value *OldCXXThisValue;
1522 CharUnits OldCXXABIThisAlignment;
1523 CharUnits OldCXXThisAlignment;
1524 Address OldReturnValue;
1525 QualType OldFnRetTy;
1526 CallArgList OldCXXInheritedCtorInitExprArgs;
1527 };
1528
Richard Smith852c9db2013-04-20 22:23:05 +00001529private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001530 /// CXXThisDecl - When generating code for a C++ member function,
1531 /// this will hold the implicit 'this' declaration.
Erich Keanebe65e872018-07-10 21:07:50 +00001532 ImplicitParamDecl *CXXABIThisDecl = nullptr;
1533 llvm::Value *CXXABIThisValue = nullptr;
1534 llvm::Value *CXXThisValue = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +00001535 CharUnits CXXABIThisAlignment;
1536 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001537
Richard Smith852c9db2013-04-20 22:23:05 +00001538 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1539 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001540 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001541
Richard Smith410306b2016-12-12 02:53:20 +00001542 /// The current array initialization index when evaluating an
1543 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1544 llvm::Value *ArrayInitIndex = nullptr;
1545
Richard Smith5179eb72016-06-28 19:03:57 +00001546 /// The values of function arguments to use when evaluating
1547 /// CXXInheritedCtorInitExprs within this context.
1548 CallArgList CXXInheritedCtorInitExprArgs;
1549
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001550 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1551 /// destructor, this will hold the implicit argument (e.g. VTT).
Erich Keanebe65e872018-07-10 21:07:50 +00001552 ImplicitParamDecl *CXXStructorImplicitParamDecl = nullptr;
1553 llvm::Value *CXXStructorImplicitParamValue = nullptr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001554
John McCallce1de612011-01-26 04:00:11 +00001555 /// OutermostConditional - Points to the outermost active
1556 /// conditional control. This is used so that we know if a
1557 /// temporary should be destroyed conditionally.
Erich Keanebe65e872018-07-10 21:07:50 +00001558 ConditionalEvaluation *OutermostConditional = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001559
Nadav Rotem1da30942013-03-23 06:43:35 +00001560 /// The current lexical scope.
Erich Keanebe65e872018-07-10 21:07:50 +00001561 LexicalScope *CurLexicalScope = nullptr;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001562
Adrian Prantldc237b52013-05-16 00:41:26 +00001563 /// The current source location that should be used for exception
1564 /// handling code.
1565 SourceLocation CurEHLocation;
1566
John McCall7f416cc2015-09-08 08:05:57 +00001567 /// BlockByrefInfos - For each __block variable, contains
1568 /// information about the layout of the variable.
1569 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001570
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001571 /// Used by -fsanitize=nullability-return to determine whether the return
1572 /// value can be checked.
1573 llvm::Value *RetValNullabilityPrecondition = nullptr;
1574
1575 /// Check if -fsanitize=nullability-return instrumentation is required for
1576 /// this function.
1577 bool requiresReturnValueNullabilityCheck() const {
1578 return RetValNullabilityPrecondition;
1579 }
1580
Vedant Kumarc34d3432017-06-23 21:32:38 +00001581 /// Used to store precise source locations for return statements by the
1582 /// runtime return value checks.
1583 Address ReturnLocation = Address::invalid();
1584
1585 /// Check if the return value of this function requires sanitization.
1586 bool requiresReturnValueCheck() const {
1587 return requiresReturnValueNullabilityCheck() ||
1588 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
1589 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
1590 }
1591
Erich Keanebe65e872018-07-10 21:07:50 +00001592 llvm::BasicBlock *TerminateLandingPad = nullptr;
1593 llvm::BasicBlock *TerminateHandler = nullptr;
1594 llvm::BasicBlock *TrapBB = nullptr;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001595
Reid Kleckner06f19a02018-01-02 21:34:16 +00001596 /// Terminate funclets keyed by parent funclet pad.
1597 llvm::MapVector<llvm::Value *, llvm::BasicBlock *> TerminateFunclets;
1598
Craig Topper74c10e32018-07-09 19:00:16 +00001599 /// Largest vector width used in ths function. Will be used to create a
1600 /// function attribute.
Erich Keanebe65e872018-07-10 21:07:50 +00001601 unsigned LargestVectorWidth = 0;
Craig Topper74c10e32018-07-09 19:00:16 +00001602
Vitaly Buka1c943322016-10-26 01:59:57 +00001603 /// True if we need emit the life-time markers.
1604 const bool ShouldEmitLifetimeMarkers;
1605
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00001606 /// Add OpenCL kernel arg metadata and the kernel attribute metadata to
Xiuli Panbe6da4b2017-05-04 07:31:20 +00001607 /// the function metadata.
Gor Nishanov04491bd2017-11-11 17:00:43 +00001608 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001609 llvm::Function *Fn);
1610
Chris Lattnerbed31442007-05-28 01:07:47 +00001611public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001612 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001613 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001614
John McCall8ed55a52010-09-02 09:58:18 +00001615 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001616 ASTContext &getContext() const { return CGM.getContext(); }
Gor Nishanov04491bd2017-11-11 17:00:43 +00001617 CGDebugInfo *getDebugInfo() {
1618 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001619 return nullptr;
Gor Nishanov04491bd2017-11-11 17:00:43 +00001620 return DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001621 }
1622 void disableDebugInfo() { DisableDebugInfo = true; }
1623 void enableDebugInfo() { DisableDebugInfo = false; }
1624
John McCall31168b02011-06-15 23:02:42 +00001625 bool shouldUseFusedARCCalls() {
1626 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1627 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001628
David Blaikiebbafb8a2012-03-11 07:00:24 +00001629 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001630
Bill Wendlingf0724e82011-09-19 20:31:14 +00001631 /// Returns a pointer to the function's exception object and selector slot,
1632 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001633 Address getExceptionSlot();
1634 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001635
Bill Wendling79a70e42011-09-15 18:57:19 +00001636 /// Returns the contents of the function's exception object and selector
1637 /// slots.
1638 llvm::Value *getExceptionFromSlot();
1639 llvm::Value *getSelectorFromSlot();
1640
John McCall7f416cc2015-09-08 08:05:57 +00001641 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001642
John McCallbd309292010-07-06 01:34:17 +00001643 llvm::BasicBlock *getUnreachableBlock() {
1644 if (!UnreachableBlock) {
1645 UnreachableBlock = createBasicBlock("unreachable");
1646 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1647 }
1648 return UnreachableBlock;
1649 }
1650
1651 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001652 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001653 return getInvokeDestImpl();
1654 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001655
David Majnemer25eb1652016-03-01 19:42:53 +00001656 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001657
John McCallc8e01702013-04-16 22:48:15 +00001658 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001659 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Yaxun Liucbf647c2017-07-08 13:24:52 +00001660 const TargetCodeGenInfo &getTargetHooks() const {
1661 return CGM.getTargetCodeGenInfo();
1662 }
Owen Andersonae86c192009-07-13 04:10:07 +00001663
Daniel Dunbar12347492009-02-23 17:26:39 +00001664 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001665 // Cleanups
1666 //===--------------------------------------------------------------------===//
1667
John McCall7f416cc2015-09-08 08:05:57 +00001668 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001669
John McCall178360e2011-07-11 08:38:19 +00001670 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001671 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001672 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001673 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001674 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001675 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1676 llvm::Value *arrayEnd,
1677 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001678 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001679 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001680
John McCall4bd0fb12011-07-12 16:41:08 +00001681 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001682 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001683 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001684 Address addr, QualType type);
1685 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001686 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001687 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001688 QualType type, Destroyer *destroyer,
1689 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001690 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1691 llvm::Value *CompletePtr,
1692 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001693 void pushStackRestore(CleanupKind kind, Address SPMem);
1694 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001695 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001696 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001697 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001698 bool useEHCleanupForArray,
1699 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001700 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001701 QualType elementType, CharUnits elementAlign,
1702 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001703 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001704
Peter Collingbourne1425b452012-01-26 03:33:36 +00001705 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001706
John McCall82fe67b2011-07-09 01:37:26 +00001707 /// Determines whether an EH cleanup is required to destroy a type
1708 /// with the given destruction kind.
1709 bool needsEHCleanup(QualType::DestructionKind kind) {
1710 switch (kind) {
1711 case QualType::DK_none:
1712 return false;
1713 case QualType::DK_cxx_destructor:
1714 case QualType::DK_objc_weak_lifetime:
Akira Hatanaka7275da02018-02-28 07:15:55 +00001715 case QualType::DK_nontrivial_c_struct:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001716 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001717 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001718 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001719 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1720 }
1721 llvm_unreachable("bad destruction kind");
1722 }
1723
John McCall4bd0fb12011-07-12 16:41:08 +00001724 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1725 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1726 }
1727
John McCall82fe67b2011-07-09 01:37:26 +00001728 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001729 // Objective-C
1730 //===--------------------------------------------------------------------===//
1731
Chris Lattner4bd55962008-03-30 23:03:07 +00001732 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001733
David Blaikief1425802015-01-14 00:04:42 +00001734 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001735
Mike Stumpfc496822009-02-08 23:14:22 +00001736 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001737 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1738 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001739 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001740 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001741 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001742 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001743
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001744 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1745 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001746
Mike Stumpfc496822009-02-08 23:14:22 +00001747 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1748 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001749 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1750 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001751 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001752 const ObjCPropertyImplDecl *propImpl,
1753 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001754
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001755 //===--------------------------------------------------------------------===//
1756 // Block Bits
1757 //===--------------------------------------------------------------------===//
1758
Yaxun Liuc2a87a02017-10-14 12:23:50 +00001759 /// Emit block literal.
1760 /// \return an LLVM value which is a pointer to a struct which contains
1761 /// information about the block, including the block invoke function, the
1762 /// captured variables, etc.
Yaxun Liufa13d012018-02-15 16:39:19 +00001763 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001764 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001765
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001766 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001767 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001768 const DeclMapTy &ldm,
Akira Hatanakaba0367a2017-09-22 21:32:06 +00001769 bool IsLambdaConversionToBlock,
1770 bool BuildGlobalBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001771
Akira Hatanaka9978da32018-08-10 15:09:24 +00001772 /// Check if \p T is a C++ class that has a destructor that can throw.
1773 static bool cxxDestructorCanThrow(QualType T);
1774
John McCallad7c5c12011-02-08 08:22:06 +00001775 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1776 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001777 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1778 const ObjCPropertyImplDecl *PID);
1779 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1780 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001781 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001782
Akira Hatanaka9978da32018-08-10 15:09:24 +00001783 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags,
1784 bool CanThrow);
John McCallad7c5c12011-02-08 08:22:06 +00001785
John McCall73064872011-03-31 01:59:53 +00001786 class AutoVarEmission;
1787
1788 void emitByrefStructureInit(const AutoVarEmission &emission);
Akira Hatanakacb6a9332018-07-26 16:51:21 +00001789
1790 /// Enter a cleanup to destroy a __block variable. Note that this
1791 /// cleanup should be a no-op if the variable hasn't left the stack
1792 /// yet; if a cleanup is required for the variable itself, that needs
1793 /// to be done externally.
1794 ///
1795 /// \param Kind Cleanup kind.
1796 ///
1797 /// \param Addr When \p LoadBlockVarAddr is false, the address of the __block
1798 /// structure that will be passed to _Block_object_dispose. When
1799 /// \p LoadBlockVarAddr is true, the address of the field of the block
1800 /// structure that holds the address of the __block structure.
1801 ///
1802 /// \param Flags The flag that will be passed to _Block_object_dispose.
1803 ///
1804 /// \param LoadBlockVarAddr Indicates whether we need to emit a load from
1805 /// \p Addr to get the address of the __block structure.
1806 void enterByrefCleanup(CleanupKind Kind, Address Addr, BlockFieldFlags Flags,
Akira Hatanaka9978da32018-08-10 15:09:24 +00001807 bool LoadBlockVarAddr, bool CanThrow);
John McCall73064872011-03-31 01:59:53 +00001808
John McCall7f416cc2015-09-08 08:05:57 +00001809 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1810 llvm::Value *ptr);
1811
1812 Address LoadBlockStruct();
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001813 Address GetAddrOfBlockDecl(const VarDecl *var);
John McCall7f416cc2015-09-08 08:05:57 +00001814
1815 /// BuildBlockByrefAddress - Computes the location of the
1816 /// data in a variable which is declared as __block.
1817 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1818 bool followForward = true);
1819 Address emitBlockByrefAddress(Address baseAddr,
1820 const BlockByrefInfo &info,
1821 bool followForward,
1822 const llvm::Twine &name);
1823
1824 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001825
Richard Smith5179eb72016-06-28 19:03:57 +00001826 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1827
John McCalla738c252011-03-09 04:27:21 +00001828 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1829 const CGFunctionInfo &FnInfo);
Akira Hatanaka9978da32018-08-10 15:09:24 +00001830
1831 /// Annotate the function with an attribute that disables TSan checking at
1832 /// runtime.
1833 void markAsIgnoreThreadCheckingAtRuntime(llvm::Function *Fn);
1834
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001835 /// Emit code for the start of a function.
Adrian Prantl42d71b92014-04-10 23:21:53 +00001836 /// \param Loc The location to be associated with the function.
1837 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001838 void StartFunction(GlobalDecl GD,
1839 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001840 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001841 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001842 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001843 SourceLocation Loc = SourceLocation(),
1844 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001845
Vedant Kumar7f809b22017-02-24 01:15:19 +00001846 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1847
John McCallb81884d2010-02-19 09:25:03 +00001848 void EmitConstructorBody(FunctionArgList &Args);
1849 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001850 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Reid Kleckner43071082018-12-13 01:33:20 +00001851 void EmitFunctionBody(const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001852 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001853
Faisal Vali571df122013-09-29 08:45:24 +00001854 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001855 CallArgList &CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00001856 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001857 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001858 void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
Richard Smith04440062019-01-17 22:05:50 +00001859 void EmitLambdaVLACapture(const VariableArrayType *VAT, LValue LV) {
1860 EmitStoreThroughLValue(RValue::get(VLASizeMap[VAT->getSizeExpr()]), LV);
1861 }
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001862 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001863
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001864 /// Emit the unified return block, trying to avoid its emission when
David Blaikiea0a1a872015-01-18 02:48:07 +00001865 /// possible.
1866 /// \return The debug location of the user written return statement if the
1867 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001868 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001869
Mike Stumpfc496822009-02-08 23:14:22 +00001870 /// FinishFunction - Complete IR generation of the current function. It is
1871 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001872 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001873
Nico Weber1bebad12015-02-11 22:33:32 +00001874 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
Reid Kleckner399d96e2018-04-02 20:20:33 +00001875 const CGFunctionInfo &FnInfo, bool IsUnprototyped);
Hans Wennborg88497d62013-11-15 17:24:45 +00001876
James Y Knight76f78742019-02-05 19:17:50 +00001877 void EmitCallAndReturnForThunk(llvm::FunctionCallee Callee,
1878 const ThunkInfo *Thunk, bool IsUnprototyped);
Hans Wennborg88497d62013-11-15 17:24:45 +00001879
John McCall7f416cc2015-09-08 08:05:57 +00001880 void FinishThunk();
1881
Reid Klecknerab2090d2014-07-26 01:34:32 +00001882 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
Erich Keanede6480a32018-11-13 15:48:08 +00001883 void EmitMustTailThunk(GlobalDecl GD, llvm::Value *AdjustedThisPtr,
James Y Knight76f78742019-02-05 19:17:50 +00001884 llvm::FunctionCallee Callee);
Reid Klecknerab2090d2014-07-26 01:34:32 +00001885
Rafael Espindolad6e66942015-07-13 06:07:58 +00001886 /// Generate a thunk for the given method.
1887 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
Reid Kleckner399d96e2018-04-02 20:20:33 +00001888 GlobalDecl GD, const ThunkInfo &Thunk,
1889 bool IsUnprototyped);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001890
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001891 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1892 const CGFunctionInfo &FnInfo,
1893 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001894
Douglas Gregor94f9a482010-05-05 05:51:00 +00001895 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1896 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001897
Richard Smith30e304e2016-12-14 00:03:17 +00001898 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001899
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00001900 /// Struct with all information about dynamic [sub]class needed to set vptr.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001901 struct VPtr {
1902 BaseSubobject Base;
1903 const CXXRecordDecl *NearestVBase;
1904 CharUnits OffsetFromNearestVBase;
1905 const CXXRecordDecl *VTableClass;
1906 };
1907
1908 /// Initialize the vtable pointer of the given subobject.
1909 void InitializeVTablePointer(const VPtr &vptr);
1910
1911 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001912
1913 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001914 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1915
1916 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1917 CharUnits OffsetFromNearestVBase,
1918 bool BaseIsNonVirtualPrimaryBase,
1919 const CXXRecordDecl *VTableClass,
1920 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001921
Anders Carlssond5895932010-03-28 21:07:49 +00001922 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001923
Dan Gohman8fc50c22010-10-26 18:44:08 +00001924 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1925 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001926 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1927 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001928
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001929 enum CFITypeCheckKind {
1930 CFITCK_VCall,
1931 CFITCK_NVCall,
1932 CFITCK_DerivedCast,
1933 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001934 CFITCK_ICall,
Peter Collingbournee44acad2018-06-26 02:15:47 +00001935 CFITCK_NVMFCall,
1936 CFITCK_VMFCall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001937 };
1938
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001939 /// Derived is the presumed address of an object of type T after a
Peter Collingbourned2926c92015-03-14 02:42:25 +00001940 /// cast. If T is a polymorphic class type, emit a check that the virtual
1941 /// table for Derived belongs to a class derived from T.
1942 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001943 bool MayBeNull, CFITypeCheckKind TCK,
1944 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001945
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001946 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1947 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001948 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001949 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001950
Peter Collingbourned2926c92015-03-14 02:42:25 +00001951 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001952 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001953 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1954 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001955
Peter Collingbournefb532b92016-02-24 20:46:36 +00001956 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001957 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1958 /// enabled, emit a check that VTable is a member of RD's type identifier.
1959 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1960 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001961
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001962 /// Returns whether we should perform a type checked load when loading a
1963 /// virtual function for virtual calls to members of RD. This is generally
1964 /// true when both vcall CFI and whole-program-vtables are enabled.
1965 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1966
1967 /// Emit a type checked load from the given vtable.
1968 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1969 uint64_t VTableByteOffset);
1970
John McCallf99a6312010-07-21 05:30:47 +00001971 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1972 /// given phase of destruction for a destructor. The end result
1973 /// should call destructors on members and base classes in reverse
1974 /// order of their construction.
1975 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001976
Chris Lattner3c77a352010-06-22 00:03:40 +00001977 /// ShouldInstrumentFunction - Return true if the current function should be
1978 /// instrumented with __cyg_profile_func_* calls
1979 bool ShouldInstrumentFunction();
1980
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001981 /// ShouldXRayInstrument - Return true if the current function should be
1982 /// instrumented with XRay nop sleds.
1983 bool ShouldXRayInstrumentFunction() const;
1984
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +00001985 /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
1986 /// XRay custom event handling calls.
1987 bool AlwaysEmitXRayCustomEvents() const;
1988
Keith Wyssf437e352018-04-17 21:32:43 +00001989 /// AlwaysEmitXRayTypedEvents - Return true if clang must unconditionally emit
1990 /// XRay typed event handling calls.
1991 bool AlwaysEmitXRayTypedEvents() const;
1992
Vedant Kumarbb5d4852017-09-13 00:04:35 +00001993 /// Encode an address into a form suitable for use in a function prologue.
1994 llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
1995 llvm::Constant *Addr);
1996
1997 /// Decode an address used in a function prologue, encoded by \c
1998 /// EncodeAddrForUseInPrologue.
1999 llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
2000 llvm::Value *EncodedAddr);
2001
Mike Stumpfc496822009-02-08 23:14:22 +00002002 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
2003 /// arguments for the given function. This is also responsible for naming the
2004 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00002005 void EmitFunctionProlog(const CGFunctionInfo &FI,
2006 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00002007 const FunctionArgList &Args);
2008
Mike Stumpfc496822009-02-08 23:14:22 +00002009 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
2010 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002011 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
2012 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002013
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002014 /// Emit a test that checks if the return value \p RV is nonnull.
Vedant Kumarc34d3432017-06-23 21:32:38 +00002015 void EmitReturnValueCheck(llvm::Value *RV);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002016
Mike Stump1d849212009-12-07 23:38:24 +00002017 /// EmitStartEHSpec - Emit the start of the exception spec.
2018 void EmitStartEHSpec(const Decl *D);
2019
2020 /// EmitEndEHSpec - Emit the end of the exception spec.
2021 void EmitEndEHSpec(const Decl *D);
2022
John McCallbd309292010-07-06 01:34:17 +00002023 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
2024 llvm::BasicBlock *getTerminateLandingPad();
2025
Reid Kleckner06f19a02018-01-02 21:34:16 +00002026 /// getTerminateLandingPad - Return a cleanup funclet that just calls
2027 /// terminate.
2028 llvm::BasicBlock *getTerminateFunclet();
2029
John McCallbd309292010-07-06 01:34:17 +00002030 /// getTerminateHandler - Return a handler (not a landing pad, just
2031 /// a catch handler) that just calls terminate. This is used when
2032 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00002033 llvm::BasicBlock *getTerminateHandler();
2034
Chris Lattnera5f58b02011-07-09 17:41:47 +00002035 llvm::Type *ConvertTypeForMem(QualType T);
2036 llvm::Type *ConvertType(QualType T);
2037 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00002038 return ConvertType(getContext().getTypeDeclType(T));
2039 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00002040
Mike Stumpfc496822009-02-08 23:14:22 +00002041 /// LoadObjCSelf - Load the value of self. This function is only valid while
2042 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00002043 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00002044
2045 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002046 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00002047
Krasimir Georgiev46dfb7a2017-09-08 13:44:51 +00002048 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
John McCall47fb9502013-03-07 21:37:08 +00002049 static TypeEvaluationKind getEvaluationKind(QualType T);
2050
2051 static bool hasScalarEvaluationKind(QualType T) {
2052 return getEvaluationKind(T) == TEK_Scalar;
2053 }
2054
2055 static bool hasAggregateEvaluationKind(QualType T) {
2056 return getEvaluationKind(T) == TEK_Aggregate;
2057 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00002058
2059 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00002060 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00002061 llvm::Function *parent = nullptr,
2062 llvm::BasicBlock *before = nullptr) {
John McCallad7c5c12011-02-08 08:22:06 +00002063 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar75283ff2008-11-11 02:29:29 +00002064 }
Mike Stumpfc496822009-02-08 23:14:22 +00002065
Chris Lattnerac248202007-05-30 00:13:02 +00002066 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
2067 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002068 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00002069
Mike Stumpe5311b02009-11-30 20:08:49 +00002070 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
2071 /// another basic block, simplify it. This assumes that no other code could
2072 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00002073 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
2074
Mike Stumpfc496822009-02-08 23:14:22 +00002075 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
2076 /// adding a fall-through branch from the current insert block if
2077 /// necessary. It is legal to call this function even if there is no current
2078 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00002079 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002080 /// IsFinished - If true, indicates that the caller has finished emitting
2081 /// branches to the given block and does not expect to emit code into it. This
2082 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00002083 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00002084
John McCall8e4c74b2011-08-11 02:22:43 +00002085 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
2086 /// near its uses, and leave the insertion point in it.
2087 void EmitBlockAfterUses(llvm::BasicBlock *BB);
2088
Mike Stumpfc496822009-02-08 23:14:22 +00002089 /// EmitBranch - Emit a branch to the specified basic block from the current
2090 /// insert block, taking care to avoid creation of branches from dummy
2091 /// blocks. It is legal to call this function even if there is no current
2092 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00002093 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002094 /// This function clears the current insertion point. The caller should follow
2095 /// calls to this function with calls to Emit*Block prior to generation new
2096 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00002097 void EmitBranch(llvm::BasicBlock *Block);
2098
Mike Stumpfc496822009-02-08 23:14:22 +00002099 /// HaveInsertPoint - True if an insertion point is defined. If not, this
2100 /// indicates that the current code being emitted is unreachable.
2101 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002102 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002103 }
2104
Mike Stumpfc496822009-02-08 23:14:22 +00002105 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
2106 /// emitted IR has a place to go. Note that by definition, if this function
2107 /// creates a block then that block is unreachable; callers may do better to
2108 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002109 void EnsureInsertPoint() {
2110 if (!HaveInsertPoint())
2111 EmitBlock(createBasicBlock());
2112 }
Mike Stumpfc496822009-02-08 23:14:22 +00002113
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00002114 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00002115 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00002116 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00002117
Chris Lattnere9a64532007-06-22 21:44:33 +00002118 //===--------------------------------------------------------------------===//
2119 // Helpers
2120 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002121
John McCall7f416cc2015-09-08 08:05:57 +00002122 LValue MakeAddrLValue(Address Addr, QualType T,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002123 AlignmentSource Source = AlignmentSource::Type) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00002124 return LValue::MakeAddr(Addr, T, getContext(), LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002125 CGM.getTBAAAccessInfo(T));
2126 }
2127
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00002128 LValue MakeAddrLValue(Address Addr, QualType T, LValueBaseInfo BaseInfo,
2129 TBAAAccessInfo TBAAInfo) {
2130 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00002131 }
John McCall4e8ca4f2012-07-02 23:58:38 +00002132
John McCall7f416cc2015-09-08 08:05:57 +00002133 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002134 AlignmentSource Source = AlignmentSource::Type) {
2135 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00002136 LValueBaseInfo(Source), CGM.getTBAAAccessInfo(T));
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002137 }
2138
2139 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00002140 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00002141 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00002142 BaseInfo, TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +00002143 }
2144
2145 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00002146 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00002147 CharUnits getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00002148 LValueBaseInfo *BaseInfo = nullptr,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +00002149 TBAAAccessInfo *TBAAInfo = nullptr,
John McCall7f416cc2015-09-08 08:05:57 +00002150 bool forPointeeType = false);
2151 CharUnits getNaturalPointeeTypeAlignment(QualType T,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00002152 LValueBaseInfo *BaseInfo = nullptr,
2153 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00002154
Ivan A. Kosarev9f9d1572017-10-30 11:49:31 +00002155 Address EmitLoadOfReference(LValue RefLVal,
2156 LValueBaseInfo *PointeeBaseInfo = nullptr,
2157 TBAAAccessInfo *PointeeTBAAInfo = nullptr);
2158 LValue EmitLoadOfReferenceLValue(LValue RefLVal);
2159 LValue EmitLoadOfReferenceLValue(Address RefAddr, QualType RefTy,
2160 AlignmentSource Source =
2161 AlignmentSource::Type) {
2162 LValue RefLVal = MakeAddrLValue(RefAddr, RefTy, LValueBaseInfo(Source),
2163 CGM.getTBAAAccessInfo(RefTy));
2164 return EmitLoadOfReferenceLValue(RefLVal);
2165 }
Daniel Dunbar93b00a92010-08-21 02:53:44 +00002166
Alexey Bataev31300ed2016-02-04 11:27:03 +00002167 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
Ivan A. Kosarev90295642017-10-13 16:47:22 +00002168 LValueBaseInfo *BaseInfo = nullptr,
2169 TBAAAccessInfo *TBAAInfo = nullptr);
Alexey Bataev31300ed2016-02-04 11:27:03 +00002170 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
2171
Yaxun Liu84744c12017-06-19 17:03:41 +00002172 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
2173 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
2174 /// insertion point of the builder. The caller is responsible for setting an
2175 /// appropriate alignment on
Daniel Dunbara7566f12010-02-09 02:48:28 +00002176 /// the alloca.
Yaxun Liu84744c12017-06-19 17:03:41 +00002177 ///
2178 /// \p ArraySize is the number of array elements to be allocated if it
2179 /// is not nullptr.
2180 ///
2181 /// LangAS::Default is the address space of pointers to local variables and
2182 /// temporaries, as exposed in the source language. In certain
2183 /// configurations, this is not the same as the alloca address space, and a
2184 /// cast is needed to lift the pointer from the alloca AS into
2185 /// LangAS::Default. This can happen when the target uses a restricted
2186 /// address space for the stack but the source language requires
2187 /// LangAS::Default to be a generic address space. The latter condition is
2188 /// common for most programming languages; OpenCL is an exception in that
2189 /// LangAS::Default is the private address space, which naturally maps
2190 /// to the stack.
2191 ///
2192 /// Because the address of a temporary is often exposed to the program in
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002193 /// various ways, this function will perform the cast. The original alloca
2194 /// instruction is returned through \p Alloca if it is not nullptr.
2195 ///
2196 /// The cast is not performaed in CreateTempAllocaWithoutCast. This is
Yaxun Liu84744c12017-06-19 17:03:41 +00002197 /// more efficient if the caller knows that the address will not be exposed.
2198 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
2199 llvm::Value *ArraySize = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00002200 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
Yaxun Liu84744c12017-06-19 17:03:41 +00002201 const Twine &Name = "tmp",
2202 llvm::Value *ArraySize = nullptr,
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002203 Address *Alloca = nullptr);
2204 Address CreateTempAllocaWithoutCast(llvm::Type *Ty, CharUnits align,
2205 const Twine &Name = "tmp",
2206 llvm::Value *ArraySize = nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002207
John McCall7f416cc2015-09-08 08:05:57 +00002208 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
2209 /// default ABI alignment of the given LLVM type.
2210 ///
2211 /// IMPORTANT NOTE: This is *not* generally the right alignment for
2212 /// any given AST type that happens to have been lowered to the
2213 /// given IR type. This should only ever be used for function-local,
2214 /// IR-driven manipulations like saving and restoring a value. Do
2215 /// not hand this address off to arbitrary IRGen routines, and especially
2216 /// do not pass it as an argument to a function that might expect a
2217 /// properly ABI-aligned value.
2218 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
2219 const Twine &Name = "tmp");
2220
2221 /// InitTempAlloca - Provide an initial value for the given alloca which
2222 /// will be observable at all locations in the function.
2223 ///
2224 /// The address should be something that was returned from one of
2225 /// the CreateTempAlloca or CreateMemTemp routines, and the
2226 /// initializer must be valid in the entry block (i.e. it must
2227 /// either be a constant or an argument value).
2228 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00002229
Daniel Dunbard0049182010-02-16 19:44:13 +00002230 /// CreateIRTemp - Create a temporary IR object of the given type, with
2231 /// appropriate alignment. This routine should only be used when an temporary
2232 /// value needs to be stored into an alloca (for example, to avoid explicit
2233 /// PHI construction), but the type is the IR type, not the type appropriate
2234 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00002235 ///
2236 /// That is, this is exactly equivalent to CreateMemTemp, but calling
2237 /// ConvertType instead of ConvertTypeForMem.
2238 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00002239
Daniel Dunbara7566f12010-02-09 02:48:28 +00002240 /// CreateMemTemp - Create a temporary memory object of the given type, with
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002241 /// appropriate alignmen and cast it to the default address space. Returns
2242 /// the original alloca instruction by \p Alloca if it is not nullptr.
Yaxun Liu84744c12017-06-19 17:03:41 +00002243 Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002244 Address *Alloca = nullptr);
Yaxun Liu84744c12017-06-19 17:03:41 +00002245 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002246 Address *Alloca = nullptr);
2247
2248 /// CreateMemTemp - Create a temporary memory object of the given type, with
2249 /// appropriate alignmen without casting it to the default address space.
2250 Address CreateMemTempWithoutCast(QualType T, const Twine &Name = "tmp");
2251 Address CreateMemTempWithoutCast(QualType T, CharUnits Align,
2252 const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00002253
John McCall7a626f62010-09-15 10:14:12 +00002254 /// CreateAggTemp - Create a temporary memory object for the given
2255 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00002256 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00002257 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00002258 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00002259 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00002260 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00002261 AggValueSlot::IsNotAliased,
2262 AggValueSlot::DoesNotOverlap);
John McCall7a626f62010-09-15 10:14:12 +00002263 }
2264
John McCallad7c5c12011-02-08 08:22:06 +00002265 /// Emit a cast to void* in the appropriate address space.
2266 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2267
Chris Lattner8394d792007-06-05 20:53:16 +00002268 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2269 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00002270 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00002271
John McCalla2342eb2010-12-05 02:00:02 +00002272 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2273 void EmitIgnoredExpr(const Expr *E);
2274
Chris Lattner4647a212007-08-31 22:49:20 +00002275 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2276 /// any type. The result is returned as an RValue struct. If this is an
2277 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2278 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00002279 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00002280 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00002281 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00002282 AggValueSlot aggSlot = AggValueSlot::ignored(),
2283 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00002284
Mike Stumpfc496822009-02-08 23:14:22 +00002285 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2286 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00002287 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002288
Charles Davisc7d5c942015-09-17 20:55:33 +00002289 /// Emit a "reference" to a __builtin_ms_va_list; this is
2290 /// always the value of the expression, because a __builtin_ms_va_list is a
2291 /// pointer to a char.
2292 Address EmitMSVAListRef(const Expr *E);
2293
Gor Nishanov5eb58582017-03-26 02:18:05 +00002294 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
Mike Stumpfc496822009-02-08 23:14:22 +00002295 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00002296 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00002297
John McCall91ca10f2011-03-08 09:11:50 +00002298 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00002299 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00002300 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002301 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00002302
John McCall7f416cc2015-09-08 08:05:57 +00002303 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00002304
John McCall91ca10f2011-03-08 09:11:50 +00002305 /// EmitExprAsInit - Emits the code necessary to initialize a
2306 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00002307 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002308 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00002309
Fariborz Jahanian78652202013-01-25 23:57:05 +00002310 /// hasVolatileMember - returns true if aggregate type has a volatile
2311 /// member.
2312 bool hasVolatileMember(QualType T) {
2313 if (const RecordType *RT = T->getAs<RecordType>()) {
2314 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2315 return RD->hasVolatileMember();
2316 }
2317 return false;
2318 }
Richard Smithe78fac52018-04-05 20:52:58 +00002319
2320 /// Determine whether a return value slot may overlap some other object.
Richard Smith8cca3a52019-06-20 20:56:20 +00002321 AggValueSlot::Overlap_t getOverlapForReturnValue() {
Richard Smithe78fac52018-04-05 20:52:58 +00002322 // FIXME: Assuming no overlap here breaks guaranteed copy elision for base
2323 // class subobjects. These cases may need to be revisited depending on the
2324 // resolution of the relevant core issue.
2325 return AggValueSlot::DoesNotOverlap;
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002326 }
2327
Richard Smithe78fac52018-04-05 20:52:58 +00002328 /// Determine whether a field initialization may overlap some other object.
Richard Smith8cca3a52019-06-20 20:56:20 +00002329 AggValueSlot::Overlap_t getOverlapForFieldInit(const FieldDecl *FD);
Richard Smithe78fac52018-04-05 20:52:58 +00002330
2331 /// Determine whether a base class initialization may overlap some other
2332 /// object.
Richard Smith8cca3a52019-06-20 20:56:20 +00002333 AggValueSlot::Overlap_t getOverlapForBaseInit(const CXXRecordDecl *RD,
2334 const CXXRecordDecl *BaseRD,
2335 bool IsVirtual);
Richard Smithe78fac52018-04-05 20:52:58 +00002336
2337 /// Emit an aggregate assignment.
2338 void EmitAggregateAssign(LValue Dest, LValue Src, QualType EltTy) {
2339 bool IsVolatile = hasVolatileMember(EltTy);
2340 EmitAggregateCopy(Dest, Src, EltTy, AggValueSlot::MayOverlap, IsVolatile);
2341 }
2342
2343 void EmitAggregateCopyCtor(LValue Dest, LValue Src,
2344 AggValueSlot::Overlap_t MayOverlap) {
2345 EmitAggregateCopy(Dest, Src, Src.getType(), MayOverlap);
David Majnemerfd1e7392015-02-03 23:04:06 +00002346 }
2347
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002348 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00002349 ///
Richard Smithe78fac52018-04-05 20:52:58 +00002350 /// \param isVolatile \c true iff either the source or the destination is
2351 /// volatile.
2352 /// \param MayOverlap Whether the tail padding of the destination might be
2353 /// occupied by some other object. More efficient code can often be
2354 /// generated if not.
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00002355 void EmitAggregateCopy(LValue Dest, LValue Src, QualType EltTy,
Richard Smithe78fac52018-04-05 20:52:58 +00002356 AggValueSlot::Overlap_t MayOverlap,
2357 bool isVolatile = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00002358
Anders Carlsson9396a892008-09-11 09:15:33 +00002359 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00002360 Address GetAddrOfLocalVar(const VarDecl *VD) {
2361 auto it = LocalDeclMap.find(VD);
2362 assert(it != LocalDeclMap.end() &&
2363 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2364 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00002365 }
Mike Stumpfc496822009-02-08 23:14:22 +00002366
Akira Hatanaka797afe32018-03-20 01:47:58 +00002367 /// Given an opaque value expression, return its LValue mapping if it exists,
2368 /// otherwise create one.
2369 LValue getOrCreateOpaqueLValueMapping(const OpaqueValueExpr *e);
John McCallc07a0c72011-02-17 10:25:35 +00002370
Akira Hatanaka797afe32018-03-20 01:47:58 +00002371 /// Given an opaque value expression, return its RValue mapping if it exists,
2372 /// otherwise create one.
2373 RValue getOrCreateOpaqueRValueMapping(const OpaqueValueExpr *e);
John McCall1bf58462011-02-16 08:02:54 +00002374
Richard Smith410306b2016-12-12 02:53:20 +00002375 /// Get the index of the current ArrayInitLoopExpr, if any.
2376 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2377
Dan Gohman75d69da2008-05-22 00:50:06 +00002378 /// getAccessedFieldNo - Given an encoded value and a result number, return
2379 /// the input field number being accessed.
2380 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2381
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002382 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002383 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002384
Vedant Kumarffd7c882017-04-14 22:03:34 +00002385 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2386 static bool IsWrappedCXXThis(const Expr *E);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00002387
Anders Carlssonc0964b62010-05-22 17:35:42 +00002388 /// EmitNullInitialization - Generate code to set a value of the given type to
2389 /// null, If the type contains data member pointers, they will be initialized
2390 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002391 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002392
Charles Davisc7d5c942015-09-17 20:55:33 +00002393 /// Emits a call to an LLVM variable-argument intrinsic, either
2394 /// \c llvm.va_start or \c llvm.va_end.
2395 /// \param ArgValue A reference to the \c va_list as emitted by either
2396 /// \c EmitVAListRef or \c EmitMSVAListRef.
2397 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2398 /// calls \c llvm.va_end.
2399 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2400
2401 /// Generate code to get an argument from the passed in pointer
2402 /// and update it accordingly.
2403 /// \param VE The \c VAArgExpr for which to generate code.
2404 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2405 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2406 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002407 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002408 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002409 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002410
John McCall82fe67b2011-07-09 01:37:26 +00002411 /// emitArrayLength - Compute the length of an array, even if it's a
2412 /// VLA, and drill down to the base element type.
2413 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2414 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002415 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002416
John McCall23c29fe2011-06-24 21:55:10 +00002417 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2418 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002419 ///
2420 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002421 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002422
Sander de Smalen891af03a2018-02-03 13:55:59 +00002423 struct VlaSizePair {
2424 llvm::Value *NumElts;
2425 QualType Type;
2426
2427 VlaSizePair(llvm::Value *NE, QualType T) : NumElts(NE), Type(T) {}
2428 };
2429
2430 /// Return the number of elements for a single dimension
2431 /// for the given array type.
2432 VlaSizePair getVLAElements1D(const VariableArrayType *vla);
2433 VlaSizePair getVLAElements1D(QualType vla);
2434
2435 /// Returns an LLVM value that corresponds to the size,
John McCall23c29fe2011-06-24 21:55:10 +00002436 /// in non-variably-sized elements, of a variable length array type,
2437 /// plus that largest non-variably-sized element type. Assumes that
2438 /// the type has already been emitted with EmitVariablyModifiedType.
Sander de Smalen891af03a2018-02-03 13:55:59 +00002439 VlaSizePair getVLASize(const VariableArrayType *vla);
2440 VlaSizePair getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002441
Anders Carlssona5d077d2009-04-14 16:58:56 +00002442 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2443 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002444 llvm::Value *LoadCXXThis() {
2445 assert(CXXThisValue && "no 'this' value for this function");
2446 return CXXThisValue;
2447 }
John McCall7f416cc2015-09-08 08:05:57 +00002448 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002449
Anders Carlssone36a6b32010-01-02 01:01:18 +00002450 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2451 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002452 // FIXME: Every place that calls LoadCXXVTT is something
2453 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002454 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002455 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2456 return CXXStructorImplicitParamValue;
2457 }
2458
John McCall6ce74722010-02-16 04:15:37 +00002459 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002460 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002461 Address
2462 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002463 const CXXRecordDecl *Derived,
2464 const CXXRecordDecl *Base,
2465 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002466
John McCall7f416cc2015-09-08 08:05:57 +00002467 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2468
Mike Stumpe5311b02009-11-30 20:08:49 +00002469 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2470 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002471 Address GetAddressOfBaseClass(Address Value,
2472 const CXXRecordDecl *Derived,
2473 CastExpr::path_const_iterator PathBegin,
2474 CastExpr::path_const_iterator PathEnd,
2475 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002476
John McCall7f416cc2015-09-08 08:05:57 +00002477 Address GetAddressOfDerivedClass(Address Value,
2478 const CXXRecordDecl *Derived,
2479 CastExpr::path_const_iterator PathBegin,
2480 CastExpr::path_const_iterator PathEnd,
2481 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002482
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002483 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2484 /// base constructor/destructor with virtual bases.
2485 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2486 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2487 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2488 bool Delegating);
2489
John McCallf8ff7b92010-02-23 00:48:20 +00002490 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2491 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002492 const FunctionArgList &Args,
2493 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002494 // It's important not to confuse this and the previous function. Delegating
2495 // constructors are the C++0x feature. The constructor delegate optimization
2496 // is used to reduce duplication in the base and complete consturctors where
2497 // they are substantially the same.
2498 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2499 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002500
Richard Smith5179eb72016-06-28 19:03:57 +00002501 /// Emit a call to an inheriting constructor (that is, one that invokes a
2502 /// constructor inherited from a base class) by inlining its definition. This
2503 /// is necessary if the ABI does not support forwarding the arguments to the
2504 /// base class constructor (because they're variadic or similar).
2505 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2506 CXXCtorType CtorType,
2507 bool ForVirtualBase,
2508 bool Delegating,
2509 CallArgList &Args);
2510
2511 /// Emit a call to a constructor inherited from a base class, passing the
2512 /// current constructor's arguments along unmodified (without even making
2513 /// a copy).
2514 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2515 bool ForVirtualBase, Address This,
2516 bool InheritedFromVBase,
2517 const CXXInheritedCtorInitExpr *E);
2518
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002519 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002520 bool ForVirtualBase, bool Delegating,
Anastasia Stulova094c7262019-04-04 10:48:36 +00002521 AggValueSlot ThisAVS, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002522
Richard Smith5179eb72016-06-28 19:03:57 +00002523 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2524 bool ForVirtualBase, bool Delegating,
Richard Smithe78fac52018-04-05 20:52:58 +00002525 Address This, CallArgList &Args,
Igor Kudrineff8f9d2018-06-25 05:48:04 +00002526 AggValueSlot::Overlap_t Overlap,
Anastasia Stulova094c7262019-04-04 10:48:36 +00002527 SourceLocation Loc, bool NewPointerIsChecked);
Richard Smith5179eb72016-06-28 19:03:57 +00002528
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002529 /// Emit assumption load for all bases. Requires to be be called only on
2530 /// most-derived class and not under construction of the object.
2531 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2532
2533 /// Emit assumption that vptr load == global vtable.
2534 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2535
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002536 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002537 Address This, Address Src,
2538 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002539
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002540 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002541 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002542 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002543 const CXXConstructExpr *E,
Serge Pavlov37605182018-07-28 15:33:03 +00002544 bool NewPointerIsChecked,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002545 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002546
Anders Carlssond49844b2009-09-23 02:45:36 +00002547 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2548 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002549 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002550 const CXXConstructExpr *E,
Serge Pavlov37605182018-07-28 15:33:03 +00002551 bool NewPointerIsChecked,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002552 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002553
John McCall82fe67b2011-07-09 01:37:26 +00002554 static Destroyer destroyCXXObject;
2555
Anders Carlsson0a637412009-05-29 21:03:38 +00002556 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002557 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002558 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002559
John McCall99210dc2011-09-15 06:49:18 +00002560 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002561 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002562 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002563 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002564
Peter Collingbourne702b2842011-11-27 22:09:22 +00002565 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002566 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002567
David Majnemerdc012fa2015-04-22 21:38:15 +00002568 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2569 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2570
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002571 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002572 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002573
Eli Friedman24f55432009-11-18 00:57:03 +00002574 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002575 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2576 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002577
Richard Smith760520b2014-06-03 23:27:44 +00002578 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
Eric Fiselierfa752f22018-03-21 19:19:48 +00002579 const CallExpr *TheCallExpr, bool IsDelete);
Richard Smith760520b2014-06-03 23:27:44 +00002580
John McCall7f416cc2015-09-08 08:05:57 +00002581 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2582 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2583 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002584
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002585 /// Situations in which we might emit a check for the suitability of a
Richard Smith69d0d262012-08-24 00:54:33 +00002586 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002587 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002588 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002589 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002590 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002591 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002592 /// Checking the bound value in a reference binding. Must be suitably sized
2593 /// and aligned, but is not required to refer to an object (until the
2594 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002595 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002596 /// Checking the object expression in a non-static data member access. Must
2597 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002598 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002599 /// Checking the 'this' pointer for a call to a non-static member function.
2600 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002601 TCK_MemberCall,
2602 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002603 TCK_ConstructorCall,
2604 /// Checking the operand of a static_cast to a derived pointer type. Must be
2605 /// null or an object within its lifetime.
2606 TCK_DowncastPointer,
2607 /// Checking the operand of a static_cast to a derived reference type. Must
2608 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002609 TCK_DowncastReference,
2610 /// Checking the operand of a cast to a base object. Must be suitably sized
2611 /// and aligned.
2612 TCK_Upcast,
2613 /// Checking the operand of a cast to a virtual base object. Must be an
2614 /// object within its lifetime.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002615 TCK_UpcastToVirtualBase,
2616 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002617 TCK_NonnullAssign,
2618 /// Checking the operand of a dynamic_cast or a typeid expression. Must be
2619 /// null or an object within its lifetime.
2620 TCK_DynamicOperation
Richard Smith69d0d262012-08-24 00:54:33 +00002621 };
2622
Vedant Kumar24792e32017-10-03 01:27:25 +00002623 /// Determine whether the pointer type check \p TCK permits null pointers.
2624 static bool isNullPointerAllowed(TypeCheckKind TCK);
2625
2626 /// Determine whether the pointer type check \p TCK requires a vptr check.
2627 static bool isVptrCheckRequired(TypeCheckKind TCK, QualType Ty);
2628
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002629 /// Whether any type-checking sanitizers are enabled. If \c false,
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002630 /// calls to EmitTypeCheck can be skipped.
2631 bool sanitizePerformTypeCheck() const;
2632
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002633 /// Emit a check that \p V is the address of storage of the
Richard Smithcfa79b22019-01-23 03:37:29 +00002634 /// appropriate size and alignment for an object of type \p Type
2635 /// (or if ArraySize is provided, for an array of that bound).
Richard Smithe30752c2012-10-09 19:52:38 +00002636 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002637 QualType Type, CharUnits Alignment = CharUnits::Zero(),
Richard Smithcfa79b22019-01-23 03:37:29 +00002638 SanitizerSet SkippedChecks = SanitizerSet(),
2639 llvm::Value *ArraySize = nullptr);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002640
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002641 /// Emit a check that \p Base points into an array object, which
Richard Smith539e4a72013-02-23 02:53:19 +00002642 /// we can access at index \p Index. \p Accessed should be \c false if we
2643 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2644 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2645 QualType IndexType, bool Accessed);
2646
Chris Lattner116ce8f2010-01-09 21:40:03 +00002647 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2648 bool isInc, bool isPre);
2649 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2650 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002651
Amara Emerson652795d2016-11-10 14:44:30 +00002652 /// Converts Location to a DebugLoc, if debug information is enabled.
2653 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2654
2655
Chris Lattner8394d792007-06-05 20:53:16 +00002656 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002657 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002658 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002659
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002660 /// EmitDecl - Emit a declaration.
2661 ///
2662 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002663 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002664
John McCall1c9c3fd2010-10-15 04:57:14 +00002665 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002666 ///
2667 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002668 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002669
David Blaikie73ca5692014-12-09 00:32:22 +00002670 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002671 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002672
John McCallbd309292010-07-06 01:34:17 +00002673 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2674 llvm::Value *Address);
2675
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002676 /// Determine whether the given initializer is trivial in the sense
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002677 /// that it requires no code to be generated.
2678 bool isTrivialInitializer(const Expr *Init);
2679
John McCall1c9c3fd2010-10-15 04:57:14 +00002680 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002681 ///
2682 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002683 void EmitAutoVarDecl(const VarDecl &D);
2684
2685 class AutoVarEmission {
2686 friend class CodeGenFunction;
2687
John McCall9e2e22f2011-02-22 07:16:58 +00002688 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002689
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002690 /// The address of the alloca for languages with explicit address space
2691 /// (e.g. OpenCL) or alloca casted to generic pointer for address space
2692 /// agnostic languages (e.g. C++). Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002693 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002694 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002695
2696 llvm::Value *NRVOFlag;
2697
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002698 /// True if the variable is a __block variable that is captured by an
2699 /// escaping block.
2700 bool IsEscapingByRef;
John McCallc533cb72011-02-22 06:44:22 +00002701
2702 /// True if the variable is of aggregate type and has a constant
2703 /// initializer.
2704 bool IsConstantAggregate;
2705
Nadav Rotem1da30942013-03-23 06:43:35 +00002706 /// Non-null if we should use lifetime annotations.
2707 llvm::Value *SizeForLifetimeMarkers;
2708
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002709 /// Address with original alloca instruction. Invalid if the variable was
2710 /// emitted as a global constant.
2711 Address AllocaAddr;
2712
John McCall9e2e22f2011-02-22 07:16:58 +00002713 struct Invalid {};
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002714 AutoVarEmission(Invalid)
2715 : Variable(nullptr), Addr(Address::invalid()),
2716 AllocaAddr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002717
John McCallc533cb72011-02-22 06:44:22 +00002718 AutoVarEmission(const VarDecl &variable)
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002719 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002720 IsEscapingByRef(false), IsConstantAggregate(false),
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002721 SizeForLifetimeMarkers(nullptr), AllocaAddr(Address::invalid()) {}
John McCallc533cb72011-02-22 06:44:22 +00002722
John McCall7f416cc2015-09-08 08:05:57 +00002723 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002724
2725 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002726 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2727
Craig Topper8a13c412014-05-21 05:09:00 +00002728 bool useLifetimeMarkers() const {
2729 return SizeForLifetimeMarkers != nullptr;
2730 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002731 llvm::Value *getSizeForLifetimeMarkers() const {
2732 assert(useLifetimeMarkers());
2733 return SizeForLifetimeMarkers;
2734 }
2735
2736 /// Returns the raw, allocated address, which is not necessarily
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002737 /// the address of the object itself. It is casted to default
2738 /// address space for address space agnostic languages.
John McCall7f416cc2015-09-08 08:05:57 +00002739 Address getAllocatedAddress() const {
2740 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002741 }
2742
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002743 /// Returns the address for the original alloca instruction.
2744 Address getOriginalAllocatedAddress() const { return AllocaAddr; }
2745
John McCallc533cb72011-02-22 06:44:22 +00002746 /// Returns the address of the object within this declaration.
2747 /// Note that this does not chase the forwarding pointer for
2748 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002749 Address getObjectAddress(CodeGenFunction &CGF) const {
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002750 if (!IsEscapingByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002751
John McCall7f416cc2015-09-08 08:05:57 +00002752 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002753 }
2754 };
2755 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2756 void EmitAutoVarInit(const AutoVarEmission &emission);
Gor Nishanov04491bd2017-11-11 17:00:43 +00002757 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002758 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2759 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002760
Sander de Smalen891af03a2018-02-03 13:55:59 +00002761 /// Emits the alloca and debug information for the size expressions for each
2762 /// dimension of an array. It registers the association of its (1-dimensional)
2763 /// QualTypes and size expression's debug node, so that CGDebugInfo can
2764 /// reference this node when creating the DISubrange object to describe the
2765 /// array types.
2766 void EmitAndRegisterVariableArrayDimensions(CGDebugInfo *DI,
2767 const VarDecl &D,
2768 bool EmitDebugInfo);
2769
John McCall1c9c3fd2010-10-15 04:57:14 +00002770 void EmitStaticVarDecl(const VarDecl &D,
2771 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002772
John McCall7f416cc2015-09-08 08:05:57 +00002773 class ParamValue {
2774 llvm::Value *Value;
2775 unsigned Alignment;
2776 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2777 public:
2778 static ParamValue forDirect(llvm::Value *value) {
2779 return ParamValue(value, 0);
2780 }
2781 static ParamValue forIndirect(Address addr) {
2782 assert(!addr.getAlignment().isZero());
2783 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2784 }
2785
2786 bool isIndirect() const { return Alignment != 0; }
2787 llvm::Value *getAnyValue() const { return Value; }
Gor Nishanov04491bd2017-11-11 17:00:43 +00002788
John McCall7f416cc2015-09-08 08:05:57 +00002789 llvm::Value *getDirectValue() const {
2790 assert(!isIndirect());
2791 return Value;
2792 }
2793
2794 Address getIndirectAddress() const {
2795 assert(isIndirect());
2796 return Address(Value, CharUnits::fromQuantity(Alignment));
2797 }
2798 };
2799
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002800 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002801 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002802
John McCallc07a0c72011-02-17 10:25:35 +00002803 /// protectFromPeepholes - Protect a value that we're intending to
2804 /// store to the side, but which will probably be used later, from
2805 /// aggressive peepholing optimizations that might delete it.
2806 ///
2807 /// Pass the result to unprotectFromPeepholes to declare that
2808 /// protection is no longer required.
2809 ///
2810 /// There's no particular reason why this shouldn't apply to
2811 /// l-values, it's just that no existing peepholes work on pointers.
2812 PeepholeProtection protectFromPeepholes(RValue rvalue);
2813 void unprotectFromPeepholes(PeepholeProtection protection);
2814
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002815 void EmitAlignmentAssumptionCheck(llvm::Value *Ptr, QualType Ty,
2816 SourceLocation Loc,
2817 SourceLocation AssumptionLoc,
2818 llvm::Value *Alignment,
2819 llvm::Value *OffsetValue,
2820 llvm::Value *TheCheck,
2821 llvm::Instruction *Assumption);
2822
2823 void EmitAlignmentAssumption(llvm::Value *PtrValue, QualType Ty,
2824 SourceLocation Loc, SourceLocation AssumptionLoc,
2825 llvm::Value *Alignment,
2826 llvm::Value *OffsetValue = nullptr);
2827
2828 void EmitAlignmentAssumption(llvm::Value *PtrValue, QualType Ty,
2829 SourceLocation Loc, SourceLocation AssumptionLoc,
2830 unsigned Alignment,
2831 llvm::Value *OffsetValue = nullptr);
2832
2833 void EmitAlignmentAssumption(llvm::Value *PtrValue, const Expr *E,
2834 SourceLocation AssumptionLoc, unsigned Alignment,
2835 llvm::Value *OffsetValue = nullptr);
Erich Keane623efd82017-03-30 21:48:55 +00002836
Chris Lattner84915fa2007-06-02 04:16:21 +00002837 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002838 // Statement Emission
2839 //===--------------------------------------------------------------------===//
2840
Mike Stumpfc496822009-02-08 23:14:22 +00002841 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002842 void EmitStopPoint(const Stmt *S);
2843
Mike Stumpfc496822009-02-08 23:14:22 +00002844 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2845 /// this function even if there is no current insertion point.
2846 ///
2847 /// This function may clear the current insertion point; callers should use
2848 /// EnsureInsertPoint if they wish to subsequently generate code without first
2849 /// calling EmitBlock, EmitBranch, or EmitStmt.
Karl-Johan Karlsson33e205a2017-09-06 08:47:18 +00002850 void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002851
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002852 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002853 /// necessarily require an insertion point or debug information; typically
2854 /// because the statement amounts to a jump or a container of other
2855 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002856 ///
2857 /// \return True if the statement was handled.
2858 bool EmitSimpleStmt(const Stmt *S);
2859
John McCall7f416cc2015-09-08 08:05:57 +00002860 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2861 AggValueSlot AVS = AggValueSlot::ignored());
2862 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2863 bool GetLast = false,
2864 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002865 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002866
Mike Stumpfc496822009-02-08 23:14:22 +00002867 /// EmitLabel - Emit the block for the given label. It is legal to call this
2868 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002869 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002870
Chris Lattnerac248202007-05-30 00:13:02 +00002871 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002872 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002873 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002874 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002875 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002876
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002877 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002878 ArrayRef<const Attr *> Attrs = None);
2879 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002880 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002881 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002882 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002883 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002884 void EmitBreakStmt(const BreakStmt &S);
2885 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002886 void EmitSwitchStmt(const SwitchStmt &S);
2887 void EmitDefaultStmt(const DefaultStmt &S);
2888 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002889 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002890 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002891
Anders Carlsson2e744e82008-08-30 19:51:14 +00002892 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002893 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2894 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002895 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002896 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002897
Gor Nishanov8df64e92016-10-27 16:28:31 +00002898 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov90be1212017-03-06 21:12:54 +00002899 void EmitCoreturnStmt(const CoreturnStmt &S);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002900 RValue EmitCoawaitExpr(const CoawaitExpr &E,
2901 AggValueSlot aggSlot = AggValueSlot::ignored(),
2902 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002903 LValue EmitCoawaitLValue(const CoawaitExpr *E);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002904 RValue EmitCoyieldExpr(const CoyieldExpr &E,
2905 AggValueSlot aggSlot = AggValueSlot::ignored(),
2906 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002907 LValue EmitCoyieldLValue(const CoyieldExpr *E);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002908 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2909
John McCallb609d3f2010-07-07 06:56:46 +00002910 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2911 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002912
Anders Carlsson52d78a52009-09-27 18:58:34 +00002913 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002914 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002915 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002916 void EnterSEHTryStmt(const SEHTryStmt &S);
2917 void ExitSEHTryStmt(const SEHTryStmt &S);
2918
David Chisnall93ce0182018-08-10 12:53:13 +00002919 void pushSEHCleanup(CleanupKind kind,
2920 llvm::Function *FinallyFunc);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002921 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002922 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002923
2924 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2925 const SEHExceptStmt &Except);
2926
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002927 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2928 const SEHFinallyStmt &Finally);
2929
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002930 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2931 llvm::Value *ParentFP,
2932 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002933 llvm::Value *EmitSEHExceptionCode();
2934 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002935 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002936
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002937 /// Emit simple code for OpenMP directives in Simd-only mode.
2938 void EmitSimpleOMPExecutableDirective(const OMPExecutableDirective &D);
2939
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002940 /// Scan the outlined statement for captures from the parent function. For
2941 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002942 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002943 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002944 bool IsFilter);
2945
2946 /// Recovers the address of a local in a parent function. ParentVar is the
2947 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002948 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002949 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2950 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002951 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2952 Address ParentVar,
2953 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002954
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002955 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002956 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002957
Alexey Bataev2139ed62017-11-16 18:20:21 +00002958 /// Controls insertion of cancellation exit blocks in worksharing constructs.
2959 class OMPCancelStackRAII {
2960 CodeGenFunction &CGF;
2961
2962 public:
2963 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
2964 bool HasCancel)
2965 : CGF(CGF) {
2966 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
2967 }
2968 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
2969 };
2970
Alexey Bataev1189bd02016-01-26 12:20:39 +00002971 /// Returns calculated size of the specified type.
2972 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002973 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002974 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002975 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002976 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002977 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002978 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002979 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002980 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2981 SourceLocation Loc);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002982 /// Perform element by element copying of arrays with type \a
Alexey Bataev420d45b2015-04-14 05:11:24 +00002983 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2984 /// generated by \a CopyGen.
2985 ///
2986 /// \param DestAddr Address of the destination array.
2987 /// \param SrcAddr Address of the source array.
2988 /// \param OriginalType Type of destination and source arrays.
2989 /// \param CopyGen Copying procedure that copies value of single array element
2990 /// to another single array element.
2991 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002992 Address DestAddr, Address SrcAddr, QualType OriginalType,
Alexey Bataevddf3db92018-04-13 17:31:06 +00002993 const llvm::function_ref<void(Address, Address)> CopyGen);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002994 /// Emit proper copying of data from one variable to another.
Alexey Bataev420d45b2015-04-14 05:11:24 +00002995 ///
2996 /// \param OriginalType Original type of the copied variables.
2997 /// \param DestAddr Destination address.
2998 /// \param SrcAddr Source address.
2999 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
3000 /// type of the base array element).
3001 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
3002 /// the base array element).
3003 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
3004 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00003005 void EmitOMPCopy(QualType OriginalType,
3006 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00003007 const VarDecl *DestVD, const VarDecl *SrcVD,
3008 const Expr *Copy);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003009 /// Emit atomic update code for constructs: \a X = \a X \a BO \a E or
Alexey Bataev794ba0d2015-04-10 10:43:45 +00003010 /// \a X = \a E \a BO \a E.
3011 ///
3012 /// \param X Value to be updated.
3013 /// \param E Update value.
3014 /// \param BO Binary operation for update operation.
3015 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
3016 /// expression, false otherwise.
3017 /// \param AO Atomic ordering of the generated atomic instructions.
3018 /// \param CommonGen Code generator for complex expressions that cannot be
3019 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00003020 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
3021 /// generated, <false, RValue::get(nullptr)> otherwise.
3022 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00003023 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
3024 llvm::AtomicOrdering AO, SourceLocation Loc,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003025 const llvm::function_ref<RValue(RValue)> CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00003026 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00003027 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00003028 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
3029 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00003030 void EmitOMPUseDevicePtrClause(
3031 const OMPClause &C, OMPPrivateScope &PrivateScope,
3032 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003033 /// Emit code for copyin clause in \a D directive. The next code is
Alexey Bataevf56f98c2015-04-16 05:39:01 +00003034 /// generated at the start of outlined functions for directives:
3035 /// \code
3036 /// threadprivate_var1 = master_threadprivate_var1;
3037 /// operator=(threadprivate_var2, master_threadprivate_var2);
3038 /// ...
3039 /// __kmpc_barrier(&loc, global_tid);
3040 /// \endcode
3041 ///
3042 /// \param D OpenMP directive possibly with 'copyin' clause(s).
3043 /// \returns true if at least one copyin variable is found, false otherwise.
3044 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003045 /// Emit initial code for lastprivate variables. If some variable is
Alexey Bataev38e89532015-04-16 04:54:05 +00003046 /// not also firstprivate, then the default initialization is used. Otherwise
3047 /// initialization of this variable is performed by EmitOMPFirstprivateClause
3048 /// method.
3049 ///
3050 /// \param D Directive that may have 'lastprivate' directives.
3051 /// \param PrivateScope Private scope for capturing lastprivate variables for
3052 /// proper codegen in internal captured statement.
3053 ///
3054 /// \returns true if there is at least one lastprivate variable, false
3055 /// otherwise.
3056 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
3057 OMPPrivateScope &PrivateScope);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003058 /// Emit final copying of lastprivate values to original variables at
Alexey Bataev38e89532015-04-16 04:54:05 +00003059 /// the end of the worksharing or simd directive.
3060 ///
3061 /// \param D Directive that has at least one 'lastprivate' directives.
3062 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
3063 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00003064 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00003065 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00003066 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00003067 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00003068 /// Emit initial code for linear clauses.
3069 void EmitOMPLinearClause(const OMPLoopDirective &D,
3070 CodeGenFunction::OMPPrivateScope &PrivateScope);
3071 /// Emit final code for linear clauses.
3072 /// \param CondGen Optional conditional code for final part of codegen for
3073 /// linear clause.
3074 void EmitOMPLinearClauseFinal(
3075 const OMPLoopDirective &D,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003076 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003077 /// Emit initial code for reduction variables. Creates reduction copies
Alexey Bataev794ba0d2015-04-10 10:43:45 +00003078 /// and initializes them with the values according to OpenMP standard.
3079 ///
3080 /// \param D Directive (possibly) with the 'reduction' clause.
3081 /// \param PrivateScope Private scope for capturing reduction variables for
3082 /// proper codegen in internal captured statement.
3083 ///
3084 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
3085 OMPPrivateScope &PrivateScope);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003086 /// Emit final update of reduction values to original variables at
Alexey Bataev794ba0d2015-04-10 10:43:45 +00003087 /// the end of the directive.
3088 ///
3089 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00003090 /// \param ReductionKind The kind of reduction to perform.
3091 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
3092 const OpenMPDirectiveKind ReductionKind);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003093 /// Emit initial code for linear variables. Creates private copies
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00003094 /// and initializes them with the values according to OpenMP standard.
3095 ///
3096 /// \param D Directive (possibly) with the 'linear' clause.
Alexey Bataev8c3edfe2017-08-16 15:58:46 +00003097 /// \return true if at least one linear variable is found that should be
3098 /// initialized with the value of the original variable, false otherwise.
3099 bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00003100
Alexey Bataev7292c292016-04-25 12:22:29 +00003101 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
James Y Knight9871db02019-02-05 16:42:33 +00003102 llvm::Function * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00003103 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00003104 TaskGenTy;
3105 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
Alexey Bataev475a7442018-01-12 19:39:11 +00003106 const OpenMPDirectiveKind CapturedRegion,
Alexey Bataev7292c292016-04-25 12:22:29 +00003107 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00003108 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataevd2202ca2017-12-27 17:58:32 +00003109 struct OMPTargetDataInfo {
3110 Address BasePointersArray = Address::invalid();
3111 Address PointersArray = Address::invalid();
3112 Address SizesArray = Address::invalid();
3113 unsigned NumberOfTargetItems = 0;
3114 explicit OMPTargetDataInfo() = default;
3115 OMPTargetDataInfo(Address BasePointersArray, Address PointersArray,
3116 Address SizesArray, unsigned NumberOfTargetItems)
3117 : BasePointersArray(BasePointersArray), PointersArray(PointersArray),
3118 SizesArray(SizesArray), NumberOfTargetItems(NumberOfTargetItems) {}
3119 };
3120 void EmitOMPTargetTaskBasedDirective(const OMPExecutableDirective &S,
3121 const RegionCodeGenTy &BodyGen,
3122 OMPTargetDataInfo &InputInfo);
Alexey Bataev7292c292016-04-25 12:22:29 +00003123
Alexey Bataev9959db52014-05-06 10:08:46 +00003124 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00003125 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00003126 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00003127 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00003128 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00003129 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00003130 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00003131 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00003132 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00003133 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00003134 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00003135 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00003136 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00003137 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00003138 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00003139 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00003140 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00003141 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00003142 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00003143 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00003144 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00003145 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00003146 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00003147 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00003148 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00003149 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00003150 void
3151 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00003152 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00003153 void
3154 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00003155 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00003156 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00003157 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00003158 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00003159 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00003160 void EmitOMPDistributeParallelForDirective(
3161 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00003162 void EmitOMPDistributeParallelForSimdDirective(
3163 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00003164 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00003165 void EmitOMPTargetParallelForSimdDirective(
3166 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00003167 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00003168 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00003169 void
3170 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00003171 void EmitOMPTeamsDistributeParallelForSimdDirective(
3172 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00003173 void EmitOMPTeamsDistributeParallelForDirective(
3174 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00003175 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00003176 void EmitOMPTargetTeamsDistributeDirective(
3177 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00003178 void EmitOMPTargetTeamsDistributeParallelForDirective(
3179 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00003180 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
3181 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00003182 void EmitOMPTargetTeamsDistributeSimdDirective(
3183 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00003184
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00003185 /// Emit device code for the target directive.
3186 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
3187 StringRef ParentName,
3188 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00003189 static void
3190 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3191 const OMPTargetParallelDirective &S);
Alexey Bataevfb0ebec2017-11-08 20:16:14 +00003192 /// Emit device code for the target parallel for directive.
3193 static void EmitOMPTargetParallelForDeviceFunction(
3194 CodeGenModule &CGM, StringRef ParentName,
3195 const OMPTargetParallelForDirective &S);
Alexey Bataev5d7edca2017-11-09 17:32:15 +00003196 /// Emit device code for the target parallel for simd directive.
3197 static void EmitOMPTargetParallelForSimdDeviceFunction(
3198 CodeGenModule &CGM, StringRef ParentName,
3199 const OMPTargetParallelForSimdDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003200 /// Emit device code for the target teams directive.
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00003201 static void
3202 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3203 const OMPTargetTeamsDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003204 /// Emit device code for the target teams distribute directive.
3205 static void EmitOMPTargetTeamsDistributeDeviceFunction(
3206 CodeGenModule &CGM, StringRef ParentName,
3207 const OMPTargetTeamsDistributeDirective &S);
Alexey Bataevfbe17fb2017-12-13 19:45:06 +00003208 /// Emit device code for the target teams distribute simd directive.
3209 static void EmitOMPTargetTeamsDistributeSimdDeviceFunction(
3210 CodeGenModule &CGM, StringRef ParentName,
3211 const OMPTargetTeamsDistributeSimdDirective &S);
Alexey Bataevf8365372017-11-17 17:57:25 +00003212 /// Emit device code for the target simd directive.
3213 static void EmitOMPTargetSimdDeviceFunction(CodeGenModule &CGM,
3214 StringRef ParentName,
3215 const OMPTargetSimdDirective &S);
Alexey Bataev647dd842018-01-15 20:59:40 +00003216 /// Emit device code for the target teams distribute parallel for simd
3217 /// directive.
3218 static void EmitOMPTargetTeamsDistributeParallelForSimdDeviceFunction(
3219 CodeGenModule &CGM, StringRef ParentName,
3220 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Carlo Bertolli52978c32018-01-03 21:12:44 +00003221
3222 static void EmitOMPTargetTeamsDistributeParallelForDeviceFunction(
3223 CodeGenModule &CGM, StringRef ParentName,
3224 const OMPTargetTeamsDistributeParallelForDirective &S);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003225 /// Emit inner loop of the worksharing/simd construct.
Alexey Bataev98eb6e32015-04-22 11:15:40 +00003226 ///
3227 /// \param S Directive, for which the inner loop must be emitted.
3228 /// \param RequiresCleanup true, if directive has some associated private
3229 /// variables.
3230 /// \param LoopCond Bollean condition for loop continuation.
3231 /// \param IncExpr Increment expression for loop control variable.
3232 /// \param BodyGen Generator for the inner body of the inner loop.
3233 /// \param PostIncGen Genrator for post-increment code (required for ordered
3234 /// loop directvies).
3235 void EmitOMPInnerLoop(
3236 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
3237 const Expr *IncExpr,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003238 const llvm::function_ref<void(CodeGenFunction &)> BodyGen,
3239 const llvm::function_ref<void(CodeGenFunction &)> PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00003240
Alexey Bataev81c7ea02015-07-03 09:56:58 +00003241 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00003242 /// Emit initial code for loop counters of loop-based directives.
3243 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
3244 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00003245
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003246 /// Helper for the OpenMP loop directives.
3247 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
3248
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003249 /// Emit code for the worksharing loop-based directive.
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003250 /// \return true, if this construct has any lastprivate clause, false -
3251 /// otherwise.
3252 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
3253 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
3254 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3255
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003256 /// Emit code for the distribute loop-based directive.
3257 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
3258 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
3259
Alexey Bataevf8365372017-11-17 17:57:25 +00003260 /// Helpers for the OpenMP loop directives.
3261 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
3262 void EmitOMPSimdFinal(
3263 const OMPLoopDirective &D,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003264 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
Alexey Bataevf8365372017-11-17 17:57:25 +00003265
Alexey Bataevf47c4b42017-09-26 13:47:31 +00003266 /// Emits the lvalue for the expression with possibly captured variable.
3267 LValue EmitOMPSharedLValue(const Expr *E);
3268
Alexander Musmanc6388682014-12-15 07:07:06 +00003269private:
Yaxun Liufa13d012018-02-15 16:39:19 +00003270 /// Helpers for blocks.
3271 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
George Burgess IVe3763372016-12-22 02:50:20 +00003272
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003273 /// struct with the values to be passed to the OpenMP loop-related functions
3274 struct OMPLoopArguments {
3275 /// loop lower bound
3276 Address LB = Address::invalid();
3277 /// loop upper bound
3278 Address UB = Address::invalid();
3279 /// loop stride
3280 Address ST = Address::invalid();
3281 /// isLastIteration argument for runtime functions
3282 Address IL = Address::invalid();
3283 /// Chunk value generated by sema
3284 llvm::Value *Chunk = nullptr;
3285 /// EnsureUpperBound
3286 Expr *EUB = nullptr;
3287 /// IncrementExpression
3288 Expr *IncExpr = nullptr;
3289 /// Loop initialization
3290 Expr *Init = nullptr;
3291 /// Loop exit condition
3292 Expr *Cond = nullptr;
3293 /// Update of LB after a whole chunk has been executed
3294 Expr *NextLB = nullptr;
3295 /// Update of UB after a whole chunk has been executed
3296 Expr *NextUB = nullptr;
3297 OMPLoopArguments() = default;
3298 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
3299 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
3300 Expr *IncExpr = nullptr, Expr *Init = nullptr,
3301 Expr *Cond = nullptr, Expr *NextLB = nullptr,
3302 Expr *NextUB = nullptr)
3303 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
3304 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
3305 NextUB(NextUB) {}
3306 };
3307 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
3308 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
3309 const OMPLoopArguments &LoopArgs,
3310 const CodeGenLoopTy &CodeGenLoop,
3311 const CodeGenOrderedTy &CodeGenOrdered);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00003312 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00003313 bool IsMonotonic, const OMPLoopDirective &S,
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003314 OMPPrivateScope &LoopScope, bool Ordered,
3315 const OMPLoopArguments &LoopArgs,
3316 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3317 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
3318 const OMPLoopDirective &S,
3319 OMPPrivateScope &LoopScope,
3320 const OMPLoopArguments &LoopArgs,
3321 const CodeGenLoopTy &CodeGenLoopContent);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003322 /// Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00003323 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00003324
3325public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00003326
Chris Lattner208ae962007-05-30 17:57:17 +00003327 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00003328 // LValue Expression Emission
3329 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00003330
Daniel Dunbarc79407f2009-02-05 07:09:07 +00003331 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
3332 RValue GetUndefRValue(QualType Ty);
3333
Daniel Dunbarbb197e42009-01-09 16:50:52 +00003334 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
3335 /// and issue an ErrorUnsupported style diagnostic (using the
3336 /// provided Name).
3337 RValue EmitUnsupportedRValue(const Expr *E,
3338 const char *Name);
3339
Mike Stumpfc496822009-02-08 23:14:22 +00003340 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
3341 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00003342 LValue EmitUnsupportedLValue(const Expr *E,
3343 const char *Name);
3344
Chris Lattner8394d792007-06-05 20:53:16 +00003345 /// EmitLValue - Emit code to compute a designator that specifies the location
3346 /// of the expression.
3347 ///
3348 /// This can return one of two things: a simple address or a bitfield
3349 /// reference. In either case, the LLVM Value* in the LValue structure is
3350 /// guaranteed to be an LLVM pointer type.
3351 ///
3352 /// If this returns a bitfield reference, nothing about the pointee type of
3353 /// the LLVM value is known: For example, it may not be a pointer to an
3354 /// integer.
3355 ///
3356 /// If this returns a normal address, and if the lvalue's C type is fixed
3357 /// size, this method guarantees that the returned pointer type will point to
3358 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
3359 /// variable length type, this is not possible.
3360 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00003361 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003362
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003363 /// Same as EmitLValue but additionally we generate checking code to
Richard Smith4d1458e2012-09-08 02:08:36 +00003364 /// guard against undefined behavior. This is only suitable when we know
3365 /// that the address will be used to access the object.
3366 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00003367
John McCall7f416cc2015-09-08 08:05:57 +00003368 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003369 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00003370
John McCalla8ec7eb2013-03-07 21:37:17 +00003371 void EmitAtomicInit(Expr *E, LValue lvalue);
3372
David Majnemera5b195a2015-02-14 01:35:12 +00003373 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00003374
3375 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
3376 AggValueSlot Slot = AggValueSlot::ignored());
3377
Nick Lewycky2d84e842013-10-02 02:29:49 +00003378 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00003379 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00003380 AggValueSlot slot = AggValueSlot::ignored());
3381
3382 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3383
David Majnemera5b195a2015-02-14 01:35:12 +00003384 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3385 bool IsVolatile, bool isInit);
3386
Alexey Bataevb4505a72015-03-30 05:20:59 +00003387 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00003388 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00003389 llvm::AtomicOrdering Success =
3390 llvm::AtomicOrdering::SequentiallyConsistent,
3391 llvm::AtomicOrdering Failure =
3392 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00003393 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3394
Alexey Bataevb4505a72015-03-30 05:20:59 +00003395 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00003396 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00003397 bool IsVolatile);
3398
John McCall3a7f6922010-10-27 20:58:56 +00003399 /// EmitToMemory - Change a scalar value from its value
3400 /// representation to its in-memory representation.
3401 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3402
3403 /// EmitFromMemory - Change a scalar value from its memory
3404 /// representation to its value representation.
3405 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3406
Vedant Kumar5a972652017-02-27 19:46:19 +00003407 /// Check if the scalar \p Value is within the valid range for the given
3408 /// type \p Ty.
3409 ///
3410 /// Returns true if a check is needed (even if the range is unknown).
3411 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3412 SourceLocation Loc);
3413
Daniel Dunbar1d425462009-02-10 00:57:50 +00003414 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3415 /// care to appropriately convert from the memory representation to
3416 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003417 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003418 SourceLocation Loc,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003419 AlignmentSource Source = AlignmentSource::Type,
3420 bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003421 return EmitLoadOfScalar(Addr, Volatile, Ty, Loc, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003422 CGM.getTBAAAccessInfo(Ty), isNontemporal);
3423 }
3424
3425 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3426 SourceLocation Loc, LValueBaseInfo BaseInfo,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003427 TBAAAccessInfo TBAAInfo,
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003428 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003429
3430 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3431 /// care to appropriately convert from the memory representation to
3432 /// the LLVM value representation. The l-value must be a simple
3433 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003434 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003435
3436 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3437 /// care to appropriately convert from the memory representation to
3438 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003439 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3440 bool Volatile, QualType Ty,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003441 AlignmentSource Source = AlignmentSource::Type,
3442 bool isInit = false, bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003443 EmitStoreOfScalar(Value, Addr, Volatile, Ty, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003444 CGM.getTBAAAccessInfo(Ty), isInit, isNontemporal);
3445 }
3446
3447 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003448 bool Volatile, QualType Ty,
3449 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo,
Ivan A. Kosareva511ed72017-10-03 10:52:39 +00003450 bool isInit = false, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003451
3452 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3453 /// care to appropriately convert from the memory representation to
3454 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00003455 /// l-value. The isInit flag indicates whether this is an initialization.
3456 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3457 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003458
Chris Lattner8394d792007-06-05 20:53:16 +00003459 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3460 /// this method emits the address of the lvalue, then loads the result as an
3461 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003462 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00003463 RValue EmitLoadOfExtVectorElementLValue(LValue V);
Vedant Kumar129edab2017-03-09 16:06:27 +00003464 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
Renato Golin230c5eb2014-05-19 18:15:42 +00003465 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00003466
Chris Lattner8394d792007-06-05 20:53:16 +00003467 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3468 /// lvalue, where both are guaranteed to the have the same type, and that type
3469 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00003470 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003471 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00003472 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003473
Nick Lewycky2d84e842013-10-02 02:29:49 +00003474 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3475 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003476 ///
Mike Stumpfc496822009-02-08 23:14:22 +00003477 /// \param Result [out] - If non-null, this will be set to a Value* for the
3478 /// bit-field contents after the store, appropriate for use as the result of
3479 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00003480 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00003481 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00003482
John McCall4f29b492010-11-16 23:07:28 +00003483 /// Emit an l-value for an assignment (simple or compound) of complex type.
3484 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003485 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00003486 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3487 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00003488
Chris Lattner57540c52011-04-15 05:22:18 +00003489 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00003490 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003491 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003492 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00003493 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003494 // Note: only available for agg return types
3495 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00003496 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00003497 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00003498 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00003499 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00003500 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00003501 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3502 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00003503 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3504 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00003505 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00003506 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00003507 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00003508 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00003509 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00003510 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00003511 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00003512 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00003513 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003514
John McCall7f416cc2015-09-08 08:05:57 +00003515 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003516
Nick Lewycky2d84e842013-10-02 02:29:49 +00003517 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00003518
John McCall7f416cc2015-09-08 08:05:57 +00003519 Address EmitArrayToPointerDecay(const Expr *Array,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00003520 LValueBaseInfo *BaseInfo = nullptr,
3521 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003522
John McCall71335052012-03-10 03:05:10 +00003523 class ConstantEmission {
3524 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3525 ConstantEmission(llvm::Constant *C, bool isReference)
3526 : ValueAndIsReference(C, isReference) {}
3527 public:
3528 ConstantEmission() {}
3529 static ConstantEmission forReference(llvm::Constant *C) {
3530 return ConstantEmission(C, true);
3531 }
3532 static ConstantEmission forValue(llvm::Constant *C) {
3533 return ConstantEmission(C, false);
3534 }
3535
Aaron Ballman67347662015-02-15 22:00:28 +00003536 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00003537 return ValueAndIsReference.getOpaqueValue() != nullptr;
3538 }
John McCall71335052012-03-10 03:05:10 +00003539
3540 bool isReference() const { return ValueAndIsReference.getInt(); }
3541 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3542 assert(isReference());
3543 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3544 refExpr->getType());
3545 }
3546
3547 llvm::Constant *getValue() const {
3548 assert(!isReference());
3549 return ValueAndIsReference.getPointer();
3550 }
3551 };
3552
John McCall113bee02012-03-10 09:33:50 +00003553 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
Alex Lorenz6cc83172017-08-25 10:07:00 +00003554 ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
Volodymyr Sapsaief1899b2018-11-01 21:57:05 +00003555 llvm::Value *emitScalarConstant(const ConstantEmission &Constant, Expr *E);
John McCall71335052012-03-10 03:05:10 +00003556
John McCallfe96e0b2011-11-06 09:01:30 +00003557 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3558 AggValueSlot slot = AggValueSlot::ignored());
3559 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3560
Daniel Dunbar722f4242009-04-22 05:08:15 +00003561 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003562 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00003563 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00003564 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003565
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003566 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3567 /// if the Field is a reference, this will return the address of the reference
3568 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003569 LValue EmitLValueForFieldInitialization(LValue Base,
3570 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003571
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003572 LValue EmitLValueForIvar(QualType ObjectTy,
3573 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003574 unsigned CVRQualifiers);
3575
Anders Carlsson3be22e22009-05-30 23:23:33 +00003576 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003577 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003578 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003579 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003580
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003581 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003582 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003583 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003584 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003585 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003586 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003587
Chris Lattnerd7f58862007-06-02 05:24:33 +00003588 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003589 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003590 //===--------------------------------------------------------------------===//
3591
Mike Stumpfc496822009-02-08 23:14:22 +00003592 /// EmitCall - Generate a call of the given function, expecting the given
3593 /// result type, and using the given argument list which specifies both the
3594 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003595 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003596 ReturnValueSlot ReturnValue, const CallArgList &Args,
James Y Knight3933add2019-01-30 02:54:28 +00003597 llvm::CallBase **callOrInvoke, SourceLocation Loc);
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003598 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
3599 ReturnValueSlot ReturnValue, const CallArgList &Args,
James Y Knight3933add2019-01-30 02:54:28 +00003600 llvm::CallBase **callOrInvoke = nullptr) {
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003601 return EmitCall(CallInfo, Callee, ReturnValue, Args, callOrInvoke,
3602 SourceLocation());
3603 }
John McCallb92ab1a2016-10-26 23:46:34 +00003604 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003605 ReturnValueSlot ReturnValue, llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003606 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003607 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003608 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3609 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003610
Eric Christopherc7e79db2015-11-12 00:44:04 +00003611 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Erich Keane36176242019-06-21 22:29:32 +00003612 void checkTargetFeatures(SourceLocation Loc, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003613
James Y Knight9871db02019-02-05 16:42:33 +00003614 llvm::CallInst *EmitRuntimeCall(llvm::FunctionCallee callee,
John McCall882987f2013-02-28 19:01:20 +00003615 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003616 llvm::CallInst *EmitRuntimeCall(llvm::FunctionCallee callee,
3617 ArrayRef<llvm::Value *> args,
John McCall882987f2013-02-28 19:01:20 +00003618 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003619 llvm::CallInst *EmitNounwindRuntimeCall(llvm::FunctionCallee callee,
John McCall882987f2013-02-28 19:01:20 +00003620 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003621 llvm::CallInst *EmitNounwindRuntimeCall(llvm::FunctionCallee callee,
3622 ArrayRef<llvm::Value *> args,
John McCall882987f2013-02-28 19:01:20 +00003623 const Twine &name = "");
3624
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003625 SmallVector<llvm::OperandBundleDef, 1>
3626 getBundlesForFunclet(llvm::Value *Callee);
3627
James Y Knight9871db02019-02-05 16:42:33 +00003628 llvm::CallBase *EmitCallOrInvoke(llvm::FunctionCallee Callee,
James Y Knight3933add2019-01-30 02:54:28 +00003629 ArrayRef<llvm::Value *> Args,
3630 const Twine &Name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003631 llvm::CallBase *EmitRuntimeCallOrInvoke(llvm::FunctionCallee callee,
James Y Knight3933add2019-01-30 02:54:28 +00003632 ArrayRef<llvm::Value *> args,
3633 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003634 llvm::CallBase *EmitRuntimeCallOrInvoke(llvm::FunctionCallee callee,
James Y Knight3933add2019-01-30 02:54:28 +00003635 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003636 void EmitNoreturnRuntimeCallOrInvoke(llvm::FunctionCallee callee,
3637 ArrayRef<llvm::Value *> args);
John McCallbd309292010-07-06 01:34:17 +00003638
Gor Nishanov04491bd2017-11-11 17:00:43 +00003639 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
John McCallb92ab1a2016-10-26 23:46:34 +00003640 NestedNameSpecifier *Qual,
3641 llvm::Type *Ty);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003642
John McCallb92ab1a2016-10-26 23:46:34 +00003643 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
Gor Nishanov04491bd2017-11-11 17:00:43 +00003644 CXXDtorType Type,
John McCallb92ab1a2016-10-26 23:46:34 +00003645 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003646
Akira Hatanaka9978da32018-08-10 15:09:24 +00003647 // Return the copy constructor name with the prefix "__copy_constructor_"
3648 // removed.
3649 static std::string getNonTrivialCopyConstructorStr(QualType QT,
3650 CharUnits Alignment,
3651 bool IsVolatile,
3652 ASTContext &Ctx);
3653
3654 // Return the destructor name with the prefix "__destructor_" removed.
3655 static std::string getNonTrivialDestructorStr(QualType QT,
3656 CharUnits Alignment,
3657 bool IsVolatile,
3658 ASTContext &Ctx);
3659
Akira Hatanaka7275da02018-02-28 07:15:55 +00003660 // These functions emit calls to the special functions of non-trivial C
3661 // structs.
3662 void defaultInitNonTrivialCStructVar(LValue Dst);
3663 void callCStructDefaultConstructor(LValue Dst);
3664 void callCStructDestructor(LValue Dst);
3665 void callCStructCopyConstructor(LValue Dst, LValue Src);
3666 void callCStructMoveConstructor(LValue Dst, LValue Src);
3667 void callCStructCopyAssignmentOperator(LValue Dst, LValue Src);
3668 void callCStructMoveAssignmentOperator(LValue Dst, LValue Src);
3669
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003670 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003671 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3672 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003673 ReturnValueSlot ReturnValue, llvm::Value *This,
3674 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003675 QualType ImplicitParamTy, const CallExpr *E,
3676 CallArgList *RtlArgs);
Peter Collingbourned1c5b282019-03-22 23:05:10 +00003677 RValue EmitCXXDestructorCall(GlobalDecl Dtor,
John McCallb92ab1a2016-10-26 23:46:34 +00003678 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003679 llvm::Value *This, llvm::Value *ImplicitParam,
Peter Collingbourned1c5b282019-03-22 23:05:10 +00003680 QualType ImplicitParamTy, const CallExpr *E);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003681 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3682 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003683 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3684 const CXXMethodDecl *MD,
3685 ReturnValueSlot ReturnValue,
3686 bool HasQualifier,
3687 NestedNameSpecifier *Qualifier,
3688 bool IsArrow, const Expr *Base);
3689 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003690 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3691 llvm::Value *memberPtr,
3692 const MemberPointerType *memberPtrType,
Ivan A. Kosarev229a6d82017-10-13 16:38:32 +00003693 LValueBaseInfo *BaseInfo = nullptr,
3694 TBAAAccessInfo *TBAAInfo = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003695 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3696 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003697
Anders Carlsson4034a952009-05-27 04:18:27 +00003698 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003699 const CXXMethodDecl *MD,
3700 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003701 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003702
Peter Collingbournefe883422011-10-06 18:29:37 +00003703 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3704 ReturnValueSlot ReturnValue);
3705
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003706 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3707 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003708
Erich Keanede6480a32018-11-13 15:48:08 +00003709 RValue EmitBuiltinExpr(const GlobalDecl GD, unsigned BuiltinID,
3710 const CallExpr *E, ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003711
Sanjay Patelad823902018-08-19 16:50:30 +00003712 RValue emitRotate(const CallExpr *E, bool IsRotateRight);
3713
Akira Hatanaka6b103bc2017-10-06 07:12:46 +00003714 /// Emit IR for __builtin_os_log_format.
3715 RValue emitBuiltinOSLogFormat(const CallExpr &E);
3716
3717 llvm::Function *generateBuiltinOSLogHelperFunction(
3718 const analyze_os_log::OSLogBufferLayout &Layout,
3719 CharUnits BufferAlignment);
3720
Anders Carlssonbfb36712009-12-24 21:13:40 +00003721 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003722
Mike Stumpfc496822009-02-08 23:14:22 +00003723 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3724 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003725 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3726
Kevin Qin1718af62013-11-14 02:45:18 +00003727 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3728 const llvm::CmpInst::Predicate Fp,
3729 const llvm::CmpInst::Predicate Ip,
3730 const llvm::Twine &Name = "");
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003731 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3732 llvm::Triple::ArchType Arch);
Tim Northover8fe03d62014-02-21 11:57:24 +00003733
3734 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3735 unsigned LLVMIntrinsic,
3736 unsigned AltLLVMIntrinsic,
3737 const char *NameHint,
3738 unsigned Modifier,
3739 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003740 SmallVectorImpl<llvm::Value *> &Ops,
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003741 Address PtrOp0, Address PtrOp1,
3742 llvm::Triple::ArchType Arch);
Simon Tatham89e31fa2018-05-30 07:54:05 +00003743
Tim Northover8fe03d62014-02-21 11:57:24 +00003744 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3745 unsigned Modifier, llvm::Type *ArgTy,
3746 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003747 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003748 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003749 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003750 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003751 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003752 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003753 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003754 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3755 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003756 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003757 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3758 llvm::Triple::ArchType Arch);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003759
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003760 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003761 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3762 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003763 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003764 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003765 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003766 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3767 const CallExpr *E);
Krzysztof Parzyszek5a655832017-12-13 19:56:03 +00003768 llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003769
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003770private:
3771 enum class MSVCIntrin;
3772
3773public:
3774 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3775
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003776 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3777
Daniel Dunbar66912a12008-08-20 00:28:19 +00003778 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003779 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003780 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003781 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3782 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3783 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003784 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003785 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003786 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3787 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003788
John McCall31168b02011-06-15 23:02:42 +00003789 /// Retrieves the default cleanup kind for an ARC cleanup.
3790 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3791 CleanupKind getARCCleanupKind() {
3792 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3793 ? NormalAndEHCleanup : NormalCleanup;
3794 }
3795
3796 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003797 void EmitARCInitWeak(Address addr, llvm::Value *value);
3798 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003799 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003800 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3801 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
Akira Hatanakad791e922018-03-19 17:38:40 +00003802 void emitARCCopyAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
3803 void emitARCMoveAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
John McCall7f416cc2015-09-08 08:05:57 +00003804 void EmitARCCopyWeak(Address dst, Address src);
3805 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003806 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3807 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003808 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003809 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003810 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003811 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003812 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003813 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003814 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003815 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003816 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003817 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003818 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3819 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3820 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003821 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003822
Pete Coopere5b64ea2018-12-21 21:00:32 +00003823 llvm::Value *EmitObjCAutorelease(llvm::Value *value, llvm::Type *returnType);
3824 llvm::Value *EmitObjCRetainNonBlock(llvm::Value *value,
3825 llvm::Type *returnType);
3826 void EmitObjCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
3827
John McCall31168b02011-06-15 23:02:42 +00003828 std::pair<LValue,llvm::Value*>
3829 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3830 std::pair<LValue,llvm::Value*>
3831 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003832 std::pair<LValue,llvm::Value*>
3833 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003834
Pete Coopere3886802018-12-08 05:13:50 +00003835 llvm::Value *EmitObjCAlloc(llvm::Value *value,
3836 llvm::Type *returnType);
3837 llvm::Value *EmitObjCAllocWithZone(llvm::Value *value,
3838 llvm::Type *returnType);
Erik Pilkingtonec389b02019-02-14 19:58:37 +00003839 llvm::Value *EmitObjCAllocInit(llvm::Value *value, llvm::Type *resultType);
3840
John McCall248512a2011-10-01 10:32:24 +00003841 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003842 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3843 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3844
John McCallff613032011-10-04 06:23:45 +00003845 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003846 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3847 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003848 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3849 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003850 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003851
Craig Topper00bbdcf2014-06-28 23:22:23 +00003852 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003853
John McCall82fe67b2011-07-09 01:37:26 +00003854 static Destroyer destroyARCStrongImprecise;
3855 static Destroyer destroyARCStrongPrecise;
3856 static Destroyer destroyARCWeak;
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00003857 static Destroyer emitARCIntrinsicUse;
Akira Hatanaka7275da02018-02-28 07:15:55 +00003858 static Destroyer destroyNonTrivialCStruct;
John McCall82fe67b2011-07-09 01:37:26 +00003859
Gor Nishanov04491bd2017-11-11 17:00:43 +00003860 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003861 llvm::Value *EmitObjCAutoreleasePoolPush();
3862 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3863 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003864 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003865
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003866 /// Emits a reference binding to the passed in expression.
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003867 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003868
Chris Lattner6278e6a2007-08-11 00:04:45 +00003869 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003870 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003871 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003872
3873 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003874
3875 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3876 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003877 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003878
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003879 /// Emit a conversion from the specified type to the specified destination
3880 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003881 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003882 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003883
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003884 /// Emit a conversion from the specified complex type to the specified
3885 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003886 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003887 QualType DstTy,
3888 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003889
John McCall7a626f62010-09-15 10:14:12 +00003890 /// EmitAggExpr - Emit the computation of the specified expression
3891 /// of aggregate type. The result is computed into the given slot,
3892 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003893 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003894
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003895 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3896 /// aggregate type into a temporary LValue.
3897 LValue EmitAggExprToLValue(const Expr *E);
3898
John McCall1bd25562011-06-24 23:21:27 +00003899 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3900 /// make sure it survives garbage collection until this point.
3901 void EmitExtendGCLifetime(llvm::Value *object);
3902
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003903 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003904 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003905 ComplexPairTy EmitComplexExpr(const Expr *E,
3906 bool IgnoreReal = false,
3907 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003908
John McCall47fb9502013-03-07 21:37:08 +00003909 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3910 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003911 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003912
John McCall47fb9502013-03-07 21:37:08 +00003913 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003914 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003915
3916 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003917 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003918
John McCall7f416cc2015-09-08 08:05:57 +00003919 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3920 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3921
Chandler Carruth84537952012-03-30 19:44:53 +00003922 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3923 /// global variable that has already been created for it. If the initializer
3924 /// has a different type than GV does, this may free GV and return a different
3925 /// one. Otherwise it just returns GV.
3926 llvm::GlobalVariable *
3927 AddInitializerToStaticVarDecl(const VarDecl &D,
3928 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003929
Richard Smith3ad06362018-10-31 20:39:26 +00003930 // Emit an @llvm.invariant.start call for the given memory region.
3931 void EmitInvariantStart(llvm::Constant *Addr, CharUnits Size);
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003932
Anders Carlssonf40886a2009-08-08 21:45:14 +00003933 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3934 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003935 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3936 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003937
James Y Knightf7321542019-02-07 01:14:17 +00003938 llvm::Function *createAtExitStub(const VarDecl &VD, llvm::FunctionCallee Dtor,
David Majnemerb3341ea2014-10-05 05:05:40 +00003939 llvm::Constant *Addr);
3940
John McCallc84ed6a2012-05-01 06:13:13 +00003941 /// Call atexit() with a function that passes the given argument to
3942 /// the given function.
James Y Knightf7321542019-02-07 01:14:17 +00003943 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::FunctionCallee fn,
David Blaikieebe87e12013-08-27 23:57:18 +00003944 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003945
Akira Hatanaka617e2612018-04-17 18:41:52 +00003946 /// Call atexit() with function dtorStub.
3947 void registerGlobalDtorWithAtExit(llvm::Constant *dtorStub);
3948
John McCallcdf7ef52010-11-06 09:44:32 +00003949 /// Emit code in this function to perform a guarded variable
3950 /// initialization. Guarded initializations are used when it's not
3951 /// possible to prove that an initialization will be done exactly
3952 /// once, e.g. with a static local variable or a static data member
3953 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003954 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003955 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003956
Richard Smithae8d62c2017-07-26 22:01:09 +00003957 enum class GuardKind { VariableGuard, TlsGuard };
3958
3959 /// Emit a branch to select whether or not to perform guarded initialization.
3960 void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
3961 llvm::BasicBlock *InitBlock,
3962 llvm::BasicBlock *NoInitBlock,
3963 GuardKind Kind, const VarDecl *D);
3964
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003965 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3966 /// variables.
Richard Smith3ad06362018-10-31 20:39:26 +00003967 void
3968 GenerateCXXGlobalInitFunc(llvm::Function *Fn,
3969 ArrayRef<llvm::Function *> CXXThreadLocals,
3970 ConstantAddress Guard = ConstantAddress::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003971
John McCallee08c532012-04-06 18:21:03 +00003972 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003973 /// variables.
Sanjoy Dase369bd92017-05-01 17:08:00 +00003974 void GenerateCXXGlobalDtorsFunc(
3975 llvm::Function *Fn,
James Y Knightf7321542019-02-07 01:14:17 +00003976 const std::vector<std::tuple<llvm::FunctionType *, llvm::WeakTrackingVH,
3977 llvm::Constant *>> &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003978
John McCalla738c252011-03-09 04:27:21 +00003979 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3980 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003981 llvm::GlobalVariable *Addr,
3982 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003983
John McCall7a626f62010-09-15 10:14:12 +00003984 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003985
John McCall7f416cc2015-09-08 08:05:57 +00003986 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003987
Bill Wendling7c44da22018-10-31 03:48:47 +00003988 void enterFullExpression(const FullExpr *E) {
3989 if (const auto *EWC = dyn_cast<ExprWithCleanups>(E))
3990 if (EWC->getNumObjects() == 0)
3991 return;
John McCall08ef4662011-11-10 08:15:53 +00003992 enterNonTrivialFullExpression(E);
3993 }
Bill Wendling7c44da22018-10-31 03:48:47 +00003994 void enterNonTrivialFullExpression(const FullExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003995
Richard Smithea852322013-05-07 21:53:22 +00003996 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003997
Tim Northovercc2a6e02015-11-09 19:56:35 +00003998 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003999
Daniel Dunbar88402ce2008-08-04 16:51:22 +00004000 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00004001 // Annotations Emission
4002 //===--------------------------------------------------------------------===//
4003
James Y Knight8799cae2019-02-03 21:53:49 +00004004 /// Emit an annotation call (intrinsic).
4005 llvm::Value *EmitAnnotationCall(llvm::Function *AnnotationFn,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00004006 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00004007 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00004008 SourceLocation Location);
4009
4010 /// Emit local annotations for the local variable V, declared by D.
4011 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
4012
4013 /// Emit field annotations for the given field & value. Returns the
4014 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00004015 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00004016
4017 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00004018 // Internal Helpers
4019 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00004020
Chris Lattner5b1964b2008-11-11 07:41:27 +00004021 /// ContainsLabel - Return true if the statement contains a label in it. If
4022 /// this statement is not executed normally, it not containing a label means
4023 /// that we can just remove the code.
4024 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00004025
Chris Lattner29911cc2011-02-28 00:18:40 +00004026 /// containsBreak - Return true if the statement contains a break out of it.
4027 /// If the statement (recursively) contains a switch or loop with a break
4028 /// inside of it, this is fine.
4029 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00004030
4031 /// Determine if the given statement might introduce a declaration into the
4032 /// current scope, by being a (possibly-labelled) DeclStmt.
4033 static bool mightAddDeclToScope(const Stmt *S);
Gor Nishanov04491bd2017-11-11 17:00:43 +00004034
Daniel Dunbar682712c2008-11-12 10:12:14 +00004035 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00004036 /// to a constant, or if it does but contains a label, return false. If it
4037 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00004038 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
4039 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00004040
Chris Lattner29911cc2011-02-28 00:18:40 +00004041 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
4042 /// to a constant, or if it does but contains a label, return false. If it
4043 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00004044 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
4045 bool AllowLabels = false);
4046
Chris Lattnercd439292008-11-12 08:04:58 +00004047 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
4048 /// if statement) to the specified blocks. Based on the condition, this might
4049 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00004050 /// TrueCount should be the number of times we expect the condition to
4051 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00004052 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00004053 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00004054
Vedant Kumar42c17ec2017-03-14 01:56:34 +00004055 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
4056 /// nonnull, if \p LHS is marked _Nonnull.
4057 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
4058
Vedant Kumar175b6d12017-07-13 20:55:26 +00004059 /// An enumeration which makes it easier to specify whether or not an
4060 /// operation is a subtraction.
4061 enum { NotSubtraction = false, IsSubtraction = true };
4062
Vedant Kumara125eb52017-06-01 19:22:18 +00004063 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
4064 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
Vedant Kumar6dbf4272017-06-12 18:42:51 +00004065 /// \p SignedIndices indicates whether any of the GEP indices are signed.
Vedant Kumar175b6d12017-07-13 20:55:26 +00004066 /// \p IsSubtraction indicates whether the expression used to form the GEP
4067 /// is a subtraction.
Vedant Kumara125eb52017-06-01 19:22:18 +00004068 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
4069 ArrayRef<llvm::Value *> IdxList,
Vedant Kumar6dbf4272017-06-12 18:42:51 +00004070 bool SignedIndices,
Vedant Kumar175b6d12017-07-13 20:55:26 +00004071 bool IsSubtraction,
Vedant Kumara125eb52017-06-01 19:22:18 +00004072 SourceLocation Loc,
4073 const Twine &Name = "");
4074
Vedant Kumar10c31022017-07-29 00:19:51 +00004075 /// Specifies which type of sanitizer check to apply when handling a
4076 /// particular builtin.
4077 enum BuiltinCheckKind {
4078 BCK_CTZPassedZero,
4079 BCK_CLZPassedZero,
4080 };
4081
4082 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
4083 /// enabled, a runtime check specified by \p Kind is also emitted.
4084 llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
4085
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004086 /// Emit a description of a type in a format suitable for passing to
Richard Smithe30752c2012-10-09 19:52:38 +00004087 /// a runtime sanitizer handler.
4088 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
4089
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004090 /// Convert a value into a format suitable for passing to a runtime
Richard Smithe30752c2012-10-09 19:52:38 +00004091 /// sanitizer handler.
4092 llvm::Value *EmitCheckValue(llvm::Value *V);
4093
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004094 /// Emit a description of a source location in a format suitable for
Richard Smithe30752c2012-10-09 19:52:38 +00004095 /// passing to a runtime sanitizer handler.
4096 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
4097
Julian Lettnerb6c06dc2019-02-01 02:51:00 +00004098 /// Create a basic block that will either trap or call a handler function in
4099 /// the UBSan runtime with the provided arguments, and create a conditional
Richard Smithde670682012-11-01 22:15:34 +00004100 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00004101 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00004102 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00004103 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004104
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004105 /// Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00004106 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00004107 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
4108 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
4109 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00004110
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004111 /// Emit a reached-unreachable diagnostic if \p Loc is valid and runtime
4112 /// checking is enabled. Otherwise, just emit an unreachable instruction.
4113 void EmitUnreachable(SourceLocation Loc);
4114
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004115 /// Create a basic block that will call the trap intrinsic, and emit a
Richard Smithde670682012-11-01 22:15:34 +00004116 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00004117 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00004118
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004119 /// Emit a call to trap or debugtrap and attach function attribute
Akira Hatanaka85365cd2015-07-02 22:15:41 +00004120 /// "trap-func-name" if specified.
4121 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
4122
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004123 /// Emit a stub for the cross-DSO CFI check function.
Evgeniy Stepanov1a8030e2017-04-07 23:00:38 +00004124 void EmitCfiCheckStub();
4125
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004126 /// Emit a cross-DSO CFI failure handling function.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00004127 void EmitCfiCheckFail();
4128
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004129 /// Create a check for a function parameter that may potentially be
Nuno Lopes1ba2d782015-05-30 16:11:40 +00004130 /// declared as non-null.
4131 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00004132 AbstractCallee AC, unsigned ParmNum);
Nuno Lopes1ba2d782015-05-30 16:11:40 +00004133
Anders Carlsson093bdff2010-03-30 03:27:09 +00004134 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00004135 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00004136
John McCall23f66262010-05-26 22:34:26 +00004137 /// EmitDelegateCallArg - We are performing a delegate call; that
4138 /// is, the current function is delegating to another one. Produce
4139 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00004140 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
4141 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00004142
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00004143 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
4144 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00004145 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00004146
Chris Lattnercd439292008-11-12 08:04:58 +00004147private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00004148 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00004149 void EmitReturnOfRValue(RValue RV, QualType Ty);
4150
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004151 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
4152
4153 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
4154 DeferredReplacements;
4155
John McCall7f416cc2015-09-08 08:05:57 +00004156 /// Set the address of a local variable.
4157 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
4158 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
4159 LocalDeclMap.insert({VD, Addr});
4160 }
4161
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004162 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
4163 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
4164 ///
4165 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004166 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00004167 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004168
Yaxun Liu5b330e82018-03-15 15:25:19 +00004169 /// ExpandTypeToArgs - Expand an CallArg \arg Arg, with the LLVM type for \arg
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004170 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
4171 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
Yaxun Liu5b330e82018-03-15 15:25:19 +00004172 void ExpandTypeToArgs(QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004173 SmallVectorImpl<llvm::Value *> &IRCallArgs,
4174 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00004175
Chad Rosier59df25b2012-08-23 20:00:18 +00004176 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00004177 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00004178
Chad Rosier59df25b2012-08-23 20:00:18 +00004179 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00004180 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00004181 std::string &ConstraintStr,
4182 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00004183
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004184 /// Attempts to statically evaluate the object size of E. If that
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004185 /// fails, emits code to figure the size of E out for us. This is
4186 /// pass_object_size aware.
George Burgess IV0d6592a2017-02-23 05:59:56 +00004187 ///
4188 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004189 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00004190 llvm::IntegerType *ResType,
Erik Pilkington9c3b5882019-01-30 20:34:53 +00004191 llvm::Value *EmittedE,
4192 bool IsDynamic);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004193
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004194 /// Emits the size of E, as required by __builtin_object_size. This
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004195 /// function is aware of pass_object_size parameters, and will act accordingly
4196 /// if E is a parameter with the pass_object_size attribute.
4197 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00004198 llvm::IntegerType *ResType,
Erik Pilkington9c3b5882019-01-30 20:34:53 +00004199 llvm::Value *EmittedE,
4200 bool IsDynamic);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004201
Vitaly Bukae7267662019-07-10 22:53:50 +00004202 void emitZeroOrPatternForAutoVarInit(QualType type, const VarDecl &D,
4203 Address Loc);
4204
Reid Kleckner89077a12013-12-17 19:46:40 +00004205public:
Douglas Gregore83b9562015-07-07 03:57:53 +00004206#ifndef NDEBUG
4207 // Determine whether the given argument is an Objective-C method
4208 // that may have type parameters in its signature.
4209 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
4210 const DeclContext *dc = method->getDeclContext();
4211 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
4212 return classDecl->getTypeParamListAsWritten();
4213 }
4214
4215 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
4216 return catDecl->getTypeParamList();
4217 }
4218
4219 return false;
4220 }
4221
4222 template<typename T>
4223 static bool isObjCMethodWithTypeParams(const T *) { return false; }
4224#endif
4225
Richard Smitha560ccf2016-09-29 21:30:12 +00004226 enum class EvaluationOrder {
4227 ///! No language constraints on evaluation order.
4228 Default,
4229 ///! Language semantics require left-to-right evaluation.
4230 ForceLeftToRight,
4231 ///! Language semantics require right-to-left evaluation.
4232 ForceRightToLeft
4233 };
4234
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00004235 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00004236 template <typename T>
4237 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00004238 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00004239 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00004240 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00004241 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00004242 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00004243 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00004244
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004245 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
4246 "Can't skip parameters if type info is not provided");
4247 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00004248#ifndef NDEBUG
4249 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
4250#endif
4251
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004252 // First, use the argument types that the type info knows about
4253 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
4254 E = CallArgTypeInfo->param_type_end();
4255 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00004256 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00004257 assert((isGenericMethod ||
4258 ((*I)->isVariablyModifiedType() ||
4259 (*I).getNonReferenceType()->isObjCRetainableType() ||
4260 getContext()
4261 .getCanonicalType((*I).getNonReferenceType())
4262 .getTypePtr() ==
4263 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00004264 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00004265 .getTypePtr())) &&
4266 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004267 ArgTypes.push_back(*I);
4268 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00004269 }
Mike Stump11289f42009-09-09 15:08:12 +00004270
Reid Kleckner739756c2013-12-04 19:23:12 +00004271 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004272 // function.
David Blaikief05779e2015-07-21 18:37:18 +00004273 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
4274 CallArgTypeInfo->isVariadic()) &&
4275 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00004276
Anders Carlsson603d6af2009-04-18 20:20:22 +00004277 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00004278 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00004279 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00004280
Vedant Kumared00ea02017-03-06 05:28:22 +00004281 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00004282 }
John McCalld4f4b7f2010-03-03 04:15:11 +00004283
Reid Kleckner739756c2013-12-04 19:23:12 +00004284 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00004285 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00004286 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00004287 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00004288 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00004289
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00004290 /// EmitPointerWithAlignment - Given an expression with a pointer type,
4291 /// emit the value and compute our best estimate of the alignment of the
4292 /// pointee.
John McCall7f416cc2015-09-08 08:05:57 +00004293 ///
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00004294 /// \param BaseInfo - If non-null, this will be initialized with
4295 /// information about the source of the alignment and the may-alias
4296 /// attribute. Note that this function will conservatively fall back on
4297 /// the type when it doesn't recognize the expression and may-alias will
4298 /// be set to false.
4299 ///
4300 /// One reasonable way to use this information is when there's a language
4301 /// guarantee that the pointer must be aligned to some stricter value, and
4302 /// we're simply trying to ensure that sufficiently obvious uses of under-
4303 /// aligned objects don't get miscompiled; for example, a placement new
4304 /// into the address of a local variable. In such a case, it's quite
4305 /// reasonable to just ignore the returned alignment when it isn't from an
4306 /// explicit source.
John McCall7f416cc2015-09-08 08:05:57 +00004307 Address EmitPointerWithAlignment(const Expr *Addr,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00004308 LValueBaseInfo *BaseInfo = nullptr,
4309 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00004310
Vedant Kumar36347d92017-12-08 01:51:47 +00004311 /// If \p E references a parameter with pass_object_size info or a constant
4312 /// array size modifier, emit the object size divided by the size of \p EltTy.
4313 /// Otherwise return null.
4314 llvm::Value *LoadPassedObjectSize(const Expr *E, QualType EltTy);
4315
Peter Collingbournedc134532016-01-16 00:31:22 +00004316 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
4317
Erich Keanef353ae12018-09-13 16:58:24 +00004318 struct MultiVersionResolverOption {
Erich Keane281d20b2018-01-08 21:34:17 +00004319 llvm::Function *Function;
Erich Keane19a8adc2018-10-25 18:57:19 +00004320 FunctionDecl *FD;
Erich Keanef353ae12018-09-13 16:58:24 +00004321 struct Conds {
4322 StringRef Architecture;
4323 llvm::SmallVector<StringRef, 8> Features;
Erich Keane281d20b2018-01-08 21:34:17 +00004324
Erich Keanef353ae12018-09-13 16:58:24 +00004325 Conds(StringRef Arch, ArrayRef<StringRef> Feats)
4326 : Architecture(Arch), Features(Feats.begin(), Feats.end()) {}
4327 } Conditions;
Erich Keane281d20b2018-01-08 21:34:17 +00004328
Erich Keanef353ae12018-09-13 16:58:24 +00004329 MultiVersionResolverOption(llvm::Function *F, StringRef Arch,
4330 ArrayRef<StringRef> Feats)
4331 : Function(F), Conditions(Arch, Feats) {}
Erich Keane281d20b2018-01-08 21:34:17 +00004332 };
Erich Keanef353ae12018-09-13 16:58:24 +00004333
4334 // Emits the body of a multiversion function's resolver. Assumes that the
4335 // options are already sorted in the proper order, with the 'default' option
4336 // last (if it exists).
4337 void EmitMultiVersionResolver(llvm::Function *Resolver,
4338 ArrayRef<MultiVersionResolverOption> Options);
Erich Keane3efe0022018-07-20 14:13:28 +00004339
Craig Topper4d8ced12018-10-20 03:51:52 +00004340 static uint64_t GetX86CpuSupportsMask(ArrayRef<StringRef> FeatureStrs);
Erich Keane281d20b2018-01-08 21:34:17 +00004341
Reid Kleckner89077a12013-12-17 19:46:40 +00004342private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004343 QualType getVarArgType(const Expr *Arg);
4344
John McCall09ae0322010-07-06 23:57:41 +00004345 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00004346
John McCall7f416cc2015-09-08 08:05:57 +00004347 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
4348 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00004349
4350 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00004351
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00004352 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Erich Keane9937b132017-09-01 19:42:45 +00004353 llvm::Value *EmitX86CpuIs(const CallExpr *E);
4354 llvm::Value *EmitX86CpuIs(StringRef CPUStr);
4355 llvm::Value *EmitX86CpuSupports(const CallExpr *E);
4356 llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
Craig Topper4d8ced12018-10-20 03:51:52 +00004357 llvm::Value *EmitX86CpuSupports(uint64_t Mask);
Erich Keane1fe643a2017-10-06 16:40:45 +00004358 llvm::Value *EmitX86CpuInit();
Erich Keanef353ae12018-09-13 16:58:24 +00004359 llvm::Value *FormResolverCondition(const MultiVersionResolverOption &RO);
Chris Lattnerbed31442007-05-28 01:07:47 +00004360};
Mike Stump11289f42009-09-09 15:08:12 +00004361
Richard Smithf66e4f72018-07-23 22:56:45 +00004362inline DominatingLLVMValue::saved_type
4363DominatingLLVMValue::save(CodeGenFunction &CGF, llvm::Value *value) {
4364 if (!needsSaving(value)) return saved_type(value, false);
John McCallce1de612011-01-26 04:00:11 +00004365
Richard Smithf66e4f72018-07-23 22:56:45 +00004366 // Otherwise, we need an alloca.
4367 auto align = CharUnits::fromQuantity(
4368 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
4369 Address alloca =
4370 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
4371 CGF.Builder.CreateStore(value, alloca);
John McCallce1de612011-01-26 04:00:11 +00004372
Richard Smithf66e4f72018-07-23 22:56:45 +00004373 return saved_type(alloca.getPointer(), true);
4374}
John McCallce1de612011-01-26 04:00:11 +00004375
Richard Smithf66e4f72018-07-23 22:56:45 +00004376inline llvm::Value *DominatingLLVMValue::restore(CodeGenFunction &CGF,
4377 saved_type value) {
4378 // If the value says it wasn't saved, trust that it's still dominating.
4379 if (!value.getInt()) return value.getPointer();
John McCallce1de612011-01-26 04:00:11 +00004380
Richard Smithf66e4f72018-07-23 22:56:45 +00004381 // Otherwise, it should be an alloca instruction, as set up in save().
4382 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
4383 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
4384}
John McCallce1de612011-01-26 04:00:11 +00004385
Chris Lattnerbed31442007-05-28 01:07:47 +00004386} // end namespace CodeGen
4387} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00004388
Chris Lattnerbed31442007-05-28 01:07:47 +00004389#endif