blob: 907b4d744b07a3cd9ce0b18e6ac426745a41e16c [file] [log] [blame]
Daniel Dunbar9c426522008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Chris Lattnerbed31442007-05-28 01:07:47 +00002//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Chris Lattnerbed31442007-05-28 01:07:47 +00006//
7//===----------------------------------------------------------------------===//
8//
Mike Stumpfc496822009-02-08 23:14:22 +00009// This is the internal per-function state used for llvm translation.
Chris Lattnerbed31442007-05-28 01:07:47 +000010//
11//===----------------------------------------------------------------------===//
12
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000013#ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
14#define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
Chris Lattnerbed31442007-05-28 01:07:47 +000015
Daniel Dunbarcb463852008-11-01 01:53:16 +000016#include "CGBuilder.h"
Eric Christophera9d34972011-10-19 00:43:52 +000017#include "CGDebugInfo.h"
Alexander Musman515ad8c2014-05-22 08:54:05 +000018#include "CGLoopInfo.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000019#include "CGValue.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000020#include "CodeGenModule.h"
Justin Bogneref512b92014-01-06 22:27:43 +000021#include "CodeGenPGO.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000022#include "EHScopeStack.h"
Vitaly Buka64c80b42016-10-26 05:42:30 +000023#include "VarBypassDetector.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000024#include "clang/AST/CharUnits.h"
Eric Fiselier708afb52019-05-16 21:04:15 +000025#include "clang/AST/CurrentSourceLocExprScope.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000026#include "clang/AST/ExprCXX.h"
27#include "clang/AST/ExprObjC.h"
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +000028#include "clang/AST/ExprOpenMP.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000029#include "clang/AST/Type.h"
30#include "clang/Basic/ABI.h"
Ben Langmuir3b4c30b2013-05-09 19:17:11 +000031#include "clang/Basic/CapturedStmt.h"
Richard Trieu63688182018-12-11 03:18:39 +000032#include "clang/Basic/CodeGenOptions.h"
Alexander Musmandf7a8e22015-01-22 08:49:35 +000033#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000034#include "clang/Basic/TargetInfo.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000035#include "llvm/ADT/ArrayRef.h"
36#include "llvm/ADT/DenseMap.h"
Reid Kleckner06f19a02018-01-02 21:34:16 +000037#include "llvm/ADT/MapVector.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000038#include "llvm/ADT/SmallVector.h"
Fady Ghanimba3f8632020-02-19 13:50:26 -060039#include "llvm/Frontend/OpenMP/OMPIRBuilder.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000040#include "llvm/IR/ValueHandle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000041#include "llvm/Support/Debug.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000042#include "llvm/Transforms/Utils/SanitizerStats.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000043
Chris Lattnerbed31442007-05-28 01:07:47 +000044namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000045class BasicBlock;
46class LLVMContext;
47class MDNode;
48class Module;
49class SwitchInst;
50class Twine;
51class Value;
Chris Lattner23b7eb62007-06-15 23:05:46 +000052}
53
Chris Lattnerbed31442007-05-28 01:07:47 +000054namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000055class ASTContext;
56class BlockDecl;
57class CXXDestructorDecl;
58class CXXForRangeStmt;
59class CXXTryStmt;
60class Decl;
61class LabelDecl;
62class EnumConstantDecl;
63class FunctionDecl;
64class FunctionProtoType;
65class LabelStmt;
66class ObjCContainerDecl;
67class ObjCInterfaceDecl;
68class ObjCIvarDecl;
69class ObjCMethodDecl;
70class ObjCImplementationDecl;
71class ObjCPropertyImplDecl;
72class TargetInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000073class VarDecl;
74class ObjCForCollectionStmt;
75class ObjCAtTryStmt;
76class ObjCAtThrowStmt;
77class ObjCAtSynchronizedStmt;
78class ObjCAutoreleasePoolStmt;
Reid Kleckner98031782019-12-09 16:11:56 -080079class ReturnsNonNullAttr;
Devang Patel3e11cce2007-10-23 02:10:49 +000080
Akira Hatanaka6b103bc2017-10-06 07:12:46 +000081namespace analyze_os_log {
82class OSLogBufferLayout;
83}
84
Chris Lattnerbed31442007-05-28 01:07:47 +000085namespace CodeGen {
Rafael Espindola42ae7452014-05-09 00:57:59 +000086class CodeGenTypes;
John McCallb92ab1a2016-10-26 23:46:34 +000087class CGCallee;
Rafael Espindola42ae7452014-05-09 00:57:59 +000088class CGFunctionInfo;
89class CGRecordLayout;
90class CGBlockInfo;
91class CGCXXABI;
John McCall7f416cc2015-09-08 08:05:57 +000092class BlockByrefHelpers;
93class BlockByrefInfo;
Rafael Espindola42ae7452014-05-09 00:57:59 +000094class BlockFlags;
95class BlockFieldFlags;
Alexey Bataev7292c292016-04-25 12:22:29 +000096class RegionCodeGenTy;
John McCall12f23522016-04-04 18:33:08 +000097class TargetCodeGenInfo;
Alexey Bataev24b5bae2016-04-28 09:23:51 +000098struct OMPTaskDataTy;
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000099struct CGCoroData;
Mike Stumpfc496822009-02-08 23:14:22 +0000100
John McCall47fb9502013-03-07 21:37:08 +0000101/// The kind of evaluation to perform on values of a particular
102/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
103/// CGExprAgg?
104///
105/// TODO: should vectors maybe be split out into their own thing?
106enum TypeEvaluationKind {
107 TEK_Scalar,
108 TEK_Complex,
109 TEK_Aggregate
110};
111
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000112#define LIST_SANITIZER_CHECKS \
113 SANITIZER_CHECK(AddOverflow, add_overflow, 0) \
114 SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \
115 SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \
116 SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \
117 SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \
118 SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \
Stephan Bergmanne2159962019-07-16 06:23:27 +0000119 SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 1) \
Roman Lebedevb69ba222018-07-30 18:58:30 +0000120 SANITIZER_CHECK(ImplicitConversion, implicit_conversion, 0) \
Vedant Kumar10c31022017-07-29 00:19:51 +0000121 SANITIZER_CHECK(InvalidBuiltin, invalid_builtin, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000122 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
123 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
124 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
125 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000126 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000127 SANITIZER_CHECK(NullabilityReturn, nullability_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000128 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
Vedant Kumarc34d3432017-06-23 21:32:38 +0000129 SANITIZER_CHECK(NonnullReturn, nonnull_return, 1) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000130 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
Vedant Kumara125eb52017-06-01 19:22:18 +0000131 SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000132 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
133 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
Filipe Cabecinhasfe5e5af2017-01-06 14:40:12 +0000134 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
Roman Lebedevbd1c0872019-01-15 09:44:25 +0000135 SANITIZER_CHECK(AlignmentAssumption, alignment_assumption, 0) \
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +0000136 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
137
138enum SanitizerHandler {
139#define SANITIZER_CHECK(Enum, Name, Version) Enum,
140 LIST_SANITIZER_CHECKS
141#undef SANITIZER_CHECK
142};
143
Richard Smithf66e4f72018-07-23 22:56:45 +0000144/// Helper class with most of the code for saving a value for a
145/// conditional expression cleanup.
146struct DominatingLLVMValue {
147 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
148
149 /// Answer whether the given value needs extra work to be saved.
150 static bool needsSaving(llvm::Value *value) {
151 // If it's not an instruction, we don't need to save.
152 if (!isa<llvm::Instruction>(value)) return false;
153
154 // If it's an instruction in the entry block, we don't need to save.
155 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
156 return (block != &block->getParent()->getEntryBlock());
157 }
158
159 static saved_type save(CodeGenFunction &CGF, llvm::Value *value);
160 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value);
161};
162
163/// A partial specialization of DominatingValue for llvm::Values that
164/// might be llvm::Instructions.
165template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
166 typedef T *type;
167 static type restore(CodeGenFunction &CGF, saved_type value) {
168 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
169 }
170};
171
172/// A specialization of DominatingValue for Address.
173template <> struct DominatingValue<Address> {
174 typedef Address type;
175
176 struct saved_type {
177 DominatingLLVMValue::saved_type SavedValue;
178 CharUnits Alignment;
179 };
180
181 static bool needsSaving(type value) {
182 return DominatingLLVMValue::needsSaving(value.getPointer());
183 }
184 static saved_type save(CodeGenFunction &CGF, type value) {
185 return { DominatingLLVMValue::save(CGF, value.getPointer()),
186 value.getAlignment() };
187 }
188 static type restore(CodeGenFunction &CGF, saved_type value) {
189 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
190 value.Alignment);
191 }
192};
193
194/// A specialization of DominatingValue for RValue.
195template <> struct DominatingValue<RValue> {
196 typedef RValue type;
197 class saved_type {
198 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
199 AggregateAddress, ComplexAddress };
200
201 llvm::Value *Value;
202 unsigned K : 3;
203 unsigned Align : 29;
204 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
205 : Value(v), K(k), Align(a) {}
206
207 public:
208 static bool needsSaving(RValue value);
209 static saved_type save(CodeGenFunction &CGF, RValue value);
210 RValue restore(CodeGenFunction &CGF);
211
212 // implementations in CGCleanup.cpp
213 };
214
215 static bool needsSaving(type value) {
216 return saved_type::needsSaving(value);
217 }
218 static saved_type save(CodeGenFunction &CGF, type value) {
219 return saved_type::save(CGF, value);
220 }
221 static type restore(CodeGenFunction &CGF, saved_type value) {
222 return value.restore(CGF);
223 }
224};
225
Chris Lattnerbed31442007-05-28 01:07:47 +0000226/// CodeGenFunction - This class organizes the per-function state that is used
227/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000228class CodeGenFunction : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000229 CodeGenFunction(const CodeGenFunction &) = delete;
230 void operator=(const CodeGenFunction &) = delete;
John McCall5d865c322010-08-31 07:33:07 +0000231
232 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000233public:
John McCallad5d61e2010-07-23 21:56:41 +0000234 /// A jump destination is an abstract label, branching to which may
235 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000236 struct JumpDest {
Craig Topper8a13c412014-05-21 05:09:00 +0000237 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
John McCallad5d61e2010-07-23 21:56:41 +0000238 JumpDest(llvm::BasicBlock *Block,
239 EHScopeStack::stable_iterator Depth,
240 unsigned Index)
241 : Block(Block), ScopeDepth(Depth), Index(Index) {}
242
Craig Topper8a13c412014-05-21 05:09:00 +0000243 bool isValid() const { return Block != nullptr; }
John McCallad5d61e2010-07-23 21:56:41 +0000244 llvm::BasicBlock *getBlock() const { return Block; }
245 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
246 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000247
Nadav Rotem1da30942013-03-23 06:43:35 +0000248 // This should be used cautiously.
249 void setScopeDepth(EHScopeStack::stable_iterator depth) {
250 ScopeDepth = depth;
251 }
252
John McCallad5d61e2010-07-23 21:56:41 +0000253 private:
John McCallbd309292010-07-06 01:34:17 +0000254 llvm::BasicBlock *Block;
255 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000256 unsigned Index;
257 };
258
Fady Ghanimba3f8632020-02-19 13:50:26 -0600259 // Helper class for the OpenMP IR Builder. Allows reusability of code used for
260 // region body, and finalization codegen callbacks. This will class will also
261 // contain privatization functions used by the privatization call backs
262 struct OMPBuilderCBHelpers {
263
264 using InsertPointTy = llvm::OpenMPIRBuilder::InsertPointTy;
265
266 /// Emit the Finalization for an OMP region
267 /// \param CGF The Codegen function this belongs to
268 /// \param IP Insertion point for generating the finalization code.
269 static void FinalizeOMPRegion(CodeGenFunction &CGF, InsertPointTy IP) {
270 CGBuilderTy::InsertPointGuard IPG(CGF.Builder);
271 assert(IP.getBlock()->end() != IP.getPoint() &&
272 "OpenMP IR Builder should cause terminated block!");
273
274 llvm::BasicBlock *IPBB = IP.getBlock();
275 llvm::BasicBlock *DestBB = IPBB->getUniqueSuccessor();
276 assert(DestBB && "Finalization block should have one successor!");
277
278 // erase and replace with cleanup branch.
279 IPBB->getTerminator()->eraseFromParent();
280 CGF.Builder.SetInsertPoint(IPBB);
281 CodeGenFunction::JumpDest Dest = CGF.getJumpDestInCurrentScope(DestBB);
282 CGF.EmitBranchThroughCleanup(Dest);
283 }
284
285 /// Emit the body of an OMP region
286 /// \param CGF The Codegen function this belongs to
287 /// \param RegionBodyStmt The body statement for the OpenMP region being
288 /// generated
289 /// \param CodeGenIP Insertion point for generating the body code.
290 /// \param FiniBB The finalization basic block
291 static void EmitOMPRegionBody(CodeGenFunction &CGF,
292 const Stmt *RegionBodyStmt,
293 InsertPointTy CodeGenIP,
294 llvm::BasicBlock &FiniBB) {
295 llvm::BasicBlock *CodeGenIPBB = CodeGenIP.getBlock();
296 if (llvm::Instruction *CodeGenIPBBTI = CodeGenIPBB->getTerminator())
297 CodeGenIPBBTI->eraseFromParent();
298
299 CGF.Builder.SetInsertPoint(CodeGenIPBB);
300
301 CGF.EmitStmt(RegionBodyStmt);
302
303 if (CGF.Builder.saveIP().isSet())
304 CGF.Builder.CreateBr(&FiniBB);
305 }
306
307 /// RAII for preserving necessary info during Outlined region body codegen.
308 class OutlinedRegionBodyRAII {
309
310 llvm::AssertingVH<llvm::Instruction> OldAllocaIP;
311 CodeGenFunction::JumpDest OldReturnBlock;
312 CodeGenFunction &CGF;
313
314 public:
315 OutlinedRegionBodyRAII(CodeGenFunction &cgf, InsertPointTy &AllocaIP,
316 llvm::BasicBlock &RetBB)
317 : CGF(cgf) {
318 assert(AllocaIP.isSet() &&
319 "Must specify Insertion point for allocas of outlined function");
320 OldAllocaIP = CGF.AllocaInsertPt;
321 CGF.AllocaInsertPt = &*AllocaIP.getPoint();
322
323 OldReturnBlock = CGF.ReturnBlock;
324 CGF.ReturnBlock = CGF.getJumpDestInCurrentScope(&RetBB);
325 }
326
327 ~OutlinedRegionBodyRAII() {
328 CGF.AllocaInsertPt = OldAllocaIP;
329 CGF.ReturnBlock = OldReturnBlock;
330 }
331 };
332
333 /// RAII for preserving necessary info during inlined region body codegen.
334 class InlinedRegionBodyRAII {
335
336 llvm::AssertingVH<llvm::Instruction> OldAllocaIP;
337 CodeGenFunction &CGF;
338
339 public:
340 InlinedRegionBodyRAII(CodeGenFunction &cgf, InsertPointTy &AllocaIP,
341 llvm::BasicBlock &FiniBB)
342 : CGF(cgf) {
343 // Alloca insertion block should be in the entry block of the containing
344 // function so it expects an empty AllocaIP in which case will reuse the
345 // old alloca insertion point, or a new AllocaIP in the same block as
346 // the old one
347 assert((!AllocaIP.isSet() ||
348 CGF.AllocaInsertPt->getParent() == AllocaIP.getBlock()) &&
349 "Insertion point should be in the entry block of containing "
350 "function!");
351 OldAllocaIP = CGF.AllocaInsertPt;
352 if (AllocaIP.isSet())
353 CGF.AllocaInsertPt = &*AllocaIP.getPoint();
354
355 // TODO: Remove the call, after making sure the counter is not used by
356 // the EHStack.
357 // Since this is an inlined region, it should not modify the
358 // ReturnBlock, and should reuse the one for the enclosing outlined
359 // region. So, the JumpDest being return by the function is discarded
360 (void)CGF.getJumpDestInCurrentScope(&FiniBB);
361 }
362
363 ~InlinedRegionBodyRAII() { CGF.AllocaInsertPt = OldAllocaIP; }
364 };
365 };
366
Chris Lattnerbed31442007-05-28 01:07:47 +0000367 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000368 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000369
Chris Lattner96d72562007-08-21 16:57:55 +0000370 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Alexander Musman515ad8c2014-05-22 08:54:05 +0000371 LoopInfoStack LoopStack;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000372 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000373
Vitaly Buka64c80b42016-10-26 05:42:30 +0000374 // Stores variables for which we can't generate correct lifetime markers
375 // because of jumps.
376 VarBypassDetector Bypasses;
377
Carlo Bertollib0ff0a62017-04-25 17:52:12 +0000378 // CodeGen lambda for loops and support for ordered clause
379 typedef llvm::function_ref<void(CodeGenFunction &, const OMPLoopDirective &,
380 JumpDest)>
381 CodeGenLoopTy;
382 typedef llvm::function_ref<void(CodeGenFunction &, SourceLocation,
383 const unsigned, const bool)>
384 CodeGenOrderedTy;
385
386 // Codegen lambda for loop bounds in worksharing loop constructs
387 typedef llvm::function_ref<std::pair<LValue, LValue>(
388 CodeGenFunction &, const OMPExecutableDirective &S)>
389 CodeGenLoopBoundsTy;
390
391 // Codegen lambda for loop bounds in dispatch-based loop implementation
392 typedef llvm::function_ref<std::pair<llvm::Value *, llvm::Value *>(
393 CodeGenFunction &, const OMPExecutableDirective &S, Address LB,
394 Address UB)>
395 CodeGenDispatchBoundsTy;
396
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000397 /// CGBuilder insert helper. This function is called after an
Alexander Musman515ad8c2014-05-22 08:54:05 +0000398 /// instruction is created using Builder.
399 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
400 llvm::BasicBlock *BB,
401 llvm::BasicBlock::iterator InsertPt) const;
402
John McCalldec348f72013-05-03 07:33:41 +0000403 /// CurFuncDecl - Holds the Decl for the current outermost
404 /// non-closure context.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000405 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000406 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
407 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000408 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000409 QualType FnRetTy;
Erich Keanebe65e872018-07-10 21:07:50 +0000410 llvm::Function *CurFn = nullptr;
Chris Lattnerac248202007-05-30 00:13:02 +0000411
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000412 // Holds coroutine data if the current function is a coroutine. We use a
413 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
414 // in this header.
415 struct CGCoroInfo {
416 std::unique_ptr<CGCoroData> Data;
417 CGCoroInfo();
418 ~CGCoroInfo();
419 };
420 CGCoroInfo CurCoro;
421
Gor Nishanov04491bd2017-11-11 17:00:43 +0000422 bool isCoroutine() const {
423 return CurCoro.Data != nullptr;
424 }
425
Mike Stumpbee78dd2009-12-04 23:26:17 +0000426 /// CurGD - The GlobalDecl for the current function being compiled.
427 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000428
John McCall31168b02011-06-15 23:02:42 +0000429 /// PrologueCleanupDepth - The cleanup depth enclosing all the
430 /// cleanups associated with the parameters.
431 EHScopeStack::stable_iterator PrologueCleanupDepth;
432
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000433 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000434 JumpDest ReturnBlock;
435
John McCall7f416cc2015-09-08 08:05:57 +0000436 /// ReturnValue - The temporary alloca to hold the return
437 /// value. This is invalid iff the function has no return value.
Erich Keanebe65e872018-07-10 21:07:50 +0000438 Address ReturnValue = Address::invalid();
Mike Stumpfc496822009-02-08 23:14:22 +0000439
Amy Huang7fac5c82019-06-20 17:15:21 +0000440 /// ReturnValuePointer - The temporary alloca to hold a pointer to sret.
441 /// This is invalid if sret is not in use.
442 Address ReturnValuePointer = Address::invalid();
443
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000444 /// Return true if a label was seen in the current scope.
445 bool hasLabelBeenSeenInCurrentScope() const {
446 if (CurLexicalScope)
447 return CurLexicalScope->hasLabels();
448 return !LabelMap.empty();
449 }
450
Chris Lattner03df1222007-06-02 04:53:11 +0000451 /// AllocaInsertPoint - This is an instruction in the entry block before which
452 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000453 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000454
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000455 /// API for captured statement code generation.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000456 class CGCapturedStmtInfo {
457 public:
Alexey Bataevf841bd92014-12-16 07:00:22 +0000458 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
459 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000460 explicit CGCapturedStmtInfo(const CapturedStmt &S,
461 CapturedRegionKind K = CR_Default)
Craig Topper8a13c412014-05-21 05:09:00 +0000462 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000463
464 RecordDecl::field_iterator Field =
465 S.getCapturedRecordDecl()->field_begin();
466 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
467 E = S.capture_end();
468 I != E; ++I, ++Field) {
469 if (I->capturesThis())
470 CXXThisFieldDecl = *Field;
Alexey Bataev330de032014-10-29 12:21:55 +0000471 else if (I->capturesVariable())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000472 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Alexey Bataev7ace49d2016-05-17 08:55:33 +0000473 else if (I->capturesVariableByCopy())
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000474 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000475 }
476 }
477
478 virtual ~CGCapturedStmtInfo();
479
480 CapturedRegionKind getKind() const { return Kind; }
481
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000482 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000483 // Retrieve the value of the context parameter.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000484 virtual llvm::Value *getContextValue() const { return ThisValue; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000485
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000486 /// Lookup the captured field decl for a variable.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000487 virtual const FieldDecl *lookup(const VarDecl *VD) const {
Alexey Bataevb7f18c32017-09-22 16:56:13 +0000488 return CaptureFields.lookup(VD->getCanonicalDecl());
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000489 }
490
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000491 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
492 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000493
Alexey Bataev18095712014-10-10 12:19:54 +0000494 static bool classof(const CGCapturedStmtInfo *) {
495 return true;
496 }
497
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000498 /// Emit the captured statement body.
Alexey Bataev8cbe0a62015-02-26 10:27:34 +0000499 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
Justin Bogner66242d62015-04-23 23:06:47 +0000500 CGF.incrementProfileCounter(S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000501 CGF.EmitStmt(S);
502 }
503
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000504 /// Get the name of the capture helper.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000505 virtual StringRef getHelperName() const { return "__captured_stmt"; }
506
507 private:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000508 /// The kind of captured statement being generated.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000509 CapturedRegionKind Kind;
510
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000511 /// Keep the map between VarDecl and FieldDecl.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000512 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
513
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000514 /// The base address of the captured record, passed in as the first
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000515 /// argument of the parallel region function.
516 llvm::Value *ThisValue;
517
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000518 /// Captured 'this' type.
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000519 FieldDecl *CXXThisFieldDecl;
520 };
Erich Keanebe65e872018-07-10 21:07:50 +0000521 CGCapturedStmtInfo *CapturedStmtInfo = nullptr;
Ben Langmuir3b4c30b2013-05-09 19:17:11 +0000522
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000523 /// RAII for correct setting/restoring of CapturedStmtInfo.
Alexey Bataevd157d472015-06-24 03:35:38 +0000524 class CGCapturedStmtRAII {
525 private:
526 CodeGenFunction &CGF;
527 CGCapturedStmtInfo *PrevCapturedStmtInfo;
528 public:
529 CGCapturedStmtRAII(CodeGenFunction &CGF,
530 CGCapturedStmtInfo *NewCapturedStmtInfo)
531 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
532 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
533 }
534 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
535 };
536
Vedant Kumared00ea02017-03-06 05:28:22 +0000537 /// An abstract representation of regular/ObjC call/message targets.
538 class AbstractCallee {
539 /// The function declaration of the callee.
540 const Decl *CalleeDecl;
541
542 public:
543 AbstractCallee() : CalleeDecl(nullptr) {}
544 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
545 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
546 bool hasFunctionDecl() const {
547 return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
548 }
549 const Decl *getDecl() const { return CalleeDecl; }
550 unsigned getNumParams() const {
551 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
552 return FD->getNumParams();
553 return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
554 }
555 const ParmVarDecl *getParamDecl(unsigned I) const {
556 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
557 return FD->getParamDecl(I);
558 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
559 }
560 };
561
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000562 /// Sanitizers enabled for this function.
Alexey Samsonova0416102014-11-11 01:26:14 +0000563 SanitizerSet SanOpts;
Will Dietzf54319c2013-01-18 11:30:38 +0000564
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000565 /// True if CodeGen currently emits code implementing sanitizer checks.
Erich Keanebe65e872018-07-10 21:07:50 +0000566 bool IsSanitizerScope = false;
Alexey Samsonov24cad992014-07-17 18:46:27 +0000567
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000568 /// RAII object to set/unset CodeGenFunction::IsSanitizerScope.
Alexey Samsonov24cad992014-07-17 18:46:27 +0000569 class SanitizerScope {
570 CodeGenFunction *CGF;
571 public:
572 SanitizerScope(CodeGenFunction *CGF);
573 ~SanitizerScope();
574 };
575
Reid Kleckner19819442014-07-25 21:39:46 +0000576 /// In C++, whether we are code generating a thunk. This controls whether we
577 /// should emit cleanups.
Erich Keanebe65e872018-07-10 21:07:50 +0000578 bool CurFuncIsThunk = false;
Reid Kleckner19819442014-07-25 21:39:46 +0000579
John McCall31168b02011-06-15 23:02:42 +0000580 /// In ARC, whether we should autorelease the return value.
Erich Keanebe65e872018-07-10 21:07:50 +0000581 bool AutoreleaseResult = false;
John McCall31168b02011-06-15 23:02:42 +0000582
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000583 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
584 /// potentially set the return value.
Erich Keanebe65e872018-07-10 21:07:50 +0000585 bool SawAsmBlock = false;
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000586
David Chisnall93ce0182018-08-10 12:53:13 +0000587 const NamedDecl *CurSEHParent = nullptr;
David Majnemer25eb1652016-03-01 19:42:53 +0000588
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000589 /// True if the current function is an outlined SEH helper. This can be a
590 /// finally block or filter expression.
Erich Keanebe65e872018-07-10 21:07:50 +0000591 bool IsOutlinedSEHHelper = false;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000592
Yonghong Song048493f2019-07-09 04:21:50 +0000593 /// True if CodeGen currently emits code inside presereved access index
594 /// region.
595 bool IsInPreservedAIRegion = false;
596
Erich Keanebe65e872018-07-10 21:07:50 +0000597 const CodeGen::CGBlockInfo *BlockInfo = nullptr;
598 llvm::Value *BlockPointer = nullptr;
John McCallad7c5c12011-02-08 08:22:06 +0000599
Eli Friedman9fbeba02012-02-11 02:57:39 +0000600 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
Erich Keanebe65e872018-07-10 21:07:50 +0000601 FieldDecl *LambdaThisCaptureField = nullptr;
Eli Friedman9fbeba02012-02-11 02:57:39 +0000602
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000603 /// A mapping from NRVO variables to the flags used to indicate
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000604 /// when the NRVO has been applied to this variable.
605 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000606
John McCallbd309292010-07-06 01:34:17 +0000607 EHScopeStack EHStack;
Richard Smith736a9472013-06-12 20:42:33 +0000608 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
Nico Weber5779f842015-02-12 23:16:11 +0000609 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
Richard Smith736a9472013-06-12 20:42:33 +0000610
David Majnemer4e52d6f2015-12-12 05:39:21 +0000611 llvm::Instruction *CurrentFuncletPad = nullptr;
612
Tim Shen421119f2016-07-01 21:08:47 +0000613 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
614 llvm::Value *Addr;
615 llvm::Value *Size;
616
617 public:
618 CallLifetimeEnd(Address addr, llvm::Value *size)
619 : Addr(addr.getPointer()), Size(size) {}
620
621 void Emit(CodeGenFunction &CGF, Flags flags) override {
622 CGF.EmitLifetimeEnd(Size, Addr);
623 }
624 };
625
Richard Smith736a9472013-06-12 20:42:33 +0000626 /// Header for data within LifetimeExtendedCleanupStack.
627 struct LifetimeExtendedCleanupHeader {
628 /// The size of the following cleanup object.
Justin Bognerbdff2192015-07-01 00:59:27 +0000629 unsigned Size;
Richard Smith736a9472013-06-12 20:42:33 +0000630 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
Richard Smithf66e4f72018-07-23 22:56:45 +0000631 unsigned Kind : 31;
632 /// Whether this is a conditional cleanup.
633 unsigned IsConditional : 1;
Richard Smith736a9472013-06-12 20:42:33 +0000634
Justin Bognerbdff2192015-07-01 00:59:27 +0000635 size_t getSize() const { return Size; }
Richard Smithf66e4f72018-07-23 22:56:45 +0000636 CleanupKind getKind() const { return (CleanupKind)Kind; }
637 bool isConditional() const { return IsConditional; }
Richard Smith736a9472013-06-12 20:42:33 +0000638 };
John McCallbd309292010-07-06 01:34:17 +0000639
John McCallad5d61e2010-07-23 21:56:41 +0000640 /// i32s containing the indexes of the cleanup destinations.
Erich Keanebe65e872018-07-10 21:07:50 +0000641 Address NormalCleanupDest = Address::invalid();
John McCallad5d61e2010-07-23 21:56:41 +0000642
Erich Keanebe65e872018-07-10 21:07:50 +0000643 unsigned NextCleanupDestIndex = 1;
John McCallad5d61e2010-07-23 21:56:41 +0000644
John McCall08ef4662011-11-10 08:15:53 +0000645 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
Erich Keanebe65e872018-07-10 21:07:50 +0000646 CGBlockInfo *FirstBlockInfo = nullptr;
John McCall08ef4662011-11-10 08:15:53 +0000647
John McCall8e4c74b2011-08-11 02:22:43 +0000648 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
Erich Keanebe65e872018-07-10 21:07:50 +0000649 llvm::BasicBlock *EHResumeBlock = nullptr;
John McCall8e4c74b2011-08-11 02:22:43 +0000650
Bill Wendlingf0724e82011-09-19 20:31:14 +0000651 /// The exception slot. All landing pads write the current exception pointer
652 /// into this alloca.
Erich Keanebe65e872018-07-10 21:07:50 +0000653 llvm::Value *ExceptionSlot = nullptr;
John McCallbd309292010-07-06 01:34:17 +0000654
Bill Wendlingf0724e82011-09-19 20:31:14 +0000655 /// The selector slot. Under the MandatoryCleanup model, all landing pads
656 /// write the current selector value into this alloca.
Erich Keanebe65e872018-07-10 21:07:50 +0000657 llvm::AllocaInst *EHSelectorSlot = nullptr;
John McCall9b382dd2011-05-28 21:13:02 +0000658
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000659 /// A stack of exception code slots. Entering an __except block pushes a slot
660 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
661 /// a value from the top of the stack.
John McCall7f416cc2015-09-08 08:05:57 +0000662 SmallVector<Address, 1> SEHCodeSlotStack;
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +0000663
Reid Kleckner9fe7f232015-07-07 00:36:30 +0000664 /// Value returned by __exception_info intrinsic.
665 llvm::Value *SEHInfo = nullptr;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000666
John McCallbd309292010-07-06 01:34:17 +0000667 /// Emits a landing pad for the current EH stack.
668 llvm::BasicBlock *EmitLandingPad();
669
670 llvm::BasicBlock *getInvokeDestImpl();
671
John McCallce1de612011-01-26 04:00:11 +0000672 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000673 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
674 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000675 }
676
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000677public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000678 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
679 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000680 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000681
John McCall6b0feb72011-06-22 02:32:12 +0000682 /// A class controlling the emission of a finally block.
683 class FinallyInfo {
684 /// Where the catchall's edge through the cleanup should go.
685 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000686
John McCall6b0feb72011-06-22 02:32:12 +0000687 /// A function to call to enter the catch.
James Y Knight9871db02019-02-05 16:42:33 +0000688 llvm::FunctionCallee BeginCatchFn;
John McCall6b0feb72011-06-22 02:32:12 +0000689
690 /// An i1 variable indicating whether or not the @finally is
691 /// running for an exception.
692 llvm::AllocaInst *ForEHVar;
693
694 /// An i8* variable into which the exception pointer to rethrow
695 /// has been saved.
696 llvm::AllocaInst *SavedExnVar;
697
698 public:
699 void enter(CodeGenFunction &CGF, const Stmt *Finally,
James Y Knight9871db02019-02-05 16:42:33 +0000700 llvm::FunctionCallee beginCatchFn,
701 llvm::FunctionCallee endCatchFn, llvm::FunctionCallee rethrowFn);
John McCall6b0feb72011-06-22 02:32:12 +0000702 void exit(CodeGenFunction &CGF);
703 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000704
Reid Kleckner11c033e2015-02-12 23:40:45 +0000705 /// Returns true inside SEH __try blocks.
706 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
707
Reid Klecknera002bd52015-10-28 23:06:42 +0000708 /// Returns true while emitting a cleanuppad.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000709 bool isCleanupPadScope() const {
710 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
711 }
Reid Klecknera002bd52015-10-28 23:06:42 +0000712
John McCallce1de612011-01-26 04:00:11 +0000713 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
714 /// current full-expression. Safe against the possibility that
715 /// we're currently inside a conditionally-evaluated expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000716 template <class T, class... As>
717 void pushFullExprCleanup(CleanupKind kind, As... A) {
John McCalle4df6c82011-01-28 08:37:24 +0000718 // If we're not in a conditional branch, or if none of the
719 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000720 if (!isInConditionalBranch())
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000721 return EHStack.pushCleanup<T>(kind, A...);
John McCalle4df6c82011-01-28 08:37:24 +0000722
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000723 // Stash values in a tuple so we can guarantee the order of saves.
724 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
725 SavedTuple Saved{saveValueInCond(A)...};
John McCalle4df6c82011-01-28 08:37:24 +0000726
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000727 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
Benjamin Kramer7f1f6b52015-03-12 23:46:55 +0000728 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
John McCall4bd0fb12011-07-12 16:41:08 +0000729 initFullExprCleanup();
730 }
731
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000732 /// Queue a cleanup to be pushed after finishing the current
Richard Smith736a9472013-06-12 20:42:33 +0000733 /// full-expression.
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000734 template <class T, class... As>
735 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
Richard Smithf66e4f72018-07-23 22:56:45 +0000736 if (!isInConditionalBranch())
737 return pushCleanupAfterFullExprImpl<T>(Kind, Address::invalid(), A...);
Richard Smith736a9472013-06-12 20:42:33 +0000738
Richard Smithf66e4f72018-07-23 22:56:45 +0000739 Address ActiveFlag = createCleanupActiveFlag();
740 assert(!DominatingValue<Address>::needsSaving(ActiveFlag) &&
741 "cleanup active flag should never need saving");
742
743 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
744 SavedTuple Saved{saveValueInCond(A)...};
745
746 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
747 pushCleanupAfterFullExprImpl<CleanupType>(Kind, ActiveFlag, Saved);
748 }
749
750 template <class T, class... As>
751 void pushCleanupAfterFullExprImpl(CleanupKind Kind, Address ActiveFlag,
752 As... A) {
753 LifetimeExtendedCleanupHeader Header = {sizeof(T), Kind,
754 ActiveFlag.isValid()};
Richard Smith736a9472013-06-12 20:42:33 +0000755
756 size_t OldSize = LifetimeExtendedCleanupStack.size();
757 LifetimeExtendedCleanupStack.resize(
Richard Smithf66e4f72018-07-23 22:56:45 +0000758 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size +
759 (Header.IsConditional ? sizeof(ActiveFlag) : 0));
Richard Smith736a9472013-06-12 20:42:33 +0000760
Benjamin Kramerc3f89252016-10-20 14:27:22 +0000761 static_assert(sizeof(Header) % alignof(T) == 0,
Justin Bognerbdff2192015-07-01 00:59:27 +0000762 "Cleanup will be allocated on misaligned address");
Richard Smith736a9472013-06-12 20:42:33 +0000763 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
764 new (Buffer) LifetimeExtendedCleanupHeader(Header);
Benjamin Kramer51680bc2015-03-12 23:41:40 +0000765 new (Buffer + sizeof(Header)) T(A...);
Richard Smithf66e4f72018-07-23 22:56:45 +0000766 if (Header.IsConditional)
767 new (Buffer + sizeof(Header) + sizeof(T)) Address(ActiveFlag);
Richard Smith736a9472013-06-12 20:42:33 +0000768 }
769
Richard Smithf66e4f72018-07-23 22:56:45 +0000770 /// Set up the last cleanup that was pushed as a conditional
John McCallf4beacd2011-11-10 10:43:54 +0000771 /// full-expression cleanup.
Richard Smithf66e4f72018-07-23 22:56:45 +0000772 void initFullExprCleanup() {
773 initFullExprCleanupWithFlag(createCleanupActiveFlag());
774 }
775
776 void initFullExprCleanupWithFlag(Address ActiveFlag);
777 Address createCleanupActiveFlag();
John McCallf4beacd2011-11-10 10:43:54 +0000778
John McCallbd309292010-07-06 01:34:17 +0000779 /// PushDestructorCleanup - Push a cleanup to call the
780 /// complete-object destructor of an object of the given type at the
781 /// given address. Does nothing if T is not a C++ class type with a
782 /// non-trivial destructor.
John McCall7f416cc2015-09-08 08:05:57 +0000783 void PushDestructorCleanup(QualType T, Address Addr);
John McCallbd309292010-07-06 01:34:17 +0000784
John McCall8680f872010-07-21 06:29:51 +0000785 /// PushDestructorCleanup - Push a cleanup to call the
786 /// complete-object variant of the given destructor on the object at
787 /// the given address.
Marco Antognini88559632019-07-22 09:39:13 +0000788 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, QualType T,
789 Address Addr);
John McCall8680f872010-07-21 06:29:51 +0000790
John McCallbd309292010-07-06 01:34:17 +0000791 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
792 /// process all branch fixups.
Adrian Prantldc237b52013-05-16 00:41:26 +0000793 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000794
John McCall824c2f52010-09-14 07:57:04 +0000795 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
796 /// The block cannot be reactivated. Pops it if it's the top of the
797 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000798 ///
799 /// \param DominatingIP - An instruction which is known to
800 /// dominate the current IP (if set) and which lies along
801 /// all paths of execution between the current IP and the
802 /// the point at which the cleanup comes into scope.
803 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
804 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000805
806 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
807 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000808 ///
809 /// \param DominatingIP - An instruction which is known to
810 /// dominate the current IP (if set) and which lies along
811 /// all paths of execution between the current IP and the
812 /// the point at which the cleanup comes into scope.
813 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
814 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000815
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000816 /// Enters a new scope for capturing cleanups, all of which
John McCallbd309292010-07-06 01:34:17 +0000817 /// will be executed once the scope is exited.
818 class RunCleanupsScope {
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000819 EHScopeStack::stable_iterator CleanupStackDepth, OldCleanupScopeDepth;
Richard Smith736a9472013-06-12 20:42:33 +0000820 size_t LifetimeExtendedCleanupStackSize;
Douglas Gregor965f4502009-11-24 16:43:22 +0000821 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000822 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000823 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000824 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000825
Aaron Ballmanabc18922015-02-15 22:54:08 +0000826 RunCleanupsScope(const RunCleanupsScope &) = delete;
827 void operator=(const RunCleanupsScope &) = delete;
Douglas Gregor965f4502009-11-24 16:43:22 +0000828
Eric Christophera9d34972011-10-19 00:43:52 +0000829 protected:
830 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000831
Douglas Gregor965f4502009-11-24 16:43:22 +0000832 public:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000833 /// Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000834 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000835 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000836 {
John McCallbd309292010-07-06 01:34:17 +0000837 CleanupStackDepth = CGF.EHStack.stable_begin();
Richard Smith736a9472013-06-12 20:42:33 +0000838 LifetimeExtendedCleanupStackSize =
839 CGF.LifetimeExtendedCleanupStack.size();
Douglas Gregor965f4502009-11-24 16:43:22 +0000840 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000841 CGF.DidCallStackSave = false;
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000842 OldCleanupScopeDepth = CGF.CurrentCleanupScopeDepth;
843 CGF.CurrentCleanupScopeDepth = CleanupStackDepth;
Douglas Gregor965f4502009-11-24 16:43:22 +0000844 }
845
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000846 /// Exit this cleanup scope, emitting any accumulated cleanups.
John McCallbd309292010-07-06 01:34:17 +0000847 ~RunCleanupsScope() {
Reid Kleckner092d0652017-03-06 22:18:34 +0000848 if (PerformCleanup)
849 ForceCleanup();
Douglas Gregor680f8612009-11-24 21:15:44 +0000850 }
851
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000852 /// Determine whether this scope requires any cleanups.
Douglas Gregor680f8612009-11-24 21:15:44 +0000853 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000854 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000855 }
856
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000857 /// Force the emission of cleanups now, instead of waiting
Douglas Gregor680f8612009-11-24 21:15:44 +0000858 /// until this object is destroyed.
Reid Kleckner092d0652017-03-06 22:18:34 +0000859 /// \param ValuesToReload - A list of values that need to be available at
860 /// the insertion point after cleanup emission. If cleanup emission created
861 /// a shared cleanup block, these value pointers will be rewritten.
862 /// Otherwise, they not will be modified.
863 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
Douglas Gregor680f8612009-11-24 21:15:44 +0000864 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000865 CGF.DidCallStackSave = OldDidCallStackSave;
Reid Kleckner092d0652017-03-06 22:18:34 +0000866 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
867 ValuesToReload);
Douglas Gregor680f8612009-11-24 21:15:44 +0000868 PerformCleanup = false;
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000869 CGF.CurrentCleanupScopeDepth = OldCleanupScopeDepth;
Douglas Gregor965f4502009-11-24 16:43:22 +0000870 }
871 };
872
Akira Hatanakaccda3d22018-04-27 06:57:00 +0000873 // Cleanup stack depth of the RunCleanupsScope that was pushed most recently.
874 EHScopeStack::stable_iterator CurrentCleanupScopeDepth =
875 EHScopeStack::stable_end();
876
David Blaikie93be0b22014-08-22 21:37:04 +0000877 class LexicalScope : public RunCleanupsScope {
Eric Christophera9d34972011-10-19 00:43:52 +0000878 SourceRange Range;
Nadav Rotem1da30942013-03-23 06:43:35 +0000879 SmallVector<const LabelDecl*, 4> Labels;
880 LexicalScope *ParentScope;
Eric Christophera9d34972011-10-19 00:43:52 +0000881
Aaron Ballmanabc18922015-02-15 22:54:08 +0000882 LexicalScope(const LexicalScope &) = delete;
883 void operator=(const LexicalScope &) = delete;
Eric Christophera9d34972011-10-19 00:43:52 +0000884
885 public:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000886 /// Enter a new cleanup scope.
Eric Christophera9d34972011-10-19 00:43:52 +0000887 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem1da30942013-03-23 06:43:35 +0000888 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
889 CGF.CurLexicalScope = this;
Eric Christophera9d34972011-10-19 00:43:52 +0000890 if (CGDebugInfo *DI = CGF.getDebugInfo())
891 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
892 }
893
Nadav Rotem1da30942013-03-23 06:43:35 +0000894 void addLabel(const LabelDecl *label) {
895 assert(PerformCleanup && "adding label to dead scope?");
896 Labels.push_back(label);
897 }
898
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000899 /// Exit this cleanup scope, emitting any accumulated
Eric Christophera9d34972011-10-19 00:43:52 +0000900 /// cleanups.
901 ~LexicalScope() {
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000902 if (CGDebugInfo *DI = CGF.getDebugInfo())
903 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
904
Nadav Rotem1da30942013-03-23 06:43:35 +0000905 // If we should perform a cleanup, force them now. Note that
906 // this ends the cleanup scope before rescoping any labels.
David Blaikie4d524432015-02-04 19:47:54 +0000907 if (PerformCleanup) {
Calixte Denizetfcd661d2018-09-24 18:24:18 +0000908 ApplyDebugLocation DL(CGF, Range.getEnd());
David Blaikie4d524432015-02-04 19:47:54 +0000909 ForceCleanup();
910 }
Eric Christophera9d34972011-10-19 00:43:52 +0000911 }
912
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000913 /// Force the emission of cleanups now, instead of waiting
Eric Christophera9d34972011-10-19 00:43:52 +0000914 /// until this object is destroyed.
915 void ForceCleanup() {
Nadav Rotem1da30942013-03-23 06:43:35 +0000916 CGF.CurLexicalScope = ParentScope;
Adrian Prantl5d5b67c2013-04-01 19:02:06 +0000917 RunCleanupsScope::ForceCleanup();
918
Nadav Rotem1da30942013-03-23 06:43:35 +0000919 if (!Labels.empty())
920 rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000921 }
Nadav Rotem1da30942013-03-23 06:43:35 +0000922
Akira Hatanakafdcd18b2017-01-25 22:55:13 +0000923 bool hasLabels() const {
924 return !Labels.empty();
925 }
926
Nadav Rotem1da30942013-03-23 06:43:35 +0000927 void rescopeLabels();
Eric Christophera9d34972011-10-19 00:43:52 +0000928 };
929
John McCall7f416cc2015-09-08 08:05:57 +0000930 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
931
Alexey Bataevab4ea222018-03-07 18:17:06 +0000932 /// The class used to assign some variables some temporarily addresses.
933 class OMPMapVars {
John McCall7f416cc2015-09-08 08:05:57 +0000934 DeclMapTy SavedLocals;
Alexey Bataevab4ea222018-03-07 18:17:06 +0000935 DeclMapTy SavedTempAddresses;
936 OMPMapVars(const OMPMapVars &) = delete;
937 void operator=(const OMPMapVars &) = delete;
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000938
939 public:
Alexey Bataevab4ea222018-03-07 18:17:06 +0000940 explicit OMPMapVars() = default;
941 ~OMPMapVars() {
942 assert(SavedLocals.empty() && "Did not restored original addresses.");
943 };
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000944
Alexey Bataevab4ea222018-03-07 18:17:06 +0000945 /// Sets the address of the variable \p LocalVD to be \p TempAddr in
946 /// function \p CGF.
947 /// \return true if at least one variable was set already, false otherwise.
948 bool setVarAddr(CodeGenFunction &CGF, const VarDecl *LocalVD,
949 Address TempAddr) {
Alexey Bataev6a71f362017-08-22 17:54:52 +0000950 LocalVD = LocalVD->getCanonicalDecl();
John McCall7f416cc2015-09-08 08:05:57 +0000951 // Only save it once.
952 if (SavedLocals.count(LocalVD)) return false;
953
954 // Copy the existing local entry to SavedLocals.
955 auto it = CGF.LocalDeclMap.find(LocalVD);
Alexey Bataevab4ea222018-03-07 18:17:06 +0000956 if (it != CGF.LocalDeclMap.end())
957 SavedLocals.try_emplace(LocalVD, it->second);
958 else
959 SavedLocals.try_emplace(LocalVD, Address::invalid());
John McCall7f416cc2015-09-08 08:05:57 +0000960
961 // Generate the private entry.
Alexey Bataevcaacd532015-09-04 11:26:21 +0000962 QualType VarTy = LocalVD->getType();
963 if (VarTy->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000964 Address Temp = CGF.CreateMemTemp(VarTy);
Alexey Bataevab4ea222018-03-07 18:17:06 +0000965 CGF.Builder.CreateStore(TempAddr.getPointer(), Temp);
966 TempAddr = Temp;
Alexey Bataevcaacd532015-09-04 11:26:21 +0000967 }
Alexey Bataevab4ea222018-03-07 18:17:06 +0000968 SavedTempAddresses.try_emplace(LocalVD, TempAddr);
John McCall7f416cc2015-09-08 08:05:57 +0000969
Alexey Bataev435ad7b2014-10-10 09:48:26 +0000970 return true;
971 }
972
Alexey Bataevab4ea222018-03-07 18:17:06 +0000973 /// Applies new addresses to the list of the variables.
974 /// \return true if at least one variable is using new address, false
975 /// otherwise.
976 bool apply(CodeGenFunction &CGF) {
977 copyInto(SavedTempAddresses, CGF.LocalDeclMap);
978 SavedTempAddresses.clear();
979 return !SavedLocals.empty();
980 }
981
982 /// Restores original addresses of the variables.
983 void restore(CodeGenFunction &CGF) {
984 if (!SavedLocals.empty()) {
985 copyInto(SavedLocals, CGF.LocalDeclMap);
986 SavedLocals.clear();
987 }
988 }
989
990 private:
991 /// Copy all the entries in the source map over the corresponding
992 /// entries in the destination, which must exist.
993 static void copyInto(const DeclMapTy &Src, DeclMapTy &Dest) {
994 for (auto &Pair : Src) {
995 if (!Pair.second.isValid()) {
996 Dest.erase(Pair.first);
997 continue;
998 }
999
1000 auto I = Dest.find(Pair.first);
1001 if (I != Dest.end())
1002 I->second = Pair.second;
1003 else
1004 Dest.insert(Pair);
1005 }
1006 }
1007 };
1008
1009 /// The scope used to remap some variables as private in the OpenMP loop body
1010 /// (or other captured region emitted without outlining), and to restore old
1011 /// vars back on exit.
1012 class OMPPrivateScope : public RunCleanupsScope {
1013 OMPMapVars MappedVars;
1014 OMPPrivateScope(const OMPPrivateScope &) = delete;
1015 void operator=(const OMPPrivateScope &) = delete;
1016
1017 public:
1018 /// Enter a new OpenMP private scope.
1019 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
1020
1021 /// Registers \p LocalVD variable as a private and apply \p PrivateGen
1022 /// function for it to generate corresponding private variable. \p
1023 /// PrivateGen returns an address of the generated private variable.
1024 /// \return true if the variable is registered as private, false if it has
1025 /// been privatized already.
1026 bool addPrivate(const VarDecl *LocalVD,
Alexey Bataevddf3db92018-04-13 17:31:06 +00001027 const llvm::function_ref<Address()> PrivateGen) {
Alexey Bataevab4ea222018-03-07 18:17:06 +00001028 assert(PerformCleanup && "adding private to dead scope");
1029 return MappedVars.setVarAddr(CGF, LocalVD, PrivateGen());
1030 }
1031
1032 /// Privatizes local variables previously registered as private.
Alexey Bataev435ad7b2014-10-10 09:48:26 +00001033 /// Registration is separate from the actual privatization to allow
1034 /// initializers use values of the original variables, not the private one.
1035 /// This is important, for example, if the private variable is a class
1036 /// variable initialized by a constructor that references other private
1037 /// variables. But at initialization original variables must be used, not
1038 /// private copies.
1039 /// \return true if at least one variable was privatized, false otherwise.
Alexey Bataevab4ea222018-03-07 18:17:06 +00001040 bool Privatize() { return MappedVars.apply(CGF); }
Alexey Bataev435ad7b2014-10-10 09:48:26 +00001041
1042 void ForceCleanup() {
1043 RunCleanupsScope::ForceCleanup();
Alexey Bataevab4ea222018-03-07 18:17:06 +00001044 MappedVars.restore(CGF);
Alexey Bataev435ad7b2014-10-10 09:48:26 +00001045 }
1046
Alexey Bataevab4ea222018-03-07 18:17:06 +00001047 /// Exit scope - all the mapped variables are restored.
Alexey Bataeva63048e2015-03-23 06:18:07 +00001048 ~OMPPrivateScope() {
1049 if (PerformCleanup)
1050 ForceCleanup();
1051 }
John McCall7f416cc2015-09-08 08:05:57 +00001052
Gor Nishanov04491bd2017-11-11 17:00:43 +00001053 /// Checks if the global variable is captured in current function.
Alexey Bataev4ba78a42016-04-27 07:56:03 +00001054 bool isGlobalVarCaptured(const VarDecl *VD) const {
Alexey Bataev6a71f362017-08-22 17:54:52 +00001055 VD = VD->getCanonicalDecl();
Alexey Bataev4ba78a42016-04-27 07:56:03 +00001056 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
1057 }
Alexey Bataev435ad7b2014-10-10 09:48:26 +00001058 };
Anders Carlssonb9fd57f2010-03-30 03:14:41 +00001059
Alexey Bataevd08c0562019-11-19 12:07:54 -05001060 /// Save/restore original map of previously emitted local vars in case when we
1061 /// need to duplicate emission of the same code several times in the same
1062 /// function for OpenMP code.
1063 class OMPLocalDeclMapRAII {
1064 CodeGenFunction &CGF;
1065 DeclMapTy SavedMap;
1066
1067 public:
1068 OMPLocalDeclMapRAII(CodeGenFunction &CGF)
1069 : CGF(CGF), SavedMap(CGF.LocalDeclMap) {}
1070 ~OMPLocalDeclMapRAII() { SavedMap.swap(CGF.LocalDeclMap); }
1071 };
1072
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001073 /// Takes the old cleanup stack size and emits the cleanup blocks
Richard Smith736a9472013-06-12 20:42:33 +00001074 /// that have been added.
Reid Kleckner092d0652017-03-06 22:18:34 +00001075 void
1076 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
1077 std::initializer_list<llvm::Value **> ValuesToReload = {});
Anders Carlssonb9fd57f2010-03-30 03:14:41 +00001078
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001079 /// Takes the old cleanup stack size and emits the cleanup blocks
Richard Smith736a9472013-06-12 20:42:33 +00001080 /// that have been added, then adds all lifetime-extended cleanups from
1081 /// the given position to the stack.
Reid Kleckner092d0652017-03-06 22:18:34 +00001082 void
1083 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
1084 size_t OldLifetimeExtendedStackSize,
1085 std::initializer_list<llvm::Value **> ValuesToReload = {});
Richard Smith736a9472013-06-12 20:42:33 +00001086
John McCallad5d61e2010-07-23 21:56:41 +00001087 void ResolveBranchFixups(llvm::BasicBlock *Target);
1088
John McCallbd309292010-07-06 01:34:17 +00001089 /// The given basic block lies in the current EH scope, but may be a
1090 /// target of a potentially scope-crossing jump; get a stable handle
1091 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +00001092 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +00001093 return JumpDest(Target,
1094 EHStack.getInnermostNormalCleanup(),
1095 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +00001096 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +00001097
John McCallbd309292010-07-06 01:34:17 +00001098 /// The given basic block lies in the current EH scope, but may be a
1099 /// target of a potentially scope-crossing jump; get a stable handle
1100 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +00001101 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +00001102 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +00001103 }
1104
1105 /// EmitBranchThroughCleanup - Emit a branch from the current insert
1106 /// block through the normal cleanup handling code (if any) and then
1107 /// on to \arg Dest.
1108 void EmitBranchThroughCleanup(JumpDest Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +00001109
Justin Bognere25ffdf2014-01-21 00:35:11 +00001110 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
1111 /// specified destination obviously has no cleanups to run. 'false' is always
1112 /// a conservatively correct answer for this method.
1113 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
1114
John McCall8e4c74b2011-08-11 02:22:43 +00001115 /// popCatchScope - Pops the catch scope at the top of the EHScope
1116 /// stack, emitting any required code (other than the catch handlers
1117 /// themselves).
1118 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +00001119
David Chisnall9a837be2012-11-07 16:50:40 +00001120 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +00001121 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Heejin Ahnc6479192018-05-31 22:18:13 +00001122 llvm::BasicBlock *
1123 getFuncletEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +00001124
John McCallce1de612011-01-26 04:00:11 +00001125 /// An object to manage conditionally-evaluated expressions.
1126 class ConditionalEvaluation {
1127 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +00001128
John McCallce1de612011-01-26 04:00:11 +00001129 public:
1130 ConditionalEvaluation(CodeGenFunction &CGF)
1131 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001132
John McCallce1de612011-01-26 04:00:11 +00001133 void begin(CodeGenFunction &CGF) {
1134 assert(CGF.OutermostConditional != this);
1135 if (!CGF.OutermostConditional)
1136 CGF.OutermostConditional = this;
1137 }
1138
1139 void end(CodeGenFunction &CGF) {
Craig Topper8a13c412014-05-21 05:09:00 +00001140 assert(CGF.OutermostConditional != nullptr);
John McCallce1de612011-01-26 04:00:11 +00001141 if (CGF.OutermostConditional == this)
Craig Topper8a13c412014-05-21 05:09:00 +00001142 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +00001143 }
1144
1145 /// Returns a block which will be executed prior to each
1146 /// evaluation of the conditional code.
1147 llvm::BasicBlock *getStartingBlock() const {
1148 return StartBB;
1149 }
1150 };
Mike Stump11289f42009-09-09 15:08:12 +00001151
John McCall7f9c92a2010-09-17 00:50:28 +00001152 /// isInConditionalBranch - Return true if we're currently emitting
1153 /// one branch or the other of a conditional expression.
Craig Topper8a13c412014-05-21 05:09:00 +00001154 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
John McCallce1de612011-01-26 04:00:11 +00001155
John McCall7f416cc2015-09-08 08:05:57 +00001156 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
John McCallf4beacd2011-11-10 10:43:54 +00001157 assert(isInConditionalBranch());
1158 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
John McCall7f416cc2015-09-08 08:05:57 +00001159 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
Guillaume Chateletc79099e2019-10-03 13:00:29 +00001160 store->setAlignment(addr.getAlignment().getAsAlign());
John McCallf4beacd2011-11-10 10:43:54 +00001161 }
1162
John McCallce1de612011-01-26 04:00:11 +00001163 /// An RAII object to record that we're evaluating a statement
1164 /// expression.
1165 class StmtExprEvaluation {
1166 CodeGenFunction &CGF;
1167
1168 /// We have to save the outermost conditional: cleanups in a
1169 /// statement expression aren't conditional just because the
1170 /// StmtExpr is.
1171 ConditionalEvaluation *SavedOutermostConditional;
1172
1173 public:
1174 StmtExprEvaluation(CodeGenFunction &CGF)
1175 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
Craig Topper8a13c412014-05-21 05:09:00 +00001176 CGF.OutermostConditional = nullptr;
John McCallce1de612011-01-26 04:00:11 +00001177 }
1178
1179 ~StmtExprEvaluation() {
1180 CGF.OutermostConditional = SavedOutermostConditional;
1181 CGF.EnsureInsertPoint();
1182 }
1183 };
John McCall1bf58462011-02-16 08:02:54 +00001184
John McCallc07a0c72011-02-17 10:25:35 +00001185 /// An object which temporarily prevents a value from being
1186 /// destroyed by aggressive peephole optimizations that assume that
1187 /// all uses of a value have been realized in the IR.
1188 class PeepholeProtection {
1189 llvm::Instruction *Inst;
1190 friend class CodeGenFunction;
1191
1192 public:
Craig Topper8a13c412014-05-21 05:09:00 +00001193 PeepholeProtection() : Inst(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +00001194 };
John McCallc07a0c72011-02-17 10:25:35 +00001195
John McCallfe96e0b2011-11-06 09:01:30 +00001196 /// A non-RAII class containing all the information about a bound
1197 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
1198 /// this which makes individual mappings very simple; using this
1199 /// class directly is useful when you have a variable number of
1200 /// opaque values or don't want the RAII functionality for some
1201 /// reason.
1202 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +00001203 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +00001204 bool BoundLValue;
1205 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +00001206
John McCallfe96e0b2011-11-06 09:01:30 +00001207 OpaqueValueMappingData(const OpaqueValueExpr *ov,
1208 bool boundLValue)
1209 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +00001210 public:
Craig Topper8a13c412014-05-21 05:09:00 +00001211 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
John McCallfe96e0b2011-11-06 09:01:30 +00001212
John McCallc07a0c72011-02-17 10:25:35 +00001213 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +00001214 // gl-values should be bound as l-values for obvious reasons.
1215 // Records should be bound as l-values because IR generation
1216 // always keeps them in memory. Expressions of function type
1217 // act exactly like l-values but are formally required to be
1218 // r-values in C.
1219 return expr->isGLValue() ||
Fariborz Jahanian77411012014-02-14 19:37:25 +00001220 expr->getType()->isFunctionType() ||
1221 hasAggregateEvaluationKind(expr->getType());
John McCallc07a0c72011-02-17 10:25:35 +00001222 }
1223
John McCallfe96e0b2011-11-06 09:01:30 +00001224 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1225 const OpaqueValueExpr *ov,
1226 const Expr *e) {
1227 if (shouldBindAsLValue(ov))
1228 return bind(CGF, ov, CGF.EmitLValue(e));
1229 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1230 }
1231
1232 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1233 const OpaqueValueExpr *ov,
1234 const LValue &lv) {
1235 assert(shouldBindAsLValue(ov));
1236 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1237 return OpaqueValueMappingData(ov, true);
1238 }
1239
1240 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1241 const OpaqueValueExpr *ov,
1242 const RValue &rv) {
1243 assert(!shouldBindAsLValue(ov));
1244 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1245
1246 OpaqueValueMappingData data(ov, false);
1247
1248 // Work around an extremely aggressive peephole optimization in
1249 // EmitScalarConversion which assumes that all other uses of a
1250 // value are extant.
1251 data.Protection = CGF.protectFromPeepholes(rv);
1252
1253 return data;
1254 }
1255
Craig Topper8a13c412014-05-21 05:09:00 +00001256 bool isValid() const { return OpaqueValue != nullptr; }
1257 void clear() { OpaqueValue = nullptr; }
John McCallfe96e0b2011-11-06 09:01:30 +00001258
1259 void unbind(CodeGenFunction &CGF) {
1260 assert(OpaqueValue && "no data to unbind!");
1261
1262 if (BoundLValue) {
1263 CGF.OpaqueLValues.erase(OpaqueValue);
1264 } else {
1265 CGF.OpaqueRValues.erase(OpaqueValue);
1266 CGF.unprotectFromPeepholes(Protection);
1267 }
1268 }
1269 };
1270
1271 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1272 class OpaqueValueMapping {
1273 CodeGenFunction &CGF;
1274 OpaqueValueMappingData Data;
1275
1276 public:
1277 static bool shouldBindAsLValue(const Expr *expr) {
1278 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1279 }
1280
John McCallc07a0c72011-02-17 10:25:35 +00001281 /// Build the opaque value mapping for the given conditional
1282 /// operator if it's the GNU ?: extension. This is a common
1283 /// enough pattern that the convenience operator is really
1284 /// helpful.
1285 ///
1286 OpaqueValueMapping(CodeGenFunction &CGF,
1287 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +00001288 if (isa<ConditionalOperator>(op))
1289 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001290 return;
John McCallc07a0c72011-02-17 10:25:35 +00001291
1292 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001293 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1294 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001295 }
1296
Richard Smith410306b2016-12-12 02:53:20 +00001297 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1298 /// expression is set to the expression the OVE represents.
1299 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1300 : CGF(CGF) {
1301 if (OV) {
1302 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1303 "for OVE with no source expression");
1304 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1305 }
1306 }
1307
John McCall1bf58462011-02-16 08:02:54 +00001308 OpaqueValueMapping(CodeGenFunction &CGF,
1309 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001310 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001311 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001312 }
1313
1314 OpaqueValueMapping(CodeGenFunction &CGF,
1315 const OpaqueValueExpr *opaqueValue,
1316 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001317 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001318 }
1319
1320 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001321 Data.unbind(CGF);
1322 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001323 }
1324
1325 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001326 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001327 }
1328 };
Gor Nishanov04491bd2017-11-11 17:00:43 +00001329
Chris Lattner2da04b32007-08-24 05:35:26 +00001330private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001331 CGDebugInfo *DebugInfo;
Adrian Prantla40cce82018-11-09 19:17:56 +00001332 /// Used to create unique names for artificial VLA size debug info variables.
1333 unsigned VLAExprCounter = 0;
Erich Keanebe65e872018-07-10 21:07:50 +00001334 bool DisableDebugInfo = false;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001335
John McCall9b382dd2011-05-28 21:13:02 +00001336 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1337 /// calling llvm.stacksave for multiple VLAs in the same scope.
Erich Keanebe65e872018-07-10 21:07:50 +00001338 bool DidCallStackSave = false;
John McCall9b382dd2011-05-28 21:13:02 +00001339
Mike Stumpe5311b02009-11-30 20:08:49 +00001340 /// IndirectBranch - The first time an indirect goto is seen we create a block
1341 /// with an indirect branch. Every time we see the address of a label taken,
1342 /// we add the label to the indirect goto. Every subsequent indirect goto is
1343 /// codegen'd as a jump to the IndirectBranch's basic block.
Erich Keanebe65e872018-07-10 21:07:50 +00001344 llvm::IndirectBrInst *IndirectBranch = nullptr;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001345
Mike Stumpfc496822009-02-08 23:14:22 +00001346 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1347 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001348 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001349
Akira Hatanakaccda3d22018-04-27 06:57:00 +00001350 // Keep track of the cleanups for callee-destructed parameters pushed to the
1351 // cleanup stack so that they can be deactivated later.
1352 llvm::DenseMap<const ParmVarDecl *, EHScopeStack::stable_iterator>
1353 CalleeDestructedParamCleanups;
1354
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001355 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1356 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1357 /// parameter.
1358 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1359 SizeArguments;
1360
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001361 /// Track escaped local variables with auto storage. Used during SEH
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001362 /// outlining to produce a call to llvm.localescape.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001363 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1364
Chris Lattnerac248202007-05-30 00:13:02 +00001365 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001366 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001367
Mike Stumpfc496822009-02-08 23:14:22 +00001368 // BreakContinueStack - This keeps track of where break and continue
Bob Wilsonbf854f02014-02-17 19:21:09 +00001369 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001370 struct BreakContinue {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001371 BreakContinue(JumpDest Break, JumpDest Continue)
1372 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001373
John McCallbd309292010-07-06 01:34:17 +00001374 JumpDest BreakBlock;
1375 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001376 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001377 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001378
Alexey Bataev957d8562016-11-17 15:12:05 +00001379 /// Handles cancellation exit points in OpenMP-related constructs.
1380 class OpenMPCancelExitStack {
1381 /// Tracks cancellation exit point and join point for cancel-related exit
1382 /// and normal exit.
1383 struct CancelExit {
1384 CancelExit() = default;
1385 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1386 JumpDest ContBlock)
1387 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
Johannes Doerferteb3e81f2019-11-04 22:00:49 -06001388 OpenMPDirectiveKind Kind = llvm::omp::OMPD_unknown;
Alexey Bataev957d8562016-11-17 15:12:05 +00001389 /// true if the exit block has been emitted already by the special
1390 /// emitExit() call, false if the default codegen is used.
1391 bool HasBeenEmitted = false;
1392 JumpDest ExitBlock;
1393 JumpDest ContBlock;
1394 };
1395
1396 SmallVector<CancelExit, 8> Stack;
1397
1398 public:
1399 OpenMPCancelExitStack() : Stack(1) {}
1400 ~OpenMPCancelExitStack() = default;
1401 /// Fetches the exit block for the current OpenMP construct.
1402 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1403 /// Emits exit block with special codegen procedure specific for the related
1404 /// OpenMP construct + emits code for normal construct cleanup.
1405 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
Alexey Bataevddf3db92018-04-13 17:31:06 +00001406 const llvm::function_ref<void(CodeGenFunction &)> CodeGen) {
Alexey Bataev957d8562016-11-17 15:12:05 +00001407 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1408 assert(CGF.getOMPCancelDestination(Kind).isValid());
1409 assert(CGF.HaveInsertPoint());
1410 assert(!Stack.back().HasBeenEmitted);
1411 auto IP = CGF.Builder.saveAndClearIP();
1412 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1413 CodeGen(CGF);
Erich Keane0026ed22017-07-27 16:28:20 +00001414 CGF.EmitBranch(Stack.back().ContBlock.getBlock());
Alexey Bataev957d8562016-11-17 15:12:05 +00001415 CGF.Builder.restoreIP(IP);
1416 Stack.back().HasBeenEmitted = true;
1417 }
1418 CodeGen(CGF);
1419 }
1420 /// Enter the cancel supporting \a Kind construct.
1421 /// \param Kind OpenMP directive that supports cancel constructs.
1422 /// \param HasCancel true, if the construct has inner cancel directive,
1423 /// false otherwise.
1424 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1425 Stack.push_back({Kind,
1426 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1427 : JumpDest(),
1428 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1429 : JumpDest()});
1430 }
1431 /// Emits default exit point for the cancel construct (if the special one
1432 /// has not be used) + join point for cancel/normal exits.
1433 void exit(CodeGenFunction &CGF) {
1434 if (getExitBlock().isValid()) {
1435 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1436 bool HaveIP = CGF.HaveInsertPoint();
1437 if (!Stack.back().HasBeenEmitted) {
1438 if (HaveIP)
1439 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1440 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1441 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1442 }
1443 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1444 if (!HaveIP) {
1445 CGF.Builder.CreateUnreachable();
1446 CGF.Builder.ClearInsertionPoint();
1447 }
1448 }
1449 Stack.pop_back();
1450 }
1451 };
1452 OpenMPCancelExitStack OMPCancelStack;
1453
Justin Bogneref512b92014-01-06 22:27:43 +00001454 CodeGenPGO PGO;
1455
Justin Bogner65512642015-05-02 05:00:55 +00001456 /// Calculate branch weights appropriate for PGO data
1457 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1458 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1459 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1460 uint64_t LoopCount);
1461
Justin Bogneref512b92014-01-06 22:27:43 +00001462public:
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001463 /// Increment the profiler's counter for the given statement by \p StepV.
1464 /// If \p StepV is null, the default increment is 1.
1465 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
Rong Xu9837ef52016-02-04 18:39:09 +00001466 if (CGM.getCodeGenOpts().hasProfileClangInstr())
Vedant Kumar502bbfa2017-02-25 06:35:45 +00001467 PGO.emitCounterIncrement(Builder, S, StepV);
Justin Bogner66242d62015-04-23 23:06:47 +00001468 PGO.setCurrentStmt(S);
Justin Bogneref512b92014-01-06 22:27:43 +00001469 }
Justin Bogner66242d62015-04-23 23:06:47 +00001470
1471 /// Get the profiler's count for the given statement.
1472 uint64_t getProfileCount(const Stmt *S) {
1473 Optional<uint64_t> Count = PGO.getStmtCount(S);
1474 if (!Count.hasValue())
1475 return 0;
1476 return *Count;
1477 }
1478
1479 /// Set the profiler's current count.
1480 void setCurrentProfileCount(uint64_t Count) {
1481 PGO.setCurrentRegionCount(Count);
1482 }
1483
1484 /// Get the profiler's current count. This is generally the count for the most
1485 /// recently incremented counter.
1486 uint64_t getCurrentProfileCount() {
1487 return PGO.getCurrentRegionCount();
1488 }
1489
Justin Bogneref512b92014-01-06 22:27:43 +00001490private:
1491
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001492 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001493 /// current context is not in a switch.
Erich Keanebe65e872018-07-10 21:07:50 +00001494 llvm::SwitchInst *SwitchInsn = nullptr;
Justin Bogneref512b92014-01-06 22:27:43 +00001495 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
Erich Keanebe65e872018-07-10 21:07:50 +00001496 SmallVector<uint64_t, 16> *SwitchWeights = nullptr;
Devang Patelda5d6bb2007-10-04 23:45:31 +00001497
Mike Stumpfc496822009-02-08 23:14:22 +00001498 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001499 /// statement range in current switch instruction.
Erich Keanebe65e872018-07-10 21:07:50 +00001500 llvm::BasicBlock *CaseRangeBlock = nullptr;
Devang Patel11663122007-10-08 20:57:48 +00001501
John McCallc07a0c72011-02-17 10:25:35 +00001502 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001503 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001504 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1505 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001506
Mike Stumpfc496822009-02-08 23:14:22 +00001507 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001508 // We track this by the size expression rather than the type itself because
1509 // in certain situations, like a const qualifier applied to an VLA typedef,
1510 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001511 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1512 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001513 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001514
John McCallbd309292010-07-06 01:34:17 +00001515 /// A block containing a single 'unreachable' instruction. Created
1516 /// lazily by getUnreachableBlock().
Erich Keanebe65e872018-07-10 21:07:50 +00001517 llvm::BasicBlock *UnreachableBlock = nullptr;
Mike Stumpfc496822009-02-08 23:14:22 +00001518
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001519 /// Counts of the number return expressions in the function.
Erich Keanebe65e872018-07-10 21:07:50 +00001520 unsigned NumReturnExprs = 0;
Adrian Prantl3be10542013-05-02 17:30:20 +00001521
1522 /// Count the number of simple (constant) return expressions in the function.
Erich Keanebe65e872018-07-10 21:07:50 +00001523 unsigned NumSimpleReturnExprs = 0;
Adrian Prantl3be10542013-05-02 17:30:20 +00001524
Adrian Prantl52bf3c42013-05-03 20:11:48 +00001525 /// The last regular (non-return) debug location (breakpoint) in the function.
Adrian Prantle83b1302014-01-07 22:05:52 +00001526 SourceLocation LastStopPoint;
Adrian Prantl3be10542013-05-02 17:30:20 +00001527
Richard Smith852c9db2013-04-20 22:23:05 +00001528public:
Eric Fiselier708afb52019-05-16 21:04:15 +00001529 /// Source location information about the default argument or member
1530 /// initializer expression we're evaluating, if any.
1531 CurrentSourceLocExprScope CurSourceLocExprScope;
1532 using SourceLocExprScopeGuard =
1533 CurrentSourceLocExprScope::SourceLocExprScopeGuard;
1534
Richard Smith852c9db2013-04-20 22:23:05 +00001535 /// A scope within which we are constructing the fields of an object which
1536 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1537 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1538 class FieldConstructionScope {
1539 public:
John McCall7f416cc2015-09-08 08:05:57 +00001540 FieldConstructionScope(CodeGenFunction &CGF, Address This)
Richard Smith852c9db2013-04-20 22:23:05 +00001541 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1542 CGF.CXXDefaultInitExprThis = This;
1543 }
1544 ~FieldConstructionScope() {
1545 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1546 }
1547
1548 private:
1549 CodeGenFunction &CGF;
John McCall7f416cc2015-09-08 08:05:57 +00001550 Address OldCXXDefaultInitExprThis;
Richard Smith852c9db2013-04-20 22:23:05 +00001551 };
1552
1553 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1554 /// is overridden to be the object under construction.
Eric Fiselier708afb52019-05-16 21:04:15 +00001555 class CXXDefaultInitExprScope {
Richard Smith852c9db2013-04-20 22:23:05 +00001556 public:
Eric Fiselier708afb52019-05-16 21:04:15 +00001557 CXXDefaultInitExprScope(CodeGenFunction &CGF, const CXXDefaultInitExpr *E)
1558 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1559 OldCXXThisAlignment(CGF.CXXThisAlignment),
1560 SourceLocScope(E, CGF.CurSourceLocExprScope) {
John McCall7f416cc2015-09-08 08:05:57 +00001561 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1562 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
Richard Smith852c9db2013-04-20 22:23:05 +00001563 }
1564 ~CXXDefaultInitExprScope() {
1565 CGF.CXXThisValue = OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001566 CGF.CXXThisAlignment = OldCXXThisAlignment;
Richard Smith852c9db2013-04-20 22:23:05 +00001567 }
1568
1569 public:
1570 CodeGenFunction &CGF;
1571 llvm::Value *OldCXXThisValue;
John McCall7f416cc2015-09-08 08:05:57 +00001572 CharUnits OldCXXThisAlignment;
Eric Fiselier708afb52019-05-16 21:04:15 +00001573 SourceLocExprScopeGuard SourceLocScope;
1574 };
1575
1576 struct CXXDefaultArgExprScope : SourceLocExprScopeGuard {
1577 CXXDefaultArgExprScope(CodeGenFunction &CGF, const CXXDefaultArgExpr *E)
1578 : SourceLocExprScopeGuard(E, CGF.CurSourceLocExprScope) {}
Richard Smith852c9db2013-04-20 22:23:05 +00001579 };
1580
Richard Smith410306b2016-12-12 02:53:20 +00001581 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1582 /// current loop index is overridden.
1583 class ArrayInitLoopExprScope {
1584 public:
1585 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1586 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1587 CGF.ArrayInitIndex = Index;
1588 }
1589 ~ArrayInitLoopExprScope() {
1590 CGF.ArrayInitIndex = OldArrayInitIndex;
1591 }
1592
1593 private:
1594 CodeGenFunction &CGF;
1595 llvm::Value *OldArrayInitIndex;
1596 };
1597
Richard Smith5179eb72016-06-28 19:03:57 +00001598 class InlinedInheritingConstructorScope {
1599 public:
1600 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1601 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1602 OldCurCodeDecl(CGF.CurCodeDecl),
1603 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1604 OldCXXABIThisValue(CGF.CXXABIThisValue),
1605 OldCXXThisValue(CGF.CXXThisValue),
1606 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1607 OldCXXThisAlignment(CGF.CXXThisAlignment),
1608 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1609 OldCXXInheritedCtorInitExprArgs(
1610 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1611 CGF.CurGD = GD;
1612 CGF.CurFuncDecl = CGF.CurCodeDecl =
1613 cast<CXXConstructorDecl>(GD.getDecl());
1614 CGF.CXXABIThisDecl = nullptr;
1615 CGF.CXXABIThisValue = nullptr;
1616 CGF.CXXThisValue = nullptr;
1617 CGF.CXXABIThisAlignment = CharUnits();
1618 CGF.CXXThisAlignment = CharUnits();
1619 CGF.ReturnValue = Address::invalid();
1620 CGF.FnRetTy = QualType();
1621 CGF.CXXInheritedCtorInitExprArgs.clear();
1622 }
1623 ~InlinedInheritingConstructorScope() {
1624 CGF.CurGD = OldCurGD;
1625 CGF.CurFuncDecl = OldCurFuncDecl;
1626 CGF.CurCodeDecl = OldCurCodeDecl;
1627 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1628 CGF.CXXABIThisValue = OldCXXABIThisValue;
1629 CGF.CXXThisValue = OldCXXThisValue;
1630 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1631 CGF.CXXThisAlignment = OldCXXThisAlignment;
1632 CGF.ReturnValue = OldReturnValue;
1633 CGF.FnRetTy = OldFnRetTy;
1634 CGF.CXXInheritedCtorInitExprArgs =
1635 std::move(OldCXXInheritedCtorInitExprArgs);
1636 }
1637
1638 private:
1639 CodeGenFunction &CGF;
1640 GlobalDecl OldCurGD;
1641 const Decl *OldCurFuncDecl;
1642 const Decl *OldCurCodeDecl;
1643 ImplicitParamDecl *OldCXXABIThisDecl;
1644 llvm::Value *OldCXXABIThisValue;
1645 llvm::Value *OldCXXThisValue;
1646 CharUnits OldCXXABIThisAlignment;
1647 CharUnits OldCXXThisAlignment;
1648 Address OldReturnValue;
1649 QualType OldFnRetTy;
1650 CallArgList OldCXXInheritedCtorInitExprArgs;
1651 };
1652
Richard Smith852c9db2013-04-20 22:23:05 +00001653private:
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001654 /// CXXThisDecl - When generating code for a C++ member function,
1655 /// this will hold the implicit 'this' declaration.
Erich Keanebe65e872018-07-10 21:07:50 +00001656 ImplicitParamDecl *CXXABIThisDecl = nullptr;
1657 llvm::Value *CXXABIThisValue = nullptr;
1658 llvm::Value *CXXThisValue = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +00001659 CharUnits CXXABIThisAlignment;
1660 CharUnits CXXThisAlignment;
Mike Stump11289f42009-09-09 15:08:12 +00001661
Richard Smith852c9db2013-04-20 22:23:05 +00001662 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1663 /// this expression.
John McCall7f416cc2015-09-08 08:05:57 +00001664 Address CXXDefaultInitExprThis = Address::invalid();
Richard Smith852c9db2013-04-20 22:23:05 +00001665
Richard Smith410306b2016-12-12 02:53:20 +00001666 /// The current array initialization index when evaluating an
1667 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1668 llvm::Value *ArrayInitIndex = nullptr;
1669
Richard Smith5179eb72016-06-28 19:03:57 +00001670 /// The values of function arguments to use when evaluating
1671 /// CXXInheritedCtorInitExprs within this context.
1672 CallArgList CXXInheritedCtorInitExprArgs;
1673
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001674 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1675 /// destructor, this will hold the implicit argument (e.g. VTT).
Erich Keanebe65e872018-07-10 21:07:50 +00001676 ImplicitParamDecl *CXXStructorImplicitParamDecl = nullptr;
1677 llvm::Value *CXXStructorImplicitParamValue = nullptr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001678
John McCallce1de612011-01-26 04:00:11 +00001679 /// OutermostConditional - Points to the outermost active
1680 /// conditional control. This is used so that we know if a
1681 /// temporary should be destroyed conditionally.
Erich Keanebe65e872018-07-10 21:07:50 +00001682 ConditionalEvaluation *OutermostConditional = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001683
Nadav Rotem1da30942013-03-23 06:43:35 +00001684 /// The current lexical scope.
Erich Keanebe65e872018-07-10 21:07:50 +00001685 LexicalScope *CurLexicalScope = nullptr;
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001686
Adrian Prantldc237b52013-05-16 00:41:26 +00001687 /// The current source location that should be used for exception
1688 /// handling code.
1689 SourceLocation CurEHLocation;
1690
John McCall7f416cc2015-09-08 08:05:57 +00001691 /// BlockByrefInfos - For each __block variable, contains
1692 /// information about the layout of the variable.
1693 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001694
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001695 /// Used by -fsanitize=nullability-return to determine whether the return
1696 /// value can be checked.
1697 llvm::Value *RetValNullabilityPrecondition = nullptr;
1698
1699 /// Check if -fsanitize=nullability-return instrumentation is required for
1700 /// this function.
1701 bool requiresReturnValueNullabilityCheck() const {
1702 return RetValNullabilityPrecondition;
1703 }
1704
Vedant Kumarc34d3432017-06-23 21:32:38 +00001705 /// Used to store precise source locations for return statements by the
1706 /// runtime return value checks.
1707 Address ReturnLocation = Address::invalid();
1708
1709 /// Check if the return value of this function requires sanitization.
Reid Kleckner98031782019-12-09 16:11:56 -08001710 bool requiresReturnValueCheck() const;
Vedant Kumarc34d3432017-06-23 21:32:38 +00001711
Erich Keanebe65e872018-07-10 21:07:50 +00001712 llvm::BasicBlock *TerminateLandingPad = nullptr;
1713 llvm::BasicBlock *TerminateHandler = nullptr;
1714 llvm::BasicBlock *TrapBB = nullptr;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001715
Reid Kleckner06f19a02018-01-02 21:34:16 +00001716 /// Terminate funclets keyed by parent funclet pad.
1717 llvm::MapVector<llvm::Value *, llvm::BasicBlock *> TerminateFunclets;
1718
Craig Topper74c10e32018-07-09 19:00:16 +00001719 /// Largest vector width used in ths function. Will be used to create a
1720 /// function attribute.
Erich Keanebe65e872018-07-10 21:07:50 +00001721 unsigned LargestVectorWidth = 0;
Craig Topper74c10e32018-07-09 19:00:16 +00001722
Vitaly Buka1c943322016-10-26 01:59:57 +00001723 /// True if we need emit the life-time markers.
1724 const bool ShouldEmitLifetimeMarkers;
1725
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00001726 /// Add OpenCL kernel arg metadata and the kernel attribute metadata to
Xiuli Panbe6da4b2017-05-04 07:31:20 +00001727 /// the function metadata.
Gor Nishanov04491bd2017-11-11 17:00:43 +00001728 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001729 llvm::Function *Fn);
1730
Chris Lattnerbed31442007-05-28 01:07:47 +00001731public:
Diogo Sampaio21477032020-01-21 15:31:33 +00001732 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001733 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001734
John McCall8ed55a52010-09-02 09:58:18 +00001735 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001736 ASTContext &getContext() const { return CGM.getContext(); }
Gor Nishanov04491bd2017-11-11 17:00:43 +00001737 CGDebugInfo *getDebugInfo() {
1738 if (DisableDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00001739 return nullptr;
Gor Nishanov04491bd2017-11-11 17:00:43 +00001740 return DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001741 }
1742 void disableDebugInfo() { DisableDebugInfo = true; }
1743 void enableDebugInfo() { DisableDebugInfo = false; }
1744
John McCall31168b02011-06-15 23:02:42 +00001745 bool shouldUseFusedARCCalls() {
1746 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1747 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001748
David Blaikiebbafb8a2012-03-11 07:00:24 +00001749 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001750
Bill Wendlingf0724e82011-09-19 20:31:14 +00001751 /// Returns a pointer to the function's exception object and selector slot,
1752 /// which is assigned in every landing pad.
John McCall7f416cc2015-09-08 08:05:57 +00001753 Address getExceptionSlot();
1754 Address getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001755
Bill Wendling79a70e42011-09-15 18:57:19 +00001756 /// Returns the contents of the function's exception object and selector
1757 /// slots.
1758 llvm::Value *getExceptionFromSlot();
1759 llvm::Value *getSelectorFromSlot();
1760
John McCall7f416cc2015-09-08 08:05:57 +00001761 Address getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001762
John McCallbd309292010-07-06 01:34:17 +00001763 llvm::BasicBlock *getUnreachableBlock() {
1764 if (!UnreachableBlock) {
1765 UnreachableBlock = createBasicBlock("unreachable");
1766 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1767 }
1768 return UnreachableBlock;
1769 }
1770
1771 llvm::BasicBlock *getInvokeDest() {
Craig Topper8a13c412014-05-21 05:09:00 +00001772 if (!EHStack.requiresLandingPad()) return nullptr;
John McCallbd309292010-07-06 01:34:17 +00001773 return getInvokeDestImpl();
1774 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001775
David Majnemer25eb1652016-03-01 19:42:53 +00001776 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
Reid Klecknere7b3f7c2015-02-11 00:00:21 +00001777
John McCallc8e01702013-04-16 22:48:15 +00001778 const TargetInfo &getTarget() const { return Target; }
John McCallad7c5c12011-02-08 08:22:06 +00001779 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Yaxun Liucbf647c2017-07-08 13:24:52 +00001780 const TargetCodeGenInfo &getTargetHooks() const {
1781 return CGM.getTargetCodeGenInfo();
1782 }
Owen Andersonae86c192009-07-13 04:10:07 +00001783
Daniel Dunbar12347492009-02-23 17:26:39 +00001784 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001785 // Cleanups
1786 //===--------------------------------------------------------------------===//
1787
John McCall7f416cc2015-09-08 08:05:57 +00001788 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
John McCall82fe67b2011-07-09 01:37:26 +00001789
John McCall178360e2011-07-11 08:38:19 +00001790 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001791 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001792 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001793 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001794 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001795 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1796 llvm::Value *arrayEnd,
1797 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001798 CharUnits elementAlignment,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001799 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001800
John McCall4bd0fb12011-07-12 16:41:08 +00001801 void pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001802 Address addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001803 void pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001804 Address addr, QualType type);
1805 void pushDestroy(CleanupKind kind, Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001806 Destroyer *destroyer, bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001807 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
Richard Smith736a9472013-06-12 20:42:33 +00001808 QualType type, Destroyer *destroyer,
1809 bool useEHCleanupForArray);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001810 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1811 llvm::Value *CompletePtr,
1812 QualType ElementType);
John McCall7f416cc2015-09-08 08:05:57 +00001813 void pushStackRestore(CleanupKind kind, Address SPMem);
1814 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001815 bool useEHCleanupForArray);
John McCall7f416cc2015-09-08 08:05:57 +00001816 llvm::Function *generateDestroyHelper(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001817 Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +00001818 bool useEHCleanupForArray,
1819 const VarDecl *VD);
John McCall82fe67b2011-07-09 01:37:26 +00001820 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001821 QualType elementType, CharUnits elementAlign,
1822 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001823 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001824
Peter Collingbourne1425b452012-01-26 03:33:36 +00001825 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001826
John McCall82fe67b2011-07-09 01:37:26 +00001827 /// Determines whether an EH cleanup is required to destroy a type
1828 /// with the given destruction kind.
1829 bool needsEHCleanup(QualType::DestructionKind kind) {
1830 switch (kind) {
1831 case QualType::DK_none:
1832 return false;
1833 case QualType::DK_cxx_destructor:
1834 case QualType::DK_objc_weak_lifetime:
Akira Hatanaka7275da02018-02-28 07:15:55 +00001835 case QualType::DK_nontrivial_c_struct:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001836 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001837 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001838 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001839 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1840 }
1841 llvm_unreachable("bad destruction kind");
1842 }
1843
John McCall4bd0fb12011-07-12 16:41:08 +00001844 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1845 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1846 }
1847
John McCall82fe67b2011-07-09 01:37:26 +00001848 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001849 // Objective-C
1850 //===--------------------------------------------------------------------===//
1851
Chris Lattner4bd55962008-03-30 23:03:07 +00001852 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001853
David Blaikief1425802015-01-14 00:04:42 +00001854 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001855
Mike Stumpfc496822009-02-08 23:14:22 +00001856 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001857 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1858 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001859 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001860 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001861 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001862 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001863
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001864 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1865 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001866
Mike Stumpfc496822009-02-08 23:14:22 +00001867 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1868 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001869 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1870 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001871 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001872 const ObjCPropertyImplDecl *propImpl,
1873 llvm::Constant *AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001874
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001875 //===--------------------------------------------------------------------===//
1876 // Block Bits
1877 //===--------------------------------------------------------------------===//
1878
Yaxun Liuc2a87a02017-10-14 12:23:50 +00001879 /// Emit block literal.
1880 /// \return an LLVM value which is a pointer to a struct which contains
1881 /// information about the block, including the block invoke function, the
1882 /// captured variables, etc.
Yaxun Liufa13d012018-02-15 16:39:19 +00001883 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001884 static void destroyBlockInfos(CGBlockInfo *info);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001885
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001886 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001887 const CGBlockInfo &Info,
Eli Friedman2495ab02012-02-25 02:48:22 +00001888 const DeclMapTy &ldm,
Akira Hatanakaba0367a2017-09-22 21:32:06 +00001889 bool IsLambdaConversionToBlock,
1890 bool BuildGlobalBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001891
Akira Hatanaka9978da32018-08-10 15:09:24 +00001892 /// Check if \p T is a C++ class that has a destructor that can throw.
1893 static bool cxxDestructorCanThrow(QualType T);
1894
John McCallad7c5c12011-02-08 08:22:06 +00001895 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1896 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001897 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1898 const ObjCPropertyImplDecl *PID);
1899 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1900 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001901 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001902
Akira Hatanaka9978da32018-08-10 15:09:24 +00001903 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags,
1904 bool CanThrow);
John McCallad7c5c12011-02-08 08:22:06 +00001905
John McCall73064872011-03-31 01:59:53 +00001906 class AutoVarEmission;
1907
1908 void emitByrefStructureInit(const AutoVarEmission &emission);
Akira Hatanakacb6a9332018-07-26 16:51:21 +00001909
1910 /// Enter a cleanup to destroy a __block variable. Note that this
1911 /// cleanup should be a no-op if the variable hasn't left the stack
1912 /// yet; if a cleanup is required for the variable itself, that needs
1913 /// to be done externally.
1914 ///
1915 /// \param Kind Cleanup kind.
1916 ///
1917 /// \param Addr When \p LoadBlockVarAddr is false, the address of the __block
1918 /// structure that will be passed to _Block_object_dispose. When
1919 /// \p LoadBlockVarAddr is true, the address of the field of the block
1920 /// structure that holds the address of the __block structure.
1921 ///
1922 /// \param Flags The flag that will be passed to _Block_object_dispose.
1923 ///
1924 /// \param LoadBlockVarAddr Indicates whether we need to emit a load from
1925 /// \p Addr to get the address of the __block structure.
1926 void enterByrefCleanup(CleanupKind Kind, Address Addr, BlockFieldFlags Flags,
Akira Hatanaka9978da32018-08-10 15:09:24 +00001927 bool LoadBlockVarAddr, bool CanThrow);
John McCall73064872011-03-31 01:59:53 +00001928
John McCall7f416cc2015-09-08 08:05:57 +00001929 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1930 llvm::Value *ptr);
1931
1932 Address LoadBlockStruct();
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001933 Address GetAddrOfBlockDecl(const VarDecl *var);
John McCall7f416cc2015-09-08 08:05:57 +00001934
1935 /// BuildBlockByrefAddress - Computes the location of the
1936 /// data in a variable which is declared as __block.
1937 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1938 bool followForward = true);
1939 Address emitBlockByrefAddress(Address baseAddr,
1940 const BlockByrefInfo &info,
1941 bool followForward,
1942 const llvm::Twine &name);
1943
1944 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001945
Richard Smith5179eb72016-06-28 19:03:57 +00001946 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1947
John McCalla738c252011-03-09 04:27:21 +00001948 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1949 const CGFunctionInfo &FnInfo);
Akira Hatanaka9978da32018-08-10 15:09:24 +00001950
1951 /// Annotate the function with an attribute that disables TSan checking at
1952 /// runtime.
1953 void markAsIgnoreThreadCheckingAtRuntime(llvm::Function *Fn);
1954
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001955 /// Emit code for the start of a function.
Adrian Prantl42d71b92014-04-10 23:21:53 +00001956 /// \param Loc The location to be associated with the function.
1957 /// \param StartLoc The location of the function body.
John McCalldec348f72013-05-03 07:33:41 +00001958 void StartFunction(GlobalDecl GD,
1959 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001960 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001961 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001962 const FunctionArgList &Args,
Adrian Prantl22e66b42014-04-11 01:13:04 +00001963 SourceLocation Loc = SourceLocation(),
1964 SourceLocation StartLoc = SourceLocation());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001965
Vedant Kumar7f809b22017-02-24 01:15:19 +00001966 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1967
John McCallb81884d2010-02-19 09:25:03 +00001968 void EmitConstructorBody(FunctionArgList &Args);
1969 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001970 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
Reid Kleckner43071082018-12-13 01:33:20 +00001971 void EmitFunctionBody(const Stmt *Body);
Justin Bogner66242d62015-04-23 23:06:47 +00001972 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
John McCall89b12b32010-02-18 03:17:58 +00001973
Faisal Vali571df122013-09-29 08:45:24 +00001974 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
Eli Friedman2495ab02012-02-25 02:48:22 +00001975 CallArgList &CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00001976 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001977 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001978 void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
Richard Smith04440062019-01-17 22:05:50 +00001979 void EmitLambdaVLACapture(const VariableArrayType *VAT, LValue LV) {
1980 EmitStoreThroughLValue(RValue::get(VLASizeMap[VAT->getSizeExpr()]), LV);
1981 }
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001982 void EmitAsanPrologueOrEpilogue(bool Prologue);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001983
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001984 /// Emit the unified return block, trying to avoid its emission when
David Blaikiea0a1a872015-01-18 02:48:07 +00001985 /// possible.
1986 /// \return The debug location of the user written return statement if the
1987 /// return block is is avoided.
David Blaikie66e41972015-01-14 07:38:27 +00001988 llvm::DebugLoc EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001989
Mike Stumpfc496822009-02-08 23:14:22 +00001990 /// FinishFunction - Complete IR generation of the current function. It is
1991 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001992 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001993
Nico Weber1bebad12015-02-11 22:33:32 +00001994 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
Reid Kleckner399d96e2018-04-02 20:20:33 +00001995 const CGFunctionInfo &FnInfo, bool IsUnprototyped);
Hans Wennborg88497d62013-11-15 17:24:45 +00001996
James Y Knight76f78742019-02-05 19:17:50 +00001997 void EmitCallAndReturnForThunk(llvm::FunctionCallee Callee,
1998 const ThunkInfo *Thunk, bool IsUnprototyped);
Hans Wennborg88497d62013-11-15 17:24:45 +00001999
John McCall7f416cc2015-09-08 08:05:57 +00002000 void FinishThunk();
2001
Reid Klecknerab2090d2014-07-26 01:34:32 +00002002 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
Erich Keanede6480a32018-11-13 15:48:08 +00002003 void EmitMustTailThunk(GlobalDecl GD, llvm::Value *AdjustedThisPtr,
James Y Knight76f78742019-02-05 19:17:50 +00002004 llvm::FunctionCallee Callee);
Reid Klecknerab2090d2014-07-26 01:34:32 +00002005
Rafael Espindolad6e66942015-07-13 06:07:58 +00002006 /// Generate a thunk for the given method.
2007 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
Reid Kleckner399d96e2018-04-02 20:20:33 +00002008 GlobalDecl GD, const ThunkInfo &Thunk,
2009 bool IsUnprototyped);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002010
Peter Collingbournee286b0e2015-06-30 22:08:44 +00002011 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
2012 const CGFunctionInfo &FnInfo,
2013 GlobalDecl GD, const ThunkInfo &Thunk);
Eli Friedman49a94b12011-05-06 17:27:27 +00002014
Douglas Gregor94f9a482010-05-05 05:51:00 +00002015 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
2016 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00002017
Richard Smith30e304e2016-12-14 00:03:17 +00002018 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
Eli Friedman5f1a04f2012-02-14 02:31:03 +00002019
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00002020 /// Struct with all information about dynamic [sub]class needed to set vptr.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002021 struct VPtr {
2022 BaseSubobject Base;
2023 const CXXRecordDecl *NearestVBase;
2024 CharUnits OffsetFromNearestVBase;
2025 const CXXRecordDecl *VTableClass;
2026 };
2027
2028 /// Initialize the vtable pointer of the given subobject.
2029 void InitializeVTablePointer(const VPtr &vptr);
2030
2031 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
Anders Carlssone87fae92010-03-28 19:40:00 +00002032
2033 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002034 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
2035
2036 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
2037 CharUnits OffsetFromNearestVBase,
2038 bool BaseIsNonVirtualPrimaryBase,
2039 const CXXRecordDecl *VTableClass,
2040 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00002041
Anders Carlssond5895932010-03-28 21:07:49 +00002042 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00002043
Dan Gohman8fc50c22010-10-26 18:44:08 +00002044 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
2045 /// to by This.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00002046 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
2047 const CXXRecordDecl *VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00002048
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002049 enum CFITypeCheckKind {
2050 CFITCK_VCall,
2051 CFITCK_NVCall,
2052 CFITCK_DerivedCast,
2053 CFITCK_UnrelatedCast,
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00002054 CFITCK_ICall,
Peter Collingbournee44acad2018-06-26 02:15:47 +00002055 CFITCK_NVMFCall,
2056 CFITCK_VMFCall,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002057 };
2058
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002059 /// Derived is the presumed address of an object of type T after a
Peter Collingbourned2926c92015-03-14 02:42:25 +00002060 /// cast. If T is a polymorphic class type, emit a check that the virtual
2061 /// table for Derived belongs to a class derived from T.
2062 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002063 bool MayBeNull, CFITypeCheckKind TCK,
2064 SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00002065
Peter Collingbournea4ccff32015-02-20 20:30:56 +00002066 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
2067 /// If vptr CFI is enabled, emit a check that VTable is valid.
Peter Collingbournefb532b92016-02-24 20:46:36 +00002068 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002069 CFITypeCheckKind TCK, SourceLocation Loc);
Benjamin Kramer7463ed72013-08-25 22:46:27 +00002070
Peter Collingbourned2926c92015-03-14 02:42:25 +00002071 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002072 /// RD using llvm.type.test.
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002073 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
2074 CFITypeCheckKind TCK, SourceLocation Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00002075
Peter Collingbournefb532b92016-02-24 20:46:36 +00002076 /// If whole-program virtual table optimization is enabled, emit an assumption
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002077 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
2078 /// enabled, emit a check that VTable is a member of RD's type identifier.
2079 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
2080 llvm::Value *VTable, SourceLocation Loc);
Peter Collingbournefb532b92016-02-24 20:46:36 +00002081
Peter Collingbourne0ca03632016-06-25 00:24:06 +00002082 /// Returns whether we should perform a type checked load when loading a
2083 /// virtual function for virtual calls to members of RD. This is generally
2084 /// true when both vcall CFI and whole-program-vtables are enabled.
2085 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
2086
2087 /// Emit a type checked load from the given vtable.
2088 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
2089 uint64_t VTableByteOffset);
2090
John McCallf99a6312010-07-21 05:30:47 +00002091 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
2092 /// given phase of destruction for a destructor. The end result
2093 /// should call destructors on members and base classes in reverse
2094 /// order of their construction.
2095 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00002096
Chris Lattner3c77a352010-06-22 00:03:40 +00002097 /// ShouldInstrumentFunction - Return true if the current function should be
2098 /// instrumented with __cyg_profile_func_* calls
2099 bool ShouldInstrumentFunction();
2100
Aaron Ballman7d2aecb2016-07-13 22:32:15 +00002101 /// ShouldXRayInstrument - Return true if the current function should be
2102 /// instrumented with XRay nop sleds.
2103 bool ShouldXRayInstrumentFunction() const;
2104
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +00002105 /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
2106 /// XRay custom event handling calls.
2107 bool AlwaysEmitXRayCustomEvents() const;
2108
Keith Wyssf437e352018-04-17 21:32:43 +00002109 /// AlwaysEmitXRayTypedEvents - Return true if clang must unconditionally emit
2110 /// XRay typed event handling calls.
2111 bool AlwaysEmitXRayTypedEvents() const;
2112
Vedant Kumarbb5d4852017-09-13 00:04:35 +00002113 /// Encode an address into a form suitable for use in a function prologue.
2114 llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
2115 llvm::Constant *Addr);
2116
2117 /// Decode an address used in a function prologue, encoded by \c
2118 /// EncodeAddrForUseInPrologue.
2119 llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
2120 llvm::Value *EncodedAddr);
2121
Mike Stumpfc496822009-02-08 23:14:22 +00002122 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
2123 /// arguments for the given function. This is also responsible for naming the
2124 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00002125 void EmitFunctionProlog(const CGFunctionInfo &FI,
2126 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00002127 const FunctionArgList &Args);
2128
Mike Stumpfc496822009-02-08 23:14:22 +00002129 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
2130 /// given temporary.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002131 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
2132 SourceLocation EndLoc);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002133
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002134 /// Emit a test that checks if the return value \p RV is nonnull.
Vedant Kumarc34d3432017-06-23 21:32:38 +00002135 void EmitReturnValueCheck(llvm::Value *RV);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002136
Mike Stump1d849212009-12-07 23:38:24 +00002137 /// EmitStartEHSpec - Emit the start of the exception spec.
2138 void EmitStartEHSpec(const Decl *D);
2139
2140 /// EmitEndEHSpec - Emit the end of the exception spec.
2141 void EmitEndEHSpec(const Decl *D);
2142
John McCallbd309292010-07-06 01:34:17 +00002143 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
2144 llvm::BasicBlock *getTerminateLandingPad();
2145
Reid Kleckner06f19a02018-01-02 21:34:16 +00002146 /// getTerminateLandingPad - Return a cleanup funclet that just calls
2147 /// terminate.
2148 llvm::BasicBlock *getTerminateFunclet();
2149
John McCallbd309292010-07-06 01:34:17 +00002150 /// getTerminateHandler - Return a handler (not a landing pad, just
2151 /// a catch handler) that just calls terminate. This is used when
2152 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00002153 llvm::BasicBlock *getTerminateHandler();
2154
Chris Lattnera5f58b02011-07-09 17:41:47 +00002155 llvm::Type *ConvertTypeForMem(QualType T);
2156 llvm::Type *ConvertType(QualType T);
2157 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00002158 return ConvertType(getContext().getTypeDeclType(T));
2159 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00002160
Mike Stumpfc496822009-02-08 23:14:22 +00002161 /// LoadObjCSelf - Load the value of self. This function is only valid while
2162 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00002163 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00002164
2165 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002166 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00002167
Krasimir Georgiev46dfb7a2017-09-08 13:44:51 +00002168 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
John McCall47fb9502013-03-07 21:37:08 +00002169 static TypeEvaluationKind getEvaluationKind(QualType T);
2170
2171 static bool hasScalarEvaluationKind(QualType T) {
2172 return getEvaluationKind(T) == TEK_Scalar;
2173 }
2174
2175 static bool hasAggregateEvaluationKind(QualType T) {
2176 return getEvaluationKind(T) == TEK_Aggregate;
2177 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00002178
2179 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00002180 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
Craig Topper8a13c412014-05-21 05:09:00 +00002181 llvm::Function *parent = nullptr,
2182 llvm::BasicBlock *before = nullptr) {
John McCallad7c5c12011-02-08 08:22:06 +00002183 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar75283ff2008-11-11 02:29:29 +00002184 }
Mike Stumpfc496822009-02-08 23:14:22 +00002185
Chris Lattnerac248202007-05-30 00:13:02 +00002186 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
2187 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002188 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00002189
Mike Stumpe5311b02009-11-30 20:08:49 +00002190 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
2191 /// another basic block, simplify it. This assumes that no other code could
2192 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00002193 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
2194
Mike Stumpfc496822009-02-08 23:14:22 +00002195 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
2196 /// adding a fall-through branch from the current insert block if
2197 /// necessary. It is legal to call this function even if there is no current
2198 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00002199 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002200 /// IsFinished - If true, indicates that the caller has finished emitting
2201 /// branches to the given block and does not expect to emit code into it. This
2202 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00002203 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00002204
John McCall8e4c74b2011-08-11 02:22:43 +00002205 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
2206 /// near its uses, and leave the insertion point in it.
2207 void EmitBlockAfterUses(llvm::BasicBlock *BB);
2208
Mike Stumpfc496822009-02-08 23:14:22 +00002209 /// EmitBranch - Emit a branch to the specified basic block from the current
2210 /// insert block, taking care to avoid creation of branches from dummy
2211 /// blocks. It is legal to call this function even if there is no current
2212 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00002213 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002214 /// This function clears the current insertion point. The caller should follow
2215 /// calls to this function with calls to Emit*Block prior to generation new
2216 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00002217 void EmitBranch(llvm::BasicBlock *Block);
2218
Mike Stumpfc496822009-02-08 23:14:22 +00002219 /// HaveInsertPoint - True if an insertion point is defined. If not, this
2220 /// indicates that the current code being emitted is unreachable.
2221 bool HaveInsertPoint() const {
Craig Topper8a13c412014-05-21 05:09:00 +00002222 return Builder.GetInsertBlock() != nullptr;
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002223 }
2224
Mike Stumpfc496822009-02-08 23:14:22 +00002225 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
2226 /// emitted IR has a place to go. Note that by definition, if this function
2227 /// creates a block then that block is unreachable; callers may do better to
2228 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002229 void EnsureInsertPoint() {
2230 if (!HaveInsertPoint())
2231 EmitBlock(createBasicBlock());
2232 }
Mike Stumpfc496822009-02-08 23:14:22 +00002233
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00002234 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00002235 /// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00002236 void ErrorUnsupported(const Stmt *S, const char *Type);
Chris Lattner84915fa2007-06-02 04:16:21 +00002237
Chris Lattnere9a64532007-06-22 21:44:33 +00002238 //===--------------------------------------------------------------------===//
2239 // Helpers
2240 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002241
John McCall7f416cc2015-09-08 08:05:57 +00002242 LValue MakeAddrLValue(Address Addr, QualType T,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002243 AlignmentSource Source = AlignmentSource::Type) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00002244 return LValue::MakeAddr(Addr, T, getContext(), LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002245 CGM.getTBAAAccessInfo(T));
2246 }
2247
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00002248 LValue MakeAddrLValue(Address Addr, QualType T, LValueBaseInfo BaseInfo,
2249 TBAAAccessInfo TBAAInfo) {
2250 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
Daniel Dunbar93b00a92010-08-21 02:53:44 +00002251 }
John McCall4e8ca4f2012-07-02 23:58:38 +00002252
John McCall7f416cc2015-09-08 08:05:57 +00002253 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002254 AlignmentSource Source = AlignmentSource::Type) {
2255 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00002256 LValueBaseInfo(Source), CGM.getTBAAAccessInfo(T));
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00002257 }
2258
2259 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00002260 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00002261 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
Ivan A. Kosarevf5f20462017-10-12 11:29:46 +00002262 BaseInfo, TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +00002263 }
2264
2265 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
David Majnemer99281062014-09-18 22:05:54 +00002266 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
John McCall7f416cc2015-09-08 08:05:57 +00002267 CharUnits getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00002268 LValueBaseInfo *BaseInfo = nullptr,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +00002269 TBAAAccessInfo *TBAAInfo = nullptr,
John McCall7f416cc2015-09-08 08:05:57 +00002270 bool forPointeeType = false);
2271 CharUnits getNaturalPointeeTypeAlignment(QualType T,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00002272 LValueBaseInfo *BaseInfo = nullptr,
2273 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00002274
Ivan A. Kosarev9f9d1572017-10-30 11:49:31 +00002275 Address EmitLoadOfReference(LValue RefLVal,
2276 LValueBaseInfo *PointeeBaseInfo = nullptr,
2277 TBAAAccessInfo *PointeeTBAAInfo = nullptr);
2278 LValue EmitLoadOfReferenceLValue(LValue RefLVal);
2279 LValue EmitLoadOfReferenceLValue(Address RefAddr, QualType RefTy,
2280 AlignmentSource Source =
2281 AlignmentSource::Type) {
2282 LValue RefLVal = MakeAddrLValue(RefAddr, RefTy, LValueBaseInfo(Source),
2283 CGM.getTBAAAccessInfo(RefTy));
2284 return EmitLoadOfReferenceLValue(RefLVal);
2285 }
Daniel Dunbar93b00a92010-08-21 02:53:44 +00002286
Alexey Bataev31300ed2016-02-04 11:27:03 +00002287 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
Ivan A. Kosarev90295642017-10-13 16:47:22 +00002288 LValueBaseInfo *BaseInfo = nullptr,
2289 TBAAAccessInfo *TBAAInfo = nullptr);
Alexey Bataev31300ed2016-02-04 11:27:03 +00002290 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
2291
Yaxun Liu84744c12017-06-19 17:03:41 +00002292 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
2293 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
2294 /// insertion point of the builder. The caller is responsible for setting an
2295 /// appropriate alignment on
Daniel Dunbara7566f12010-02-09 02:48:28 +00002296 /// the alloca.
Yaxun Liu84744c12017-06-19 17:03:41 +00002297 ///
2298 /// \p ArraySize is the number of array elements to be allocated if it
2299 /// is not nullptr.
2300 ///
2301 /// LangAS::Default is the address space of pointers to local variables and
2302 /// temporaries, as exposed in the source language. In certain
2303 /// configurations, this is not the same as the alloca address space, and a
2304 /// cast is needed to lift the pointer from the alloca AS into
2305 /// LangAS::Default. This can happen when the target uses a restricted
2306 /// address space for the stack but the source language requires
2307 /// LangAS::Default to be a generic address space. The latter condition is
2308 /// common for most programming languages; OpenCL is an exception in that
2309 /// LangAS::Default is the private address space, which naturally maps
2310 /// to the stack.
2311 ///
2312 /// Because the address of a temporary is often exposed to the program in
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002313 /// various ways, this function will perform the cast. The original alloca
2314 /// instruction is returned through \p Alloca if it is not nullptr.
2315 ///
2316 /// The cast is not performaed in CreateTempAllocaWithoutCast. This is
Yaxun Liu84744c12017-06-19 17:03:41 +00002317 /// more efficient if the caller knows that the address will not be exposed.
2318 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
2319 llvm::Value *ArraySize = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00002320 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
Yaxun Liu84744c12017-06-19 17:03:41 +00002321 const Twine &Name = "tmp",
2322 llvm::Value *ArraySize = nullptr,
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002323 Address *Alloca = nullptr);
2324 Address CreateTempAllocaWithoutCast(llvm::Type *Ty, CharUnits align,
2325 const Twine &Name = "tmp",
2326 llvm::Value *ArraySize = nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00002327
John McCall7f416cc2015-09-08 08:05:57 +00002328 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
2329 /// default ABI alignment of the given LLVM type.
2330 ///
2331 /// IMPORTANT NOTE: This is *not* generally the right alignment for
2332 /// any given AST type that happens to have been lowered to the
2333 /// given IR type. This should only ever be used for function-local,
2334 /// IR-driven manipulations like saving and restoring a value. Do
2335 /// not hand this address off to arbitrary IRGen routines, and especially
2336 /// do not pass it as an argument to a function that might expect a
2337 /// properly ABI-aligned value.
2338 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
2339 const Twine &Name = "tmp");
2340
2341 /// InitTempAlloca - Provide an initial value for the given alloca which
2342 /// will be observable at all locations in the function.
2343 ///
2344 /// The address should be something that was returned from one of
2345 /// the CreateTempAlloca or CreateMemTemp routines, and the
2346 /// initializer must be valid in the entry block (i.e. it must
2347 /// either be a constant or an argument value).
2348 void InitTempAlloca(Address Alloca, llvm::Value *Value);
John McCall2e6567a2010-04-22 01:10:34 +00002349
Daniel Dunbard0049182010-02-16 19:44:13 +00002350 /// CreateIRTemp - Create a temporary IR object of the given type, with
2351 /// appropriate alignment. This routine should only be used when an temporary
2352 /// value needs to be stored into an alloca (for example, to avoid explicit
2353 /// PHI construction), but the type is the IR type, not the type appropriate
2354 /// for storing in memory.
John McCall7f416cc2015-09-08 08:05:57 +00002355 ///
2356 /// That is, this is exactly equivalent to CreateMemTemp, but calling
2357 /// ConvertType instead of ConvertTypeForMem.
2358 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00002359
Daniel Dunbara7566f12010-02-09 02:48:28 +00002360 /// CreateMemTemp - Create a temporary memory object of the given type, with
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002361 /// appropriate alignmen and cast it to the default address space. Returns
2362 /// the original alloca instruction by \p Alloca if it is not nullptr.
Yaxun Liu84744c12017-06-19 17:03:41 +00002363 Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002364 Address *Alloca = nullptr);
Yaxun Liu84744c12017-06-19 17:03:41 +00002365 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00002366 Address *Alloca = nullptr);
2367
2368 /// CreateMemTemp - Create a temporary memory object of the given type, with
2369 /// appropriate alignmen without casting it to the default address space.
2370 Address CreateMemTempWithoutCast(QualType T, const Twine &Name = "tmp");
2371 Address CreateMemTempWithoutCast(QualType T, CharUnits Align,
2372 const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00002373
John McCall7a626f62010-09-15 10:14:12 +00002374 /// CreateAggTemp - Create a temporary memory object for the given
2375 /// aggregate type.
Michael Liaoa0678912020-02-09 13:09:19 -05002376 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp",
2377 Address *Alloca = nullptr) {
2378 return AggValueSlot::forAddr(CreateMemTemp(T, Name, Alloca),
Eli Friedmanc1d85b92011-12-03 00:54:26 +00002379 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00002380 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00002381 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00002382 AggValueSlot::IsNotAliased,
2383 AggValueSlot::DoesNotOverlap);
John McCall7a626f62010-09-15 10:14:12 +00002384 }
2385
John McCallad7c5c12011-02-08 08:22:06 +00002386 /// Emit a cast to void* in the appropriate address space.
2387 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2388
Chris Lattner8394d792007-06-05 20:53:16 +00002389 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2390 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00002391 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00002392
John McCalla2342eb2010-12-05 02:00:02 +00002393 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2394 void EmitIgnoredExpr(const Expr *E);
2395
Chris Lattner4647a212007-08-31 22:49:20 +00002396 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2397 /// any type. The result is returned as an RValue struct. If this is an
2398 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2399 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00002400 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00002401 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00002402 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00002403 AggValueSlot aggSlot = AggValueSlot::ignored(),
2404 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00002405
Mike Stumpfc496822009-02-08 23:14:22 +00002406 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2407 // or the value of the expression, depending on how va_list is defined.
John McCall7f416cc2015-09-08 08:05:57 +00002408 Address EmitVAListRef(const Expr *E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002409
Charles Davisc7d5c942015-09-17 20:55:33 +00002410 /// Emit a "reference" to a __builtin_ms_va_list; this is
2411 /// always the value of the expression, because a __builtin_ms_va_list is a
2412 /// pointer to a char.
2413 Address EmitMSVAListRef(const Expr *E);
2414
Gor Nishanov5eb58582017-03-26 02:18:05 +00002415 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
Mike Stumpfc496822009-02-08 23:14:22 +00002416 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00002417 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00002418
John McCall91ca10f2011-03-08 09:11:50 +00002419 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00002420 /// arbitrary expression into the given memory location.
John McCall7f416cc2015-09-08 08:05:57 +00002421 void EmitAnyExprToMem(const Expr *E, Address Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002422 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00002423
John McCall7f416cc2015-09-08 08:05:57 +00002424 void EmitAnyExprToExn(const Expr *E, Address Addr);
David Majnemer7c237072015-03-05 00:46:22 +00002425
John McCall91ca10f2011-03-08 09:11:50 +00002426 /// EmitExprAsInit - Emits the code necessary to initialize a
2427 /// location in memory with the given initializer.
David Blaikie73ca5692014-12-09 00:32:22 +00002428 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002429 bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00002430
Fariborz Jahanian78652202013-01-25 23:57:05 +00002431 /// hasVolatileMember - returns true if aggregate type has a volatile
2432 /// member.
2433 bool hasVolatileMember(QualType T) {
2434 if (const RecordType *RT = T->getAs<RecordType>()) {
2435 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2436 return RD->hasVolatileMember();
2437 }
2438 return false;
2439 }
Richard Smithe78fac52018-04-05 20:52:58 +00002440
2441 /// Determine whether a return value slot may overlap some other object.
Richard Smith8cca3a52019-06-20 20:56:20 +00002442 AggValueSlot::Overlap_t getOverlapForReturnValue() {
Richard Smithe78fac52018-04-05 20:52:58 +00002443 // FIXME: Assuming no overlap here breaks guaranteed copy elision for base
2444 // class subobjects. These cases may need to be revisited depending on the
2445 // resolution of the relevant core issue.
2446 return AggValueSlot::DoesNotOverlap;
Benjamin Kramer1ca66912012-09-30 12:43:37 +00002447 }
2448
Richard Smithe78fac52018-04-05 20:52:58 +00002449 /// Determine whether a field initialization may overlap some other object.
Richard Smith8cca3a52019-06-20 20:56:20 +00002450 AggValueSlot::Overlap_t getOverlapForFieldInit(const FieldDecl *FD);
Richard Smithe78fac52018-04-05 20:52:58 +00002451
2452 /// Determine whether a base class initialization may overlap some other
2453 /// object.
Richard Smith8cca3a52019-06-20 20:56:20 +00002454 AggValueSlot::Overlap_t getOverlapForBaseInit(const CXXRecordDecl *RD,
2455 const CXXRecordDecl *BaseRD,
2456 bool IsVirtual);
Richard Smithe78fac52018-04-05 20:52:58 +00002457
2458 /// Emit an aggregate assignment.
2459 void EmitAggregateAssign(LValue Dest, LValue Src, QualType EltTy) {
2460 bool IsVolatile = hasVolatileMember(EltTy);
2461 EmitAggregateCopy(Dest, Src, EltTy, AggValueSlot::MayOverlap, IsVolatile);
2462 }
2463
2464 void EmitAggregateCopyCtor(LValue Dest, LValue Src,
2465 AggValueSlot::Overlap_t MayOverlap) {
2466 EmitAggregateCopy(Dest, Src, Src.getType(), MayOverlap);
David Majnemerfd1e7392015-02-03 23:04:06 +00002467 }
2468
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00002469 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00002470 ///
Richard Smithe78fac52018-04-05 20:52:58 +00002471 /// \param isVolatile \c true iff either the source or the destination is
2472 /// volatile.
2473 /// \param MayOverlap Whether the tail padding of the destination might be
2474 /// occupied by some other object. More efficient code can often be
2475 /// generated if not.
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00002476 void EmitAggregateCopy(LValue Dest, LValue Src, QualType EltTy,
Richard Smithe78fac52018-04-05 20:52:58 +00002477 AggValueSlot::Overlap_t MayOverlap,
2478 bool isVolatile = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00002479
Anders Carlsson9396a892008-09-11 09:15:33 +00002480 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall7f416cc2015-09-08 08:05:57 +00002481 Address GetAddrOfLocalVar(const VarDecl *VD) {
2482 auto it = LocalDeclMap.find(VD);
2483 assert(it != LocalDeclMap.end() &&
2484 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2485 return it->second;
John McCall5d865c322010-08-31 07:33:07 +00002486 }
Mike Stumpfc496822009-02-08 23:14:22 +00002487
Akira Hatanaka797afe32018-03-20 01:47:58 +00002488 /// Given an opaque value expression, return its LValue mapping if it exists,
2489 /// otherwise create one.
2490 LValue getOrCreateOpaqueLValueMapping(const OpaqueValueExpr *e);
John McCallc07a0c72011-02-17 10:25:35 +00002491
Akira Hatanaka797afe32018-03-20 01:47:58 +00002492 /// Given an opaque value expression, return its RValue mapping if it exists,
2493 /// otherwise create one.
2494 RValue getOrCreateOpaqueRValueMapping(const OpaqueValueExpr *e);
John McCall1bf58462011-02-16 08:02:54 +00002495
Richard Smith410306b2016-12-12 02:53:20 +00002496 /// Get the index of the current ArrayInitLoopExpr, if any.
2497 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2498
Dan Gohman75d69da2008-05-22 00:50:06 +00002499 /// getAccessedFieldNo - Given an encoded value and a result number, return
2500 /// the input field number being accessed.
2501 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2502
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002503 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00002504 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002505
Vedant Kumarffd7c882017-04-14 22:03:34 +00002506 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2507 static bool IsWrappedCXXThis(const Expr *E);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00002508
Anders Carlssonc0964b62010-05-22 17:35:42 +00002509 /// EmitNullInitialization - Generate code to set a value of the given type to
2510 /// null, If the type contains data member pointers, they will be initialized
2511 /// to -1 in accordance with the Itanium C++ ABI.
John McCall7f416cc2015-09-08 08:05:57 +00002512 void EmitNullInitialization(Address DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002513
Charles Davisc7d5c942015-09-17 20:55:33 +00002514 /// Emits a call to an LLVM variable-argument intrinsic, either
2515 /// \c llvm.va_start or \c llvm.va_end.
2516 /// \param ArgValue A reference to the \c va_list as emitted by either
2517 /// \c EmitVAListRef or \c EmitMSVAListRef.
2518 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2519 /// calls \c llvm.va_end.
2520 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2521
2522 /// Generate code to get an argument from the passed in pointer
2523 /// and update it accordingly.
2524 /// \param VE The \c VAArgExpr for which to generate code.
2525 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2526 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2527 /// \returns A pointer to the argument.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00002528 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00002529 // instruction in LLVM instead once it works well enough.
Charles Davisc7d5c942015-09-17 20:55:33 +00002530 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
Anders Carlssone388a5b2008-12-20 20:27:15 +00002531
John McCall82fe67b2011-07-09 01:37:26 +00002532 /// emitArrayLength - Compute the length of an array, even if it's a
2533 /// VLA, and drill down to the base element type.
2534 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2535 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00002536 Address &addr);
John McCall82fe67b2011-07-09 01:37:26 +00002537
John McCall23c29fe2011-06-24 21:55:10 +00002538 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2539 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002540 ///
2541 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00002542 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00002543
Sander de Smalen891af03a2018-02-03 13:55:59 +00002544 struct VlaSizePair {
2545 llvm::Value *NumElts;
2546 QualType Type;
2547
2548 VlaSizePair(llvm::Value *NE, QualType T) : NumElts(NE), Type(T) {}
2549 };
2550
2551 /// Return the number of elements for a single dimension
2552 /// for the given array type.
2553 VlaSizePair getVLAElements1D(const VariableArrayType *vla);
2554 VlaSizePair getVLAElements1D(QualType vla);
2555
2556 /// Returns an LLVM value that corresponds to the size,
John McCall23c29fe2011-06-24 21:55:10 +00002557 /// in non-variably-sized elements, of a variable length array type,
2558 /// plus that largest non-variably-sized element type. Assumes that
2559 /// the type has already been emitted with EmitVariablyModifiedType.
Sander de Smalen891af03a2018-02-03 13:55:59 +00002560 VlaSizePair getVLASize(const VariableArrayType *vla);
2561 VlaSizePair getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00002562
Anders Carlssona5d077d2009-04-14 16:58:56 +00002563 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2564 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00002565 llvm::Value *LoadCXXThis() {
2566 assert(CXXThisValue && "no 'this' value for this function");
2567 return CXXThisValue;
2568 }
John McCall7f416cc2015-09-08 08:05:57 +00002569 Address LoadCXXThisAddress();
Mike Stump11289f42009-09-09 15:08:12 +00002570
Anders Carlssone36a6b32010-01-02 01:01:18 +00002571 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2572 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002573 // FIXME: Every place that calls LoadCXXVTT is something
2574 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00002575 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002576 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2577 return CXXStructorImplicitParamValue;
2578 }
2579
John McCall6ce74722010-02-16 04:15:37 +00002580 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002581 /// complete class to the given direct base.
John McCall7f416cc2015-09-08 08:05:57 +00002582 Address
2583 GetAddressOfDirectBaseInCompleteClass(Address Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00002584 const CXXRecordDecl *Derived,
2585 const CXXRecordDecl *Base,
2586 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00002587
John McCall7f416cc2015-09-08 08:05:57 +00002588 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2589
Mike Stumpe5311b02009-11-30 20:08:49 +00002590 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2591 /// load of 'this' and returns address of the base class.
John McCall7f416cc2015-09-08 08:05:57 +00002592 Address GetAddressOfBaseClass(Address Value,
2593 const CXXRecordDecl *Derived,
2594 CastExpr::path_const_iterator PathBegin,
2595 CastExpr::path_const_iterator PathEnd,
2596 bool NullCheckValue, SourceLocation Loc);
Anders Carlssond829a022010-04-24 21:06:20 +00002597
John McCall7f416cc2015-09-08 08:05:57 +00002598 Address GetAddressOfDerivedClass(Address Value,
2599 const CXXRecordDecl *Derived,
2600 CastExpr::path_const_iterator PathBegin,
2601 CastExpr::path_const_iterator PathEnd,
2602 bool NullCheckValue);
Anders Carlsson8c793172009-11-23 17:57:54 +00002603
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00002604 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2605 /// base constructor/destructor with virtual bases.
2606 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2607 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2608 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2609 bool Delegating);
2610
John McCallf8ff7b92010-02-23 00:48:20 +00002611 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2612 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002613 const FunctionArgList &Args,
2614 SourceLocation Loc);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002615 // It's important not to confuse this and the previous function. Delegating
2616 // constructors are the C++0x feature. The constructor delegate optimization
2617 // is used to reduce duplication in the base and complete consturctors where
2618 // they are substantially the same.
2619 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2620 const FunctionArgList &Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002621
Richard Smith5179eb72016-06-28 19:03:57 +00002622 /// Emit a call to an inheriting constructor (that is, one that invokes a
2623 /// constructor inherited from a base class) by inlining its definition. This
2624 /// is necessary if the ABI does not support forwarding the arguments to the
2625 /// base class constructor (because they're variadic or similar).
2626 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2627 CXXCtorType CtorType,
2628 bool ForVirtualBase,
2629 bool Delegating,
2630 CallArgList &Args);
2631
2632 /// Emit a call to a constructor inherited from a base class, passing the
2633 /// current constructor's arguments along unmodified (without even making
2634 /// a copy).
2635 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2636 bool ForVirtualBase, Address This,
2637 bool InheritedFromVBase,
2638 const CXXInheritedCtorInitExpr *E);
2639
Anders Carlssone11f9ce2010-05-02 23:20:53 +00002640 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00002641 bool ForVirtualBase, bool Delegating,
Anastasia Stulova094c7262019-04-04 10:48:36 +00002642 AggValueSlot ThisAVS, const CXXConstructExpr *E);
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002643
Richard Smith5179eb72016-06-28 19:03:57 +00002644 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2645 bool ForVirtualBase, bool Delegating,
Richard Smithe78fac52018-04-05 20:52:58 +00002646 Address This, CallArgList &Args,
Igor Kudrineff8f9d2018-06-25 05:48:04 +00002647 AggValueSlot::Overlap_t Overlap,
Anastasia Stulova094c7262019-04-04 10:48:36 +00002648 SourceLocation Loc, bool NewPointerIsChecked);
Richard Smith5179eb72016-06-28 19:03:57 +00002649
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002650 /// Emit assumption load for all bases. Requires to be be called only on
2651 /// most-derived class and not under construction of the object.
2652 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2653
2654 /// Emit assumption that vptr load == global vtable.
2655 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2656
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002657 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002658 Address This, Address Src,
2659 const CXXConstructExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002660
Fariborz Jahanian431c8832009-08-19 20:55:16 +00002661 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Alexey Bataeve7545b32016-04-29 09:39:50 +00002662 const ArrayType *ArrayTy,
John McCall7f416cc2015-09-08 08:05:57 +00002663 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002664 const CXXConstructExpr *E,
Serge Pavlov37605182018-07-28 15:33:03 +00002665 bool NewPointerIsChecked,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002666 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002667
Anders Carlssond49844b2009-09-23 02:45:36 +00002668 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2669 llvm::Value *NumElements,
John McCall7f416cc2015-09-08 08:05:57 +00002670 Address ArrayPtr,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002671 const CXXConstructExpr *E,
Serge Pavlov37605182018-07-28 15:33:03 +00002672 bool NewPointerIsChecked,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002673 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00002674
John McCall82fe67b2011-07-09 01:37:26 +00002675 static Destroyer destroyCXXObject;
2676
Anders Carlsson0a637412009-05-29 21:03:38 +00002677 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Marco Antognini88559632019-07-22 09:39:13 +00002678 bool ForVirtualBase, bool Delegating, Address This,
2679 QualType ThisTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002680
John McCall99210dc2011-09-15 06:49:18 +00002681 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002682 llvm::Type *ElementTy, Address NewPtr,
David Blaikiefb901c7a2015-04-04 15:12:29 +00002683 llvm::Value *NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00002684 llvm::Value *AllocSizeWithoutCookie);
Mike Stump11289f42009-09-09 15:08:12 +00002685
Peter Collingbourne702b2842011-11-27 22:09:22 +00002686 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
John McCall7f416cc2015-09-08 08:05:57 +00002687 Address Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00002688
David Majnemerdc012fa2015-04-22 21:38:15 +00002689 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2690 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2691
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00002692 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00002693 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00002694
Eli Friedman24f55432009-11-18 00:57:03 +00002695 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
Richard Smithb2f0f052016-10-10 18:54:32 +00002696 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2697 CharUnits CookieSize = CharUnits());
Eli Friedman24f55432009-11-18 00:57:03 +00002698
Richard Smith760520b2014-06-03 23:27:44 +00002699 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
Eric Fiselierfa752f22018-03-21 19:19:48 +00002700 const CallExpr *TheCallExpr, bool IsDelete);
Richard Smith760520b2014-06-03 23:27:44 +00002701
John McCall7f416cc2015-09-08 08:05:57 +00002702 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2703 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2704 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002705
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002706 /// Situations in which we might emit a check for the suitability of a
Vedant Kumarc54597b2020-02-28 14:09:14 -08002707 /// pointer or glvalue. Needs to be kept in sync with ubsan_handlers.cpp in
2708 /// compiler-rt.
Richard Smith4d1458e2012-09-08 02:08:36 +00002709 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00002710 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002711 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00002712 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00002713 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00002714 /// Checking the bound value in a reference binding. Must be suitably sized
2715 /// and aligned, but is not required to refer to an object (until the
2716 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00002717 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00002718 /// Checking the object expression in a non-static data member access. Must
2719 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00002720 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00002721 /// Checking the 'this' pointer for a call to a non-static member function.
2722 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00002723 TCK_MemberCall,
2724 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00002725 TCK_ConstructorCall,
2726 /// Checking the operand of a static_cast to a derived pointer type. Must be
2727 /// null or an object within its lifetime.
2728 TCK_DowncastPointer,
2729 /// Checking the operand of a static_cast to a derived reference type. Must
2730 /// be an object within its lifetime.
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002731 TCK_DowncastReference,
2732 /// Checking the operand of a cast to a base object. Must be suitably sized
2733 /// and aligned.
2734 TCK_Upcast,
2735 /// Checking the operand of a cast to a virtual base object. Must be an
2736 /// object within its lifetime.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002737 TCK_UpcastToVirtualBase,
2738 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002739 TCK_NonnullAssign,
2740 /// Checking the operand of a dynamic_cast or a typeid expression. Must be
2741 /// null or an object within its lifetime.
2742 TCK_DynamicOperation
Richard Smith69d0d262012-08-24 00:54:33 +00002743 };
2744
Vedant Kumar24792e32017-10-03 01:27:25 +00002745 /// Determine whether the pointer type check \p TCK permits null pointers.
2746 static bool isNullPointerAllowed(TypeCheckKind TCK);
2747
2748 /// Determine whether the pointer type check \p TCK requires a vptr check.
2749 static bool isVptrCheckRequired(TypeCheckKind TCK, QualType Ty);
2750
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002751 /// Whether any type-checking sanitizers are enabled. If \c false,
Alexey Samsonovac4afe42014-07-07 23:59:57 +00002752 /// calls to EmitTypeCheck can be skipped.
2753 bool sanitizePerformTypeCheck() const;
2754
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002755 /// Emit a check that \p V is the address of storage of the
Richard Smithcfa79b22019-01-23 03:37:29 +00002756 /// appropriate size and alignment for an object of type \p Type
2757 /// (or if ArraySize is provided, for an array of that bound).
Richard Smithe30752c2012-10-09 19:52:38 +00002758 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +00002759 QualType Type, CharUnits Alignment = CharUnits::Zero(),
Richard Smithcfa79b22019-01-23 03:37:29 +00002760 SanitizerSet SkippedChecks = SanitizerSet(),
2761 llvm::Value *ArraySize = nullptr);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002762
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002763 /// Emit a check that \p Base points into an array object, which
Richard Smith539e4a72013-02-23 02:53:19 +00002764 /// we can access at index \p Index. \p Accessed should be \c false if we
2765 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2766 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2767 QualType IndexType, bool Accessed);
2768
Chris Lattner116ce8f2010-01-09 21:40:03 +00002769 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2770 bool isInc, bool isPre);
2771 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2772 bool isInc, bool isPre);
Hal Finkelbcc06082014-09-07 22:58:14 +00002773
Amara Emerson652795d2016-11-10 14:44:30 +00002774 /// Converts Location to a DebugLoc, if debug information is enabled.
2775 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2776
Yonghong Song47548142019-07-16 17:24:33 +00002777 /// Get the record field index as represented in debug info.
2778 unsigned getDebugInfoFIndex(const RecordDecl *Rec, unsigned FieldIndex);
2779
Amara Emerson652795d2016-11-10 14:44:30 +00002780
Chris Lattner8394d792007-06-05 20:53:16 +00002781 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00002782 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00002783 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002784
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002785 /// EmitDecl - Emit a declaration.
2786 ///
2787 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00002788 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002789
John McCall1c9c3fd2010-10-15 04:57:14 +00002790 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002791 ///
2792 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00002793 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002794
David Blaikie73ca5692014-12-09 00:32:22 +00002795 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
David Blaikie66e41972015-01-14 07:38:27 +00002796 bool capturedByInit);
John McCall31168b02011-06-15 23:02:42 +00002797
John McCallbd309292010-07-06 01:34:17 +00002798 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2799 llvm::Value *Address);
2800
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002801 /// Determine whether the given initializer is trivial in the sense
Alexey Bataev4a5bb772014-10-08 14:01:46 +00002802 /// that it requires no code to be generated.
2803 bool isTrivialInitializer(const Expr *Init);
2804
John McCall1c9c3fd2010-10-15 04:57:14 +00002805 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002806 ///
2807 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00002808 void EmitAutoVarDecl(const VarDecl &D);
2809
2810 class AutoVarEmission {
2811 friend class CodeGenFunction;
2812
John McCall9e2e22f2011-02-22 07:16:58 +00002813 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00002814
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002815 /// The address of the alloca for languages with explicit address space
2816 /// (e.g. OpenCL) or alloca casted to generic pointer for address space
2817 /// agnostic languages (e.g. C++). Invalid if the variable was emitted
John McCallc533cb72011-02-22 06:44:22 +00002818 /// as a global constant.
John McCall7f416cc2015-09-08 08:05:57 +00002819 Address Addr;
John McCallc533cb72011-02-22 06:44:22 +00002820
2821 llvm::Value *NRVOFlag;
2822
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002823 /// True if the variable is a __block variable that is captured by an
2824 /// escaping block.
2825 bool IsEscapingByRef;
John McCallc533cb72011-02-22 06:44:22 +00002826
2827 /// True if the variable is of aggregate type and has a constant
2828 /// initializer.
2829 bool IsConstantAggregate;
2830
Nadav Rotem1da30942013-03-23 06:43:35 +00002831 /// Non-null if we should use lifetime annotations.
2832 llvm::Value *SizeForLifetimeMarkers;
2833
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002834 /// Address with original alloca instruction. Invalid if the variable was
2835 /// emitted as a global constant.
2836 Address AllocaAddr;
2837
John McCall9e2e22f2011-02-22 07:16:58 +00002838 struct Invalid {};
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002839 AutoVarEmission(Invalid)
2840 : Variable(nullptr), Addr(Address::invalid()),
2841 AllocaAddr(Address::invalid()) {}
John McCall9e2e22f2011-02-22 07:16:58 +00002842
John McCallc533cb72011-02-22 06:44:22 +00002843 AutoVarEmission(const VarDecl &variable)
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002844 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002845 IsEscapingByRef(false), IsConstantAggregate(false),
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002846 SizeForLifetimeMarkers(nullptr), AllocaAddr(Address::invalid()) {}
John McCallc533cb72011-02-22 06:44:22 +00002847
John McCall7f416cc2015-09-08 08:05:57 +00002848 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
John McCallc533cb72011-02-22 06:44:22 +00002849
2850 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002851 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2852
Craig Topper8a13c412014-05-21 05:09:00 +00002853 bool useLifetimeMarkers() const {
2854 return SizeForLifetimeMarkers != nullptr;
2855 }
Nadav Rotem1da30942013-03-23 06:43:35 +00002856 llvm::Value *getSizeForLifetimeMarkers() const {
2857 assert(useLifetimeMarkers());
2858 return SizeForLifetimeMarkers;
2859 }
2860
2861 /// Returns the raw, allocated address, which is not necessarily
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002862 /// the address of the object itself. It is casted to default
2863 /// address space for address space agnostic languages.
John McCall7f416cc2015-09-08 08:05:57 +00002864 Address getAllocatedAddress() const {
2865 return Addr;
Nadav Rotem1da30942013-03-23 06:43:35 +00002866 }
2867
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00002868 /// Returns the address for the original alloca instruction.
2869 Address getOriginalAllocatedAddress() const { return AllocaAddr; }
2870
John McCallc533cb72011-02-22 06:44:22 +00002871 /// Returns the address of the object within this declaration.
2872 /// Note that this does not chase the forwarding pointer for
2873 /// __block decls.
John McCall7f416cc2015-09-08 08:05:57 +00002874 Address getObjectAddress(CodeGenFunction &CGF) const {
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002875 if (!IsEscapingByRef) return Addr;
John McCallc533cb72011-02-22 06:44:22 +00002876
John McCall7f416cc2015-09-08 08:05:57 +00002877 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
John McCallc533cb72011-02-22 06:44:22 +00002878 }
2879 };
2880 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2881 void EmitAutoVarInit(const AutoVarEmission &emission);
Gor Nishanov04491bd2017-11-11 17:00:43 +00002882 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002883 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2884 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002885
Sander de Smalen891af03a2018-02-03 13:55:59 +00002886 /// Emits the alloca and debug information for the size expressions for each
2887 /// dimension of an array. It registers the association of its (1-dimensional)
2888 /// QualTypes and size expression's debug node, so that CGDebugInfo can
2889 /// reference this node when creating the DISubrange object to describe the
2890 /// array types.
2891 void EmitAndRegisterVariableArrayDimensions(CGDebugInfo *DI,
2892 const VarDecl &D,
2893 bool EmitDebugInfo);
2894
John McCall1c9c3fd2010-10-15 04:57:14 +00002895 void EmitStaticVarDecl(const VarDecl &D,
2896 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002897
John McCall7f416cc2015-09-08 08:05:57 +00002898 class ParamValue {
2899 llvm::Value *Value;
2900 unsigned Alignment;
2901 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2902 public:
2903 static ParamValue forDirect(llvm::Value *value) {
2904 return ParamValue(value, 0);
2905 }
2906 static ParamValue forIndirect(Address addr) {
2907 assert(!addr.getAlignment().isZero());
2908 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2909 }
2910
2911 bool isIndirect() const { return Alignment != 0; }
2912 llvm::Value *getAnyValue() const { return Value; }
Gor Nishanov04491bd2017-11-11 17:00:43 +00002913
John McCall7f416cc2015-09-08 08:05:57 +00002914 llvm::Value *getDirectValue() const {
2915 assert(!isIndirect());
2916 return Value;
2917 }
2918
2919 Address getIndirectAddress() const {
2920 assert(isIndirect());
2921 return Address(Value, CharUnits::fromQuantity(Alignment));
2922 }
2923 };
2924
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002925 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
John McCall7f416cc2015-09-08 08:05:57 +00002926 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002927
John McCallc07a0c72011-02-17 10:25:35 +00002928 /// protectFromPeepholes - Protect a value that we're intending to
2929 /// store to the side, but which will probably be used later, from
2930 /// aggressive peepholing optimizations that might delete it.
2931 ///
2932 /// Pass the result to unprotectFromPeepholes to declare that
2933 /// protection is no longer required.
2934 ///
2935 /// There's no particular reason why this shouldn't apply to
2936 /// l-values, it's just that no existing peepholes work on pointers.
2937 PeepholeProtection protectFromPeepholes(RValue rvalue);
2938 void unprotectFromPeepholes(PeepholeProtection protection);
2939
Fangrui Song1d49eb02020-02-13 16:36:27 -08002940 void emitAlignmentAssumptionCheck(llvm::Value *Ptr, QualType Ty,
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002941 SourceLocation Loc,
2942 SourceLocation AssumptionLoc,
2943 llvm::Value *Alignment,
2944 llvm::Value *OffsetValue,
2945 llvm::Value *TheCheck,
2946 llvm::Instruction *Assumption);
2947
Fangrui Song1d49eb02020-02-13 16:36:27 -08002948 void emitAlignmentAssumption(llvm::Value *PtrValue, QualType Ty,
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002949 SourceLocation Loc, SourceLocation AssumptionLoc,
2950 llvm::Value *Alignment,
2951 llvm::Value *OffsetValue = nullptr);
2952
Fangrui Song1d49eb02020-02-13 16:36:27 -08002953 void emitAlignmentAssumption(llvm::Value *PtrValue, const Expr *E,
2954 SourceLocation AssumptionLoc,
2955 llvm::Value *Alignment,
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002956 llvm::Value *OffsetValue = nullptr);
Erich Keane623efd82017-03-30 21:48:55 +00002957
Chris Lattner84915fa2007-06-02 04:16:21 +00002958 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002959 // Statement Emission
2960 //===--------------------------------------------------------------------===//
2961
Mike Stumpfc496822009-02-08 23:14:22 +00002962 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002963 void EmitStopPoint(const Stmt *S);
2964
Mike Stumpfc496822009-02-08 23:14:22 +00002965 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2966 /// this function even if there is no current insertion point.
2967 ///
2968 /// This function may clear the current insertion point; callers should use
2969 /// EnsureInsertPoint if they wish to subsequently generate code without first
2970 /// calling EmitBlock, EmitBranch, or EmitStmt.
Karl-Johan Karlsson33e205a2017-09-06 08:47:18 +00002971 void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002972
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002973 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002974 /// necessarily require an insertion point or debug information; typically
2975 /// because the statement amounts to a jump or a container of other
2976 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002977 ///
2978 /// \return True if the statement was handled.
2979 bool EmitSimpleStmt(const Stmt *S);
2980
John McCall7f416cc2015-09-08 08:05:57 +00002981 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2982 AggValueSlot AVS = AggValueSlot::ignored());
2983 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2984 bool GetLast = false,
2985 AggValueSlot AVS =
Eli Friedman4871a462013-06-10 22:04:49 +00002986 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002987
Mike Stumpfc496822009-02-08 23:14:22 +00002988 /// EmitLabel - Emit the block for the given label. It is legal to call this
2989 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002990 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002991
Chris Lattnerac248202007-05-30 00:13:02 +00002992 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002993 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002994 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002995 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002996 void EmitIfStmt(const IfStmt &S);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002997
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00002998 void EmitWhileStmt(const WhileStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00002999 ArrayRef<const Attr *> Attrs = None);
3000 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00003001 void EmitForStmt(const ForStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00003002 ArrayRef<const Attr *> Attrs = None);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00003003 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00003004 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00003005 void EmitBreakStmt(const BreakStmt &S);
3006 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00003007 void EmitSwitchStmt(const SwitchStmt &S);
3008 void EmitDefaultStmt(const DefaultStmt &S);
3009 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00003010 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00003011 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00003012
Anders Carlsson2e744e82008-08-30 19:51:14 +00003013 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00003014 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
3015 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00003016 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00003017 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00003018
Gor Nishanov8df64e92016-10-27 16:28:31 +00003019 void EmitCoroutineBody(const CoroutineBodyStmt &S);
Gor Nishanov90be1212017-03-06 21:12:54 +00003020 void EmitCoreturnStmt(const CoreturnStmt &S);
Gor Nishanov5eb58582017-03-26 02:18:05 +00003021 RValue EmitCoawaitExpr(const CoawaitExpr &E,
3022 AggValueSlot aggSlot = AggValueSlot::ignored(),
3023 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00003024 LValue EmitCoawaitLValue(const CoawaitExpr *E);
Gor Nishanov5eb58582017-03-26 02:18:05 +00003025 RValue EmitCoyieldExpr(const CoyieldExpr &E,
3026 AggValueSlot aggSlot = AggValueSlot::ignored(),
3027 bool ignoreResult = false);
Eric Fiseliercddaf872017-06-15 19:43:36 +00003028 LValue EmitCoyieldLValue(const CoyieldExpr *E);
Gor Nishanov97e3b6d2016-10-03 22:44:48 +00003029 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
3030
John McCallb609d3f2010-07-07 06:56:46 +00003031 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
3032 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00003033
Anders Carlsson52d78a52009-09-27 18:58:34 +00003034 void EmitCXXTryStmt(const CXXTryStmt &S);
Reid Kleckner543a16c2013-09-16 21:46:30 +00003035 void EmitSEHTryStmt(const SEHTryStmt &S);
Nico Weber9b982072014-07-07 00:12:30 +00003036 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00003037 void EnterSEHTryStmt(const SEHTryStmt &S);
3038 void ExitSEHTryStmt(const SEHTryStmt &S);
3039
David Chisnall93ce0182018-08-10 12:53:13 +00003040 void pushSEHCleanup(CleanupKind kind,
3041 llvm::Function *FinallyFunc);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00003042 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00003043 const Stmt *OutlinedStmt);
Reid Kleckner1d59f992015-01-22 01:36:17 +00003044
3045 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
3046 const SEHExceptStmt &Except);
3047
Reid Klecknerebaf28d2015-04-14 20:59:00 +00003048 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
3049 const SEHFinallyStmt &Finally);
3050
Reid Kleckner9fe7f232015-07-07 00:36:30 +00003051 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
3052 llvm::Value *ParentFP,
3053 llvm::Value *EntryEBP);
Reid Kleckner1d59f992015-01-22 01:36:17 +00003054 llvm::Value *EmitSEHExceptionCode();
3055 llvm::Value *EmitSEHExceptionInfo();
Reid Kleckneraca01db2015-02-04 22:37:07 +00003056 llvm::Value *EmitSEHAbnormalTermination();
Reid Kleckner1d59f992015-01-22 01:36:17 +00003057
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00003058 /// Emit simple code for OpenMP directives in Simd-only mode.
3059 void EmitSimpleOMPExecutableDirective(const OMPExecutableDirective &D);
3060
Reid Kleckner31a1bb02015-04-08 22:23:48 +00003061 /// Scan the outlined statement for captures from the parent function. For
3062 /// each capture, mark the capture as escaped and emit a call to
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00003063 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00003064 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00003065 bool IsFilter);
3066
3067 /// Recovers the address of a local in a parent function. ParentVar is the
3068 /// address of the variable used in the immediate parent function. It can
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00003069 /// either be an alloca or a call to llvm.localrecover if there are nested
Reid Kleckner9fe7f232015-07-07 00:36:30 +00003070 /// outlined functions. ParentFP is the frame pointer of the outermost parent
3071 /// frame.
John McCall7f416cc2015-09-08 08:05:57 +00003072 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
3073 Address ParentVar,
3074 llvm::Value *ParentFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00003075
Aaron Ballmanb06b15a2014-06-06 12:40:24 +00003076 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
Craig Topper3cb91b22014-08-27 06:28:16 +00003077 ArrayRef<const Attr *> Attrs = None);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003078
Alexey Bataev2139ed62017-11-16 18:20:21 +00003079 /// Controls insertion of cancellation exit blocks in worksharing constructs.
3080 class OMPCancelStackRAII {
3081 CodeGenFunction &CGF;
3082
3083 public:
3084 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
3085 bool HasCancel)
3086 : CGF(CGF) {
3087 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
3088 }
3089 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
3090 };
3091
Alexey Bataev1189bd02016-01-26 12:20:39 +00003092 /// Returns calculated size of the specified type.
3093 llvm::Value *getTypeSize(QualType Ty);
Alexey Bataev330de032014-10-29 12:21:55 +00003094 LValue InitCapturedStruct(const CapturedStmt &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00003095 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
Alexey Bataevaca7fcf2014-06-30 02:55:54 +00003096 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
John McCall7f416cc2015-09-08 08:05:57 +00003097 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
Alexey Bataevc33ba8c2020-01-17 14:05:40 -05003098 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S,
3099 SourceLocation Loc);
Alexey Bataev2377fe92015-09-10 08:12:02 +00003100 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
Samuel Antao4af1b7b2015-12-02 17:44:43 +00003101 SmallVectorImpl<llvm::Value *> &CapturedVars);
Alexey Bataev8524d152016-01-21 12:35:58 +00003102 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
3103 SourceLocation Loc);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003104 /// Perform element by element copying of arrays with type \a
Alexey Bataev420d45b2015-04-14 05:11:24 +00003105 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
3106 /// generated by \a CopyGen.
3107 ///
3108 /// \param DestAddr Address of the destination array.
3109 /// \param SrcAddr Address of the source array.
3110 /// \param OriginalType Type of destination and source arrays.
3111 /// \param CopyGen Copying procedure that copies value of single array element
3112 /// to another single array element.
3113 void EmitOMPAggregateAssign(
John McCall7f416cc2015-09-08 08:05:57 +00003114 Address DestAddr, Address SrcAddr, QualType OriginalType,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003115 const llvm::function_ref<void(Address, Address)> CopyGen);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003116 /// Emit proper copying of data from one variable to another.
Alexey Bataev420d45b2015-04-14 05:11:24 +00003117 ///
3118 /// \param OriginalType Original type of the copied variables.
3119 /// \param DestAddr Destination address.
3120 /// \param SrcAddr Source address.
3121 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
3122 /// type of the base array element).
3123 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
3124 /// the base array element).
3125 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
3126 /// DestVD.
John McCall7f416cc2015-09-08 08:05:57 +00003127 void EmitOMPCopy(QualType OriginalType,
3128 Address DestAddr, Address SrcAddr,
Alexey Bataev420d45b2015-04-14 05:11:24 +00003129 const VarDecl *DestVD, const VarDecl *SrcVD,
3130 const Expr *Copy);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003131 /// Emit atomic update code for constructs: \a X = \a X \a BO \a E or
Alexey Bataev794ba0d2015-04-10 10:43:45 +00003132 /// \a X = \a E \a BO \a E.
3133 ///
3134 /// \param X Value to be updated.
3135 /// \param E Update value.
3136 /// \param BO Binary operation for update operation.
3137 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
3138 /// expression, false otherwise.
3139 /// \param AO Atomic ordering of the generated atomic instructions.
3140 /// \param CommonGen Code generator for complex expressions that cannot be
3141 /// expressed through atomicrmw instruction.
Alexey Bataev5e018f92015-04-23 06:35:10 +00003142 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
3143 /// generated, <false, RValue::get(nullptr)> otherwise.
3144 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
Alexey Bataev794ba0d2015-04-10 10:43:45 +00003145 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
3146 llvm::AtomicOrdering AO, SourceLocation Loc,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003147 const llvm::function_ref<RValue(RValue)> CommonGen);
Alexey Bataev69c62a92015-04-15 04:52:20 +00003148 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
Alexey Bataev435ad7b2014-10-10 09:48:26 +00003149 OMPPrivateScope &PrivateScope);
Alexey Bataev03b340a2014-10-21 03:16:40 +00003150 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
3151 OMPPrivateScope &PrivateScope);
Samuel Antaocc10b852016-07-28 14:23:26 +00003152 void EmitOMPUseDevicePtrClause(
3153 const OMPClause &C, OMPPrivateScope &PrivateScope,
3154 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003155 /// Emit code for copyin clause in \a D directive. The next code is
Alexey Bataevf56f98c2015-04-16 05:39:01 +00003156 /// generated at the start of outlined functions for directives:
3157 /// \code
3158 /// threadprivate_var1 = master_threadprivate_var1;
3159 /// operator=(threadprivate_var2, master_threadprivate_var2);
3160 /// ...
3161 /// __kmpc_barrier(&loc, global_tid);
3162 /// \endcode
3163 ///
3164 /// \param D OpenMP directive possibly with 'copyin' clause(s).
3165 /// \returns true if at least one copyin variable is found, false otherwise.
3166 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003167 /// Emit initial code for lastprivate variables. If some variable is
Alexey Bataev38e89532015-04-16 04:54:05 +00003168 /// not also firstprivate, then the default initialization is used. Otherwise
3169 /// initialization of this variable is performed by EmitOMPFirstprivateClause
3170 /// method.
3171 ///
3172 /// \param D Directive that may have 'lastprivate' directives.
3173 /// \param PrivateScope Private scope for capturing lastprivate variables for
3174 /// proper codegen in internal captured statement.
3175 ///
3176 /// \returns true if there is at least one lastprivate variable, false
3177 /// otherwise.
3178 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
3179 OMPPrivateScope &PrivateScope);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003180 /// Emit final copying of lastprivate values to original variables at
Alexey Bataev38e89532015-04-16 04:54:05 +00003181 /// the end of the worksharing or simd directive.
3182 ///
3183 /// \param D Directive that has at least one 'lastprivate' directives.
3184 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
3185 /// it is the last iteration of the loop code in associated directive, or to
Alexey Bataevfc087ec2015-06-16 13:14:42 +00003186 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
Alexey Bataev38e89532015-04-16 04:54:05 +00003187 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
Alexey Bataev5dff95c2016-04-22 03:56:56 +00003188 bool NoFinals,
Alexey Bataevfc087ec2015-06-16 13:14:42 +00003189 llvm::Value *IsLastIterCond = nullptr);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00003190 /// Emit initial code for linear clauses.
3191 void EmitOMPLinearClause(const OMPLoopDirective &D,
3192 CodeGenFunction::OMPPrivateScope &PrivateScope);
3193 /// Emit final code for linear clauses.
3194 /// \param CondGen Optional conditional code for final part of codegen for
3195 /// linear clause.
3196 void EmitOMPLinearClauseFinal(
3197 const OMPLoopDirective &D,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003198 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003199 /// Emit initial code for reduction variables. Creates reduction copies
Alexey Bataev794ba0d2015-04-10 10:43:45 +00003200 /// and initializes them with the values according to OpenMP standard.
3201 ///
3202 /// \param D Directive (possibly) with the 'reduction' clause.
3203 /// \param PrivateScope Private scope for capturing reduction variables for
3204 /// proper codegen in internal captured statement.
3205 ///
3206 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
3207 OMPPrivateScope &PrivateScope);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003208 /// Emit final update of reduction values to original variables at
Alexey Bataev794ba0d2015-04-10 10:43:45 +00003209 /// the end of the directive.
3210 ///
3211 /// \param D Directive that has at least one 'reduction' directives.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00003212 /// \param ReductionKind The kind of reduction to perform.
3213 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
3214 const OpenMPDirectiveKind ReductionKind);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003215 /// Emit initial code for linear variables. Creates private copies
Alexey Bataev3b5b5c42015-06-18 10:10:12 +00003216 /// and initializes them with the values according to OpenMP standard.
3217 ///
3218 /// \param D Directive (possibly) with the 'linear' clause.
Alexey Bataev8c3edfe2017-08-16 15:58:46 +00003219 /// \return true if at least one linear variable is found that should be
3220 /// initialized with the value of the original variable, false otherwise.
3221 bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
Alexey Bataev9959db52014-05-06 10:08:46 +00003222
Alexey Bataev7292c292016-04-25 12:22:29 +00003223 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
James Y Knight9871db02019-02-05 16:42:33 +00003224 llvm::Function * /*OutlinedFn*/,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00003225 const OMPTaskDataTy & /*Data*/)>
Alexey Bataev7292c292016-04-25 12:22:29 +00003226 TaskGenTy;
3227 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
Alexey Bataev475a7442018-01-12 19:39:11 +00003228 const OpenMPDirectiveKind CapturedRegion,
Alexey Bataev7292c292016-04-25 12:22:29 +00003229 const RegionCodeGenTy &BodyGen,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00003230 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
Alexey Bataevd2202ca2017-12-27 17:58:32 +00003231 struct OMPTargetDataInfo {
3232 Address BasePointersArray = Address::invalid();
3233 Address PointersArray = Address::invalid();
3234 Address SizesArray = Address::invalid();
3235 unsigned NumberOfTargetItems = 0;
3236 explicit OMPTargetDataInfo() = default;
3237 OMPTargetDataInfo(Address BasePointersArray, Address PointersArray,
3238 Address SizesArray, unsigned NumberOfTargetItems)
3239 : BasePointersArray(BasePointersArray), PointersArray(PointersArray),
3240 SizesArray(SizesArray), NumberOfTargetItems(NumberOfTargetItems) {}
3241 };
3242 void EmitOMPTargetTaskBasedDirective(const OMPExecutableDirective &S,
3243 const RegionCodeGenTy &BodyGen,
3244 OMPTargetDataInfo &InputInfo);
Alexey Bataev7292c292016-04-25 12:22:29 +00003245
Alexey Bataev9959db52014-05-06 10:08:46 +00003246 void EmitOMPParallelDirective(const OMPParallelDirective &S);
Alexander Musman515ad8c2014-05-22 08:54:05 +00003247 void EmitOMPSimdDirective(const OMPSimdDirective &S);
Alexey Bataevf29276e2014-06-18 04:14:57 +00003248 void EmitOMPForDirective(const OMPForDirective &S);
Alexander Musmanf82886e2014-09-18 05:12:34 +00003249 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00003250 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00003251 void EmitOMPSectionDirective(const OMPSectionDirective &S);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00003252 void EmitOMPSingleDirective(const OMPSingleDirective &S);
Alexander Musman80c22892014-07-17 08:54:58 +00003253 void EmitOMPMasterDirective(const OMPMasterDirective &S);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00003254 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
Alexey Bataev4acb8592014-07-07 13:01:15 +00003255 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
Alexander Musmane4e893b2014-09-23 09:33:00 +00003256 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00003257 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
cchen47d60942019-12-05 13:43:48 -05003258 void EmitOMPParallelMasterDirective(const OMPParallelMasterDirective &S);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00003259 void EmitOMPTaskDirective(const OMPTaskDirective &S);
Alexey Bataev68446b72014-07-18 07:47:19 +00003260 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00003261 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
Alexey Bataev2df347a2014-07-18 10:17:07 +00003262 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00003263 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
Alexey Bataev6125da92014-07-21 11:26:11 +00003264 void EmitOMPFlushDirective(const OMPFlushDirective &S);
Alexey Bataevc112e942020-02-28 09:52:15 -05003265 void EmitOMPDepobjDirective(const OMPDepobjDirective &S);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00003266 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
Alexey Bataev0162e452014-07-22 10:10:35 +00003267 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00003268 void EmitOMPTargetDirective(const OMPTargetDirective &S);
Michael Wong65f367f2015-07-21 13:44:28 +00003269 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
Samuel Antaodf67fc42016-01-19 19:15:56 +00003270 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
Samuel Antao72590762016-01-19 20:04:50 +00003271 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
Samuel Antao686c70c2016-05-26 17:30:50 +00003272 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00003273 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00003274 void
3275 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
Alexey Bataev13314bf2014-10-09 04:18:56 +00003276 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00003277 void
3278 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
Alexey Bataev80909872015-07-02 11:25:17 +00003279 void EmitOMPCancelDirective(const OMPCancelDirective &S);
Alexey Bataev7292c292016-04-25 12:22:29 +00003280 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
Alexey Bataev49f6e782015-12-01 04:18:41 +00003281 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00003282 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
Alexey Bataev60e51c42019-10-10 20:13:02 +00003283 void EmitOMPMasterTaskLoopDirective(const OMPMasterTaskLoopDirective &S);
Alexey Bataevb8552ab2019-10-18 16:47:35 +00003284 void
3285 EmitOMPMasterTaskLoopSimdDirective(const OMPMasterTaskLoopSimdDirective &S);
Alexey Bataev5bbcead2019-10-14 17:17:41 +00003286 void EmitOMPParallelMasterTaskLoopDirective(
3287 const OMPParallelMasterTaskLoopDirective &S);
Alexey Bataev14a388f2019-10-25 10:27:13 -04003288 void EmitOMPParallelMasterTaskLoopSimdDirective(
3289 const OMPParallelMasterTaskLoopSimdDirective &S);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00003290 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
Carlo Bertolli9925f152016-06-27 14:55:37 +00003291 void EmitOMPDistributeParallelForDirective(
3292 const OMPDistributeParallelForDirective &S);
Kelvin Li4a39add2016-07-05 05:00:15 +00003293 void EmitOMPDistributeParallelForSimdDirective(
3294 const OMPDistributeParallelForSimdDirective &S);
Kelvin Li787f3fc2016-07-06 04:45:38 +00003295 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
Kelvin Lia579b912016-07-14 02:54:56 +00003296 void EmitOMPTargetParallelForSimdDirective(
3297 const OMPTargetParallelForSimdDirective &S);
Kelvin Li986330c2016-07-20 22:57:10 +00003298 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
Kelvin Li02532872016-08-05 14:37:37 +00003299 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
Kelvin Li4e325f72016-10-25 12:50:55 +00003300 void
3301 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
Kelvin Li579e41c2016-11-30 23:51:03 +00003302 void EmitOMPTeamsDistributeParallelForSimdDirective(
3303 const OMPTeamsDistributeParallelForSimdDirective &S);
Kelvin Li7ade93f2016-12-09 03:24:30 +00003304 void EmitOMPTeamsDistributeParallelForDirective(
3305 const OMPTeamsDistributeParallelForDirective &S);
Kelvin Libf594a52016-12-17 05:48:59 +00003306 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
Kelvin Li83c451e2016-12-25 04:52:54 +00003307 void EmitOMPTargetTeamsDistributeDirective(
3308 const OMPTargetTeamsDistributeDirective &S);
Kelvin Li80e8f562016-12-29 22:16:30 +00003309 void EmitOMPTargetTeamsDistributeParallelForDirective(
3310 const OMPTargetTeamsDistributeParallelForDirective &S);
Kelvin Li1851df52017-01-03 05:23:48 +00003311 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
3312 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Kelvin Lida681182017-01-10 18:08:18 +00003313 void EmitOMPTargetTeamsDistributeSimdDirective(
3314 const OMPTargetTeamsDistributeSimdDirective &S);
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00003315
Arpith Chacko Jacob43a8b7b2017-01-16 15:26:02 +00003316 /// Emit device code for the target directive.
3317 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
3318 StringRef ParentName,
3319 const OMPTargetDirective &S);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +00003320 static void
3321 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3322 const OMPTargetParallelDirective &S);
Alexey Bataevfb0ebec2017-11-08 20:16:14 +00003323 /// Emit device code for the target parallel for directive.
3324 static void EmitOMPTargetParallelForDeviceFunction(
3325 CodeGenModule &CGM, StringRef ParentName,
3326 const OMPTargetParallelForDirective &S);
Alexey Bataev5d7edca2017-11-09 17:32:15 +00003327 /// Emit device code for the target parallel for simd directive.
3328 static void EmitOMPTargetParallelForSimdDeviceFunction(
3329 CodeGenModule &CGM, StringRef ParentName,
3330 const OMPTargetParallelForSimdDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003331 /// Emit device code for the target teams directive.
Arpith Chacko Jacob99a1e0e2017-01-25 02:18:43 +00003332 static void
3333 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3334 const OMPTargetTeamsDirective &S);
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003335 /// Emit device code for the target teams distribute directive.
3336 static void EmitOMPTargetTeamsDistributeDeviceFunction(
3337 CodeGenModule &CGM, StringRef ParentName,
3338 const OMPTargetTeamsDistributeDirective &S);
Alexey Bataevfbe17fb2017-12-13 19:45:06 +00003339 /// Emit device code for the target teams distribute simd directive.
3340 static void EmitOMPTargetTeamsDistributeSimdDeviceFunction(
3341 CodeGenModule &CGM, StringRef ParentName,
3342 const OMPTargetTeamsDistributeSimdDirective &S);
Alexey Bataevf8365372017-11-17 17:57:25 +00003343 /// Emit device code for the target simd directive.
3344 static void EmitOMPTargetSimdDeviceFunction(CodeGenModule &CGM,
3345 StringRef ParentName,
3346 const OMPTargetSimdDirective &S);
Alexey Bataev647dd842018-01-15 20:59:40 +00003347 /// Emit device code for the target teams distribute parallel for simd
3348 /// directive.
3349 static void EmitOMPTargetTeamsDistributeParallelForSimdDeviceFunction(
3350 CodeGenModule &CGM, StringRef ParentName,
3351 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
Carlo Bertolli52978c32018-01-03 21:12:44 +00003352
3353 static void EmitOMPTargetTeamsDistributeParallelForDeviceFunction(
3354 CodeGenModule &CGM, StringRef ParentName,
3355 const OMPTargetTeamsDistributeParallelForDirective &S);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003356 /// Emit inner loop of the worksharing/simd construct.
Alexey Bataev98eb6e32015-04-22 11:15:40 +00003357 ///
3358 /// \param S Directive, for which the inner loop must be emitted.
3359 /// \param RequiresCleanup true, if directive has some associated private
3360 /// variables.
3361 /// \param LoopCond Bollean condition for loop continuation.
3362 /// \param IncExpr Increment expression for loop control variable.
3363 /// \param BodyGen Generator for the inner body of the inner loop.
3364 /// \param PostIncGen Genrator for post-increment code (required for ordered
3365 /// loop directvies).
3366 void EmitOMPInnerLoop(
3367 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
3368 const Expr *IncExpr,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003369 const llvm::function_ref<void(CodeGenFunction &)> BodyGen,
3370 const llvm::function_ref<void(CodeGenFunction &)> PostIncGen);
Alexey Bataev68adb7d2015-04-14 03:29:22 +00003371
Alexey Bataev81c7ea02015-07-03 09:56:58 +00003372 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
Alexey Bataev5dff95c2016-04-22 03:56:56 +00003373 /// Emit initial code for loop counters of loop-based directives.
3374 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
3375 OMPPrivateScope &LoopScope);
Alexey Bataev81c7ea02015-07-03 09:56:58 +00003376
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003377 /// Helper for the OpenMP loop directives.
3378 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
3379
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003380 /// Emit code for the worksharing loop-based directive.
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003381 /// \return true, if this construct has any lastprivate clause, false -
3382 /// otherwise.
3383 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
3384 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
3385 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3386
Alexey Bataevdfa430f2017-12-08 15:03:50 +00003387 /// Emit code for the distribute loop-based directive.
3388 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
3389 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
3390
Alexey Bataevf8365372017-11-17 17:57:25 +00003391 /// Helpers for the OpenMP loop directives.
3392 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
3393 void EmitOMPSimdFinal(
3394 const OMPLoopDirective &D,
Alexey Bataevddf3db92018-04-13 17:31:06 +00003395 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
Alexey Bataevf8365372017-11-17 17:57:25 +00003396
Alexey Bataevf47c4b42017-09-26 13:47:31 +00003397 /// Emits the lvalue for the expression with possibly captured variable.
3398 LValue EmitOMPSharedLValue(const Expr *E);
3399
Alexander Musmanc6388682014-12-15 07:07:06 +00003400private:
Yaxun Liufa13d012018-02-15 16:39:19 +00003401 /// Helpers for blocks.
3402 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
George Burgess IVe3763372016-12-22 02:50:20 +00003403
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003404 /// struct with the values to be passed to the OpenMP loop-related functions
3405 struct OMPLoopArguments {
3406 /// loop lower bound
3407 Address LB = Address::invalid();
3408 /// loop upper bound
3409 Address UB = Address::invalid();
3410 /// loop stride
3411 Address ST = Address::invalid();
3412 /// isLastIteration argument for runtime functions
3413 Address IL = Address::invalid();
3414 /// Chunk value generated by sema
3415 llvm::Value *Chunk = nullptr;
3416 /// EnsureUpperBound
3417 Expr *EUB = nullptr;
3418 /// IncrementExpression
3419 Expr *IncExpr = nullptr;
3420 /// Loop initialization
3421 Expr *Init = nullptr;
3422 /// Loop exit condition
3423 Expr *Cond = nullptr;
3424 /// Update of LB after a whole chunk has been executed
3425 Expr *NextLB = nullptr;
3426 /// Update of UB after a whole chunk has been executed
3427 Expr *NextUB = nullptr;
3428 OMPLoopArguments() = default;
3429 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
3430 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
3431 Expr *IncExpr = nullptr, Expr *Init = nullptr,
3432 Expr *Cond = nullptr, Expr *NextLB = nullptr,
3433 Expr *NextUB = nullptr)
3434 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
3435 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
3436 NextUB(NextUB) {}
3437 };
3438 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
3439 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
3440 const OMPLoopArguments &LoopArgs,
3441 const CodeGenLoopTy &CodeGenLoop,
3442 const CodeGenOrderedTy &CodeGenOrdered);
Alexey Bataev9ebd7422016-05-10 09:57:36 +00003443 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
Alexey Bataeva6f2a142015-12-31 06:52:34 +00003444 bool IsMonotonic, const OMPLoopDirective &S,
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00003445 OMPPrivateScope &LoopScope, bool Ordered,
3446 const OMPLoopArguments &LoopArgs,
3447 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3448 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
3449 const OMPLoopDirective &S,
3450 OMPPrivateScope &LoopScope,
3451 const OMPLoopArguments &LoopArgs,
3452 const CodeGenLoopTy &CodeGenLoopContent);
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003453 /// Emit code for sections directive.
Alexey Bataev3392d762016-02-16 11:18:12 +00003454 void EmitSections(const OMPExecutableDirective &S);
Alexander Musmanc6388682014-12-15 07:07:06 +00003455
3456public:
Alexander Musmana5f070a2014-10-01 06:03:56 +00003457
Chris Lattner208ae962007-05-30 17:57:17 +00003458 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00003459 // LValue Expression Emission
3460 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00003461
Daniel Dunbarc79407f2009-02-05 07:09:07 +00003462 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
3463 RValue GetUndefRValue(QualType Ty);
3464
Daniel Dunbarbb197e42009-01-09 16:50:52 +00003465 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
3466 /// and issue an ErrorUnsupported style diagnostic (using the
3467 /// provided Name).
3468 RValue EmitUnsupportedRValue(const Expr *E,
3469 const char *Name);
3470
Mike Stumpfc496822009-02-08 23:14:22 +00003471 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
3472 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00003473 LValue EmitUnsupportedLValue(const Expr *E,
3474 const char *Name);
3475
Chris Lattner8394d792007-06-05 20:53:16 +00003476 /// EmitLValue - Emit code to compute a designator that specifies the location
3477 /// of the expression.
3478 ///
3479 /// This can return one of two things: a simple address or a bitfield
3480 /// reference. In either case, the LLVM Value* in the LValue structure is
3481 /// guaranteed to be an LLVM pointer type.
3482 ///
3483 /// If this returns a bitfield reference, nothing about the pointee type of
3484 /// the LLVM value is known: For example, it may not be a pointer to an
3485 /// integer.
3486 ///
3487 /// If this returns a normal address, and if the lvalue's C type is fixed
3488 /// size, this method guarantees that the returned pointer type will point to
3489 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
3490 /// variable length type, this is not possible.
3491 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00003492 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003493
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003494 /// Same as EmitLValue but additionally we generate checking code to
Richard Smith4d1458e2012-09-08 02:08:36 +00003495 /// guard against undefined behavior. This is only suitable when we know
3496 /// that the address will be used to access the object.
3497 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00003498
John McCall7f416cc2015-09-08 08:05:57 +00003499 RValue convertTempToRValue(Address addr, QualType type,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003500 SourceLocation Loc);
John McCall47fb9502013-03-07 21:37:08 +00003501
John McCalla8ec7eb2013-03-07 21:37:17 +00003502 void EmitAtomicInit(Expr *E, LValue lvalue);
3503
David Majnemera5b195a2015-02-14 01:35:12 +00003504 bool LValueIsSuitableForInlineAtomic(LValue Src);
David Majnemera5b195a2015-02-14 01:35:12 +00003505
3506 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
3507 AggValueSlot Slot = AggValueSlot::ignored());
3508
Nick Lewycky2d84e842013-10-02 02:29:49 +00003509 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
David Majnemera5b195a2015-02-14 01:35:12 +00003510 llvm::AtomicOrdering AO, bool IsVolatile = false,
John McCalla8ec7eb2013-03-07 21:37:17 +00003511 AggValueSlot slot = AggValueSlot::ignored());
3512
3513 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3514
David Majnemera5b195a2015-02-14 01:35:12 +00003515 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3516 bool IsVolatile, bool isInit);
3517
Alexey Bataevb4505a72015-03-30 05:20:59 +00003518 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
Alexey Bataev452d8e12014-12-15 05:25:25 +00003519 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
JF Bastien92f4ef12016-04-06 17:26:42 +00003520 llvm::AtomicOrdering Success =
3521 llvm::AtomicOrdering::SequentiallyConsistent,
3522 llvm::AtomicOrdering Failure =
3523 llvm::AtomicOrdering::SequentiallyConsistent,
Alexey Bataev452d8e12014-12-15 05:25:25 +00003524 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3525
Alexey Bataevb4505a72015-03-30 05:20:59 +00003526 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
Alexey Bataevf0ab5532015-05-15 08:36:34 +00003527 const llvm::function_ref<RValue(RValue)> &UpdateOp,
Alexey Bataevb4505a72015-03-30 05:20:59 +00003528 bool IsVolatile);
3529
John McCall3a7f6922010-10-27 20:58:56 +00003530 /// EmitToMemory - Change a scalar value from its value
3531 /// representation to its in-memory representation.
3532 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3533
3534 /// EmitFromMemory - Change a scalar value from its memory
3535 /// representation to its value representation.
3536 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3537
Vedant Kumar5a972652017-02-27 19:46:19 +00003538 /// Check if the scalar \p Value is within the valid range for the given
3539 /// type \p Ty.
3540 ///
3541 /// Returns true if a check is needed (even if the range is unknown).
3542 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3543 SourceLocation Loc);
3544
Daniel Dunbar1d425462009-02-10 00:57:50 +00003545 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3546 /// care to appropriately convert from the memory representation to
3547 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003548 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003549 SourceLocation Loc,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003550 AlignmentSource Source = AlignmentSource::Type,
3551 bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003552 return EmitLoadOfScalar(Addr, Volatile, Ty, Loc, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003553 CGM.getTBAAAccessInfo(Ty), isNontemporal);
3554 }
3555
3556 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3557 SourceLocation Loc, LValueBaseInfo BaseInfo,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003558 TBAAAccessInfo TBAAInfo,
Michael Zolotukhin84df1232015-09-08 23:52:33 +00003559 bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003560
3561 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3562 /// care to appropriately convert from the memory representation to
3563 /// the LLVM value representation. The l-value must be a simple
3564 /// l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003565 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003566
3567 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3568 /// care to appropriately convert from the memory representation to
3569 /// the LLVM value representation.
John McCall7f416cc2015-09-08 08:05:57 +00003570 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3571 bool Volatile, QualType Ty,
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003572 AlignmentSource Source = AlignmentSource::Type,
3573 bool isInit = false, bool isNontemporal = false) {
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +00003574 EmitStoreOfScalar(Value, Addr, Volatile, Ty, LValueBaseInfo(Source),
Ivan A. Kosarev5f8c0ca2017-10-10 09:39:32 +00003575 CGM.getTBAAAccessInfo(Ty), isInit, isNontemporal);
3576 }
3577
3578 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
Ivan A. Kosarev383890b2017-10-06 08:17:48 +00003579 bool Volatile, QualType Ty,
3580 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo,
Ivan A. Kosareva511ed72017-10-03 10:52:39 +00003581 bool isInit = false, bool isNontemporal = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003582
3583 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3584 /// care to appropriately convert from the memory representation to
3585 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00003586 /// l-value. The isInit flag indicates whether this is an initialization.
3587 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3588 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00003589
Chris Lattner8394d792007-06-05 20:53:16 +00003590 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3591 /// this method emits the address of the lvalue, then loads the result as an
3592 /// rvalue, returning the rvalue.
Nick Lewycky2d84e842013-10-02 02:29:49 +00003593 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
John McCall55e1fbc2011-06-25 02:11:03 +00003594 RValue EmitLoadOfExtVectorElementLValue(LValue V);
Vedant Kumar129edab2017-03-09 16:06:27 +00003595 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
Renato Golin230c5eb2014-05-19 18:15:42 +00003596 RValue EmitLoadOfGlobalRegLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00003597
Chris Lattner8394d792007-06-05 20:53:16 +00003598 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3599 /// lvalue, where both are guaranteed to the have the same type, and that type
3600 /// is 'Ty'.
David Blaikie66e41972015-01-14 07:38:27 +00003601 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
John McCall55e1fbc2011-06-25 02:11:03 +00003602 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Renato Golin230c5eb2014-05-19 18:15:42 +00003603 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003604
Nick Lewycky2d84e842013-10-02 02:29:49 +00003605 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3606 /// as EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00003607 ///
Mike Stumpfc496822009-02-08 23:14:22 +00003608 /// \param Result [out] - If non-null, this will be set to a Value* for the
3609 /// bit-field contents after the store, appropriate for use as the result of
3610 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00003611 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Craig Topper8a13c412014-05-21 05:09:00 +00003612 llvm::Value **Result=nullptr);
Mike Stumpfc496822009-02-08 23:14:22 +00003613
John McCall4f29b492010-11-16 23:07:28 +00003614 /// Emit an l-value for an assignment (simple or compound) of complex type.
3615 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003616 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
Richard Smith527473d2015-02-12 21:23:20 +00003617 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3618 llvm::Value *&Result);
John McCall4f29b492010-11-16 23:07:28 +00003619
Chris Lattner57540c52011-04-15 05:22:18 +00003620 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00003621 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00003622 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003623 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00003624 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00003625 // Note: only available for agg return types
3626 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00003627 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00003628 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00003629 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00003630 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00003631 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00003632 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3633 bool Accessed = false);
Alexey Bataevd6fdc8b2015-08-31 07:32:19 +00003634 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3635 bool IsLowerBound = true);
Nate Begemance4d7fc2008-04-18 23:10:10 +00003636 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00003637 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00003638 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00003639 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00003640 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00003641 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00003642 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00003643 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00003644 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003645
John McCall7f416cc2015-09-08 08:05:57 +00003646 Address EmitExtVectorElementLValue(LValue V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003647
Nick Lewycky2d84e842013-10-02 02:29:49 +00003648 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00003649
John McCall7f416cc2015-09-08 08:05:57 +00003650 Address EmitArrayToPointerDecay(const Expr *Array,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00003651 LValueBaseInfo *BaseInfo = nullptr,
3652 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00003653
John McCall71335052012-03-10 03:05:10 +00003654 class ConstantEmission {
3655 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3656 ConstantEmission(llvm::Constant *C, bool isReference)
3657 : ValueAndIsReference(C, isReference) {}
3658 public:
3659 ConstantEmission() {}
3660 static ConstantEmission forReference(llvm::Constant *C) {
3661 return ConstantEmission(C, true);
3662 }
3663 static ConstantEmission forValue(llvm::Constant *C) {
3664 return ConstantEmission(C, false);
3665 }
3666
Aaron Ballman67347662015-02-15 22:00:28 +00003667 explicit operator bool() const {
Craig Topper8a13c412014-05-21 05:09:00 +00003668 return ValueAndIsReference.getOpaqueValue() != nullptr;
3669 }
John McCall71335052012-03-10 03:05:10 +00003670
3671 bool isReference() const { return ValueAndIsReference.getInt(); }
3672 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3673 assert(isReference());
3674 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3675 refExpr->getType());
3676 }
3677
3678 llvm::Constant *getValue() const {
3679 assert(!isReference());
3680 return ValueAndIsReference.getPointer();
3681 }
3682 };
3683
John McCall113bee02012-03-10 09:33:50 +00003684 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
Alex Lorenz6cc83172017-08-25 10:07:00 +00003685 ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
Volodymyr Sapsaief1899b2018-11-01 21:57:05 +00003686 llvm::Value *emitScalarConstant(const ConstantEmission &Constant, Expr *E);
John McCall71335052012-03-10 03:05:10 +00003687
John McCallfe96e0b2011-11-06 09:01:30 +00003688 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3689 AggValueSlot slot = AggValueSlot::ignored());
3690 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3691
Daniel Dunbar722f4242009-04-22 05:08:15 +00003692 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003693 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00003694 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCalldec348f72013-05-03 07:33:41 +00003695 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003696
Anders Carlssondb78f0a2010-01-29 05:24:29 +00003697 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3698 /// if the Field is a reference, this will return the address of the reference
3699 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00003700 LValue EmitLValueForFieldInitialization(LValue Base,
3701 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003702
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00003703 LValue EmitLValueForIvar(QualType ObjectTy,
3704 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00003705 unsigned CVRQualifiers);
3706
Anders Carlsson3be22e22009-05-30 23:23:33 +00003707 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00003708 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00003709 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00003710 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003711
Daniel Dunbarc8317a42008-08-23 10:51:21 +00003712 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00003713 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00003714 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00003715 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00003716 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003717 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
John McCallc07a0c72011-02-17 10:25:35 +00003718
Chris Lattnerd7f58862007-06-02 05:24:33 +00003719 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00003720 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00003721 //===--------------------------------------------------------------------===//
3722
Mike Stumpfc496822009-02-08 23:14:22 +00003723 /// EmitCall - Generate a call of the given function, expecting the given
3724 /// result type, and using the given argument list which specifies both the
3725 /// LLVM arguments and the types they were derived from.
John McCallb92ab1a2016-10-26 23:46:34 +00003726 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
Samuel Antao798f11c2015-11-23 22:04:44 +00003727 ReturnValueSlot ReturnValue, const CallArgList &Args,
James Y Knight3933add2019-01-30 02:54:28 +00003728 llvm::CallBase **callOrInvoke, SourceLocation Loc);
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003729 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
3730 ReturnValueSlot ReturnValue, const CallArgList &Args,
James Y Knight3933add2019-01-30 02:54:28 +00003731 llvm::CallBase **callOrInvoke = nullptr) {
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003732 return EmitCall(CallInfo, Callee, ReturnValue, Args, callOrInvoke,
3733 SourceLocation());
3734 }
John McCallb92ab1a2016-10-26 23:46:34 +00003735 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003736 ReturnValueSlot ReturnValue, llvm::Value *Chain = nullptr);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003737 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00003738 ReturnValueSlot ReturnValue = ReturnValueSlot());
John McCallb92ab1a2016-10-26 23:46:34 +00003739 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3740 CGCallee EmitCallee(const Expr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003741
Eric Christopherc7e79db2015-11-12 00:44:04 +00003742 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
Erich Keane36176242019-06-21 22:29:32 +00003743 void checkTargetFeatures(SourceLocation Loc, const FunctionDecl *TargetDecl);
Eric Christopher15709992015-10-15 23:47:11 +00003744
James Y Knight9871db02019-02-05 16:42:33 +00003745 llvm::CallInst *EmitRuntimeCall(llvm::FunctionCallee callee,
John McCall882987f2013-02-28 19:01:20 +00003746 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003747 llvm::CallInst *EmitRuntimeCall(llvm::FunctionCallee callee,
3748 ArrayRef<llvm::Value *> args,
John McCall882987f2013-02-28 19:01:20 +00003749 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003750 llvm::CallInst *EmitNounwindRuntimeCall(llvm::FunctionCallee callee,
John McCall882987f2013-02-28 19:01:20 +00003751 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003752 llvm::CallInst *EmitNounwindRuntimeCall(llvm::FunctionCallee callee,
3753 ArrayRef<llvm::Value *> args,
John McCall882987f2013-02-28 19:01:20 +00003754 const Twine &name = "");
3755
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003756 SmallVector<llvm::OperandBundleDef, 1>
3757 getBundlesForFunclet(llvm::Value *Callee);
3758
James Y Knight9871db02019-02-05 16:42:33 +00003759 llvm::CallBase *EmitCallOrInvoke(llvm::FunctionCallee Callee,
James Y Knight3933add2019-01-30 02:54:28 +00003760 ArrayRef<llvm::Value *> Args,
3761 const Twine &Name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003762 llvm::CallBase *EmitRuntimeCallOrInvoke(llvm::FunctionCallee callee,
James Y Knight3933add2019-01-30 02:54:28 +00003763 ArrayRef<llvm::Value *> args,
3764 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003765 llvm::CallBase *EmitRuntimeCallOrInvoke(llvm::FunctionCallee callee,
James Y Knight3933add2019-01-30 02:54:28 +00003766 const Twine &name = "");
James Y Knight9871db02019-02-05 16:42:33 +00003767 void EmitNoreturnRuntimeCallOrInvoke(llvm::FunctionCallee callee,
3768 ArrayRef<llvm::Value *> args);
John McCallbd309292010-07-06 01:34:17 +00003769
Gor Nishanov04491bd2017-11-11 17:00:43 +00003770 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
John McCallb92ab1a2016-10-26 23:46:34 +00003771 NestedNameSpecifier *Qual,
3772 llvm::Type *Ty);
Gor Nishanov04491bd2017-11-11 17:00:43 +00003773
John McCallb92ab1a2016-10-26 23:46:34 +00003774 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
Gor Nishanov04491bd2017-11-11 17:00:43 +00003775 CXXDtorType Type,
John McCallb92ab1a2016-10-26 23:46:34 +00003776 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00003777
Akira Hatanaka9978da32018-08-10 15:09:24 +00003778 // Return the copy constructor name with the prefix "__copy_constructor_"
3779 // removed.
3780 static std::string getNonTrivialCopyConstructorStr(QualType QT,
3781 CharUnits Alignment,
3782 bool IsVolatile,
3783 ASTContext &Ctx);
3784
3785 // Return the destructor name with the prefix "__destructor_" removed.
3786 static std::string getNonTrivialDestructorStr(QualType QT,
3787 CharUnits Alignment,
3788 bool IsVolatile,
3789 ASTContext &Ctx);
3790
Akira Hatanaka7275da02018-02-28 07:15:55 +00003791 // These functions emit calls to the special functions of non-trivial C
3792 // structs.
3793 void defaultInitNonTrivialCStructVar(LValue Dst);
3794 void callCStructDefaultConstructor(LValue Dst);
3795 void callCStructDestructor(LValue Dst);
3796 void callCStructCopyConstructor(LValue Dst, LValue Src);
3797 void callCStructMoveConstructor(LValue Dst, LValue Src);
3798 void callCStructCopyAssignmentOperator(LValue Dst, LValue Src);
3799 void callCStructMoveAssignmentOperator(LValue Dst, LValue Src);
3800
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003801 RValue
John McCallb92ab1a2016-10-26 23:46:34 +00003802 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3803 const CGCallee &Callee,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00003804 ReturnValueSlot ReturnValue, llvm::Value *This,
3805 llvm::Value *ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +00003806 QualType ImplicitParamTy, const CallExpr *E,
3807 CallArgList *RtlArgs);
Marco Antognini88559632019-07-22 09:39:13 +00003808 RValue EmitCXXDestructorCall(GlobalDecl Dtor, const CGCallee &Callee,
3809 llvm::Value *This, QualType ThisTy,
3810 llvm::Value *ImplicitParam,
Peter Collingbourned1c5b282019-03-22 23:05:10 +00003811 QualType ImplicitParamTy, const CallExpr *E);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003812 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3813 ReturnValueSlot ReturnValue);
Nico Weberaad4af62014-12-03 01:21:41 +00003814 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3815 const CXXMethodDecl *MD,
3816 ReturnValueSlot ReturnValue,
3817 bool HasQualifier,
3818 NestedNameSpecifier *Qualifier,
3819 bool IsArrow, const Expr *Base);
3820 // Compute the object pointer.
John McCall7f416cc2015-09-08 08:05:57 +00003821 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3822 llvm::Value *memberPtr,
3823 const MemberPointerType *memberPtrType,
Ivan A. Kosarev229a6d82017-10-13 16:38:32 +00003824 LValueBaseInfo *BaseInfo = nullptr,
3825 TBAAAccessInfo *TBAAInfo = nullptr);
Anders Carlssonbfb36712009-12-24 21:13:40 +00003826 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3827 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00003828
Anders Carlsson4034a952009-05-27 04:18:27 +00003829 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00003830 const CXXMethodDecl *MD,
3831 ReturnValueSlot ReturnValue);
John McCallb92ab1a2016-10-26 23:46:34 +00003832 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00003833
Peter Collingbournefe883422011-10-06 18:29:37 +00003834 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3835 ReturnValueSlot ReturnValue);
3836
Arpith Chacko Jacobcdda3daa2017-01-29 20:49:31 +00003837 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3838 ReturnValueSlot ReturnValue);
Sameer Sahasrabuddheed181ef2019-08-22 15:34:35 +05303839 RValue EmitAMDGPUDevicePrintfCallExpr(const CallExpr *E,
3840 ReturnValueSlot ReturnValue);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003841
Erich Keanede6480a32018-11-13 15:48:08 +00003842 RValue EmitBuiltinExpr(const GlobalDecl GD, unsigned BuiltinID,
3843 const CallExpr *E, ReturnValueSlot ReturnValue);
Chris Lattner8394d792007-06-05 20:53:16 +00003844
Sanjay Patelad823902018-08-19 16:50:30 +00003845 RValue emitRotate(const CallExpr *E, bool IsRotateRight);
3846
Akira Hatanaka6b103bc2017-10-06 07:12:46 +00003847 /// Emit IR for __builtin_os_log_format.
3848 RValue emitBuiltinOSLogFormat(const CallExpr &E);
3849
Alex Richardson8c387cb2020-01-09 20:48:06 +00003850 /// Emit IR for __builtin_is_aligned.
3851 RValue EmitBuiltinIsAligned(const CallExpr *E);
3852 /// Emit IR for __builtin_align_up/__builtin_align_down.
3853 RValue EmitBuiltinAlignTo(const CallExpr *E, bool AlignUp);
3854
Akira Hatanaka6b103bc2017-10-06 07:12:46 +00003855 llvm::Function *generateBuiltinOSLogHelperFunction(
3856 const analyze_os_log::OSLogBufferLayout &Layout,
3857 CharUnits BufferAlignment);
3858
Anders Carlssonbfb36712009-12-24 21:13:40 +00003859 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00003860
Mike Stumpfc496822009-02-08 23:14:22 +00003861 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3862 /// is unhandled by the current target.
Simon Tatham08074cc2019-09-02 15:50:50 +01003863 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3864 ReturnValueSlot ReturnValue);
Daniel Dunbareca513d2008-10-10 00:24:54 +00003865
Kevin Qin1718af62013-11-14 02:45:18 +00003866 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3867 const llvm::CmpInst::Predicate Fp,
3868 const llvm::CmpInst::Predicate Ip,
3869 const llvm::Twine &Name = "");
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003870 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E,
Simon Tatham08074cc2019-09-02 15:50:50 +01003871 ReturnValueSlot ReturnValue,
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003872 llvm::Triple::ArchType Arch);
Simon Tatham08074cc2019-09-02 15:50:50 +01003873 llvm::Value *EmitARMMVEBuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3874 ReturnValueSlot ReturnValue,
3875 llvm::Triple::ArchType Arch);
Tim Northover8fe03d62014-02-21 11:57:24 +00003876
3877 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3878 unsigned LLVMIntrinsic,
3879 unsigned AltLLVMIntrinsic,
3880 const char *NameHint,
3881 unsigned Modifier,
3882 const CallExpr *E,
Tim Northover027b4ee2014-01-31 10:46:45 +00003883 SmallVectorImpl<llvm::Value *> &Ops,
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003884 Address PtrOp0, Address PtrOp1,
3885 llvm::Triple::ArchType Arch);
Simon Tatham89e31fa2018-05-30 07:54:05 +00003886
Tim Northover8fe03d62014-02-21 11:57:24 +00003887 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3888 unsigned Modifier, llvm::Type *ArgTy,
3889 const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003890 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00003891 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00003892 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003893 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00003894 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00003895 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00003896 bool negateForRightShift);
Amaury de la Vieuville21bf6ed2013-10-04 13:13:15 +00003897 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3898 llvm::Type *Ty, bool usgn, const char *name);
Tim Northovera2ee4332014-03-29 15:09:45 +00003899 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
Sjoerd Meijer95da8752018-03-13 19:38:56 +00003900 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3901 llvm::Triple::ArchType Arch);
Yonghong Song05e46972019-10-08 18:23:17 +00003902 llvm::Value *EmitBPFBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003903
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003904 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00003905 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3906 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Matt Arsenault3ea39f92015-06-19 17:54:10 +00003907 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Ulrich Weigand3a610eb2015-04-01 12:54:25 +00003908 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Artem Belevichd21e5c62015-06-25 18:29:42 +00003909 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Dan Gohmanc2853072015-09-03 22:51:53 +00003910 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3911 const CallExpr *E);
Krzysztof Parzyszek5a655832017-12-13 19:56:03 +00003912 llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00003913
Albert Gutowski2a0621e2016-10-12 22:01:05 +00003914private:
3915 enum class MSVCIntrin;
3916
3917public:
3918 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3919
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003920 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3921
Daniel Dunbar66912a12008-08-20 00:28:19 +00003922 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00003923 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00003924 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00003925 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3926 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3927 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +00003928 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003929 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00003930 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3931 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00003932
John McCall31168b02011-06-15 23:02:42 +00003933 /// Retrieves the default cleanup kind for an ARC cleanup.
3934 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3935 CleanupKind getARCCleanupKind() {
3936 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3937 ? NormalAndEHCleanup : NormalCleanup;
3938 }
3939
3940 // ARC primitives.
John McCall7f416cc2015-09-08 08:05:57 +00003941 void EmitARCInitWeak(Address addr, llvm::Value *value);
3942 void EmitARCDestroyWeak(Address addr);
John McCallb04ecb72015-10-21 18:06:43 +00003943 llvm::Value *EmitARCLoadWeak(Address addr);
John McCall7f416cc2015-09-08 08:05:57 +00003944 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3945 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
Akira Hatanakad791e922018-03-19 17:38:40 +00003946 void emitARCCopyAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
3947 void emitARCMoveAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
John McCall7f416cc2015-09-08 08:05:57 +00003948 void EmitARCCopyWeak(Address dst, Address src);
3949 void EmitARCMoveWeak(Address dst, Address src);
John McCall31168b02011-06-15 23:02:42 +00003950 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3951 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00003952 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003953 bool resultIgnored);
John McCall7f416cc2015-09-08 08:05:57 +00003954 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00003955 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00003956 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
Pete Cooper94867712016-03-21 20:50:03 +00003957 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00003958 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall7f416cc2015-09-08 08:05:57 +00003959 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
John McCallcdda29c2013-03-13 03:10:54 +00003960 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
Pete Cooper94867712016-03-21 20:50:03 +00003961 llvm::Value *EmitARCAutorelease(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003962 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3963 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3964 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
John McCalle399e5b2016-01-27 18:32:30 +00003965 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
John McCall31168b02011-06-15 23:02:42 +00003966
Pete Coopere5b64ea2018-12-21 21:00:32 +00003967 llvm::Value *EmitObjCAutorelease(llvm::Value *value, llvm::Type *returnType);
3968 llvm::Value *EmitObjCRetainNonBlock(llvm::Value *value,
3969 llvm::Type *returnType);
3970 void EmitObjCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
3971
John McCall31168b02011-06-15 23:02:42 +00003972 std::pair<LValue,llvm::Value*>
3973 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3974 std::pair<LValue,llvm::Value*>
3975 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
John McCalle399e5b2016-01-27 18:32:30 +00003976 std::pair<LValue,llvm::Value*>
3977 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
John McCall31168b02011-06-15 23:02:42 +00003978
Pete Coopere3886802018-12-08 05:13:50 +00003979 llvm::Value *EmitObjCAlloc(llvm::Value *value,
3980 llvm::Type *returnType);
3981 llvm::Value *EmitObjCAllocWithZone(llvm::Value *value,
3982 llvm::Type *returnType);
Erik Pilkingtonec389b02019-02-14 19:58:37 +00003983 llvm::Value *EmitObjCAllocInit(llvm::Value *value, llvm::Type *resultType);
3984
John McCall248512a2011-10-01 10:32:24 +00003985 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003986 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3987 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3988
John McCallff613032011-10-04 06:23:45 +00003989 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003990 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3991 bool allowUnsafeClaim);
John McCall31168b02011-06-15 23:02:42 +00003992 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3993 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
John McCalle399e5b2016-01-27 18:32:30 +00003994 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00003995
Craig Topper00bbdcf2014-06-28 23:22:23 +00003996 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
John McCalleff18842013-03-23 02:35:54 +00003997
John McCall82fe67b2011-07-09 01:37:26 +00003998 static Destroyer destroyARCStrongImprecise;
3999 static Destroyer destroyARCStrongPrecise;
4000 static Destroyer destroyARCWeak;
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00004001 static Destroyer emitARCIntrinsicUse;
Akira Hatanaka7275da02018-02-28 07:15:55 +00004002 static Destroyer destroyNonTrivialCStruct;
John McCall82fe67b2011-07-09 01:37:26 +00004003
Gor Nishanov04491bd2017-11-11 17:00:43 +00004004 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00004005 llvm::Value *EmitObjCAutoreleasePoolPush();
4006 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
4007 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
Gor Nishanov04491bd2017-11-11 17:00:43 +00004008 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
John McCall31168b02011-06-15 23:02:42 +00004009
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004010 /// Emits a reference binding to the passed in expression.
Richard Smitha1c9d4d2013-06-12 23:38:09 +00004011 RValue EmitReferenceBindingToExpr(const Expr *E);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00004012
Chris Lattner6278e6a2007-08-11 00:04:45 +00004013 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00004014 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00004015 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00004016
4017 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00004018
4019 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
4020 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00004021 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00004022
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00004023 /// Emit a conversion from the specified type to the specified destination
4024 /// type, both of which are LLVM scalar types.
Chris Lattner3474c202007-08-26 06:48:56 +00004025 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00004026 QualType DstTy, SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00004027
Filipe Cabecinhas650d7f72015-08-05 06:19:26 +00004028 /// Emit a conversion from the specified complex type to the specified
4029 /// destination type, where the destination type is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00004030 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
Filipe Cabecinhas7af183d2015-08-11 04:19:28 +00004031 QualType DstTy,
4032 SourceLocation Loc);
Mike Stumpfc496822009-02-08 23:14:22 +00004033
John McCall7a626f62010-09-15 10:14:12 +00004034 /// EmitAggExpr - Emit the computation of the specified expression
4035 /// of aggregate type. The result is computed into the given slot,
4036 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00004037 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00004038
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00004039 /// EmitAggExprToLValue - Emit the computation of the specified expression of
4040 /// aggregate type into a temporary LValue.
4041 LValue EmitAggExprToLValue(const Expr *E);
4042
John McCall1bd25562011-06-24 23:21:27 +00004043 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
4044 /// make sure it survives garbage collection until this point.
4045 void EmitExtendGCLifetime(llvm::Value *object);
4046
Chris Lattnercbfc73b2007-08-21 05:54:00 +00004047 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00004048 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00004049 ComplexPairTy EmitComplexExpr(const Expr *E,
4050 bool IgnoreReal = false,
4051 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00004052
John McCall47fb9502013-03-07 21:37:08 +00004053 /// EmitComplexExprIntoLValue - Emit the given expression of complex
4054 /// type and place its result into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00004055 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00004056
John McCall47fb9502013-03-07 21:37:08 +00004057 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
David Blaikie66e41972015-01-14 07:38:27 +00004058 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
John McCall47fb9502013-03-07 21:37:08 +00004059
4060 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00004061 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
Chris Lattnerb781dc792008-05-08 05:58:21 +00004062
John McCall7f416cc2015-09-08 08:05:57 +00004063 Address emitAddrOfRealComponent(Address complex, QualType complexType);
4064 Address emitAddrOfImagComponent(Address complex, QualType complexType);
4065
Chandler Carruth84537952012-03-30 19:44:53 +00004066 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
4067 /// global variable that has already been created for it. If the initializer
4068 /// has a different type than GV does, this may free GV and return a different
4069 /// one. Otherwise it just returns GV.
4070 llvm::GlobalVariable *
4071 AddInitializerToStaticVarDecl(const VarDecl &D,
4072 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004073
Richard Smith3ad06362018-10-31 20:39:26 +00004074 // Emit an @llvm.invariant.start call for the given memory region.
4075 void EmitInvariantStart(llvm::Constant *Addr, CharUnits Size);
Daniel Dunbar22a87f92009-02-25 19:24:29 +00004076
Anders Carlssonf40886a2009-08-08 21:45:14 +00004077 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
4078 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00004079 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
4080 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00004081
James Y Knightf7321542019-02-07 01:14:17 +00004082 llvm::Function *createAtExitStub(const VarDecl &VD, llvm::FunctionCallee Dtor,
David Majnemerb3341ea2014-10-05 05:05:40 +00004083 llvm::Constant *Addr);
4084
John McCallc84ed6a2012-05-01 06:13:13 +00004085 /// Call atexit() with a function that passes the given argument to
4086 /// the given function.
James Y Knightf7321542019-02-07 01:14:17 +00004087 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::FunctionCallee fn,
David Blaikieebe87e12013-08-27 23:57:18 +00004088 llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00004089
Akira Hatanaka617e2612018-04-17 18:41:52 +00004090 /// Call atexit() with function dtorStub.
4091 void registerGlobalDtorWithAtExit(llvm::Constant *dtorStub);
4092
John McCallcdf7ef52010-11-06 09:44:32 +00004093 /// Emit code in this function to perform a guarded variable
4094 /// initialization. Guarded initializations are used when it's not
4095 /// possible to prove that an initialization will be done exactly
4096 /// once, e.g. with a static local variable or a static data member
4097 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00004098 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00004099 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00004100
Richard Smithae8d62c2017-07-26 22:01:09 +00004101 enum class GuardKind { VariableGuard, TlsGuard };
4102
4103 /// Emit a branch to select whether or not to perform guarded initialization.
4104 void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
4105 llvm::BasicBlock *InitBlock,
4106 llvm::BasicBlock *NoInitBlock,
4107 GuardKind Kind, const VarDecl *D);
4108
Daniel Dunbarfe06df42010-03-20 04:15:41 +00004109 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
4110 /// variables.
Richard Smith3ad06362018-10-31 20:39:26 +00004111 void
4112 GenerateCXXGlobalInitFunc(llvm::Function *Fn,
4113 ArrayRef<llvm::Function *> CXXThreadLocals,
4114 ConstantAddress Guard = ConstantAddress::invalid());
Daniel Dunbarfe06df42010-03-20 04:15:41 +00004115
John McCallee08c532012-04-06 18:21:03 +00004116 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00004117 /// variables.
Sanjoy Dase369bd92017-05-01 17:08:00 +00004118 void GenerateCXXGlobalDtorsFunc(
4119 llvm::Function *Fn,
James Y Knightf7321542019-02-07 01:14:17 +00004120 const std::vector<std::tuple<llvm::FunctionType *, llvm::WeakTrackingVH,
4121 llvm::Constant *>> &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00004122
John McCalla738c252011-03-09 04:27:21 +00004123 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
4124 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00004125 llvm::GlobalVariable *Addr,
4126 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00004127
John McCall7a626f62010-09-15 10:14:12 +00004128 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Gor Nishanov04491bd2017-11-11 17:00:43 +00004129
John McCall7f416cc2015-09-08 08:05:57 +00004130 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00004131
Bill Wendling7c44da22018-10-31 03:48:47 +00004132 void enterFullExpression(const FullExpr *E) {
4133 if (const auto *EWC = dyn_cast<ExprWithCleanups>(E))
4134 if (EWC->getNumObjects() == 0)
4135 return;
John McCall08ef4662011-11-10 08:15:53 +00004136 enterNonTrivialFullExpression(E);
4137 }
Bill Wendling7c44da22018-10-31 03:48:47 +00004138 void enterNonTrivialFullExpression(const FullExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00004139
Richard Smithea852322013-05-07 21:53:22 +00004140 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00004141
Tim Northovercc2a6e02015-11-09 19:56:35 +00004142 RValue EmitAtomicExpr(AtomicExpr *E);
Eli Friedmandf14b3a2011-10-11 02:20:01 +00004143
Daniel Dunbar88402ce2008-08-04 16:51:22 +00004144 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00004145 // Annotations Emission
4146 //===--------------------------------------------------------------------===//
4147
James Y Knight8799cae2019-02-03 21:53:49 +00004148 /// Emit an annotation call (intrinsic).
4149 llvm::Value *EmitAnnotationCall(llvm::Function *AnnotationFn,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00004150 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00004151 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00004152 SourceLocation Location);
4153
4154 /// Emit local annotations for the local variable V, declared by D.
4155 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
4156
4157 /// Emit field annotations for the given field & value. Returns the
4158 /// annotation result.
John McCall7f416cc2015-09-08 08:05:57 +00004159 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00004160
4161 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00004162 // Internal Helpers
4163 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00004164
Chris Lattner5b1964b2008-11-11 07:41:27 +00004165 /// ContainsLabel - Return true if the statement contains a label in it. If
4166 /// this statement is not executed normally, it not containing a label means
4167 /// that we can just remove the code.
4168 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00004169
Chris Lattner29911cc2011-02-28 00:18:40 +00004170 /// containsBreak - Return true if the statement contains a break out of it.
4171 /// If the statement (recursively) contains a switch or loop with a break
4172 /// inside of it, this is fine.
4173 static bool containsBreak(const Stmt *S);
Richard Smithd8e3ac32016-09-16 23:30:39 +00004174
4175 /// Determine if the given statement might introduce a declaration into the
4176 /// current scope, by being a (possibly-labelled) DeclStmt.
4177 static bool mightAddDeclToScope(const Stmt *S);
Gor Nishanov04491bd2017-11-11 17:00:43 +00004178
Daniel Dunbar682712c2008-11-12 10:12:14 +00004179 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00004180 /// to a constant, or if it does but contains a label, return false. If it
4181 /// constant folds return true and set the boolean result in Result.
Richard Smithb130fe72016-06-23 19:16:49 +00004182 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
4183 bool AllowLabels = false);
Mike Stumpfc496822009-02-08 23:14:22 +00004184
Chris Lattner29911cc2011-02-28 00:18:40 +00004185 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
4186 /// to a constant, or if it does but contains a label, return false. If it
4187 /// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00004188 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
4189 bool AllowLabels = false);
4190
Chris Lattnercd439292008-11-12 08:04:58 +00004191 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
4192 /// if statement) to the specified blocks. Based on the condition, this might
4193 /// try to simplify the codegen of the conditional based on the branch.
Justin Bogneref512b92014-01-06 22:27:43 +00004194 /// TrueCount should be the number of times we expect the condition to
4195 /// evaluate to true based on PGO data.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00004196 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00004197 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
Mike Stumpba6a0c42009-12-14 21:58:14 +00004198
Vedant Kumar42c17ec2017-03-14 01:56:34 +00004199 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
4200 /// nonnull, if \p LHS is marked _Nonnull.
4201 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
4202
Vedant Kumar175b6d12017-07-13 20:55:26 +00004203 /// An enumeration which makes it easier to specify whether or not an
4204 /// operation is a subtraction.
4205 enum { NotSubtraction = false, IsSubtraction = true };
4206
Vedant Kumara125eb52017-06-01 19:22:18 +00004207 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
4208 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
Vedant Kumar6dbf4272017-06-12 18:42:51 +00004209 /// \p SignedIndices indicates whether any of the GEP indices are signed.
Vedant Kumar175b6d12017-07-13 20:55:26 +00004210 /// \p IsSubtraction indicates whether the expression used to form the GEP
4211 /// is a subtraction.
Vedant Kumara125eb52017-06-01 19:22:18 +00004212 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
4213 ArrayRef<llvm::Value *> IdxList,
Vedant Kumar6dbf4272017-06-12 18:42:51 +00004214 bool SignedIndices,
Vedant Kumar175b6d12017-07-13 20:55:26 +00004215 bool IsSubtraction,
Vedant Kumara125eb52017-06-01 19:22:18 +00004216 SourceLocation Loc,
4217 const Twine &Name = "");
4218
Vedant Kumar10c31022017-07-29 00:19:51 +00004219 /// Specifies which type of sanitizer check to apply when handling a
4220 /// particular builtin.
4221 enum BuiltinCheckKind {
4222 BCK_CTZPassedZero,
4223 BCK_CLZPassedZero,
4224 };
4225
4226 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
4227 /// enabled, a runtime check specified by \p Kind is also emitted.
4228 llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
4229
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004230 /// Emit a description of a type in a format suitable for passing to
Richard Smithe30752c2012-10-09 19:52:38 +00004231 /// a runtime sanitizer handler.
4232 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
4233
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004234 /// Convert a value into a format suitable for passing to a runtime
Richard Smithe30752c2012-10-09 19:52:38 +00004235 /// sanitizer handler.
4236 llvm::Value *EmitCheckValue(llvm::Value *V);
4237
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004238 /// Emit a description of a source location in a format suitable for
Richard Smithe30752c2012-10-09 19:52:38 +00004239 /// passing to a runtime sanitizer handler.
4240 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
4241
Julian Lettnerb6c06dc2019-02-01 02:51:00 +00004242 /// Create a basic block that will either trap or call a handler function in
4243 /// the UBSan runtime with the provided arguments, and create a conditional
Richard Smithde670682012-11-01 22:15:34 +00004244 /// branch to it.
Peter Collingbourne3eea6772015-05-11 21:39:14 +00004245 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00004246 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
Alexey Samsonove396bfc2014-11-11 22:03:54 +00004247 ArrayRef<llvm::Value *> DynamicArgs);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004248
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004249 /// Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00004250 /// if Cond if false.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00004251 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
4252 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
4253 ArrayRef<llvm::Constant *> StaticArgs);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00004254
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004255 /// Emit a reached-unreachable diagnostic if \p Loc is valid and runtime
4256 /// checking is enabled. Otherwise, just emit an unreachable instruction.
4257 void EmitUnreachable(SourceLocation Loc);
4258
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004259 /// Create a basic block that will call the trap intrinsic, and emit a
Richard Smithde670682012-11-01 22:15:34 +00004260 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00004261 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00004262
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004263 /// Emit a call to trap or debugtrap and attach function attribute
Akira Hatanaka85365cd2015-07-02 22:15:41 +00004264 /// "trap-func-name" if specified.
4265 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
4266
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004267 /// Emit a stub for the cross-DSO CFI check function.
Evgeniy Stepanov1a8030e2017-04-07 23:00:38 +00004268 void EmitCfiCheckStub();
4269
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004270 /// Emit a cross-DSO CFI failure handling function.
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00004271 void EmitCfiCheckFail();
4272
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004273 /// Create a check for a function parameter that may potentially be
Nuno Lopes1ba2d782015-05-30 16:11:40 +00004274 /// declared as non-null.
4275 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00004276 AbstractCallee AC, unsigned ParmNum);
Nuno Lopes1ba2d782015-05-30 16:11:40 +00004277
Anders Carlsson093bdff2010-03-30 03:27:09 +00004278 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00004279 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00004280
John McCall23f66262010-05-26 22:34:26 +00004281 /// EmitDelegateCallArg - We are performing a delegate call; that
4282 /// is, the current function is delegating to another one. Produce
4283 /// a r-value suitable for passing the given parameter.
Nick Lewycky2d84e842013-10-02 02:29:49 +00004284 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
4285 SourceLocation loc);
John McCall23f66262010-05-26 22:34:26 +00004286
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00004287 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
4288 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00004289 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00004290
Melanie Blower7f9b5132019-12-04 12:23:46 -08004291 /// SetFPModel - Control floating point behavior via fp-model settings.
4292 void SetFPModel();
4293
Chris Lattnercd439292008-11-12 08:04:58 +00004294private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00004295 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00004296 void EmitReturnOfRValue(RValue RV, QualType Ty);
4297
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004298 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
4299
4300 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
4301 DeferredReplacements;
4302
John McCall7f416cc2015-09-08 08:05:57 +00004303 /// Set the address of a local variable.
4304 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
4305 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
4306 LocalDeclMap.insert({VD, Addr});
4307 }
4308
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004309 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
4310 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
4311 ///
4312 /// \param AI - The first function argument of the expansion.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004313 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
John McCall12f23522016-04-04 18:33:08 +00004314 SmallVectorImpl<llvm::Value *>::iterator &AI);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004315
Yaxun Liu5b330e82018-03-15 15:25:19 +00004316 /// ExpandTypeToArgs - Expand an CallArg \arg Arg, with the LLVM type for \arg
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004317 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
4318 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
Yaxun Liu5b330e82018-03-15 15:25:19 +00004319 void ExpandTypeToArgs(QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004320 SmallVectorImpl<llvm::Value *> &IRCallArgs,
4321 unsigned &IRCallArgPos);
Anders Carlsson03aaf112009-01-11 19:40:10 +00004322
Chad Rosier59df25b2012-08-23 20:00:18 +00004323 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00004324 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00004325
Chad Rosier59df25b2012-08-23 20:00:18 +00004326 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00004327 LValue InputValue, QualType InputType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00004328 std::string &ConstraintStr,
4329 SourceLocation Loc);
Eli Friedmaneca55af2010-07-16 00:55:21 +00004330
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004331 /// Attempts to statically evaluate the object size of E. If that
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004332 /// fails, emits code to figure the size of E out for us. This is
4333 /// pass_object_size aware.
George Burgess IV0d6592a2017-02-23 05:59:56 +00004334 ///
4335 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004336 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00004337 llvm::IntegerType *ResType,
Erik Pilkington9c3b5882019-01-30 20:34:53 +00004338 llvm::Value *EmittedE,
4339 bool IsDynamic);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004340
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004341 /// Emits the size of E, as required by __builtin_object_size. This
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004342 /// function is aware of pass_object_size parameters, and will act accordingly
4343 /// if E is a parameter with the pass_object_size attribute.
4344 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
George Burgess IV0d6592a2017-02-23 05:59:56 +00004345 llvm::IntegerType *ResType,
Erik Pilkington9c3b5882019-01-30 20:34:53 +00004346 llvm::Value *EmittedE,
4347 bool IsDynamic);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00004348
Vitaly Bukae7267662019-07-10 22:53:50 +00004349 void emitZeroOrPatternForAutoVarInit(QualType type, const VarDecl &D,
4350 Address Loc);
4351
Reid Kleckner89077a12013-12-17 19:46:40 +00004352public:
Douglas Gregore83b9562015-07-07 03:57:53 +00004353#ifndef NDEBUG
4354 // Determine whether the given argument is an Objective-C method
4355 // that may have type parameters in its signature.
4356 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
4357 const DeclContext *dc = method->getDeclContext();
4358 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
4359 return classDecl->getTypeParamListAsWritten();
4360 }
4361
4362 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
4363 return catDecl->getTypeParamList();
4364 }
4365
4366 return false;
4367 }
4368
4369 template<typename T>
4370 static bool isObjCMethodWithTypeParams(const T *) { return false; }
4371#endif
4372
Richard Smitha560ccf2016-09-29 21:30:12 +00004373 enum class EvaluationOrder {
4374 ///! No language constraints on evaluation order.
4375 Default,
4376 ///! Language semantics require left-to-right evaluation.
4377 ForceLeftToRight,
4378 ///! Language semantics require right-to-left evaluation.
4379 ForceRightToLeft
4380 };
4381
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00004382 /// EmitCallArgs - Emit call arguments for a function.
Reid Kleckner739756c2013-12-04 19:23:12 +00004383 template <typename T>
4384 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
David Blaikief05779e2015-07-21 18:37:18 +00004385 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00004386 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00004387 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00004388 EvaluationOrder Order = EvaluationOrder::Default) {
Reid Kleckner739756c2013-12-04 19:23:12 +00004389 SmallVector<QualType, 16> ArgTypes;
David Blaikief05779e2015-07-21 18:37:18 +00004390 CallExpr::const_arg_iterator Arg = ArgRange.begin();
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00004391
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004392 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
4393 "Can't skip parameters if type info is not provided");
4394 if (CallArgTypeInfo) {
Douglas Gregore83b9562015-07-07 03:57:53 +00004395#ifndef NDEBUG
4396 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
4397#endif
4398
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004399 // First, use the argument types that the type info knows about
4400 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
4401 E = CallArgTypeInfo->param_type_end();
4402 I != E; ++I, ++Arg) {
David Blaikief05779e2015-07-21 18:37:18 +00004403 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
Aaron Ballman7c04eae2015-07-07 13:25:57 +00004404 assert((isGenericMethod ||
4405 ((*I)->isVariablyModifiedType() ||
4406 (*I).getNonReferenceType()->isObjCRetainableType() ||
4407 getContext()
4408 .getCanonicalType((*I).getNonReferenceType())
4409 .getTypePtr() ==
4410 getContext()
Benjamin Kramerf48ee442015-07-18 14:35:53 +00004411 .getCanonicalType((*Arg)->getType())
Aaron Ballman7c04eae2015-07-07 13:25:57 +00004412 .getTypePtr())) &&
4413 "type mismatch in call argument!");
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004414 ArgTypes.push_back(*I);
4415 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00004416 }
Mike Stump11289f42009-09-09 15:08:12 +00004417
Reid Kleckner739756c2013-12-04 19:23:12 +00004418 // Either we've emitted all the call args, or we have a call to variadic
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00004419 // function.
David Blaikief05779e2015-07-21 18:37:18 +00004420 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
4421 CallArgTypeInfo->isVariadic()) &&
4422 "Extra arguments in non-variadic function!");
Reid Kleckner739756c2013-12-04 19:23:12 +00004423
Anders Carlsson603d6af2009-04-18 20:20:22 +00004424 // If we still have any arguments, emit them using the type of the argument.
David Blaikiefd7c2192015-07-21 18:59:10 +00004425 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
Reid Klecknerd2ad9df2017-01-03 21:23:35 +00004426 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
Adrian Prantlca64c3e2013-07-26 20:42:57 +00004427
Vedant Kumared00ea02017-03-06 05:28:22 +00004428 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
Anders Carlsson603d6af2009-04-18 20:20:22 +00004429 }
John McCalld4f4b7f2010-03-03 04:15:11 +00004430
Reid Kleckner739756c2013-12-04 19:23:12 +00004431 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
David Blaikief05779e2015-07-21 18:37:18 +00004432 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00004433 AbstractCallee AC = AbstractCallee(),
Richard Smith762672a2016-09-28 19:09:10 +00004434 unsigned ParamsToSkip = 0,
Richard Smitha560ccf2016-09-29 21:30:12 +00004435 EvaluationOrder Order = EvaluationOrder::Default);
Reid Kleckner739756c2013-12-04 19:23:12 +00004436
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00004437 /// EmitPointerWithAlignment - Given an expression with a pointer type,
4438 /// emit the value and compute our best estimate of the alignment of the
4439 /// pointee.
John McCall7f416cc2015-09-08 08:05:57 +00004440 ///
Krzysztof Parzyszek8b9897f2017-05-19 12:03:34 +00004441 /// \param BaseInfo - If non-null, this will be initialized with
4442 /// information about the source of the alignment and the may-alias
4443 /// attribute. Note that this function will conservatively fall back on
4444 /// the type when it doesn't recognize the expression and may-alias will
4445 /// be set to false.
4446 ///
4447 /// One reasonable way to use this information is when there's a language
4448 /// guarantee that the pointer must be aligned to some stricter value, and
4449 /// we're simply trying to ensure that sufficiently obvious uses of under-
4450 /// aligned objects don't get miscompiled; for example, a placement new
4451 /// into the address of a local variable. In such a case, it's quite
4452 /// reasonable to just ignore the returned alignment when it isn't from an
4453 /// explicit source.
John McCall7f416cc2015-09-08 08:05:57 +00004454 Address EmitPointerWithAlignment(const Expr *Addr,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +00004455 LValueBaseInfo *BaseInfo = nullptr,
4456 TBAAAccessInfo *TBAAInfo = nullptr);
John McCall7f416cc2015-09-08 08:05:57 +00004457
Vedant Kumar36347d92017-12-08 01:51:47 +00004458 /// If \p E references a parameter with pass_object_size info or a constant
4459 /// array size modifier, emit the object size divided by the size of \p EltTy.
4460 /// Otherwise return null.
4461 llvm::Value *LoadPassedObjectSize(const Expr *E, QualType EltTy);
4462
Peter Collingbournedc134532016-01-16 00:31:22 +00004463 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
4464
Erich Keanef353ae12018-09-13 16:58:24 +00004465 struct MultiVersionResolverOption {
Erich Keane281d20b2018-01-08 21:34:17 +00004466 llvm::Function *Function;
Erich Keane19a8adc2018-10-25 18:57:19 +00004467 FunctionDecl *FD;
Erich Keanef353ae12018-09-13 16:58:24 +00004468 struct Conds {
4469 StringRef Architecture;
4470 llvm::SmallVector<StringRef, 8> Features;
Erich Keane281d20b2018-01-08 21:34:17 +00004471
Erich Keanef353ae12018-09-13 16:58:24 +00004472 Conds(StringRef Arch, ArrayRef<StringRef> Feats)
4473 : Architecture(Arch), Features(Feats.begin(), Feats.end()) {}
4474 } Conditions;
Erich Keane281d20b2018-01-08 21:34:17 +00004475
Erich Keanef353ae12018-09-13 16:58:24 +00004476 MultiVersionResolverOption(llvm::Function *F, StringRef Arch,
4477 ArrayRef<StringRef> Feats)
4478 : Function(F), Conditions(Arch, Feats) {}
Erich Keane281d20b2018-01-08 21:34:17 +00004479 };
Erich Keanef353ae12018-09-13 16:58:24 +00004480
4481 // Emits the body of a multiversion function's resolver. Assumes that the
4482 // options are already sorted in the proper order, with the 'default' option
4483 // last (if it exists).
4484 void EmitMultiVersionResolver(llvm::Function *Resolver,
4485 ArrayRef<MultiVersionResolverOption> Options);
Erich Keane3efe0022018-07-20 14:13:28 +00004486
Craig Topper4d8ced12018-10-20 03:51:52 +00004487 static uint64_t GetX86CpuSupportsMask(ArrayRef<StringRef> FeatureStrs);
Erich Keane281d20b2018-01-08 21:34:17 +00004488
Reid Kleckner89077a12013-12-17 19:46:40 +00004489private:
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004490 QualType getVarArgType(const Expr *Arg);
4491
John McCall09ae0322010-07-06 23:57:41 +00004492 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00004493
John McCall7f416cc2015-09-08 08:05:57 +00004494 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
4495 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00004496
4497 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00004498
Saleem Abdulrasoola14ac3f42014-12-04 04:52:37 +00004499 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
Erich Keane9937b132017-09-01 19:42:45 +00004500 llvm::Value *EmitX86CpuIs(const CallExpr *E);
4501 llvm::Value *EmitX86CpuIs(StringRef CPUStr);
4502 llvm::Value *EmitX86CpuSupports(const CallExpr *E);
4503 llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
Craig Topper4d8ced12018-10-20 03:51:52 +00004504 llvm::Value *EmitX86CpuSupports(uint64_t Mask);
Erich Keane1fe643a2017-10-06 16:40:45 +00004505 llvm::Value *EmitX86CpuInit();
Erich Keanef353ae12018-09-13 16:58:24 +00004506 llvm::Value *FormResolverCondition(const MultiVersionResolverOption &RO);
Chris Lattnerbed31442007-05-28 01:07:47 +00004507};
Mike Stump11289f42009-09-09 15:08:12 +00004508
Richard Smithf66e4f72018-07-23 22:56:45 +00004509inline DominatingLLVMValue::saved_type
4510DominatingLLVMValue::save(CodeGenFunction &CGF, llvm::Value *value) {
4511 if (!needsSaving(value)) return saved_type(value, false);
John McCallce1de612011-01-26 04:00:11 +00004512
Richard Smithf66e4f72018-07-23 22:56:45 +00004513 // Otherwise, we need an alloca.
4514 auto align = CharUnits::fromQuantity(
4515 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
4516 Address alloca =
4517 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
4518 CGF.Builder.CreateStore(value, alloca);
John McCallce1de612011-01-26 04:00:11 +00004519
Richard Smithf66e4f72018-07-23 22:56:45 +00004520 return saved_type(alloca.getPointer(), true);
4521}
John McCallce1de612011-01-26 04:00:11 +00004522
Richard Smithf66e4f72018-07-23 22:56:45 +00004523inline llvm::Value *DominatingLLVMValue::restore(CodeGenFunction &CGF,
4524 saved_type value) {
4525 // If the value says it wasn't saved, trust that it's still dominating.
4526 if (!value.getInt()) return value.getPointer();
John McCallce1de612011-01-26 04:00:11 +00004527
Richard Smithf66e4f72018-07-23 22:56:45 +00004528 // Otherwise, it should be an alloca instruction, as set up in save().
4529 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
Guillaume Chatelet07c9d532020-01-27 10:37:01 +01004530 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlign());
Richard Smithf66e4f72018-07-23 22:56:45 +00004531}
John McCallce1de612011-01-26 04:00:11 +00004532
Chris Lattnerbed31442007-05-28 01:07:47 +00004533} // end namespace CodeGen
4534} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00004535
Chris Lattnerbed31442007-05-28 01:07:47 +00004536#endif