blob: 6ea2d75b318d46b507311fc3ea35df6be4a98794 [file] [log] [blame]
Daniel Dunbar9c426522008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Chris Lattnerbed31442007-05-28 01:07:47 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattnerbed31442007-05-28 01:07:47 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stumpfc496822009-02-08 23:14:22 +000010// This is the internal per-function state used for llvm translation.
Chris Lattnerbed31442007-05-28 01:07:47 +000011//
12//===----------------------------------------------------------------------===//
13
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000014#ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
15#define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
Chris Lattnerbed31442007-05-28 01:07:47 +000016
Daniel Dunbarcb463852008-11-01 01:53:16 +000017#include "CGBuilder.h"
Eric Christophera9d34972011-10-19 00:43:52 +000018#include "CGDebugInfo.h"
Alexander Musman515ad8c2014-05-22 08:54:05 +000019#include "CGLoopInfo.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000020#include "CGValue.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "CodeGenModule.h"
Justin Bogneref512b92014-01-06 22:27:43 +000022#include "CodeGenPGO.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000023#include "EHScopeStack.h"
Vitaly Buka64c80b42016-10-26 05:42:30 +000024#include "VarBypassDetector.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000025#include "clang/AST/CharUnits.h"
26#include "clang/AST/ExprCXX.h"
27#include "clang/AST/ExprObjC.h"
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +000028#include "clang/AST/ExprOpenMP.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000029#include "clang/AST/Type.h"
30#include "clang/Basic/ABI.h"
Ben Langmuir3b4c30b2013-05-09 19:17:11 +000031#include "clang/Basic/CapturedStmt.h"
Alexander Musmandf7a8e22015-01-22 08:49:35 +000032#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000033#include "clang/Basic/TargetInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000034#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000035#include "llvm/ADT/ArrayRef.h"
36#include "llvm/ADT/DenseMap.h"
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;
51class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000052}
53
Chris Lattnerbed31442007-05-28 01:07:47 +000054namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000055class ASTContext;
56class BlockDecl;
57class CXXDestructorDecl;
58class CXXForRangeStmt;
59class CXXTryStmt;
60class Decl;
61class LabelDecl;
62class EnumConstantDecl;
63class FunctionDecl;
64class FunctionProtoType;
65class LabelStmt;
66class ObjCContainerDecl;
67class ObjCInterfaceDecl;
68class ObjCIvarDecl;
69class ObjCMethodDecl;
70class ObjCImplementationDecl;
71class ObjCPropertyImplDecl;
72class TargetInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000073class VarDecl;
74class ObjCForCollectionStmt;
75class ObjCAtTryStmt;
76class ObjCAtThrowStmt;
77class ObjCAtSynchronizedStmt;
78class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000079
Akira Hatanaka6b103bc2017-10-06 07:12:46 +000080namespace analyze_os_log {
81class OSLogBufferLayout;
82}
83
Chris Lattnerbed31442007-05-28 01:07:47 +000084namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000085class CodeGenTypes;
John McCallb92ab1a2016-10-26 23:46:34 +000086class CGCallee;
Rafael Espindola42ae7452014-05-09 00:57:59 +000087class CGFunctionInfo;
88class CGRecordLayout;
89class CGBlockInfo;
90class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000091class BlockByrefHelpers;
92class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000093class BlockFlags;
94class BlockFieldFlags;
Alexey Bataev7292c292016-04-25 12:22:29 +000095class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000096class TargetCodeGenInfo;
Alexey Bataev24b5bae2016-04-28 09:23:51 +000097struct OMPTaskDataTy;
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000098struct CGCoroData;
Mike Stumpfc496822009-02-08 23:14:22 +000099
John McCall47fb9502013-03-07 21:37:08 +0000100/// The kind of evaluation to perform on values of a particular
101/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
102/// CGExprAgg?
103///
104/// TODO: should vectors maybe be split out into their own thing?
105enum TypeEvaluationKind {
106 TEK_Scalar,
107 TEK_Complex,
108 TEK_Aggregate
109};
110
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000111#define LIST_SANITIZER_CHECKS \
112 SANITIZER_CHECK(AddOverflow, add_overflow, 0) \
113 SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \
114 SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \
115 SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \
116 SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \
117 SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \
118 SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0) \
Roman Lebedevb69ba222018-07-30 18:58:30 +0000119 SANITIZER_CHECK(ImplicitConversion, implicit_conversion, 0) \
Vedant Kumar10c31022017-07-29 00:19:51 +0000120 SANITIZER_CHECK(InvalidBuiltin, invalid_builtin, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000121 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
122 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
123 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
124 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000125 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000126 SANITIZER_CHECK(NullabilityReturn, nullability_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000127 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000128 SANITIZER_CHECK(NonnullReturn, nonnull_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000129 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
Vedant Kumara125eb52017-06-01 19:22:18 +0000130 SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000131 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
132 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
Filipe Cabecinhasfe5e5af2017-01-06 14:40:12 +0000133 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
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
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000330 /// Return true if a label was seen in the current scope.
331 bool hasLabelBeenSeenInCurrentScope() const {
332 if (CurLexicalScope)
333 return CurLexicalScope->hasLabels();
334 return !LabelMap.empty();
335 }
336
Chris Lattner03df1222007-06-02 04:53:11 +0000337 /// AllocaInsertPoint - This is an instruction in the entry block before which
338 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000339 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000340
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000341 /// API for captured statement code generation.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000342 class CGCapturedStmtInfo {
343 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000344 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
345 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000346 explicit CGCapturedStmtInfo(const CapturedStmt &S,
347 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000348 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000349
350 RecordDecl::field_iterator Field =
351 S.getCapturedRecordDecl()->field_begin();
352 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
353 E = S.capture_end();
354 I != E; ++I, ++Field) {
355 if (I->capturesThis())
356 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000357 else if (I->capturesVariable())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000358 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000359 else if (I->capturesVariableByCopy())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000360 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000361 }
362 }
363
364 virtual ~CGCapturedStmtInfo();
365
366 CapturedRegionKind getKind() const { return Kind; }
367
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000368 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000369 // Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000370 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000371
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000372 /// Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000373 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000374 return CaptureFields.lookup(VD->getCanonicalDecl());
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000375 }
376
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000377 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
378 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000379
Alexey Bataev18095712014-10-10 12:19:54 +0000380 static bool classof(const CGCapturedStmtInfo *) {
381 return true;
382 }
383
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000384 /// Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000385 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000386 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000387 CGF.EmitStmt(S);
388 }
389
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000390 /// Get the name of the capture helper.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000391 virtual StringRef getHelperName() const { return "__captured_stmt"; }
392
393 private:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000394 /// The kind of captured statement being generated.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000395 CapturedRegionKind Kind;
396
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000397 /// Keep the map between VarDecl and FieldDecl.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000398 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
399
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000400 /// The base address of the captured record, passed in as the first
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000401 /// argument of the parallel region function.
402 llvm::Value *ThisValue;
403
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000404 /// Captured 'this' type.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000405 FieldDecl *CXXThisFieldDecl;
406 };
Erich Keanebe65e872018-07-10 21:07:50 +0000407 CGCapturedStmtInfo *CapturedStmtInfo = nullptr;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000408
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000409 /// RAII for correct setting/restoring of CapturedStmtInfo.
Alexey Bataevd157d472015-06-24 03:35:38 +0000410 class CGCapturedStmtRAII {
411 private:
412 CodeGenFunction &CGF;
413 CGCapturedStmtInfo *PrevCapturedStmtInfo;
414 public:
415 CGCapturedStmtRAII(CodeGenFunction &CGF,
416 CGCapturedStmtInfo *NewCapturedStmtInfo)
417 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
418 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
419 }
420 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
421 };
422
Vedant Kumared00ea02017-03-06 05:28:22 +0000423 /// An abstract representation of regular/ObjC call/message targets.
424 class AbstractCallee {
425 /// The function declaration of the callee.
426 const Decl *CalleeDecl;
427
428 public:
429 AbstractCallee() : CalleeDecl(nullptr) {}
430 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
431 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
432 bool hasFunctionDecl() const {
433 return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
434 }
435 const Decl *getDecl() const { return CalleeDecl; }
436 unsigned getNumParams() const {
437 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
438 return FD->getNumParams();
439 return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
440 }
441 const ParmVarDecl *getParamDecl(unsigned I) const {
442 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
443 return FD->getParamDecl(I);
444 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
445 }
446 };
447
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000448 /// Sanitizers enabled for this function.
Alexey Samsonova0416102014-11-11 01:26:14 +0000449 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000450
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000451 /// True if CodeGen currently emits code implementing sanitizer checks.
Erich Keanebe65e872018-07-10 21:07:50 +0000452 bool IsSanitizerScope = false;
Alexey Samsonov24cad992014-07-17 18:46:27 +0000453
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000454 /// RAII object to set/unset CodeGenFunction::IsSanitizerScope.
Alexey Samsonov24cad992014-07-17 18:46:27 +0000455 class SanitizerScope {
456 CodeGenFunction *CGF;
457 public:
458 SanitizerScope(CodeGenFunction *CGF);
459 ~SanitizerScope();
460 };
461
Reid Kleckner19819442014-07-25 21:39:46 +0000462 /// In C++, whether we are code generating a thunk. This controls whether we
463 /// should emit cleanups.
Erich Keanebe65e872018-07-10 21:07:50 +0000464 bool CurFuncIsThunk = false;
Reid Kleckner19819442014-07-25 21:39:46 +0000465
John McCall31168b02011-06-15 23:02:42 +0000466 /// In ARC, whether we should autorelease the return value.
Erich Keanebe65e872018-07-10 21:07:50 +0000467 bool AutoreleaseResult = false;
John McCall31168b02011-06-15 23:02:42 +0000468
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000469 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
470 /// potentially set the return value.
Erich Keanebe65e872018-07-10 21:07:50 +0000471 bool SawAsmBlock = false;
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000472
David Chisnall93ce0182018-08-10 12:53:13 +0000473 const NamedDecl *CurSEHParent = nullptr;
David Majnemer25eb1652016-03-01 19:42:53 +0000474
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000475 /// True if the current function is an outlined SEH helper. This can be a
476 /// finally block or filter expression.
Erich Keanebe65e872018-07-10 21:07:50 +0000477 bool IsOutlinedSEHHelper = false;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000478
Erich Keanebe65e872018-07-10 21:07:50 +0000479 const CodeGen::CGBlockInfo *BlockInfo = nullptr;
480 llvm::Value *BlockPointer = nullptr;
John McCallad7c5c12011-02-08 08:22:06 +0000481
Eli Friedman9fbeba02012-02-11 02:57:39 +0000482 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
Erich Keanebe65e872018-07-10 21:07:50 +0000483 FieldDecl *LambdaThisCaptureField = nullptr;
Eli Friedman9fbeba02012-02-11 02:57:39 +0000484
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000485 /// A mapping from NRVO variables to the flags used to indicate
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000486 /// when the NRVO has been applied to this variable.
487 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000488
John McCallbd309292010-07-06 01:34:17 +0000489 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000490 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000491 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000492
David Majnemer4e52d6f2015-12-12 05:39:21 +0000493 llvm::Instruction *CurrentFuncletPad = nullptr;
494
Tim Shen421119f2016-07-01 21:08:47 +0000495 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
496 llvm::Value *Addr;
497 llvm::Value *Size;
498
499 public:
500 CallLifetimeEnd(Address addr, llvm::Value *size)
501 : Addr(addr.getPointer()), Size(size) {}
502
503 void Emit(CodeGenFunction &CGF, Flags flags) override {
504 CGF.EmitLifetimeEnd(Size, Addr);
505 }
506 };
507
Richard Smith736a9472013-06-12 20:42:33 +0000508 /// Header for data within LifetimeExtendedCleanupStack.
509 struct LifetimeExtendedCleanupHeader {
510 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000511 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000512 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Richard Smithf66e4f72018-07-23 22:56:45 +0000513 unsigned Kind : 31;
514 /// Whether this is a conditional cleanup.
515 unsigned IsConditional : 1;
Richard Smith736a9472013-06-12 20:42:33 +0000516
Justin Bognerbdff2192015-07-01 00:59:27 +0000517 size_t getSize() const { return Size; }
Richard Smithf66e4f72018-07-23 22:56:45 +0000518 CleanupKind getKind() const { return (CleanupKind)Kind; }
519 bool isConditional() const { return IsConditional; }
Richard Smith736a9472013-06-12 20:42:33 +0000520 };
John McCallbd309292010-07-06 01:34:17 +0000521
John McCallad5d61e2010-07-23 21:56:41 +0000522 /// i32s containing the indexes of the cleanup destinations.
Erich Keanebe65e872018-07-10 21:07:50 +0000523 Address NormalCleanupDest = Address::invalid();
John McCallad5d61e2010-07-23 21:56:41 +0000524
Erich Keanebe65e872018-07-10 21:07:50 +0000525 unsigned NextCleanupDestIndex = 1;
John McCallad5d61e2010-07-23 21:56:41 +0000526
John McCall08ef4662011-11-10 08:15:53 +0000527 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
Erich Keanebe65e872018-07-10 21:07:50 +0000528 CGBlockInfo *FirstBlockInfo = nullptr;
John McCall08ef4662011-11-10 08:15:53 +0000529
John McCall8e4c74b2011-08-11 02:22:43 +0000530 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
Erich Keanebe65e872018-07-10 21:07:50 +0000531 llvm::BasicBlock *EHResumeBlock = nullptr;
John McCall8e4c74b2011-08-11 02:22:43 +0000532
Bill Wendlingf0724e82011-09-19 20:31:14 +0000533 /// The exception slot. All landing pads write the current exception pointer
534 /// into this alloca.
Erich Keanebe65e872018-07-10 21:07:50 +0000535 llvm::Value *ExceptionSlot = nullptr;
John McCallbd309292010-07-06 01:34:17 +0000536
Bill Wendlingf0724e82011-09-19 20:31:14 +0000537 /// The selector slot. Under the MandatoryCleanup model, all landing pads
538 /// write the current selector value into this alloca.
Erich Keanebe65e872018-07-10 21:07:50 +0000539 llvm::AllocaInst *EHSelectorSlot = nullptr;
John McCall9b382dd2011-05-28 21:13:02 +0000540
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000541 /// A stack of exception code slots. Entering an __except block pushes a slot
542 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
543 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000544 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000545
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000546 /// Value returned by __exception_info intrinsic.
547 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000548
John McCallbd309292010-07-06 01:34:17 +0000549 /// Emits a landing pad for the current EH stack.
550 llvm::BasicBlock *EmitLandingPad();
551
552 llvm::BasicBlock *getInvokeDestImpl();
553
John McCallce1de612011-01-26 04:00:11 +0000554 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000555 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
556 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000557 }
558
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000559public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000560 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
561 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000562 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000563
John McCall6b0feb72011-06-22 02:32:12 +0000564 /// A class controlling the emission of a finally block.
565 class FinallyInfo {
566 /// Where the catchall's edge through the cleanup should go.
567 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000568
John McCall6b0feb72011-06-22 02:32:12 +0000569 /// A function to call to enter the catch.
570 llvm::Constant *BeginCatchFn;
571
572 /// An i1 variable indicating whether or not the @finally is
573 /// running for an exception.
574 llvm::AllocaInst *ForEHVar;
575
576 /// An i8* variable into which the exception pointer to rethrow
577 /// has been saved.
578 llvm::AllocaInst *SavedExnVar;
579
580 public:
581 void enter(CodeGenFunction &CGF, const Stmt *Finally,
582 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
583 llvm::Constant *rethrowFn);
584 void exit(CodeGenFunction &CGF);
585 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000586
Reid Kleckner11c033e2015-02-12 23:40:45 +0000587 /// Returns true inside SEH __try blocks.
588 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
589
Reid Klecknera002bd52015-10-28 23:06:42 +0000590 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000591 bool isCleanupPadScope() const {
592 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
593 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000594
John McCallce1de612011-01-26 04:00:11 +0000595 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
596 /// current full-expression. Safe against the possibility that
597 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000598 template <class T, class... As>
599 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000600 // If we're not in a conditional branch, or if none of the
601 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000602 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000603 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000604
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000605 // Stash values in a tuple so we can guarantee the order of saves.
606 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
607 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000608
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000609 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000610 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000611 initFullExprCleanup();
612 }
613
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000614 /// Queue a cleanup to be pushed after finishing the current
Richard Smith736a9472013-06-12 20:42:33 +0000615 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000616 template <class T, class... As>
617 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smithf66e4f72018-07-23 22:56:45 +0000618 if (!isInConditionalBranch())
619 return pushCleanupAfterFullExprImpl<T>(Kind, Address::invalid(), A...);
Richard Smith736a9472013-06-12 20:42:33 +0000620
Richard Smithf66e4f72018-07-23 22:56:45 +0000621 Address ActiveFlag = createCleanupActiveFlag();
622 assert(!DominatingValue<Address>::needsSaving(ActiveFlag) &&
623 "cleanup active flag should never need saving");
624
625 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
626 SavedTuple Saved{saveValueInCond(A)...};
627
628 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
629 pushCleanupAfterFullExprImpl<CleanupType>(Kind, ActiveFlag, Saved);
630 }
631
632 template <class T, class... As>
633 void pushCleanupAfterFullExprImpl(CleanupKind Kind, Address ActiveFlag,
634 As... A) {
635 LifetimeExtendedCleanupHeader Header = {sizeof(T), Kind,
636 ActiveFlag.isValid()};
Richard Smith736a9472013-06-12 20:42:33 +0000637
638 size_t OldSize = LifetimeExtendedCleanupStack.size();
639 LifetimeExtendedCleanupStack.resize(
Richard Smithf66e4f72018-07-23 22:56:45 +0000640 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size +
641 (Header.IsConditional ? sizeof(ActiveFlag) : 0));
Richard Smith736a9472013-06-12 20:42:33 +0000642
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000643 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000644 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000645 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
646 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000647 new (Buffer + sizeof(Header)) T(A...);
Richard Smithf66e4f72018-07-23 22:56:45 +0000648 if (Header.IsConditional)
649 new (Buffer + sizeof(Header) + sizeof(T)) Address(ActiveFlag);
Richard Smith736a9472013-06-12 20:42:33 +0000650 }
651
Richard Smithf66e4f72018-07-23 22:56:45 +0000652 /// Set up the last cleanup that was pushed as a conditional
John McCallf4beacd2011-11-10 10:43:54 +0000653 /// full-expression cleanup.
Richard Smithf66e4f72018-07-23 22:56:45 +0000654 void initFullExprCleanup() {
655 initFullExprCleanupWithFlag(createCleanupActiveFlag());
656 }
657
658 void initFullExprCleanupWithFlag(Address ActiveFlag);
659 Address createCleanupActiveFlag();
John McCallf4beacd2011-11-10 10:43:54 +0000660
John McCallbd309292010-07-06 01:34:17 +0000661 /// PushDestructorCleanup - Push a cleanup to call the
662 /// complete-object destructor of an object of the given type at the
663 /// given address. Does nothing if T is not a C++ class type with a
664 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000665 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000666
John McCall8680f872010-07-21 06:29:51 +0000667 /// PushDestructorCleanup - Push a cleanup to call the
668 /// complete-object variant of the given destructor on the object at
669 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000670 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000671
John McCallbd309292010-07-06 01:34:17 +0000672 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
673 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000674 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000675
John McCall824c2f52010-09-14 07:57:04 +0000676 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
677 /// The block cannot be reactivated. Pops it if it's the top of the
678 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000679 ///
680 /// \param DominatingIP - An instruction which is known to
681 /// dominate the current IP (if set) and which lies along
682 /// all paths of execution between the current IP and the
683 /// the point at which the cleanup comes into scope.
684 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
685 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000686
687 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
688 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000689 ///
690 /// \param DominatingIP - An instruction which is known to
691 /// dominate the current IP (if set) and which lies along
692 /// all paths of execution between the current IP and the
693 /// the point at which the cleanup comes into scope.
694 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
695 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000696
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000697 /// Enters a new scope for capturing cleanups, all of which
John McCallbd309292010-07-06 01:34:17 +0000698 /// will be executed once the scope is exited.
699 class RunCleanupsScope {
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000700 EHScopeStack::stable_iterator CleanupStackDepth, OldCleanupScopeDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000701 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000702 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000703 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000704 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000705 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000706
Aaron Ballmanabc18922015-02-15 22:54:08 +0000707 RunCleanupsScope(const RunCleanupsScope &) = delete;
708 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000709
Eric Christophera9d34972011-10-19 00:43:52 +0000710 protected:
711 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000712
Douglas Gregor965f4502009-11-24 16:43:22 +0000713 public:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000714 /// Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000715 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000716 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000717 {
John McCallbd309292010-07-06 01:34:17 +0000718 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000719 LifetimeExtendedCleanupStackSize =
720 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000721 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000722 CGF.DidCallStackSave = false;
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000723 OldCleanupScopeDepth = CGF.CurrentCleanupScopeDepth;
724 CGF.CurrentCleanupScopeDepth = CleanupStackDepth;
Douglas Gregor965f4502009-11-24 16:43:22 +0000725 }
726
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000727 /// Exit this cleanup scope, emitting any accumulated cleanups.
John McCallbd309292010-07-06 01:34:17 +0000728 ~RunCleanupsScope() {
Reid Kleckner092d0652017-03-06 22:18:34 +0000729 if (PerformCleanup)
730 ForceCleanup();
Douglas Gregor680f8612009-11-24 21:15:44 +0000731 }
732
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000733 /// Determine whether this scope requires any cleanups.
Douglas Gregor680f8612009-11-24 21:15:44 +0000734 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000735 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000736 }
737
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000738 /// Force the emission of cleanups now, instead of waiting
Douglas Gregor680f8612009-11-24 21:15:44 +0000739 /// until this object is destroyed.
Reid Kleckner092d0652017-03-06 22:18:34 +0000740 /// \param ValuesToReload - A list of values that need to be available at
741 /// the insertion point after cleanup emission. If cleanup emission created
742 /// a shared cleanup block, these value pointers will be rewritten.
743 /// Otherwise, they not will be modified.
744 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
Douglas Gregor680f8612009-11-24 21:15:44 +0000745 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000746 CGF.DidCallStackSave = OldDidCallStackSave;
Reid Kleckner092d0652017-03-06 22:18:34 +0000747 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
748 ValuesToReload);
Douglas Gregor680f8612009-11-24 21:15:44 +0000749 PerformCleanup = false;
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000750 CGF.CurrentCleanupScopeDepth = OldCleanupScopeDepth;
Douglas Gregor965f4502009-11-24 16:43:22 +0000751 }
752 };
753
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000754 // Cleanup stack depth of the RunCleanupsScope that was pushed most recently.
755 EHScopeStack::stable_iterator CurrentCleanupScopeDepth =
756 EHScopeStack::stable_end();
757
David Blaikie93be0b22014-08-22 21:37:04 +0000758 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000759 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000760 SmallVector<const LabelDecl*, 4> Labels;
761 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000762
Aaron Ballmanabc18922015-02-15 22:54:08 +0000763 LexicalScope(const LexicalScope &) = delete;
764 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000765
766 public:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000767 /// Enter a new cleanup scope.
Eric Christophera9d34972011-10-19 00:43:52 +0000768 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000769 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
770 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000771 if (CGDebugInfo *DI = CGF.getDebugInfo())
772 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
773 }
774
Nadav Rotem1da30942013-03-23 06:43:35 +0000775 void addLabel(const LabelDecl *label) {
776 assert(PerformCleanup && "adding label to dead scope?");
777 Labels.push_back(label);
778 }
779
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000780 /// Exit this cleanup scope, emitting any accumulated
Eric Christophera9d34972011-10-19 00:43:52 +0000781 /// cleanups.
782 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000783 if (CGDebugInfo *DI = CGF.getDebugInfo())
784 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
785
Nadav Rotem1da30942013-03-23 06:43:35 +0000786 // If we should perform a cleanup, force them now. Note that
787 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000788 if (PerformCleanup) {
Calixte Denizetfcd661d2018-09-24 18:24:18 +0000789 ApplyDebugLocation DL(CGF, Range.getEnd());
David Blaikie4d524432015-02-04 19:47:54 +0000790 ForceCleanup();
791 }
Eric Christophera9d34972011-10-19 00:43:52 +0000792 }
793
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000794 /// Force the emission of cleanups now, instead of waiting
Eric Christophera9d34972011-10-19 00:43:52 +0000795 /// until this object is destroyed.
796 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000797 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000798 RunCleanupsScope::ForceCleanup();
799
Nadav Rotem1da30942013-03-23 06:43:35 +0000800 if (!Labels.empty())
801 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000802 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000803
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000804 bool hasLabels() const {
805 return !Labels.empty();
806 }
807
Nadav Rotem1da30942013-03-23 06:43:35 +0000808 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000809 };
810
John McCall7f416cc2015-09-08 08:05:57 +0000811 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
812
Alexey Bataevab4ea222018-03-07 18:17:06 +0000813 /// The class used to assign some variables some temporarily addresses.
814 class OMPMapVars {
John McCall7f416cc2015-09-08 08:05:57 +0000815 DeclMapTy SavedLocals;
Alexey Bataevab4ea222018-03-07 18:17:06 +0000816 DeclMapTy SavedTempAddresses;
817 OMPMapVars(const OMPMapVars &) = delete;
818 void operator=(const OMPMapVars &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000819
820 public:
Alexey Bataevab4ea222018-03-07 18:17:06 +0000821 explicit OMPMapVars() = default;
822 ~OMPMapVars() {
823 assert(SavedLocals.empty() && "Did not restored original addresses.");
824 };
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000825
Alexey Bataevab4ea222018-03-07 18:17:06 +0000826 /// Sets the address of the variable \p LocalVD to be \p TempAddr in
827 /// function \p CGF.
828 /// \return true if at least one variable was set already, false otherwise.
829 bool setVarAddr(CodeGenFunction &CGF, const VarDecl *LocalVD,
830 Address TempAddr) {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000831 LocalVD = LocalVD->getCanonicalDecl();
John McCall7f416cc2015-09-08 08:05:57 +0000832 // Only save it once.
833 if (SavedLocals.count(LocalVD)) return false;
834
835 // Copy the existing local entry to SavedLocals.
836 auto it = CGF.LocalDeclMap.find(LocalVD);
Alexey Bataevab4ea222018-03-07 18:17:06 +0000837 if (it != CGF.LocalDeclMap.end())
838 SavedLocals.try_emplace(LocalVD, it->second);
839 else
840 SavedLocals.try_emplace(LocalVD, Address::invalid());
John McCall7f416cc2015-09-08 08:05:57 +0000841
842 // Generate the private entry.
Alexey Bataevcaacd532015-09-04 11:26:21 +0000843 QualType VarTy = LocalVD->getType();
844 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000845 Address Temp = CGF.CreateMemTemp(VarTy);
Alexey Bataevab4ea222018-03-07 18:17:06 +0000846 CGF.Builder.CreateStore(TempAddr.getPointer(), Temp);
847 TempAddr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000848 }
Alexey Bataevab4ea222018-03-07 18:17:06 +0000849 SavedTempAddresses.try_emplace(LocalVD, TempAddr);
John McCall7f416cc2015-09-08 08:05:57 +0000850
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000851 return true;
852 }
853
Alexey Bataevab4ea222018-03-07 18:17:06 +0000854 /// Applies new addresses to the list of the variables.
855 /// \return true if at least one variable is using new address, false
856 /// otherwise.
857 bool apply(CodeGenFunction &CGF) {
858 copyInto(SavedTempAddresses, CGF.LocalDeclMap);
859 SavedTempAddresses.clear();
860 return !SavedLocals.empty();
861 }
862
863 /// Restores original addresses of the variables.
864 void restore(CodeGenFunction &CGF) {
865 if (!SavedLocals.empty()) {
866 copyInto(SavedLocals, CGF.LocalDeclMap);
867 SavedLocals.clear();
868 }
869 }
870
871 private:
872 /// Copy all the entries in the source map over the corresponding
873 /// entries in the destination, which must exist.
874 static void copyInto(const DeclMapTy &Src, DeclMapTy &Dest) {
875 for (auto &Pair : Src) {
876 if (!Pair.second.isValid()) {
877 Dest.erase(Pair.first);
878 continue;
879 }
880
881 auto I = Dest.find(Pair.first);
882 if (I != Dest.end())
883 I->second = Pair.second;
884 else
885 Dest.insert(Pair);
886 }
887 }
888 };
889
890 /// The scope used to remap some variables as private in the OpenMP loop body
891 /// (or other captured region emitted without outlining), and to restore old
892 /// vars back on exit.
893 class OMPPrivateScope : public RunCleanupsScope {
894 OMPMapVars MappedVars;
895 OMPPrivateScope(const OMPPrivateScope &) = delete;
896 void operator=(const OMPPrivateScope &) = delete;
897
898 public:
899 /// Enter a new OpenMP private scope.
900 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
901
902 /// Registers \p LocalVD variable as a private and apply \p PrivateGen
903 /// function for it to generate corresponding private variable. \p
904 /// PrivateGen returns an address of the generated private variable.
905 /// \return true if the variable is registered as private, false if it has
906 /// been privatized already.
907 bool addPrivate(const VarDecl *LocalVD,
Alexey Bataevddf3db92018-04-13 17:31:06 +0000908 const llvm::function_ref<Address()> PrivateGen) {
Alexey Bataevab4ea222018-03-07 18:17:06 +0000909 assert(PerformCleanup && "adding private to dead scope");
910 return MappedVars.setVarAddr(CGF, LocalVD, PrivateGen());
911 }
912
913 /// Privatizes local variables previously registered as private.
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000914 /// Registration is separate from the actual privatization to allow
915 /// initializers use values of the original variables, not the private one.
916 /// This is important, for example, if the private variable is a class
917 /// variable initialized by a constructor that references other private
918 /// variables. But at initialization original variables must be used, not
919 /// private copies.
920 /// \return true if at least one variable was privatized, false otherwise.
Alexey Bataevab4ea222018-03-07 18:17:06 +0000921 bool Privatize() { return MappedVars.apply(CGF); }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000922
923 void ForceCleanup() {
924 RunCleanupsScope::ForceCleanup();
Alexey Bataevab4ea222018-03-07 18:17:06 +0000925 MappedVars.restore(CGF);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000926 }
927
Alexey Bataevab4ea222018-03-07 18:17:06 +0000928 /// Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000929 ~OMPPrivateScope() {
930 if (PerformCleanup)
931 ForceCleanup();
932 }
John McCall7f416cc2015-09-08 08:05:57 +0000933
Gor Nishanov04491bd2017-11-11 17:00:43 +0000934 /// Checks if the global variable is captured in current function.
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000935 bool isGlobalVarCaptured(const VarDecl *VD) const {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000936 VD = VD->getCanonicalDecl();
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000937 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
938 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000939 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000940
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000941 /// Takes the old cleanup stack size and emits the cleanup blocks
Richard Smith736a9472013-06-12 20:42:33 +0000942 /// that have been added.
Reid Kleckner092d0652017-03-06 22:18:34 +0000943 void
944 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
945 std::initializer_list<llvm::Value **> ValuesToReload = {});
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000946
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000947 /// Takes the old cleanup stack size and emits the cleanup blocks
Richard Smith736a9472013-06-12 20:42:33 +0000948 /// that have been added, then adds all lifetime-extended cleanups from
949 /// the given position to the stack.
Reid Kleckner092d0652017-03-06 22:18:34 +0000950 void
951 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
952 size_t OldLifetimeExtendedStackSize,
953 std::initializer_list<llvm::Value **> ValuesToReload = {});
Richard Smith736a9472013-06-12 20:42:33 +0000954
John McCallad5d61e2010-07-23 21:56:41 +0000955 void ResolveBranchFixups(llvm::BasicBlock *Target);
956
John McCallbd309292010-07-06 01:34:17 +0000957 /// The given basic block lies in the current EH scope, but may be a
958 /// target of a potentially scope-crossing jump; get a stable handle
959 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000960 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000961 return JumpDest(Target,
962 EHStack.getInnermostNormalCleanup(),
963 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000964 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000965
John McCallbd309292010-07-06 01:34:17 +0000966 /// The given basic block lies in the current EH scope, but may be a
967 /// target of a potentially scope-crossing jump; get a stable handle
968 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000969 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000970 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000971 }
972
973 /// EmitBranchThroughCleanup - Emit a branch from the current insert
974 /// block through the normal cleanup handling code (if any) and then
975 /// on to \arg Dest.
976 void EmitBranchThroughCleanup(JumpDest Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +0000977
Justin Bognere25ffdf2014-01-21 00:35:11 +0000978 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
979 /// specified destination obviously has no cleanups to run. 'false' is always
980 /// a conservatively correct answer for this method.
981 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
982
John McCall8e4c74b2011-08-11 02:22:43 +0000983 /// popCatchScope - Pops the catch scope at the top of the EHScope
984 /// stack, emitting any required code (other than the catch handlers
985 /// themselves).
986 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000987
David Chisnall9a837be2012-11-07 16:50:40 +0000988 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000989 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Heejin Ahnc6479192018-05-31 22:18:13 +0000990 llvm::BasicBlock *
991 getFuncletEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000992
John McCallce1de612011-01-26 04:00:11 +0000993 /// An object to manage conditionally-evaluated expressions.
994 class ConditionalEvaluation {
995 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000996
John McCallce1de612011-01-26 04:00:11 +0000997 public:
998 ConditionalEvaluation(CodeGenFunction &CGF)
999 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001000
John McCallce1de612011-01-26 04:00:11 +00001001 void begin(CodeGenFunction &CGF) {
1002 assert(CGF.OutermostConditional != this);
1003 if (!CGF.OutermostConditional)
1004 CGF.OutermostConditional = this;
1005 }
1006
1007 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +00001008 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +00001009 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +00001010 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +00001011 }
1012
1013 /// Returns a block which will be executed prior to each
1014 /// evaluation of the conditional code.
1015 llvm::BasicBlock *getStartingBlock() const {
1016 return StartBB;
1017 }
1018 };
Mike Stump11289f42009-09-09 15:08:12 +00001019
John McCall7f9c92a2010-09-17 00:50:28 +00001020 /// isInConditionalBranch - Return true if we're currently emitting
1021 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +00001022 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +00001023
John McCall7f416cc2015-09-08 08:05:57 +00001024 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +00001025 assert(isInConditionalBranch());
1026 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +00001027 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
1028 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +00001029 }
1030
John McCallce1de612011-01-26 04:00:11 +00001031 /// An RAII object to record that we're evaluating a statement
1032 /// expression.
1033 class StmtExprEvaluation {
1034 CodeGenFunction &CGF;
1035
1036 /// We have to save the outermost conditional: cleanups in a
1037 /// statement expression aren't conditional just because the
1038 /// StmtExpr is.
1039 ConditionalEvaluation *SavedOutermostConditional;
1040
1041 public:
1042 StmtExprEvaluation(CodeGenFunction &CGF)
1043 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +00001044 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +00001045 }
1046
1047 ~StmtExprEvaluation() {
1048 CGF.OutermostConditional = SavedOutermostConditional;
1049 CGF.EnsureInsertPoint();
1050 }
1051 };
John McCall1bf58462011-02-16 08:02:54 +00001052
John McCallc07a0c72011-02-17 10:25:35 +00001053 /// An object which temporarily prevents a value from being
1054 /// destroyed by aggressive peephole optimizations that assume that
1055 /// all uses of a value have been realized in the IR.
1056 class PeepholeProtection {
1057 llvm::Instruction *Inst;
1058 friend class CodeGenFunction;
1059
1060 public:
Craig Topper8a13c412014-05-21 05:09:00 +00001061 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +00001062 };
John McCallc07a0c72011-02-17 10:25:35 +00001063
John McCallfe96e0b2011-11-06 09:01:30 +00001064 /// A non-RAII class containing all the information about a bound
1065 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
1066 /// this which makes individual mappings very simple; using this
1067 /// class directly is useful when you have a variable number of
1068 /// opaque values or don't want the RAII functionality for some
1069 /// reason.
1070 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +00001071 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +00001072 bool BoundLValue;
1073 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +00001074
John McCallfe96e0b2011-11-06 09:01:30 +00001075 OpaqueValueMappingData(const OpaqueValueExpr *ov,
1076 bool boundLValue)
1077 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +00001078 public:
Craig Topper8a13c412014-05-21 05:09:00 +00001079 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +00001080
John McCallc07a0c72011-02-17 10:25:35 +00001081 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +00001082 // gl-values should be bound as l-values for obvious reasons.
1083 // Records should be bound as l-values because IR generation
1084 // always keeps them in memory. Expressions of function type
1085 // act exactly like l-values but are formally required to be
1086 // r-values in C.
1087 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +00001088 expr->getType()->isFunctionType() ||
1089 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +00001090 }
1091
John McCallfe96e0b2011-11-06 09:01:30 +00001092 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1093 const OpaqueValueExpr *ov,
1094 const Expr *e) {
1095 if (shouldBindAsLValue(ov))
1096 return bind(CGF, ov, CGF.EmitLValue(e));
1097 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1098 }
1099
1100 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1101 const OpaqueValueExpr *ov,
1102 const LValue &lv) {
1103 assert(shouldBindAsLValue(ov));
1104 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1105 return OpaqueValueMappingData(ov, true);
1106 }
1107
1108 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1109 const OpaqueValueExpr *ov,
1110 const RValue &rv) {
1111 assert(!shouldBindAsLValue(ov));
1112 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1113
1114 OpaqueValueMappingData data(ov, false);
1115
1116 // Work around an extremely aggressive peephole optimization in
1117 // EmitScalarConversion which assumes that all other uses of a
1118 // value are extant.
1119 data.Protection = CGF.protectFromPeepholes(rv);
1120
1121 return data;
1122 }
1123
Craig Topper8a13c412014-05-21 05:09:00 +00001124 bool isValid() const { return OpaqueValue != nullptr; }
1125 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +00001126
1127 void unbind(CodeGenFunction &CGF) {
1128 assert(OpaqueValue && "no data to unbind!");
1129
1130 if (BoundLValue) {
1131 CGF.OpaqueLValues.erase(OpaqueValue);
1132 } else {
1133 CGF.OpaqueRValues.erase(OpaqueValue);
1134 CGF.unprotectFromPeepholes(Protection);
1135 }
1136 }
1137 };
1138
1139 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1140 class OpaqueValueMapping {
1141 CodeGenFunction &CGF;
1142 OpaqueValueMappingData Data;
1143
1144 public:
1145 static bool shouldBindAsLValue(const Expr *expr) {
1146 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1147 }
1148
John McCallc07a0c72011-02-17 10:25:35 +00001149 /// Build the opaque value mapping for the given conditional
1150 /// operator if it's the GNU ?: extension. This is a common
1151 /// enough pattern that the convenience operator is really
1152 /// helpful.
1153 ///
1154 OpaqueValueMapping(CodeGenFunction &CGF,
1155 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +00001156 if (isa<ConditionalOperator>(op))
1157 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001158 return;
John McCallc07a0c72011-02-17 10:25:35 +00001159
1160 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001161 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1162 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001163 }
1164
Richard Smith410306b2016-12-12 02:53:20 +00001165 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1166 /// expression is set to the expression the OVE represents.
1167 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1168 : CGF(CGF) {
1169 if (OV) {
1170 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1171 "for OVE with no source expression");
1172 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1173 }
1174 }
1175
John McCall1bf58462011-02-16 08:02:54 +00001176 OpaqueValueMapping(CodeGenFunction &CGF,
1177 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001178 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001179 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001180 }
1181
1182 OpaqueValueMapping(CodeGenFunction &CGF,
1183 const OpaqueValueExpr *opaqueValue,
1184 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001185 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001186 }
1187
1188 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001189 Data.unbind(CGF);
1190 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001191 }
1192
1193 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001194 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001195 }
1196 };
Gor Nishanov04491bd2017-11-11 17:00:43 +00001197
Chris Lattner2da04b32007-08-24 05:35:26 +00001198private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001199 CGDebugInfo *DebugInfo;
Erich Keanebe65e872018-07-10 21:07:50 +00001200 bool DisableDebugInfo = false;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001201
John McCall9b382dd2011-05-28 21:13:02 +00001202 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1203 /// calling llvm.stacksave for multiple VLAs in the same scope.
Erich Keanebe65e872018-07-10 21:07:50 +00001204 bool DidCallStackSave = false;
John McCall9b382dd2011-05-28 21:13:02 +00001205
Mike Stumpe5311b02009-11-30 20:08:49 +00001206 /// IndirectBranch - The first time an indirect goto is seen we create a block
1207 /// with an indirect branch. Every time we see the address of a label taken,
1208 /// we add the label to the indirect goto. Every subsequent indirect goto is
1209 /// codegen'd as a jump to the IndirectBranch's basic block.
Erich Keanebe65e872018-07-10 21:07:50 +00001210 llvm::IndirectBrInst *IndirectBranch = nullptr;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001211
Mike Stumpfc496822009-02-08 23:14:22 +00001212 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1213 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001214 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001215
Akira Hatanakaccda3d22018-04-27 06:57:00 +00001216 // Keep track of the cleanups for callee-destructed parameters pushed to the
1217 // cleanup stack so that they can be deactivated later.
1218 llvm::DenseMap<const ParmVarDecl *, EHScopeStack::stable_iterator>
1219 CalleeDestructedParamCleanups;
1220
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001221 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1222 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1223 /// parameter.
1224 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1225 SizeArguments;
1226
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001227 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001228 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001229 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1230
Chris Lattnerac248202007-05-30 00:13:02 +00001231 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001232 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001233
Mike Stumpfc496822009-02-08 23:14:22 +00001234 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001235 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001236 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001237 BreakContinue(JumpDest Break, JumpDest Continue)
1238 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001239
John McCallbd309292010-07-06 01:34:17 +00001240 JumpDest BreakBlock;
1241 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001242 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001243 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001244
Alexey Bataev957d8562016-11-17 15:12:05 +00001245 /// Handles cancellation exit points in OpenMP-related constructs.
1246 class OpenMPCancelExitStack {
1247 /// Tracks cancellation exit point and join point for cancel-related exit
1248 /// and normal exit.
1249 struct CancelExit {
1250 CancelExit() = default;
1251 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1252 JumpDest ContBlock)
1253 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1254 OpenMPDirectiveKind Kind = OMPD_unknown;
1255 /// true if the exit block has been emitted already by the special
1256 /// emitExit() call, false if the default codegen is used.
1257 bool HasBeenEmitted = false;
1258 JumpDest ExitBlock;
1259 JumpDest ContBlock;
1260 };
1261
1262 SmallVector<CancelExit, 8> Stack;
1263
1264 public:
1265 OpenMPCancelExitStack() : Stack(1) {}
1266 ~OpenMPCancelExitStack() = default;
1267 /// Fetches the exit block for the current OpenMP construct.
1268 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1269 /// Emits exit block with special codegen procedure specific for the related
1270 /// OpenMP construct + emits code for normal construct cleanup.
1271 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
Alexey Bataevddf3db92018-04-13 17:31:06 +00001272 const llvm::function_ref<void(CodeGenFunction &)> CodeGen) {
Alexey Bataev957d8562016-11-17 15:12:05 +00001273 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1274 assert(CGF.getOMPCancelDestination(Kind).isValid());
1275 assert(CGF.HaveInsertPoint());
1276 assert(!Stack.back().HasBeenEmitted);
1277 auto IP = CGF.Builder.saveAndClearIP();
1278 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1279 CodeGen(CGF);
Erich Keane0026ed22017-07-27 16:28:20 +00001280 CGF.EmitBranch(Stack.back().ContBlock.getBlock());
Alexey Bataev957d8562016-11-17 15:12:05 +00001281 CGF.Builder.restoreIP(IP);
1282 Stack.back().HasBeenEmitted = true;
1283 }
1284 CodeGen(CGF);
1285 }
1286 /// Enter the cancel supporting \a Kind construct.
1287 /// \param Kind OpenMP directive that supports cancel constructs.
1288 /// \param HasCancel true, if the construct has inner cancel directive,
1289 /// false otherwise.
1290 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1291 Stack.push_back({Kind,
1292 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1293 : JumpDest(),
1294 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1295 : JumpDest()});
1296 }
1297 /// Emits default exit point for the cancel construct (if the special one
1298 /// has not be used) + join point for cancel/normal exits.
1299 void exit(CodeGenFunction &CGF) {
1300 if (getExitBlock().isValid()) {
1301 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1302 bool HaveIP = CGF.HaveInsertPoint();
1303 if (!Stack.back().HasBeenEmitted) {
1304 if (HaveIP)
1305 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1306 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1307 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1308 }
1309 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1310 if (!HaveIP) {
1311 CGF.Builder.CreateUnreachable();
1312 CGF.Builder.ClearInsertionPoint();
1313 }
1314 }
1315 Stack.pop_back();
1316 }
1317 };
1318 OpenMPCancelExitStack OMPCancelStack;
1319
Justin Bogneref512b92014-01-06 22:27:43 +00001320 CodeGenPGO PGO;
1321
Justin Bogner65512642015-05-02 05:00:55 +00001322 /// Calculate branch weights appropriate for PGO data
1323 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1324 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1325 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1326 uint64_t LoopCount);
1327
Justin Bogneref512b92014-01-06 22:27:43 +00001328public:
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001329 /// Increment the profiler's counter for the given statement by \p StepV.
1330 /// If \p StepV is null, the default increment is 1.
1331 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
Rong Xu9837ef52016-02-04 18:39:09 +00001332 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001333 PGO.emitCounterIncrement(Builder, S, StepV);
Justin Bogner66242d62015-04-23 23:06:47 +00001334 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001335 }
Justin Bogner66242d62015-04-23 23:06:47 +00001336
1337 /// Get the profiler's count for the given statement.
1338 uint64_t getProfileCount(const Stmt *S) {
1339 Optional<uint64_t> Count = PGO.getStmtCount(S);
1340 if (!Count.hasValue())
1341 return 0;
1342 return *Count;
1343 }
1344
1345 /// Set the profiler's current count.
1346 void setCurrentProfileCount(uint64_t Count) {
1347 PGO.setCurrentRegionCount(Count);
1348 }
1349
1350 /// Get the profiler's current count. This is generally the count for the most
1351 /// recently incremented counter.
1352 uint64_t getCurrentProfileCount() {
1353 return PGO.getCurrentRegionCount();
1354 }
1355
Justin Bogneref512b92014-01-06 22:27:43 +00001356private:
1357
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001358 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001359 /// current context is not in a switch.
Erich Keanebe65e872018-07-10 21:07:50 +00001360 llvm::SwitchInst *SwitchInsn = nullptr;
Justin Bogneref512b92014-01-06 22:27:43 +00001361 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
Erich Keanebe65e872018-07-10 21:07:50 +00001362 SmallVector<uint64_t, 16> *SwitchWeights = nullptr;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001363
Mike Stumpfc496822009-02-08 23:14:22 +00001364 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001365 /// statement range in current switch instruction.
Erich Keanebe65e872018-07-10 21:07:50 +00001366 llvm::BasicBlock *CaseRangeBlock = nullptr;
Devang Patel11663122007-10-08 20:57:48 +00001367
John McCallc07a0c72011-02-17 10:25:35 +00001368 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001369 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001370 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1371 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001372
Mike Stumpfc496822009-02-08 23:14:22 +00001373 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001374 // We track this by the size expression rather than the type itself because
1375 // in certain situations, like a const qualifier applied to an VLA typedef,
1376 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001377 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1378 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001379 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001380
John McCallbd309292010-07-06 01:34:17 +00001381 /// A block containing a single 'unreachable' instruction. Created
1382 /// lazily by getUnreachableBlock().
Erich Keanebe65e872018-07-10 21:07:50 +00001383 llvm::BasicBlock *UnreachableBlock = nullptr;
Mike Stumpfc496822009-02-08 23:14:22 +00001384
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001385 /// Counts of the number return expressions in the function.
Erich Keanebe65e872018-07-10 21:07:50 +00001386 unsigned NumReturnExprs = 0;
Adrian Prantl3be10542013-05-02 17:30:20 +00001387
1388 /// Count the number of simple (constant) return expressions in the function.
Erich Keanebe65e872018-07-10 21:07:50 +00001389 unsigned NumSimpleReturnExprs = 0;
Adrian Prantl3be10542013-05-02 17:30:20 +00001390
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001391 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001392 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001393
Richard Smith852c9db2013-04-20 22:23:05 +00001394public:
1395 /// A scope within which we are constructing the fields of an object which
1396 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1397 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1398 class FieldConstructionScope {
1399 public:
John McCall7f416cc2015-09-08 08:05:57 +00001400 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001401 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1402 CGF.CXXDefaultInitExprThis = This;
1403 }
1404 ~FieldConstructionScope() {
1405 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1406 }
1407
1408 private:
1409 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001410 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001411 };
1412
1413 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1414 /// is overridden to be the object under construction.
1415 class CXXDefaultInitExprScope {
1416 public:
1417 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001418 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1419 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1420 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1421 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001422 }
1423 ~CXXDefaultInitExprScope() {
1424 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001425 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001426 }
1427
1428 public:
1429 CodeGenFunction &CGF;
1430 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001431 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001432 };
1433
Richard Smith410306b2016-12-12 02:53:20 +00001434 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1435 /// current loop index is overridden.
1436 class ArrayInitLoopExprScope {
1437 public:
1438 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1439 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1440 CGF.ArrayInitIndex = Index;
1441 }
1442 ~ArrayInitLoopExprScope() {
1443 CGF.ArrayInitIndex = OldArrayInitIndex;
1444 }
1445
1446 private:
1447 CodeGenFunction &CGF;
1448 llvm::Value *OldArrayInitIndex;
1449 };
1450
Richard Smith5179eb72016-06-28 19:03:57 +00001451 class InlinedInheritingConstructorScope {
1452 public:
1453 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1454 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1455 OldCurCodeDecl(CGF.CurCodeDecl),
1456 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1457 OldCXXABIThisValue(CGF.CXXABIThisValue),
1458 OldCXXThisValue(CGF.CXXThisValue),
1459 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1460 OldCXXThisAlignment(CGF.CXXThisAlignment),
1461 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1462 OldCXXInheritedCtorInitExprArgs(
1463 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1464 CGF.CurGD = GD;
1465 CGF.CurFuncDecl = CGF.CurCodeDecl =
1466 cast<CXXConstructorDecl>(GD.getDecl());
1467 CGF.CXXABIThisDecl = nullptr;
1468 CGF.CXXABIThisValue = nullptr;
1469 CGF.CXXThisValue = nullptr;
1470 CGF.CXXABIThisAlignment = CharUnits();
1471 CGF.CXXThisAlignment = CharUnits();
1472 CGF.ReturnValue = Address::invalid();
1473 CGF.FnRetTy = QualType();
1474 CGF.CXXInheritedCtorInitExprArgs.clear();
1475 }
1476 ~InlinedInheritingConstructorScope() {
1477 CGF.CurGD = OldCurGD;
1478 CGF.CurFuncDecl = OldCurFuncDecl;
1479 CGF.CurCodeDecl = OldCurCodeDecl;
1480 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1481 CGF.CXXABIThisValue = OldCXXABIThisValue;
1482 CGF.CXXThisValue = OldCXXThisValue;
1483 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1484 CGF.CXXThisAlignment = OldCXXThisAlignment;
1485 CGF.ReturnValue = OldReturnValue;
1486 CGF.FnRetTy = OldFnRetTy;
1487 CGF.CXXInheritedCtorInitExprArgs =
1488 std::move(OldCXXInheritedCtorInitExprArgs);
1489 }
1490
1491 private:
1492 CodeGenFunction &CGF;
1493 GlobalDecl OldCurGD;
1494 const Decl *OldCurFuncDecl;
1495 const Decl *OldCurCodeDecl;
1496 ImplicitParamDecl *OldCXXABIThisDecl;
1497 llvm::Value *OldCXXABIThisValue;
1498 llvm::Value *OldCXXThisValue;
1499 CharUnits OldCXXABIThisAlignment;
1500 CharUnits OldCXXThisAlignment;
1501 Address OldReturnValue;
1502 QualType OldFnRetTy;
1503 CallArgList OldCXXInheritedCtorInitExprArgs;
1504 };
1505
Richard Smith852c9db2013-04-20 22:23:05 +00001506private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001507 /// CXXThisDecl - When generating code for a C++ member function,
1508 /// this will hold the implicit 'this' declaration.
Erich Keanebe65e872018-07-10 21:07:50 +00001509 ImplicitParamDecl *CXXABIThisDecl = nullptr;
1510 llvm::Value *CXXABIThisValue = nullptr;
1511 llvm::Value *CXXThisValue = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +00001512 CharUnits CXXABIThisAlignment;
1513 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001514
Richard Smith852c9db2013-04-20 22:23:05 +00001515 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1516 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001517 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001518
Richard Smith410306b2016-12-12 02:53:20 +00001519 /// The current array initialization index when evaluating an
1520 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1521 llvm::Value *ArrayInitIndex = nullptr;
1522
Richard Smith5179eb72016-06-28 19:03:57 +00001523 /// The values of function arguments to use when evaluating
1524 /// CXXInheritedCtorInitExprs within this context.
1525 CallArgList CXXInheritedCtorInitExprArgs;
1526
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001527 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1528 /// destructor, this will hold the implicit argument (e.g. VTT).
Erich Keanebe65e872018-07-10 21:07:50 +00001529 ImplicitParamDecl *CXXStructorImplicitParamDecl = nullptr;
1530 llvm::Value *CXXStructorImplicitParamValue = nullptr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001531
John McCallce1de612011-01-26 04:00:11 +00001532 /// OutermostConditional - Points to the outermost active
1533 /// conditional control. This is used so that we know if a
1534 /// temporary should be destroyed conditionally.
Erich Keanebe65e872018-07-10 21:07:50 +00001535 ConditionalEvaluation *OutermostConditional = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001536
Nadav Rotem1da30942013-03-23 06:43:35 +00001537 /// The current lexical scope.
Erich Keanebe65e872018-07-10 21:07:50 +00001538 LexicalScope *CurLexicalScope = nullptr;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001539
Adrian Prantldc237b52013-05-16 00:41:26 +00001540 /// The current source location that should be used for exception
1541 /// handling code.
1542 SourceLocation CurEHLocation;
1543
John McCall7f416cc2015-09-08 08:05:57 +00001544 /// BlockByrefInfos - For each __block variable, contains
1545 /// information about the layout of the variable.
1546 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001547
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001548 /// Used by -fsanitize=nullability-return to determine whether the return
1549 /// value can be checked.
1550 llvm::Value *RetValNullabilityPrecondition = nullptr;
1551
1552 /// Check if -fsanitize=nullability-return instrumentation is required for
1553 /// this function.
1554 bool requiresReturnValueNullabilityCheck() const {
1555 return RetValNullabilityPrecondition;
1556 }
1557
Vedant Kumarc34d3432017-06-23 21:32:38 +00001558 /// Used to store precise source locations for return statements by the
1559 /// runtime return value checks.
1560 Address ReturnLocation = Address::invalid();
1561
1562 /// Check if the return value of this function requires sanitization.
1563 bool requiresReturnValueCheck() const {
1564 return requiresReturnValueNullabilityCheck() ||
1565 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
1566 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
1567 }
1568
Erich Keanebe65e872018-07-10 21:07:50 +00001569 llvm::BasicBlock *TerminateLandingPad = nullptr;
1570 llvm::BasicBlock *TerminateHandler = nullptr;
1571 llvm::BasicBlock *TrapBB = nullptr;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001572
Reid Kleckner06f19a02018-01-02 21:34:16 +00001573 /// Terminate funclets keyed by parent funclet pad.
1574 llvm::MapVector<llvm::Value *, llvm::BasicBlock *> TerminateFunclets;
1575
Craig Topper74c10e32018-07-09 19:00:16 +00001576 /// Largest vector width used in ths function. Will be used to create a
1577 /// function attribute.
Erich Keanebe65e872018-07-10 21:07:50 +00001578 unsigned LargestVectorWidth = 0;
Craig Topper74c10e32018-07-09 19:00:16 +00001579
Vitaly Buka1c943322016-10-26 01:59:57 +00001580 /// True if we need emit the life-time markers.
1581 const bool ShouldEmitLifetimeMarkers;
1582
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00001583 /// Add OpenCL kernel arg metadata and the kernel attribute metadata to
Xiuli Panbe6da4b2017-05-04 07:31:20 +00001584 /// the function metadata.
Gor Nishanov04491bd2017-11-11 17:00:43 +00001585 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001586 llvm::Function *Fn);
1587
Chris Lattnerbed31442007-05-28 01:07:47 +00001588public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001589 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001590 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001591
John McCall8ed55a52010-09-02 09:58:18 +00001592 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001593 ASTContext &getContext() const { return CGM.getContext(); }
Gor Nishanov04491bd2017-11-11 17:00:43 +00001594 CGDebugInfo *getDebugInfo() {
1595 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001596 return nullptr;
Gor Nishanov04491bd2017-11-11 17:00:43 +00001597 return DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001598 }
1599 void disableDebugInfo() { DisableDebugInfo = true; }
1600 void enableDebugInfo() { DisableDebugInfo = false; }
1601
John McCall31168b02011-06-15 23:02:42 +00001602 bool shouldUseFusedARCCalls() {
1603 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1604 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001605
David Blaikiebbafb8a2012-03-11 07:00:24 +00001606 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001607
Bill Wendlingf0724e82011-09-19 20:31:14 +00001608 /// Returns a pointer to the function's exception object and selector slot,
1609 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001610 Address getExceptionSlot();
1611 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001612
Bill Wendling79a70e42011-09-15 18:57:19 +00001613 /// Returns the contents of the function's exception object and selector
1614 /// slots.
1615 llvm::Value *getExceptionFromSlot();
1616 llvm::Value *getSelectorFromSlot();
1617
John McCall7f416cc2015-09-08 08:05:57 +00001618 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001619
John McCallbd309292010-07-06 01:34:17 +00001620 llvm::BasicBlock *getUnreachableBlock() {
1621 if (!UnreachableBlock) {
1622 UnreachableBlock = createBasicBlock("unreachable");
1623 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1624 }
1625 return UnreachableBlock;
1626 }
1627
1628 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001629 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001630 return getInvokeDestImpl();
1631 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001632
David Majnemer25eb1652016-03-01 19:42:53 +00001633 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001634
John McCallc8e01702013-04-16 22:48:15 +00001635 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001636 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Yaxun Liucbf647c2017-07-08 13:24:52 +00001637 const TargetCodeGenInfo &getTargetHooks() const {
1638 return CGM.getTargetCodeGenInfo();
1639 }
Owen Andersonae86c192009-07-13 04:10:07 +00001640
Daniel Dunbar12347492009-02-23 17:26:39 +00001641 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001642 // Cleanups
1643 //===--------------------------------------------------------------------===//
1644
John McCall7f416cc2015-09-08 08:05:57 +00001645 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001646
John McCall178360e2011-07-11 08:38:19 +00001647 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001648 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001649 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001650 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001651 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001652 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1653 llvm::Value *arrayEnd,
1654 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001655 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001656 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001657
John McCall4bd0fb12011-07-12 16:41:08 +00001658 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001659 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001660 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001661 Address addr, QualType type);
1662 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001663 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001664 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001665 QualType type, Destroyer *destroyer,
1666 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001667 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1668 llvm::Value *CompletePtr,
1669 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001670 void pushStackRestore(CleanupKind kind, Address SPMem);
1671 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001672 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001673 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001674 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001675 bool useEHCleanupForArray,
1676 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001677 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001678 QualType elementType, CharUnits elementAlign,
1679 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001680 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001681
Peter Collingbourne1425b452012-01-26 03:33:36 +00001682 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001683
John McCall82fe67b2011-07-09 01:37:26 +00001684 /// Determines whether an EH cleanup is required to destroy a type
1685 /// with the given destruction kind.
1686 bool needsEHCleanup(QualType::DestructionKind kind) {
1687 switch (kind) {
1688 case QualType::DK_none:
1689 return false;
1690 case QualType::DK_cxx_destructor:
1691 case QualType::DK_objc_weak_lifetime:
Akira Hatanaka7275da02018-02-28 07:15:55 +00001692 case QualType::DK_nontrivial_c_struct:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001693 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001694 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001695 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001696 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1697 }
1698 llvm_unreachable("bad destruction kind");
1699 }
1700
John McCall4bd0fb12011-07-12 16:41:08 +00001701 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1702 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1703 }
1704
John McCall82fe67b2011-07-09 01:37:26 +00001705 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001706 // Objective-C
1707 //===--------------------------------------------------------------------===//
1708
Chris Lattner4bd55962008-03-30 23:03:07 +00001709 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001710
David Blaikief1425802015-01-14 00:04:42 +00001711 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001712
Mike Stumpfc496822009-02-08 23:14:22 +00001713 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001714 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1715 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001716 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001717 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001718 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001719 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001720
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001721 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1722 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001723
Mike Stumpfc496822009-02-08 23:14:22 +00001724 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1725 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001726 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1727 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001728 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001729 const ObjCPropertyImplDecl *propImpl,
1730 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001731
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001732 //===--------------------------------------------------------------------===//
1733 // Block Bits
1734 //===--------------------------------------------------------------------===//
1735
Yaxun Liuc2a87a02017-10-14 12:23:50 +00001736 /// Emit block literal.
1737 /// \return an LLVM value which is a pointer to a struct which contains
1738 /// information about the block, including the block invoke function, the
1739 /// captured variables, etc.
Yaxun Liufa13d012018-02-15 16:39:19 +00001740 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001741 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001742
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001743 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001744 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001745 const DeclMapTy &ldm,
Akira Hatanakaba0367a2017-09-22 21:32:06 +00001746 bool IsLambdaConversionToBlock,
1747 bool BuildGlobalBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001748
Akira Hatanaka9978da32018-08-10 15:09:24 +00001749 /// Check if \p T is a C++ class that has a destructor that can throw.
1750 static bool cxxDestructorCanThrow(QualType T);
1751
John McCallad7c5c12011-02-08 08:22:06 +00001752 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1753 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001754 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1755 const ObjCPropertyImplDecl *PID);
1756 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1757 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001758 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001759
Akira Hatanaka9978da32018-08-10 15:09:24 +00001760 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags,
1761 bool CanThrow);
John McCallad7c5c12011-02-08 08:22:06 +00001762
John McCall73064872011-03-31 01:59:53 +00001763 class AutoVarEmission;
1764
1765 void emitByrefStructureInit(const AutoVarEmission &emission);
Akira Hatanakacb6a9332018-07-26 16:51:21 +00001766
1767 /// Enter a cleanup to destroy a __block variable. Note that this
1768 /// cleanup should be a no-op if the variable hasn't left the stack
1769 /// yet; if a cleanup is required for the variable itself, that needs
1770 /// to be done externally.
1771 ///
1772 /// \param Kind Cleanup kind.
1773 ///
1774 /// \param Addr When \p LoadBlockVarAddr is false, the address of the __block
1775 /// structure that will be passed to _Block_object_dispose. When
1776 /// \p LoadBlockVarAddr is true, the address of the field of the block
1777 /// structure that holds the address of the __block structure.
1778 ///
1779 /// \param Flags The flag that will be passed to _Block_object_dispose.
1780 ///
1781 /// \param LoadBlockVarAddr Indicates whether we need to emit a load from
1782 /// \p Addr to get the address of the __block structure.
1783 void enterByrefCleanup(CleanupKind Kind, Address Addr, BlockFieldFlags Flags,
Akira Hatanaka9978da32018-08-10 15:09:24 +00001784 bool LoadBlockVarAddr, bool CanThrow);
John McCall73064872011-03-31 01:59:53 +00001785
John McCall7f416cc2015-09-08 08:05:57 +00001786 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1787 llvm::Value *ptr);
1788
1789 Address LoadBlockStruct();
Akira Hatanaka9bd24522018-09-09 05:22:49 +00001790 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
John McCall7f416cc2015-09-08 08:05:57 +00001791
1792 /// BuildBlockByrefAddress - Computes the location of the
1793 /// data in a variable which is declared as __block.
1794 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1795 bool followForward = true);
1796 Address emitBlockByrefAddress(Address baseAddr,
1797 const BlockByrefInfo &info,
1798 bool followForward,
1799 const llvm::Twine &name);
1800
1801 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001802
Richard Smith5179eb72016-06-28 19:03:57 +00001803 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1804
John McCalla738c252011-03-09 04:27:21 +00001805 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1806 const CGFunctionInfo &FnInfo);
Akira Hatanaka9978da32018-08-10 15:09:24 +00001807
1808 /// Annotate the function with an attribute that disables TSan checking at
1809 /// runtime.
1810 void markAsIgnoreThreadCheckingAtRuntime(llvm::Function *Fn);
1811
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001812 /// Emit code for the start of a function.
Adrian Prantl42d71b92014-04-10 23:21:53 +00001813 /// \param Loc The location to be associated with the function.
1814 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001815 void StartFunction(GlobalDecl GD,
1816 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001817 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001818 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001819 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001820 SourceLocation Loc = SourceLocation(),
1821 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001822
Vedant Kumar7f809b22017-02-24 01:15:19 +00001823 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1824
John McCallb81884d2010-02-19 09:25:03 +00001825 void EmitConstructorBody(FunctionArgList &Args);
1826 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001827 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Richard Smithb47c36f2013-11-05 09:12:18 +00001828 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001829 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001830
Faisal Vali571df122013-09-29 08:45:24 +00001831 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001832 CallArgList &CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00001833 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001834 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001835 void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001836 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001837
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001838 /// Emit the unified return block, trying to avoid its emission when
David Blaikiea0a1a872015-01-18 02:48:07 +00001839 /// possible.
1840 /// \return The debug location of the user written return statement if the
1841 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001842 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001843
Mike Stumpfc496822009-02-08 23:14:22 +00001844 /// FinishFunction - Complete IR generation of the current function. It is
1845 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001846 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001847
Nico Weber1bebad12015-02-11 22:33:32 +00001848 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
Reid Kleckner399d96e2018-04-02 20:20:33 +00001849 const CGFunctionInfo &FnInfo, bool IsUnprototyped);
Hans Wennborg88497d62013-11-15 17:24:45 +00001850
Reid Kleckner399d96e2018-04-02 20:20:33 +00001851 void EmitCallAndReturnForThunk(llvm::Constant *Callee, const ThunkInfo *Thunk,
1852 bool IsUnprototyped);
Hans Wennborg88497d62013-11-15 17:24:45 +00001853
John McCall7f416cc2015-09-08 08:05:57 +00001854 void FinishThunk();
1855
Reid Klecknerab2090d2014-07-26 01:34:32 +00001856 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1857 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1858 llvm::Value *Callee);
1859
Rafael Espindolad6e66942015-07-13 06:07:58 +00001860 /// Generate a thunk for the given method.
1861 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
Reid Kleckner399d96e2018-04-02 20:20:33 +00001862 GlobalDecl GD, const ThunkInfo &Thunk,
1863 bool IsUnprototyped);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001864
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001865 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1866 const CGFunctionInfo &FnInfo,
1867 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001868
Douglas Gregor94f9a482010-05-05 05:51:00 +00001869 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1870 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001871
Richard Smith30e304e2016-12-14 00:03:17 +00001872 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001873
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00001874 /// Struct with all information about dynamic [sub]class needed to set vptr.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001875 struct VPtr {
1876 BaseSubobject Base;
1877 const CXXRecordDecl *NearestVBase;
1878 CharUnits OffsetFromNearestVBase;
1879 const CXXRecordDecl *VTableClass;
1880 };
1881
1882 /// Initialize the vtable pointer of the given subobject.
1883 void InitializeVTablePointer(const VPtr &vptr);
1884
1885 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001886
1887 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001888 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1889
1890 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1891 CharUnits OffsetFromNearestVBase,
1892 bool BaseIsNonVirtualPrimaryBase,
1893 const CXXRecordDecl *VTableClass,
1894 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001895
Anders Carlssond5895932010-03-28 21:07:49 +00001896 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001897
Dan Gohman8fc50c22010-10-26 18:44:08 +00001898 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1899 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001900 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1901 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001902
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001903 enum CFITypeCheckKind {
1904 CFITCK_VCall,
1905 CFITCK_NVCall,
1906 CFITCK_DerivedCast,
1907 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001908 CFITCK_ICall,
Peter Collingbournee44acad2018-06-26 02:15:47 +00001909 CFITCK_NVMFCall,
1910 CFITCK_VMFCall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001911 };
1912
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001913 /// Derived is the presumed address of an object of type T after a
Peter Collingbourned2926c92015-03-14 02:42:25 +00001914 /// cast. If T is a polymorphic class type, emit a check that the virtual
1915 /// table for Derived belongs to a class derived from T.
1916 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001917 bool MayBeNull, CFITypeCheckKind TCK,
1918 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001919
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001920 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1921 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001922 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001923 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001924
Peter Collingbourned2926c92015-03-14 02:42:25 +00001925 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001926 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001927 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1928 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001929
Peter Collingbournefb532b92016-02-24 20:46:36 +00001930 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001931 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1932 /// enabled, emit a check that VTable is a member of RD's type identifier.
1933 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1934 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001935
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001936 /// Returns whether we should perform a type checked load when loading a
1937 /// virtual function for virtual calls to members of RD. This is generally
1938 /// true when both vcall CFI and whole-program-vtables are enabled.
1939 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1940
1941 /// Emit a type checked load from the given vtable.
1942 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1943 uint64_t VTableByteOffset);
1944
John McCallf99a6312010-07-21 05:30:47 +00001945 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1946 /// given phase of destruction for a destructor. The end result
1947 /// should call destructors on members and base classes in reverse
1948 /// order of their construction.
1949 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001950
Chris Lattner3c77a352010-06-22 00:03:40 +00001951 /// ShouldInstrumentFunction - Return true if the current function should be
1952 /// instrumented with __cyg_profile_func_* calls
1953 bool ShouldInstrumentFunction();
1954
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001955 /// ShouldXRayInstrument - Return true if the current function should be
1956 /// instrumented with XRay nop sleds.
1957 bool ShouldXRayInstrumentFunction() const;
1958
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +00001959 /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
1960 /// XRay custom event handling calls.
1961 bool AlwaysEmitXRayCustomEvents() const;
1962
Keith Wyssf437e352018-04-17 21:32:43 +00001963 /// AlwaysEmitXRayTypedEvents - Return true if clang must unconditionally emit
1964 /// XRay typed event handling calls.
1965 bool AlwaysEmitXRayTypedEvents() const;
1966
Vedant Kumarbb5d4852017-09-13 00:04:35 +00001967 /// Encode an address into a form suitable for use in a function prologue.
1968 llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
1969 llvm::Constant *Addr);
1970
1971 /// Decode an address used in a function prologue, encoded by \c
1972 /// EncodeAddrForUseInPrologue.
1973 llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
1974 llvm::Value *EncodedAddr);
1975
Mike Stumpfc496822009-02-08 23:14:22 +00001976 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1977 /// arguments for the given function. This is also responsible for naming the
1978 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001979 void EmitFunctionProlog(const CGFunctionInfo &FI,
1980 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001981 const FunctionArgList &Args);
1982
Mike Stumpfc496822009-02-08 23:14:22 +00001983 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1984 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001985 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1986 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001987
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001988 /// Emit a test that checks if the return value \p RV is nonnull.
Vedant Kumarc34d3432017-06-23 21:32:38 +00001989 void EmitReturnValueCheck(llvm::Value *RV);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001990
Mike Stump1d849212009-12-07 23:38:24 +00001991 /// EmitStartEHSpec - Emit the start of the exception spec.
1992 void EmitStartEHSpec(const Decl *D);
1993
1994 /// EmitEndEHSpec - Emit the end of the exception spec.
1995 void EmitEndEHSpec(const Decl *D);
1996
John McCallbd309292010-07-06 01:34:17 +00001997 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1998 llvm::BasicBlock *getTerminateLandingPad();
1999
Reid Kleckner06f19a02018-01-02 21:34:16 +00002000 /// getTerminateLandingPad - Return a cleanup funclet that just calls
2001 /// terminate.
2002 llvm::BasicBlock *getTerminateFunclet();
2003
John McCallbd309292010-07-06 01:34:17 +00002004 /// getTerminateHandler - Return a handler (not a landing pad, just
2005 /// a catch handler) that just calls terminate. This is used when
2006 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00002007 llvm::BasicBlock *getTerminateHandler();
2008
Chris Lattnera5f58b02011-07-09 17:41:47 +00002009 llvm::Type *ConvertTypeForMem(QualType T);
2010 llvm::Type *ConvertType(QualType T);
2011 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00002012 return ConvertType(getContext().getTypeDeclType(T));
2013 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00002014
Mike Stumpfc496822009-02-08 23:14:22 +00002015 /// LoadObjCSelf - Load the value of self. This function is only valid while
2016 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00002017 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00002018
2019 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002020 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00002021
Krasimir Georgiev46dfb7a2017-09-08 13:44:51 +00002022 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
John McCall47fb9502013-03-07 21:37:08 +00002023 static TypeEvaluationKind getEvaluationKind(QualType T);
2024
2025 static bool hasScalarEvaluationKind(QualType T) {
2026 return getEvaluationKind(T) == TEK_Scalar;
2027 }
2028
2029 static bool hasAggregateEvaluationKind(QualType T) {
2030 return getEvaluationKind(T) == TEK_Aggregate;
2031 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00002032
2033 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00002034 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00002035 llvm::Function *parent = nullptr,
2036 llvm::BasicBlock *before = nullptr) {
John McCallad7c5c12011-02-08 08:22:06 +00002037 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar75283ff2008-11-11 02:29:29 +00002038 }
Mike Stumpfc496822009-02-08 23:14:22 +00002039
Chris Lattnerac248202007-05-30 00:13:02 +00002040 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
2041 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002042 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00002043
Mike Stumpe5311b02009-11-30 20:08:49 +00002044 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
2045 /// another basic block, simplify it. This assumes that no other code could
2046 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00002047 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
2048
Mike Stumpfc496822009-02-08 23:14:22 +00002049 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
2050 /// adding a fall-through branch from the current insert block if
2051 /// necessary. It is legal to call this function even if there is no current
2052 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00002053 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002054 /// IsFinished - If true, indicates that the caller has finished emitting
2055 /// branches to the given block and does not expect to emit code into it. This
2056 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00002057 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00002058
John McCall8e4c74b2011-08-11 02:22:43 +00002059 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
2060 /// near its uses, and leave the insertion point in it.
2061 void EmitBlockAfterUses(llvm::BasicBlock *BB);
2062
Mike Stumpfc496822009-02-08 23:14:22 +00002063 /// EmitBranch - Emit a branch to the specified basic block from the current
2064 /// insert block, taking care to avoid creation of branches from dummy
2065 /// blocks. It is legal to call this function even if there is no current
2066 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00002067 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002068 /// This function clears the current insertion point. The caller should follow
2069 /// calls to this function with calls to Emit*Block prior to generation new
2070 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00002071 void EmitBranch(llvm::BasicBlock *Block);
2072
Mike Stumpfc496822009-02-08 23:14:22 +00002073 /// HaveInsertPoint - True if an insertion point is defined. If not, this
2074 /// indicates that the current code being emitted is unreachable.
2075 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002076 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002077 }
2078
Mike Stumpfc496822009-02-08 23:14:22 +00002079 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
2080 /// emitted IR has a place to go. Note that by definition, if this function
2081 /// creates a block then that block is unreachable; callers may do better to
2082 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002083 void EnsureInsertPoint() {
2084 if (!HaveInsertPoint())
2085 EmitBlock(createBasicBlock());
2086 }
Mike Stumpfc496822009-02-08 23:14:22 +00002087
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00002088 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00002089 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00002090 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00002091
Chris Lattnere9a64532007-06-22 21:44:33 +00002092 //===--------------------------------------------------------------------===//
2093 // Helpers
2094 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002095
John McCall7f416cc2015-09-08 08:05:57 +00002096 LValue MakeAddrLValue(Address Addr, QualType T,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002097 AlignmentSource Source = AlignmentSource::Type) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00002098 return LValue::MakeAddr(Addr, T, getContext(), LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002099 CGM.getTBAAAccessInfo(T));
2100 }
2101
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00002102 LValue MakeAddrLValue(Address Addr, QualType T, LValueBaseInfo BaseInfo,
2103 TBAAAccessInfo TBAAInfo) {
2104 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00002105 }
John McCall4e8ca4f2012-07-02 23:58:38 +00002106
John McCall7f416cc2015-09-08 08:05:57 +00002107 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002108 AlignmentSource Source = AlignmentSource::Type) {
2109 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00002110 LValueBaseInfo(Source), CGM.getTBAAAccessInfo(T));
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002111 }
2112
2113 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00002114 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00002115 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00002116 BaseInfo, TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +00002117 }
2118
2119 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00002120 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00002121 CharUnits getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00002122 LValueBaseInfo *BaseInfo = nullptr,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +00002123 TBAAAccessInfo *TBAAInfo = nullptr,
John McCall7f416cc2015-09-08 08:05:57 +00002124 bool forPointeeType = false);
2125 CharUnits getNaturalPointeeTypeAlignment(QualType T,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00002126 LValueBaseInfo *BaseInfo = nullptr,
2127 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00002128
Ivan A. Kosarev9f9d1572017-10-30 11:49:31 +00002129 Address EmitLoadOfReference(LValue RefLVal,
2130 LValueBaseInfo *PointeeBaseInfo = nullptr,
2131 TBAAAccessInfo *PointeeTBAAInfo = nullptr);
2132 LValue EmitLoadOfReferenceLValue(LValue RefLVal);
2133 LValue EmitLoadOfReferenceLValue(Address RefAddr, QualType RefTy,
2134 AlignmentSource Source =
2135 AlignmentSource::Type) {
2136 LValue RefLVal = MakeAddrLValue(RefAddr, RefTy, LValueBaseInfo(Source),
2137 CGM.getTBAAAccessInfo(RefTy));
2138 return EmitLoadOfReferenceLValue(RefLVal);
2139 }
Daniel Dunbar93b00a92010-08-21 02:53:44 +00002140
Alexey Bataev31300ed2016-02-04 11:27:03 +00002141 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
Ivan A. Kosarev90295642017-10-13 16:47:22 +00002142 LValueBaseInfo *BaseInfo = nullptr,
2143 TBAAAccessInfo *TBAAInfo = nullptr);
Alexey Bataev31300ed2016-02-04 11:27:03 +00002144 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
2145
Yaxun Liu84744c12017-06-19 17:03:41 +00002146 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
2147 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
2148 /// insertion point of the builder. The caller is responsible for setting an
2149 /// appropriate alignment on
Daniel Dunbara7566f12010-02-09 02:48:28 +00002150 /// the alloca.
Yaxun Liu84744c12017-06-19 17:03:41 +00002151 ///
2152 /// \p ArraySize is the number of array elements to be allocated if it
2153 /// is not nullptr.
2154 ///
2155 /// LangAS::Default is the address space of pointers to local variables and
2156 /// temporaries, as exposed in the source language. In certain
2157 /// configurations, this is not the same as the alloca address space, and a
2158 /// cast is needed to lift the pointer from the alloca AS into
2159 /// LangAS::Default. This can happen when the target uses a restricted
2160 /// address space for the stack but the source language requires
2161 /// LangAS::Default to be a generic address space. The latter condition is
2162 /// common for most programming languages; OpenCL is an exception in that
2163 /// LangAS::Default is the private address space, which naturally maps
2164 /// to the stack.
2165 ///
2166 /// Because the address of a temporary is often exposed to the program in
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002167 /// various ways, this function will perform the cast. The original alloca
2168 /// instruction is returned through \p Alloca if it is not nullptr.
2169 ///
2170 /// The cast is not performaed in CreateTempAllocaWithoutCast. This is
Yaxun Liu84744c12017-06-19 17:03:41 +00002171 /// more efficient if the caller knows that the address will not be exposed.
2172 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
2173 llvm::Value *ArraySize = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00002174 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
Yaxun Liu84744c12017-06-19 17:03:41 +00002175 const Twine &Name = "tmp",
2176 llvm::Value *ArraySize = nullptr,
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002177 Address *Alloca = nullptr);
2178 Address CreateTempAllocaWithoutCast(llvm::Type *Ty, CharUnits align,
2179 const Twine &Name = "tmp",
2180 llvm::Value *ArraySize = nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002181
John McCall7f416cc2015-09-08 08:05:57 +00002182 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
2183 /// default ABI alignment of the given LLVM type.
2184 ///
2185 /// IMPORTANT NOTE: This is *not* generally the right alignment for
2186 /// any given AST type that happens to have been lowered to the
2187 /// given IR type. This should only ever be used for function-local,
2188 /// IR-driven manipulations like saving and restoring a value. Do
2189 /// not hand this address off to arbitrary IRGen routines, and especially
2190 /// do not pass it as an argument to a function that might expect a
2191 /// properly ABI-aligned value.
2192 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
2193 const Twine &Name = "tmp");
2194
2195 /// InitTempAlloca - Provide an initial value for the given alloca which
2196 /// will be observable at all locations in the function.
2197 ///
2198 /// The address should be something that was returned from one of
2199 /// the CreateTempAlloca or CreateMemTemp routines, and the
2200 /// initializer must be valid in the entry block (i.e. it must
2201 /// either be a constant or an argument value).
2202 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00002203
Daniel Dunbard0049182010-02-16 19:44:13 +00002204 /// CreateIRTemp - Create a temporary IR object of the given type, with
2205 /// appropriate alignment. This routine should only be used when an temporary
2206 /// value needs to be stored into an alloca (for example, to avoid explicit
2207 /// PHI construction), but the type is the IR type, not the type appropriate
2208 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00002209 ///
2210 /// That is, this is exactly equivalent to CreateMemTemp, but calling
2211 /// ConvertType instead of ConvertTypeForMem.
2212 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00002213
Daniel Dunbara7566f12010-02-09 02:48:28 +00002214 /// CreateMemTemp - Create a temporary memory object of the given type, with
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002215 /// appropriate alignmen and cast it to the default address space. Returns
2216 /// the original alloca instruction by \p Alloca if it is not nullptr.
Yaxun Liu84744c12017-06-19 17:03:41 +00002217 Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002218 Address *Alloca = nullptr);
Yaxun Liu84744c12017-06-19 17:03:41 +00002219 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002220 Address *Alloca = nullptr);
2221
2222 /// CreateMemTemp - Create a temporary memory object of the given type, with
2223 /// appropriate alignmen without casting it to the default address space.
2224 Address CreateMemTempWithoutCast(QualType T, const Twine &Name = "tmp");
2225 Address CreateMemTempWithoutCast(QualType T, CharUnits Align,
2226 const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00002227
John McCall7a626f62010-09-15 10:14:12 +00002228 /// CreateAggTemp - Create a temporary memory object for the given
2229 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00002230 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00002231 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00002232 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00002233 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00002234 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00002235 AggValueSlot::IsNotAliased,
2236 AggValueSlot::DoesNotOverlap);
John McCall7a626f62010-09-15 10:14:12 +00002237 }
2238
John McCallad7c5c12011-02-08 08:22:06 +00002239 /// Emit a cast to void* in the appropriate address space.
2240 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2241
Chris Lattner8394d792007-06-05 20:53:16 +00002242 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2243 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00002244 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00002245
John McCalla2342eb2010-12-05 02:00:02 +00002246 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2247 void EmitIgnoredExpr(const Expr *E);
2248
Chris Lattner4647a212007-08-31 22:49:20 +00002249 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2250 /// any type. The result is returned as an RValue struct. If this is an
2251 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2252 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00002253 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00002254 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00002255 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00002256 AggValueSlot aggSlot = AggValueSlot::ignored(),
2257 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00002258
Mike Stumpfc496822009-02-08 23:14:22 +00002259 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2260 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00002261 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002262
Charles Davisc7d5c942015-09-17 20:55:33 +00002263 /// Emit a "reference" to a __builtin_ms_va_list; this is
2264 /// always the value of the expression, because a __builtin_ms_va_list is a
2265 /// pointer to a char.
2266 Address EmitMSVAListRef(const Expr *E);
2267
Gor Nishanov5eb58582017-03-26 02:18:05 +00002268 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
Mike Stumpfc496822009-02-08 23:14:22 +00002269 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00002270 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00002271
John McCall91ca10f2011-03-08 09:11:50 +00002272 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00002273 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00002274 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002275 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00002276
John McCall7f416cc2015-09-08 08:05:57 +00002277 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00002278
John McCall91ca10f2011-03-08 09:11:50 +00002279 /// EmitExprAsInit - Emits the code necessary to initialize a
2280 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00002281 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002282 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00002283
Fariborz Jahanian78652202013-01-25 23:57:05 +00002284 /// hasVolatileMember - returns true if aggregate type has a volatile
2285 /// member.
2286 bool hasVolatileMember(QualType T) {
2287 if (const RecordType *RT = T->getAs<RecordType>()) {
2288 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2289 return RD->hasVolatileMember();
2290 }
2291 return false;
2292 }
Richard Smithe78fac52018-04-05 20:52:58 +00002293
2294 /// Determine whether a return value slot may overlap some other object.
2295 AggValueSlot::Overlap_t overlapForReturnValue() {
2296 // FIXME: Assuming no overlap here breaks guaranteed copy elision for base
2297 // class subobjects. These cases may need to be revisited depending on the
2298 // resolution of the relevant core issue.
2299 return AggValueSlot::DoesNotOverlap;
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002300 }
2301
Richard Smithe78fac52018-04-05 20:52:58 +00002302 /// Determine whether a field initialization may overlap some other object.
2303 AggValueSlot::Overlap_t overlapForFieldInit(const FieldDecl *FD) {
2304 // FIXME: These cases can result in overlap as a result of P0840R0's
2305 // [[no_unique_address]] attribute. We can still infer NoOverlap in the
2306 // presence of that attribute if the field is within the nvsize of its
2307 // containing class, because non-virtual subobjects are initialized in
2308 // address order.
2309 return AggValueSlot::DoesNotOverlap;
2310 }
2311
2312 /// Determine whether a base class initialization may overlap some other
2313 /// object.
2314 AggValueSlot::Overlap_t overlapForBaseInit(const CXXRecordDecl *RD,
2315 const CXXRecordDecl *BaseRD,
2316 bool IsVirtual);
2317
2318 /// Emit an aggregate assignment.
2319 void EmitAggregateAssign(LValue Dest, LValue Src, QualType EltTy) {
2320 bool IsVolatile = hasVolatileMember(EltTy);
2321 EmitAggregateCopy(Dest, Src, EltTy, AggValueSlot::MayOverlap, IsVolatile);
2322 }
2323
2324 void EmitAggregateCopyCtor(LValue Dest, LValue Src,
2325 AggValueSlot::Overlap_t MayOverlap) {
2326 EmitAggregateCopy(Dest, Src, Src.getType(), MayOverlap);
David Majnemerfd1e7392015-02-03 23:04:06 +00002327 }
2328
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002329 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00002330 ///
Richard Smithe78fac52018-04-05 20:52:58 +00002331 /// \param isVolatile \c true iff either the source or the destination is
2332 /// volatile.
2333 /// \param MayOverlap Whether the tail padding of the destination might be
2334 /// occupied by some other object. More efficient code can often be
2335 /// generated if not.
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00002336 void EmitAggregateCopy(LValue Dest, LValue Src, QualType EltTy,
Richard Smithe78fac52018-04-05 20:52:58 +00002337 AggValueSlot::Overlap_t MayOverlap,
2338 bool isVolatile = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00002339
Anders Carlsson9396a892008-09-11 09:15:33 +00002340 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00002341 Address GetAddrOfLocalVar(const VarDecl *VD) {
2342 auto it = LocalDeclMap.find(VD);
2343 assert(it != LocalDeclMap.end() &&
2344 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2345 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00002346 }
Mike Stumpfc496822009-02-08 23:14:22 +00002347
Akira Hatanaka797afe32018-03-20 01:47:58 +00002348 /// Given an opaque value expression, return its LValue mapping if it exists,
2349 /// otherwise create one.
2350 LValue getOrCreateOpaqueLValueMapping(const OpaqueValueExpr *e);
John McCallc07a0c72011-02-17 10:25:35 +00002351
Akira Hatanaka797afe32018-03-20 01:47:58 +00002352 /// Given an opaque value expression, return its RValue mapping if it exists,
2353 /// otherwise create one.
2354 RValue getOrCreateOpaqueRValueMapping(const OpaqueValueExpr *e);
John McCall1bf58462011-02-16 08:02:54 +00002355
Richard Smith410306b2016-12-12 02:53:20 +00002356 /// Get the index of the current ArrayInitLoopExpr, if any.
2357 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2358
Dan Gohman75d69da2008-05-22 00:50:06 +00002359 /// getAccessedFieldNo - Given an encoded value and a result number, return
2360 /// the input field number being accessed.
2361 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2362
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002363 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002364 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002365
Vedant Kumarffd7c882017-04-14 22:03:34 +00002366 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2367 static bool IsWrappedCXXThis(const Expr *E);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00002368
Anders Carlssonc0964b62010-05-22 17:35:42 +00002369 /// EmitNullInitialization - Generate code to set a value of the given type to
2370 /// null, If the type contains data member pointers, they will be initialized
2371 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002372 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002373
Charles Davisc7d5c942015-09-17 20:55:33 +00002374 /// Emits a call to an LLVM variable-argument intrinsic, either
2375 /// \c llvm.va_start or \c llvm.va_end.
2376 /// \param ArgValue A reference to the \c va_list as emitted by either
2377 /// \c EmitVAListRef or \c EmitMSVAListRef.
2378 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2379 /// calls \c llvm.va_end.
2380 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2381
2382 /// Generate code to get an argument from the passed in pointer
2383 /// and update it accordingly.
2384 /// \param VE The \c VAArgExpr for which to generate code.
2385 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2386 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2387 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002388 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002389 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002390 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002391
John McCall82fe67b2011-07-09 01:37:26 +00002392 /// emitArrayLength - Compute the length of an array, even if it's a
2393 /// VLA, and drill down to the base element type.
2394 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2395 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002396 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002397
John McCall23c29fe2011-06-24 21:55:10 +00002398 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2399 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002400 ///
2401 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002402 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002403
Sander de Smalen891af03a2018-02-03 13:55:59 +00002404 struct VlaSizePair {
2405 llvm::Value *NumElts;
2406 QualType Type;
2407
2408 VlaSizePair(llvm::Value *NE, QualType T) : NumElts(NE), Type(T) {}
2409 };
2410
2411 /// Return the number of elements for a single dimension
2412 /// for the given array type.
2413 VlaSizePair getVLAElements1D(const VariableArrayType *vla);
2414 VlaSizePair getVLAElements1D(QualType vla);
2415
2416 /// Returns an LLVM value that corresponds to the size,
John McCall23c29fe2011-06-24 21:55:10 +00002417 /// in non-variably-sized elements, of a variable length array type,
2418 /// plus that largest non-variably-sized element type. Assumes that
2419 /// the type has already been emitted with EmitVariablyModifiedType.
Sander de Smalen891af03a2018-02-03 13:55:59 +00002420 VlaSizePair getVLASize(const VariableArrayType *vla);
2421 VlaSizePair getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002422
Anders Carlssona5d077d2009-04-14 16:58:56 +00002423 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2424 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002425 llvm::Value *LoadCXXThis() {
2426 assert(CXXThisValue && "no 'this' value for this function");
2427 return CXXThisValue;
2428 }
John McCall7f416cc2015-09-08 08:05:57 +00002429 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002430
Anders Carlssone36a6b32010-01-02 01:01:18 +00002431 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2432 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002433 // FIXME: Every place that calls LoadCXXVTT is something
2434 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002435 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002436 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2437 return CXXStructorImplicitParamValue;
2438 }
2439
John McCall6ce74722010-02-16 04:15:37 +00002440 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002441 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002442 Address
2443 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002444 const CXXRecordDecl *Derived,
2445 const CXXRecordDecl *Base,
2446 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002447
John McCall7f416cc2015-09-08 08:05:57 +00002448 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2449
Mike Stumpe5311b02009-11-30 20:08:49 +00002450 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2451 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002452 Address GetAddressOfBaseClass(Address Value,
2453 const CXXRecordDecl *Derived,
2454 CastExpr::path_const_iterator PathBegin,
2455 CastExpr::path_const_iterator PathEnd,
2456 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002457
John McCall7f416cc2015-09-08 08:05:57 +00002458 Address GetAddressOfDerivedClass(Address Value,
2459 const CXXRecordDecl *Derived,
2460 CastExpr::path_const_iterator PathBegin,
2461 CastExpr::path_const_iterator PathEnd,
2462 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002463
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002464 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2465 /// base constructor/destructor with virtual bases.
2466 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2467 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2468 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2469 bool Delegating);
2470
John McCallf8ff7b92010-02-23 00:48:20 +00002471 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2472 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002473 const FunctionArgList &Args,
2474 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002475 // It's important not to confuse this and the previous function. Delegating
2476 // constructors are the C++0x feature. The constructor delegate optimization
2477 // is used to reduce duplication in the base and complete consturctors where
2478 // they are substantially the same.
2479 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2480 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002481
Richard Smith5179eb72016-06-28 19:03:57 +00002482 /// Emit a call to an inheriting constructor (that is, one that invokes a
2483 /// constructor inherited from a base class) by inlining its definition. This
2484 /// is necessary if the ABI does not support forwarding the arguments to the
2485 /// base class constructor (because they're variadic or similar).
2486 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2487 CXXCtorType CtorType,
2488 bool ForVirtualBase,
2489 bool Delegating,
2490 CallArgList &Args);
2491
2492 /// Emit a call to a constructor inherited from a base class, passing the
2493 /// current constructor's arguments along unmodified (without even making
2494 /// a copy).
2495 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2496 bool ForVirtualBase, Address This,
2497 bool InheritedFromVBase,
2498 const CXXInheritedCtorInitExpr *E);
2499
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002500 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002501 bool ForVirtualBase, bool Delegating,
Richard Smithe78fac52018-04-05 20:52:58 +00002502 Address This, const CXXConstructExpr *E,
Serge Pavlov37605182018-07-28 15:33:03 +00002503 AggValueSlot::Overlap_t Overlap,
2504 bool NewPointerIsChecked);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002505
Richard Smith5179eb72016-06-28 19:03:57 +00002506 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2507 bool ForVirtualBase, bool Delegating,
Richard Smithe78fac52018-04-05 20:52:58 +00002508 Address This, CallArgList &Args,
Igor Kudrineff8f9d2018-06-25 05:48:04 +00002509 AggValueSlot::Overlap_t Overlap,
Serge Pavlov37605182018-07-28 15:33:03 +00002510 SourceLocation Loc,
2511 bool NewPointerIsChecked);
Richard Smith5179eb72016-06-28 19:03:57 +00002512
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002513 /// Emit assumption load for all bases. Requires to be be called only on
2514 /// most-derived class and not under construction of the object.
2515 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2516
2517 /// Emit assumption that vptr load == global vtable.
2518 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2519
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002520 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002521 Address This, Address Src,
2522 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002523
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002524 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002525 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002526 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002527 const CXXConstructExpr *E,
Serge Pavlov37605182018-07-28 15:33:03 +00002528 bool NewPointerIsChecked,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002529 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002530
Anders Carlssond49844b2009-09-23 02:45:36 +00002531 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2532 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002533 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002534 const CXXConstructExpr *E,
Serge Pavlov37605182018-07-28 15:33:03 +00002535 bool NewPointerIsChecked,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002536 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002537
John McCall82fe67b2011-07-09 01:37:26 +00002538 static Destroyer destroyCXXObject;
2539
Anders Carlsson0a637412009-05-29 21:03:38 +00002540 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002541 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002542 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002543
John McCall99210dc2011-09-15 06:49:18 +00002544 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002545 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002546 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002547 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002548
Peter Collingbourne702b2842011-11-27 22:09:22 +00002549 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002550 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002551
David Majnemerdc012fa2015-04-22 21:38:15 +00002552 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2553 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2554
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002555 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002556 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002557
Eli Friedman24f55432009-11-18 00:57:03 +00002558 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002559 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2560 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002561
Richard Smith760520b2014-06-03 23:27:44 +00002562 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
Eric Fiselierfa752f22018-03-21 19:19:48 +00002563 const CallExpr *TheCallExpr, bool IsDelete);
Richard Smith760520b2014-06-03 23:27:44 +00002564
John McCall7f416cc2015-09-08 08:05:57 +00002565 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2566 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2567 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002568
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002569 /// Situations in which we might emit a check for the suitability of a
Richard Smith69d0d262012-08-24 00:54:33 +00002570 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002571 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002572 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002573 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002574 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002575 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002576 /// Checking the bound value in a reference binding. Must be suitably sized
2577 /// and aligned, but is not required to refer to an object (until the
2578 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002579 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002580 /// Checking the object expression in a non-static data member access. Must
2581 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002582 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002583 /// Checking the 'this' pointer for a call to a non-static member function.
2584 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002585 TCK_MemberCall,
2586 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002587 TCK_ConstructorCall,
2588 /// Checking the operand of a static_cast to a derived pointer type. Must be
2589 /// null or an object within its lifetime.
2590 TCK_DowncastPointer,
2591 /// Checking the operand of a static_cast to a derived reference type. Must
2592 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002593 TCK_DowncastReference,
2594 /// Checking the operand of a cast to a base object. Must be suitably sized
2595 /// and aligned.
2596 TCK_Upcast,
2597 /// Checking the operand of a cast to a virtual base object. Must be an
2598 /// object within its lifetime.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002599 TCK_UpcastToVirtualBase,
2600 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002601 TCK_NonnullAssign,
2602 /// Checking the operand of a dynamic_cast or a typeid expression. Must be
2603 /// null or an object within its lifetime.
2604 TCK_DynamicOperation
Richard Smith69d0d262012-08-24 00:54:33 +00002605 };
2606
Vedant Kumar24792e32017-10-03 01:27:25 +00002607 /// Determine whether the pointer type check \p TCK permits null pointers.
2608 static bool isNullPointerAllowed(TypeCheckKind TCK);
2609
2610 /// Determine whether the pointer type check \p TCK requires a vptr check.
2611 static bool isVptrCheckRequired(TypeCheckKind TCK, QualType Ty);
2612
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002613 /// Whether any type-checking sanitizers are enabled. If \c false,
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002614 /// calls to EmitTypeCheck can be skipped.
2615 bool sanitizePerformTypeCheck() const;
2616
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002617 /// Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00002618 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00002619 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002620 QualType Type, CharUnits Alignment = CharUnits::Zero(),
Vedant Kumar18348ea2017-02-17 23:22:55 +00002621 SanitizerSet SkippedChecks = SanitizerSet());
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002622
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002623 /// Emit a check that \p Base points into an array object, which
Richard Smith539e4a72013-02-23 02:53:19 +00002624 /// we can access at index \p Index. \p Accessed should be \c false if we
2625 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2626 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2627 QualType IndexType, bool Accessed);
2628
Chris Lattner116ce8f2010-01-09 21:40:03 +00002629 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2630 bool isInc, bool isPre);
2631 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2632 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002633
2634 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
Hal Finkel6fae8492014-10-15 23:45:08 +00002635 llvm::Value *OffsetValue = nullptr) {
2636 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2637 OffsetValue);
2638 }
Hal Finkelbcc06082014-09-07 22:58:14 +00002639
Amara Emerson652795d2016-11-10 14:44:30 +00002640 /// Converts Location to a DebugLoc, if debug information is enabled.
2641 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2642
2643
Chris Lattner8394d792007-06-05 20:53:16 +00002644 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002645 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002646 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002647
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002648 /// EmitDecl - Emit a declaration.
2649 ///
2650 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002651 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002652
John McCall1c9c3fd2010-10-15 04:57:14 +00002653 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002654 ///
2655 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002656 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002657
David Blaikie73ca5692014-12-09 00:32:22 +00002658 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002659 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002660
John McCallbd309292010-07-06 01:34:17 +00002661 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2662 llvm::Value *Address);
2663
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002664 /// Determine whether the given initializer is trivial in the sense
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002665 /// that it requires no code to be generated.
2666 bool isTrivialInitializer(const Expr *Init);
2667
John McCall1c9c3fd2010-10-15 04:57:14 +00002668 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002669 ///
2670 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002671 void EmitAutoVarDecl(const VarDecl &D);
2672
2673 class AutoVarEmission {
2674 friend class CodeGenFunction;
2675
John McCall9e2e22f2011-02-22 07:16:58 +00002676 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002677
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002678 /// The address of the alloca for languages with explicit address space
2679 /// (e.g. OpenCL) or alloca casted to generic pointer for address space
2680 /// agnostic languages (e.g. C++). Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002681 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002682 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002683
2684 llvm::Value *NRVOFlag;
2685
Akira Hatanaka9bd24522018-09-09 05:22:49 +00002686 /// True if the variable is a __block variable.
2687 bool IsByRef;
John McCallc533cb72011-02-22 06:44:22 +00002688
2689 /// True if the variable is of aggregate type and has a constant
2690 /// initializer.
2691 bool IsConstantAggregate;
2692
Nadav Rotem1da30942013-03-23 06:43:35 +00002693 /// Non-null if we should use lifetime annotations.
2694 llvm::Value *SizeForLifetimeMarkers;
2695
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002696 /// Address with original alloca instruction. Invalid if the variable was
2697 /// emitted as a global constant.
2698 Address AllocaAddr;
2699
John McCall9e2e22f2011-02-22 07:16:58 +00002700 struct Invalid {};
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002701 AutoVarEmission(Invalid)
2702 : Variable(nullptr), Addr(Address::invalid()),
2703 AllocaAddr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002704
John McCallc533cb72011-02-22 06:44:22 +00002705 AutoVarEmission(const VarDecl &variable)
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002706 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Akira Hatanaka9bd24522018-09-09 05:22:49 +00002707 IsByRef(false), IsConstantAggregate(false),
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002708 SizeForLifetimeMarkers(nullptr), AllocaAddr(Address::invalid()) {}
John McCallc533cb72011-02-22 06:44:22 +00002709
John McCall7f416cc2015-09-08 08:05:57 +00002710 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002711
2712 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002713 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2714
Craig Topper8a13c412014-05-21 05:09:00 +00002715 bool useLifetimeMarkers() const {
2716 return SizeForLifetimeMarkers != nullptr;
2717 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002718 llvm::Value *getSizeForLifetimeMarkers() const {
2719 assert(useLifetimeMarkers());
2720 return SizeForLifetimeMarkers;
2721 }
2722
2723 /// Returns the raw, allocated address, which is not necessarily
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002724 /// the address of the object itself. It is casted to default
2725 /// address space for address space agnostic languages.
John McCall7f416cc2015-09-08 08:05:57 +00002726 Address getAllocatedAddress() const {
2727 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002728 }
2729
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002730 /// Returns the address for the original alloca instruction.
2731 Address getOriginalAllocatedAddress() const { return AllocaAddr; }
2732
John McCallc533cb72011-02-22 06:44:22 +00002733 /// Returns the address of the object within this declaration.
2734 /// Note that this does not chase the forwarding pointer for
2735 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002736 Address getObjectAddress(CodeGenFunction &CGF) const {
Akira Hatanaka9bd24522018-09-09 05:22:49 +00002737 if (!IsByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002738
John McCall7f416cc2015-09-08 08:05:57 +00002739 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002740 }
2741 };
2742 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2743 void EmitAutoVarInit(const AutoVarEmission &emission);
Gor Nishanov04491bd2017-11-11 17:00:43 +00002744 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002745 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2746 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002747
Sander de Smalen891af03a2018-02-03 13:55:59 +00002748 /// Emits the alloca and debug information for the size expressions for each
2749 /// dimension of an array. It registers the association of its (1-dimensional)
2750 /// QualTypes and size expression's debug node, so that CGDebugInfo can
2751 /// reference this node when creating the DISubrange object to describe the
2752 /// array types.
2753 void EmitAndRegisterVariableArrayDimensions(CGDebugInfo *DI,
2754 const VarDecl &D,
2755 bool EmitDebugInfo);
2756
John McCall1c9c3fd2010-10-15 04:57:14 +00002757 void EmitStaticVarDecl(const VarDecl &D,
2758 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002759
John McCall7f416cc2015-09-08 08:05:57 +00002760 class ParamValue {
2761 llvm::Value *Value;
2762 unsigned Alignment;
2763 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2764 public:
2765 static ParamValue forDirect(llvm::Value *value) {
2766 return ParamValue(value, 0);
2767 }
2768 static ParamValue forIndirect(Address addr) {
2769 assert(!addr.getAlignment().isZero());
2770 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2771 }
2772
2773 bool isIndirect() const { return Alignment != 0; }
2774 llvm::Value *getAnyValue() const { return Value; }
Gor Nishanov04491bd2017-11-11 17:00:43 +00002775
John McCall7f416cc2015-09-08 08:05:57 +00002776 llvm::Value *getDirectValue() const {
2777 assert(!isIndirect());
2778 return Value;
2779 }
2780
2781 Address getIndirectAddress() const {
2782 assert(isIndirect());
2783 return Address(Value, CharUnits::fromQuantity(Alignment));
2784 }
2785 };
2786
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002787 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002788 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002789
John McCallc07a0c72011-02-17 10:25:35 +00002790 /// protectFromPeepholes - Protect a value that we're intending to
2791 /// store to the side, but which will probably be used later, from
2792 /// aggressive peepholing optimizations that might delete it.
2793 ///
2794 /// Pass the result to unprotectFromPeepholes to declare that
2795 /// protection is no longer required.
2796 ///
2797 /// There's no particular reason why this shouldn't apply to
2798 /// l-values, it's just that no existing peepholes work on pointers.
2799 PeepholeProtection protectFromPeepholes(RValue rvalue);
2800 void unprotectFromPeepholes(PeepholeProtection protection);
2801
Erich Keane623efd82017-03-30 21:48:55 +00002802 void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment,
2803 llvm::Value *OffsetValue = nullptr) {
2804 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2805 OffsetValue);
2806 }
2807
Chris Lattner84915fa2007-06-02 04:16:21 +00002808 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002809 // Statement Emission
2810 //===--------------------------------------------------------------------===//
2811
Mike Stumpfc496822009-02-08 23:14:22 +00002812 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002813 void EmitStopPoint(const Stmt *S);
2814
Mike Stumpfc496822009-02-08 23:14:22 +00002815 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2816 /// this function even if there is no current insertion point.
2817 ///
2818 /// This function may clear the current insertion point; callers should use
2819 /// EnsureInsertPoint if they wish to subsequently generate code without first
2820 /// calling EmitBlock, EmitBranch, or EmitStmt.
Karl-Johan Karlsson33e205a2017-09-06 08:47:18 +00002821 void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002822
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002823 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002824 /// necessarily require an insertion point or debug information; typically
2825 /// because the statement amounts to a jump or a container of other
2826 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002827 ///
2828 /// \return True if the statement was handled.
2829 bool EmitSimpleStmt(const Stmt *S);
2830
John McCall7f416cc2015-09-08 08:05:57 +00002831 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2832 AggValueSlot AVS = AggValueSlot::ignored());
2833 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2834 bool GetLast = false,
2835 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002836 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002837
Mike Stumpfc496822009-02-08 23:14:22 +00002838 /// EmitLabel - Emit the block for the given label. It is legal to call this
2839 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002840 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002841
Chris Lattnerac248202007-05-30 00:13:02 +00002842 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002843 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002844 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002845 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002846 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002847
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002848 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002849 ArrayRef<const Attr *> Attrs = None);
2850 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002851 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002852 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002853 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002854 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002855 void EmitBreakStmt(const BreakStmt &S);
2856 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002857 void EmitSwitchStmt(const SwitchStmt &S);
2858 void EmitDefaultStmt(const DefaultStmt &S);
2859 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002860 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002861 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002862
Anders Carlsson2e744e82008-08-30 19:51:14 +00002863 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002864 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2865 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002866 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002867 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002868
Gor Nishanov8df64e92016-10-27 16:28:31 +00002869 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov90be1212017-03-06 21:12:54 +00002870 void EmitCoreturnStmt(const CoreturnStmt &S);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002871 RValue EmitCoawaitExpr(const CoawaitExpr &E,
2872 AggValueSlot aggSlot = AggValueSlot::ignored(),
2873 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002874 LValue EmitCoawaitLValue(const CoawaitExpr *E);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002875 RValue EmitCoyieldExpr(const CoyieldExpr &E,
2876 AggValueSlot aggSlot = AggValueSlot::ignored(),
2877 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002878 LValue EmitCoyieldLValue(const CoyieldExpr *E);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002879 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2880
John McCallb609d3f2010-07-07 06:56:46 +00002881 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2882 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002883
Anders Carlsson52d78a52009-09-27 18:58:34 +00002884 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002885 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002886 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002887 void EnterSEHTryStmt(const SEHTryStmt &S);
2888 void ExitSEHTryStmt(const SEHTryStmt &S);
2889
David Chisnall93ce0182018-08-10 12:53:13 +00002890 void pushSEHCleanup(CleanupKind kind,
2891 llvm::Function *FinallyFunc);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002892 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002893 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002894
2895 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2896 const SEHExceptStmt &Except);
2897
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002898 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2899 const SEHFinallyStmt &Finally);
2900
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002901 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2902 llvm::Value *ParentFP,
2903 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002904 llvm::Value *EmitSEHExceptionCode();
2905 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002906 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002907
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002908 /// Emit simple code for OpenMP directives in Simd-only mode.
2909 void EmitSimpleOMPExecutableDirective(const OMPExecutableDirective &D);
2910
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002911 /// Scan the outlined statement for captures from the parent function. For
2912 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002913 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002914 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002915 bool IsFilter);
2916
2917 /// Recovers the address of a local in a parent function. ParentVar is the
2918 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002919 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002920 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2921 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002922 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2923 Address ParentVar,
2924 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002925
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002926 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002927 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002928
Alexey Bataev2139ed62017-11-16 18:20:21 +00002929 /// Controls insertion of cancellation exit blocks in worksharing constructs.
2930 class OMPCancelStackRAII {
2931 CodeGenFunction &CGF;
2932
2933 public:
2934 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
2935 bool HasCancel)
2936 : CGF(CGF) {
2937 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
2938 }
2939 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
2940 };
2941
Alexey Bataev1189bd02016-01-26 12:20:39 +00002942 /// Returns calculated size of the specified type.
2943 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002944 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002945 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002946 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002947 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002948 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002949 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002950 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002951 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2952 SourceLocation Loc);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002953 /// Perform element by element copying of arrays with type \a
Alexey Bataev420d45b2015-04-14 05:11:24 +00002954 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2955 /// generated by \a CopyGen.
2956 ///
2957 /// \param DestAddr Address of the destination array.
2958 /// \param SrcAddr Address of the source array.
2959 /// \param OriginalType Type of destination and source arrays.
2960 /// \param CopyGen Copying procedure that copies value of single array element
2961 /// to another single array element.
2962 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002963 Address DestAddr, Address SrcAddr, QualType OriginalType,
Alexey Bataevddf3db92018-04-13 17:31:06 +00002964 const llvm::function_ref<void(Address, Address)> CopyGen);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002965 /// Emit proper copying of data from one variable to another.
Alexey Bataev420d45b2015-04-14 05:11:24 +00002966 ///
2967 /// \param OriginalType Original type of the copied variables.
2968 /// \param DestAddr Destination address.
2969 /// \param SrcAddr Source address.
2970 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2971 /// type of the base array element).
2972 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2973 /// the base array element).
2974 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2975 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002976 void EmitOMPCopy(QualType OriginalType,
2977 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002978 const VarDecl *DestVD, const VarDecl *SrcVD,
2979 const Expr *Copy);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002980 /// Emit atomic update code for constructs: \a X = \a X \a BO \a E or
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002981 /// \a X = \a E \a BO \a E.
2982 ///
2983 /// \param X Value to be updated.
2984 /// \param E Update value.
2985 /// \param BO Binary operation for update operation.
2986 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2987 /// expression, false otherwise.
2988 /// \param AO Atomic ordering of the generated atomic instructions.
2989 /// \param CommonGen Code generator for complex expressions that cannot be
2990 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00002991 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2992 /// generated, <false, RValue::get(nullptr)> otherwise.
2993 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002994 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2995 llvm::AtomicOrdering AO, SourceLocation Loc,
Alexey Bataevddf3db92018-04-13 17:31:06 +00002996 const llvm::function_ref<RValue(RValue)> CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00002997 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00002998 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002999 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
3000 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00003001 void EmitOMPUseDevicePtrClause(
3002 const OMPClause &C, OMPPrivateScope &PrivateScope,
3003 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003004 /// Emit code for copyin clause in \a D directive. The next code is
Alexey Bataevf56f98c2015-04-16 05:39:01 +00003005 /// generated at the start of outlined functions for directives:
3006 /// \code
3007 /// threadprivate_var1 = master_threadprivate_var1;
3008 /// operator=(threadprivate_var2, master_threadprivate_var2);
3009 /// ...
3010 /// __kmpc_barrier(&loc, global_tid);
3011 /// \endcode
3012 ///
3013 /// \param D OpenMP directive possibly with 'copyin' clause(s).
3014 /// \returns true if at least one copyin variable is found, false otherwise.
3015 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003016 /// Emit initial code for lastprivate variables. If some variable is
Alexey Bataev38e89532015-04-16 04:54:05 +00003017 /// not also firstprivate, then the default initialization is used. Otherwise
3018 /// initialization of this variable is performed by EmitOMPFirstprivateClause
3019 /// method.
3020 ///
3021 /// \param D Directive that may have 'lastprivate' directives.
3022 /// \param PrivateScope Private scope for capturing lastprivate variables for
3023 /// proper codegen in internal captured statement.
3024 ///
3025 /// \returns true if there is at least one lastprivate variable, false
3026 /// otherwise.
3027 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
3028 OMPPrivateScope &PrivateScope);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003029 /// Emit final copying of lastprivate values to original variables at
Alexey Bataev38e89532015-04-16 04:54:05 +00003030 /// the end of the worksharing or simd directive.
3031 ///
3032 /// \param D Directive that has at least one 'lastprivate' directives.
3033 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
3034 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00003035 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00003036 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00003037 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00003038 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00003039 /// Emit initial code for linear clauses.
3040 void EmitOMPLinearClause(const OMPLoopDirective &D,
3041 CodeGenFunction::OMPPrivateScope &PrivateScope);
3042 /// Emit final code for linear clauses.
3043 /// \param CondGen Optional conditional code for final part of codegen for
3044 /// linear clause.
3045 void EmitOMPLinearClauseFinal(
3046 const OMPLoopDirective &D,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003047 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003048 /// Emit initial code for reduction variables. Creates reduction copies
Alexey Bataev794ba0d2015-04-10 10:43:45 +00003049 /// and initializes them with the values according to OpenMP standard.
3050 ///
3051 /// \param D Directive (possibly) with the 'reduction' clause.
3052 /// \param PrivateScope Private scope for capturing reduction variables for
3053 /// proper codegen in internal captured statement.
3054 ///
3055 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
3056 OMPPrivateScope &PrivateScope);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003057 /// Emit final update of reduction values to original variables at
Alexey Bataev794ba0d2015-04-10 10:43:45 +00003058 /// the end of the directive.
3059 ///
3060 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00003061 /// \param ReductionKind The kind of reduction to perform.
3062 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
3063 const OpenMPDirectiveKind ReductionKind);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003064 /// Emit initial code for linear variables. Creates private copies
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00003065 /// and initializes them with the values according to OpenMP standard.
3066 ///
3067 /// \param D Directive (possibly) with the 'linear' clause.
Alexey Bataev8c3edfe2017-08-16 15:58:46 +00003068 /// \return true if at least one linear variable is found that should be
3069 /// initialized with the value of the original variable, false otherwise.
3070 bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00003071
Alexey Bataev7292c292016-04-25 12:22:29 +00003072 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
3073 llvm::Value * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00003074 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00003075 TaskGenTy;
3076 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
Alexey Bataev475a7442018-01-12 19:39:11 +00003077 const OpenMPDirectiveKind CapturedRegion,
Alexey Bataev7292c292016-04-25 12:22:29 +00003078 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00003079 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataevd2202ca2017-12-27 17:58:32 +00003080 struct OMPTargetDataInfo {
3081 Address BasePointersArray = Address::invalid();
3082 Address PointersArray = Address::invalid();
3083 Address SizesArray = Address::invalid();
3084 unsigned NumberOfTargetItems = 0;
3085 explicit OMPTargetDataInfo() = default;
3086 OMPTargetDataInfo(Address BasePointersArray, Address PointersArray,
3087 Address SizesArray, unsigned NumberOfTargetItems)
3088 : BasePointersArray(BasePointersArray), PointersArray(PointersArray),
3089 SizesArray(SizesArray), NumberOfTargetItems(NumberOfTargetItems) {}
3090 };
3091 void EmitOMPTargetTaskBasedDirective(const OMPExecutableDirective &S,
3092 const RegionCodeGenTy &BodyGen,
3093 OMPTargetDataInfo &InputInfo);
Alexey Bataev7292c292016-04-25 12:22:29 +00003094
Alexey Bataev9959db52014-05-06 10:08:46 +00003095 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00003096 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00003097 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00003098 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00003099 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00003100 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00003101 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00003102 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00003103 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00003104 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00003105 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00003106 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00003107 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00003108 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00003109 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00003110 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00003111 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00003112 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00003113 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00003114 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00003115 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00003116 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00003117 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00003118 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00003119 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00003120 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00003121 void
3122 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00003123 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00003124 void
3125 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00003126 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00003127 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00003128 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00003129 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00003130 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00003131 void EmitOMPDistributeParallelForDirective(
3132 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00003133 void EmitOMPDistributeParallelForSimdDirective(
3134 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00003135 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00003136 void EmitOMPTargetParallelForSimdDirective(
3137 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00003138 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00003139 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00003140 void
3141 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00003142 void EmitOMPTeamsDistributeParallelForSimdDirective(
3143 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00003144 void EmitOMPTeamsDistributeParallelForDirective(
3145 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00003146 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00003147 void EmitOMPTargetTeamsDistributeDirective(
3148 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00003149 void EmitOMPTargetTeamsDistributeParallelForDirective(
3150 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00003151 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
3152 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00003153 void EmitOMPTargetTeamsDistributeSimdDirective(
3154 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00003155
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00003156 /// Emit device code for the target directive.
3157 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
3158 StringRef ParentName,
3159 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00003160 static void
3161 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3162 const OMPTargetParallelDirective &S);
Alexey Bataevfb0ebec2017-11-08 20:16:14 +00003163 /// Emit device code for the target parallel for directive.
3164 static void EmitOMPTargetParallelForDeviceFunction(
3165 CodeGenModule &CGM, StringRef ParentName,
3166 const OMPTargetParallelForDirective &S);
Alexey Bataev5d7edca2017-11-09 17:32:15 +00003167 /// Emit device code for the target parallel for simd directive.
3168 static void EmitOMPTargetParallelForSimdDeviceFunction(
3169 CodeGenModule &CGM, StringRef ParentName,
3170 const OMPTargetParallelForSimdDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003171 /// Emit device code for the target teams directive.
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00003172 static void
3173 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3174 const OMPTargetTeamsDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003175 /// Emit device code for the target teams distribute directive.
3176 static void EmitOMPTargetTeamsDistributeDeviceFunction(
3177 CodeGenModule &CGM, StringRef ParentName,
3178 const OMPTargetTeamsDistributeDirective &S);
Alexey Bataevfbe17fb2017-12-13 19:45:06 +00003179 /// Emit device code for the target teams distribute simd directive.
3180 static void EmitOMPTargetTeamsDistributeSimdDeviceFunction(
3181 CodeGenModule &CGM, StringRef ParentName,
3182 const OMPTargetTeamsDistributeSimdDirective &S);
Alexey Bataevf8365372017-11-17 17:57:25 +00003183 /// Emit device code for the target simd directive.
3184 static void EmitOMPTargetSimdDeviceFunction(CodeGenModule &CGM,
3185 StringRef ParentName,
3186 const OMPTargetSimdDirective &S);
Alexey Bataev647dd842018-01-15 20:59:40 +00003187 /// Emit device code for the target teams distribute parallel for simd
3188 /// directive.
3189 static void EmitOMPTargetTeamsDistributeParallelForSimdDeviceFunction(
3190 CodeGenModule &CGM, StringRef ParentName,
3191 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Carlo Bertolli52978c32018-01-03 21:12:44 +00003192
3193 static void EmitOMPTargetTeamsDistributeParallelForDeviceFunction(
3194 CodeGenModule &CGM, StringRef ParentName,
3195 const OMPTargetTeamsDistributeParallelForDirective &S);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003196 /// Emit inner loop of the worksharing/simd construct.
Alexey Bataev98eb6e32015-04-22 11:15:40 +00003197 ///
3198 /// \param S Directive, for which the inner loop must be emitted.
3199 /// \param RequiresCleanup true, if directive has some associated private
3200 /// variables.
3201 /// \param LoopCond Bollean condition for loop continuation.
3202 /// \param IncExpr Increment expression for loop control variable.
3203 /// \param BodyGen Generator for the inner body of the inner loop.
3204 /// \param PostIncGen Genrator for post-increment code (required for ordered
3205 /// loop directvies).
3206 void EmitOMPInnerLoop(
3207 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
3208 const Expr *IncExpr,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003209 const llvm::function_ref<void(CodeGenFunction &)> BodyGen,
3210 const llvm::function_ref<void(CodeGenFunction &)> PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00003211
Alexey Bataev81c7ea02015-07-03 09:56:58 +00003212 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00003213 /// Emit initial code for loop counters of loop-based directives.
3214 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
3215 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00003216
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003217 /// Helper for the OpenMP loop directives.
3218 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
3219
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003220 /// Emit code for the worksharing loop-based directive.
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003221 /// \return true, if this construct has any lastprivate clause, false -
3222 /// otherwise.
3223 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
3224 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
3225 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3226
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003227 /// Emit code for the distribute loop-based directive.
3228 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
3229 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
3230
Alexey Bataevf8365372017-11-17 17:57:25 +00003231 /// Helpers for the OpenMP loop directives.
3232 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
3233 void EmitOMPSimdFinal(
3234 const OMPLoopDirective &D,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003235 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
Alexey Bataevf8365372017-11-17 17:57:25 +00003236
Alexey Bataevf47c4b42017-09-26 13:47:31 +00003237 /// Emits the lvalue for the expression with possibly captured variable.
3238 LValue EmitOMPSharedLValue(const Expr *E);
3239
Alexander Musmanc6388682014-12-15 07:07:06 +00003240private:
Yaxun Liufa13d012018-02-15 16:39:19 +00003241 /// Helpers for blocks.
3242 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
George Burgess IVe3763372016-12-22 02:50:20 +00003243
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003244 /// struct with the values to be passed to the OpenMP loop-related functions
3245 struct OMPLoopArguments {
3246 /// loop lower bound
3247 Address LB = Address::invalid();
3248 /// loop upper bound
3249 Address UB = Address::invalid();
3250 /// loop stride
3251 Address ST = Address::invalid();
3252 /// isLastIteration argument for runtime functions
3253 Address IL = Address::invalid();
3254 /// Chunk value generated by sema
3255 llvm::Value *Chunk = nullptr;
3256 /// EnsureUpperBound
3257 Expr *EUB = nullptr;
3258 /// IncrementExpression
3259 Expr *IncExpr = nullptr;
3260 /// Loop initialization
3261 Expr *Init = nullptr;
3262 /// Loop exit condition
3263 Expr *Cond = nullptr;
3264 /// Update of LB after a whole chunk has been executed
3265 Expr *NextLB = nullptr;
3266 /// Update of UB after a whole chunk has been executed
3267 Expr *NextUB = nullptr;
3268 OMPLoopArguments() = default;
3269 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
3270 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
3271 Expr *IncExpr = nullptr, Expr *Init = nullptr,
3272 Expr *Cond = nullptr, Expr *NextLB = nullptr,
3273 Expr *NextUB = nullptr)
3274 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
3275 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
3276 NextUB(NextUB) {}
3277 };
3278 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
3279 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
3280 const OMPLoopArguments &LoopArgs,
3281 const CodeGenLoopTy &CodeGenLoop,
3282 const CodeGenOrderedTy &CodeGenOrdered);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00003283 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00003284 bool IsMonotonic, const OMPLoopDirective &S,
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003285 OMPPrivateScope &LoopScope, bool Ordered,
3286 const OMPLoopArguments &LoopArgs,
3287 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3288 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
3289 const OMPLoopDirective &S,
3290 OMPPrivateScope &LoopScope,
3291 const OMPLoopArguments &LoopArgs,
3292 const CodeGenLoopTy &CodeGenLoopContent);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003293 /// Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00003294 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00003295
3296public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00003297
Chris Lattner208ae962007-05-30 17:57:17 +00003298 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00003299 // LValue Expression Emission
3300 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00003301
Daniel Dunbarc79407f2009-02-05 07:09:07 +00003302 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
3303 RValue GetUndefRValue(QualType Ty);
3304
Daniel Dunbarbb197e42009-01-09 16:50:52 +00003305 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
3306 /// and issue an ErrorUnsupported style diagnostic (using the
3307 /// provided Name).
3308 RValue EmitUnsupportedRValue(const Expr *E,
3309 const char *Name);
3310
Mike Stumpfc496822009-02-08 23:14:22 +00003311 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
3312 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00003313 LValue EmitUnsupportedLValue(const Expr *E,
3314 const char *Name);
3315
Chris Lattner8394d792007-06-05 20:53:16 +00003316 /// EmitLValue - Emit code to compute a designator that specifies the location
3317 /// of the expression.
3318 ///
3319 /// This can return one of two things: a simple address or a bitfield
3320 /// reference. In either case, the LLVM Value* in the LValue structure is
3321 /// guaranteed to be an LLVM pointer type.
3322 ///
3323 /// If this returns a bitfield reference, nothing about the pointee type of
3324 /// the LLVM value is known: For example, it may not be a pointer to an
3325 /// integer.
3326 ///
3327 /// If this returns a normal address, and if the lvalue's C type is fixed
3328 /// size, this method guarantees that the returned pointer type will point to
3329 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
3330 /// variable length type, this is not possible.
3331 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00003332 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003333
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003334 /// Same as EmitLValue but additionally we generate checking code to
Richard Smith4d1458e2012-09-08 02:08:36 +00003335 /// guard against undefined behavior. This is only suitable when we know
3336 /// that the address will be used to access the object.
3337 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00003338
John McCall7f416cc2015-09-08 08:05:57 +00003339 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003340 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00003341
John McCalla8ec7eb2013-03-07 21:37:17 +00003342 void EmitAtomicInit(Expr *E, LValue lvalue);
3343
David Majnemera5b195a2015-02-14 01:35:12 +00003344 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00003345
3346 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
3347 AggValueSlot Slot = AggValueSlot::ignored());
3348
Nick Lewycky2d84e842013-10-02 02:29:49 +00003349 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00003350 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00003351 AggValueSlot slot = AggValueSlot::ignored());
3352
3353 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3354
David Majnemera5b195a2015-02-14 01:35:12 +00003355 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3356 bool IsVolatile, bool isInit);
3357
Alexey Bataevb4505a72015-03-30 05:20:59 +00003358 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00003359 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00003360 llvm::AtomicOrdering Success =
3361 llvm::AtomicOrdering::SequentiallyConsistent,
3362 llvm::AtomicOrdering Failure =
3363 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00003364 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3365
Alexey Bataevb4505a72015-03-30 05:20:59 +00003366 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00003367 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00003368 bool IsVolatile);
3369
John McCall3a7f6922010-10-27 20:58:56 +00003370 /// EmitToMemory - Change a scalar value from its value
3371 /// representation to its in-memory representation.
3372 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3373
3374 /// EmitFromMemory - Change a scalar value from its memory
3375 /// representation to its value representation.
3376 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3377
Vedant Kumar5a972652017-02-27 19:46:19 +00003378 /// Check if the scalar \p Value is within the valid range for the given
3379 /// type \p Ty.
3380 ///
3381 /// Returns true if a check is needed (even if the range is unknown).
3382 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3383 SourceLocation Loc);
3384
Daniel Dunbar1d425462009-02-10 00:57:50 +00003385 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3386 /// care to appropriately convert from the memory representation to
3387 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003388 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003389 SourceLocation Loc,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003390 AlignmentSource Source = AlignmentSource::Type,
3391 bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003392 return EmitLoadOfScalar(Addr, Volatile, Ty, Loc, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003393 CGM.getTBAAAccessInfo(Ty), isNontemporal);
3394 }
3395
3396 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3397 SourceLocation Loc, LValueBaseInfo BaseInfo,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003398 TBAAAccessInfo TBAAInfo,
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003399 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003400
3401 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3402 /// care to appropriately convert from the memory representation to
3403 /// the LLVM value representation. The l-value must be a simple
3404 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003405 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003406
3407 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3408 /// care to appropriately convert from the memory representation to
3409 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003410 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3411 bool Volatile, QualType Ty,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003412 AlignmentSource Source = AlignmentSource::Type,
3413 bool isInit = false, bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003414 EmitStoreOfScalar(Value, Addr, Volatile, Ty, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003415 CGM.getTBAAAccessInfo(Ty), isInit, isNontemporal);
3416 }
3417
3418 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003419 bool Volatile, QualType Ty,
3420 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo,
Ivan A. Kosareva511ed72017-10-03 10:52:39 +00003421 bool isInit = false, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003422
3423 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3424 /// care to appropriately convert from the memory representation to
3425 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00003426 /// l-value. The isInit flag indicates whether this is an initialization.
3427 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3428 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003429
Chris Lattner8394d792007-06-05 20:53:16 +00003430 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3431 /// this method emits the address of the lvalue, then loads the result as an
3432 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003433 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00003434 RValue EmitLoadOfExtVectorElementLValue(LValue V);
Vedant Kumar129edab2017-03-09 16:06:27 +00003435 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
Renato Golin230c5eb2014-05-19 18:15:42 +00003436 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00003437
Chris Lattner8394d792007-06-05 20:53:16 +00003438 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3439 /// lvalue, where both are guaranteed to the have the same type, and that type
3440 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00003441 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003442 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00003443 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003444
Nick Lewycky2d84e842013-10-02 02:29:49 +00003445 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3446 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003447 ///
Mike Stumpfc496822009-02-08 23:14:22 +00003448 /// \param Result [out] - If non-null, this will be set to a Value* for the
3449 /// bit-field contents after the store, appropriate for use as the result of
3450 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00003451 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00003452 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00003453
John McCall4f29b492010-11-16 23:07:28 +00003454 /// Emit an l-value for an assignment (simple or compound) of complex type.
3455 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003456 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00003457 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3458 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00003459
Chris Lattner57540c52011-04-15 05:22:18 +00003460 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00003461 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003462 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003463 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00003464 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003465 // Note: only available for agg return types
3466 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00003467 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00003468 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00003469 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00003470 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00003471 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00003472 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3473 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00003474 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3475 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00003476 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00003477 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00003478 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00003479 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00003480 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00003481 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00003482 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00003483 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00003484 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003485
John McCall7f416cc2015-09-08 08:05:57 +00003486 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003487
Nick Lewycky2d84e842013-10-02 02:29:49 +00003488 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00003489
John McCall7f416cc2015-09-08 08:05:57 +00003490 Address EmitArrayToPointerDecay(const Expr *Array,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00003491 LValueBaseInfo *BaseInfo = nullptr,
3492 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003493
John McCall71335052012-03-10 03:05:10 +00003494 class ConstantEmission {
3495 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3496 ConstantEmission(llvm::Constant *C, bool isReference)
3497 : ValueAndIsReference(C, isReference) {}
3498 public:
3499 ConstantEmission() {}
3500 static ConstantEmission forReference(llvm::Constant *C) {
3501 return ConstantEmission(C, true);
3502 }
3503 static ConstantEmission forValue(llvm::Constant *C) {
3504 return ConstantEmission(C, false);
3505 }
3506
Aaron Ballman67347662015-02-15 22:00:28 +00003507 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00003508 return ValueAndIsReference.getOpaqueValue() != nullptr;
3509 }
John McCall71335052012-03-10 03:05:10 +00003510
3511 bool isReference() const { return ValueAndIsReference.getInt(); }
3512 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3513 assert(isReference());
3514 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3515 refExpr->getType());
3516 }
3517
3518 llvm::Constant *getValue() const {
3519 assert(!isReference());
3520 return ValueAndIsReference.getPointer();
3521 }
3522 };
3523
John McCall113bee02012-03-10 09:33:50 +00003524 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
Alex Lorenz6cc83172017-08-25 10:07:00 +00003525 ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
John McCall71335052012-03-10 03:05:10 +00003526
John McCallfe96e0b2011-11-06 09:01:30 +00003527 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3528 AggValueSlot slot = AggValueSlot::ignored());
3529 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3530
Daniel Dunbar722f4242009-04-22 05:08:15 +00003531 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003532 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00003533 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00003534 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003535
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003536 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3537 /// if the Field is a reference, this will return the address of the reference
3538 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003539 LValue EmitLValueForFieldInitialization(LValue Base,
3540 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003541
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003542 LValue EmitLValueForIvar(QualType ObjectTy,
3543 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003544 unsigned CVRQualifiers);
3545
Anders Carlsson3be22e22009-05-30 23:23:33 +00003546 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003547 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00003548 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003549 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003550 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003551
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003552 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003553 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003554 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003555 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003556 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003557 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003558
Chris Lattnerd7f58862007-06-02 05:24:33 +00003559 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003560 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003561 //===--------------------------------------------------------------------===//
3562
Mike Stumpfc496822009-02-08 23:14:22 +00003563 /// EmitCall - Generate a call of the given function, expecting the given
3564 /// result type, and using the given argument list which specifies both the
3565 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003566 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003567 ReturnValueSlot ReturnValue, const CallArgList &Args,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003568 llvm::Instruction **callOrInvoke, SourceLocation Loc);
3569 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
3570 ReturnValueSlot ReturnValue, const CallArgList &Args,
3571 llvm::Instruction **callOrInvoke = nullptr) {
3572 return EmitCall(CallInfo, Callee, ReturnValue, Args, callOrInvoke,
3573 SourceLocation());
3574 }
John McCallb92ab1a2016-10-26 23:46:34 +00003575 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003576 ReturnValueSlot ReturnValue, llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003577 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003578 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003579 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3580 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003581
Eric Christopherc7e79db2015-11-12 00:44:04 +00003582 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003583
John McCall882987f2013-02-28 19:01:20 +00003584 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3585 const Twine &name = "");
3586 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3587 ArrayRef<llvm::Value*> args,
3588 const Twine &name = "");
3589 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3590 const Twine &name = "");
3591 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3592 ArrayRef<llvm::Value*> args,
3593 const Twine &name = "");
3594
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003595 SmallVector<llvm::OperandBundleDef, 1>
3596 getBundlesForFunclet(llvm::Value *Callee);
3597
John McCallbd309292010-07-06 01:34:17 +00003598 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003599 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00003600 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00003601 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3602 ArrayRef<llvm::Value*> args,
3603 const Twine &name = "");
3604 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3605 const Twine &name = "");
3606 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3607 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00003608
Gor Nishanov04491bd2017-11-11 17:00:43 +00003609 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
John McCallb92ab1a2016-10-26 23:46:34 +00003610 NestedNameSpecifier *Qual,
3611 llvm::Type *Ty);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003612
John McCallb92ab1a2016-10-26 23:46:34 +00003613 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
Gor Nishanov04491bd2017-11-11 17:00:43 +00003614 CXXDtorType Type,
John McCallb92ab1a2016-10-26 23:46:34 +00003615 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003616
Akira Hatanaka9978da32018-08-10 15:09:24 +00003617 // Return the copy constructor name with the prefix "__copy_constructor_"
3618 // removed.
3619 static std::string getNonTrivialCopyConstructorStr(QualType QT,
3620 CharUnits Alignment,
3621 bool IsVolatile,
3622 ASTContext &Ctx);
3623
3624 // Return the destructor name with the prefix "__destructor_" removed.
3625 static std::string getNonTrivialDestructorStr(QualType QT,
3626 CharUnits Alignment,
3627 bool IsVolatile,
3628 ASTContext &Ctx);
3629
Akira Hatanaka7275da02018-02-28 07:15:55 +00003630 // These functions emit calls to the special functions of non-trivial C
3631 // structs.
3632 void defaultInitNonTrivialCStructVar(LValue Dst);
3633 void callCStructDefaultConstructor(LValue Dst);
3634 void callCStructDestructor(LValue Dst);
3635 void callCStructCopyConstructor(LValue Dst, LValue Src);
3636 void callCStructMoveConstructor(LValue Dst, LValue Src);
3637 void callCStructCopyAssignmentOperator(LValue Dst, LValue Src);
3638 void callCStructMoveAssignmentOperator(LValue Dst, LValue Src);
3639
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003640 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003641 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3642 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003643 ReturnValueSlot ReturnValue, llvm::Value *This,
3644 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003645 QualType ImplicitParamTy, const CallExpr *E,
3646 CallArgList *RtlArgs);
John McCallb92ab1a2016-10-26 23:46:34 +00003647 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3648 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003649 llvm::Value *This, llvm::Value *ImplicitParam,
3650 QualType ImplicitParamTy, const CallExpr *E,
3651 StructorType Type);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003652 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3653 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003654 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3655 const CXXMethodDecl *MD,
3656 ReturnValueSlot ReturnValue,
3657 bool HasQualifier,
3658 NestedNameSpecifier *Qualifier,
3659 bool IsArrow, const Expr *Base);
3660 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003661 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3662 llvm::Value *memberPtr,
3663 const MemberPointerType *memberPtrType,
Ivan A. Kosarev229a6d82017-10-13 16:38:32 +00003664 LValueBaseInfo *BaseInfo = nullptr,
3665 TBAAAccessInfo *TBAAInfo = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003666 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3667 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003668
Anders Carlsson4034a952009-05-27 04:18:27 +00003669 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003670 const CXXMethodDecl *MD,
3671 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003672 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003673
Peter Collingbournefe883422011-10-06 18:29:37 +00003674 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3675 ReturnValueSlot ReturnValue);
3676
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003677 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3678 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003679
Mike Stump11289f42009-09-09 15:08:12 +00003680 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Peter Collingbournef7706832014-12-12 23:41:25 +00003681 unsigned BuiltinID, const CallExpr *E,
3682 ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003683
Sanjay Patelad823902018-08-19 16:50:30 +00003684 RValue emitRotate(const CallExpr *E, bool IsRotateRight);
3685
Akira Hatanaka6b103bc2017-10-06 07:12:46 +00003686 /// Emit IR for __builtin_os_log_format.
3687 RValue emitBuiltinOSLogFormat(const CallExpr &E);
3688
3689 llvm::Function *generateBuiltinOSLogHelperFunction(
3690 const analyze_os_log::OSLogBufferLayout &Layout,
3691 CharUnits BufferAlignment);
3692
Anders Carlssonbfb36712009-12-24 21:13:40 +00003693 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003694
Mike Stumpfc496822009-02-08 23:14:22 +00003695 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3696 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003697 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3698
Kevin Qin1718af62013-11-14 02:45:18 +00003699 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3700 const llvm::CmpInst::Predicate Fp,
3701 const llvm::CmpInst::Predicate Ip,
3702 const llvm::Twine &Name = "");
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003703 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3704 llvm::Triple::ArchType Arch);
Tim Northover8fe03d62014-02-21 11:57:24 +00003705
3706 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3707 unsigned LLVMIntrinsic,
3708 unsigned AltLLVMIntrinsic,
3709 const char *NameHint,
3710 unsigned Modifier,
3711 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003712 SmallVectorImpl<llvm::Value *> &Ops,
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003713 Address PtrOp0, Address PtrOp1,
3714 llvm::Triple::ArchType Arch);
Simon Tatham89e31fa2018-05-30 07:54:05 +00003715
3716 llvm::Value *EmitISOVolatileLoad(const CallExpr *E);
3717 llvm::Value *EmitISOVolatileStore(const CallExpr *E);
3718
Tim Northover8fe03d62014-02-21 11:57:24 +00003719 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3720 unsigned Modifier, llvm::Type *ArgTy,
3721 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003722 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003723 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003724 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003725 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003726 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003727 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003728 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003729 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3730 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003731 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003732 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3733 llvm::Triple::ArchType Arch);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003734
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003735 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003736 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3737 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003738 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003739 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003740 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003741 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3742 const CallExpr *E);
Krzysztof Parzyszek5a655832017-12-13 19:56:03 +00003743 llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003744
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003745private:
3746 enum class MSVCIntrin;
3747
3748public:
3749 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3750
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003751 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3752
Daniel Dunbar66912a12008-08-20 00:28:19 +00003753 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003754 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003755 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003756 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3757 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3758 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003759 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003760 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003761 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3762 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003763
John McCall31168b02011-06-15 23:02:42 +00003764 /// Retrieves the default cleanup kind for an ARC cleanup.
3765 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3766 CleanupKind getARCCleanupKind() {
3767 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3768 ? NormalAndEHCleanup : NormalCleanup;
3769 }
3770
3771 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003772 void EmitARCInitWeak(Address addr, llvm::Value *value);
3773 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003774 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003775 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3776 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
Akira Hatanakad791e922018-03-19 17:38:40 +00003777 void emitARCCopyAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
3778 void emitARCMoveAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
John McCall7f416cc2015-09-08 08:05:57 +00003779 void EmitARCCopyWeak(Address dst, Address src);
3780 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003781 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3782 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003783 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003784 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003785 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003786 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003787 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003788 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003789 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003790 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003791 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003792 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003793 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3794 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3795 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003796 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003797
3798 std::pair<LValue,llvm::Value*>
3799 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3800 std::pair<LValue,llvm::Value*>
3801 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003802 std::pair<LValue,llvm::Value*>
3803 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003804
John McCall248512a2011-10-01 10:32:24 +00003805 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003806 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3807 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3808
John McCallff613032011-10-04 06:23:45 +00003809 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003810 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3811 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003812 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3813 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003814 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003815
Craig Topper00bbdcf2014-06-28 23:22:23 +00003816 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003817
John McCall82fe67b2011-07-09 01:37:26 +00003818 static Destroyer destroyARCStrongImprecise;
3819 static Destroyer destroyARCStrongPrecise;
3820 static Destroyer destroyARCWeak;
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00003821 static Destroyer emitARCIntrinsicUse;
Akira Hatanaka7275da02018-02-28 07:15:55 +00003822 static Destroyer destroyNonTrivialCStruct;
John McCall82fe67b2011-07-09 01:37:26 +00003823
Gor Nishanov04491bd2017-11-11 17:00:43 +00003824 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003825 llvm::Value *EmitObjCAutoreleasePoolPush();
3826 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3827 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003828 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003829
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003830 /// Emits a reference binding to the passed in expression.
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003831 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003832
Chris Lattner6278e6a2007-08-11 00:04:45 +00003833 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003834 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003835 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003836
3837 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003838
3839 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3840 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003841 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003842
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003843 /// Emit a conversion from the specified type to the specified destination
3844 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003845 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003846 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003847
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003848 /// Emit a conversion from the specified complex type to the specified
3849 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003850 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003851 QualType DstTy,
3852 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003853
John McCall7a626f62010-09-15 10:14:12 +00003854 /// EmitAggExpr - Emit the computation of the specified expression
3855 /// of aggregate type. The result is computed into the given slot,
3856 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003857 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003858
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003859 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3860 /// aggregate type into a temporary LValue.
3861 LValue EmitAggExprToLValue(const Expr *E);
3862
John McCall1bd25562011-06-24 23:21:27 +00003863 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3864 /// make sure it survives garbage collection until this point.
3865 void EmitExtendGCLifetime(llvm::Value *object);
3866
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003867 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003868 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003869 ComplexPairTy EmitComplexExpr(const Expr *E,
3870 bool IgnoreReal = false,
3871 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003872
John McCall47fb9502013-03-07 21:37:08 +00003873 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3874 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003875 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003876
John McCall47fb9502013-03-07 21:37:08 +00003877 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003878 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003879
3880 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003881 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003882
John McCall7f416cc2015-09-08 08:05:57 +00003883 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3884 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3885
Chandler Carruth84537952012-03-30 19:44:53 +00003886 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3887 /// global variable that has already been created for it. If the initializer
3888 /// has a different type than GV does, this may free GV and return a different
3889 /// one. Otherwise it just returns GV.
3890 llvm::GlobalVariable *
3891 AddInitializerToStaticVarDecl(const VarDecl &D,
3892 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003893
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003894
Anders Carlssonf40886a2009-08-08 21:45:14 +00003895 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3896 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003897 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3898 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003899
David Majnemerb3341ea2014-10-05 05:05:40 +00003900 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3901 llvm::Constant *Addr);
3902
John McCallc84ed6a2012-05-01 06:13:13 +00003903 /// Call atexit() with a function that passes the given argument to
3904 /// the given function.
David Blaikieebe87e12013-08-27 23:57:18 +00003905 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3906 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003907
Akira Hatanaka617e2612018-04-17 18:41:52 +00003908 /// Call atexit() with function dtorStub.
3909 void registerGlobalDtorWithAtExit(llvm::Constant *dtorStub);
3910
John McCallcdf7ef52010-11-06 09:44:32 +00003911 /// Emit code in this function to perform a guarded variable
3912 /// initialization. Guarded initializations are used when it's not
3913 /// possible to prove that an initialization will be done exactly
3914 /// once, e.g. with a static local variable or a static data member
3915 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003916 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003917 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003918
Richard Smithae8d62c2017-07-26 22:01:09 +00003919 enum class GuardKind { VariableGuard, TlsGuard };
3920
3921 /// Emit a branch to select whether or not to perform guarded initialization.
3922 void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
3923 llvm::BasicBlock *InitBlock,
3924 llvm::BasicBlock *NoInitBlock,
3925 GuardKind Kind, const VarDecl *D);
3926
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003927 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3928 /// variables.
3929 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +00003930 ArrayRef<llvm::Function *> CXXThreadLocals,
John McCall7f416cc2015-09-08 08:05:57 +00003931 Address Guard = Address::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003932
John McCallee08c532012-04-06 18:21:03 +00003933 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003934 /// variables.
Sanjoy Dase369bd92017-05-01 17:08:00 +00003935 void GenerateCXXGlobalDtorsFunc(
3936 llvm::Function *Fn,
3937 const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
3938 &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003939
John McCalla738c252011-03-09 04:27:21 +00003940 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3941 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003942 llvm::GlobalVariable *Addr,
3943 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003944
John McCall7a626f62010-09-15 10:14:12 +00003945 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003946
John McCall7f416cc2015-09-08 08:05:57 +00003947 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003948
John McCall08ef4662011-11-10 08:15:53 +00003949 void enterFullExpression(const ExprWithCleanups *E) {
3950 if (E->getNumObjects() == 0) return;
3951 enterNonTrivialFullExpression(E);
3952 }
3953 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00003954
Richard Smithea852322013-05-07 21:53:22 +00003955 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003956
Eli Friedmanc370a7e2012-02-09 03:32:31 +00003957 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3958
Tim Northovercc2a6e02015-11-09 19:56:35 +00003959 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003960
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003961 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003962 // Annotations Emission
3963 //===--------------------------------------------------------------------===//
3964
3965 /// Emit an annotation call (intrinsic or builtin).
3966 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3967 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003968 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003969 SourceLocation Location);
3970
3971 /// Emit local annotations for the local variable V, declared by D.
3972 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3973
3974 /// Emit field annotations for the given field & value. Returns the
3975 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00003976 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003977
3978 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003979 // Internal Helpers
3980 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00003981
Chris Lattner5b1964b2008-11-11 07:41:27 +00003982 /// ContainsLabel - Return true if the statement contains a label in it. If
3983 /// this statement is not executed normally, it not containing a label means
3984 /// that we can just remove the code.
3985 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003986
Chris Lattner29911cc2011-02-28 00:18:40 +00003987 /// containsBreak - Return true if the statement contains a break out of it.
3988 /// If the statement (recursively) contains a switch or loop with a break
3989 /// inside of it, this is fine.
3990 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00003991
3992 /// Determine if the given statement might introduce a declaration into the
3993 /// current scope, by being a (possibly-labelled) DeclStmt.
3994 static bool mightAddDeclToScope(const Stmt *S);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003995
Daniel Dunbar682712c2008-11-12 10:12:14 +00003996 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00003997 /// to a constant, or if it does but contains a label, return false. If it
3998 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00003999 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
4000 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00004001
Chris Lattner29911cc2011-02-28 00:18:40 +00004002 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
4003 /// to a constant, or if it does but contains a label, return false. If it
4004 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00004005 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
4006 bool AllowLabels = false);
4007
Chris Lattnercd439292008-11-12 08:04:58 +00004008 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
4009 /// if statement) to the specified blocks. Based on the condition, this might
4010 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00004011 /// TrueCount should be the number of times we expect the condition to
4012 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00004013 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00004014 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00004015
Vedant Kumar42c17ec2017-03-14 01:56:34 +00004016 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
4017 /// nonnull, if \p LHS is marked _Nonnull.
4018 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
4019
Vedant Kumar175b6d12017-07-13 20:55:26 +00004020 /// An enumeration which makes it easier to specify whether or not an
4021 /// operation is a subtraction.
4022 enum { NotSubtraction = false, IsSubtraction = true };
4023
Vedant Kumara125eb52017-06-01 19:22:18 +00004024 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
4025 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
Vedant Kumar6dbf4272017-06-12 18:42:51 +00004026 /// \p SignedIndices indicates whether any of the GEP indices are signed.
Vedant Kumar175b6d12017-07-13 20:55:26 +00004027 /// \p IsSubtraction indicates whether the expression used to form the GEP
4028 /// is a subtraction.
Vedant Kumara125eb52017-06-01 19:22:18 +00004029 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
4030 ArrayRef<llvm::Value *> IdxList,
Vedant Kumar6dbf4272017-06-12 18:42:51 +00004031 bool SignedIndices,
Vedant Kumar175b6d12017-07-13 20:55:26 +00004032 bool IsSubtraction,
Vedant Kumara125eb52017-06-01 19:22:18 +00004033 SourceLocation Loc,
4034 const Twine &Name = "");
4035
Vedant Kumar10c31022017-07-29 00:19:51 +00004036 /// Specifies which type of sanitizer check to apply when handling a
4037 /// particular builtin.
4038 enum BuiltinCheckKind {
4039 BCK_CTZPassedZero,
4040 BCK_CLZPassedZero,
4041 };
4042
4043 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
4044 /// enabled, a runtime check specified by \p Kind is also emitted.
4045 llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
4046
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004047 /// Emit a description of a type in a format suitable for passing to
Richard Smithe30752c2012-10-09 19:52:38 +00004048 /// a runtime sanitizer handler.
4049 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
4050
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004051 /// Convert a value into a format suitable for passing to a runtime
Richard Smithe30752c2012-10-09 19:52:38 +00004052 /// sanitizer handler.
4053 llvm::Value *EmitCheckValue(llvm::Value *V);
4054
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004055 /// Emit a description of a source location in a format suitable for
Richard Smithe30752c2012-10-09 19:52:38 +00004056 /// passing to a runtime sanitizer handler.
4057 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
4058
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004059 /// Create a basic block that will call a handler function in a
Richard Smithde670682012-11-01 22:15:34 +00004060 /// sanitizer runtime with the provided arguments, and create a conditional
4061 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00004062 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00004063 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00004064 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004065
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004066 /// Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00004067 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00004068 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
4069 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
4070 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00004071
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004072 /// Emit a reached-unreachable diagnostic if \p Loc is valid and runtime
4073 /// checking is enabled. Otherwise, just emit an unreachable instruction.
4074 void EmitUnreachable(SourceLocation Loc);
4075
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004076 /// Create a basic block that will call the trap intrinsic, and emit a
Richard Smithde670682012-11-01 22:15:34 +00004077 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00004078 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00004079
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004080 /// Emit a call to trap or debugtrap and attach function attribute
Akira Hatanaka85365cd2015-07-02 22:15:41 +00004081 /// "trap-func-name" if specified.
4082 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
4083
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004084 /// Emit a stub for the cross-DSO CFI check function.
Evgeniy Stepanov1a8030e2017-04-07 23:00:38 +00004085 void EmitCfiCheckStub();
4086
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004087 /// Emit a cross-DSO CFI failure handling function.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00004088 void EmitCfiCheckFail();
4089
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004090 /// Create a check for a function parameter that may potentially be
Nuno Lopes1ba2d782015-05-30 16:11:40 +00004091 /// declared as non-null.
4092 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00004093 AbstractCallee AC, unsigned ParmNum);
Nuno Lopes1ba2d782015-05-30 16:11:40 +00004094
Anders Carlsson093bdff2010-03-30 03:27:09 +00004095 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00004096 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00004097
John McCall23f66262010-05-26 22:34:26 +00004098 /// EmitDelegateCallArg - We are performing a delegate call; that
4099 /// is, the current function is delegating to another one. Produce
4100 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00004101 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
4102 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00004103
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00004104 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
4105 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00004106 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00004107
Chris Lattnercd439292008-11-12 08:04:58 +00004108private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00004109 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00004110 void EmitReturnOfRValue(RValue RV, QualType Ty);
4111
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004112 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
4113
4114 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
4115 DeferredReplacements;
4116
John McCall7f416cc2015-09-08 08:05:57 +00004117 /// Set the address of a local variable.
4118 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
4119 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
4120 LocalDeclMap.insert({VD, Addr});
4121 }
4122
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004123 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
4124 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
4125 ///
4126 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004127 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00004128 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004129
Yaxun Liu5b330e82018-03-15 15:25:19 +00004130 /// ExpandTypeToArgs - Expand an CallArg \arg Arg, with the LLVM type for \arg
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004131 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
4132 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
Yaxun Liu5b330e82018-03-15 15:25:19 +00004133 void ExpandTypeToArgs(QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004134 SmallVectorImpl<llvm::Value *> &IRCallArgs,
4135 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00004136
Chad Rosier59df25b2012-08-23 20:00:18 +00004137 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00004138 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00004139
Chad Rosier59df25b2012-08-23 20:00:18 +00004140 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00004141 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00004142 std::string &ConstraintStr,
4143 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00004144
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004145 /// Attempts to statically evaluate the object size of E. If that
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004146 /// fails, emits code to figure the size of E out for us. This is
4147 /// pass_object_size aware.
George Burgess IV0d6592a2017-02-23 05:59:56 +00004148 ///
4149 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004150 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00004151 llvm::IntegerType *ResType,
4152 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004153
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004154 /// Emits the size of E, as required by __builtin_object_size. This
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004155 /// function is aware of pass_object_size parameters, and will act accordingly
4156 /// if E is a parameter with the pass_object_size attribute.
4157 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00004158 llvm::IntegerType *ResType,
4159 llvm::Value *EmittedE);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004160
Reid Kleckner89077a12013-12-17 19:46:40 +00004161public:
Douglas Gregore83b9562015-07-07 03:57:53 +00004162#ifndef NDEBUG
4163 // Determine whether the given argument is an Objective-C method
4164 // that may have type parameters in its signature.
4165 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
4166 const DeclContext *dc = method->getDeclContext();
4167 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
4168 return classDecl->getTypeParamListAsWritten();
4169 }
4170
4171 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
4172 return catDecl->getTypeParamList();
4173 }
4174
4175 return false;
4176 }
4177
4178 template<typename T>
4179 static bool isObjCMethodWithTypeParams(const T *) { return false; }
4180#endif
4181
Richard Smitha560ccf2016-09-29 21:30:12 +00004182 enum class EvaluationOrder {
4183 ///! No language constraints on evaluation order.
4184 Default,
4185 ///! Language semantics require left-to-right evaluation.
4186 ForceLeftToRight,
4187 ///! Language semantics require right-to-left evaluation.
4188 ForceRightToLeft
4189 };
4190
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00004191 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00004192 template <typename T>
4193 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00004194 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00004195 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00004196 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00004197 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00004198 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00004199 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00004200
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004201 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
4202 "Can't skip parameters if type info is not provided");
4203 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00004204#ifndef NDEBUG
4205 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
4206#endif
4207
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004208 // First, use the argument types that the type info knows about
4209 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
4210 E = CallArgTypeInfo->param_type_end();
4211 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00004212 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00004213 assert((isGenericMethod ||
4214 ((*I)->isVariablyModifiedType() ||
4215 (*I).getNonReferenceType()->isObjCRetainableType() ||
4216 getContext()
4217 .getCanonicalType((*I).getNonReferenceType())
4218 .getTypePtr() ==
4219 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00004220 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00004221 .getTypePtr())) &&
4222 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004223 ArgTypes.push_back(*I);
4224 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00004225 }
Mike Stump11289f42009-09-09 15:08:12 +00004226
Reid Kleckner739756c2013-12-04 19:23:12 +00004227 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004228 // function.
David Blaikief05779e2015-07-21 18:37:18 +00004229 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
4230 CallArgTypeInfo->isVariadic()) &&
4231 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00004232
Anders Carlsson603d6af2009-04-18 20:20:22 +00004233 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00004234 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00004235 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00004236
Vedant Kumared00ea02017-03-06 05:28:22 +00004237 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00004238 }
John McCalld4f4b7f2010-03-03 04:15:11 +00004239
Reid Kleckner739756c2013-12-04 19:23:12 +00004240 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00004241 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00004242 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00004243 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00004244 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00004245
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00004246 /// EmitPointerWithAlignment - Given an expression with a pointer type,
4247 /// emit the value and compute our best estimate of the alignment of the
4248 /// pointee.
John McCall7f416cc2015-09-08 08:05:57 +00004249 ///
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00004250 /// \param BaseInfo - If non-null, this will be initialized with
4251 /// information about the source of the alignment and the may-alias
4252 /// attribute. Note that this function will conservatively fall back on
4253 /// the type when it doesn't recognize the expression and may-alias will
4254 /// be set to false.
4255 ///
4256 /// One reasonable way to use this information is when there's a language
4257 /// guarantee that the pointer must be aligned to some stricter value, and
4258 /// we're simply trying to ensure that sufficiently obvious uses of under-
4259 /// aligned objects don't get miscompiled; for example, a placement new
4260 /// into the address of a local variable. In such a case, it's quite
4261 /// reasonable to just ignore the returned alignment when it isn't from an
4262 /// explicit source.
John McCall7f416cc2015-09-08 08:05:57 +00004263 Address EmitPointerWithAlignment(const Expr *Addr,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00004264 LValueBaseInfo *BaseInfo = nullptr,
4265 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00004266
Vedant Kumar36347d92017-12-08 01:51:47 +00004267 /// If \p E references a parameter with pass_object_size info or a constant
4268 /// array size modifier, emit the object size divided by the size of \p EltTy.
4269 /// Otherwise return null.
4270 llvm::Value *LoadPassedObjectSize(const Expr *E, QualType EltTy);
4271
Peter Collingbournedc134532016-01-16 00:31:22 +00004272 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
4273
Erich Keanef353ae12018-09-13 16:58:24 +00004274 struct MultiVersionResolverOption {
Erich Keane281d20b2018-01-08 21:34:17 +00004275 llvm::Function *Function;
Erich Keanef353ae12018-09-13 16:58:24 +00004276 struct Conds {
4277 StringRef Architecture;
4278 llvm::SmallVector<StringRef, 8> Features;
Erich Keane281d20b2018-01-08 21:34:17 +00004279
Erich Keanef353ae12018-09-13 16:58:24 +00004280 Conds(StringRef Arch, ArrayRef<StringRef> Feats)
4281 : Architecture(Arch), Features(Feats.begin(), Feats.end()) {}
4282 } Conditions;
Erich Keane281d20b2018-01-08 21:34:17 +00004283
Erich Keanef353ae12018-09-13 16:58:24 +00004284 MultiVersionResolverOption(llvm::Function *F, StringRef Arch,
4285 ArrayRef<StringRef> Feats)
4286 : Function(F), Conditions(Arch, Feats) {}
Erich Keane281d20b2018-01-08 21:34:17 +00004287 };
Erich Keanef353ae12018-09-13 16:58:24 +00004288
4289 // Emits the body of a multiversion function's resolver. Assumes that the
4290 // options are already sorted in the proper order, with the 'default' option
4291 // last (if it exists).
4292 void EmitMultiVersionResolver(llvm::Function *Resolver,
4293 ArrayRef<MultiVersionResolverOption> Options);
Erich Keane3efe0022018-07-20 14:13:28 +00004294
4295 struct CPUDispatchMultiVersionResolverOption {
4296 llvm::Function *Function;
4297 // Note: EmitX86CPUSupports only has 32 bits available, so we store the mask
4298 // as 32 bits here. When 64-bit support is added to __builtin_cpu_supports,
4299 // this can be extended to 64 bits.
4300 uint32_t FeatureMask;
4301 CPUDispatchMultiVersionResolverOption(llvm::Function *F, uint64_t Mask)
4302 : Function(F), FeatureMask(static_cast<uint32_t>(Mask)) {}
4303 bool operator>(const CPUDispatchMultiVersionResolverOption &Other) const {
4304 return FeatureMask > Other.FeatureMask;
4305 }
4306 };
4307 void EmitCPUDispatchMultiVersionResolver(
4308 llvm::Function *Resolver,
4309 ArrayRef<CPUDispatchMultiVersionResolverOption> Options);
4310 static uint32_t GetX86CpuSupportsMask(ArrayRef<StringRef> FeatureStrs);
Erich Keane281d20b2018-01-08 21:34:17 +00004311
Reid Kleckner89077a12013-12-17 19:46:40 +00004312private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004313 QualType getVarArgType(const Expr *Arg);
4314
John McCall09ae0322010-07-06 23:57:41 +00004315 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00004316
John McCall7f416cc2015-09-08 08:05:57 +00004317 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
4318 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00004319
4320 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00004321
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00004322 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Erich Keane9937b132017-09-01 19:42:45 +00004323 llvm::Value *EmitX86CpuIs(const CallExpr *E);
4324 llvm::Value *EmitX86CpuIs(StringRef CPUStr);
4325 llvm::Value *EmitX86CpuSupports(const CallExpr *E);
4326 llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
Erich Keane3efe0022018-07-20 14:13:28 +00004327 llvm::Value *EmitX86CpuSupports(uint32_t Mask);
Erich Keane1fe643a2017-10-06 16:40:45 +00004328 llvm::Value *EmitX86CpuInit();
Erich Keanef353ae12018-09-13 16:58:24 +00004329 llvm::Value *FormResolverCondition(const MultiVersionResolverOption &RO);
Chris Lattnerbed31442007-05-28 01:07:47 +00004330};
Mike Stump11289f42009-09-09 15:08:12 +00004331
Richard Smithf66e4f72018-07-23 22:56:45 +00004332inline DominatingLLVMValue::saved_type
4333DominatingLLVMValue::save(CodeGenFunction &CGF, llvm::Value *value) {
4334 if (!needsSaving(value)) return saved_type(value, false);
John McCallce1de612011-01-26 04:00:11 +00004335
Richard Smithf66e4f72018-07-23 22:56:45 +00004336 // Otherwise, we need an alloca.
4337 auto align = CharUnits::fromQuantity(
4338 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
4339 Address alloca =
4340 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
4341 CGF.Builder.CreateStore(value, alloca);
John McCallce1de612011-01-26 04:00:11 +00004342
Richard Smithf66e4f72018-07-23 22:56:45 +00004343 return saved_type(alloca.getPointer(), true);
4344}
John McCallce1de612011-01-26 04:00:11 +00004345
Richard Smithf66e4f72018-07-23 22:56:45 +00004346inline llvm::Value *DominatingLLVMValue::restore(CodeGenFunction &CGF,
4347 saved_type value) {
4348 // If the value says it wasn't saved, trust that it's still dominating.
4349 if (!value.getInt()) return value.getPointer();
John McCallce1de612011-01-26 04:00:11 +00004350
Richard Smithf66e4f72018-07-23 22:56:45 +00004351 // Otherwise, it should be an alloca instruction, as set up in save().
4352 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
4353 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
4354}
John McCallce1de612011-01-26 04:00:11 +00004355
Chris Lattnerbed31442007-05-28 01:07:47 +00004356} // end namespace CodeGen
4357} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00004358
Chris Lattnerbed31442007-05-28 01:07:47 +00004359#endif