blob: c24fc77d6d3e8a546e5906f3a2f3142d173bb2c3 [file] [log] [blame]
Daniel Dunbar9c426522008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Chris Lattnerbed31442007-05-28 01:07:47 +00002//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Chris Lattnerbed31442007-05-28 01:07:47 +00006//
7//===----------------------------------------------------------------------===//
8//
Mike Stumpfc496822009-02-08 23:14:22 +00009// This is the internal per-function state used for llvm translation.
Chris Lattnerbed31442007-05-28 01:07:47 +000010//
11//===----------------------------------------------------------------------===//
12
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000013#ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
14#define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
Chris Lattnerbed31442007-05-28 01:07:47 +000015
Daniel Dunbarcb463852008-11-01 01:53:16 +000016#include "CGBuilder.h"
Eric Christophera9d34972011-10-19 00:43:52 +000017#include "CGDebugInfo.h"
Alexander Musman515ad8c2014-05-22 08:54:05 +000018#include "CGLoopInfo.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000019#include "CGValue.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000020#include "CodeGenModule.h"
Justin Bogneref512b92014-01-06 22:27:43 +000021#include "CodeGenPGO.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000022#include "EHScopeStack.h"
Vitaly Buka64c80b42016-10-26 05:42:30 +000023#include "VarBypassDetector.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000024#include "clang/AST/CharUnits.h"
25#include "clang/AST/ExprCXX.h"
26#include "clang/AST/ExprObjC.h"
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +000027#include "clang/AST/ExprOpenMP.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000028#include "clang/AST/Type.h"
29#include "clang/Basic/ABI.h"
Ben Langmuir3b4c30b2013-05-09 19:17:11 +000030#include "clang/Basic/CapturedStmt.h"
Richard Trieu63688182018-12-11 03:18:39 +000031#include "clang/Basic/CodeGenOptions.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"
Chandler Carruth3a022472012-12-04 09:13:33 +000034#include "llvm/ADT/ArrayRef.h"
35#include "llvm/ADT/DenseMap.h"
Reid Kleckner06f19a02018-01-02 21:34:16 +000036#include "llvm/ADT/MapVector.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000037#include "llvm/ADT/SmallVector.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000038#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000039#include "llvm/Support/Debug.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000040#include "llvm/Transforms/Utils/SanitizerStats.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000041
Chris Lattnerbed31442007-05-28 01:07:47 +000042namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000043class BasicBlock;
44class LLVMContext;
45class MDNode;
46class Module;
47class SwitchInst;
48class Twine;
49class Value;
Chris Lattner23b7eb62007-06-15 23:05:46 +000050}
51
Chris Lattnerbed31442007-05-28 01:07:47 +000052namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000053class ASTContext;
54class BlockDecl;
55class CXXDestructorDecl;
56class CXXForRangeStmt;
57class CXXTryStmt;
58class Decl;
59class LabelDecl;
60class EnumConstantDecl;
61class FunctionDecl;
62class FunctionProtoType;
63class LabelStmt;
64class ObjCContainerDecl;
65class ObjCInterfaceDecl;
66class ObjCIvarDecl;
67class ObjCMethodDecl;
68class ObjCImplementationDecl;
69class ObjCPropertyImplDecl;
70class TargetInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000071class VarDecl;
72class ObjCForCollectionStmt;
73class ObjCAtTryStmt;
74class ObjCAtThrowStmt;
75class ObjCAtSynchronizedStmt;
76class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000077
Akira Hatanaka6b103bc2017-10-06 07:12:46 +000078namespace analyze_os_log {
79class OSLogBufferLayout;
80}
81
Chris Lattnerbed31442007-05-28 01:07:47 +000082namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000083class CodeGenTypes;
John McCallb92ab1a2016-10-26 23:46:34 +000084class CGCallee;
Rafael Espindola42ae7452014-05-09 00:57:59 +000085class CGFunctionInfo;
86class CGRecordLayout;
87class CGBlockInfo;
88class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000089class BlockByrefHelpers;
90class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000091class BlockFlags;
92class BlockFieldFlags;
Alexey Bataev7292c292016-04-25 12:22:29 +000093class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000094class TargetCodeGenInfo;
Alexey Bataev24b5bae2016-04-28 09:23:51 +000095struct OMPTaskDataTy;
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000096struct CGCoroData;
Mike Stumpfc496822009-02-08 23:14:22 +000097
John McCall47fb9502013-03-07 21:37:08 +000098/// The kind of evaluation to perform on values of a particular
99/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
100/// CGExprAgg?
101///
102/// TODO: should vectors maybe be split out into their own thing?
103enum TypeEvaluationKind {
104 TEK_Scalar,
105 TEK_Complex,
106 TEK_Aggregate
107};
108
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000109#define LIST_SANITIZER_CHECKS \
110 SANITIZER_CHECK(AddOverflow, add_overflow, 0) \
111 SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \
112 SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \
113 SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \
114 SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \
115 SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \
116 SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0) \
Roman Lebedevb69ba222018-07-30 18:58:30 +0000117 SANITIZER_CHECK(ImplicitConversion, implicit_conversion, 0) \
Vedant Kumar10c31022017-07-29 00:19:51 +0000118 SANITIZER_CHECK(InvalidBuiltin, invalid_builtin, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000119 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
120 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
121 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
122 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000123 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000124 SANITIZER_CHECK(NullabilityReturn, nullability_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000125 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000126 SANITIZER_CHECK(NonnullReturn, nonnull_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000127 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
Vedant Kumara125eb52017-06-01 19:22:18 +0000128 SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000129 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
130 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
Filipe Cabecinhasfe5e5af2017-01-06 14:40:12 +0000131 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
Roman Lebedevbd1c0872019-01-15 09:44:25 +0000132 SANITIZER_CHECK(AlignmentAssumption, alignment_assumption, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000133 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
134
135enum SanitizerHandler {
136#define SANITIZER_CHECK(Enum, Name, Version) Enum,
137 LIST_SANITIZER_CHECKS
138#undef SANITIZER_CHECK
139};
140
Richard Smithf66e4f72018-07-23 22:56:45 +0000141/// Helper class with most of the code for saving a value for a
142/// conditional expression cleanup.
143struct DominatingLLVMValue {
144 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
145
146 /// Answer whether the given value needs extra work to be saved.
147 static bool needsSaving(llvm::Value *value) {
148 // If it's not an instruction, we don't need to save.
149 if (!isa<llvm::Instruction>(value)) return false;
150
151 // If it's an instruction in the entry block, we don't need to save.
152 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
153 return (block != &block->getParent()->getEntryBlock());
154 }
155
156 static saved_type save(CodeGenFunction &CGF, llvm::Value *value);
157 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value);
158};
159
160/// A partial specialization of DominatingValue for llvm::Values that
161/// might be llvm::Instructions.
162template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
163 typedef T *type;
164 static type restore(CodeGenFunction &CGF, saved_type value) {
165 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
166 }
167};
168
169/// A specialization of DominatingValue for Address.
170template <> struct DominatingValue<Address> {
171 typedef Address type;
172
173 struct saved_type {
174 DominatingLLVMValue::saved_type SavedValue;
175 CharUnits Alignment;
176 };
177
178 static bool needsSaving(type value) {
179 return DominatingLLVMValue::needsSaving(value.getPointer());
180 }
181 static saved_type save(CodeGenFunction &CGF, type value) {
182 return { DominatingLLVMValue::save(CGF, value.getPointer()),
183 value.getAlignment() };
184 }
185 static type restore(CodeGenFunction &CGF, saved_type value) {
186 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
187 value.Alignment);
188 }
189};
190
191/// A specialization of DominatingValue for RValue.
192template <> struct DominatingValue<RValue> {
193 typedef RValue type;
194 class saved_type {
195 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
196 AggregateAddress, ComplexAddress };
197
198 llvm::Value *Value;
199 unsigned K : 3;
200 unsigned Align : 29;
201 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
202 : Value(v), K(k), Align(a) {}
203
204 public:
205 static bool needsSaving(RValue value);
206 static saved_type save(CodeGenFunction &CGF, RValue value);
207 RValue restore(CodeGenFunction &CGF);
208
209 // implementations in CGCleanup.cpp
210 };
211
212 static bool needsSaving(type value) {
213 return saved_type::needsSaving(value);
214 }
215 static saved_type save(CodeGenFunction &CGF, type value) {
216 return saved_type::save(CGF, value);
217 }
218 static type restore(CodeGenFunction &CGF, saved_type value) {
219 return value.restore(CGF);
220 }
221};
222
Chris Lattnerbed31442007-05-28 01:07:47 +0000223/// CodeGenFunction - This class organizes the per-function state that is used
224/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000225class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000226 CodeGenFunction(const CodeGenFunction &) = delete;
227 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000228
229 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000230public:
John McCallad5d61e2010-07-23 21:56:41 +0000231 /// A jump destination is an abstract label, branching to which may
232 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000233 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000234 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000235 JumpDest(llvm::BasicBlock *Block,
236 EHScopeStack::stable_iterator Depth,
237 unsigned Index)
238 : Block(Block), ScopeDepth(Depth), Index(Index) {}
239
Craig Topper8a13c412014-05-21 05:09:00 +0000240 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000241 llvm::BasicBlock *getBlock() const { return Block; }
242 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
243 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000244
Nadav Rotem1da30942013-03-23 06:43:35 +0000245 // This should be used cautiously.
246 void setScopeDepth(EHScopeStack::stable_iterator depth) {
247 ScopeDepth = depth;
248 }
249
John McCallad5d61e2010-07-23 21:56:41 +0000250 private:
John McCallbd309292010-07-06 01:34:17 +0000251 llvm::BasicBlock *Block;
252 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000253 unsigned Index;
254 };
255
Chris Lattnerbed31442007-05-28 01:07:47 +0000256 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000257 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000258
Chris Lattner96d72562007-08-21 16:57:55 +0000259 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000260 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000261 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000262
Vitaly Buka64c80b42016-10-26 05:42:30 +0000263 // Stores variables for which we can't generate correct lifetime markers
264 // because of jumps.
265 VarBypassDetector Bypasses;
266
Carlo Bertollib0ff0a62017-04-25 17:52:12 +0000267 // CodeGen lambda for loops and support for ordered clause
268 typedef llvm::function_ref<void(CodeGenFunction &, const OMPLoopDirective &,
269 JumpDest)>
270 CodeGenLoopTy;
271 typedef llvm::function_ref<void(CodeGenFunction &, SourceLocation,
272 const unsigned, const bool)>
273 CodeGenOrderedTy;
274
275 // Codegen lambda for loop bounds in worksharing loop constructs
276 typedef llvm::function_ref<std::pair<LValue, LValue>(
277 CodeGenFunction &, const OMPExecutableDirective &S)>
278 CodeGenLoopBoundsTy;
279
280 // Codegen lambda for loop bounds in dispatch-based loop implementation
281 typedef llvm::function_ref<std::pair<llvm::Value *, llvm::Value *>(
282 CodeGenFunction &, const OMPExecutableDirective &S, Address LB,
283 Address UB)>
284 CodeGenDispatchBoundsTy;
285
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000286 /// CGBuilder insert helper. This function is called after an
Alexander Musman515ad8c2014-05-22 08:54:05 +0000287 /// instruction is created using Builder.
288 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
289 llvm::BasicBlock *BB,
290 llvm::BasicBlock::iterator InsertPt) const;
291
John McCalldec348f72013-05-03 07:33:41 +0000292 /// CurFuncDecl - Holds the Decl for the current outermost
293 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000294 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000295 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
296 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000297 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000298 QualType FnRetTy;
Erich Keanebe65e872018-07-10 21:07:50 +0000299 llvm::Function *CurFn = nullptr;
Chris Lattnerac248202007-05-30 00:13:02 +0000300
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000301 // Holds coroutine data if the current function is a coroutine. We use a
302 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
303 // in this header.
304 struct CGCoroInfo {
305 std::unique_ptr<CGCoroData> Data;
306 CGCoroInfo();
307 ~CGCoroInfo();
308 };
309 CGCoroInfo CurCoro;
310
Gor Nishanov04491bd2017-11-11 17:00:43 +0000311 bool isCoroutine() const {
312 return CurCoro.Data != nullptr;
313 }
314
Mike Stumpbee78dd2009-12-04 23:26:17 +0000315 /// CurGD - The GlobalDecl for the current function being compiled.
316 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000317
John McCall31168b02011-06-15 23:02:42 +0000318 /// PrologueCleanupDepth - The cleanup depth enclosing all the
319 /// cleanups associated with the parameters.
320 EHScopeStack::stable_iterator PrologueCleanupDepth;
321
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000322 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000323 JumpDest ReturnBlock;
324
John McCall7f416cc2015-09-08 08:05:57 +0000325 /// ReturnValue - The temporary alloca to hold the return
326 /// value. This is invalid iff the function has no return value.
Erich Keanebe65e872018-07-10 21:07:50 +0000327 Address ReturnValue = Address::invalid();
Mike Stumpfc496822009-02-08 23:14:22 +0000328
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000329 /// Return true if a label was seen in the current scope.
330 bool hasLabelBeenSeenInCurrentScope() const {
331 if (CurLexicalScope)
332 return CurLexicalScope->hasLabels();
333 return !LabelMap.empty();
334 }
335
Chris Lattner03df1222007-06-02 04:53:11 +0000336 /// AllocaInsertPoint - This is an instruction in the entry block before which
337 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000338 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000339
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000340 /// API for captured statement code generation.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000341 class CGCapturedStmtInfo {
342 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000343 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
344 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000345 explicit CGCapturedStmtInfo(const CapturedStmt &S,
346 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000347 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000348
349 RecordDecl::field_iterator Field =
350 S.getCapturedRecordDecl()->field_begin();
351 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
352 E = S.capture_end();
353 I != E; ++I, ++Field) {
354 if (I->capturesThis())
355 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000356 else if (I->capturesVariable())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000357 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000358 else if (I->capturesVariableByCopy())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000359 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000360 }
361 }
362
363 virtual ~CGCapturedStmtInfo();
364
365 CapturedRegionKind getKind() const { return Kind; }
366
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000367 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000368 // Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000369 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000370
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000371 /// Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000372 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000373 return CaptureFields.lookup(VD->getCanonicalDecl());
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000374 }
375
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000376 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
377 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000378
Alexey Bataev18095712014-10-10 12:19:54 +0000379 static bool classof(const CGCapturedStmtInfo *) {
380 return true;
381 }
382
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000383 /// Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000384 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000385 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000386 CGF.EmitStmt(S);
387 }
388
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000389 /// Get the name of the capture helper.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000390 virtual StringRef getHelperName() const { return "__captured_stmt"; }
391
392 private:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000393 /// The kind of captured statement being generated.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000394 CapturedRegionKind Kind;
395
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000396 /// Keep the map between VarDecl and FieldDecl.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000397 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
398
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000399 /// The base address of the captured record, passed in as the first
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000400 /// argument of the parallel region function.
401 llvm::Value *ThisValue;
402
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000403 /// Captured 'this' type.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000404 FieldDecl *CXXThisFieldDecl;
405 };
Erich Keanebe65e872018-07-10 21:07:50 +0000406 CGCapturedStmtInfo *CapturedStmtInfo = nullptr;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000407
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000408 /// RAII for correct setting/restoring of CapturedStmtInfo.
Alexey Bataevd157d472015-06-24 03:35:38 +0000409 class CGCapturedStmtRAII {
410 private:
411 CodeGenFunction &CGF;
412 CGCapturedStmtInfo *PrevCapturedStmtInfo;
413 public:
414 CGCapturedStmtRAII(CodeGenFunction &CGF,
415 CGCapturedStmtInfo *NewCapturedStmtInfo)
416 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
417 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
418 }
419 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
420 };
421
Vedant Kumared00ea02017-03-06 05:28:22 +0000422 /// An abstract representation of regular/ObjC call/message targets.
423 class AbstractCallee {
424 /// The function declaration of the callee.
425 const Decl *CalleeDecl;
426
427 public:
428 AbstractCallee() : CalleeDecl(nullptr) {}
429 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
430 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
431 bool hasFunctionDecl() const {
432 return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
433 }
434 const Decl *getDecl() const { return CalleeDecl; }
435 unsigned getNumParams() const {
436 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
437 return FD->getNumParams();
438 return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
439 }
440 const ParmVarDecl *getParamDecl(unsigned I) const {
441 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
442 return FD->getParamDecl(I);
443 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
444 }
445 };
446
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000447 /// Sanitizers enabled for this function.
Alexey Samsonova0416102014-11-11 01:26:14 +0000448 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000449
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000450 /// True if CodeGen currently emits code implementing sanitizer checks.
Erich Keanebe65e872018-07-10 21:07:50 +0000451 bool IsSanitizerScope = false;
Alexey Samsonov24cad992014-07-17 18:46:27 +0000452
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000453 /// RAII object to set/unset CodeGenFunction::IsSanitizerScope.
Alexey Samsonov24cad992014-07-17 18:46:27 +0000454 class SanitizerScope {
455 CodeGenFunction *CGF;
456 public:
457 SanitizerScope(CodeGenFunction *CGF);
458 ~SanitizerScope();
459 };
460
Reid Kleckner19819442014-07-25 21:39:46 +0000461 /// In C++, whether we are code generating a thunk. This controls whether we
462 /// should emit cleanups.
Erich Keanebe65e872018-07-10 21:07:50 +0000463 bool CurFuncIsThunk = false;
Reid Kleckner19819442014-07-25 21:39:46 +0000464
John McCall31168b02011-06-15 23:02:42 +0000465 /// In ARC, whether we should autorelease the return value.
Erich Keanebe65e872018-07-10 21:07:50 +0000466 bool AutoreleaseResult = false;
John McCall31168b02011-06-15 23:02:42 +0000467
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000468 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
469 /// potentially set the return value.
Erich Keanebe65e872018-07-10 21:07:50 +0000470 bool SawAsmBlock = false;
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000471
David Chisnall93ce0182018-08-10 12:53:13 +0000472 const NamedDecl *CurSEHParent = nullptr;
David Majnemer25eb1652016-03-01 19:42:53 +0000473
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000474 /// True if the current function is an outlined SEH helper. This can be a
475 /// finally block or filter expression.
Erich Keanebe65e872018-07-10 21:07:50 +0000476 bool IsOutlinedSEHHelper = false;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000477
Erich Keanebe65e872018-07-10 21:07:50 +0000478 const CodeGen::CGBlockInfo *BlockInfo = nullptr;
479 llvm::Value *BlockPointer = nullptr;
John McCallad7c5c12011-02-08 08:22:06 +0000480
Eli Friedman9fbeba02012-02-11 02:57:39 +0000481 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
Erich Keanebe65e872018-07-10 21:07:50 +0000482 FieldDecl *LambdaThisCaptureField = nullptr;
Eli Friedman9fbeba02012-02-11 02:57:39 +0000483
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000484 /// A mapping from NRVO variables to the flags used to indicate
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000485 /// when the NRVO has been applied to this variable.
486 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000487
John McCallbd309292010-07-06 01:34:17 +0000488 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000489 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000490 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000491
David Majnemer4e52d6f2015-12-12 05:39:21 +0000492 llvm::Instruction *CurrentFuncletPad = nullptr;
493
Tim Shen421119f2016-07-01 21:08:47 +0000494 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
495 llvm::Value *Addr;
496 llvm::Value *Size;
497
498 public:
499 CallLifetimeEnd(Address addr, llvm::Value *size)
500 : Addr(addr.getPointer()), Size(size) {}
501
502 void Emit(CodeGenFunction &CGF, Flags flags) override {
503 CGF.EmitLifetimeEnd(Size, Addr);
504 }
505 };
506
Richard Smith736a9472013-06-12 20:42:33 +0000507 /// Header for data within LifetimeExtendedCleanupStack.
508 struct LifetimeExtendedCleanupHeader {
509 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000510 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000511 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Richard Smithf66e4f72018-07-23 22:56:45 +0000512 unsigned Kind : 31;
513 /// Whether this is a conditional cleanup.
514 unsigned IsConditional : 1;
Richard Smith736a9472013-06-12 20:42:33 +0000515
Justin Bognerbdff2192015-07-01 00:59:27 +0000516 size_t getSize() const { return Size; }
Richard Smithf66e4f72018-07-23 22:56:45 +0000517 CleanupKind getKind() const { return (CleanupKind)Kind; }
518 bool isConditional() const { return IsConditional; }
Richard Smith736a9472013-06-12 20:42:33 +0000519 };
John McCallbd309292010-07-06 01:34:17 +0000520
John McCallad5d61e2010-07-23 21:56:41 +0000521 /// i32s containing the indexes of the cleanup destinations.
Erich Keanebe65e872018-07-10 21:07:50 +0000522 Address NormalCleanupDest = Address::invalid();
John McCallad5d61e2010-07-23 21:56:41 +0000523
Erich Keanebe65e872018-07-10 21:07:50 +0000524 unsigned NextCleanupDestIndex = 1;
John McCallad5d61e2010-07-23 21:56:41 +0000525
John McCall08ef4662011-11-10 08:15:53 +0000526 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
Erich Keanebe65e872018-07-10 21:07:50 +0000527 CGBlockInfo *FirstBlockInfo = nullptr;
John McCall08ef4662011-11-10 08:15:53 +0000528
John McCall8e4c74b2011-08-11 02:22:43 +0000529 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
Erich Keanebe65e872018-07-10 21:07:50 +0000530 llvm::BasicBlock *EHResumeBlock = nullptr;
John McCall8e4c74b2011-08-11 02:22:43 +0000531
Bill Wendlingf0724e82011-09-19 20:31:14 +0000532 /// The exception slot. All landing pads write the current exception pointer
533 /// into this alloca.
Erich Keanebe65e872018-07-10 21:07:50 +0000534 llvm::Value *ExceptionSlot = nullptr;
John McCallbd309292010-07-06 01:34:17 +0000535
Bill Wendlingf0724e82011-09-19 20:31:14 +0000536 /// The selector slot. Under the MandatoryCleanup model, all landing pads
537 /// write the current selector value into this alloca.
Erich Keanebe65e872018-07-10 21:07:50 +0000538 llvm::AllocaInst *EHSelectorSlot = nullptr;
John McCall9b382dd2011-05-28 21:13:02 +0000539
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000540 /// A stack of exception code slots. Entering an __except block pushes a slot
541 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
542 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000543 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000544
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000545 /// Value returned by __exception_info intrinsic.
546 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000547
John McCallbd309292010-07-06 01:34:17 +0000548 /// Emits a landing pad for the current EH stack.
549 llvm::BasicBlock *EmitLandingPad();
550
551 llvm::BasicBlock *getInvokeDestImpl();
552
John McCallce1de612011-01-26 04:00:11 +0000553 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000554 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
555 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000556 }
557
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000558public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000559 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
560 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000561 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000562
John McCall6b0feb72011-06-22 02:32:12 +0000563 /// A class controlling the emission of a finally block.
564 class FinallyInfo {
565 /// Where the catchall's edge through the cleanup should go.
566 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000567
John McCall6b0feb72011-06-22 02:32:12 +0000568 /// A function to call to enter the catch.
James Y Knight9871db02019-02-05 16:42:33 +0000569 llvm::FunctionCallee BeginCatchFn;
John McCall6b0feb72011-06-22 02:32:12 +0000570
571 /// An i1 variable indicating whether or not the @finally is
572 /// running for an exception.
573 llvm::AllocaInst *ForEHVar;
574
575 /// An i8* variable into which the exception pointer to rethrow
576 /// has been saved.
577 llvm::AllocaInst *SavedExnVar;
578
579 public:
580 void enter(CodeGenFunction &CGF, const Stmt *Finally,
James Y Knight9871db02019-02-05 16:42:33 +0000581 llvm::FunctionCallee beginCatchFn,
582 llvm::FunctionCallee endCatchFn, llvm::FunctionCallee rethrowFn);
John McCall6b0feb72011-06-22 02:32:12 +0000583 void exit(CodeGenFunction &CGF);
584 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000585
Reid Kleckner11c033e2015-02-12 23:40:45 +0000586 /// Returns true inside SEH __try blocks.
587 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
588
Reid Klecknera002bd52015-10-28 23:06:42 +0000589 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000590 bool isCleanupPadScope() const {
591 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
592 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000593
John McCallce1de612011-01-26 04:00:11 +0000594 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
595 /// current full-expression. Safe against the possibility that
596 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000597 template <class T, class... As>
598 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000599 // If we're not in a conditional branch, or if none of the
600 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000601 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000602 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000603
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000604 // Stash values in a tuple so we can guarantee the order of saves.
605 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
606 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000607
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000608 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000609 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000610 initFullExprCleanup();
611 }
612
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000613 /// Queue a cleanup to be pushed after finishing the current
Richard Smith736a9472013-06-12 20:42:33 +0000614 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000615 template <class T, class... As>
616 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smithf66e4f72018-07-23 22:56:45 +0000617 if (!isInConditionalBranch())
618 return pushCleanupAfterFullExprImpl<T>(Kind, Address::invalid(), A...);
Richard Smith736a9472013-06-12 20:42:33 +0000619
Richard Smithf66e4f72018-07-23 22:56:45 +0000620 Address ActiveFlag = createCleanupActiveFlag();
621 assert(!DominatingValue<Address>::needsSaving(ActiveFlag) &&
622 "cleanup active flag should never need saving");
623
624 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
625 SavedTuple Saved{saveValueInCond(A)...};
626
627 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
628 pushCleanupAfterFullExprImpl<CleanupType>(Kind, ActiveFlag, Saved);
629 }
630
631 template <class T, class... As>
632 void pushCleanupAfterFullExprImpl(CleanupKind Kind, Address ActiveFlag,
633 As... A) {
634 LifetimeExtendedCleanupHeader Header = {sizeof(T), Kind,
635 ActiveFlag.isValid()};
Richard Smith736a9472013-06-12 20:42:33 +0000636
637 size_t OldSize = LifetimeExtendedCleanupStack.size();
638 LifetimeExtendedCleanupStack.resize(
Richard Smithf66e4f72018-07-23 22:56:45 +0000639 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size +
640 (Header.IsConditional ? sizeof(ActiveFlag) : 0));
Richard Smith736a9472013-06-12 20:42:33 +0000641
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000642 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000643 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000644 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
645 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000646 new (Buffer + sizeof(Header)) T(A...);
Richard Smithf66e4f72018-07-23 22:56:45 +0000647 if (Header.IsConditional)
648 new (Buffer + sizeof(Header) + sizeof(T)) Address(ActiveFlag);
Richard Smith736a9472013-06-12 20:42:33 +0000649 }
650
Richard Smithf66e4f72018-07-23 22:56:45 +0000651 /// Set up the last cleanup that was pushed as a conditional
John McCallf4beacd2011-11-10 10:43:54 +0000652 /// full-expression cleanup.
Richard Smithf66e4f72018-07-23 22:56:45 +0000653 void initFullExprCleanup() {
654 initFullExprCleanupWithFlag(createCleanupActiveFlag());
655 }
656
657 void initFullExprCleanupWithFlag(Address ActiveFlag);
658 Address createCleanupActiveFlag();
John McCallf4beacd2011-11-10 10:43:54 +0000659
John McCallbd309292010-07-06 01:34:17 +0000660 /// PushDestructorCleanup - Push a cleanup to call the
661 /// complete-object destructor of an object of the given type at the
662 /// given address. Does nothing if T is not a C++ class type with a
663 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000664 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000665
John McCall8680f872010-07-21 06:29:51 +0000666 /// PushDestructorCleanup - Push a cleanup to call the
667 /// complete-object variant of the given destructor on the object at
668 /// the given address.
John McCall7f416cc2015-09-08 08:05:57 +0000669 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000670
John McCallbd309292010-07-06 01:34:17 +0000671 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
672 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000673 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000674
John McCall824c2f52010-09-14 07:57:04 +0000675 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
676 /// The block cannot be reactivated. Pops it if it's the top of the
677 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000678 ///
679 /// \param DominatingIP - An instruction which is known to
680 /// dominate the current IP (if set) and which lies along
681 /// all paths of execution between the current IP and the
682 /// the point at which the cleanup comes into scope.
683 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
684 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000685
686 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
687 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000688 ///
689 /// \param DominatingIP - An instruction which is known to
690 /// dominate the current IP (if set) and which lies along
691 /// all paths of execution between the current IP and the
692 /// the point at which the cleanup comes into scope.
693 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
694 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000695
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000696 /// Enters a new scope for capturing cleanups, all of which
John McCallbd309292010-07-06 01:34:17 +0000697 /// will be executed once the scope is exited.
698 class RunCleanupsScope {
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000699 EHScopeStack::stable_iterator CleanupStackDepth, OldCleanupScopeDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000700 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000701 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000702 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000703 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000704 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000705
Aaron Ballmanabc18922015-02-15 22:54:08 +0000706 RunCleanupsScope(const RunCleanupsScope &) = delete;
707 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000708
Eric Christophera9d34972011-10-19 00:43:52 +0000709 protected:
710 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000711
Douglas Gregor965f4502009-11-24 16:43:22 +0000712 public:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000713 /// Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000714 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000715 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000716 {
John McCallbd309292010-07-06 01:34:17 +0000717 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000718 LifetimeExtendedCleanupStackSize =
719 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000720 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000721 CGF.DidCallStackSave = false;
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000722 OldCleanupScopeDepth = CGF.CurrentCleanupScopeDepth;
723 CGF.CurrentCleanupScopeDepth = CleanupStackDepth;
Douglas Gregor965f4502009-11-24 16:43:22 +0000724 }
725
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000726 /// Exit this cleanup scope, emitting any accumulated cleanups.
John McCallbd309292010-07-06 01:34:17 +0000727 ~RunCleanupsScope() {
Reid Kleckner092d0652017-03-06 22:18:34 +0000728 if (PerformCleanup)
729 ForceCleanup();
Douglas Gregor680f8612009-11-24 21:15:44 +0000730 }
731
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000732 /// Determine whether this scope requires any cleanups.
Douglas Gregor680f8612009-11-24 21:15:44 +0000733 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000734 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000735 }
736
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000737 /// Force the emission of cleanups now, instead of waiting
Douglas Gregor680f8612009-11-24 21:15:44 +0000738 /// until this object is destroyed.
Reid Kleckner092d0652017-03-06 22:18:34 +0000739 /// \param ValuesToReload - A list of values that need to be available at
740 /// the insertion point after cleanup emission. If cleanup emission created
741 /// a shared cleanup block, these value pointers will be rewritten.
742 /// Otherwise, they not will be modified.
743 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
Douglas Gregor680f8612009-11-24 21:15:44 +0000744 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000745 CGF.DidCallStackSave = OldDidCallStackSave;
Reid Kleckner092d0652017-03-06 22:18:34 +0000746 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
747 ValuesToReload);
Douglas Gregor680f8612009-11-24 21:15:44 +0000748 PerformCleanup = false;
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000749 CGF.CurrentCleanupScopeDepth = OldCleanupScopeDepth;
Douglas Gregor965f4502009-11-24 16:43:22 +0000750 }
751 };
752
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000753 // Cleanup stack depth of the RunCleanupsScope that was pushed most recently.
754 EHScopeStack::stable_iterator CurrentCleanupScopeDepth =
755 EHScopeStack::stable_end();
756
David Blaikie93be0b22014-08-22 21:37:04 +0000757 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000758 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000759 SmallVector<const LabelDecl*, 4> Labels;
760 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000761
Aaron Ballmanabc18922015-02-15 22:54:08 +0000762 LexicalScope(const LexicalScope &) = delete;
763 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000764
765 public:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000766 /// Enter a new cleanup scope.
Eric Christophera9d34972011-10-19 00:43:52 +0000767 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000768 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
769 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000770 if (CGDebugInfo *DI = CGF.getDebugInfo())
771 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
772 }
773
Nadav Rotem1da30942013-03-23 06:43:35 +0000774 void addLabel(const LabelDecl *label) {
775 assert(PerformCleanup && "adding label to dead scope?");
776 Labels.push_back(label);
777 }
778
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000779 /// Exit this cleanup scope, emitting any accumulated
Eric Christophera9d34972011-10-19 00:43:52 +0000780 /// cleanups.
781 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000782 if (CGDebugInfo *DI = CGF.getDebugInfo())
783 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
784
Nadav Rotem1da30942013-03-23 06:43:35 +0000785 // If we should perform a cleanup, force them now. Note that
786 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000787 if (PerformCleanup) {
Calixte Denizetfcd661d2018-09-24 18:24:18 +0000788 ApplyDebugLocation DL(CGF, Range.getEnd());
David Blaikie4d524432015-02-04 19:47:54 +0000789 ForceCleanup();
790 }
Eric Christophera9d34972011-10-19 00:43:52 +0000791 }
792
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000793 /// Force the emission of cleanups now, instead of waiting
Eric Christophera9d34972011-10-19 00:43:52 +0000794 /// until this object is destroyed.
795 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000796 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000797 RunCleanupsScope::ForceCleanup();
798
Nadav Rotem1da30942013-03-23 06:43:35 +0000799 if (!Labels.empty())
800 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000801 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000802
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000803 bool hasLabels() const {
804 return !Labels.empty();
805 }
806
Nadav Rotem1da30942013-03-23 06:43:35 +0000807 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000808 };
809
John McCall7f416cc2015-09-08 08:05:57 +0000810 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
811
Alexey Bataevab4ea222018-03-07 18:17:06 +0000812 /// The class used to assign some variables some temporarily addresses.
813 class OMPMapVars {
John McCall7f416cc2015-09-08 08:05:57 +0000814 DeclMapTy SavedLocals;
Alexey Bataevab4ea222018-03-07 18:17:06 +0000815 DeclMapTy SavedTempAddresses;
816 OMPMapVars(const OMPMapVars &) = delete;
817 void operator=(const OMPMapVars &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000818
819 public:
Alexey Bataevab4ea222018-03-07 18:17:06 +0000820 explicit OMPMapVars() = default;
821 ~OMPMapVars() {
822 assert(SavedLocals.empty() && "Did not restored original addresses.");
823 };
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000824
Alexey Bataevab4ea222018-03-07 18:17:06 +0000825 /// Sets the address of the variable \p LocalVD to be \p TempAddr in
826 /// function \p CGF.
827 /// \return true if at least one variable was set already, false otherwise.
828 bool setVarAddr(CodeGenFunction &CGF, const VarDecl *LocalVD,
829 Address TempAddr) {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000830 LocalVD = LocalVD->getCanonicalDecl();
John McCall7f416cc2015-09-08 08:05:57 +0000831 // Only save it once.
832 if (SavedLocals.count(LocalVD)) return false;
833
834 // Copy the existing local entry to SavedLocals.
835 auto it = CGF.LocalDeclMap.find(LocalVD);
Alexey Bataevab4ea222018-03-07 18:17:06 +0000836 if (it != CGF.LocalDeclMap.end())
837 SavedLocals.try_emplace(LocalVD, it->second);
838 else
839 SavedLocals.try_emplace(LocalVD, Address::invalid());
John McCall7f416cc2015-09-08 08:05:57 +0000840
841 // Generate the private entry.
Alexey Bataevcaacd532015-09-04 11:26:21 +0000842 QualType VarTy = LocalVD->getType();
843 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000844 Address Temp = CGF.CreateMemTemp(VarTy);
Alexey Bataevab4ea222018-03-07 18:17:06 +0000845 CGF.Builder.CreateStore(TempAddr.getPointer(), Temp);
846 TempAddr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000847 }
Alexey Bataevab4ea222018-03-07 18:17:06 +0000848 SavedTempAddresses.try_emplace(LocalVD, TempAddr);
John McCall7f416cc2015-09-08 08:05:57 +0000849
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000850 return true;
851 }
852
Alexey Bataevab4ea222018-03-07 18:17:06 +0000853 /// Applies new addresses to the list of the variables.
854 /// \return true if at least one variable is using new address, false
855 /// otherwise.
856 bool apply(CodeGenFunction &CGF) {
857 copyInto(SavedTempAddresses, CGF.LocalDeclMap);
858 SavedTempAddresses.clear();
859 return !SavedLocals.empty();
860 }
861
862 /// Restores original addresses of the variables.
863 void restore(CodeGenFunction &CGF) {
864 if (!SavedLocals.empty()) {
865 copyInto(SavedLocals, CGF.LocalDeclMap);
866 SavedLocals.clear();
867 }
868 }
869
870 private:
871 /// Copy all the entries in the source map over the corresponding
872 /// entries in the destination, which must exist.
873 static void copyInto(const DeclMapTy &Src, DeclMapTy &Dest) {
874 for (auto &Pair : Src) {
875 if (!Pair.second.isValid()) {
876 Dest.erase(Pair.first);
877 continue;
878 }
879
880 auto I = Dest.find(Pair.first);
881 if (I != Dest.end())
882 I->second = Pair.second;
883 else
884 Dest.insert(Pair);
885 }
886 }
887 };
888
889 /// The scope used to remap some variables as private in the OpenMP loop body
890 /// (or other captured region emitted without outlining), and to restore old
891 /// vars back on exit.
892 class OMPPrivateScope : public RunCleanupsScope {
893 OMPMapVars MappedVars;
894 OMPPrivateScope(const OMPPrivateScope &) = delete;
895 void operator=(const OMPPrivateScope &) = delete;
896
897 public:
898 /// Enter a new OpenMP private scope.
899 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
900
901 /// Registers \p LocalVD variable as a private and apply \p PrivateGen
902 /// function for it to generate corresponding private variable. \p
903 /// PrivateGen returns an address of the generated private variable.
904 /// \return true if the variable is registered as private, false if it has
905 /// been privatized already.
906 bool addPrivate(const VarDecl *LocalVD,
Alexey Bataevddf3db92018-04-13 17:31:06 +0000907 const llvm::function_ref<Address()> PrivateGen) {
Alexey Bataevab4ea222018-03-07 18:17:06 +0000908 assert(PerformCleanup && "adding private to dead scope");
909 return MappedVars.setVarAddr(CGF, LocalVD, PrivateGen());
910 }
911
912 /// Privatizes local variables previously registered as private.
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000913 /// Registration is separate from the actual privatization to allow
914 /// initializers use values of the original variables, not the private one.
915 /// This is important, for example, if the private variable is a class
916 /// variable initialized by a constructor that references other private
917 /// variables. But at initialization original variables must be used, not
918 /// private copies.
919 /// \return true if at least one variable was privatized, false otherwise.
Alexey Bataevab4ea222018-03-07 18:17:06 +0000920 bool Privatize() { return MappedVars.apply(CGF); }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000921
922 void ForceCleanup() {
923 RunCleanupsScope::ForceCleanup();
Alexey Bataevab4ea222018-03-07 18:17:06 +0000924 MappedVars.restore(CGF);
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000925 }
926
Alexey Bataevab4ea222018-03-07 18:17:06 +0000927 /// Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +0000928 ~OMPPrivateScope() {
929 if (PerformCleanup)
930 ForceCleanup();
931 }
John McCall7f416cc2015-09-08 08:05:57 +0000932
Gor Nishanov04491bd2017-11-11 17:00:43 +0000933 /// Checks if the global variable is captured in current function.
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000934 bool isGlobalVarCaptured(const VarDecl *VD) const {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000935 VD = VD->getCanonicalDecl();
Alexey Bataev4ba78a42016-04-27 07:56:03 +0000936 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
937 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000938 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000939
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000940 /// Takes the old cleanup stack size and emits the cleanup blocks
Richard Smith736a9472013-06-12 20:42:33 +0000941 /// that have been added.
Reid Kleckner092d0652017-03-06 22:18:34 +0000942 void
943 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
944 std::initializer_list<llvm::Value **> ValuesToReload = {});
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000945
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000946 /// Takes the old cleanup stack size and emits the cleanup blocks
Richard Smith736a9472013-06-12 20:42:33 +0000947 /// that have been added, then adds all lifetime-extended cleanups from
948 /// the given position to the stack.
Reid Kleckner092d0652017-03-06 22:18:34 +0000949 void
950 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
951 size_t OldLifetimeExtendedStackSize,
952 std::initializer_list<llvm::Value **> ValuesToReload = {});
Richard Smith736a9472013-06-12 20:42:33 +0000953
John McCallad5d61e2010-07-23 21:56:41 +0000954 void ResolveBranchFixups(llvm::BasicBlock *Target);
955
John McCallbd309292010-07-06 01:34:17 +0000956 /// The given basic block lies in the current EH scope, but may be a
957 /// target of a potentially scope-crossing jump; get a stable handle
958 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000959 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000960 return JumpDest(Target,
961 EHStack.getInnermostNormalCleanup(),
962 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000963 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000964
John McCallbd309292010-07-06 01:34:17 +0000965 /// The given basic block lies in the current EH scope, but may be a
966 /// target of a potentially scope-crossing jump; get a stable handle
967 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000968 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000969 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000970 }
971
972 /// EmitBranchThroughCleanup - Emit a branch from the current insert
973 /// block through the normal cleanup handling code (if any) and then
974 /// on to \arg Dest.
975 void EmitBranchThroughCleanup(JumpDest Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +0000976
Justin Bognere25ffdf2014-01-21 00:35:11 +0000977 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
978 /// specified destination obviously has no cleanups to run. 'false' is always
979 /// a conservatively correct answer for this method.
980 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
981
John McCall8e4c74b2011-08-11 02:22:43 +0000982 /// popCatchScope - Pops the catch scope at the top of the EHScope
983 /// stack, emitting any required code (other than the catch handlers
984 /// themselves).
985 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000986
David Chisnall9a837be2012-11-07 16:50:40 +0000987 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000988 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Heejin Ahnc6479192018-05-31 22:18:13 +0000989 llvm::BasicBlock *
990 getFuncletEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000991
John McCallce1de612011-01-26 04:00:11 +0000992 /// An object to manage conditionally-evaluated expressions.
993 class ConditionalEvaluation {
994 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000995
John McCallce1de612011-01-26 04:00:11 +0000996 public:
997 ConditionalEvaluation(CodeGenFunction &CGF)
998 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000999
John McCallce1de612011-01-26 04:00:11 +00001000 void begin(CodeGenFunction &CGF) {
1001 assert(CGF.OutermostConditional != this);
1002 if (!CGF.OutermostConditional)
1003 CGF.OutermostConditional = this;
1004 }
1005
1006 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +00001007 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +00001008 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +00001009 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +00001010 }
1011
1012 /// Returns a block which will be executed prior to each
1013 /// evaluation of the conditional code.
1014 llvm::BasicBlock *getStartingBlock() const {
1015 return StartBB;
1016 }
1017 };
Mike Stump11289f42009-09-09 15:08:12 +00001018
John McCall7f9c92a2010-09-17 00:50:28 +00001019 /// isInConditionalBranch - Return true if we're currently emitting
1020 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +00001021 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +00001022
John McCall7f416cc2015-09-08 08:05:57 +00001023 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +00001024 assert(isInConditionalBranch());
1025 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +00001026 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
1027 store->setAlignment(addr.getAlignment().getQuantity());
John McCallf4beacd2011-11-10 10:43:54 +00001028 }
1029
John McCallce1de612011-01-26 04:00:11 +00001030 /// An RAII object to record that we're evaluating a statement
1031 /// expression.
1032 class StmtExprEvaluation {
1033 CodeGenFunction &CGF;
1034
1035 /// We have to save the outermost conditional: cleanups in a
1036 /// statement expression aren't conditional just because the
1037 /// StmtExpr is.
1038 ConditionalEvaluation *SavedOutermostConditional;
1039
1040 public:
1041 StmtExprEvaluation(CodeGenFunction &CGF)
1042 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +00001043 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +00001044 }
1045
1046 ~StmtExprEvaluation() {
1047 CGF.OutermostConditional = SavedOutermostConditional;
1048 CGF.EnsureInsertPoint();
1049 }
1050 };
John McCall1bf58462011-02-16 08:02:54 +00001051
John McCallc07a0c72011-02-17 10:25:35 +00001052 /// An object which temporarily prevents a value from being
1053 /// destroyed by aggressive peephole optimizations that assume that
1054 /// all uses of a value have been realized in the IR.
1055 class PeepholeProtection {
1056 llvm::Instruction *Inst;
1057 friend class CodeGenFunction;
1058
1059 public:
Craig Topper8a13c412014-05-21 05:09:00 +00001060 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +00001061 };
John McCallc07a0c72011-02-17 10:25:35 +00001062
John McCallfe96e0b2011-11-06 09:01:30 +00001063 /// A non-RAII class containing all the information about a bound
1064 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
1065 /// this which makes individual mappings very simple; using this
1066 /// class directly is useful when you have a variable number of
1067 /// opaque values or don't want the RAII functionality for some
1068 /// reason.
1069 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +00001070 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +00001071 bool BoundLValue;
1072 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +00001073
John McCallfe96e0b2011-11-06 09:01:30 +00001074 OpaqueValueMappingData(const OpaqueValueExpr *ov,
1075 bool boundLValue)
1076 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +00001077 public:
Craig Topper8a13c412014-05-21 05:09:00 +00001078 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +00001079
John McCallc07a0c72011-02-17 10:25:35 +00001080 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +00001081 // gl-values should be bound as l-values for obvious reasons.
1082 // Records should be bound as l-values because IR generation
1083 // always keeps them in memory. Expressions of function type
1084 // act exactly like l-values but are formally required to be
1085 // r-values in C.
1086 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +00001087 expr->getType()->isFunctionType() ||
1088 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +00001089 }
1090
John McCallfe96e0b2011-11-06 09:01:30 +00001091 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1092 const OpaqueValueExpr *ov,
1093 const Expr *e) {
1094 if (shouldBindAsLValue(ov))
1095 return bind(CGF, ov, CGF.EmitLValue(e));
1096 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1097 }
1098
1099 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1100 const OpaqueValueExpr *ov,
1101 const LValue &lv) {
1102 assert(shouldBindAsLValue(ov));
1103 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1104 return OpaqueValueMappingData(ov, true);
1105 }
1106
1107 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1108 const OpaqueValueExpr *ov,
1109 const RValue &rv) {
1110 assert(!shouldBindAsLValue(ov));
1111 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1112
1113 OpaqueValueMappingData data(ov, false);
1114
1115 // Work around an extremely aggressive peephole optimization in
1116 // EmitScalarConversion which assumes that all other uses of a
1117 // value are extant.
1118 data.Protection = CGF.protectFromPeepholes(rv);
1119
1120 return data;
1121 }
1122
Craig Topper8a13c412014-05-21 05:09:00 +00001123 bool isValid() const { return OpaqueValue != nullptr; }
1124 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +00001125
1126 void unbind(CodeGenFunction &CGF) {
1127 assert(OpaqueValue && "no data to unbind!");
1128
1129 if (BoundLValue) {
1130 CGF.OpaqueLValues.erase(OpaqueValue);
1131 } else {
1132 CGF.OpaqueRValues.erase(OpaqueValue);
1133 CGF.unprotectFromPeepholes(Protection);
1134 }
1135 }
1136 };
1137
1138 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1139 class OpaqueValueMapping {
1140 CodeGenFunction &CGF;
1141 OpaqueValueMappingData Data;
1142
1143 public:
1144 static bool shouldBindAsLValue(const Expr *expr) {
1145 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1146 }
1147
John McCallc07a0c72011-02-17 10:25:35 +00001148 /// Build the opaque value mapping for the given conditional
1149 /// operator if it's the GNU ?: extension. This is a common
1150 /// enough pattern that the convenience operator is really
1151 /// helpful.
1152 ///
1153 OpaqueValueMapping(CodeGenFunction &CGF,
1154 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +00001155 if (isa<ConditionalOperator>(op))
1156 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001157 return;
John McCallc07a0c72011-02-17 10:25:35 +00001158
1159 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001160 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1161 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001162 }
1163
Richard Smith410306b2016-12-12 02:53:20 +00001164 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1165 /// expression is set to the expression the OVE represents.
1166 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1167 : CGF(CGF) {
1168 if (OV) {
1169 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1170 "for OVE with no source expression");
1171 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1172 }
1173 }
1174
John McCall1bf58462011-02-16 08:02:54 +00001175 OpaqueValueMapping(CodeGenFunction &CGF,
1176 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001177 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001178 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001179 }
1180
1181 OpaqueValueMapping(CodeGenFunction &CGF,
1182 const OpaqueValueExpr *opaqueValue,
1183 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001184 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001185 }
1186
1187 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001188 Data.unbind(CGF);
1189 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001190 }
1191
1192 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001193 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001194 }
1195 };
Gor Nishanov04491bd2017-11-11 17:00:43 +00001196
Chris Lattner2da04b32007-08-24 05:35:26 +00001197private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001198 CGDebugInfo *DebugInfo;
Adrian Prantla40cce82018-11-09 19:17:56 +00001199 /// Used to create unique names for artificial VLA size debug info variables.
1200 unsigned VLAExprCounter = 0;
Erich Keanebe65e872018-07-10 21:07:50 +00001201 bool DisableDebugInfo = false;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001202
John McCall9b382dd2011-05-28 21:13:02 +00001203 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1204 /// calling llvm.stacksave for multiple VLAs in the same scope.
Erich Keanebe65e872018-07-10 21:07:50 +00001205 bool DidCallStackSave = false;
John McCall9b382dd2011-05-28 21:13:02 +00001206
Mike Stumpe5311b02009-11-30 20:08:49 +00001207 /// IndirectBranch - The first time an indirect goto is seen we create a block
1208 /// with an indirect branch. Every time we see the address of a label taken,
1209 /// we add the label to the indirect goto. Every subsequent indirect goto is
1210 /// codegen'd as a jump to the IndirectBranch's basic block.
Erich Keanebe65e872018-07-10 21:07:50 +00001211 llvm::IndirectBrInst *IndirectBranch = nullptr;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001212
Mike Stumpfc496822009-02-08 23:14:22 +00001213 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1214 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001215 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001216
Akira Hatanakaccda3d22018-04-27 06:57:00 +00001217 // Keep track of the cleanups for callee-destructed parameters pushed to the
1218 // cleanup stack so that they can be deactivated later.
1219 llvm::DenseMap<const ParmVarDecl *, EHScopeStack::stable_iterator>
1220 CalleeDestructedParamCleanups;
1221
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001222 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1223 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1224 /// parameter.
1225 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1226 SizeArguments;
1227
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001228 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001229 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001230 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1231
Chris Lattnerac248202007-05-30 00:13:02 +00001232 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001233 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001234
Mike Stumpfc496822009-02-08 23:14:22 +00001235 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001236 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001237 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001238 BreakContinue(JumpDest Break, JumpDest Continue)
1239 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001240
John McCallbd309292010-07-06 01:34:17 +00001241 JumpDest BreakBlock;
1242 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001243 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001244 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001245
Alexey Bataev957d8562016-11-17 15:12:05 +00001246 /// Handles cancellation exit points in OpenMP-related constructs.
1247 class OpenMPCancelExitStack {
1248 /// Tracks cancellation exit point and join point for cancel-related exit
1249 /// and normal exit.
1250 struct CancelExit {
1251 CancelExit() = default;
1252 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1253 JumpDest ContBlock)
1254 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1255 OpenMPDirectiveKind Kind = OMPD_unknown;
1256 /// true if the exit block has been emitted already by the special
1257 /// emitExit() call, false if the default codegen is used.
1258 bool HasBeenEmitted = false;
1259 JumpDest ExitBlock;
1260 JumpDest ContBlock;
1261 };
1262
1263 SmallVector<CancelExit, 8> Stack;
1264
1265 public:
1266 OpenMPCancelExitStack() : Stack(1) {}
1267 ~OpenMPCancelExitStack() = default;
1268 /// Fetches the exit block for the current OpenMP construct.
1269 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1270 /// Emits exit block with special codegen procedure specific for the related
1271 /// OpenMP construct + emits code for normal construct cleanup.
1272 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
Alexey Bataevddf3db92018-04-13 17:31:06 +00001273 const llvm::function_ref<void(CodeGenFunction &)> CodeGen) {
Alexey Bataev957d8562016-11-17 15:12:05 +00001274 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1275 assert(CGF.getOMPCancelDestination(Kind).isValid());
1276 assert(CGF.HaveInsertPoint());
1277 assert(!Stack.back().HasBeenEmitted);
1278 auto IP = CGF.Builder.saveAndClearIP();
1279 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1280 CodeGen(CGF);
Erich Keane0026ed22017-07-27 16:28:20 +00001281 CGF.EmitBranch(Stack.back().ContBlock.getBlock());
Alexey Bataev957d8562016-11-17 15:12:05 +00001282 CGF.Builder.restoreIP(IP);
1283 Stack.back().HasBeenEmitted = true;
1284 }
1285 CodeGen(CGF);
1286 }
1287 /// Enter the cancel supporting \a Kind construct.
1288 /// \param Kind OpenMP directive that supports cancel constructs.
1289 /// \param HasCancel true, if the construct has inner cancel directive,
1290 /// false otherwise.
1291 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1292 Stack.push_back({Kind,
1293 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1294 : JumpDest(),
1295 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1296 : JumpDest()});
1297 }
1298 /// Emits default exit point for the cancel construct (if the special one
1299 /// has not be used) + join point for cancel/normal exits.
1300 void exit(CodeGenFunction &CGF) {
1301 if (getExitBlock().isValid()) {
1302 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1303 bool HaveIP = CGF.HaveInsertPoint();
1304 if (!Stack.back().HasBeenEmitted) {
1305 if (HaveIP)
1306 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1307 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1308 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1309 }
1310 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1311 if (!HaveIP) {
1312 CGF.Builder.CreateUnreachable();
1313 CGF.Builder.ClearInsertionPoint();
1314 }
1315 }
1316 Stack.pop_back();
1317 }
1318 };
1319 OpenMPCancelExitStack OMPCancelStack;
1320
Justin Bogneref512b92014-01-06 22:27:43 +00001321 CodeGenPGO PGO;
1322
Justin Bogner65512642015-05-02 05:00:55 +00001323 /// Calculate branch weights appropriate for PGO data
1324 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1325 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1326 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1327 uint64_t LoopCount);
1328
Justin Bogneref512b92014-01-06 22:27:43 +00001329public:
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001330 /// Increment the profiler's counter for the given statement by \p StepV.
1331 /// If \p StepV is null, the default increment is 1.
1332 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
Rong Xu9837ef52016-02-04 18:39:09 +00001333 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001334 PGO.emitCounterIncrement(Builder, S, StepV);
Justin Bogner66242d62015-04-23 23:06:47 +00001335 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001336 }
Justin Bogner66242d62015-04-23 23:06:47 +00001337
1338 /// Get the profiler's count for the given statement.
1339 uint64_t getProfileCount(const Stmt *S) {
1340 Optional<uint64_t> Count = PGO.getStmtCount(S);
1341 if (!Count.hasValue())
1342 return 0;
1343 return *Count;
1344 }
1345
1346 /// Set the profiler's current count.
1347 void setCurrentProfileCount(uint64_t Count) {
1348 PGO.setCurrentRegionCount(Count);
1349 }
1350
1351 /// Get the profiler's current count. This is generally the count for the most
1352 /// recently incremented counter.
1353 uint64_t getCurrentProfileCount() {
1354 return PGO.getCurrentRegionCount();
1355 }
1356
Justin Bogneref512b92014-01-06 22:27:43 +00001357private:
1358
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001359 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001360 /// current context is not in a switch.
Erich Keanebe65e872018-07-10 21:07:50 +00001361 llvm::SwitchInst *SwitchInsn = nullptr;
Justin Bogneref512b92014-01-06 22:27:43 +00001362 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
Erich Keanebe65e872018-07-10 21:07:50 +00001363 SmallVector<uint64_t, 16> *SwitchWeights = nullptr;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001364
Mike Stumpfc496822009-02-08 23:14:22 +00001365 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001366 /// statement range in current switch instruction.
Erich Keanebe65e872018-07-10 21:07:50 +00001367 llvm::BasicBlock *CaseRangeBlock = nullptr;
Devang Patel11663122007-10-08 20:57:48 +00001368
John McCallc07a0c72011-02-17 10:25:35 +00001369 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001370 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001371 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1372 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001373
Mike Stumpfc496822009-02-08 23:14:22 +00001374 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001375 // We track this by the size expression rather than the type itself because
1376 // in certain situations, like a const qualifier applied to an VLA typedef,
1377 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001378 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1379 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001380 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001381
John McCallbd309292010-07-06 01:34:17 +00001382 /// A block containing a single 'unreachable' instruction. Created
1383 /// lazily by getUnreachableBlock().
Erich Keanebe65e872018-07-10 21:07:50 +00001384 llvm::BasicBlock *UnreachableBlock = nullptr;
Mike Stumpfc496822009-02-08 23:14:22 +00001385
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001386 /// Counts of the number return expressions in the function.
Erich Keanebe65e872018-07-10 21:07:50 +00001387 unsigned NumReturnExprs = 0;
Adrian Prantl3be10542013-05-02 17:30:20 +00001388
1389 /// Count the number of simple (constant) return expressions in the function.
Erich Keanebe65e872018-07-10 21:07:50 +00001390 unsigned NumSimpleReturnExprs = 0;
Adrian Prantl3be10542013-05-02 17:30:20 +00001391
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001392 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001393 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001394
Richard Smith852c9db2013-04-20 22:23:05 +00001395public:
1396 /// A scope within which we are constructing the fields of an object which
1397 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1398 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1399 class FieldConstructionScope {
1400 public:
John McCall7f416cc2015-09-08 08:05:57 +00001401 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001402 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1403 CGF.CXXDefaultInitExprThis = This;
1404 }
1405 ~FieldConstructionScope() {
1406 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1407 }
1408
1409 private:
1410 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001411 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001412 };
1413
1414 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1415 /// is overridden to be the object under construction.
1416 class CXXDefaultInitExprScope {
1417 public:
1418 CXXDefaultInitExprScope(CodeGenFunction &CGF)
John McCall7f416cc2015-09-08 08:05:57 +00001419 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1420 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1421 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1422 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001423 }
1424 ~CXXDefaultInitExprScope() {
1425 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001426 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001427 }
1428
1429 public:
1430 CodeGenFunction &CGF;
1431 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001432 CharUnits OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001433 };
1434
Richard Smith410306b2016-12-12 02:53:20 +00001435 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1436 /// current loop index is overridden.
1437 class ArrayInitLoopExprScope {
1438 public:
1439 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1440 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1441 CGF.ArrayInitIndex = Index;
1442 }
1443 ~ArrayInitLoopExprScope() {
1444 CGF.ArrayInitIndex = OldArrayInitIndex;
1445 }
1446
1447 private:
1448 CodeGenFunction &CGF;
1449 llvm::Value *OldArrayInitIndex;
1450 };
1451
Richard Smith5179eb72016-06-28 19:03:57 +00001452 class InlinedInheritingConstructorScope {
1453 public:
1454 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1455 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1456 OldCurCodeDecl(CGF.CurCodeDecl),
1457 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1458 OldCXXABIThisValue(CGF.CXXABIThisValue),
1459 OldCXXThisValue(CGF.CXXThisValue),
1460 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1461 OldCXXThisAlignment(CGF.CXXThisAlignment),
1462 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1463 OldCXXInheritedCtorInitExprArgs(
1464 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1465 CGF.CurGD = GD;
1466 CGF.CurFuncDecl = CGF.CurCodeDecl =
1467 cast<CXXConstructorDecl>(GD.getDecl());
1468 CGF.CXXABIThisDecl = nullptr;
1469 CGF.CXXABIThisValue = nullptr;
1470 CGF.CXXThisValue = nullptr;
1471 CGF.CXXABIThisAlignment = CharUnits();
1472 CGF.CXXThisAlignment = CharUnits();
1473 CGF.ReturnValue = Address::invalid();
1474 CGF.FnRetTy = QualType();
1475 CGF.CXXInheritedCtorInitExprArgs.clear();
1476 }
1477 ~InlinedInheritingConstructorScope() {
1478 CGF.CurGD = OldCurGD;
1479 CGF.CurFuncDecl = OldCurFuncDecl;
1480 CGF.CurCodeDecl = OldCurCodeDecl;
1481 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1482 CGF.CXXABIThisValue = OldCXXABIThisValue;
1483 CGF.CXXThisValue = OldCXXThisValue;
1484 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1485 CGF.CXXThisAlignment = OldCXXThisAlignment;
1486 CGF.ReturnValue = OldReturnValue;
1487 CGF.FnRetTy = OldFnRetTy;
1488 CGF.CXXInheritedCtorInitExprArgs =
1489 std::move(OldCXXInheritedCtorInitExprArgs);
1490 }
1491
1492 private:
1493 CodeGenFunction &CGF;
1494 GlobalDecl OldCurGD;
1495 const Decl *OldCurFuncDecl;
1496 const Decl *OldCurCodeDecl;
1497 ImplicitParamDecl *OldCXXABIThisDecl;
1498 llvm::Value *OldCXXABIThisValue;
1499 llvm::Value *OldCXXThisValue;
1500 CharUnits OldCXXABIThisAlignment;
1501 CharUnits OldCXXThisAlignment;
1502 Address OldReturnValue;
1503 QualType OldFnRetTy;
1504 CallArgList OldCXXInheritedCtorInitExprArgs;
1505 };
1506
Richard Smith852c9db2013-04-20 22:23:05 +00001507private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001508 /// CXXThisDecl - When generating code for a C++ member function,
1509 /// this will hold the implicit 'this' declaration.
Erich Keanebe65e872018-07-10 21:07:50 +00001510 ImplicitParamDecl *CXXABIThisDecl = nullptr;
1511 llvm::Value *CXXABIThisValue = nullptr;
1512 llvm::Value *CXXThisValue = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +00001513 CharUnits CXXABIThisAlignment;
1514 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001515
Richard Smith852c9db2013-04-20 22:23:05 +00001516 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1517 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001518 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001519
Richard Smith410306b2016-12-12 02:53:20 +00001520 /// The current array initialization index when evaluating an
1521 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1522 llvm::Value *ArrayInitIndex = nullptr;
1523
Richard Smith5179eb72016-06-28 19:03:57 +00001524 /// The values of function arguments to use when evaluating
1525 /// CXXInheritedCtorInitExprs within this context.
1526 CallArgList CXXInheritedCtorInitExprArgs;
1527
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001528 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1529 /// destructor, this will hold the implicit argument (e.g. VTT).
Erich Keanebe65e872018-07-10 21:07:50 +00001530 ImplicitParamDecl *CXXStructorImplicitParamDecl = nullptr;
1531 llvm::Value *CXXStructorImplicitParamValue = nullptr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001532
John McCallce1de612011-01-26 04:00:11 +00001533 /// OutermostConditional - Points to the outermost active
1534 /// conditional control. This is used so that we know if a
1535 /// temporary should be destroyed conditionally.
Erich Keanebe65e872018-07-10 21:07:50 +00001536 ConditionalEvaluation *OutermostConditional = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001537
Nadav Rotem1da30942013-03-23 06:43:35 +00001538 /// The current lexical scope.
Erich Keanebe65e872018-07-10 21:07:50 +00001539 LexicalScope *CurLexicalScope = nullptr;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001540
Adrian Prantldc237b52013-05-16 00:41:26 +00001541 /// The current source location that should be used for exception
1542 /// handling code.
1543 SourceLocation CurEHLocation;
1544
John McCall7f416cc2015-09-08 08:05:57 +00001545 /// BlockByrefInfos - For each __block variable, contains
1546 /// information about the layout of the variable.
1547 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001548
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001549 /// Used by -fsanitize=nullability-return to determine whether the return
1550 /// value can be checked.
1551 llvm::Value *RetValNullabilityPrecondition = nullptr;
1552
1553 /// Check if -fsanitize=nullability-return instrumentation is required for
1554 /// this function.
1555 bool requiresReturnValueNullabilityCheck() const {
1556 return RetValNullabilityPrecondition;
1557 }
1558
Vedant Kumarc34d3432017-06-23 21:32:38 +00001559 /// Used to store precise source locations for return statements by the
1560 /// runtime return value checks.
1561 Address ReturnLocation = Address::invalid();
1562
1563 /// Check if the return value of this function requires sanitization.
1564 bool requiresReturnValueCheck() const {
1565 return requiresReturnValueNullabilityCheck() ||
1566 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
1567 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
1568 }
1569
Erich Keanebe65e872018-07-10 21:07:50 +00001570 llvm::BasicBlock *TerminateLandingPad = nullptr;
1571 llvm::BasicBlock *TerminateHandler = nullptr;
1572 llvm::BasicBlock *TrapBB = nullptr;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001573
Reid Kleckner06f19a02018-01-02 21:34:16 +00001574 /// Terminate funclets keyed by parent funclet pad.
1575 llvm::MapVector<llvm::Value *, llvm::BasicBlock *> TerminateFunclets;
1576
Craig Topper74c10e32018-07-09 19:00:16 +00001577 /// Largest vector width used in ths function. Will be used to create a
1578 /// function attribute.
Erich Keanebe65e872018-07-10 21:07:50 +00001579 unsigned LargestVectorWidth = 0;
Craig Topper74c10e32018-07-09 19:00:16 +00001580
Vitaly Buka1c943322016-10-26 01:59:57 +00001581 /// True if we need emit the life-time markers.
1582 const bool ShouldEmitLifetimeMarkers;
1583
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00001584 /// Add OpenCL kernel arg metadata and the kernel attribute metadata to
Xiuli Panbe6da4b2017-05-04 07:31:20 +00001585 /// the function metadata.
Gor Nishanov04491bd2017-11-11 17:00:43 +00001586 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001587 llvm::Function *Fn);
1588
Chris Lattnerbed31442007-05-28 01:07:47 +00001589public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001590 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001591 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001592
John McCall8ed55a52010-09-02 09:58:18 +00001593 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001594 ASTContext &getContext() const { return CGM.getContext(); }
Gor Nishanov04491bd2017-11-11 17:00:43 +00001595 CGDebugInfo *getDebugInfo() {
1596 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001597 return nullptr;
Gor Nishanov04491bd2017-11-11 17:00:43 +00001598 return DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001599 }
1600 void disableDebugInfo() { DisableDebugInfo = true; }
1601 void enableDebugInfo() { DisableDebugInfo = false; }
1602
John McCall31168b02011-06-15 23:02:42 +00001603 bool shouldUseFusedARCCalls() {
1604 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1605 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001606
David Blaikiebbafb8a2012-03-11 07:00:24 +00001607 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001608
Bill Wendlingf0724e82011-09-19 20:31:14 +00001609 /// Returns a pointer to the function's exception object and selector slot,
1610 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001611 Address getExceptionSlot();
1612 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001613
Bill Wendling79a70e42011-09-15 18:57:19 +00001614 /// Returns the contents of the function's exception object and selector
1615 /// slots.
1616 llvm::Value *getExceptionFromSlot();
1617 llvm::Value *getSelectorFromSlot();
1618
John McCall7f416cc2015-09-08 08:05:57 +00001619 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001620
John McCallbd309292010-07-06 01:34:17 +00001621 llvm::BasicBlock *getUnreachableBlock() {
1622 if (!UnreachableBlock) {
1623 UnreachableBlock = createBasicBlock("unreachable");
1624 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1625 }
1626 return UnreachableBlock;
1627 }
1628
1629 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001630 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001631 return getInvokeDestImpl();
1632 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001633
David Majnemer25eb1652016-03-01 19:42:53 +00001634 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001635
John McCallc8e01702013-04-16 22:48:15 +00001636 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001637 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Yaxun Liucbf647c2017-07-08 13:24:52 +00001638 const TargetCodeGenInfo &getTargetHooks() const {
1639 return CGM.getTargetCodeGenInfo();
1640 }
Owen Andersonae86c192009-07-13 04:10:07 +00001641
Daniel Dunbar12347492009-02-23 17:26:39 +00001642 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001643 // Cleanups
1644 //===--------------------------------------------------------------------===//
1645
John McCall7f416cc2015-09-08 08:05:57 +00001646 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001647
John McCall178360e2011-07-11 08:38:19 +00001648 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001649 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001650 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001651 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001652 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001653 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1654 llvm::Value *arrayEnd,
1655 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001656 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001657 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001658
John McCall4bd0fb12011-07-12 16:41:08 +00001659 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001660 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001661 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001662 Address addr, QualType type);
1663 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001664 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001665 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001666 QualType type, Destroyer *destroyer,
1667 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001668 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1669 llvm::Value *CompletePtr,
1670 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001671 void pushStackRestore(CleanupKind kind, Address SPMem);
1672 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001673 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001674 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001675 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001676 bool useEHCleanupForArray,
1677 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001678 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001679 QualType elementType, CharUnits elementAlign,
1680 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001681 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001682
Peter Collingbourne1425b452012-01-26 03:33:36 +00001683 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001684
John McCall82fe67b2011-07-09 01:37:26 +00001685 /// Determines whether an EH cleanup is required to destroy a type
1686 /// with the given destruction kind.
1687 bool needsEHCleanup(QualType::DestructionKind kind) {
1688 switch (kind) {
1689 case QualType::DK_none:
1690 return false;
1691 case QualType::DK_cxx_destructor:
1692 case QualType::DK_objc_weak_lifetime:
Akira Hatanaka7275da02018-02-28 07:15:55 +00001693 case QualType::DK_nontrivial_c_struct:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001694 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001695 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001696 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001697 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1698 }
1699 llvm_unreachable("bad destruction kind");
1700 }
1701
John McCall4bd0fb12011-07-12 16:41:08 +00001702 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1703 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1704 }
1705
John McCall82fe67b2011-07-09 01:37:26 +00001706 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001707 // Objective-C
1708 //===--------------------------------------------------------------------===//
1709
Chris Lattner4bd55962008-03-30 23:03:07 +00001710 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001711
David Blaikief1425802015-01-14 00:04:42 +00001712 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001713
Mike Stumpfc496822009-02-08 23:14:22 +00001714 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001715 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1716 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001717 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001718 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001719 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001720 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001721
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001722 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1723 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001724
Mike Stumpfc496822009-02-08 23:14:22 +00001725 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1726 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001727 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1728 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001729 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001730 const ObjCPropertyImplDecl *propImpl,
1731 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001732
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001733 //===--------------------------------------------------------------------===//
1734 // Block Bits
1735 //===--------------------------------------------------------------------===//
1736
Yaxun Liuc2a87a02017-10-14 12:23:50 +00001737 /// Emit block literal.
1738 /// \return an LLVM value which is a pointer to a struct which contains
1739 /// information about the block, including the block invoke function, the
1740 /// captured variables, etc.
Yaxun Liufa13d012018-02-15 16:39:19 +00001741 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001742 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001743
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001744 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001745 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001746 const DeclMapTy &ldm,
Akira Hatanakaba0367a2017-09-22 21:32:06 +00001747 bool IsLambdaConversionToBlock,
1748 bool BuildGlobalBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001749
Akira Hatanaka9978da32018-08-10 15:09:24 +00001750 /// Check if \p T is a C++ class that has a destructor that can throw.
1751 static bool cxxDestructorCanThrow(QualType T);
1752
John McCallad7c5c12011-02-08 08:22:06 +00001753 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1754 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001755 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1756 const ObjCPropertyImplDecl *PID);
1757 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1758 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001759 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001760
Akira Hatanaka9978da32018-08-10 15:09:24 +00001761 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags,
1762 bool CanThrow);
John McCallad7c5c12011-02-08 08:22:06 +00001763
John McCall73064872011-03-31 01:59:53 +00001764 class AutoVarEmission;
1765
1766 void emitByrefStructureInit(const AutoVarEmission &emission);
Akira Hatanakacb6a9332018-07-26 16:51:21 +00001767
1768 /// Enter a cleanup to destroy a __block variable. Note that this
1769 /// cleanup should be a no-op if the variable hasn't left the stack
1770 /// yet; if a cleanup is required for the variable itself, that needs
1771 /// to be done externally.
1772 ///
1773 /// \param Kind Cleanup kind.
1774 ///
1775 /// \param Addr When \p LoadBlockVarAddr is false, the address of the __block
1776 /// structure that will be passed to _Block_object_dispose. When
1777 /// \p LoadBlockVarAddr is true, the address of the field of the block
1778 /// structure that holds the address of the __block structure.
1779 ///
1780 /// \param Flags The flag that will be passed to _Block_object_dispose.
1781 ///
1782 /// \param LoadBlockVarAddr Indicates whether we need to emit a load from
1783 /// \p Addr to get the address of the __block structure.
1784 void enterByrefCleanup(CleanupKind Kind, Address Addr, BlockFieldFlags Flags,
Akira Hatanaka9978da32018-08-10 15:09:24 +00001785 bool LoadBlockVarAddr, bool CanThrow);
John McCall73064872011-03-31 01:59:53 +00001786
John McCall7f416cc2015-09-08 08:05:57 +00001787 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1788 llvm::Value *ptr);
1789
1790 Address LoadBlockStruct();
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001791 Address GetAddrOfBlockDecl(const VarDecl *var);
John McCall7f416cc2015-09-08 08:05:57 +00001792
1793 /// BuildBlockByrefAddress - Computes the location of the
1794 /// data in a variable which is declared as __block.
1795 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1796 bool followForward = true);
1797 Address emitBlockByrefAddress(Address baseAddr,
1798 const BlockByrefInfo &info,
1799 bool followForward,
1800 const llvm::Twine &name);
1801
1802 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001803
Richard Smith5179eb72016-06-28 19:03:57 +00001804 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1805
John McCalla738c252011-03-09 04:27:21 +00001806 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1807 const CGFunctionInfo &FnInfo);
Akira Hatanaka9978da32018-08-10 15:09:24 +00001808
1809 /// Annotate the function with an attribute that disables TSan checking at
1810 /// runtime.
1811 void markAsIgnoreThreadCheckingAtRuntime(llvm::Function *Fn);
1812
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001813 /// Emit code for the start of a function.
Adrian Prantl42d71b92014-04-10 23:21:53 +00001814 /// \param Loc The location to be associated with the function.
1815 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001816 void StartFunction(GlobalDecl GD,
1817 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001818 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001819 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001820 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001821 SourceLocation Loc = SourceLocation(),
1822 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001823
Vedant Kumar7f809b22017-02-24 01:15:19 +00001824 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1825
John McCallb81884d2010-02-19 09:25:03 +00001826 void EmitConstructorBody(FunctionArgList &Args);
1827 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001828 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Reid Kleckner43071082018-12-13 01:33:20 +00001829 void EmitFunctionBody(const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001830 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001831
Faisal Vali571df122013-09-29 08:45:24 +00001832 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001833 CallArgList &CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00001834 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001835 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001836 void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
Richard Smith04440062019-01-17 22:05:50 +00001837 void EmitLambdaVLACapture(const VariableArrayType *VAT, LValue LV) {
1838 EmitStoreThroughLValue(RValue::get(VLASizeMap[VAT->getSizeExpr()]), LV);
1839 }
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001840 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001841
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001842 /// Emit the unified return block, trying to avoid its emission when
David Blaikiea0a1a872015-01-18 02:48:07 +00001843 /// possible.
1844 /// \return The debug location of the user written return statement if the
1845 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001846 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001847
Mike Stumpfc496822009-02-08 23:14:22 +00001848 /// FinishFunction - Complete IR generation of the current function. It is
1849 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001850 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001851
Nico Weber1bebad12015-02-11 22:33:32 +00001852 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
Reid Kleckner399d96e2018-04-02 20:20:33 +00001853 const CGFunctionInfo &FnInfo, bool IsUnprototyped);
Hans Wennborg88497d62013-11-15 17:24:45 +00001854
James Y Knight76f78742019-02-05 19:17:50 +00001855 void EmitCallAndReturnForThunk(llvm::FunctionCallee Callee,
1856 const ThunkInfo *Thunk, bool IsUnprototyped);
Hans Wennborg88497d62013-11-15 17:24:45 +00001857
John McCall7f416cc2015-09-08 08:05:57 +00001858 void FinishThunk();
1859
Reid Klecknerab2090d2014-07-26 01:34:32 +00001860 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
Erich Keanede6480a32018-11-13 15:48:08 +00001861 void EmitMustTailThunk(GlobalDecl GD, llvm::Value *AdjustedThisPtr,
James Y Knight76f78742019-02-05 19:17:50 +00001862 llvm::FunctionCallee Callee);
Reid Klecknerab2090d2014-07-26 01:34:32 +00001863
Rafael Espindolad6e66942015-07-13 06:07:58 +00001864 /// Generate a thunk for the given method.
1865 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
Reid Kleckner399d96e2018-04-02 20:20:33 +00001866 GlobalDecl GD, const ThunkInfo &Thunk,
1867 bool IsUnprototyped);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001868
Peter Collingbournee286b0e2015-06-30 22:08:44 +00001869 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1870 const CGFunctionInfo &FnInfo,
1871 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00001872
Douglas Gregor94f9a482010-05-05 05:51:00 +00001873 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1874 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001875
Richard Smith30e304e2016-12-14 00:03:17 +00001876 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001877
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00001878 /// Struct with all information about dynamic [sub]class needed to set vptr.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001879 struct VPtr {
1880 BaseSubobject Base;
1881 const CXXRecordDecl *NearestVBase;
1882 CharUnits OffsetFromNearestVBase;
1883 const CXXRecordDecl *VTableClass;
1884 };
1885
1886 /// Initialize the vtable pointer of the given subobject.
1887 void InitializeVTablePointer(const VPtr &vptr);
1888
1889 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00001890
1891 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001892 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1893
1894 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1895 CharUnits OffsetFromNearestVBase,
1896 bool BaseIsNonVirtualPrimaryBase,
1897 const CXXRecordDecl *VTableClass,
1898 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001899
Anders Carlssond5895932010-03-28 21:07:49 +00001900 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001901
Dan Gohman8fc50c22010-10-26 18:44:08 +00001902 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1903 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001904 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1905 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00001906
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001907 enum CFITypeCheckKind {
1908 CFITCK_VCall,
1909 CFITCK_NVCall,
1910 CFITCK_DerivedCast,
1911 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00001912 CFITCK_ICall,
Peter Collingbournee44acad2018-06-26 02:15:47 +00001913 CFITCK_NVMFCall,
1914 CFITCK_VMFCall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001915 };
1916
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001917 /// Derived is the presumed address of an object of type T after a
Peter Collingbourned2926c92015-03-14 02:42:25 +00001918 /// cast. If T is a polymorphic class type, emit a check that the virtual
1919 /// table for Derived belongs to a class derived from T.
1920 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001921 bool MayBeNull, CFITypeCheckKind TCK,
1922 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001923
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001924 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1925 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00001926 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001927 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00001928
Peter Collingbourned2926c92015-03-14 02:42:25 +00001929 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001930 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001931 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1932 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00001933
Peter Collingbournefb532b92016-02-24 20:46:36 +00001934 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001935 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1936 /// enabled, emit a check that VTable is a member of RD's type identifier.
1937 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1938 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00001939
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001940 /// Returns whether we should perform a type checked load when loading a
1941 /// virtual function for virtual calls to members of RD. This is generally
1942 /// true when both vcall CFI and whole-program-vtables are enabled.
1943 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1944
1945 /// Emit a type checked load from the given vtable.
1946 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1947 uint64_t VTableByteOffset);
1948
John McCallf99a6312010-07-21 05:30:47 +00001949 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1950 /// given phase of destruction for a destructor. The end result
1951 /// should call destructors on members and base classes in reverse
1952 /// order of their construction.
1953 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001954
Chris Lattner3c77a352010-06-22 00:03:40 +00001955 /// ShouldInstrumentFunction - Return true if the current function should be
1956 /// instrumented with __cyg_profile_func_* calls
1957 bool ShouldInstrumentFunction();
1958
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00001959 /// ShouldXRayInstrument - Return true if the current function should be
1960 /// instrumented with XRay nop sleds.
1961 bool ShouldXRayInstrumentFunction() const;
1962
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +00001963 /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
1964 /// XRay custom event handling calls.
1965 bool AlwaysEmitXRayCustomEvents() const;
1966
Keith Wyssf437e352018-04-17 21:32:43 +00001967 /// AlwaysEmitXRayTypedEvents - Return true if clang must unconditionally emit
1968 /// XRay typed event handling calls.
1969 bool AlwaysEmitXRayTypedEvents() const;
1970
Vedant Kumarbb5d4852017-09-13 00:04:35 +00001971 /// Encode an address into a form suitable for use in a function prologue.
1972 llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
1973 llvm::Constant *Addr);
1974
1975 /// Decode an address used in a function prologue, encoded by \c
1976 /// EncodeAddrForUseInPrologue.
1977 llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
1978 llvm::Value *EncodedAddr);
1979
Mike Stumpfc496822009-02-08 23:14:22 +00001980 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1981 /// arguments for the given function. This is also responsible for naming the
1982 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001983 void EmitFunctionProlog(const CGFunctionInfo &FI,
1984 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001985 const FunctionArgList &Args);
1986
Mike Stumpfc496822009-02-08 23:14:22 +00001987 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1988 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001989 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1990 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001991
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001992 /// Emit a test that checks if the return value \p RV is nonnull.
Vedant Kumarc34d3432017-06-23 21:32:38 +00001993 void EmitReturnValueCheck(llvm::Value *RV);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001994
Mike Stump1d849212009-12-07 23:38:24 +00001995 /// EmitStartEHSpec - Emit the start of the exception spec.
1996 void EmitStartEHSpec(const Decl *D);
1997
1998 /// EmitEndEHSpec - Emit the end of the exception spec.
1999 void EmitEndEHSpec(const Decl *D);
2000
John McCallbd309292010-07-06 01:34:17 +00002001 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
2002 llvm::BasicBlock *getTerminateLandingPad();
2003
Reid Kleckner06f19a02018-01-02 21:34:16 +00002004 /// getTerminateLandingPad - Return a cleanup funclet that just calls
2005 /// terminate.
2006 llvm::BasicBlock *getTerminateFunclet();
2007
John McCallbd309292010-07-06 01:34:17 +00002008 /// getTerminateHandler - Return a handler (not a landing pad, just
2009 /// a catch handler) that just calls terminate. This is used when
2010 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00002011 llvm::BasicBlock *getTerminateHandler();
2012
Chris Lattnera5f58b02011-07-09 17:41:47 +00002013 llvm::Type *ConvertTypeForMem(QualType T);
2014 llvm::Type *ConvertType(QualType T);
2015 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00002016 return ConvertType(getContext().getTypeDeclType(T));
2017 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00002018
Mike Stumpfc496822009-02-08 23:14:22 +00002019 /// LoadObjCSelf - Load the value of self. This function is only valid while
2020 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00002021 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00002022
2023 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002024 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00002025
Krasimir Georgiev46dfb7a2017-09-08 13:44:51 +00002026 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
John McCall47fb9502013-03-07 21:37:08 +00002027 static TypeEvaluationKind getEvaluationKind(QualType T);
2028
2029 static bool hasScalarEvaluationKind(QualType T) {
2030 return getEvaluationKind(T) == TEK_Scalar;
2031 }
2032
2033 static bool hasAggregateEvaluationKind(QualType T) {
2034 return getEvaluationKind(T) == TEK_Aggregate;
2035 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00002036
2037 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00002038 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00002039 llvm::Function *parent = nullptr,
2040 llvm::BasicBlock *before = nullptr) {
John McCallad7c5c12011-02-08 08:22:06 +00002041 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar75283ff2008-11-11 02:29:29 +00002042 }
Mike Stumpfc496822009-02-08 23:14:22 +00002043
Chris Lattnerac248202007-05-30 00:13:02 +00002044 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
2045 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002046 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00002047
Mike Stumpe5311b02009-11-30 20:08:49 +00002048 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
2049 /// another basic block, simplify it. This assumes that no other code could
2050 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00002051 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
2052
Mike Stumpfc496822009-02-08 23:14:22 +00002053 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
2054 /// adding a fall-through branch from the current insert block if
2055 /// necessary. It is legal to call this function even if there is no current
2056 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00002057 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002058 /// IsFinished - If true, indicates that the caller has finished emitting
2059 /// branches to the given block and does not expect to emit code into it. This
2060 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00002061 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00002062
John McCall8e4c74b2011-08-11 02:22:43 +00002063 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
2064 /// near its uses, and leave the insertion point in it.
2065 void EmitBlockAfterUses(llvm::BasicBlock *BB);
2066
Mike Stumpfc496822009-02-08 23:14:22 +00002067 /// EmitBranch - Emit a branch to the specified basic block from the current
2068 /// insert block, taking care to avoid creation of branches from dummy
2069 /// blocks. It is legal to call this function even if there is no current
2070 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00002071 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002072 /// This function clears the current insertion point. The caller should follow
2073 /// calls to this function with calls to Emit*Block prior to generation new
2074 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00002075 void EmitBranch(llvm::BasicBlock *Block);
2076
Mike Stumpfc496822009-02-08 23:14:22 +00002077 /// HaveInsertPoint - True if an insertion point is defined. If not, this
2078 /// indicates that the current code being emitted is unreachable.
2079 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002080 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002081 }
2082
Mike Stumpfc496822009-02-08 23:14:22 +00002083 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
2084 /// emitted IR has a place to go. Note that by definition, if this function
2085 /// creates a block then that block is unreachable; callers may do better to
2086 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002087 void EnsureInsertPoint() {
2088 if (!HaveInsertPoint())
2089 EmitBlock(createBasicBlock());
2090 }
Mike Stumpfc496822009-02-08 23:14:22 +00002091
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00002092 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00002093 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00002094 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00002095
Chris Lattnere9a64532007-06-22 21:44:33 +00002096 //===--------------------------------------------------------------------===//
2097 // Helpers
2098 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002099
John McCall7f416cc2015-09-08 08:05:57 +00002100 LValue MakeAddrLValue(Address Addr, QualType T,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002101 AlignmentSource Source = AlignmentSource::Type) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00002102 return LValue::MakeAddr(Addr, T, getContext(), LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002103 CGM.getTBAAAccessInfo(T));
2104 }
2105
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00002106 LValue MakeAddrLValue(Address Addr, QualType T, LValueBaseInfo BaseInfo,
2107 TBAAAccessInfo TBAAInfo) {
2108 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00002109 }
John McCall4e8ca4f2012-07-02 23:58:38 +00002110
John McCall7f416cc2015-09-08 08:05:57 +00002111 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002112 AlignmentSource Source = AlignmentSource::Type) {
2113 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00002114 LValueBaseInfo(Source), CGM.getTBAAAccessInfo(T));
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002115 }
2116
2117 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00002118 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00002119 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00002120 BaseInfo, TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +00002121 }
2122
2123 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00002124 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00002125 CharUnits getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00002126 LValueBaseInfo *BaseInfo = nullptr,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +00002127 TBAAAccessInfo *TBAAInfo = nullptr,
John McCall7f416cc2015-09-08 08:05:57 +00002128 bool forPointeeType = false);
2129 CharUnits getNaturalPointeeTypeAlignment(QualType T,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00002130 LValueBaseInfo *BaseInfo = nullptr,
2131 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00002132
Ivan A. Kosarev9f9d1572017-10-30 11:49:31 +00002133 Address EmitLoadOfReference(LValue RefLVal,
2134 LValueBaseInfo *PointeeBaseInfo = nullptr,
2135 TBAAAccessInfo *PointeeTBAAInfo = nullptr);
2136 LValue EmitLoadOfReferenceLValue(LValue RefLVal);
2137 LValue EmitLoadOfReferenceLValue(Address RefAddr, QualType RefTy,
2138 AlignmentSource Source =
2139 AlignmentSource::Type) {
2140 LValue RefLVal = MakeAddrLValue(RefAddr, RefTy, LValueBaseInfo(Source),
2141 CGM.getTBAAAccessInfo(RefTy));
2142 return EmitLoadOfReferenceLValue(RefLVal);
2143 }
Daniel Dunbar93b00a92010-08-21 02:53:44 +00002144
Alexey Bataev31300ed2016-02-04 11:27:03 +00002145 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
Ivan A. Kosarev90295642017-10-13 16:47:22 +00002146 LValueBaseInfo *BaseInfo = nullptr,
2147 TBAAAccessInfo *TBAAInfo = nullptr);
Alexey Bataev31300ed2016-02-04 11:27:03 +00002148 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
2149
Yaxun Liu84744c12017-06-19 17:03:41 +00002150 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
2151 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
2152 /// insertion point of the builder. The caller is responsible for setting an
2153 /// appropriate alignment on
Daniel Dunbara7566f12010-02-09 02:48:28 +00002154 /// the alloca.
Yaxun Liu84744c12017-06-19 17:03:41 +00002155 ///
2156 /// \p ArraySize is the number of array elements to be allocated if it
2157 /// is not nullptr.
2158 ///
2159 /// LangAS::Default is the address space of pointers to local variables and
2160 /// temporaries, as exposed in the source language. In certain
2161 /// configurations, this is not the same as the alloca address space, and a
2162 /// cast is needed to lift the pointer from the alloca AS into
2163 /// LangAS::Default. This can happen when the target uses a restricted
2164 /// address space for the stack but the source language requires
2165 /// LangAS::Default to be a generic address space. The latter condition is
2166 /// common for most programming languages; OpenCL is an exception in that
2167 /// LangAS::Default is the private address space, which naturally maps
2168 /// to the stack.
2169 ///
2170 /// Because the address of a temporary is often exposed to the program in
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002171 /// various ways, this function will perform the cast. The original alloca
2172 /// instruction is returned through \p Alloca if it is not nullptr.
2173 ///
2174 /// The cast is not performaed in CreateTempAllocaWithoutCast. This is
Yaxun Liu84744c12017-06-19 17:03:41 +00002175 /// more efficient if the caller knows that the address will not be exposed.
2176 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
2177 llvm::Value *ArraySize = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00002178 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
Yaxun Liu84744c12017-06-19 17:03:41 +00002179 const Twine &Name = "tmp",
2180 llvm::Value *ArraySize = nullptr,
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002181 Address *Alloca = nullptr);
2182 Address CreateTempAllocaWithoutCast(llvm::Type *Ty, CharUnits align,
2183 const Twine &Name = "tmp",
2184 llvm::Value *ArraySize = nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002185
John McCall7f416cc2015-09-08 08:05:57 +00002186 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
2187 /// default ABI alignment of the given LLVM type.
2188 ///
2189 /// IMPORTANT NOTE: This is *not* generally the right alignment for
2190 /// any given AST type that happens to have been lowered to the
2191 /// given IR type. This should only ever be used for function-local,
2192 /// IR-driven manipulations like saving and restoring a value. Do
2193 /// not hand this address off to arbitrary IRGen routines, and especially
2194 /// do not pass it as an argument to a function that might expect a
2195 /// properly ABI-aligned value.
2196 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
2197 const Twine &Name = "tmp");
2198
2199 /// InitTempAlloca - Provide an initial value for the given alloca which
2200 /// will be observable at all locations in the function.
2201 ///
2202 /// The address should be something that was returned from one of
2203 /// the CreateTempAlloca or CreateMemTemp routines, and the
2204 /// initializer must be valid in the entry block (i.e. it must
2205 /// either be a constant or an argument value).
2206 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00002207
Daniel Dunbard0049182010-02-16 19:44:13 +00002208 /// CreateIRTemp - Create a temporary IR object of the given type, with
2209 /// appropriate alignment. This routine should only be used when an temporary
2210 /// value needs to be stored into an alloca (for example, to avoid explicit
2211 /// PHI construction), but the type is the IR type, not the type appropriate
2212 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00002213 ///
2214 /// That is, this is exactly equivalent to CreateMemTemp, but calling
2215 /// ConvertType instead of ConvertTypeForMem.
2216 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00002217
Daniel Dunbara7566f12010-02-09 02:48:28 +00002218 /// CreateMemTemp - Create a temporary memory object of the given type, with
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002219 /// appropriate alignmen and cast it to the default address space. Returns
2220 /// the original alloca instruction by \p Alloca if it is not nullptr.
Yaxun Liu84744c12017-06-19 17:03:41 +00002221 Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002222 Address *Alloca = nullptr);
Yaxun Liu84744c12017-06-19 17:03:41 +00002223 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002224 Address *Alloca = nullptr);
2225
2226 /// CreateMemTemp - Create a temporary memory object of the given type, with
2227 /// appropriate alignmen without casting it to the default address space.
2228 Address CreateMemTempWithoutCast(QualType T, const Twine &Name = "tmp");
2229 Address CreateMemTempWithoutCast(QualType T, CharUnits Align,
2230 const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00002231
John McCall7a626f62010-09-15 10:14:12 +00002232 /// CreateAggTemp - Create a temporary memory object for the given
2233 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00002234 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
John McCall7f416cc2015-09-08 08:05:57 +00002235 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00002236 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00002237 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00002238 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00002239 AggValueSlot::IsNotAliased,
2240 AggValueSlot::DoesNotOverlap);
John McCall7a626f62010-09-15 10:14:12 +00002241 }
2242
John McCallad7c5c12011-02-08 08:22:06 +00002243 /// Emit a cast to void* in the appropriate address space.
2244 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2245
Chris Lattner8394d792007-06-05 20:53:16 +00002246 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2247 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00002248 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00002249
John McCalla2342eb2010-12-05 02:00:02 +00002250 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2251 void EmitIgnoredExpr(const Expr *E);
2252
Chris Lattner4647a212007-08-31 22:49:20 +00002253 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2254 /// any type. The result is returned as an RValue struct. If this is an
2255 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2256 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00002257 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00002258 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00002259 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00002260 AggValueSlot aggSlot = AggValueSlot::ignored(),
2261 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00002262
Mike Stumpfc496822009-02-08 23:14:22 +00002263 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2264 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00002265 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002266
Charles Davisc7d5c942015-09-17 20:55:33 +00002267 /// Emit a "reference" to a __builtin_ms_va_list; this is
2268 /// always the value of the expression, because a __builtin_ms_va_list is a
2269 /// pointer to a char.
2270 Address EmitMSVAListRef(const Expr *E);
2271
Gor Nishanov5eb58582017-03-26 02:18:05 +00002272 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
Mike Stumpfc496822009-02-08 23:14:22 +00002273 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00002274 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00002275
John McCall91ca10f2011-03-08 09:11:50 +00002276 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00002277 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00002278 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002279 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00002280
John McCall7f416cc2015-09-08 08:05:57 +00002281 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00002282
John McCall91ca10f2011-03-08 09:11:50 +00002283 /// EmitExprAsInit - Emits the code necessary to initialize a
2284 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00002285 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002286 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00002287
Fariborz Jahanian78652202013-01-25 23:57:05 +00002288 /// hasVolatileMember - returns true if aggregate type has a volatile
2289 /// member.
2290 bool hasVolatileMember(QualType T) {
2291 if (const RecordType *RT = T->getAs<RecordType>()) {
2292 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2293 return RD->hasVolatileMember();
2294 }
2295 return false;
2296 }
Richard Smithe78fac52018-04-05 20:52:58 +00002297
2298 /// Determine whether a return value slot may overlap some other object.
2299 AggValueSlot::Overlap_t overlapForReturnValue() {
2300 // FIXME: Assuming no overlap here breaks guaranteed copy elision for base
2301 // class subobjects. These cases may need to be revisited depending on the
2302 // resolution of the relevant core issue.
2303 return AggValueSlot::DoesNotOverlap;
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002304 }
2305
Richard Smithe78fac52018-04-05 20:52:58 +00002306 /// Determine whether a field initialization may overlap some other object.
2307 AggValueSlot::Overlap_t overlapForFieldInit(const FieldDecl *FD) {
2308 // FIXME: These cases can result in overlap as a result of P0840R0's
2309 // [[no_unique_address]] attribute. We can still infer NoOverlap in the
2310 // presence of that attribute if the field is within the nvsize of its
2311 // containing class, because non-virtual subobjects are initialized in
2312 // address order.
2313 return AggValueSlot::DoesNotOverlap;
2314 }
2315
2316 /// Determine whether a base class initialization may overlap some other
2317 /// object.
2318 AggValueSlot::Overlap_t overlapForBaseInit(const CXXRecordDecl *RD,
2319 const CXXRecordDecl *BaseRD,
2320 bool IsVirtual);
2321
2322 /// Emit an aggregate assignment.
2323 void EmitAggregateAssign(LValue Dest, LValue Src, QualType EltTy) {
2324 bool IsVolatile = hasVolatileMember(EltTy);
2325 EmitAggregateCopy(Dest, Src, EltTy, AggValueSlot::MayOverlap, IsVolatile);
2326 }
2327
2328 void EmitAggregateCopyCtor(LValue Dest, LValue Src,
2329 AggValueSlot::Overlap_t MayOverlap) {
2330 EmitAggregateCopy(Dest, Src, Src.getType(), MayOverlap);
David Majnemerfd1e7392015-02-03 23:04:06 +00002331 }
2332
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002333 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00002334 ///
Richard Smithe78fac52018-04-05 20:52:58 +00002335 /// \param isVolatile \c true iff either the source or the destination is
2336 /// volatile.
2337 /// \param MayOverlap Whether the tail padding of the destination might be
2338 /// occupied by some other object. More efficient code can often be
2339 /// generated if not.
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00002340 void EmitAggregateCopy(LValue Dest, LValue Src, QualType EltTy,
Richard Smithe78fac52018-04-05 20:52:58 +00002341 AggValueSlot::Overlap_t MayOverlap,
2342 bool isVolatile = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00002343
Anders Carlsson9396a892008-09-11 09:15:33 +00002344 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00002345 Address GetAddrOfLocalVar(const VarDecl *VD) {
2346 auto it = LocalDeclMap.find(VD);
2347 assert(it != LocalDeclMap.end() &&
2348 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2349 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00002350 }
Mike Stumpfc496822009-02-08 23:14:22 +00002351
Akira Hatanaka797afe32018-03-20 01:47:58 +00002352 /// Given an opaque value expression, return its LValue mapping if it exists,
2353 /// otherwise create one.
2354 LValue getOrCreateOpaqueLValueMapping(const OpaqueValueExpr *e);
John McCallc07a0c72011-02-17 10:25:35 +00002355
Akira Hatanaka797afe32018-03-20 01:47:58 +00002356 /// Given an opaque value expression, return its RValue mapping if it exists,
2357 /// otherwise create one.
2358 RValue getOrCreateOpaqueRValueMapping(const OpaqueValueExpr *e);
John McCall1bf58462011-02-16 08:02:54 +00002359
Richard Smith410306b2016-12-12 02:53:20 +00002360 /// Get the index of the current ArrayInitLoopExpr, if any.
2361 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2362
Dan Gohman75d69da2008-05-22 00:50:06 +00002363 /// getAccessedFieldNo - Given an encoded value and a result number, return
2364 /// the input field number being accessed.
2365 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2366
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002367 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002368 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002369
Vedant Kumarffd7c882017-04-14 22:03:34 +00002370 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2371 static bool IsWrappedCXXThis(const Expr *E);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00002372
Anders Carlssonc0964b62010-05-22 17:35:42 +00002373 /// EmitNullInitialization - Generate code to set a value of the given type to
2374 /// null, If the type contains data member pointers, they will be initialized
2375 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002376 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002377
Charles Davisc7d5c942015-09-17 20:55:33 +00002378 /// Emits a call to an LLVM variable-argument intrinsic, either
2379 /// \c llvm.va_start or \c llvm.va_end.
2380 /// \param ArgValue A reference to the \c va_list as emitted by either
2381 /// \c EmitVAListRef or \c EmitMSVAListRef.
2382 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2383 /// calls \c llvm.va_end.
2384 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2385
2386 /// Generate code to get an argument from the passed in pointer
2387 /// and update it accordingly.
2388 /// \param VE The \c VAArgExpr for which to generate code.
2389 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2390 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2391 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002392 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002393 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002394 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002395
John McCall82fe67b2011-07-09 01:37:26 +00002396 /// emitArrayLength - Compute the length of an array, even if it's a
2397 /// VLA, and drill down to the base element type.
2398 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2399 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002400 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002401
John McCall23c29fe2011-06-24 21:55:10 +00002402 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2403 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002404 ///
2405 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002406 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002407
Sander de Smalen891af03a2018-02-03 13:55:59 +00002408 struct VlaSizePair {
2409 llvm::Value *NumElts;
2410 QualType Type;
2411
2412 VlaSizePair(llvm::Value *NE, QualType T) : NumElts(NE), Type(T) {}
2413 };
2414
2415 /// Return the number of elements for a single dimension
2416 /// for the given array type.
2417 VlaSizePair getVLAElements1D(const VariableArrayType *vla);
2418 VlaSizePair getVLAElements1D(QualType vla);
2419
2420 /// Returns an LLVM value that corresponds to the size,
John McCall23c29fe2011-06-24 21:55:10 +00002421 /// in non-variably-sized elements, of a variable length array type,
2422 /// plus that largest non-variably-sized element type. Assumes that
2423 /// the type has already been emitted with EmitVariablyModifiedType.
Sander de Smalen891af03a2018-02-03 13:55:59 +00002424 VlaSizePair getVLASize(const VariableArrayType *vla);
2425 VlaSizePair getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002426
Anders Carlssona5d077d2009-04-14 16:58:56 +00002427 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2428 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002429 llvm::Value *LoadCXXThis() {
2430 assert(CXXThisValue && "no 'this' value for this function");
2431 return CXXThisValue;
2432 }
John McCall7f416cc2015-09-08 08:05:57 +00002433 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002434
Anders Carlssone36a6b32010-01-02 01:01:18 +00002435 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2436 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002437 // FIXME: Every place that calls LoadCXXVTT is something
2438 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002439 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002440 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2441 return CXXStructorImplicitParamValue;
2442 }
2443
John McCall6ce74722010-02-16 04:15:37 +00002444 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002445 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002446 Address
2447 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002448 const CXXRecordDecl *Derived,
2449 const CXXRecordDecl *Base,
2450 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002451
John McCall7f416cc2015-09-08 08:05:57 +00002452 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2453
Mike Stumpe5311b02009-11-30 20:08:49 +00002454 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2455 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002456 Address GetAddressOfBaseClass(Address Value,
2457 const CXXRecordDecl *Derived,
2458 CastExpr::path_const_iterator PathBegin,
2459 CastExpr::path_const_iterator PathEnd,
2460 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002461
John McCall7f416cc2015-09-08 08:05:57 +00002462 Address GetAddressOfDerivedClass(Address Value,
2463 const CXXRecordDecl *Derived,
2464 CastExpr::path_const_iterator PathBegin,
2465 CastExpr::path_const_iterator PathEnd,
2466 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002467
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002468 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2469 /// base constructor/destructor with virtual bases.
2470 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2471 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2472 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2473 bool Delegating);
2474
John McCallf8ff7b92010-02-23 00:48:20 +00002475 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2476 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002477 const FunctionArgList &Args,
2478 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002479 // It's important not to confuse this and the previous function. Delegating
2480 // constructors are the C++0x feature. The constructor delegate optimization
2481 // is used to reduce duplication in the base and complete consturctors where
2482 // they are substantially the same.
2483 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2484 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002485
Richard Smith5179eb72016-06-28 19:03:57 +00002486 /// Emit a call to an inheriting constructor (that is, one that invokes a
2487 /// constructor inherited from a base class) by inlining its definition. This
2488 /// is necessary if the ABI does not support forwarding the arguments to the
2489 /// base class constructor (because they're variadic or similar).
2490 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2491 CXXCtorType CtorType,
2492 bool ForVirtualBase,
2493 bool Delegating,
2494 CallArgList &Args);
2495
2496 /// Emit a call to a constructor inherited from a base class, passing the
2497 /// current constructor's arguments along unmodified (without even making
2498 /// a copy).
2499 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2500 bool ForVirtualBase, Address This,
2501 bool InheritedFromVBase,
2502 const CXXInheritedCtorInitExpr *E);
2503
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002504 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002505 bool ForVirtualBase, bool Delegating,
Richard Smithe78fac52018-04-05 20:52:58 +00002506 Address This, const CXXConstructExpr *E,
Serge Pavlov37605182018-07-28 15:33:03 +00002507 AggValueSlot::Overlap_t Overlap,
2508 bool NewPointerIsChecked);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002509
Richard Smith5179eb72016-06-28 19:03:57 +00002510 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2511 bool ForVirtualBase, bool Delegating,
Richard Smithe78fac52018-04-05 20:52:58 +00002512 Address This, CallArgList &Args,
Igor Kudrineff8f9d2018-06-25 05:48:04 +00002513 AggValueSlot::Overlap_t Overlap,
Serge Pavlov37605182018-07-28 15:33:03 +00002514 SourceLocation Loc,
2515 bool NewPointerIsChecked);
Richard Smith5179eb72016-06-28 19:03:57 +00002516
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002517 /// Emit assumption load for all bases. Requires to be be called only on
2518 /// most-derived class and not under construction of the object.
2519 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2520
2521 /// Emit assumption that vptr load == global vtable.
2522 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2523
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002524 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002525 Address This, Address Src,
2526 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002527
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002528 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002529 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002530 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002531 const CXXConstructExpr *E,
Serge Pavlov37605182018-07-28 15:33:03 +00002532 bool NewPointerIsChecked,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002533 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002534
Anders Carlssond49844b2009-09-23 02:45:36 +00002535 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2536 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002537 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002538 const CXXConstructExpr *E,
Serge Pavlov37605182018-07-28 15:33:03 +00002539 bool NewPointerIsChecked,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002540 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002541
John McCall82fe67b2011-07-09 01:37:26 +00002542 static Destroyer destroyCXXObject;
2543
Anders Carlsson0a637412009-05-29 21:03:38 +00002544 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002545 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002546 Address This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002547
John McCall99210dc2011-09-15 06:49:18 +00002548 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002549 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002550 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002551 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002552
Peter Collingbourne702b2842011-11-27 22:09:22 +00002553 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002554 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002555
David Majnemerdc012fa2015-04-22 21:38:15 +00002556 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2557 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2558
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002559 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002560 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002561
Eli Friedman24f55432009-11-18 00:57:03 +00002562 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002563 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2564 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002565
Richard Smith760520b2014-06-03 23:27:44 +00002566 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
Eric Fiselierfa752f22018-03-21 19:19:48 +00002567 const CallExpr *TheCallExpr, bool IsDelete);
Richard Smith760520b2014-06-03 23:27:44 +00002568
John McCall7f416cc2015-09-08 08:05:57 +00002569 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2570 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2571 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002572
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002573 /// Situations in which we might emit a check for the suitability of a
Richard Smith69d0d262012-08-24 00:54:33 +00002574 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00002575 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002576 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002577 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002578 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002579 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002580 /// Checking the bound value in a reference binding. Must be suitably sized
2581 /// and aligned, but is not required to refer to an object (until the
2582 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002583 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002584 /// Checking the object expression in a non-static data member access. Must
2585 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002586 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002587 /// Checking the 'this' pointer for a call to a non-static member function.
2588 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002589 TCK_MemberCall,
2590 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002591 TCK_ConstructorCall,
2592 /// Checking the operand of a static_cast to a derived pointer type. Must be
2593 /// null or an object within its lifetime.
2594 TCK_DowncastPointer,
2595 /// Checking the operand of a static_cast to a derived reference type. Must
2596 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002597 TCK_DowncastReference,
2598 /// Checking the operand of a cast to a base object. Must be suitably sized
2599 /// and aligned.
2600 TCK_Upcast,
2601 /// Checking the operand of a cast to a virtual base object. Must be an
2602 /// object within its lifetime.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002603 TCK_UpcastToVirtualBase,
2604 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002605 TCK_NonnullAssign,
2606 /// Checking the operand of a dynamic_cast or a typeid expression. Must be
2607 /// null or an object within its lifetime.
2608 TCK_DynamicOperation
Richard Smith69d0d262012-08-24 00:54:33 +00002609 };
2610
Vedant Kumar24792e32017-10-03 01:27:25 +00002611 /// Determine whether the pointer type check \p TCK permits null pointers.
2612 static bool isNullPointerAllowed(TypeCheckKind TCK);
2613
2614 /// Determine whether the pointer type check \p TCK requires a vptr check.
2615 static bool isVptrCheckRequired(TypeCheckKind TCK, QualType Ty);
2616
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002617 /// Whether any type-checking sanitizers are enabled. If \c false,
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002618 /// calls to EmitTypeCheck can be skipped.
2619 bool sanitizePerformTypeCheck() const;
2620
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002621 /// Emit a check that \p V is the address of storage of the
Richard Smithcfa79b22019-01-23 03:37:29 +00002622 /// appropriate size and alignment for an object of type \p Type
2623 /// (or if ArraySize is provided, for an array of that bound).
Richard Smithe30752c2012-10-09 19:52:38 +00002624 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002625 QualType Type, CharUnits Alignment = CharUnits::Zero(),
Richard Smithcfa79b22019-01-23 03:37:29 +00002626 SanitizerSet SkippedChecks = SanitizerSet(),
2627 llvm::Value *ArraySize = nullptr);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002628
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002629 /// Emit a check that \p Base points into an array object, which
Richard Smith539e4a72013-02-23 02:53:19 +00002630 /// we can access at index \p Index. \p Accessed should be \c false if we
2631 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2632 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2633 QualType IndexType, bool Accessed);
2634
Chris Lattner116ce8f2010-01-09 21:40:03 +00002635 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2636 bool isInc, bool isPre);
2637 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2638 bool isInc, bool isPre);
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 Hatanaka8e57b072018-10-01 21:51:28 +00002686 /// True if the variable is a __block variable that is captured by an
2687 /// escaping block.
2688 bool IsEscapingByRef;
John McCallc533cb72011-02-22 06:44:22 +00002689
2690 /// True if the variable is of aggregate type and has a constant
2691 /// initializer.
2692 bool IsConstantAggregate;
2693
Nadav Rotem1da30942013-03-23 06:43:35 +00002694 /// Non-null if we should use lifetime annotations.
2695 llvm::Value *SizeForLifetimeMarkers;
2696
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002697 /// Address with original alloca instruction. Invalid if the variable was
2698 /// emitted as a global constant.
2699 Address AllocaAddr;
2700
John McCall9e2e22f2011-02-22 07:16:58 +00002701 struct Invalid {};
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002702 AutoVarEmission(Invalid)
2703 : Variable(nullptr), Addr(Address::invalid()),
2704 AllocaAddr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002705
John McCallc533cb72011-02-22 06:44:22 +00002706 AutoVarEmission(const VarDecl &variable)
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002707 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002708 IsEscapingByRef(false), IsConstantAggregate(false),
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002709 SizeForLifetimeMarkers(nullptr), AllocaAddr(Address::invalid()) {}
John McCallc533cb72011-02-22 06:44:22 +00002710
John McCall7f416cc2015-09-08 08:05:57 +00002711 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002712
2713 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002714 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2715
Craig Topper8a13c412014-05-21 05:09:00 +00002716 bool useLifetimeMarkers() const {
2717 return SizeForLifetimeMarkers != nullptr;
2718 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002719 llvm::Value *getSizeForLifetimeMarkers() const {
2720 assert(useLifetimeMarkers());
2721 return SizeForLifetimeMarkers;
2722 }
2723
2724 /// Returns the raw, allocated address, which is not necessarily
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002725 /// the address of the object itself. It is casted to default
2726 /// address space for address space agnostic languages.
John McCall7f416cc2015-09-08 08:05:57 +00002727 Address getAllocatedAddress() const {
2728 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002729 }
2730
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002731 /// Returns the address for the original alloca instruction.
2732 Address getOriginalAllocatedAddress() const { return AllocaAddr; }
2733
John McCallc533cb72011-02-22 06:44:22 +00002734 /// Returns the address of the object within this declaration.
2735 /// Note that this does not chase the forwarding pointer for
2736 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002737 Address getObjectAddress(CodeGenFunction &CGF) const {
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002738 if (!IsEscapingByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002739
John McCall7f416cc2015-09-08 08:05:57 +00002740 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002741 }
2742 };
2743 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2744 void EmitAutoVarInit(const AutoVarEmission &emission);
Gor Nishanov04491bd2017-11-11 17:00:43 +00002745 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002746 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2747 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002748
Sander de Smalen891af03a2018-02-03 13:55:59 +00002749 /// Emits the alloca and debug information for the size expressions for each
2750 /// dimension of an array. It registers the association of its (1-dimensional)
2751 /// QualTypes and size expression's debug node, so that CGDebugInfo can
2752 /// reference this node when creating the DISubrange object to describe the
2753 /// array types.
2754 void EmitAndRegisterVariableArrayDimensions(CGDebugInfo *DI,
2755 const VarDecl &D,
2756 bool EmitDebugInfo);
2757
John McCall1c9c3fd2010-10-15 04:57:14 +00002758 void EmitStaticVarDecl(const VarDecl &D,
2759 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002760
John McCall7f416cc2015-09-08 08:05:57 +00002761 class ParamValue {
2762 llvm::Value *Value;
2763 unsigned Alignment;
2764 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2765 public:
2766 static ParamValue forDirect(llvm::Value *value) {
2767 return ParamValue(value, 0);
2768 }
2769 static ParamValue forIndirect(Address addr) {
2770 assert(!addr.getAlignment().isZero());
2771 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2772 }
2773
2774 bool isIndirect() const { return Alignment != 0; }
2775 llvm::Value *getAnyValue() const { return Value; }
Gor Nishanov04491bd2017-11-11 17:00:43 +00002776
John McCall7f416cc2015-09-08 08:05:57 +00002777 llvm::Value *getDirectValue() const {
2778 assert(!isIndirect());
2779 return Value;
2780 }
2781
2782 Address getIndirectAddress() const {
2783 assert(isIndirect());
2784 return Address(Value, CharUnits::fromQuantity(Alignment));
2785 }
2786 };
2787
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002788 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002789 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002790
John McCallc07a0c72011-02-17 10:25:35 +00002791 /// protectFromPeepholes - Protect a value that we're intending to
2792 /// store to the side, but which will probably be used later, from
2793 /// aggressive peepholing optimizations that might delete it.
2794 ///
2795 /// Pass the result to unprotectFromPeepholes to declare that
2796 /// protection is no longer required.
2797 ///
2798 /// There's no particular reason why this shouldn't apply to
2799 /// l-values, it's just that no existing peepholes work on pointers.
2800 PeepholeProtection protectFromPeepholes(RValue rvalue);
2801 void unprotectFromPeepholes(PeepholeProtection protection);
2802
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002803 void EmitAlignmentAssumptionCheck(llvm::Value *Ptr, QualType Ty,
2804 SourceLocation Loc,
2805 SourceLocation AssumptionLoc,
2806 llvm::Value *Alignment,
2807 llvm::Value *OffsetValue,
2808 llvm::Value *TheCheck,
2809 llvm::Instruction *Assumption);
2810
2811 void EmitAlignmentAssumption(llvm::Value *PtrValue, QualType Ty,
2812 SourceLocation Loc, SourceLocation AssumptionLoc,
2813 llvm::Value *Alignment,
2814 llvm::Value *OffsetValue = nullptr);
2815
2816 void EmitAlignmentAssumption(llvm::Value *PtrValue, QualType Ty,
2817 SourceLocation Loc, SourceLocation AssumptionLoc,
2818 unsigned Alignment,
2819 llvm::Value *OffsetValue = nullptr);
2820
2821 void EmitAlignmentAssumption(llvm::Value *PtrValue, const Expr *E,
2822 SourceLocation AssumptionLoc, unsigned Alignment,
2823 llvm::Value *OffsetValue = nullptr);
Erich Keane623efd82017-03-30 21:48:55 +00002824
Chris Lattner84915fa2007-06-02 04:16:21 +00002825 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002826 // Statement Emission
2827 //===--------------------------------------------------------------------===//
2828
Mike Stumpfc496822009-02-08 23:14:22 +00002829 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002830 void EmitStopPoint(const Stmt *S);
2831
Mike Stumpfc496822009-02-08 23:14:22 +00002832 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2833 /// this function even if there is no current insertion point.
2834 ///
2835 /// This function may clear the current insertion point; callers should use
2836 /// EnsureInsertPoint if they wish to subsequently generate code without first
2837 /// calling EmitBlock, EmitBranch, or EmitStmt.
Karl-Johan Karlsson33e205a2017-09-06 08:47:18 +00002838 void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002839
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002840 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002841 /// necessarily require an insertion point or debug information; typically
2842 /// because the statement amounts to a jump or a container of other
2843 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002844 ///
2845 /// \return True if the statement was handled.
2846 bool EmitSimpleStmt(const Stmt *S);
2847
John McCall7f416cc2015-09-08 08:05:57 +00002848 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2849 AggValueSlot AVS = AggValueSlot::ignored());
2850 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2851 bool GetLast = false,
2852 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002853 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002854
Mike Stumpfc496822009-02-08 23:14:22 +00002855 /// EmitLabel - Emit the block for the given label. It is legal to call this
2856 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002857 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002858
Chris Lattnerac248202007-05-30 00:13:02 +00002859 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002860 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002861 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002862 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002863 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002864
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002865 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002866 ArrayRef<const Attr *> Attrs = None);
2867 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002868 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002869 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002870 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002871 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002872 void EmitBreakStmt(const BreakStmt &S);
2873 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002874 void EmitSwitchStmt(const SwitchStmt &S);
2875 void EmitDefaultStmt(const DefaultStmt &S);
2876 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002877 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002878 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002879
Anders Carlsson2e744e82008-08-30 19:51:14 +00002880 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002881 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2882 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002883 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002884 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002885
Gor Nishanov8df64e92016-10-27 16:28:31 +00002886 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov90be1212017-03-06 21:12:54 +00002887 void EmitCoreturnStmt(const CoreturnStmt &S);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002888 RValue EmitCoawaitExpr(const CoawaitExpr &E,
2889 AggValueSlot aggSlot = AggValueSlot::ignored(),
2890 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002891 LValue EmitCoawaitLValue(const CoawaitExpr *E);
Gor Nishanov5eb58582017-03-26 02:18:05 +00002892 RValue EmitCoyieldExpr(const CoyieldExpr &E,
2893 AggValueSlot aggSlot = AggValueSlot::ignored(),
2894 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00002895 LValue EmitCoyieldLValue(const CoyieldExpr *E);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00002896 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2897
John McCallb609d3f2010-07-07 06:56:46 +00002898 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2899 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002900
Anders Carlsson52d78a52009-09-27 18:58:34 +00002901 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002902 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00002903 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002904 void EnterSEHTryStmt(const SEHTryStmt &S);
2905 void ExitSEHTryStmt(const SEHTryStmt &S);
2906
David Chisnall93ce0182018-08-10 12:53:13 +00002907 void pushSEHCleanup(CleanupKind kind,
2908 llvm::Function *FinallyFunc);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002909 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002910 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002911
2912 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2913 const SEHExceptStmt &Except);
2914
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002915 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2916 const SEHFinallyStmt &Finally);
2917
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002918 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2919 llvm::Value *ParentFP,
2920 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002921 llvm::Value *EmitSEHExceptionCode();
2922 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00002923 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002924
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002925 /// Emit simple code for OpenMP directives in Simd-only mode.
2926 void EmitSimpleOMPExecutableDirective(const OMPExecutableDirective &D);
2927
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002928 /// Scan the outlined statement for captures from the parent function. For
2929 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002930 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00002931 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002932 bool IsFilter);
2933
2934 /// Recovers the address of a local in a parent function. ParentVar is the
2935 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00002936 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002937 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2938 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00002939 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2940 Address ParentVar,
2941 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00002942
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002943 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002944 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002945
Alexey Bataev2139ed62017-11-16 18:20:21 +00002946 /// Controls insertion of cancellation exit blocks in worksharing constructs.
2947 class OMPCancelStackRAII {
2948 CodeGenFunction &CGF;
2949
2950 public:
2951 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
2952 bool HasCancel)
2953 : CGF(CGF) {
2954 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
2955 }
2956 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
2957 };
2958
Alexey Bataev1189bd02016-01-26 12:20:39 +00002959 /// Returns calculated size of the specified type.
2960 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00002961 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002962 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00002963 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00002964 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Samuel Antao6d004262016-06-16 18:39:34 +00002965 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
Alexey Bataev2377fe92015-09-10 08:12:02 +00002966 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00002967 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00002968 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2969 SourceLocation Loc);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002970 /// Perform element by element copying of arrays with type \a
Alexey Bataev420d45b2015-04-14 05:11:24 +00002971 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2972 /// generated by \a CopyGen.
2973 ///
2974 /// \param DestAddr Address of the destination array.
2975 /// \param SrcAddr Address of the source array.
2976 /// \param OriginalType Type of destination and source arrays.
2977 /// \param CopyGen Copying procedure that copies value of single array element
2978 /// to another single array element.
2979 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00002980 Address DestAddr, Address SrcAddr, QualType OriginalType,
Alexey Bataevddf3db92018-04-13 17:31:06 +00002981 const llvm::function_ref<void(Address, Address)> CopyGen);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002982 /// Emit proper copying of data from one variable to another.
Alexey Bataev420d45b2015-04-14 05:11:24 +00002983 ///
2984 /// \param OriginalType Original type of the copied variables.
2985 /// \param DestAddr Destination address.
2986 /// \param SrcAddr Source address.
2987 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2988 /// type of the base array element).
2989 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2990 /// the base array element).
2991 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2992 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00002993 void EmitOMPCopy(QualType OriginalType,
2994 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00002995 const VarDecl *DestVD, const VarDecl *SrcVD,
2996 const Expr *Copy);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002997 /// Emit atomic update code for constructs: \a X = \a X \a BO \a E or
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002998 /// \a X = \a E \a BO \a E.
2999 ///
3000 /// \param X Value to be updated.
3001 /// \param E Update value.
3002 /// \param BO Binary operation for update operation.
3003 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
3004 /// expression, false otherwise.
3005 /// \param AO Atomic ordering of the generated atomic instructions.
3006 /// \param CommonGen Code generator for complex expressions that cannot be
3007 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00003008 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
3009 /// generated, <false, RValue::get(nullptr)> otherwise.
3010 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00003011 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
3012 llvm::AtomicOrdering AO, SourceLocation Loc,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003013 const llvm::function_ref<RValue(RValue)> CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00003014 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00003015 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00003016 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
3017 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00003018 void EmitOMPUseDevicePtrClause(
3019 const OMPClause &C, OMPPrivateScope &PrivateScope,
3020 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003021 /// Emit code for copyin clause in \a D directive. The next code is
Alexey Bataevf56f98c2015-04-16 05:39:01 +00003022 /// generated at the start of outlined functions for directives:
3023 /// \code
3024 /// threadprivate_var1 = master_threadprivate_var1;
3025 /// operator=(threadprivate_var2, master_threadprivate_var2);
3026 /// ...
3027 /// __kmpc_barrier(&loc, global_tid);
3028 /// \endcode
3029 ///
3030 /// \param D OpenMP directive possibly with 'copyin' clause(s).
3031 /// \returns true if at least one copyin variable is found, false otherwise.
3032 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003033 /// Emit initial code for lastprivate variables. If some variable is
Alexey Bataev38e89532015-04-16 04:54:05 +00003034 /// not also firstprivate, then the default initialization is used. Otherwise
3035 /// initialization of this variable is performed by EmitOMPFirstprivateClause
3036 /// method.
3037 ///
3038 /// \param D Directive that may have 'lastprivate' directives.
3039 /// \param PrivateScope Private scope for capturing lastprivate variables for
3040 /// proper codegen in internal captured statement.
3041 ///
3042 /// \returns true if there is at least one lastprivate variable, false
3043 /// otherwise.
3044 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
3045 OMPPrivateScope &PrivateScope);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003046 /// Emit final copying of lastprivate values to original variables at
Alexey Bataev38e89532015-04-16 04:54:05 +00003047 /// the end of the worksharing or simd directive.
3048 ///
3049 /// \param D Directive that has at least one 'lastprivate' directives.
3050 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
3051 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00003052 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00003053 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00003054 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00003055 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00003056 /// Emit initial code for linear clauses.
3057 void EmitOMPLinearClause(const OMPLoopDirective &D,
3058 CodeGenFunction::OMPPrivateScope &PrivateScope);
3059 /// Emit final code for linear clauses.
3060 /// \param CondGen Optional conditional code for final part of codegen for
3061 /// linear clause.
3062 void EmitOMPLinearClauseFinal(
3063 const OMPLoopDirective &D,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003064 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003065 /// Emit initial code for reduction variables. Creates reduction copies
Alexey Bataev794ba0d2015-04-10 10:43:45 +00003066 /// and initializes them with the values according to OpenMP standard.
3067 ///
3068 /// \param D Directive (possibly) with the 'reduction' clause.
3069 /// \param PrivateScope Private scope for capturing reduction variables for
3070 /// proper codegen in internal captured statement.
3071 ///
3072 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
3073 OMPPrivateScope &PrivateScope);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003074 /// Emit final update of reduction values to original variables at
Alexey Bataev794ba0d2015-04-10 10:43:45 +00003075 /// the end of the directive.
3076 ///
3077 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00003078 /// \param ReductionKind The kind of reduction to perform.
3079 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
3080 const OpenMPDirectiveKind ReductionKind);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003081 /// Emit initial code for linear variables. Creates private copies
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00003082 /// and initializes them with the values according to OpenMP standard.
3083 ///
3084 /// \param D Directive (possibly) with the 'linear' clause.
Alexey Bataev8c3edfe2017-08-16 15:58:46 +00003085 /// \return true if at least one linear variable is found that should be
3086 /// initialized with the value of the original variable, false otherwise.
3087 bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00003088
Alexey Bataev7292c292016-04-25 12:22:29 +00003089 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
James Y Knight9871db02019-02-05 16:42:33 +00003090 llvm::Function * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00003091 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00003092 TaskGenTy;
3093 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
Alexey Bataev475a7442018-01-12 19:39:11 +00003094 const OpenMPDirectiveKind CapturedRegion,
Alexey Bataev7292c292016-04-25 12:22:29 +00003095 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00003096 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataevd2202ca2017-12-27 17:58:32 +00003097 struct OMPTargetDataInfo {
3098 Address BasePointersArray = Address::invalid();
3099 Address PointersArray = Address::invalid();
3100 Address SizesArray = Address::invalid();
3101 unsigned NumberOfTargetItems = 0;
3102 explicit OMPTargetDataInfo() = default;
3103 OMPTargetDataInfo(Address BasePointersArray, Address PointersArray,
3104 Address SizesArray, unsigned NumberOfTargetItems)
3105 : BasePointersArray(BasePointersArray), PointersArray(PointersArray),
3106 SizesArray(SizesArray), NumberOfTargetItems(NumberOfTargetItems) {}
3107 };
3108 void EmitOMPTargetTaskBasedDirective(const OMPExecutableDirective &S,
3109 const RegionCodeGenTy &BodyGen,
3110 OMPTargetDataInfo &InputInfo);
Alexey Bataev7292c292016-04-25 12:22:29 +00003111
Alexey Bataev9959db52014-05-06 10:08:46 +00003112 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00003113 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00003114 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00003115 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00003116 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00003117 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00003118 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00003119 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00003120 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00003121 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00003122 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00003123 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00003124 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00003125 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00003126 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00003127 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00003128 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00003129 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00003130 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00003131 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00003132 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00003133 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00003134 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00003135 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00003136 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00003137 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00003138 void
3139 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00003140 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00003141 void
3142 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00003143 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00003144 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00003145 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00003146 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00003147 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00003148 void EmitOMPDistributeParallelForDirective(
3149 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00003150 void EmitOMPDistributeParallelForSimdDirective(
3151 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00003152 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00003153 void EmitOMPTargetParallelForSimdDirective(
3154 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00003155 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00003156 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00003157 void
3158 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00003159 void EmitOMPTeamsDistributeParallelForSimdDirective(
3160 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00003161 void EmitOMPTeamsDistributeParallelForDirective(
3162 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00003163 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00003164 void EmitOMPTargetTeamsDistributeDirective(
3165 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00003166 void EmitOMPTargetTeamsDistributeParallelForDirective(
3167 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00003168 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
3169 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00003170 void EmitOMPTargetTeamsDistributeSimdDirective(
3171 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00003172
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00003173 /// Emit device code for the target directive.
3174 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
3175 StringRef ParentName,
3176 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00003177 static void
3178 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3179 const OMPTargetParallelDirective &S);
Alexey Bataevfb0ebec2017-11-08 20:16:14 +00003180 /// Emit device code for the target parallel for directive.
3181 static void EmitOMPTargetParallelForDeviceFunction(
3182 CodeGenModule &CGM, StringRef ParentName,
3183 const OMPTargetParallelForDirective &S);
Alexey Bataev5d7edca2017-11-09 17:32:15 +00003184 /// Emit device code for the target parallel for simd directive.
3185 static void EmitOMPTargetParallelForSimdDeviceFunction(
3186 CodeGenModule &CGM, StringRef ParentName,
3187 const OMPTargetParallelForSimdDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003188 /// Emit device code for the target teams directive.
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00003189 static void
3190 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3191 const OMPTargetTeamsDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003192 /// Emit device code for the target teams distribute directive.
3193 static void EmitOMPTargetTeamsDistributeDeviceFunction(
3194 CodeGenModule &CGM, StringRef ParentName,
3195 const OMPTargetTeamsDistributeDirective &S);
Alexey Bataevfbe17fb2017-12-13 19:45:06 +00003196 /// Emit device code for the target teams distribute simd directive.
3197 static void EmitOMPTargetTeamsDistributeSimdDeviceFunction(
3198 CodeGenModule &CGM, StringRef ParentName,
3199 const OMPTargetTeamsDistributeSimdDirective &S);
Alexey Bataevf8365372017-11-17 17:57:25 +00003200 /// Emit device code for the target simd directive.
3201 static void EmitOMPTargetSimdDeviceFunction(CodeGenModule &CGM,
3202 StringRef ParentName,
3203 const OMPTargetSimdDirective &S);
Alexey Bataev647dd842018-01-15 20:59:40 +00003204 /// Emit device code for the target teams distribute parallel for simd
3205 /// directive.
3206 static void EmitOMPTargetTeamsDistributeParallelForSimdDeviceFunction(
3207 CodeGenModule &CGM, StringRef ParentName,
3208 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Carlo Bertolli52978c32018-01-03 21:12:44 +00003209
3210 static void EmitOMPTargetTeamsDistributeParallelForDeviceFunction(
3211 CodeGenModule &CGM, StringRef ParentName,
3212 const OMPTargetTeamsDistributeParallelForDirective &S);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003213 /// Emit inner loop of the worksharing/simd construct.
Alexey Bataev98eb6e32015-04-22 11:15:40 +00003214 ///
3215 /// \param S Directive, for which the inner loop must be emitted.
3216 /// \param RequiresCleanup true, if directive has some associated private
3217 /// variables.
3218 /// \param LoopCond Bollean condition for loop continuation.
3219 /// \param IncExpr Increment expression for loop control variable.
3220 /// \param BodyGen Generator for the inner body of the inner loop.
3221 /// \param PostIncGen Genrator for post-increment code (required for ordered
3222 /// loop directvies).
3223 void EmitOMPInnerLoop(
3224 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
3225 const Expr *IncExpr,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003226 const llvm::function_ref<void(CodeGenFunction &)> BodyGen,
3227 const llvm::function_ref<void(CodeGenFunction &)> PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00003228
Alexey Bataev81c7ea02015-07-03 09:56:58 +00003229 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00003230 /// Emit initial code for loop counters of loop-based directives.
3231 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
3232 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00003233
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003234 /// Helper for the OpenMP loop directives.
3235 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
3236
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003237 /// Emit code for the worksharing loop-based directive.
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003238 /// \return true, if this construct has any lastprivate clause, false -
3239 /// otherwise.
3240 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
3241 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
3242 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3243
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003244 /// Emit code for the distribute loop-based directive.
3245 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
3246 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
3247
Alexey Bataevf8365372017-11-17 17:57:25 +00003248 /// Helpers for the OpenMP loop directives.
3249 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
3250 void EmitOMPSimdFinal(
3251 const OMPLoopDirective &D,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003252 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
Alexey Bataevf8365372017-11-17 17:57:25 +00003253
Alexey Bataevf47c4b42017-09-26 13:47:31 +00003254 /// Emits the lvalue for the expression with possibly captured variable.
3255 LValue EmitOMPSharedLValue(const Expr *E);
3256
Alexander Musmanc6388682014-12-15 07:07:06 +00003257private:
Yaxun Liufa13d012018-02-15 16:39:19 +00003258 /// Helpers for blocks.
3259 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
George Burgess IVe3763372016-12-22 02:50:20 +00003260
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003261 /// struct with the values to be passed to the OpenMP loop-related functions
3262 struct OMPLoopArguments {
3263 /// loop lower bound
3264 Address LB = Address::invalid();
3265 /// loop upper bound
3266 Address UB = Address::invalid();
3267 /// loop stride
3268 Address ST = Address::invalid();
3269 /// isLastIteration argument for runtime functions
3270 Address IL = Address::invalid();
3271 /// Chunk value generated by sema
3272 llvm::Value *Chunk = nullptr;
3273 /// EnsureUpperBound
3274 Expr *EUB = nullptr;
3275 /// IncrementExpression
3276 Expr *IncExpr = nullptr;
3277 /// Loop initialization
3278 Expr *Init = nullptr;
3279 /// Loop exit condition
3280 Expr *Cond = nullptr;
3281 /// Update of LB after a whole chunk has been executed
3282 Expr *NextLB = nullptr;
3283 /// Update of UB after a whole chunk has been executed
3284 Expr *NextUB = nullptr;
3285 OMPLoopArguments() = default;
3286 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
3287 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
3288 Expr *IncExpr = nullptr, Expr *Init = nullptr,
3289 Expr *Cond = nullptr, Expr *NextLB = nullptr,
3290 Expr *NextUB = nullptr)
3291 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
3292 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
3293 NextUB(NextUB) {}
3294 };
3295 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
3296 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
3297 const OMPLoopArguments &LoopArgs,
3298 const CodeGenLoopTy &CodeGenLoop,
3299 const CodeGenOrderedTy &CodeGenOrdered);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00003300 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00003301 bool IsMonotonic, const OMPLoopDirective &S,
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003302 OMPPrivateScope &LoopScope, bool Ordered,
3303 const OMPLoopArguments &LoopArgs,
3304 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3305 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
3306 const OMPLoopDirective &S,
3307 OMPPrivateScope &LoopScope,
3308 const OMPLoopArguments &LoopArgs,
3309 const CodeGenLoopTy &CodeGenLoopContent);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003310 /// Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00003311 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00003312
3313public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00003314
Chris Lattner208ae962007-05-30 17:57:17 +00003315 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00003316 // LValue Expression Emission
3317 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00003318
Daniel Dunbarc79407f2009-02-05 07:09:07 +00003319 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
3320 RValue GetUndefRValue(QualType Ty);
3321
Daniel Dunbarbb197e42009-01-09 16:50:52 +00003322 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
3323 /// and issue an ErrorUnsupported style diagnostic (using the
3324 /// provided Name).
3325 RValue EmitUnsupportedRValue(const Expr *E,
3326 const char *Name);
3327
Mike Stumpfc496822009-02-08 23:14:22 +00003328 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
3329 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00003330 LValue EmitUnsupportedLValue(const Expr *E,
3331 const char *Name);
3332
Chris Lattner8394d792007-06-05 20:53:16 +00003333 /// EmitLValue - Emit code to compute a designator that specifies the location
3334 /// of the expression.
3335 ///
3336 /// This can return one of two things: a simple address or a bitfield
3337 /// reference. In either case, the LLVM Value* in the LValue structure is
3338 /// guaranteed to be an LLVM pointer type.
3339 ///
3340 /// If this returns a bitfield reference, nothing about the pointee type of
3341 /// the LLVM value is known: For example, it may not be a pointer to an
3342 /// integer.
3343 ///
3344 /// If this returns a normal address, and if the lvalue's C type is fixed
3345 /// size, this method guarantees that the returned pointer type will point to
3346 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
3347 /// variable length type, this is not possible.
3348 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00003349 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003350
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003351 /// Same as EmitLValue but additionally we generate checking code to
Richard Smith4d1458e2012-09-08 02:08:36 +00003352 /// guard against undefined behavior. This is only suitable when we know
3353 /// that the address will be used to access the object.
3354 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00003355
John McCall7f416cc2015-09-08 08:05:57 +00003356 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003357 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00003358
John McCalla8ec7eb2013-03-07 21:37:17 +00003359 void EmitAtomicInit(Expr *E, LValue lvalue);
3360
David Majnemera5b195a2015-02-14 01:35:12 +00003361 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00003362
3363 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
3364 AggValueSlot Slot = AggValueSlot::ignored());
3365
Nick Lewycky2d84e842013-10-02 02:29:49 +00003366 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00003367 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00003368 AggValueSlot slot = AggValueSlot::ignored());
3369
3370 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3371
David Majnemera5b195a2015-02-14 01:35:12 +00003372 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3373 bool IsVolatile, bool isInit);
3374
Alexey Bataevb4505a72015-03-30 05:20:59 +00003375 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00003376 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00003377 llvm::AtomicOrdering Success =
3378 llvm::AtomicOrdering::SequentiallyConsistent,
3379 llvm::AtomicOrdering Failure =
3380 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00003381 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3382
Alexey Bataevb4505a72015-03-30 05:20:59 +00003383 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00003384 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00003385 bool IsVolatile);
3386
John McCall3a7f6922010-10-27 20:58:56 +00003387 /// EmitToMemory - Change a scalar value from its value
3388 /// representation to its in-memory representation.
3389 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3390
3391 /// EmitFromMemory - Change a scalar value from its memory
3392 /// representation to its value representation.
3393 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3394
Vedant Kumar5a972652017-02-27 19:46:19 +00003395 /// Check if the scalar \p Value is within the valid range for the given
3396 /// type \p Ty.
3397 ///
3398 /// Returns true if a check is needed (even if the range is unknown).
3399 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3400 SourceLocation Loc);
3401
Daniel Dunbar1d425462009-02-10 00:57:50 +00003402 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3403 /// care to appropriately convert from the memory representation to
3404 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003405 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003406 SourceLocation Loc,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003407 AlignmentSource Source = AlignmentSource::Type,
3408 bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003409 return EmitLoadOfScalar(Addr, Volatile, Ty, Loc, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003410 CGM.getTBAAAccessInfo(Ty), isNontemporal);
3411 }
3412
3413 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3414 SourceLocation Loc, LValueBaseInfo BaseInfo,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003415 TBAAAccessInfo TBAAInfo,
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003416 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003417
3418 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3419 /// care to appropriately convert from the memory representation to
3420 /// the LLVM value representation. The l-value must be a simple
3421 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003422 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003423
3424 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3425 /// care to appropriately convert from the memory representation to
3426 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003427 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3428 bool Volatile, QualType Ty,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003429 AlignmentSource Source = AlignmentSource::Type,
3430 bool isInit = false, bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003431 EmitStoreOfScalar(Value, Addr, Volatile, Ty, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003432 CGM.getTBAAAccessInfo(Ty), isInit, isNontemporal);
3433 }
3434
3435 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003436 bool Volatile, QualType Ty,
3437 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo,
Ivan A. Kosareva511ed72017-10-03 10:52:39 +00003438 bool isInit = false, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003439
3440 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3441 /// care to appropriately convert from the memory representation to
3442 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00003443 /// l-value. The isInit flag indicates whether this is an initialization.
3444 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3445 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003446
Chris Lattner8394d792007-06-05 20:53:16 +00003447 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3448 /// this method emits the address of the lvalue, then loads the result as an
3449 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003450 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00003451 RValue EmitLoadOfExtVectorElementLValue(LValue V);
Vedant Kumar129edab2017-03-09 16:06:27 +00003452 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
Renato Golin230c5eb2014-05-19 18:15:42 +00003453 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00003454
Chris Lattner8394d792007-06-05 20:53:16 +00003455 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3456 /// lvalue, where both are guaranteed to the have the same type, and that type
3457 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00003458 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003459 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00003460 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003461
Nick Lewycky2d84e842013-10-02 02:29:49 +00003462 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3463 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003464 ///
Mike Stumpfc496822009-02-08 23:14:22 +00003465 /// \param Result [out] - If non-null, this will be set to a Value* for the
3466 /// bit-field contents after the store, appropriate for use as the result of
3467 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00003468 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00003469 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00003470
John McCall4f29b492010-11-16 23:07:28 +00003471 /// Emit an l-value for an assignment (simple or compound) of complex type.
3472 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003473 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00003474 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3475 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00003476
Chris Lattner57540c52011-04-15 05:22:18 +00003477 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00003478 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003479 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003480 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00003481 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003482 // Note: only available for agg return types
3483 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00003484 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00003485 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00003486 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00003487 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00003488 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00003489 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3490 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00003491 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3492 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00003493 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00003494 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00003495 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00003496 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00003497 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00003498 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00003499 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00003500 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00003501 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003502
John McCall7f416cc2015-09-08 08:05:57 +00003503 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003504
Nick Lewycky2d84e842013-10-02 02:29:49 +00003505 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00003506
John McCall7f416cc2015-09-08 08:05:57 +00003507 Address EmitArrayToPointerDecay(const Expr *Array,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00003508 LValueBaseInfo *BaseInfo = nullptr,
3509 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003510
John McCall71335052012-03-10 03:05:10 +00003511 class ConstantEmission {
3512 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3513 ConstantEmission(llvm::Constant *C, bool isReference)
3514 : ValueAndIsReference(C, isReference) {}
3515 public:
3516 ConstantEmission() {}
3517 static ConstantEmission forReference(llvm::Constant *C) {
3518 return ConstantEmission(C, true);
3519 }
3520 static ConstantEmission forValue(llvm::Constant *C) {
3521 return ConstantEmission(C, false);
3522 }
3523
Aaron Ballman67347662015-02-15 22:00:28 +00003524 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00003525 return ValueAndIsReference.getOpaqueValue() != nullptr;
3526 }
John McCall71335052012-03-10 03:05:10 +00003527
3528 bool isReference() const { return ValueAndIsReference.getInt(); }
3529 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3530 assert(isReference());
3531 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3532 refExpr->getType());
3533 }
3534
3535 llvm::Constant *getValue() const {
3536 assert(!isReference());
3537 return ValueAndIsReference.getPointer();
3538 }
3539 };
3540
John McCall113bee02012-03-10 09:33:50 +00003541 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
Alex Lorenz6cc83172017-08-25 10:07:00 +00003542 ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
Volodymyr Sapsaief1899b2018-11-01 21:57:05 +00003543 llvm::Value *emitScalarConstant(const ConstantEmission &Constant, Expr *E);
John McCall71335052012-03-10 03:05:10 +00003544
John McCallfe96e0b2011-11-06 09:01:30 +00003545 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3546 AggValueSlot slot = AggValueSlot::ignored());
3547 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3548
Daniel Dunbar722f4242009-04-22 05:08:15 +00003549 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003550 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00003551 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00003552 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003553
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003554 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3555 /// if the Field is a reference, this will return the address of the reference
3556 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003557 LValue EmitLValueForFieldInitialization(LValue Base,
3558 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003559
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003560 LValue EmitLValueForIvar(QualType ObjectTy,
3561 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003562 unsigned CVRQualifiers);
3563
Anders Carlsson3be22e22009-05-30 23:23:33 +00003564 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003565 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003566 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003567 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003568
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003569 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003570 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003571 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003572 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003573 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003574 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003575
Chris Lattnerd7f58862007-06-02 05:24:33 +00003576 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003577 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003578 //===--------------------------------------------------------------------===//
3579
Mike Stumpfc496822009-02-08 23:14:22 +00003580 /// EmitCall - Generate a call of the given function, expecting the given
3581 /// result type, and using the given argument list which specifies both the
3582 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003583 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003584 ReturnValueSlot ReturnValue, const CallArgList &Args,
James Y Knight3933add2019-01-30 02:54:28 +00003585 llvm::CallBase **callOrInvoke, SourceLocation Loc);
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003586 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
3587 ReturnValueSlot ReturnValue, const CallArgList &Args,
James Y Knight3933add2019-01-30 02:54:28 +00003588 llvm::CallBase **callOrInvoke = nullptr) {
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003589 return EmitCall(CallInfo, Callee, ReturnValue, Args, callOrInvoke,
3590 SourceLocation());
3591 }
John McCallb92ab1a2016-10-26 23:46:34 +00003592 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003593 ReturnValueSlot ReturnValue, llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003594 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003595 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003596 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3597 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003598
Eric Christopherc7e79db2015-11-12 00:44:04 +00003599 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003600
James Y Knight9871db02019-02-05 16:42:33 +00003601 llvm::CallInst *EmitRuntimeCall(llvm::FunctionCallee callee,
John McCall882987f2013-02-28 19:01:20 +00003602 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003603 llvm::CallInst *EmitRuntimeCall(llvm::FunctionCallee callee,
3604 ArrayRef<llvm::Value *> args,
John McCall882987f2013-02-28 19:01:20 +00003605 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003606 llvm::CallInst *EmitNounwindRuntimeCall(llvm::FunctionCallee callee,
John McCall882987f2013-02-28 19:01:20 +00003607 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003608 llvm::CallInst *EmitNounwindRuntimeCall(llvm::FunctionCallee callee,
3609 ArrayRef<llvm::Value *> args,
John McCall882987f2013-02-28 19:01:20 +00003610 const Twine &name = "");
3611
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003612 SmallVector<llvm::OperandBundleDef, 1>
3613 getBundlesForFunclet(llvm::Value *Callee);
3614
James Y Knight9871db02019-02-05 16:42:33 +00003615 llvm::CallBase *EmitCallOrInvoke(llvm::FunctionCallee Callee,
James Y Knight3933add2019-01-30 02:54:28 +00003616 ArrayRef<llvm::Value *> Args,
3617 const Twine &Name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003618 llvm::CallBase *EmitRuntimeCallOrInvoke(llvm::FunctionCallee callee,
James Y Knight3933add2019-01-30 02:54:28 +00003619 ArrayRef<llvm::Value *> args,
3620 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003621 llvm::CallBase *EmitRuntimeCallOrInvoke(llvm::FunctionCallee callee,
James Y Knight3933add2019-01-30 02:54:28 +00003622 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003623 void EmitNoreturnRuntimeCallOrInvoke(llvm::FunctionCallee callee,
3624 ArrayRef<llvm::Value *> args);
John McCallbd309292010-07-06 01:34:17 +00003625
Gor Nishanov04491bd2017-11-11 17:00:43 +00003626 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
John McCallb92ab1a2016-10-26 23:46:34 +00003627 NestedNameSpecifier *Qual,
3628 llvm::Type *Ty);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003629
John McCallb92ab1a2016-10-26 23:46:34 +00003630 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
Gor Nishanov04491bd2017-11-11 17:00:43 +00003631 CXXDtorType Type,
John McCallb92ab1a2016-10-26 23:46:34 +00003632 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003633
Akira Hatanaka9978da32018-08-10 15:09:24 +00003634 // Return the copy constructor name with the prefix "__copy_constructor_"
3635 // removed.
3636 static std::string getNonTrivialCopyConstructorStr(QualType QT,
3637 CharUnits Alignment,
3638 bool IsVolatile,
3639 ASTContext &Ctx);
3640
3641 // Return the destructor name with the prefix "__destructor_" removed.
3642 static std::string getNonTrivialDestructorStr(QualType QT,
3643 CharUnits Alignment,
3644 bool IsVolatile,
3645 ASTContext &Ctx);
3646
Akira Hatanaka7275da02018-02-28 07:15:55 +00003647 // These functions emit calls to the special functions of non-trivial C
3648 // structs.
3649 void defaultInitNonTrivialCStructVar(LValue Dst);
3650 void callCStructDefaultConstructor(LValue Dst);
3651 void callCStructDestructor(LValue Dst);
3652 void callCStructCopyConstructor(LValue Dst, LValue Src);
3653 void callCStructMoveConstructor(LValue Dst, LValue Src);
3654 void callCStructCopyAssignmentOperator(LValue Dst, LValue Src);
3655 void callCStructMoveAssignmentOperator(LValue Dst, LValue Src);
3656
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003657 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003658 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3659 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003660 ReturnValueSlot ReturnValue, llvm::Value *This,
3661 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003662 QualType ImplicitParamTy, const CallExpr *E,
3663 CallArgList *RtlArgs);
Peter Collingbourned1c5b282019-03-22 23:05:10 +00003664 RValue EmitCXXDestructorCall(GlobalDecl Dtor,
John McCallb92ab1a2016-10-26 23:46:34 +00003665 const CGCallee &Callee,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00003666 llvm::Value *This, llvm::Value *ImplicitParam,
Peter Collingbourned1c5b282019-03-22 23:05:10 +00003667 QualType ImplicitParamTy, const CallExpr *E);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003668 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3669 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003670 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3671 const CXXMethodDecl *MD,
3672 ReturnValueSlot ReturnValue,
3673 bool HasQualifier,
3674 NestedNameSpecifier *Qualifier,
3675 bool IsArrow, const Expr *Base);
3676 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003677 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3678 llvm::Value *memberPtr,
3679 const MemberPointerType *memberPtrType,
Ivan A. Kosarev229a6d82017-10-13 16:38:32 +00003680 LValueBaseInfo *BaseInfo = nullptr,
3681 TBAAAccessInfo *TBAAInfo = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003682 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3683 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003684
Anders Carlsson4034a952009-05-27 04:18:27 +00003685 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003686 const CXXMethodDecl *MD,
3687 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003688 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003689
Peter Collingbournefe883422011-10-06 18:29:37 +00003690 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3691 ReturnValueSlot ReturnValue);
3692
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003693 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3694 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003695
Erich Keanede6480a32018-11-13 15:48:08 +00003696 RValue EmitBuiltinExpr(const GlobalDecl GD, unsigned BuiltinID,
3697 const CallExpr *E, ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003698
Sanjay Patelad823902018-08-19 16:50:30 +00003699 RValue emitRotate(const CallExpr *E, bool IsRotateRight);
3700
Akira Hatanaka6b103bc2017-10-06 07:12:46 +00003701 /// Emit IR for __builtin_os_log_format.
3702 RValue emitBuiltinOSLogFormat(const CallExpr &E);
3703
3704 llvm::Function *generateBuiltinOSLogHelperFunction(
3705 const analyze_os_log::OSLogBufferLayout &Layout,
3706 CharUnits BufferAlignment);
3707
Anders Carlssonbfb36712009-12-24 21:13:40 +00003708 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003709
Mike Stumpfc496822009-02-08 23:14:22 +00003710 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3711 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00003712 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3713
Kevin Qin1718af62013-11-14 02:45:18 +00003714 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3715 const llvm::CmpInst::Predicate Fp,
3716 const llvm::CmpInst::Predicate Ip,
3717 const llvm::Twine &Name = "");
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003718 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3719 llvm::Triple::ArchType Arch);
Tim Northover8fe03d62014-02-21 11:57:24 +00003720
3721 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3722 unsigned LLVMIntrinsic,
3723 unsigned AltLLVMIntrinsic,
3724 const char *NameHint,
3725 unsigned Modifier,
3726 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003727 SmallVectorImpl<llvm::Value *> &Ops,
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003728 Address PtrOp0, Address PtrOp1,
3729 llvm::Triple::ArchType Arch);
Simon Tatham89e31fa2018-05-30 07:54:05 +00003730
Tim Northover8fe03d62014-02-21 11:57:24 +00003731 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3732 unsigned Modifier, llvm::Type *ArgTy,
3733 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003734 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003735 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003736 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003737 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003738 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003739 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003740 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003741 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3742 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003743 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003744 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3745 llvm::Triple::ArchType Arch);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003746
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003747 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003748 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3749 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003750 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003751 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003752 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003753 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3754 const CallExpr *E);
Krzysztof Parzyszek5a655832017-12-13 19:56:03 +00003755 llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003756
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003757private:
3758 enum class MSVCIntrin;
3759
3760public:
3761 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3762
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003763 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3764
Daniel Dunbar66912a12008-08-20 00:28:19 +00003765 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003766 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003767 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003768 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3769 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3770 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003771 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003772 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003773 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3774 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003775
John McCall31168b02011-06-15 23:02:42 +00003776 /// Retrieves the default cleanup kind for an ARC cleanup.
3777 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3778 CleanupKind getARCCleanupKind() {
3779 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3780 ? NormalAndEHCleanup : NormalCleanup;
3781 }
3782
3783 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003784 void EmitARCInitWeak(Address addr, llvm::Value *value);
3785 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003786 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003787 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3788 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
Akira Hatanakad791e922018-03-19 17:38:40 +00003789 void emitARCCopyAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
3790 void emitARCMoveAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
John McCall7f416cc2015-09-08 08:05:57 +00003791 void EmitARCCopyWeak(Address dst, Address src);
3792 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003793 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3794 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003795 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003796 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003797 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003798 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003799 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003800 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003801 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003802 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003803 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003804 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003805 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3806 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3807 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003808 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003809
Pete Coopere5b64ea2018-12-21 21:00:32 +00003810 llvm::Value *EmitObjCAutorelease(llvm::Value *value, llvm::Type *returnType);
3811 llvm::Value *EmitObjCRetainNonBlock(llvm::Value *value,
3812 llvm::Type *returnType);
3813 void EmitObjCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
3814
John McCall31168b02011-06-15 23:02:42 +00003815 std::pair<LValue,llvm::Value*>
3816 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3817 std::pair<LValue,llvm::Value*>
3818 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003819 std::pair<LValue,llvm::Value*>
3820 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003821
Pete Coopere3886802018-12-08 05:13:50 +00003822 llvm::Value *EmitObjCAlloc(llvm::Value *value,
3823 llvm::Type *returnType);
3824 llvm::Value *EmitObjCAllocWithZone(llvm::Value *value,
3825 llvm::Type *returnType);
Erik Pilkingtonec389b02019-02-14 19:58:37 +00003826 llvm::Value *EmitObjCAllocInit(llvm::Value *value, llvm::Type *resultType);
3827
John McCall248512a2011-10-01 10:32:24 +00003828 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003829 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3830 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3831
John McCallff613032011-10-04 06:23:45 +00003832 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003833 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3834 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003835 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3836 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003837 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003838
Craig Topper00bbdcf2014-06-28 23:22:23 +00003839 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003840
John McCall82fe67b2011-07-09 01:37:26 +00003841 static Destroyer destroyARCStrongImprecise;
3842 static Destroyer destroyARCStrongPrecise;
3843 static Destroyer destroyARCWeak;
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00003844 static Destroyer emitARCIntrinsicUse;
Akira Hatanaka7275da02018-02-28 07:15:55 +00003845 static Destroyer destroyNonTrivialCStruct;
John McCall82fe67b2011-07-09 01:37:26 +00003846
Gor Nishanov04491bd2017-11-11 17:00:43 +00003847 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003848 llvm::Value *EmitObjCAutoreleasePoolPush();
3849 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3850 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003851 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00003852
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003853 /// Emits a reference binding to the passed in expression.
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003854 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00003855
Chris Lattner6278e6a2007-08-11 00:04:45 +00003856 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003857 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00003858 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00003859
3860 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00003861
3862 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3863 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00003864 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003865
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003866 /// Emit a conversion from the specified type to the specified destination
3867 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00003868 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003869 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003870
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00003871 /// Emit a conversion from the specified complex type to the specified
3872 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00003873 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00003874 QualType DstTy,
3875 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00003876
John McCall7a626f62010-09-15 10:14:12 +00003877 /// EmitAggExpr - Emit the computation of the specified expression
3878 /// of aggregate type. The result is computed into the given slot,
3879 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00003880 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00003881
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00003882 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3883 /// aggregate type into a temporary LValue.
3884 LValue EmitAggExprToLValue(const Expr *E);
3885
John McCall1bd25562011-06-24 23:21:27 +00003886 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3887 /// make sure it survives garbage collection until this point.
3888 void EmitExtendGCLifetime(llvm::Value *object);
3889
Chris Lattnercbfc73b2007-08-21 05:54:00 +00003890 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00003891 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00003892 ComplexPairTy EmitComplexExpr(const Expr *E,
3893 bool IgnoreReal = false,
3894 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00003895
John McCall47fb9502013-03-07 21:37:08 +00003896 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3897 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003898 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00003899
John McCall47fb9502013-03-07 21:37:08 +00003900 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00003901 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00003902
3903 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003904 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00003905
John McCall7f416cc2015-09-08 08:05:57 +00003906 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3907 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3908
Chandler Carruth84537952012-03-30 19:44:53 +00003909 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3910 /// global variable that has already been created for it. If the initializer
3911 /// has a different type than GV does, this may free GV and return a different
3912 /// one. Otherwise it just returns GV.
3913 llvm::GlobalVariable *
3914 AddInitializerToStaticVarDecl(const VarDecl &D,
3915 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003916
Richard Smith3ad06362018-10-31 20:39:26 +00003917 // Emit an @llvm.invariant.start call for the given memory region.
3918 void EmitInvariantStart(llvm::Constant *Addr, CharUnits Size);
Daniel Dunbar22a87f92009-02-25 19:24:29 +00003919
Anders Carlssonf40886a2009-08-08 21:45:14 +00003920 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3921 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00003922 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3923 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00003924
James Y Knightf7321542019-02-07 01:14:17 +00003925 llvm::Function *createAtExitStub(const VarDecl &VD, llvm::FunctionCallee Dtor,
David Majnemerb3341ea2014-10-05 05:05:40 +00003926 llvm::Constant *Addr);
3927
John McCallc84ed6a2012-05-01 06:13:13 +00003928 /// Call atexit() with a function that passes the given argument to
3929 /// the given function.
James Y Knightf7321542019-02-07 01:14:17 +00003930 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::FunctionCallee fn,
David Blaikieebe87e12013-08-27 23:57:18 +00003931 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00003932
Akira Hatanaka617e2612018-04-17 18:41:52 +00003933 /// Call atexit() with function dtorStub.
3934 void registerGlobalDtorWithAtExit(llvm::Constant *dtorStub);
3935
John McCallcdf7ef52010-11-06 09:44:32 +00003936 /// Emit code in this function to perform a guarded variable
3937 /// initialization. Guarded initializations are used when it's not
3938 /// possible to prove that an initialization will be done exactly
3939 /// once, e.g. with a static local variable or a static data member
3940 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00003941 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00003942 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00003943
Richard Smithae8d62c2017-07-26 22:01:09 +00003944 enum class GuardKind { VariableGuard, TlsGuard };
3945
3946 /// Emit a branch to select whether or not to perform guarded initialization.
3947 void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
3948 llvm::BasicBlock *InitBlock,
3949 llvm::BasicBlock *NoInitBlock,
3950 GuardKind Kind, const VarDecl *D);
3951
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003952 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3953 /// variables.
Richard Smith3ad06362018-10-31 20:39:26 +00003954 void
3955 GenerateCXXGlobalInitFunc(llvm::Function *Fn,
3956 ArrayRef<llvm::Function *> CXXThreadLocals,
3957 ConstantAddress Guard = ConstantAddress::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003958
John McCallee08c532012-04-06 18:21:03 +00003959 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003960 /// variables.
Sanjoy Dase369bd92017-05-01 17:08:00 +00003961 void GenerateCXXGlobalDtorsFunc(
3962 llvm::Function *Fn,
James Y Knightf7321542019-02-07 01:14:17 +00003963 const std::vector<std::tuple<llvm::FunctionType *, llvm::WeakTrackingVH,
3964 llvm::Constant *>> &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003965
John McCalla738c252011-03-09 04:27:21 +00003966 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3967 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00003968 llvm::GlobalVariable *Addr,
3969 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00003970
John McCall7a626f62010-09-15 10:14:12 +00003971 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003972
John McCall7f416cc2015-09-08 08:05:57 +00003973 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00003974
Bill Wendling7c44da22018-10-31 03:48:47 +00003975 void enterFullExpression(const FullExpr *E) {
3976 if (const auto *EWC = dyn_cast<ExprWithCleanups>(E))
3977 if (EWC->getNumObjects() == 0)
3978 return;
John McCall08ef4662011-11-10 08:15:53 +00003979 enterNonTrivialFullExpression(E);
3980 }
Bill Wendling7c44da22018-10-31 03:48:47 +00003981 void enterNonTrivialFullExpression(const FullExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003982
Richard Smithea852322013-05-07 21:53:22 +00003983 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00003984
Tim Northovercc2a6e02015-11-09 19:56:35 +00003985 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00003986
Daniel Dunbar88402ce2008-08-04 16:51:22 +00003987 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003988 // Annotations Emission
3989 //===--------------------------------------------------------------------===//
3990
James Y Knight8799cae2019-02-03 21:53:49 +00003991 /// Emit an annotation call (intrinsic).
3992 llvm::Value *EmitAnnotationCall(llvm::Function *AnnotationFn,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003993 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003994 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00003995 SourceLocation Location);
3996
3997 /// Emit local annotations for the local variable V, declared by D.
3998 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3999
4000 /// Emit field annotations for the given field & value. Returns the
4001 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00004002 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00004003
4004 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00004005 // Internal Helpers
4006 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00004007
Chris Lattner5b1964b2008-11-11 07:41:27 +00004008 /// ContainsLabel - Return true if the statement contains a label in it. If
4009 /// this statement is not executed normally, it not containing a label means
4010 /// that we can just remove the code.
4011 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00004012
Chris Lattner29911cc2011-02-28 00:18:40 +00004013 /// containsBreak - Return true if the statement contains a break out of it.
4014 /// If the statement (recursively) contains a switch or loop with a break
4015 /// inside of it, this is fine.
4016 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00004017
4018 /// Determine if the given statement might introduce a declaration into the
4019 /// current scope, by being a (possibly-labelled) DeclStmt.
4020 static bool mightAddDeclToScope(const Stmt *S);
Gor Nishanov04491bd2017-11-11 17:00:43 +00004021
Daniel Dunbar682712c2008-11-12 10:12:14 +00004022 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00004023 /// to a constant, or if it does but contains a label, return false. If it
4024 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00004025 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
4026 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00004027
Chris Lattner29911cc2011-02-28 00:18:40 +00004028 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
4029 /// to a constant, or if it does but contains a label, return false. If it
4030 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00004031 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
4032 bool AllowLabels = false);
4033
Chris Lattnercd439292008-11-12 08:04:58 +00004034 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
4035 /// if statement) to the specified blocks. Based on the condition, this might
4036 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00004037 /// TrueCount should be the number of times we expect the condition to
4038 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00004039 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00004040 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00004041
Vedant Kumar42c17ec2017-03-14 01:56:34 +00004042 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
4043 /// nonnull, if \p LHS is marked _Nonnull.
4044 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
4045
Vedant Kumar175b6d12017-07-13 20:55:26 +00004046 /// An enumeration which makes it easier to specify whether or not an
4047 /// operation is a subtraction.
4048 enum { NotSubtraction = false, IsSubtraction = true };
4049
Vedant Kumara125eb52017-06-01 19:22:18 +00004050 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
4051 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
Vedant Kumar6dbf4272017-06-12 18:42:51 +00004052 /// \p SignedIndices indicates whether any of the GEP indices are signed.
Vedant Kumar175b6d12017-07-13 20:55:26 +00004053 /// \p IsSubtraction indicates whether the expression used to form the GEP
4054 /// is a subtraction.
Vedant Kumara125eb52017-06-01 19:22:18 +00004055 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
4056 ArrayRef<llvm::Value *> IdxList,
Vedant Kumar6dbf4272017-06-12 18:42:51 +00004057 bool SignedIndices,
Vedant Kumar175b6d12017-07-13 20:55:26 +00004058 bool IsSubtraction,
Vedant Kumara125eb52017-06-01 19:22:18 +00004059 SourceLocation Loc,
4060 const Twine &Name = "");
4061
Vedant Kumar10c31022017-07-29 00:19:51 +00004062 /// Specifies which type of sanitizer check to apply when handling a
4063 /// particular builtin.
4064 enum BuiltinCheckKind {
4065 BCK_CTZPassedZero,
4066 BCK_CLZPassedZero,
4067 };
4068
4069 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
4070 /// enabled, a runtime check specified by \p Kind is also emitted.
4071 llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
4072
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004073 /// Emit a description of a type in a format suitable for passing to
Richard Smithe30752c2012-10-09 19:52:38 +00004074 /// a runtime sanitizer handler.
4075 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
4076
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004077 /// Convert a value into a format suitable for passing to a runtime
Richard Smithe30752c2012-10-09 19:52:38 +00004078 /// sanitizer handler.
4079 llvm::Value *EmitCheckValue(llvm::Value *V);
4080
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004081 /// Emit a description of a source location in a format suitable for
Richard Smithe30752c2012-10-09 19:52:38 +00004082 /// passing to a runtime sanitizer handler.
4083 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
4084
Julian Lettnerb6c06dc2019-02-01 02:51:00 +00004085 /// Create a basic block that will either trap or call a handler function in
4086 /// the UBSan runtime with the provided arguments, and create a conditional
Richard Smithde670682012-11-01 22:15:34 +00004087 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00004088 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00004089 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00004090 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004091
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004092 /// Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00004093 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00004094 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
4095 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
4096 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00004097
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004098 /// Emit a reached-unreachable diagnostic if \p Loc is valid and runtime
4099 /// checking is enabled. Otherwise, just emit an unreachable instruction.
4100 void EmitUnreachable(SourceLocation Loc);
4101
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004102 /// Create a basic block that will call the trap intrinsic, and emit a
Richard Smithde670682012-11-01 22:15:34 +00004103 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00004104 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00004105
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004106 /// Emit a call to trap or debugtrap and attach function attribute
Akira Hatanaka85365cd2015-07-02 22:15:41 +00004107 /// "trap-func-name" if specified.
4108 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
4109
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004110 /// Emit a stub for the cross-DSO CFI check function.
Evgeniy Stepanov1a8030e2017-04-07 23:00:38 +00004111 void EmitCfiCheckStub();
4112
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004113 /// Emit a cross-DSO CFI failure handling function.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00004114 void EmitCfiCheckFail();
4115
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004116 /// Create a check for a function parameter that may potentially be
Nuno Lopes1ba2d782015-05-30 16:11:40 +00004117 /// declared as non-null.
4118 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00004119 AbstractCallee AC, unsigned ParmNum);
Nuno Lopes1ba2d782015-05-30 16:11:40 +00004120
Anders Carlsson093bdff2010-03-30 03:27:09 +00004121 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00004122 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00004123
John McCall23f66262010-05-26 22:34:26 +00004124 /// EmitDelegateCallArg - We are performing a delegate call; that
4125 /// is, the current function is delegating to another one. Produce
4126 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00004127 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
4128 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00004129
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00004130 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
4131 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00004132 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00004133
Chris Lattnercd439292008-11-12 08:04:58 +00004134private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00004135 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00004136 void EmitReturnOfRValue(RValue RV, QualType Ty);
4137
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004138 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
4139
4140 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
4141 DeferredReplacements;
4142
John McCall7f416cc2015-09-08 08:05:57 +00004143 /// Set the address of a local variable.
4144 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
4145 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
4146 LocalDeclMap.insert({VD, Addr});
4147 }
4148
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004149 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
4150 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
4151 ///
4152 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004153 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00004154 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004155
Yaxun Liu5b330e82018-03-15 15:25:19 +00004156 /// ExpandTypeToArgs - Expand an CallArg \arg Arg, with the LLVM type for \arg
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004157 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
4158 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
Yaxun Liu5b330e82018-03-15 15:25:19 +00004159 void ExpandTypeToArgs(QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004160 SmallVectorImpl<llvm::Value *> &IRCallArgs,
4161 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00004162
Chad Rosier59df25b2012-08-23 20:00:18 +00004163 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00004164 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00004165
Chad Rosier59df25b2012-08-23 20:00:18 +00004166 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00004167 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00004168 std::string &ConstraintStr,
4169 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00004170
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004171 /// Attempts to statically evaluate the object size of E. If that
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004172 /// fails, emits code to figure the size of E out for us. This is
4173 /// pass_object_size aware.
George Burgess IV0d6592a2017-02-23 05:59:56 +00004174 ///
4175 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004176 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00004177 llvm::IntegerType *ResType,
Erik Pilkington9c3b5882019-01-30 20:34:53 +00004178 llvm::Value *EmittedE,
4179 bool IsDynamic);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004180
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004181 /// Emits the size of E, as required by __builtin_object_size. This
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004182 /// function is aware of pass_object_size parameters, and will act accordingly
4183 /// if E is a parameter with the pass_object_size attribute.
4184 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00004185 llvm::IntegerType *ResType,
Erik Pilkington9c3b5882019-01-30 20:34:53 +00004186 llvm::Value *EmittedE,
4187 bool IsDynamic);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004188
Reid Kleckner89077a12013-12-17 19:46:40 +00004189public:
Douglas Gregore83b9562015-07-07 03:57:53 +00004190#ifndef NDEBUG
4191 // Determine whether the given argument is an Objective-C method
4192 // that may have type parameters in its signature.
4193 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
4194 const DeclContext *dc = method->getDeclContext();
4195 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
4196 return classDecl->getTypeParamListAsWritten();
4197 }
4198
4199 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
4200 return catDecl->getTypeParamList();
4201 }
4202
4203 return false;
4204 }
4205
4206 template<typename T>
4207 static bool isObjCMethodWithTypeParams(const T *) { return false; }
4208#endif
4209
Richard Smitha560ccf2016-09-29 21:30:12 +00004210 enum class EvaluationOrder {
4211 ///! No language constraints on evaluation order.
4212 Default,
4213 ///! Language semantics require left-to-right evaluation.
4214 ForceLeftToRight,
4215 ///! Language semantics require right-to-left evaluation.
4216 ForceRightToLeft
4217 };
4218
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00004219 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00004220 template <typename T>
4221 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00004222 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00004223 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00004224 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00004225 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00004226 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00004227 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00004228
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004229 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
4230 "Can't skip parameters if type info is not provided");
4231 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00004232#ifndef NDEBUG
4233 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
4234#endif
4235
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004236 // First, use the argument types that the type info knows about
4237 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
4238 E = CallArgTypeInfo->param_type_end();
4239 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00004240 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00004241 assert((isGenericMethod ||
4242 ((*I)->isVariablyModifiedType() ||
4243 (*I).getNonReferenceType()->isObjCRetainableType() ||
4244 getContext()
4245 .getCanonicalType((*I).getNonReferenceType())
4246 .getTypePtr() ==
4247 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00004248 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00004249 .getTypePtr())) &&
4250 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004251 ArgTypes.push_back(*I);
4252 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00004253 }
Mike Stump11289f42009-09-09 15:08:12 +00004254
Reid Kleckner739756c2013-12-04 19:23:12 +00004255 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004256 // function.
David Blaikief05779e2015-07-21 18:37:18 +00004257 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
4258 CallArgTypeInfo->isVariadic()) &&
4259 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00004260
Anders Carlsson603d6af2009-04-18 20:20:22 +00004261 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00004262 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00004263 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00004264
Vedant Kumared00ea02017-03-06 05:28:22 +00004265 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00004266 }
John McCalld4f4b7f2010-03-03 04:15:11 +00004267
Reid Kleckner739756c2013-12-04 19:23:12 +00004268 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00004269 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00004270 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00004271 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00004272 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00004273
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00004274 /// EmitPointerWithAlignment - Given an expression with a pointer type,
4275 /// emit the value and compute our best estimate of the alignment of the
4276 /// pointee.
John McCall7f416cc2015-09-08 08:05:57 +00004277 ///
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00004278 /// \param BaseInfo - If non-null, this will be initialized with
4279 /// information about the source of the alignment and the may-alias
4280 /// attribute. Note that this function will conservatively fall back on
4281 /// the type when it doesn't recognize the expression and may-alias will
4282 /// be set to false.
4283 ///
4284 /// One reasonable way to use this information is when there's a language
4285 /// guarantee that the pointer must be aligned to some stricter value, and
4286 /// we're simply trying to ensure that sufficiently obvious uses of under-
4287 /// aligned objects don't get miscompiled; for example, a placement new
4288 /// into the address of a local variable. In such a case, it's quite
4289 /// reasonable to just ignore the returned alignment when it isn't from an
4290 /// explicit source.
John McCall7f416cc2015-09-08 08:05:57 +00004291 Address EmitPointerWithAlignment(const Expr *Addr,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00004292 LValueBaseInfo *BaseInfo = nullptr,
4293 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00004294
Vedant Kumar36347d92017-12-08 01:51:47 +00004295 /// If \p E references a parameter with pass_object_size info or a constant
4296 /// array size modifier, emit the object size divided by the size of \p EltTy.
4297 /// Otherwise return null.
4298 llvm::Value *LoadPassedObjectSize(const Expr *E, QualType EltTy);
4299
Peter Collingbournedc134532016-01-16 00:31:22 +00004300 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
4301
Erich Keanef353ae12018-09-13 16:58:24 +00004302 struct MultiVersionResolverOption {
Erich Keane281d20b2018-01-08 21:34:17 +00004303 llvm::Function *Function;
Erich Keane19a8adc2018-10-25 18:57:19 +00004304 FunctionDecl *FD;
Erich Keanef353ae12018-09-13 16:58:24 +00004305 struct Conds {
4306 StringRef Architecture;
4307 llvm::SmallVector<StringRef, 8> Features;
Erich Keane281d20b2018-01-08 21:34:17 +00004308
Erich Keanef353ae12018-09-13 16:58:24 +00004309 Conds(StringRef Arch, ArrayRef<StringRef> Feats)
4310 : Architecture(Arch), Features(Feats.begin(), Feats.end()) {}
4311 } Conditions;
Erich Keane281d20b2018-01-08 21:34:17 +00004312
Erich Keanef353ae12018-09-13 16:58:24 +00004313 MultiVersionResolverOption(llvm::Function *F, StringRef Arch,
4314 ArrayRef<StringRef> Feats)
4315 : Function(F), Conditions(Arch, Feats) {}
Erich Keane281d20b2018-01-08 21:34:17 +00004316 };
Erich Keanef353ae12018-09-13 16:58:24 +00004317
4318 // Emits the body of a multiversion function's resolver. Assumes that the
4319 // options are already sorted in the proper order, with the 'default' option
4320 // last (if it exists).
4321 void EmitMultiVersionResolver(llvm::Function *Resolver,
4322 ArrayRef<MultiVersionResolverOption> Options);
Erich Keane3efe0022018-07-20 14:13:28 +00004323
Craig Topper4d8ced12018-10-20 03:51:52 +00004324 static uint64_t GetX86CpuSupportsMask(ArrayRef<StringRef> FeatureStrs);
Erich Keane281d20b2018-01-08 21:34:17 +00004325
Reid Kleckner89077a12013-12-17 19:46:40 +00004326private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004327 QualType getVarArgType(const Expr *Arg);
4328
John McCall09ae0322010-07-06 23:57:41 +00004329 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00004330
John McCall7f416cc2015-09-08 08:05:57 +00004331 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
4332 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00004333
4334 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00004335
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00004336 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Erich Keane9937b132017-09-01 19:42:45 +00004337 llvm::Value *EmitX86CpuIs(const CallExpr *E);
4338 llvm::Value *EmitX86CpuIs(StringRef CPUStr);
4339 llvm::Value *EmitX86CpuSupports(const CallExpr *E);
4340 llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
Craig Topper4d8ced12018-10-20 03:51:52 +00004341 llvm::Value *EmitX86CpuSupports(uint64_t Mask);
Erich Keane1fe643a2017-10-06 16:40:45 +00004342 llvm::Value *EmitX86CpuInit();
Erich Keanef353ae12018-09-13 16:58:24 +00004343 llvm::Value *FormResolverCondition(const MultiVersionResolverOption &RO);
Chris Lattnerbed31442007-05-28 01:07:47 +00004344};
Mike Stump11289f42009-09-09 15:08:12 +00004345
Richard Smithf66e4f72018-07-23 22:56:45 +00004346inline DominatingLLVMValue::saved_type
4347DominatingLLVMValue::save(CodeGenFunction &CGF, llvm::Value *value) {
4348 if (!needsSaving(value)) return saved_type(value, false);
John McCallce1de612011-01-26 04:00:11 +00004349
Richard Smithf66e4f72018-07-23 22:56:45 +00004350 // Otherwise, we need an alloca.
4351 auto align = CharUnits::fromQuantity(
4352 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
4353 Address alloca =
4354 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
4355 CGF.Builder.CreateStore(value, alloca);
John McCallce1de612011-01-26 04:00:11 +00004356
Richard Smithf66e4f72018-07-23 22:56:45 +00004357 return saved_type(alloca.getPointer(), true);
4358}
John McCallce1de612011-01-26 04:00:11 +00004359
Richard Smithf66e4f72018-07-23 22:56:45 +00004360inline llvm::Value *DominatingLLVMValue::restore(CodeGenFunction &CGF,
4361 saved_type value) {
4362 // If the value says it wasn't saved, trust that it's still dominating.
4363 if (!value.getInt()) return value.getPointer();
John McCallce1de612011-01-26 04:00:11 +00004364
Richard Smithf66e4f72018-07-23 22:56:45 +00004365 // Otherwise, it should be an alloca instruction, as set up in save().
4366 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
4367 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
4368}
John McCallce1de612011-01-26 04:00:11 +00004369
Chris Lattnerbed31442007-05-28 01:07:47 +00004370} // end namespace CodeGen
4371} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00004372
Chris Lattnerbed31442007-05-28 01:07:47 +00004373#endif