blob: ade036866653ce320dfba653db47afe2530a5bc2 [file] [log] [blame]
Hans Wennborgdcfba332015-10-06 23:40:43 +00001//===--- CGClass.cpp - Emit LLVM Code for C++ classes -----------*- C++ -*-===//
Anders Carlsson9a57c5a2009-09-12 04:27:24 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This contains code dealing with C++ code generation of classes
11//
12//===----------------------------------------------------------------------===//
13
Eli Friedman2495ab02012-02-25 02:48:22 +000014#include "CGBlocks.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000015#include "CGCXXABI.h"
Devang Pateld76c1db2010-08-11 21:04:37 +000016#include "CGDebugInfo.h"
Lang Hamesbf122742013-02-17 07:22:09 +000017#include "CGRecordLayout.h"
Anders Carlsson9a57c5a2009-09-12 04:27:24 +000018#include "CodeGenFunction.h"
Anders Carlssonc6d171e2009-10-06 22:43:30 +000019#include "clang/AST/CXXInheritance.h"
Faisal Vali571df122013-09-29 08:45:24 +000020#include "clang/AST/DeclTemplate.h"
John McCall769250e2010-09-17 02:31:44 +000021#include "clang/AST/EvaluatedExprVisitor.h"
Anders Carlsson9a57c5a2009-09-12 04:27:24 +000022#include "clang/AST/RecordLayout.h"
John McCallb81884d2010-02-19 09:25:03 +000023#include "clang/AST/StmtCXX.h"
Lang Hamesbf122742013-02-17 07:22:09 +000024#include "clang/Basic/TargetBuiltins.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000025#include "clang/CodeGen/CGFunctionInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000026#include "clang/Frontend/CodeGenOptions.h"
Peter Collingbournea4ccff32015-02-20 20:30:56 +000027#include "llvm/IR/Intrinsics.h"
Piotr Padlewski4b1ac722015-09-15 21:46:55 +000028#include "llvm/IR/Metadata.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000029#include "llvm/Transforms/Utils/SanitizerStats.h"
Anders Carlssonc6d171e2009-10-06 22:43:30 +000030
Anders Carlsson9a57c5a2009-09-12 04:27:24 +000031using namespace clang;
32using namespace CodeGen;
33
John McCall7f416cc2015-09-08 08:05:57 +000034/// Return the best known alignment for an unknown pointer to a
35/// particular class.
36CharUnits CodeGenModule::getClassPointerAlignment(const CXXRecordDecl *RD) {
37 if (!RD->isCompleteDefinition())
38 return CharUnits::One(); // Hopefully won't be used anywhere.
39
40 auto &layout = getContext().getASTRecordLayout(RD);
41
42 // If the class is final, then we know that the pointer points to an
43 // object of that type and can use the full alignment.
44 if (RD->hasAttr<FinalAttr>()) {
45 return layout.getAlignment();
46
47 // Otherwise, we have to assume it could be a subclass.
48 } else {
49 return layout.getNonVirtualAlignment();
50 }
51}
52
53/// Return the best known alignment for a pointer to a virtual base,
54/// given the alignment of a pointer to the derived class.
55CharUnits CodeGenModule::getVBaseAlignment(CharUnits actualDerivedAlign,
56 const CXXRecordDecl *derivedClass,
57 const CXXRecordDecl *vbaseClass) {
58 // The basic idea here is that an underaligned derived pointer might
59 // indicate an underaligned base pointer.
60
61 assert(vbaseClass->isCompleteDefinition());
62 auto &baseLayout = getContext().getASTRecordLayout(vbaseClass);
63 CharUnits expectedVBaseAlign = baseLayout.getNonVirtualAlignment();
64
65 return getDynamicOffsetAlignment(actualDerivedAlign, derivedClass,
66 expectedVBaseAlign);
67}
68
69CharUnits
70CodeGenModule::getDynamicOffsetAlignment(CharUnits actualBaseAlign,
71 const CXXRecordDecl *baseDecl,
72 CharUnits expectedTargetAlign) {
73 // If the base is an incomplete type (which is, alas, possible with
74 // member pointers), be pessimistic.
75 if (!baseDecl->isCompleteDefinition())
76 return std::min(actualBaseAlign, expectedTargetAlign);
77
78 auto &baseLayout = getContext().getASTRecordLayout(baseDecl);
79 CharUnits expectedBaseAlign = baseLayout.getNonVirtualAlignment();
80
81 // If the class is properly aligned, assume the target offset is, too.
82 //
83 // This actually isn't necessarily the right thing to do --- if the
84 // class is a complete object, but it's only properly aligned for a
85 // base subobject, then the alignments of things relative to it are
86 // probably off as well. (Note that this requires the alignment of
87 // the target to be greater than the NV alignment of the derived
88 // class.)
89 //
90 // However, our approach to this kind of under-alignment can only
91 // ever be best effort; after all, we're never going to propagate
92 // alignments through variables or parameters. Note, in particular,
93 // that constructing a polymorphic type in an address that's less
94 // than pointer-aligned will generally trap in the constructor,
95 // unless we someday add some sort of attribute to change the
96 // assumed alignment of 'this'. So our goal here is pretty much
97 // just to allow the user to explicitly say that a pointer is
Eric Christopherd160c502016-01-29 01:35:53 +000098 // under-aligned and then safely access its fields and vtables.
John McCall7f416cc2015-09-08 08:05:57 +000099 if (actualBaseAlign >= expectedBaseAlign) {
100 return expectedTargetAlign;
101 }
102
103 // Otherwise, we might be offset by an arbitrary multiple of the
104 // actual alignment. The correct adjustment is to take the min of
105 // the two alignments.
106 return std::min(actualBaseAlign, expectedTargetAlign);
107}
108
109Address CodeGenFunction::LoadCXXThisAddress() {
110 assert(CurFuncDecl && "loading 'this' without a func declaration?");
111 assert(isa<CXXMethodDecl>(CurFuncDecl));
112
113 // Lazily compute CXXThisAlignment.
114 if (CXXThisAlignment.isZero()) {
115 // Just use the best known alignment for the parent.
116 // TODO: if we're currently emitting a complete-object ctor/dtor,
117 // we can always use the complete-object alignment.
118 auto RD = cast<CXXMethodDecl>(CurFuncDecl)->getParent();
119 CXXThisAlignment = CGM.getClassPointerAlignment(RD);
120 }
121
122 return Address(LoadCXXThis(), CXXThisAlignment);
123}
124
125/// Emit the address of a field using a member data pointer.
126///
127/// \param E Only used for emergency diagnostics
128Address
129CodeGenFunction::EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
130 llvm::Value *memberPtr,
131 const MemberPointerType *memberPtrType,
Ivan A. Kosarev229a6d82017-10-13 16:38:32 +0000132 LValueBaseInfo *BaseInfo,
133 TBAAAccessInfo *TBAAInfo) {
John McCall7f416cc2015-09-08 08:05:57 +0000134 // Ask the ABI to compute the actual address.
135 llvm::Value *ptr =
136 CGM.getCXXABI().EmitMemberDataPointerAddress(*this, E, base,
137 memberPtr, memberPtrType);
138
139 QualType memberType = memberPtrType->getPointeeType();
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000140 CharUnits memberAlign = getNaturalTypeAlignment(memberType, BaseInfo,
141 TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +0000142 memberAlign =
143 CGM.getDynamicOffsetAlignment(base.getAlignment(),
144 memberPtrType->getClass()->getAsCXXRecordDecl(),
145 memberAlign);
146 return Address(ptr, memberAlign);
147}
148
David Majnemerc1709d32015-06-23 07:31:11 +0000149CharUnits CodeGenModule::computeNonVirtualBaseClassOffset(
150 const CXXRecordDecl *DerivedClass, CastExpr::path_const_iterator Start,
151 CastExpr::path_const_iterator End) {
Ken Dycka1a4ae32011-03-22 00:53:26 +0000152 CharUnits Offset = CharUnits::Zero();
Justin Bogner1cd11f12015-05-20 15:53:59 +0000153
David Majnemerc1709d32015-06-23 07:31:11 +0000154 const ASTContext &Context = getContext();
Anders Carlssond829a022010-04-24 21:06:20 +0000155 const CXXRecordDecl *RD = DerivedClass;
Justin Bogner1cd11f12015-05-20 15:53:59 +0000156
John McCallcf142162010-08-07 06:22:56 +0000157 for (CastExpr::path_const_iterator I = Start; I != End; ++I) {
Anders Carlssond829a022010-04-24 21:06:20 +0000158 const CXXBaseSpecifier *Base = *I;
159 assert(!Base->isVirtual() && "Should not see virtual bases here!");
160
161 // Get the layout.
162 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000163
164 const CXXRecordDecl *BaseDecl =
Anders Carlssond829a022010-04-24 21:06:20 +0000165 cast<CXXRecordDecl>(Base->getType()->getAs<RecordType>()->getDecl());
Justin Bogner1cd11f12015-05-20 15:53:59 +0000166
Anders Carlssond829a022010-04-24 21:06:20 +0000167 // Add the offset.
Ken Dycka1a4ae32011-03-22 00:53:26 +0000168 Offset += Layout.getBaseClassOffset(BaseDecl);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000169
Anders Carlssond829a022010-04-24 21:06:20 +0000170 RD = BaseDecl;
171 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000172
Ken Dycka1a4ae32011-03-22 00:53:26 +0000173 return Offset;
Anders Carlssond829a022010-04-24 21:06:20 +0000174}
Anders Carlsson9a57c5a2009-09-12 04:27:24 +0000175
Anders Carlsson9150a2a2009-09-29 03:13:20 +0000176llvm::Constant *
Anders Carlsson8a64c1c2010-04-24 21:23:59 +0000177CodeGenModule::GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl,
John McCallcf142162010-08-07 06:22:56 +0000178 CastExpr::path_const_iterator PathBegin,
179 CastExpr::path_const_iterator PathEnd) {
180 assert(PathBegin != PathEnd && "Base path should not be empty!");
Anders Carlsson8a64c1c2010-04-24 21:23:59 +0000181
Justin Bogner1cd11f12015-05-20 15:53:59 +0000182 CharUnits Offset =
David Majnemerc1709d32015-06-23 07:31:11 +0000183 computeNonVirtualBaseClassOffset(ClassDecl, PathBegin, PathEnd);
Ken Dycka1a4ae32011-03-22 00:53:26 +0000184 if (Offset.isZero())
Craig Topper8a13c412014-05-21 05:09:00 +0000185 return nullptr;
186
Justin Bogner1cd11f12015-05-20 15:53:59 +0000187 llvm::Type *PtrDiffTy =
Anders Carlsson8a64c1c2010-04-24 21:23:59 +0000188 Types.ConvertType(getContext().getPointerDiffType());
Justin Bogner1cd11f12015-05-20 15:53:59 +0000189
Ken Dycka1a4ae32011-03-22 00:53:26 +0000190 return llvm::ConstantInt::get(PtrDiffTy, Offset.getQuantity());
Anders Carlsson9150a2a2009-09-29 03:13:20 +0000191}
192
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +0000193/// Gets the address of a direct base class within a complete object.
John McCall6ce74722010-02-16 04:15:37 +0000194/// This should only be used for (1) non-virtual bases or (2) virtual bases
195/// when the type is known to be complete (e.g. in complete destructors).
196///
197/// The object pointed to by 'This' is assumed to be non-null.
John McCall7f416cc2015-09-08 08:05:57 +0000198Address
199CodeGenFunction::GetAddressOfDirectBaseInCompleteClass(Address This,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +0000200 const CXXRecordDecl *Derived,
201 const CXXRecordDecl *Base,
202 bool BaseIsVirtual) {
John McCall6ce74722010-02-16 04:15:37 +0000203 // 'this' must be a pointer (in some address space) to Derived.
John McCall7f416cc2015-09-08 08:05:57 +0000204 assert(This.getElementType() == ConvertType(Derived));
John McCall6ce74722010-02-16 04:15:37 +0000205
206 // Compute the offset of the virtual base.
Ken Dyck6aa767c2011-03-22 01:21:15 +0000207 CharUnits Offset;
John McCall6ce74722010-02-16 04:15:37 +0000208 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(Derived);
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +0000209 if (BaseIsVirtual)
Ken Dyck6aa767c2011-03-22 01:21:15 +0000210 Offset = Layout.getVBaseClassOffset(Base);
John McCall6ce74722010-02-16 04:15:37 +0000211 else
Ken Dyck6aa767c2011-03-22 01:21:15 +0000212 Offset = Layout.getBaseClassOffset(Base);
John McCall6ce74722010-02-16 04:15:37 +0000213
214 // Shift and cast down to the base type.
215 // TODO: for complete types, this should be possible with a GEP.
John McCall7f416cc2015-09-08 08:05:57 +0000216 Address V = This;
217 if (!Offset.isZero()) {
218 V = Builder.CreateElementBitCast(V, Int8Ty);
219 V = Builder.CreateConstInBoundsByteGEP(V, Offset);
John McCall6ce74722010-02-16 04:15:37 +0000220 }
John McCall7f416cc2015-09-08 08:05:57 +0000221 V = Builder.CreateElementBitCast(V, ConvertType(Base));
John McCall6ce74722010-02-16 04:15:37 +0000222
223 return V;
Anders Carlssone87fae92010-03-28 19:40:00 +0000224}
John McCall6ce74722010-02-16 04:15:37 +0000225
John McCall7f416cc2015-09-08 08:05:57 +0000226static Address
227ApplyNonVirtualAndVirtualOffset(CodeGenFunction &CGF, Address addr,
John McCall13a39c62012-08-01 05:04:58 +0000228 CharUnits nonVirtualOffset,
John McCall7f416cc2015-09-08 08:05:57 +0000229 llvm::Value *virtualOffset,
230 const CXXRecordDecl *derivedClass,
231 const CXXRecordDecl *nearestVBase) {
John McCall13a39c62012-08-01 05:04:58 +0000232 // Assert that we have something to do.
Craig Topper8a13c412014-05-21 05:09:00 +0000233 assert(!nonVirtualOffset.isZero() || virtualOffset != nullptr);
John McCall13a39c62012-08-01 05:04:58 +0000234
235 // Compute the offset from the static and dynamic components.
236 llvm::Value *baseOffset;
237 if (!nonVirtualOffset.isZero()) {
238 baseOffset = llvm::ConstantInt::get(CGF.PtrDiffTy,
239 nonVirtualOffset.getQuantity());
240 if (virtualOffset) {
241 baseOffset = CGF.Builder.CreateAdd(virtualOffset, baseOffset);
242 }
243 } else {
244 baseOffset = virtualOffset;
245 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000246
Anders Carlsson53cebd12010-04-20 16:03:35 +0000247 // Apply the base offset.
John McCall7f416cc2015-09-08 08:05:57 +0000248 llvm::Value *ptr = addr.getPointer();
John McCall13a39c62012-08-01 05:04:58 +0000249 ptr = CGF.Builder.CreateBitCast(ptr, CGF.Int8PtrTy);
250 ptr = CGF.Builder.CreateInBoundsGEP(ptr, baseOffset, "add.ptr");
John McCall7f416cc2015-09-08 08:05:57 +0000251
252 // If we have a virtual component, the alignment of the result will
253 // be relative only to the known alignment of that vbase.
254 CharUnits alignment;
255 if (virtualOffset) {
256 assert(nearestVBase && "virtual offset without vbase?");
257 alignment = CGF.CGM.getVBaseAlignment(addr.getAlignment(),
258 derivedClass, nearestVBase);
259 } else {
260 alignment = addr.getAlignment();
261 }
262 alignment = alignment.alignmentAtOffset(nonVirtualOffset);
263
264 return Address(ptr, alignment);
Anders Carlsson53cebd12010-04-20 16:03:35 +0000265}
266
John McCall7f416cc2015-09-08 08:05:57 +0000267Address CodeGenFunction::GetAddressOfBaseClass(
268 Address Value, const CXXRecordDecl *Derived,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000269 CastExpr::path_const_iterator PathBegin,
270 CastExpr::path_const_iterator PathEnd, bool NullCheckValue,
271 SourceLocation Loc) {
John McCallcf142162010-08-07 06:22:56 +0000272 assert(PathBegin != PathEnd && "Base path should not be empty!");
Anders Carlssond829a022010-04-24 21:06:20 +0000273
John McCallcf142162010-08-07 06:22:56 +0000274 CastExpr::path_const_iterator Start = PathBegin;
Craig Topper8a13c412014-05-21 05:09:00 +0000275 const CXXRecordDecl *VBase = nullptr;
276
John McCall13a39c62012-08-01 05:04:58 +0000277 // Sema has done some convenient canonicalization here: if the
278 // access path involved any virtual steps, the conversion path will
279 // *start* with a step down to the correct virtual base subobject,
280 // and hence will not require any further steps.
Anders Carlssond829a022010-04-24 21:06:20 +0000281 if ((*Start)->isVirtual()) {
Justin Bogner1cd11f12015-05-20 15:53:59 +0000282 VBase =
Anders Carlssond829a022010-04-24 21:06:20 +0000283 cast<CXXRecordDecl>((*Start)->getType()->getAs<RecordType>()->getDecl());
284 ++Start;
285 }
John McCall13a39c62012-08-01 05:04:58 +0000286
287 // Compute the static offset of the ultimate destination within its
288 // allocating subobject (the virtual base, if there is one, or else
289 // the "complete" object that we see).
David Majnemerc1709d32015-06-23 07:31:11 +0000290 CharUnits NonVirtualOffset = CGM.computeNonVirtualBaseClassOffset(
291 VBase ? VBase : Derived, Start, PathEnd);
Anders Carlssond829a022010-04-24 21:06:20 +0000292
John McCall13a39c62012-08-01 05:04:58 +0000293 // If there's a virtual step, we can sometimes "devirtualize" it.
294 // For now, that's limited to when the derived type is final.
295 // TODO: "devirtualize" this for accesses to known-complete objects.
296 if (VBase && Derived->hasAttr<FinalAttr>()) {
297 const ASTRecordLayout &layout = getContext().getASTRecordLayout(Derived);
298 CharUnits vBaseOffset = layout.getVBaseClassOffset(VBase);
299 NonVirtualOffset += vBaseOffset;
Craig Topper8a13c412014-05-21 05:09:00 +0000300 VBase = nullptr; // we no longer have a virtual step
John McCall13a39c62012-08-01 05:04:58 +0000301 }
302
Anders Carlssond829a022010-04-24 21:06:20 +0000303 // Get the base pointer type.
Justin Bogner1cd11f12015-05-20 15:53:59 +0000304 llvm::Type *BasePtrTy =
John McCallcf142162010-08-07 06:22:56 +0000305 ConvertType((PathEnd[-1])->getType())->getPointerTo();
John McCall13a39c62012-08-01 05:04:58 +0000306
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000307 QualType DerivedTy = getContext().getRecordType(Derived);
John McCall7f416cc2015-09-08 08:05:57 +0000308 CharUnits DerivedAlign = CGM.getClassPointerAlignment(Derived);
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000309
John McCall13a39c62012-08-01 05:04:58 +0000310 // If the static offset is zero and we don't have a virtual step,
311 // just do a bitcast; null checks are unnecessary.
Ken Dycka1a4ae32011-03-22 00:53:26 +0000312 if (NonVirtualOffset.isZero() && !VBase) {
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000313 if (sanitizePerformTypeCheck()) {
Vedant Kumar18348ea2017-02-17 23:22:55 +0000314 SanitizerSet SkippedChecks;
315 SkippedChecks.set(SanitizerKind::Null, !NullCheckValue);
John McCall7f416cc2015-09-08 08:05:57 +0000316 EmitTypeCheck(TCK_Upcast, Loc, Value.getPointer(),
Vedant Kumar18348ea2017-02-17 23:22:55 +0000317 DerivedTy, DerivedAlign, SkippedChecks);
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000318 }
Anders Carlssond829a022010-04-24 21:06:20 +0000319 return Builder.CreateBitCast(Value, BasePtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +0000320 }
John McCall13a39c62012-08-01 05:04:58 +0000321
Craig Topper8a13c412014-05-21 05:09:00 +0000322 llvm::BasicBlock *origBB = nullptr;
323 llvm::BasicBlock *endBB = nullptr;
324
John McCall13a39c62012-08-01 05:04:58 +0000325 // Skip over the offset (and the vtable load) if we're supposed to
326 // null-check the pointer.
Anders Carlssond829a022010-04-24 21:06:20 +0000327 if (NullCheckValue) {
John McCall13a39c62012-08-01 05:04:58 +0000328 origBB = Builder.GetInsertBlock();
329 llvm::BasicBlock *notNullBB = createBasicBlock("cast.notnull");
330 endBB = createBasicBlock("cast.end");
Justin Bogner1cd11f12015-05-20 15:53:59 +0000331
John McCall7f416cc2015-09-08 08:05:57 +0000332 llvm::Value *isNull = Builder.CreateIsNull(Value.getPointer());
John McCall13a39c62012-08-01 05:04:58 +0000333 Builder.CreateCondBr(isNull, endBB, notNullBB);
334 EmitBlock(notNullBB);
Anders Carlssond829a022010-04-24 21:06:20 +0000335 }
336
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000337 if (sanitizePerformTypeCheck()) {
Vedant Kumar18348ea2017-02-17 23:22:55 +0000338 SanitizerSet SkippedChecks;
339 SkippedChecks.set(SanitizerKind::Null, true);
John McCall7f416cc2015-09-08 08:05:57 +0000340 EmitTypeCheck(VBase ? TCK_UpcastToVirtualBase : TCK_Upcast, Loc,
Vedant Kumar18348ea2017-02-17 23:22:55 +0000341 Value.getPointer(), DerivedTy, DerivedAlign, SkippedChecks);
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000342 }
343
John McCall13a39c62012-08-01 05:04:58 +0000344 // Compute the virtual offset.
Craig Topper8a13c412014-05-21 05:09:00 +0000345 llvm::Value *VirtualOffset = nullptr;
Anders Carlssona376b532011-01-29 03:18:56 +0000346 if (VBase) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000347 VirtualOffset =
348 CGM.getCXXABI().GetVirtualBaseClassOffset(*this, Value, Derived, VBase);
Anders Carlssona376b532011-01-29 03:18:56 +0000349 }
Anders Carlssond829a022010-04-24 21:06:20 +0000350
John McCall13a39c62012-08-01 05:04:58 +0000351 // Apply both offsets.
John McCall7f416cc2015-09-08 08:05:57 +0000352 Value = ApplyNonVirtualAndVirtualOffset(*this, Value, NonVirtualOffset,
353 VirtualOffset, Derived, VBase);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000354
John McCall13a39c62012-08-01 05:04:58 +0000355 // Cast to the destination type.
Anders Carlssond829a022010-04-24 21:06:20 +0000356 Value = Builder.CreateBitCast(Value, BasePtrTy);
John McCall13a39c62012-08-01 05:04:58 +0000357
358 // Build a phi if we needed a null check.
Anders Carlssond829a022010-04-24 21:06:20 +0000359 if (NullCheckValue) {
John McCall13a39c62012-08-01 05:04:58 +0000360 llvm::BasicBlock *notNullBB = Builder.GetInsertBlock();
361 Builder.CreateBr(endBB);
362 EmitBlock(endBB);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000363
John McCall13a39c62012-08-01 05:04:58 +0000364 llvm::PHINode *PHI = Builder.CreatePHI(BasePtrTy, 2, "cast.result");
John McCall7f416cc2015-09-08 08:05:57 +0000365 PHI->addIncoming(Value.getPointer(), notNullBB);
John McCall13a39c62012-08-01 05:04:58 +0000366 PHI->addIncoming(llvm::Constant::getNullValue(BasePtrTy), origBB);
John McCall7f416cc2015-09-08 08:05:57 +0000367 Value = Address(PHI, Value.getAlignment());
Anders Carlssond829a022010-04-24 21:06:20 +0000368 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000369
Anders Carlssond829a022010-04-24 21:06:20 +0000370 return Value;
371}
372
John McCall7f416cc2015-09-08 08:05:57 +0000373Address
374CodeGenFunction::GetAddressOfDerivedClass(Address BaseAddr,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +0000375 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +0000376 CastExpr::path_const_iterator PathBegin,
377 CastExpr::path_const_iterator PathEnd,
Anders Carlsson8c793172009-11-23 17:57:54 +0000378 bool NullCheckValue) {
John McCallcf142162010-08-07 06:22:56 +0000379 assert(PathBegin != PathEnd && "Base path should not be empty!");
Anders Carlsson8a64c1c2010-04-24 21:23:59 +0000380
Anders Carlsson8c793172009-11-23 17:57:54 +0000381 QualType DerivedTy =
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +0000382 getContext().getCanonicalType(getContext().getTagDeclType(Derived));
Chris Lattner2192fe52011-07-18 04:24:23 +0000383 llvm::Type *DerivedPtrTy = ConvertType(DerivedTy)->getPointerTo();
Richard Smith2c5868c2013-02-13 21:18:23 +0000384
Anders Carlsson600f7372010-01-31 01:43:37 +0000385 llvm::Value *NonVirtualOffset =
John McCallcf142162010-08-07 06:22:56 +0000386 CGM.GetNonVirtualBaseClassOffset(Derived, PathBegin, PathEnd);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000387
Anders Carlsson600f7372010-01-31 01:43:37 +0000388 if (!NonVirtualOffset) {
389 // No offset, we can just cast back.
John McCall7f416cc2015-09-08 08:05:57 +0000390 return Builder.CreateBitCast(BaseAddr, DerivedPtrTy);
Anders Carlsson600f7372010-01-31 01:43:37 +0000391 }
Craig Topper8a13c412014-05-21 05:09:00 +0000392
393 llvm::BasicBlock *CastNull = nullptr;
394 llvm::BasicBlock *CastNotNull = nullptr;
395 llvm::BasicBlock *CastEnd = nullptr;
396
Anders Carlsson8c793172009-11-23 17:57:54 +0000397 if (NullCheckValue) {
398 CastNull = createBasicBlock("cast.null");
399 CastNotNull = createBasicBlock("cast.notnull");
400 CastEnd = createBasicBlock("cast.end");
Justin Bogner1cd11f12015-05-20 15:53:59 +0000401
John McCall7f416cc2015-09-08 08:05:57 +0000402 llvm::Value *IsNull = Builder.CreateIsNull(BaseAddr.getPointer());
Anders Carlsson8c793172009-11-23 17:57:54 +0000403 Builder.CreateCondBr(IsNull, CastNull, CastNotNull);
404 EmitBlock(CastNotNull);
405 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000406
Anders Carlsson600f7372010-01-31 01:43:37 +0000407 // Apply the offset.
John McCall7f416cc2015-09-08 08:05:57 +0000408 llvm::Value *Value = Builder.CreateBitCast(BaseAddr.getPointer(), Int8PtrTy);
Sanjay Patel372c3f12018-01-19 15:14:51 +0000409 Value = Builder.CreateInBoundsGEP(Value, Builder.CreateNeg(NonVirtualOffset),
410 "sub.ptr");
Anders Carlsson600f7372010-01-31 01:43:37 +0000411
412 // Just cast.
413 Value = Builder.CreateBitCast(Value, DerivedPtrTy);
Anders Carlsson8c793172009-11-23 17:57:54 +0000414
John McCall7f416cc2015-09-08 08:05:57 +0000415 // Produce a PHI if we had a null-check.
Anders Carlsson8c793172009-11-23 17:57:54 +0000416 if (NullCheckValue) {
417 Builder.CreateBr(CastEnd);
418 EmitBlock(CastNull);
419 Builder.CreateBr(CastEnd);
420 EmitBlock(CastEnd);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000421
Jay Foad20c0f022011-03-30 11:28:58 +0000422 llvm::PHINode *PHI = Builder.CreatePHI(Value->getType(), 2);
Anders Carlsson8c793172009-11-23 17:57:54 +0000423 PHI->addIncoming(Value, CastNotNull);
John McCall7f416cc2015-09-08 08:05:57 +0000424 PHI->addIncoming(llvm::Constant::getNullValue(Value->getType()), CastNull);
Anders Carlsson8c793172009-11-23 17:57:54 +0000425 Value = PHI;
426 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000427
John McCall7f416cc2015-09-08 08:05:57 +0000428 return Address(Value, CGM.getClassPointerAlignment(Derived));
Anders Carlsson9a57c5a2009-09-12 04:27:24 +0000429}
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000430
431llvm::Value *CodeGenFunction::GetVTTParameter(GlobalDecl GD,
432 bool ForVirtualBase,
433 bool Delegating) {
Peter Collingbourne66f82e62013-06-28 20:45:28 +0000434 if (!CGM.getCXXABI().NeedsVTTParameter(GD)) {
Anders Carlssone36a6b32010-01-02 01:01:18 +0000435 // This constructor/destructor does not need a VTT parameter.
Craig Topper8a13c412014-05-21 05:09:00 +0000436 return nullptr;
Anders Carlssone36a6b32010-01-02 01:01:18 +0000437 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000438
John McCalldec348f72013-05-03 07:33:41 +0000439 const CXXRecordDecl *RD = cast<CXXMethodDecl>(CurCodeDecl)->getParent();
Anders Carlssone36a6b32010-01-02 01:01:18 +0000440 const CXXRecordDecl *Base = cast<CXXMethodDecl>(GD.getDecl())->getParent();
John McCall5c60a6f2010-02-18 19:59:28 +0000441
Anders Carlssone36a6b32010-01-02 01:01:18 +0000442 llvm::Value *VTT;
443
John McCall5c60a6f2010-02-18 19:59:28 +0000444 uint64_t SubVTTIndex;
445
Douglas Gregor61535002013-01-31 05:50:40 +0000446 if (Delegating) {
447 // If this is a delegating constructor call, just load the VTT.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000448 return LoadCXXVTT();
Douglas Gregor61535002013-01-31 05:50:40 +0000449 } else if (RD == Base) {
450 // If the record matches the base, this is the complete ctor/dtor
451 // variant calling the base variant in a class with virtual bases.
Peter Collingbourne66f82e62013-06-28 20:45:28 +0000452 assert(!CGM.getCXXABI().NeedsVTTParameter(CurGD) &&
John McCall5c60a6f2010-02-18 19:59:28 +0000453 "doing no-op VTT offset in base dtor/ctor?");
Anders Carlsson4d205ba2010-05-02 23:33:10 +0000454 assert(!ForVirtualBase && "Can't have same class as virtual base!");
John McCall5c60a6f2010-02-18 19:59:28 +0000455 SubVTTIndex = 0;
456 } else {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000457 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000458 CharUnits BaseOffset = ForVirtualBase ?
459 Layout.getVBaseClassOffset(Base) :
Ken Dyck16ffcac2011-03-24 01:21:01 +0000460 Layout.getBaseClassOffset(Base);
Anders Carlsson859b3062010-05-02 23:53:25 +0000461
Justin Bogner1cd11f12015-05-20 15:53:59 +0000462 SubVTTIndex =
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000463 CGM.getVTables().getSubVTTIndex(RD, BaseSubobject(Base, BaseOffset));
John McCall5c60a6f2010-02-18 19:59:28 +0000464 assert(SubVTTIndex != 0 && "Sub-VTT index must be greater than zero!");
465 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000466
Peter Collingbourne66f82e62013-06-28 20:45:28 +0000467 if (CGM.getCXXABI().NeedsVTTParameter(CurGD)) {
Anders Carlssone36a6b32010-01-02 01:01:18 +0000468 // A VTT parameter was passed to the constructor, use it.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000469 VTT = LoadCXXVTT();
470 VTT = Builder.CreateConstInBoundsGEP1_64(VTT, SubVTTIndex);
Anders Carlssone36a6b32010-01-02 01:01:18 +0000471 } else {
472 // We're the complete constructor, so get the VTT by name.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000473 VTT = CGM.getVTables().GetAddrOfVTT(RD);
474 VTT = Builder.CreateConstInBoundsGEP2_64(VTT, 0, SubVTTIndex);
Anders Carlssone36a6b32010-01-02 01:01:18 +0000475 }
476
477 return VTT;
478}
479
John McCall1d987562010-07-21 01:23:41 +0000480namespace {
John McCallf99a6312010-07-21 05:30:47 +0000481 /// Call the destructor for a direct base class.
David Blaikie7e70d682015-08-18 22:40:54 +0000482 struct CallBaseDtor final : EHScopeStack::Cleanup {
John McCallf99a6312010-07-21 05:30:47 +0000483 const CXXRecordDecl *BaseClass;
484 bool BaseIsVirtual;
485 CallBaseDtor(const CXXRecordDecl *Base, bool BaseIsVirtual)
486 : BaseClass(Base), BaseIsVirtual(BaseIsVirtual) {}
John McCall1d987562010-07-21 01:23:41 +0000487
Craig Topper4f12f102014-03-12 06:41:41 +0000488 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallf99a6312010-07-21 05:30:47 +0000489 const CXXRecordDecl *DerivedClass =
490 cast<CXXMethodDecl>(CGF.CurCodeDecl)->getParent();
491
492 const CXXDestructorDecl *D = BaseClass->getDestructor();
John McCall7f416cc2015-09-08 08:05:57 +0000493 Address Addr =
494 CGF.GetAddressOfDirectBaseInCompleteClass(CGF.LoadCXXThisAddress(),
John McCallf99a6312010-07-21 05:30:47 +0000495 DerivedClass, BaseClass,
496 BaseIsVirtual);
Douglas Gregor61535002013-01-31 05:50:40 +0000497 CGF.EmitCXXDestructorCall(D, Dtor_Base, BaseIsVirtual,
498 /*Delegating=*/false, Addr);
John McCall1d987562010-07-21 01:23:41 +0000499 }
500 };
John McCall769250e2010-09-17 02:31:44 +0000501
502 /// A visitor which checks whether an initializer uses 'this' in a
503 /// way which requires the vtable to be properly set.
Scott Douglass503fc392015-06-10 13:53:15 +0000504 struct DynamicThisUseChecker : ConstEvaluatedExprVisitor<DynamicThisUseChecker> {
505 typedef ConstEvaluatedExprVisitor<DynamicThisUseChecker> super;
John McCall769250e2010-09-17 02:31:44 +0000506
507 bool UsesThis;
508
Scott Douglass503fc392015-06-10 13:53:15 +0000509 DynamicThisUseChecker(const ASTContext &C) : super(C), UsesThis(false) {}
John McCall769250e2010-09-17 02:31:44 +0000510
511 // Black-list all explicit and implicit references to 'this'.
512 //
513 // Do we need to worry about external references to 'this' derived
514 // from arbitrary code? If so, then anything which runs arbitrary
515 // external code might potentially access the vtable.
Scott Douglass503fc392015-06-10 13:53:15 +0000516 void VisitCXXThisExpr(const CXXThisExpr *E) { UsesThis = true; }
John McCall769250e2010-09-17 02:31:44 +0000517 };
Hans Wennborgdcfba332015-10-06 23:40:43 +0000518} // end anonymous namespace
John McCall769250e2010-09-17 02:31:44 +0000519
520static bool BaseInitializerUsesThis(ASTContext &C, const Expr *Init) {
521 DynamicThisUseChecker Checker(C);
Scott Douglass503fc392015-06-10 13:53:15 +0000522 Checker.Visit(Init);
John McCall769250e2010-09-17 02:31:44 +0000523 return Checker.UsesThis;
John McCall1d987562010-07-21 01:23:41 +0000524}
525
Justin Bogner1cd11f12015-05-20 15:53:59 +0000526static void EmitBaseInitializer(CodeGenFunction &CGF,
Anders Carlssonfb404882009-12-24 22:46:43 +0000527 const CXXRecordDecl *ClassDecl,
Alexis Hunt1d792652011-01-08 20:30:50 +0000528 CXXCtorInitializer *BaseInit,
Anders Carlssonfb404882009-12-24 22:46:43 +0000529 CXXCtorType CtorType) {
530 assert(BaseInit->isBaseInitializer() &&
531 "Must have base initializer!");
532
John McCall7f416cc2015-09-08 08:05:57 +0000533 Address ThisPtr = CGF.LoadCXXThisAddress();
Justin Bogner1cd11f12015-05-20 15:53:59 +0000534
Anders Carlssonfb404882009-12-24 22:46:43 +0000535 const Type *BaseType = BaseInit->getBaseClass();
536 CXXRecordDecl *BaseClassDecl =
537 cast<CXXRecordDecl>(BaseType->getAs<RecordType>()->getDecl());
538
Anders Carlsson1c0f8bb2010-04-12 00:51:03 +0000539 bool isBaseVirtual = BaseInit->isBaseVirtual();
Anders Carlssonfb404882009-12-24 22:46:43 +0000540
541 // The base constructor doesn't construct virtual bases.
542 if (CtorType == Ctor_Base && isBaseVirtual)
543 return;
544
John McCall769250e2010-09-17 02:31:44 +0000545 // If the initializer for the base (other than the constructor
546 // itself) accesses 'this' in any way, we need to initialize the
547 // vtables.
548 if (BaseInitializerUsesThis(CGF.getContext(), BaseInit->getInit()))
549 CGF.InitializeVTablePointers(ClassDecl);
550
John McCall6ce74722010-02-16 04:15:37 +0000551 // We can pretend to be a complete class because it only matters for
552 // virtual bases, and we only do virtual bases for complete ctors.
John McCall7f416cc2015-09-08 08:05:57 +0000553 Address V =
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +0000554 CGF.GetAddressOfDirectBaseInCompleteClass(ThisPtr, ClassDecl,
John McCallf99a6312010-07-21 05:30:47 +0000555 BaseClassDecl,
556 isBaseVirtual);
John McCall8d6fc952011-08-25 20:40:09 +0000557 AggValueSlot AggSlot =
Richard Smithe78fac52018-04-05 20:52:58 +0000558 AggValueSlot::forAddr(
559 V, Qualifiers(),
560 AggValueSlot::IsDestructed,
561 AggValueSlot::DoesNotNeedGCBarriers,
562 AggValueSlot::IsNotAliased,
563 CGF.overlapForBaseInit(ClassDecl, BaseClassDecl, isBaseVirtual));
John McCall7a626f62010-09-15 10:14:12 +0000564
565 CGF.EmitAggExpr(BaseInit->getInit(), AggSlot);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000566
567 if (CGF.CGM.getLangOpts().Exceptions &&
Anders Carlsson08ce5ed2011-02-20 00:20:27 +0000568 !BaseClassDecl->hasTrivialDestructor())
John McCallcda666c2010-07-21 07:22:38 +0000569 CGF.EHStack.pushCleanup<CallBaseDtor>(EHCleanup, BaseClassDecl,
570 isBaseVirtual);
Anders Carlssonfb404882009-12-24 22:46:43 +0000571}
572
Richard Smith419bd092015-04-29 19:26:57 +0000573static bool isMemcpyEquivalentSpecialMember(const CXXMethodDecl *D) {
574 auto *CD = dyn_cast<CXXConstructorDecl>(D);
575 if (!(CD && CD->isCopyOrMoveConstructor()) &&
576 !D->isCopyAssignmentOperator() && !D->isMoveAssignmentOperator())
577 return false;
578
579 // We can emit a memcpy for a trivial copy or move constructor/assignment.
580 if (D->isTrivial() && !D->getParent()->mayInsertExtraPadding())
581 return true;
582
583 // We *must* emit a memcpy for a defaulted union copy or move op.
584 if (D->getParent()->isUnion() && D->isDefaulted())
585 return true;
586
587 return false;
588}
589
Alexey Bataev152c71f2015-07-14 07:55:48 +0000590static void EmitLValueForAnyFieldInitialization(CodeGenFunction &CGF,
591 CXXCtorInitializer *MemberInit,
592 LValue &LHS) {
593 FieldDecl *Field = MemberInit->getAnyMember();
594 if (MemberInit->isIndirectMemberInitializer()) {
595 // If we are initializing an anonymous union field, drill down to the field.
596 IndirectFieldDecl *IndirectField = MemberInit->getIndirectMember();
597 for (const auto *I : IndirectField->chain())
598 LHS = CGF.EmitLValueForFieldInitialization(LHS, cast<FieldDecl>(I));
599 } else {
600 LHS = CGF.EmitLValueForFieldInitialization(LHS, Field);
601 }
602}
603
Anders Carlssonfb404882009-12-24 22:46:43 +0000604static void EmitMemberInitializer(CodeGenFunction &CGF,
605 const CXXRecordDecl *ClassDecl,
Alexis Hunt1d792652011-01-08 20:30:50 +0000606 CXXCtorInitializer *MemberInit,
Douglas Gregor94f9a482010-05-05 05:51:00 +0000607 const CXXConstructorDecl *Constructor,
608 FunctionArgList &Args) {
David Blaikiea81d4102015-01-18 00:12:58 +0000609 ApplyDebugLocation Loc(CGF, MemberInit->getSourceLocation());
Francois Pichetd583da02010-12-04 09:14:42 +0000610 assert(MemberInit->isAnyMemberInitializer() &&
Anders Carlssonfb404882009-12-24 22:46:43 +0000611 "Must have member initializer!");
Richard Smith938f40b2011-06-11 17:19:42 +0000612 assert(MemberInit->getInit() && "Must have initializer!");
Justin Bogner1cd11f12015-05-20 15:53:59 +0000613
Anders Carlssonfb404882009-12-24 22:46:43 +0000614 // non-static data member initializers.
Francois Pichetd583da02010-12-04 09:14:42 +0000615 FieldDecl *Field = MemberInit->getAnyMember();
Eli Friedman6ae63022012-02-14 02:15:49 +0000616 QualType FieldType = Field->getType();
Anders Carlssonfb404882009-12-24 22:46:43 +0000617
618 llvm::Value *ThisPtr = CGF.LoadCXXThis();
Eli Friedman7f1ff602012-04-16 03:54:45 +0000619 QualType RecordTy = CGF.getContext().getTypeDeclType(ClassDecl);
Akira Hatanakae5dbb642018-01-27 00:34:09 +0000620 LValue LHS;
621
622 // If a base constructor is being emitted, create an LValue that has the
623 // non-virtual alignment.
624 if (CGF.CurGD.getCtorType() == Ctor_Base)
625 LHS = CGF.MakeNaturalAlignPointeeAddrLValue(ThisPtr, RecordTy);
626 else
627 LHS = CGF.MakeNaturalAlignAddrLValue(ThisPtr, RecordTy);
Eli Friedman7f1ff602012-04-16 03:54:45 +0000628
Alexey Bataev152c71f2015-07-14 07:55:48 +0000629 EmitLValueForAnyFieldInitialization(CGF, MemberInit, LHS);
Anders Carlssonfb404882009-12-24 22:46:43 +0000630
Eli Friedman6ae63022012-02-14 02:15:49 +0000631 // Special case: if we are in a copy or move constructor, and we are copying
632 // an array of PODs or classes with trivial copy constructors, ignore the
633 // AST and perform the copy we know is equivalent.
634 // FIXME: This is hacky at best... if we had a bit more explicit information
635 // in the AST, we could generalize it more easily.
636 const ConstantArrayType *Array
637 = CGF.getContext().getAsConstantArrayType(FieldType);
Jordan Rose54533f72013-08-07 16:16:48 +0000638 if (Array && Constructor->isDefaulted() &&
Eli Friedman6ae63022012-02-14 02:15:49 +0000639 Constructor->isCopyOrMoveConstructor()) {
640 QualType BaseElementTy = CGF.getContext().getBaseElementType(Array);
Richard Smith993f25a2012-11-07 23:56:21 +0000641 CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(MemberInit->getInit());
Eli Friedman6ae63022012-02-14 02:15:49 +0000642 if (BaseElementTy.isPODType(CGF.getContext()) ||
Richard Smith419bd092015-04-29 19:26:57 +0000643 (CE && isMemcpyEquivalentSpecialMember(CE->getConstructor()))) {
David Majnemer1573d732014-10-15 04:54:54 +0000644 unsigned SrcArgIndex =
645 CGF.CGM.getCXXABI().getSrcArgforCopyCtor(Constructor, Args);
Eli Friedman6ae63022012-02-14 02:15:49 +0000646 llvm::Value *SrcPtr
647 = CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(Args[SrcArgIndex]));
Eli Friedman7f1ff602012-04-16 03:54:45 +0000648 LValue ThisRHSLV = CGF.MakeNaturalAlignAddrLValue(SrcPtr, RecordTy);
649 LValue Src = CGF.EmitLValueForFieldInitialization(ThisRHSLV, Field);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000650
Eli Friedman6ae63022012-02-14 02:15:49 +0000651 // Copy the aggregate.
Richard Smithe78fac52018-04-05 20:52:58 +0000652 CGF.EmitAggregateCopy(LHS, Src, FieldType, CGF.overlapForFieldInit(Field),
653 LHS.isVolatileQualified());
Alexey Bataev5d49b832015-07-08 07:31:02 +0000654 // Ensure that we destroy the objects if an exception is thrown later in
655 // the constructor.
656 QualType::DestructionKind dtorKind = FieldType.isDestructedType();
657 if (CGF.needsEHCleanup(dtorKind))
Fangrui Song6907ce22018-07-30 19:24:48 +0000658 CGF.pushEHDestroy(dtorKind, LHS.getAddress(), FieldType);
Eli Friedman6ae63022012-02-14 02:15:49 +0000659 return;
660 }
661 }
662
Richard Smith30e304e2016-12-14 00:03:17 +0000663 CGF.EmitInitializerForField(Field, LHS, MemberInit->getInit());
Eli Friedman6ae63022012-02-14 02:15:49 +0000664}
665
John McCall7f416cc2015-09-08 08:05:57 +0000666void CodeGenFunction::EmitInitializerForField(FieldDecl *Field, LValue LHS,
Richard Smith30e304e2016-12-14 00:03:17 +0000667 Expr *Init) {
Eli Friedman6ae63022012-02-14 02:15:49 +0000668 QualType FieldType = Field->getType();
John McCall47fb9502013-03-07 21:37:08 +0000669 switch (getEvaluationKind(FieldType)) {
670 case TEK_Scalar:
John McCall31168b02011-06-15 23:02:42 +0000671 if (LHS.isSimple()) {
David Blaikie66e41972015-01-14 07:38:27 +0000672 EmitExprAsInit(Init, Field, LHS, false);
John McCall31168b02011-06-15 23:02:42 +0000673 } else {
Eli Friedman5f1a04f2012-02-14 02:31:03 +0000674 RValue RHS = RValue::get(EmitScalarExpr(Init));
675 EmitStoreThroughLValue(RHS, LHS);
John McCall31168b02011-06-15 23:02:42 +0000676 }
John McCall47fb9502013-03-07 21:37:08 +0000677 break;
678 case TEK_Complex:
David Blaikie66e41972015-01-14 07:38:27 +0000679 EmitComplexExprIntoLValue(Init, LHS, /*isInit*/ true);
John McCall47fb9502013-03-07 21:37:08 +0000680 break;
681 case TEK_Aggregate: {
Richard Smith30e304e2016-12-14 00:03:17 +0000682 AggValueSlot Slot =
Richard Smithe78fac52018-04-05 20:52:58 +0000683 AggValueSlot::forLValue(
684 LHS,
685 AggValueSlot::IsDestructed,
686 AggValueSlot::DoesNotNeedGCBarriers,
687 AggValueSlot::IsNotAliased,
Serge Pavlov37605182018-07-28 15:33:03 +0000688 overlapForFieldInit(Field),
689 AggValueSlot::IsNotZeroed,
690 // Checks are made by the code that calls constructor.
691 AggValueSlot::IsSanitizerChecked);
Richard Smith30e304e2016-12-14 00:03:17 +0000692 EmitAggExpr(Init, Slot);
693 break;
Anders Carlssonfb404882009-12-24 22:46:43 +0000694 }
John McCall47fb9502013-03-07 21:37:08 +0000695 }
John McCall12cc42a2013-02-01 05:11:40 +0000696
697 // Ensure that we destroy this object if an exception is thrown
698 // later in the constructor.
699 QualType::DestructionKind dtorKind = FieldType.isDestructedType();
700 if (needsEHCleanup(dtorKind))
701 pushEHDestroy(dtorKind, LHS.getAddress(), FieldType);
Anders Carlssonfb404882009-12-24 22:46:43 +0000702}
703
John McCallf8ff7b92010-02-23 00:48:20 +0000704/// Checks whether the given constructor is a valid subject for the
705/// complete-to-base constructor delegation optimization, i.e.
706/// emitting the complete constructor as a simple call to the base
707/// constructor.
Vedant Kumar7f809b22017-02-24 01:15:19 +0000708bool CodeGenFunction::IsConstructorDelegationValid(
709 const CXXConstructorDecl *Ctor) {
John McCallf8ff7b92010-02-23 00:48:20 +0000710
711 // Currently we disable the optimization for classes with virtual
712 // bases because (1) the addresses of parameter variables need to be
713 // consistent across all initializers but (2) the delegate function
714 // call necessarily creates a second copy of the parameter variable.
715 //
716 // The limiting example (purely theoretical AFAIK):
717 // struct A { A(int &c) { c++; } };
718 // struct B : virtual A {
719 // B(int count) : A(count) { printf("%d\n", count); }
720 // };
721 // ...although even this example could in principle be emitted as a
722 // delegation since the address of the parameter doesn't escape.
723 if (Ctor->getParent()->getNumVBases()) {
724 // TODO: white-list trivial vbase initializers. This case wouldn't
725 // be subject to the restrictions below.
726
727 // TODO: white-list cases where:
728 // - there are no non-reference parameters to the constructor
729 // - the initializers don't access any non-reference parameters
730 // - the initializers don't take the address of non-reference
731 // parameters
732 // - etc.
733 // If we ever add any of the above cases, remember that:
734 // - function-try-blocks will always blacklist this optimization
735 // - we need to perform the constructor prologue and cleanup in
736 // EmitConstructorBody.
737
738 return false;
739 }
740
741 // We also disable the optimization for variadic functions because
742 // it's impossible to "re-pass" varargs.
743 if (Ctor->getType()->getAs<FunctionProtoType>()->isVariadic())
744 return false;
745
Alexis Hunt61bc1732011-05-01 07:04:31 +0000746 // FIXME: Decide if we can do a delegation of a delegating constructor.
747 if (Ctor->isDelegatingConstructor())
748 return false;
749
John McCallf8ff7b92010-02-23 00:48:20 +0000750 return true;
751}
752
Kostya Serebryany293dc9b2014-10-16 20:54:52 +0000753// Emit code in ctor (Prologue==true) or dtor (Prologue==false)
754// to poison the extra field paddings inserted under
755// -fsanitize-address-field-padding=1|2.
756void CodeGenFunction::EmitAsanPrologueOrEpilogue(bool Prologue) {
757 ASTContext &Context = getContext();
758 const CXXRecordDecl *ClassDecl =
759 Prologue ? cast<CXXConstructorDecl>(CurGD.getDecl())->getParent()
760 : cast<CXXDestructorDecl>(CurGD.getDecl())->getParent();
761 if (!ClassDecl->mayInsertExtraPadding()) return;
762
763 struct SizeAndOffset {
764 uint64_t Size;
765 uint64_t Offset;
766 };
767
768 unsigned PtrSize = CGM.getDataLayout().getPointerSizeInBits();
769 const ASTRecordLayout &Info = Context.getASTRecordLayout(ClassDecl);
770
771 // Populate sizes and offsets of fields.
772 SmallVector<SizeAndOffset, 16> SSV(Info.getFieldCount());
773 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i)
774 SSV[i].Offset =
775 Context.toCharUnitsFromBits(Info.getFieldOffset(i)).getQuantity();
776
777 size_t NumFields = 0;
778 for (const auto *Field : ClassDecl->fields()) {
779 const FieldDecl *D = Field;
780 std::pair<CharUnits, CharUnits> FieldInfo =
781 Context.getTypeInfoInChars(D->getType());
782 CharUnits FieldSize = FieldInfo.first;
783 assert(NumFields < SSV.size());
784 SSV[NumFields].Size = D->isBitField() ? 0 : FieldSize.getQuantity();
785 NumFields++;
786 }
787 assert(NumFields == SSV.size());
788 if (SSV.size() <= 1) return;
789
790 // We will insert calls to __asan_* run-time functions.
791 // LLVM AddressSanitizer pass may decide to inline them later.
792 llvm::Type *Args[2] = {IntPtrTy, IntPtrTy};
793 llvm::FunctionType *FTy =
794 llvm::FunctionType::get(CGM.VoidTy, Args, false);
795 llvm::Constant *F = CGM.CreateRuntimeFunction(
796 FTy, Prologue ? "__asan_poison_intra_object_redzone"
797 : "__asan_unpoison_intra_object_redzone");
798
799 llvm::Value *ThisPtr = LoadCXXThis();
800 ThisPtr = Builder.CreatePtrToInt(ThisPtr, IntPtrTy);
Kostya Serebryany64449212014-10-17 21:02:13 +0000801 uint64_t TypeSize = Info.getNonVirtualSize().getQuantity();
Kostya Serebryany293dc9b2014-10-16 20:54:52 +0000802 // For each field check if it has sufficient padding,
803 // if so (un)poison it with a call.
804 for (size_t i = 0; i < SSV.size(); i++) {
805 uint64_t AsanAlignment = 8;
806 uint64_t NextField = i == SSV.size() - 1 ? TypeSize : SSV[i + 1].Offset;
807 uint64_t PoisonSize = NextField - SSV[i].Offset - SSV[i].Size;
808 uint64_t EndOffset = SSV[i].Offset + SSV[i].Size;
809 if (PoisonSize < AsanAlignment || !SSV[i].Size ||
810 (NextField % AsanAlignment) != 0)
811 continue;
David Blaikie43f9bb72015-05-18 22:14:03 +0000812 Builder.CreateCall(
813 F, {Builder.CreateAdd(ThisPtr, Builder.getIntN(PtrSize, EndOffset)),
814 Builder.getIntN(PtrSize, PoisonSize)});
Kostya Serebryany293dc9b2014-10-16 20:54:52 +0000815 }
816}
817
John McCallb81884d2010-02-19 09:25:03 +0000818/// EmitConstructorBody - Emits the body of the current constructor.
819void CodeGenFunction::EmitConstructorBody(FunctionArgList &Args) {
Kostya Serebryany293dc9b2014-10-16 20:54:52 +0000820 EmitAsanPrologueOrEpilogue(true);
John McCallb81884d2010-02-19 09:25:03 +0000821 const CXXConstructorDecl *Ctor = cast<CXXConstructorDecl>(CurGD.getDecl());
822 CXXCtorType CtorType = CurGD.getCtorType();
823
Reid Kleckner340ad862014-01-13 22:57:31 +0000824 assert((CGM.getTarget().getCXXABI().hasConstructorVariants() ||
825 CtorType == Ctor_Complete) &&
826 "can only generate complete ctor for this ABI");
827
John McCallf8ff7b92010-02-23 00:48:20 +0000828 // Before we go any further, try the complete->base constructor
829 // delegation optimization.
Timur Iskhodzhanovf32a3772012-04-20 08:05:00 +0000830 if (CtorType == Ctor_Complete && IsConstructorDelegationValid(Ctor) &&
John McCallc8e01702013-04-16 22:48:15 +0000831 CGM.getTarget().getCXXABI().hasConstructorVariants()) {
Stephen Kelly1c301dc2018-08-09 21:09:38 +0000832 EmitDelegateCXXConstructorCall(Ctor, Ctor_Base, Args, Ctor->getEndLoc());
John McCallf8ff7b92010-02-23 00:48:20 +0000833 return;
834 }
835
Hans Wennborgdcfba332015-10-06 23:40:43 +0000836 const FunctionDecl *Definition = nullptr;
Richard Smith46bb5812014-08-01 01:56:39 +0000837 Stmt *Body = Ctor->getBody(Definition);
838 assert(Definition == Ctor && "emitting wrong constructor body");
John McCallb81884d2010-02-19 09:25:03 +0000839
John McCallf8ff7b92010-02-23 00:48:20 +0000840 // Enter the function-try-block before the constructor prologue if
841 // applicable.
John McCallf8ff7b92010-02-23 00:48:20 +0000842 bool IsTryBody = (Body && isa<CXXTryStmt>(Body));
John McCallf8ff7b92010-02-23 00:48:20 +0000843 if (IsTryBody)
John McCallb609d3f2010-07-07 06:56:46 +0000844 EnterCXXTryStmt(*cast<CXXTryStmt>(Body), true);
John McCallb81884d2010-02-19 09:25:03 +0000845
Justin Bogner66242d62015-04-23 23:06:47 +0000846 incrementProfileCounter(Body);
Justin Bogner81c22c22014-01-23 02:54:27 +0000847
Richard Smithcc1b96d2013-06-12 22:31:48 +0000848 RunCleanupsScope RunCleanups(*this);
John McCallb81884d2010-02-19 09:25:03 +0000849
John McCall88313032012-03-30 04:25:03 +0000850 // TODO: in restricted cases, we can emit the vbase initializers of
851 // a complete ctor and then delegate to the base ctor.
852
John McCallf8ff7b92010-02-23 00:48:20 +0000853 // Emit the constructor prologue, i.e. the base and member
854 // initializers.
Douglas Gregor94f9a482010-05-05 05:51:00 +0000855 EmitCtorPrologue(Ctor, CtorType, Args);
John McCallb81884d2010-02-19 09:25:03 +0000856
857 // Emit the body of the statement.
John McCallf8ff7b92010-02-23 00:48:20 +0000858 if (IsTryBody)
John McCallb81884d2010-02-19 09:25:03 +0000859 EmitStmt(cast<CXXTryStmt>(Body)->getTryBlock());
860 else if (Body)
861 EmitStmt(Body);
John McCallb81884d2010-02-19 09:25:03 +0000862
863 // Emit any cleanup blocks associated with the member or base
864 // initializers, which includes (along the exceptional path) the
865 // destructors for those members and bases that were fully
866 // constructed.
Richard Smithcc1b96d2013-06-12 22:31:48 +0000867 RunCleanups.ForceCleanup();
John McCallb81884d2010-02-19 09:25:03 +0000868
John McCallf8ff7b92010-02-23 00:48:20 +0000869 if (IsTryBody)
John McCallb609d3f2010-07-07 06:56:46 +0000870 ExitCXXTryStmt(*cast<CXXTryStmt>(Body), true);
John McCallb81884d2010-02-19 09:25:03 +0000871}
872
Lang Hamesbf122742013-02-17 07:22:09 +0000873namespace {
Nick Lewycky8b4e3792013-09-11 02:03:20 +0000874 /// RAII object to indicate that codegen is copying the value representation
875 /// instead of the object representation. Useful when copying a struct or
876 /// class which has uninitialized members and we're only performing
877 /// lvalue-to-rvalue conversion on the object but not its members.
878 class CopyingValueRepresentation {
879 public:
880 explicit CopyingValueRepresentation(CodeGenFunction &CGF)
Alexey Samsonov035462c2014-10-30 19:33:44 +0000881 : CGF(CGF), OldSanOpts(CGF.SanOpts) {
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000882 CGF.SanOpts.set(SanitizerKind::Bool, false);
883 CGF.SanOpts.set(SanitizerKind::Enum, false);
Nick Lewycky8b4e3792013-09-11 02:03:20 +0000884 }
885 ~CopyingValueRepresentation() {
886 CGF.SanOpts = OldSanOpts;
887 }
888 private:
889 CodeGenFunction &CGF;
Alexey Samsonova0416102014-11-11 01:26:14 +0000890 SanitizerSet OldSanOpts;
Nick Lewycky8b4e3792013-09-11 02:03:20 +0000891 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000892} // end anonymous namespace
Fangrui Song6907ce22018-07-30 19:24:48 +0000893
Nick Lewycky8b4e3792013-09-11 02:03:20 +0000894namespace {
Lang Hamesbf122742013-02-17 07:22:09 +0000895 class FieldMemcpyizer {
896 public:
897 FieldMemcpyizer(CodeGenFunction &CGF, const CXXRecordDecl *ClassDecl,
898 const VarDecl *SrcRec)
Justin Bogner1cd11f12015-05-20 15:53:59 +0000899 : CGF(CGF), ClassDecl(ClassDecl), SrcRec(SrcRec),
Lang Hamesbf122742013-02-17 07:22:09 +0000900 RecLayout(CGF.getContext().getASTRecordLayout(ClassDecl)),
Craig Topper8a13c412014-05-21 05:09:00 +0000901 FirstField(nullptr), LastField(nullptr), FirstFieldOffset(0),
902 LastFieldOffset(0), LastAddedFieldIndex(0) {}
Lang Hamesbf122742013-02-17 07:22:09 +0000903
Kostya Serebryany293dc9b2014-10-16 20:54:52 +0000904 bool isMemcpyableField(FieldDecl *F) const {
905 // Never memcpy fields when we are adding poisoned paddings.
Alexey Samsonova0416102014-11-11 01:26:14 +0000906 if (CGF.getContext().getLangOpts().SanitizeAddressFieldPadding)
Kostya Serebryany293dc9b2014-10-16 20:54:52 +0000907 return false;
Lang Hamesbf122742013-02-17 07:22:09 +0000908 Qualifiers Qual = F->getType().getQualifiers();
909 if (Qual.hasVolatile() || Qual.hasObjCLifetime())
910 return false;
911 return true;
912 }
913
914 void addMemcpyableField(FieldDecl *F) {
Craig Topper8a13c412014-05-21 05:09:00 +0000915 if (!FirstField)
Lang Hamesbf122742013-02-17 07:22:09 +0000916 addInitialField(F);
917 else
918 addNextField(F);
919 }
920
David Majnemera586eb22014-10-10 18:57:10 +0000921 CharUnits getMemcpySize(uint64_t FirstByteOffset) const {
Richard Smithe78fac52018-04-05 20:52:58 +0000922 ASTContext &Ctx = CGF.getContext();
Lang Hamesbf122742013-02-17 07:22:09 +0000923 unsigned LastFieldSize =
Richard Smithe78fac52018-04-05 20:52:58 +0000924 LastField->isBitField()
925 ? LastField->getBitWidthValue(Ctx)
926 : Ctx.toBits(
927 Ctx.getTypeInfoDataSizeInChars(LastField->getType()).first);
928 uint64_t MemcpySizeBits = LastFieldOffset + LastFieldSize -
929 FirstByteOffset + Ctx.getCharWidth() - 1;
930 CharUnits MemcpySize = Ctx.toCharUnitsFromBits(MemcpySizeBits);
Lang Hamesbf122742013-02-17 07:22:09 +0000931 return MemcpySize;
932 }
933
934 void emitMemcpy() {
935 // Give the subclass a chance to bail out if it feels the memcpy isn't
936 // worth it (e.g. Hasn't aggregated enough data).
Craig Topper8a13c412014-05-21 05:09:00 +0000937 if (!FirstField) {
Lang Hamesbf122742013-02-17 07:22:09 +0000938 return;
939 }
940
David Majnemera586eb22014-10-10 18:57:10 +0000941 uint64_t FirstByteOffset;
Lang Hamesbf122742013-02-17 07:22:09 +0000942 if (FirstField->isBitField()) {
943 const CGRecordLayout &RL =
944 CGF.getTypes().getCGRecordLayout(FirstField->getParent());
945 const CGBitFieldInfo &BFInfo = RL.getBitFieldInfo(FirstField);
David Majnemera586eb22014-10-10 18:57:10 +0000946 // FirstFieldOffset is not appropriate for bitfields,
Ulrich Weigand73263d72015-07-13 11:52:14 +0000947 // we need to use the storage offset instead.
Ulrich Weigand03ce2a12015-07-10 17:30:00 +0000948 FirstByteOffset = CGF.getContext().toBits(BFInfo.StorageOffset);
Lang Hames1694e0d2013-02-27 04:14:49 +0000949 } else {
David Majnemera586eb22014-10-10 18:57:10 +0000950 FirstByteOffset = FirstFieldOffset;
Lang Hames1694e0d2013-02-27 04:14:49 +0000951 }
Lang Hamesbf122742013-02-17 07:22:09 +0000952
David Majnemera586eb22014-10-10 18:57:10 +0000953 CharUnits MemcpySize = getMemcpySize(FirstByteOffset);
Lang Hamesbf122742013-02-17 07:22:09 +0000954 QualType RecordTy = CGF.getContext().getTypeDeclType(ClassDecl);
John McCall7f416cc2015-09-08 08:05:57 +0000955 Address ThisPtr = CGF.LoadCXXThisAddress();
956 LValue DestLV = CGF.MakeAddrLValue(ThisPtr, RecordTy);
Lang Hamesbf122742013-02-17 07:22:09 +0000957 LValue Dest = CGF.EmitLValueForFieldInitialization(DestLV, FirstField);
958 llvm::Value *SrcPtr = CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(SrcRec));
959 LValue SrcLV = CGF.MakeNaturalAlignAddrLValue(SrcPtr, RecordTy);
960 LValue Src = CGF.EmitLValueForFieldInitialization(SrcLV, FirstField);
961
John McCall7f416cc2015-09-08 08:05:57 +0000962 emitMemcpyIR(Dest.isBitField() ? Dest.getBitFieldAddress() : Dest.getAddress(),
963 Src.isBitField() ? Src.getBitFieldAddress() : Src.getAddress(),
964 MemcpySize);
Lang Hamesbf122742013-02-17 07:22:09 +0000965 reset();
966 }
967
968 void reset() {
Craig Topper8a13c412014-05-21 05:09:00 +0000969 FirstField = nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +0000970 }
971
972 protected:
973 CodeGenFunction &CGF;
974 const CXXRecordDecl *ClassDecl;
975
976 private:
John McCall7f416cc2015-09-08 08:05:57 +0000977 void emitMemcpyIR(Address DestPtr, Address SrcPtr, CharUnits Size) {
978 llvm::PointerType *DPT = DestPtr.getType();
Lang Hamesbf122742013-02-17 07:22:09 +0000979 llvm::Type *DBP =
980 llvm::Type::getInt8PtrTy(CGF.getLLVMContext(), DPT->getAddressSpace());
981 DestPtr = CGF.Builder.CreateBitCast(DestPtr, DBP);
982
John McCall7f416cc2015-09-08 08:05:57 +0000983 llvm::PointerType *SPT = SrcPtr.getType();
Lang Hamesbf122742013-02-17 07:22:09 +0000984 llvm::Type *SBP =
985 llvm::Type::getInt8PtrTy(CGF.getLLVMContext(), SPT->getAddressSpace());
986 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, SBP);
987
John McCall7f416cc2015-09-08 08:05:57 +0000988 CGF.Builder.CreateMemCpy(DestPtr, SrcPtr, Size.getQuantity());
Lang Hamesbf122742013-02-17 07:22:09 +0000989 }
990
991 void addInitialField(FieldDecl *F) {
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000992 FirstField = F;
993 LastField = F;
994 FirstFieldOffset = RecLayout.getFieldOffset(F->getFieldIndex());
995 LastFieldOffset = FirstFieldOffset;
996 LastAddedFieldIndex = F->getFieldIndex();
997 }
Lang Hamesbf122742013-02-17 07:22:09 +0000998
999 void addNextField(FieldDecl *F) {
John McCall6054d5a2013-05-07 05:20:46 +00001000 // For the most part, the following invariant will hold:
1001 // F->getFieldIndex() == LastAddedFieldIndex + 1
1002 // The one exception is that Sema won't add a copy-initializer for an
1003 // unnamed bitfield, which will show up here as a gap in the sequence.
1004 assert(F->getFieldIndex() >= LastAddedFieldIndex + 1 &&
1005 "Cannot aggregate fields out of order.");
Lang Hamesbf122742013-02-17 07:22:09 +00001006 LastAddedFieldIndex = F->getFieldIndex();
1007
1008 // The 'first' and 'last' fields are chosen by offset, rather than field
1009 // index. This allows the code to support bitfields, as well as regular
1010 // fields.
1011 uint64_t FOffset = RecLayout.getFieldOffset(F->getFieldIndex());
1012 if (FOffset < FirstFieldOffset) {
1013 FirstField = F;
1014 FirstFieldOffset = FOffset;
1015 } else if (FOffset > LastFieldOffset) {
1016 LastField = F;
1017 LastFieldOffset = FOffset;
1018 }
1019 }
1020
1021 const VarDecl *SrcRec;
1022 const ASTRecordLayout &RecLayout;
1023 FieldDecl *FirstField;
1024 FieldDecl *LastField;
1025 uint64_t FirstFieldOffset, LastFieldOffset;
1026 unsigned LastAddedFieldIndex;
1027 };
1028
1029 class ConstructorMemcpyizer : public FieldMemcpyizer {
1030 private:
Lang Hamesbf122742013-02-17 07:22:09 +00001031 /// Get source argument for copy constructor. Returns null if not a copy
David Majnemer196ac332014-09-11 23:05:02 +00001032 /// constructor.
1033 static const VarDecl *getTrivialCopySource(CodeGenFunction &CGF,
1034 const CXXConstructorDecl *CD,
Lang Hamesbf122742013-02-17 07:22:09 +00001035 FunctionArgList &Args) {
Jordan Rose54533f72013-08-07 16:16:48 +00001036 if (CD->isCopyOrMoveConstructor() && CD->isDefaulted())
David Majnemer196ac332014-09-11 23:05:02 +00001037 return Args[CGF.CGM.getCXXABI().getSrcArgforCopyCtor(CD, Args)];
Craig Topper8a13c412014-05-21 05:09:00 +00001038 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001039 }
1040
1041 // Returns true if a CXXCtorInitializer represents a member initialization
1042 // that can be rolled into a memcpy.
1043 bool isMemberInitMemcpyable(CXXCtorInitializer *MemberInit) const {
1044 if (!MemcpyableCtor)
1045 return false;
1046 FieldDecl *Field = MemberInit->getMember();
Craig Topper8a13c412014-05-21 05:09:00 +00001047 assert(Field && "No field for member init.");
Lang Hamesbf122742013-02-17 07:22:09 +00001048 QualType FieldType = Field->getType();
1049 CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(MemberInit->getInit());
1050
Richard Smith419bd092015-04-29 19:26:57 +00001051 // Bail out on non-memcpyable, not-trivially-copyable members.
1052 if (!(CE && isMemcpyEquivalentSpecialMember(CE->getConstructor())) &&
Lang Hamesbf122742013-02-17 07:22:09 +00001053 !(FieldType.isTriviallyCopyableType(CGF.getContext()) ||
1054 FieldType->isReferenceType()))
1055 return false;
1056
1057 // Bail out on volatile fields.
1058 if (!isMemcpyableField(Field))
1059 return false;
1060
1061 // Otherwise we're good.
1062 return true;
1063 }
1064
1065 public:
1066 ConstructorMemcpyizer(CodeGenFunction &CGF, const CXXConstructorDecl *CD,
1067 FunctionArgList &Args)
David Majnemer196ac332014-09-11 23:05:02 +00001068 : FieldMemcpyizer(CGF, CD->getParent(), getTrivialCopySource(CGF, CD, Args)),
Lang Hamesbf122742013-02-17 07:22:09 +00001069 ConstructorDecl(CD),
Jordan Rose54533f72013-08-07 16:16:48 +00001070 MemcpyableCtor(CD->isDefaulted() &&
Lang Hamesbf122742013-02-17 07:22:09 +00001071 CD->isCopyOrMoveConstructor() &&
1072 CGF.getLangOpts().getGC() == LangOptions::NonGC),
1073 Args(Args) { }
1074
1075 void addMemberInitializer(CXXCtorInitializer *MemberInit) {
1076 if (isMemberInitMemcpyable(MemberInit)) {
1077 AggregatedInits.push_back(MemberInit);
1078 addMemcpyableField(MemberInit->getMember());
1079 } else {
1080 emitAggregatedInits();
1081 EmitMemberInitializer(CGF, ConstructorDecl->getParent(), MemberInit,
1082 ConstructorDecl, Args);
1083 }
1084 }
1085
1086 void emitAggregatedInits() {
1087 if (AggregatedInits.size() <= 1) {
1088 // This memcpy is too small to be worthwhile. Fall back on default
1089 // codegen.
Nick Lewycky8b4e3792013-09-11 02:03:20 +00001090 if (!AggregatedInits.empty()) {
1091 CopyingValueRepresentation CVR(CGF);
Lang Hamesbf122742013-02-17 07:22:09 +00001092 EmitMemberInitializer(CGF, ConstructorDecl->getParent(),
Nick Lewycky8b4e3792013-09-11 02:03:20 +00001093 AggregatedInits[0], ConstructorDecl, Args);
Alexey Bataev152c71f2015-07-14 07:55:48 +00001094 AggregatedInits.clear();
Lang Hamesbf122742013-02-17 07:22:09 +00001095 }
1096 reset();
1097 return;
1098 }
1099
1100 pushEHDestructors();
1101 emitMemcpy();
1102 AggregatedInits.clear();
1103 }
1104
1105 void pushEHDestructors() {
John McCall7f416cc2015-09-08 08:05:57 +00001106 Address ThisPtr = CGF.LoadCXXThisAddress();
Lang Hamesbf122742013-02-17 07:22:09 +00001107 QualType RecordTy = CGF.getContext().getTypeDeclType(ClassDecl);
John McCall7f416cc2015-09-08 08:05:57 +00001108 LValue LHS = CGF.MakeAddrLValue(ThisPtr, RecordTy);
Lang Hamesbf122742013-02-17 07:22:09 +00001109
1110 for (unsigned i = 0; i < AggregatedInits.size(); ++i) {
Alexey Bataev152c71f2015-07-14 07:55:48 +00001111 CXXCtorInitializer *MemberInit = AggregatedInits[i];
1112 QualType FieldType = MemberInit->getAnyMember()->getType();
Lang Hamesbf122742013-02-17 07:22:09 +00001113 QualType::DestructionKind dtorKind = FieldType.isDestructedType();
Alexey Bataev152c71f2015-07-14 07:55:48 +00001114 if (!CGF.needsEHCleanup(dtorKind))
1115 continue;
1116 LValue FieldLHS = LHS;
1117 EmitLValueForAnyFieldInitialization(CGF, MemberInit, FieldLHS);
1118 CGF.pushEHDestroy(dtorKind, FieldLHS.getAddress(), FieldType);
Lang Hamesbf122742013-02-17 07:22:09 +00001119 }
1120 }
1121
1122 void finish() {
1123 emitAggregatedInits();
1124 }
1125
1126 private:
1127 const CXXConstructorDecl *ConstructorDecl;
1128 bool MemcpyableCtor;
1129 FunctionArgList &Args;
1130 SmallVector<CXXCtorInitializer*, 16> AggregatedInits;
1131 };
1132
1133 class AssignmentMemcpyizer : public FieldMemcpyizer {
1134 private:
Lang Hamesbf122742013-02-17 07:22:09 +00001135 // Returns the memcpyable field copied by the given statement, if one
Nick Lewycky8b4e3792013-09-11 02:03:20 +00001136 // exists. Otherwise returns null.
1137 FieldDecl *getMemcpyableField(Stmt *S) {
Lang Hamesbf122742013-02-17 07:22:09 +00001138 if (!AssignmentsMemcpyable)
Craig Topper8a13c412014-05-21 05:09:00 +00001139 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001140 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(S)) {
1141 // Recognise trivial assignments.
1142 if (BO->getOpcode() != BO_Assign)
Craig Topper8a13c412014-05-21 05:09:00 +00001143 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001144 MemberExpr *ME = dyn_cast<MemberExpr>(BO->getLHS());
1145 if (!ME)
Craig Topper8a13c412014-05-21 05:09:00 +00001146 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001147 FieldDecl *Field = dyn_cast<FieldDecl>(ME->getMemberDecl());
1148 if (!Field || !isMemcpyableField(Field))
Craig Topper8a13c412014-05-21 05:09:00 +00001149 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001150 Stmt *RHS = BO->getRHS();
1151 if (ImplicitCastExpr *EC = dyn_cast<ImplicitCastExpr>(RHS))
1152 RHS = EC->getSubExpr();
1153 if (!RHS)
Craig Topper8a13c412014-05-21 05:09:00 +00001154 return nullptr;
Warren Ristow8d17b402017-02-02 17:53:34 +00001155 if (MemberExpr *ME2 = dyn_cast<MemberExpr>(RHS)) {
1156 if (ME2->getMemberDecl() == Field)
1157 return Field;
1158 }
1159 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001160 } else if (CXXMemberCallExpr *MCE = dyn_cast<CXXMemberCallExpr>(S)) {
1161 CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MCE->getCalleeDecl());
Richard Smith419bd092015-04-29 19:26:57 +00001162 if (!(MD && isMemcpyEquivalentSpecialMember(MD)))
Craig Topper8a13c412014-05-21 05:09:00 +00001163 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001164 MemberExpr *IOA = dyn_cast<MemberExpr>(MCE->getImplicitObjectArgument());
1165 if (!IOA)
Craig Topper8a13c412014-05-21 05:09:00 +00001166 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001167 FieldDecl *Field = dyn_cast<FieldDecl>(IOA->getMemberDecl());
1168 if (!Field || !isMemcpyableField(Field))
Craig Topper8a13c412014-05-21 05:09:00 +00001169 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001170 MemberExpr *Arg0 = dyn_cast<MemberExpr>(MCE->getArg(0));
1171 if (!Arg0 || Field != dyn_cast<FieldDecl>(Arg0->getMemberDecl()))
Craig Topper8a13c412014-05-21 05:09:00 +00001172 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001173 return Field;
1174 } else if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
1175 FunctionDecl *FD = dyn_cast<FunctionDecl>(CE->getCalleeDecl());
1176 if (!FD || FD->getBuiltinID() != Builtin::BI__builtin_memcpy)
Craig Topper8a13c412014-05-21 05:09:00 +00001177 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001178 Expr *DstPtr = CE->getArg(0);
1179 if (ImplicitCastExpr *DC = dyn_cast<ImplicitCastExpr>(DstPtr))
1180 DstPtr = DC->getSubExpr();
1181 UnaryOperator *DUO = dyn_cast<UnaryOperator>(DstPtr);
1182 if (!DUO || DUO->getOpcode() != UO_AddrOf)
Craig Topper8a13c412014-05-21 05:09:00 +00001183 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001184 MemberExpr *ME = dyn_cast<MemberExpr>(DUO->getSubExpr());
1185 if (!ME)
Craig Topper8a13c412014-05-21 05:09:00 +00001186 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001187 FieldDecl *Field = dyn_cast<FieldDecl>(ME->getMemberDecl());
1188 if (!Field || !isMemcpyableField(Field))
Craig Topper8a13c412014-05-21 05:09:00 +00001189 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001190 Expr *SrcPtr = CE->getArg(1);
1191 if (ImplicitCastExpr *SC = dyn_cast<ImplicitCastExpr>(SrcPtr))
1192 SrcPtr = SC->getSubExpr();
1193 UnaryOperator *SUO = dyn_cast<UnaryOperator>(SrcPtr);
1194 if (!SUO || SUO->getOpcode() != UO_AddrOf)
Craig Topper8a13c412014-05-21 05:09:00 +00001195 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001196 MemberExpr *ME2 = dyn_cast<MemberExpr>(SUO->getSubExpr());
1197 if (!ME2 || Field != dyn_cast<FieldDecl>(ME2->getMemberDecl()))
Craig Topper8a13c412014-05-21 05:09:00 +00001198 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001199 return Field;
1200 }
1201
Craig Topper8a13c412014-05-21 05:09:00 +00001202 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001203 }
1204
1205 bool AssignmentsMemcpyable;
1206 SmallVector<Stmt*, 16> AggregatedStmts;
1207
1208 public:
Lang Hamesbf122742013-02-17 07:22:09 +00001209 AssignmentMemcpyizer(CodeGenFunction &CGF, const CXXMethodDecl *AD,
1210 FunctionArgList &Args)
1211 : FieldMemcpyizer(CGF, AD->getParent(), Args[Args.size() - 1]),
1212 AssignmentsMemcpyable(CGF.getLangOpts().getGC() == LangOptions::NonGC) {
1213 assert(Args.size() == 2);
1214 }
1215
1216 void emitAssignment(Stmt *S) {
1217 FieldDecl *F = getMemcpyableField(S);
1218 if (F) {
1219 addMemcpyableField(F);
1220 AggregatedStmts.push_back(S);
Justin Bogner1cd11f12015-05-20 15:53:59 +00001221 } else {
Lang Hamesbf122742013-02-17 07:22:09 +00001222 emitAggregatedStmts();
1223 CGF.EmitStmt(S);
1224 }
1225 }
1226
1227 void emitAggregatedStmts() {
1228 if (AggregatedStmts.size() <= 1) {
Nick Lewycky8b4e3792013-09-11 02:03:20 +00001229 if (!AggregatedStmts.empty()) {
1230 CopyingValueRepresentation CVR(CGF);
1231 CGF.EmitStmt(AggregatedStmts[0]);
1232 }
Lang Hamesbf122742013-02-17 07:22:09 +00001233 reset();
1234 }
1235
1236 emitMemcpy();
1237 AggregatedStmts.clear();
1238 }
1239
1240 void finish() {
1241 emitAggregatedStmts();
1242 }
1243 };
Hans Wennborgdcfba332015-10-06 23:40:43 +00001244} // end anonymous namespace
Lang Hamesbf122742013-02-17 07:22:09 +00001245
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001246static bool isInitializerOfDynamicClass(const CXXCtorInitializer *BaseInit) {
1247 const Type *BaseType = BaseInit->getBaseClass();
1248 const auto *BaseClassDecl =
1249 cast<CXXRecordDecl>(BaseType->getAs<RecordType>()->getDecl());
1250 return BaseClassDecl->isDynamicClass();
1251}
1252
Anders Carlssonfb404882009-12-24 22:46:43 +00001253/// EmitCtorPrologue - This routine generates necessary code to initialize
1254/// base classes and non-static data members belonging to this constructor.
Anders Carlssonfb404882009-12-24 22:46:43 +00001255void CodeGenFunction::EmitCtorPrologue(const CXXConstructorDecl *CD,
Douglas Gregor94f9a482010-05-05 05:51:00 +00001256 CXXCtorType CtorType,
1257 FunctionArgList &Args) {
Alexis Hunt61bc1732011-05-01 07:04:31 +00001258 if (CD->isDelegatingConstructor())
1259 return EmitDelegatingCXXConstructorCall(CD, Args);
1260
Anders Carlssonfb404882009-12-24 22:46:43 +00001261 const CXXRecordDecl *ClassDecl = CD->getParent();
Anders Carlsson5dc86332010-02-02 19:58:43 +00001262
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001263 CXXConstructorDecl::init_const_iterator B = CD->init_begin(),
1264 E = CD->init_end();
1265
Craig Topper8a13c412014-05-21 05:09:00 +00001266 llvm::BasicBlock *BaseCtorContinueBB = nullptr;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001267 if (ClassDecl->getNumVBases() &&
1268 !CGM.getTarget().getCXXABI().hasConstructorVariants()) {
1269 // The ABIs that don't have constructor variants need to put a branch
1270 // before the virtual base initialization code.
Reid Kleckner7810af02013-06-19 15:20:38 +00001271 BaseCtorContinueBB =
1272 CGM.getCXXABI().EmitCtorCompleteObjectHandler(*this, ClassDecl);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001273 assert(BaseCtorContinueBB);
1274 }
1275
Piotr Padlewski276a78d2015-10-02 22:12:40 +00001276 llvm::Value *const OldThis = CXXThisValue;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001277 // Virtual base initializers first.
1278 for (; B != E && (*B)->isBaseInitializer() && (*B)->isBaseVirtual(); B++) {
Piotr Padlewski276a78d2015-10-02 22:12:40 +00001279 if (CGM.getCodeGenOpts().StrictVTablePointers &&
1280 CGM.getCodeGenOpts().OptimizationLevel > 0 &&
1281 isInitializerOfDynamicClass(*B))
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001282 CXXThisValue = Builder.CreateLaunderInvariantGroup(LoadCXXThis());
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001283 EmitBaseInitializer(*this, ClassDecl, *B, CtorType);
1284 }
1285
1286 if (BaseCtorContinueBB) {
1287 // Complete object handler should continue to the remaining initializers.
1288 Builder.CreateBr(BaseCtorContinueBB);
1289 EmitBlock(BaseCtorContinueBB);
1290 }
1291
1292 // Then, non-virtual base initializers.
1293 for (; B != E && (*B)->isBaseInitializer(); B++) {
1294 assert(!(*B)->isBaseVirtual());
Piotr Padlewski276a78d2015-10-02 22:12:40 +00001295
1296 if (CGM.getCodeGenOpts().StrictVTablePointers &&
1297 CGM.getCodeGenOpts().OptimizationLevel > 0 &&
1298 isInitializerOfDynamicClass(*B))
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001299 CXXThisValue = Builder.CreateLaunderInvariantGroup(LoadCXXThis());
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001300 EmitBaseInitializer(*this, ClassDecl, *B, CtorType);
Anders Carlssonfb404882009-12-24 22:46:43 +00001301 }
1302
Piotr Padlewski276a78d2015-10-02 22:12:40 +00001303 CXXThisValue = OldThis;
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001304
Anders Carlssond5895932010-03-28 21:07:49 +00001305 InitializeVTablePointers(ClassDecl);
Anders Carlsson5dc86332010-02-02 19:58:43 +00001306
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001307 // And finally, initialize class members.
John McCall7f416cc2015-09-08 08:05:57 +00001308 FieldConstructionScope FCS(*this, LoadCXXThisAddress());
Lang Hamesbf122742013-02-17 07:22:09 +00001309 ConstructorMemcpyizer CM(*this, CD, Args);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001310 for (; B != E; B++) {
1311 CXXCtorInitializer *Member = (*B);
1312 assert(!Member->isBaseInitializer());
1313 assert(Member->isAnyMemberInitializer() &&
1314 "Delegating initializer on non-delegating constructor");
1315 CM.addMemberInitializer(Member);
1316 }
Lang Hamesbf122742013-02-17 07:22:09 +00001317 CM.finish();
Anders Carlssonfb404882009-12-24 22:46:43 +00001318}
1319
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001320static bool
1321FieldHasTrivialDestructorBody(ASTContext &Context, const FieldDecl *Field);
1322
1323static bool
Justin Bogner1cd11f12015-05-20 15:53:59 +00001324HasTrivialDestructorBody(ASTContext &Context,
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001325 const CXXRecordDecl *BaseClassDecl,
1326 const CXXRecordDecl *MostDerivedClassDecl)
1327{
1328 // If the destructor is trivial we don't have to check anything else.
1329 if (BaseClassDecl->hasTrivialDestructor())
1330 return true;
1331
1332 if (!BaseClassDecl->getDestructor()->hasTrivialBody())
1333 return false;
1334
1335 // Check fields.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001336 for (const auto *Field : BaseClassDecl->fields())
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001337 if (!FieldHasTrivialDestructorBody(Context, Field))
1338 return false;
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001339
1340 // Check non-virtual bases.
Aaron Ballman574705e2014-03-13 15:41:46 +00001341 for (const auto &I : BaseClassDecl->bases()) {
1342 if (I.isVirtual())
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001343 continue;
1344
1345 const CXXRecordDecl *NonVirtualBase =
Aaron Ballman574705e2014-03-13 15:41:46 +00001346 cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001347 if (!HasTrivialDestructorBody(Context, NonVirtualBase,
1348 MostDerivedClassDecl))
1349 return false;
1350 }
1351
1352 if (BaseClassDecl == MostDerivedClassDecl) {
1353 // Check virtual bases.
Aaron Ballman445a9392014-03-13 16:15:17 +00001354 for (const auto &I : BaseClassDecl->vbases()) {
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001355 const CXXRecordDecl *VirtualBase =
Aaron Ballman445a9392014-03-13 16:15:17 +00001356 cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001357 if (!HasTrivialDestructorBody(Context, VirtualBase,
1358 MostDerivedClassDecl))
Justin Bogner1cd11f12015-05-20 15:53:59 +00001359 return false;
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001360 }
1361 }
1362
1363 return true;
1364}
1365
1366static bool
1367FieldHasTrivialDestructorBody(ASTContext &Context,
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001368 const FieldDecl *Field)
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001369{
1370 QualType FieldBaseElementType = Context.getBaseElementType(Field->getType());
1371
1372 const RecordType *RT = FieldBaseElementType->getAs<RecordType>();
1373 if (!RT)
1374 return true;
Justin Bogner1cd11f12015-05-20 15:53:59 +00001375
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001376 CXXRecordDecl *FieldClassDecl = cast<CXXRecordDecl>(RT->getDecl());
Davide Italiano982bbf42015-06-26 00:18:35 +00001377
1378 // The destructor for an implicit anonymous union member is never invoked.
1379 if (FieldClassDecl->isUnion() && FieldClassDecl->isAnonymousStructOrUnion())
1380 return false;
1381
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001382 return HasTrivialDestructorBody(Context, FieldClassDecl, FieldClassDecl);
1383}
1384
Anders Carlsson9bd7d162011-05-14 23:26:09 +00001385/// CanSkipVTablePointerInitialization - Check whether we need to initialize
1386/// any vtable pointers before calling this destructor.
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001387static bool CanSkipVTablePointerInitialization(CodeGenFunction &CGF,
Anders Carlssond6f15182011-05-16 04:08:36 +00001388 const CXXDestructorDecl *Dtor) {
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001389 const CXXRecordDecl *ClassDecl = Dtor->getParent();
1390 if (!ClassDecl->isDynamicClass())
1391 return true;
1392
Anders Carlsson9bd7d162011-05-14 23:26:09 +00001393 if (!Dtor->hasTrivialBody())
1394 return false;
1395
1396 // Check the fields.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001397 for (const auto *Field : ClassDecl->fields())
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001398 if (!FieldHasTrivialDestructorBody(CGF.getContext(), Field))
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001399 return false;
Anders Carlsson9bd7d162011-05-14 23:26:09 +00001400
1401 return true;
1402}
1403
John McCallb81884d2010-02-19 09:25:03 +00001404/// EmitDestructorBody - Emits the body of the current destructor.
1405void CodeGenFunction::EmitDestructorBody(FunctionArgList &Args) {
1406 const CXXDestructorDecl *Dtor = cast<CXXDestructorDecl>(CurGD.getDecl());
1407 CXXDtorType DtorType = CurGD.getDtorType();
1408
Richard Smithdf054d32017-02-25 23:53:05 +00001409 // For an abstract class, non-base destructors are never used (and can't
1410 // be emitted in general, because vbase dtors may not have been validated
1411 // by Sema), but the Itanium ABI doesn't make them optional and Clang may
1412 // in fact emit references to them from other compilations, so emit them
1413 // as functions containing a trap instruction.
1414 if (DtorType != Dtor_Base && Dtor->getParent()->isAbstract()) {
1415 llvm::CallInst *TrapCall = EmitTrapCall(llvm::Intrinsic::trap);
1416 TrapCall->setDoesNotReturn();
1417 TrapCall->setDoesNotThrow();
1418 Builder.CreateUnreachable();
1419 Builder.ClearInsertionPoint();
1420 return;
1421 }
1422
Justin Bognerfb298222015-05-20 16:16:23 +00001423 Stmt *Body = Dtor->getBody();
1424 if (Body)
1425 incrementProfileCounter(Body);
1426
John McCallf99a6312010-07-21 05:30:47 +00001427 // The call to operator delete in a deleting destructor happens
1428 // outside of the function-try-block, which means it's always
1429 // possible to delegate the destructor body to the complete
1430 // destructor. Do so.
1431 if (DtorType == Dtor_Deleting) {
Richard Smith5b349582017-10-13 01:55:36 +00001432 RunCleanupsScope DtorEpilogue(*this);
John McCallf99a6312010-07-21 05:30:47 +00001433 EnterDtorCleanups(Dtor, Dtor_Deleting);
Richard Smith5b349582017-10-13 01:55:36 +00001434 if (HaveInsertPoint())
1435 EmitCXXDestructorCall(Dtor, Dtor_Complete, /*ForVirtualBase=*/false,
1436 /*Delegating=*/false, LoadCXXThisAddress());
John McCallf99a6312010-07-21 05:30:47 +00001437 return;
1438 }
1439
John McCallb81884d2010-02-19 09:25:03 +00001440 // If the body is a function-try-block, enter the try before
John McCallf99a6312010-07-21 05:30:47 +00001441 // anything else.
1442 bool isTryBody = (Body && isa<CXXTryStmt>(Body));
John McCallb81884d2010-02-19 09:25:03 +00001443 if (isTryBody)
John McCallb609d3f2010-07-07 06:56:46 +00001444 EnterCXXTryStmt(*cast<CXXTryStmt>(Body), true);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001445 EmitAsanPrologueOrEpilogue(false);
John McCallb81884d2010-02-19 09:25:03 +00001446
John McCallf99a6312010-07-21 05:30:47 +00001447 // Enter the epilogue cleanups.
1448 RunCleanupsScope DtorEpilogue(*this);
Justin Bogner1cd11f12015-05-20 15:53:59 +00001449
John McCallb81884d2010-02-19 09:25:03 +00001450 // If this is the complete variant, just invoke the base variant;
1451 // the epilogue will destruct the virtual bases. But we can't do
1452 // this optimization if the body is a function-try-block, because
Justin Bogner1cd11f12015-05-20 15:53:59 +00001453 // we'd introduce *two* handler blocks. In the Microsoft ABI, we
Reid Klecknere7de47e2013-07-22 13:51:44 +00001454 // always delegate because we might not have a definition in this TU.
John McCallf99a6312010-07-21 05:30:47 +00001455 switch (DtorType) {
Saleem Abdulrasool8de4e872017-02-02 05:45:43 +00001456 case Dtor_Comdat: llvm_unreachable("not expecting a COMDAT");
John McCallf99a6312010-07-21 05:30:47 +00001457 case Dtor_Deleting: llvm_unreachable("already handled deleting case");
1458
1459 case Dtor_Complete:
Reid Klecknere7de47e2013-07-22 13:51:44 +00001460 assert((Body || getTarget().getCXXABI().isMicrosoft()) &&
1461 "can't emit a dtor without a body for non-Microsoft ABIs");
1462
John McCallf99a6312010-07-21 05:30:47 +00001463 // Enter the cleanup scopes for virtual bases.
1464 EnterDtorCleanups(Dtor, Dtor_Complete);
1465
Reid Klecknere7de47e2013-07-22 13:51:44 +00001466 if (!isTryBody) {
John McCallf99a6312010-07-21 05:30:47 +00001467 EmitCXXDestructorCall(Dtor, Dtor_Base, /*ForVirtualBase=*/false,
John McCall7f416cc2015-09-08 08:05:57 +00001468 /*Delegating=*/false, LoadCXXThisAddress());
John McCallf99a6312010-07-21 05:30:47 +00001469 break;
1470 }
Saleem Abdulrasool8de4e872017-02-02 05:45:43 +00001471
John McCallf99a6312010-07-21 05:30:47 +00001472 // Fallthrough: act like we're in the base variant.
Saleem Abdulrasool8de4e872017-02-02 05:45:43 +00001473 LLVM_FALLTHROUGH;
Justin Bogner1cd11f12015-05-20 15:53:59 +00001474
John McCallf99a6312010-07-21 05:30:47 +00001475 case Dtor_Base:
Reid Klecknere7de47e2013-07-22 13:51:44 +00001476 assert(Body);
1477
John McCallf99a6312010-07-21 05:30:47 +00001478 // Enter the cleanup scopes for fields and non-virtual bases.
1479 EnterDtorCleanups(Dtor, Dtor_Base);
1480
1481 // Initialize the vtable pointers before entering the body.
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001482 if (!CanSkipVTablePointerInitialization(*this, Dtor)) {
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001483 // Insert the llvm.launder.invariant.group intrinsic before initializing
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001484 // the vptrs to cancel any previous assumptions we might have made.
1485 if (CGM.getCodeGenOpts().StrictVTablePointers &&
1486 CGM.getCodeGenOpts().OptimizationLevel > 0)
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001487 CXXThisValue = Builder.CreateLaunderInvariantGroup(LoadCXXThis());
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001488 InitializeVTablePointers(Dtor->getParent());
1489 }
John McCallf99a6312010-07-21 05:30:47 +00001490
1491 if (isTryBody)
1492 EmitStmt(cast<CXXTryStmt>(Body)->getTryBlock());
1493 else if (Body)
1494 EmitStmt(Body);
1495 else {
1496 assert(Dtor->isImplicit() && "bodyless dtor not implicit");
1497 // nothing to do besides what's in the epilogue
1498 }
Fariborz Jahanian0c12ed12011-02-02 23:12:46 +00001499 // -fapple-kext must inline any call to this dtor into
1500 // the caller's body.
Richard Smith9c6890a2012-11-01 22:30:59 +00001501 if (getLangOpts().AppleKext)
Evgeniy Stepanov6b2a61d2015-09-14 21:35:16 +00001502 CurFn->addFnAttr(llvm::Attribute::AlwaysInline);
Naomi Musgravee50cb9b2015-08-13 18:35:11 +00001503
John McCallf99a6312010-07-21 05:30:47 +00001504 break;
John McCallb81884d2010-02-19 09:25:03 +00001505 }
1506
John McCallf99a6312010-07-21 05:30:47 +00001507 // Jump out through the epilogue cleanups.
1508 DtorEpilogue.ForceCleanup();
John McCallb81884d2010-02-19 09:25:03 +00001509
1510 // Exit the try if applicable.
1511 if (isTryBody)
John McCallb609d3f2010-07-07 06:56:46 +00001512 ExitCXXTryStmt(*cast<CXXTryStmt>(Body), true);
John McCallb81884d2010-02-19 09:25:03 +00001513}
1514
Lang Hamesbf122742013-02-17 07:22:09 +00001515void CodeGenFunction::emitImplicitAssignmentOperatorBody(FunctionArgList &Args) {
1516 const CXXMethodDecl *AssignOp = cast<CXXMethodDecl>(CurGD.getDecl());
1517 const Stmt *RootS = AssignOp->getBody();
1518 assert(isa<CompoundStmt>(RootS) &&
1519 "Body of an implicit assignment operator should be compound stmt.");
1520 const CompoundStmt *RootCS = cast<CompoundStmt>(RootS);
1521
1522 LexicalScope Scope(*this, RootCS->getSourceRange());
1523
Xinliang David Lia951e8e2016-02-09 20:02:59 +00001524 incrementProfileCounter(RootCS);
Lang Hamesbf122742013-02-17 07:22:09 +00001525 AssignmentMemcpyizer AM(*this, AssignOp, Args);
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001526 for (auto *I : RootCS->body())
Justin Bogner1cd11f12015-05-20 15:53:59 +00001527 AM.emitAssignment(I);
Lang Hamesbf122742013-02-17 07:22:09 +00001528 AM.finish();
1529}
1530
John McCallf99a6312010-07-21 05:30:47 +00001531namespace {
Richard Smith5b349582017-10-13 01:55:36 +00001532 llvm::Value *LoadThisForDtorDelete(CodeGenFunction &CGF,
1533 const CXXDestructorDecl *DD) {
1534 if (Expr *ThisArg = DD->getOperatorDeleteThisArg())
Haojian Wu5b5c81f2017-10-13 15:37:53 +00001535 return CGF.EmitScalarExpr(ThisArg);
Richard Smith5b349582017-10-13 01:55:36 +00001536 return CGF.LoadCXXThis();
1537 }
1538
John McCallf99a6312010-07-21 05:30:47 +00001539 /// Call the operator delete associated with the current destructor.
David Blaikie7e70d682015-08-18 22:40:54 +00001540 struct CallDtorDelete final : EHScopeStack::Cleanup {
John McCallf99a6312010-07-21 05:30:47 +00001541 CallDtorDelete() {}
1542
Craig Topper4f12f102014-03-12 06:41:41 +00001543 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallf99a6312010-07-21 05:30:47 +00001544 const CXXDestructorDecl *Dtor = cast<CXXDestructorDecl>(CGF.CurCodeDecl);
1545 const CXXRecordDecl *ClassDecl = Dtor->getParent();
Richard Smith5b349582017-10-13 01:55:36 +00001546 CGF.EmitDeleteCall(Dtor->getOperatorDelete(),
1547 LoadThisForDtorDelete(CGF, Dtor),
John McCallf99a6312010-07-21 05:30:47 +00001548 CGF.getContext().getTagDeclType(ClassDecl));
1549 }
1550 };
1551
Richard Smith5b349582017-10-13 01:55:36 +00001552 void EmitConditionalDtorDeleteCall(CodeGenFunction &CGF,
1553 llvm::Value *ShouldDeleteCondition,
1554 bool ReturnAfterDelete) {
1555 llvm::BasicBlock *callDeleteBB = CGF.createBasicBlock("dtor.call_delete");
1556 llvm::BasicBlock *continueBB = CGF.createBasicBlock("dtor.continue");
1557 llvm::Value *ShouldCallDelete
1558 = CGF.Builder.CreateIsNull(ShouldDeleteCondition);
1559 CGF.Builder.CreateCondBr(ShouldCallDelete, continueBB, callDeleteBB);
1560
1561 CGF.EmitBlock(callDeleteBB);
1562 const CXXDestructorDecl *Dtor = cast<CXXDestructorDecl>(CGF.CurCodeDecl);
1563 const CXXRecordDecl *ClassDecl = Dtor->getParent();
1564 CGF.EmitDeleteCall(Dtor->getOperatorDelete(),
1565 LoadThisForDtorDelete(CGF, Dtor),
1566 CGF.getContext().getTagDeclType(ClassDecl));
1567 assert(Dtor->getOperatorDelete()->isDestroyingOperatorDelete() ==
1568 ReturnAfterDelete &&
1569 "unexpected value for ReturnAfterDelete");
1570 if (ReturnAfterDelete)
1571 CGF.EmitBranchThroughCleanup(CGF.ReturnBlock);
1572 else
1573 CGF.Builder.CreateBr(continueBB);
1574
1575 CGF.EmitBlock(continueBB);
1576 }
1577
David Blaikie7e70d682015-08-18 22:40:54 +00001578 struct CallDtorDeleteConditional final : EHScopeStack::Cleanup {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001579 llvm::Value *ShouldDeleteCondition;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001580
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001581 public:
1582 CallDtorDeleteConditional(llvm::Value *ShouldDeleteCondition)
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001583 : ShouldDeleteCondition(ShouldDeleteCondition) {
Craig Topper8a13c412014-05-21 05:09:00 +00001584 assert(ShouldDeleteCondition != nullptr);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001585 }
1586
Craig Topper4f12f102014-03-12 06:41:41 +00001587 void Emit(CodeGenFunction &CGF, Flags flags) override {
Richard Smith5b349582017-10-13 01:55:36 +00001588 EmitConditionalDtorDeleteCall(CGF, ShouldDeleteCondition,
1589 /*ReturnAfterDelete*/false);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001590 }
1591 };
1592
David Blaikie7e70d682015-08-18 22:40:54 +00001593 class DestroyField final : public EHScopeStack::Cleanup {
John McCall4bd0fb12011-07-12 16:41:08 +00001594 const FieldDecl *field;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001595 CodeGenFunction::Destroyer *destroyer;
John McCall4bd0fb12011-07-12 16:41:08 +00001596 bool useEHCleanupForArray;
John McCallf99a6312010-07-21 05:30:47 +00001597
John McCall4bd0fb12011-07-12 16:41:08 +00001598 public:
1599 DestroyField(const FieldDecl *field, CodeGenFunction::Destroyer *destroyer,
1600 bool useEHCleanupForArray)
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001601 : field(field), destroyer(destroyer),
1602 useEHCleanupForArray(useEHCleanupForArray) {}
John McCallf99a6312010-07-21 05:30:47 +00001603
Craig Topper4f12f102014-03-12 06:41:41 +00001604 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall4bd0fb12011-07-12 16:41:08 +00001605 // Find the address of the field.
John McCall7f416cc2015-09-08 08:05:57 +00001606 Address thisValue = CGF.LoadCXXThisAddress();
Eli Friedman7f1ff602012-04-16 03:54:45 +00001607 QualType RecordTy = CGF.getContext().getTagDeclType(field->getParent());
1608 LValue ThisLV = CGF.MakeAddrLValue(thisValue, RecordTy);
1609 LValue LV = CGF.EmitLValueForField(ThisLV, field);
John McCall4bd0fb12011-07-12 16:41:08 +00001610 assert(LV.isSimple());
Justin Bogner1cd11f12015-05-20 15:53:59 +00001611
John McCall4bd0fb12011-07-12 16:41:08 +00001612 CGF.emitDestroy(LV.getAddress(), field->getType(), destroyer,
John McCall30317fd2011-07-12 20:27:29 +00001613 flags.isForNormalCleanup() && useEHCleanupForArray);
John McCallf99a6312010-07-21 05:30:47 +00001614 }
1615 };
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001616
Naomi Musgrave703835c2015-09-16 00:38:22 +00001617 static void EmitSanitizerDtorCallback(CodeGenFunction &CGF, llvm::Value *Ptr,
1618 CharUnits::QuantityType PoisonSize) {
Matt Morehouse4881a232017-09-20 22:53:08 +00001619 CodeGenFunction::SanitizerScope SanScope(&CGF);
Naomi Musgrave703835c2015-09-16 00:38:22 +00001620 // Pass in void pointer and size of region as arguments to runtime
1621 // function
1622 llvm::Value *Args[] = {CGF.Builder.CreateBitCast(Ptr, CGF.VoidPtrTy),
1623 llvm::ConstantInt::get(CGF.SizeTy, PoisonSize)};
1624
1625 llvm::Type *ArgTypes[] = {CGF.VoidPtrTy, CGF.SizeTy};
1626
1627 llvm::FunctionType *FnType =
1628 llvm::FunctionType::get(CGF.VoidTy, ArgTypes, false);
1629 llvm::Value *Fn =
1630 CGF.CGM.CreateRuntimeFunction(FnType, "__sanitizer_dtor_callback");
1631 CGF.EmitNounwindRuntimeCall(Fn, Args);
1632 }
1633
1634 class SanitizeDtorMembers final : public EHScopeStack::Cleanup {
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001635 const CXXDestructorDecl *Dtor;
1636
1637 public:
Naomi Musgrave703835c2015-09-16 00:38:22 +00001638 SanitizeDtorMembers(const CXXDestructorDecl *Dtor) : Dtor(Dtor) {}
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001639
1640 // Generate function call for handling object poisoning.
1641 // Disables tail call elimination, to prevent the current stack frame
1642 // from disappearing from the stack trace.
1643 void Emit(CodeGenFunction &CGF, Flags flags) override {
1644 const ASTRecordLayout &Layout =
1645 CGF.getContext().getASTRecordLayout(Dtor->getParent());
1646
1647 // Nothing to poison.
1648 if (Layout.getFieldCount() == 0)
1649 return;
1650
1651 // Prevent the current stack frame from disappearing from the stack trace.
1652 CGF.CurFn->addFnAttr("disable-tail-calls", "true");
1653
1654 // Construct pointer to region to begin poisoning, and calculate poison
1655 // size, so that only members declared in this class are poisoned.
1656 ASTContext &Context = CGF.getContext();
1657 unsigned fieldIndex = 0;
1658 int startIndex = -1;
1659 // RecordDecl::field_iterator Field;
1660 for (const FieldDecl *Field : Dtor->getParent()->fields()) {
1661 // Poison field if it is trivial
1662 if (FieldHasTrivialDestructorBody(Context, Field)) {
1663 // Start sanitizing at this field
1664 if (startIndex < 0)
1665 startIndex = fieldIndex;
1666
1667 // Currently on the last field, and it must be poisoned with the
1668 // current block.
1669 if (fieldIndex == Layout.getFieldCount() - 1) {
Naomi Musgrave703835c2015-09-16 00:38:22 +00001670 PoisonMembers(CGF, startIndex, Layout.getFieldCount());
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001671 }
1672 } else if (startIndex >= 0) {
1673 // No longer within a block of memory to poison, so poison the block
Naomi Musgrave703835c2015-09-16 00:38:22 +00001674 PoisonMembers(CGF, startIndex, fieldIndex);
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001675 // Re-set the start index
1676 startIndex = -1;
1677 }
1678 fieldIndex += 1;
1679 }
1680 }
1681
1682 private:
NAKAMURA Takumif6cef72f2015-09-04 05:19:31 +00001683 /// \param layoutStartOffset index of the ASTRecordLayout field to
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001684 /// start poisoning (inclusive)
NAKAMURA Takumif6cef72f2015-09-04 05:19:31 +00001685 /// \param layoutEndOffset index of the ASTRecordLayout field to
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001686 /// end poisoning (exclusive)
Naomi Musgrave703835c2015-09-16 00:38:22 +00001687 void PoisonMembers(CodeGenFunction &CGF, unsigned layoutStartOffset,
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001688 unsigned layoutEndOffset) {
1689 ASTContext &Context = CGF.getContext();
1690 const ASTRecordLayout &Layout =
1691 Context.getASTRecordLayout(Dtor->getParent());
1692
1693 llvm::ConstantInt *OffsetSizePtr = llvm::ConstantInt::get(
1694 CGF.SizeTy,
1695 Context.toCharUnitsFromBits(Layout.getFieldOffset(layoutStartOffset))
1696 .getQuantity());
1697
1698 llvm::Value *OffsetPtr = CGF.Builder.CreateGEP(
1699 CGF.Builder.CreateBitCast(CGF.LoadCXXThis(), CGF.Int8PtrTy),
1700 OffsetSizePtr);
1701
1702 CharUnits::QuantityType PoisonSize;
1703 if (layoutEndOffset >= Layout.getFieldCount()) {
1704 PoisonSize = Layout.getNonVirtualSize().getQuantity() -
1705 Context.toCharUnitsFromBits(
1706 Layout.getFieldOffset(layoutStartOffset))
1707 .getQuantity();
1708 } else {
1709 PoisonSize = Context.toCharUnitsFromBits(
1710 Layout.getFieldOffset(layoutEndOffset) -
1711 Layout.getFieldOffset(layoutStartOffset))
1712 .getQuantity();
1713 }
1714
1715 if (PoisonSize == 0)
1716 return;
1717
Naomi Musgrave703835c2015-09-16 00:38:22 +00001718 EmitSanitizerDtorCallback(CGF, OffsetPtr, PoisonSize);
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001719 }
1720 };
Naomi Musgrave703835c2015-09-16 00:38:22 +00001721
1722 class SanitizeDtorVTable final : public EHScopeStack::Cleanup {
1723 const CXXDestructorDecl *Dtor;
1724
1725 public:
1726 SanitizeDtorVTable(const CXXDestructorDecl *Dtor) : Dtor(Dtor) {}
1727
1728 // Generate function call for handling vtable pointer poisoning.
1729 void Emit(CodeGenFunction &CGF, Flags flags) override {
1730 assert(Dtor->getParent()->isDynamicClass());
NAKAMURA Takumiee82b492015-09-16 06:26:56 +00001731 (void)Dtor;
Naomi Musgrave703835c2015-09-16 00:38:22 +00001732 ASTContext &Context = CGF.getContext();
1733 // Poison vtable and vtable ptr if they exist for this class.
1734 llvm::Value *VTablePtr = CGF.LoadCXXThis();
1735
1736 CharUnits::QuantityType PoisonSize =
1737 Context.toCharUnitsFromBits(CGF.PointerWidthInBits).getQuantity();
1738 // Pass in void pointer and size of region as arguments to runtime
1739 // function
1740 EmitSanitizerDtorCallback(CGF, VTablePtr, PoisonSize);
1741 }
1742 };
Hans Wennborgdcfba332015-10-06 23:40:43 +00001743} // end anonymous namespace
John McCallf99a6312010-07-21 05:30:47 +00001744
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001745/// Emit all code that comes at the end of class's
Anders Carlssonfb404882009-12-24 22:46:43 +00001746/// destructor. This is to call destructors on members and base classes
1747/// in reverse order of their construction.
Richard Smith5b349582017-10-13 01:55:36 +00001748///
1749/// For a deleting destructor, this also handles the case where a destroying
1750/// operator delete completely overrides the definition.
John McCallf99a6312010-07-21 05:30:47 +00001751void CodeGenFunction::EnterDtorCleanups(const CXXDestructorDecl *DD,
1752 CXXDtorType DtorType) {
Hans Wennborg853ae942014-05-30 16:59:42 +00001753 assert((!DD->isTrivial() || DD->hasAttr<DLLExportAttr>()) &&
1754 "Should not emit dtor epilogue for non-exported trivial dtor!");
Anders Carlssonfb404882009-12-24 22:46:43 +00001755
John McCallf99a6312010-07-21 05:30:47 +00001756 // The deleting-destructor phase just needs to call the appropriate
1757 // operator delete that Sema picked up.
John McCall5c60a6f2010-02-18 19:59:28 +00001758 if (DtorType == Dtor_Deleting) {
Justin Bogner1cd11f12015-05-20 15:53:59 +00001759 assert(DD->getOperatorDelete() &&
Hans Wennborgdeff7032013-12-18 01:39:59 +00001760 "operator delete missing - EnterDtorCleanups");
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001761 if (CXXStructorImplicitParamValue) {
1762 // If there is an implicit param to the deleting dtor, it's a boolean
Richard Smith5b349582017-10-13 01:55:36 +00001763 // telling whether this is a deleting destructor.
1764 if (DD->getOperatorDelete()->isDestroyingOperatorDelete())
1765 EmitConditionalDtorDeleteCall(*this, CXXStructorImplicitParamValue,
1766 /*ReturnAfterDelete*/true);
1767 else
1768 EHStack.pushCleanup<CallDtorDeleteConditional>(
1769 NormalAndEHCleanup, CXXStructorImplicitParamValue);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001770 } else {
Richard Smith5b349582017-10-13 01:55:36 +00001771 if (DD->getOperatorDelete()->isDestroyingOperatorDelete()) {
1772 const CXXRecordDecl *ClassDecl = DD->getParent();
1773 EmitDeleteCall(DD->getOperatorDelete(),
1774 LoadThisForDtorDelete(*this, DD),
1775 getContext().getTagDeclType(ClassDecl));
1776 EmitBranchThroughCleanup(ReturnBlock);
1777 } else {
1778 EHStack.pushCleanup<CallDtorDelete>(NormalAndEHCleanup);
1779 }
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001780 }
John McCall5c60a6f2010-02-18 19:59:28 +00001781 return;
1782 }
1783
John McCallf99a6312010-07-21 05:30:47 +00001784 const CXXRecordDecl *ClassDecl = DD->getParent();
1785
Richard Smith20104042011-09-18 12:11:43 +00001786 // Unions have no bases and do not call field destructors.
1787 if (ClassDecl->isUnion())
1788 return;
1789
John McCallf99a6312010-07-21 05:30:47 +00001790 // The complete-destructor phase just destructs all the virtual bases.
John McCall5c60a6f2010-02-18 19:59:28 +00001791 if (DtorType == Dtor_Complete) {
Naomi Musgrave703835c2015-09-16 00:38:22 +00001792 // Poison the vtable pointer such that access after the base
1793 // and member destructors are invoked is invalid.
1794 if (CGM.getCodeGenOpts().SanitizeMemoryUseAfterDtor &&
1795 SanOpts.has(SanitizerKind::Memory) && ClassDecl->getNumVBases() &&
1796 ClassDecl->isPolymorphic())
1797 EHStack.pushCleanup<SanitizeDtorVTable>(NormalAndEHCleanup, DD);
John McCallf99a6312010-07-21 05:30:47 +00001798
1799 // We push them in the forward order so that they'll be popped in
1800 // the reverse order.
Aaron Ballman445a9392014-03-13 16:15:17 +00001801 for (const auto &Base : ClassDecl->vbases()) {
John McCall5c60a6f2010-02-18 19:59:28 +00001802 CXXRecordDecl *BaseClassDecl
1803 = cast<CXXRecordDecl>(Base.getType()->getAs<RecordType>()->getDecl());
Justin Bogner1cd11f12015-05-20 15:53:59 +00001804
John McCall5c60a6f2010-02-18 19:59:28 +00001805 // Ignore trivial destructors.
1806 if (BaseClassDecl->hasTrivialDestructor())
1807 continue;
John McCallf99a6312010-07-21 05:30:47 +00001808
John McCallcda666c2010-07-21 07:22:38 +00001809 EHStack.pushCleanup<CallBaseDtor>(NormalAndEHCleanup,
1810 BaseClassDecl,
1811 /*BaseIsVirtual*/ true);
John McCall5c60a6f2010-02-18 19:59:28 +00001812 }
John McCallf99a6312010-07-21 05:30:47 +00001813
John McCall5c60a6f2010-02-18 19:59:28 +00001814 return;
1815 }
1816
1817 assert(DtorType == Dtor_Base);
Naomi Musgrave703835c2015-09-16 00:38:22 +00001818 // Poison the vtable pointer if it has no virtual bases, but inherits
1819 // virtual functions.
1820 if (CGM.getCodeGenOpts().SanitizeMemoryUseAfterDtor &&
1821 SanOpts.has(SanitizerKind::Memory) && !ClassDecl->getNumVBases() &&
1822 ClassDecl->isPolymorphic())
1823 EHStack.pushCleanup<SanitizeDtorVTable>(NormalAndEHCleanup, DD);
Justin Bogner1cd11f12015-05-20 15:53:59 +00001824
John McCallf99a6312010-07-21 05:30:47 +00001825 // Destroy non-virtual bases.
Aaron Ballman574705e2014-03-13 15:41:46 +00001826 for (const auto &Base : ClassDecl->bases()) {
John McCallf99a6312010-07-21 05:30:47 +00001827 // Ignore virtual bases.
1828 if (Base.isVirtual())
1829 continue;
Justin Bogner1cd11f12015-05-20 15:53:59 +00001830
John McCallf99a6312010-07-21 05:30:47 +00001831 CXXRecordDecl *BaseClassDecl = Base.getType()->getAsCXXRecordDecl();
Justin Bogner1cd11f12015-05-20 15:53:59 +00001832
John McCallf99a6312010-07-21 05:30:47 +00001833 // Ignore trivial destructors.
1834 if (BaseClassDecl->hasTrivialDestructor())
1835 continue;
John McCall5c60a6f2010-02-18 19:59:28 +00001836
John McCallcda666c2010-07-21 07:22:38 +00001837 EHStack.pushCleanup<CallBaseDtor>(NormalAndEHCleanup,
1838 BaseClassDecl,
1839 /*BaseIsVirtual*/ false);
John McCallf99a6312010-07-21 05:30:47 +00001840 }
1841
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001842 // Poison fields such that access after their destructors are
1843 // invoked, and before the base class destructor runs, is invalid.
1844 if (CGM.getCodeGenOpts().SanitizeMemoryUseAfterDtor &&
1845 SanOpts.has(SanitizerKind::Memory))
Naomi Musgrave703835c2015-09-16 00:38:22 +00001846 EHStack.pushCleanup<SanitizeDtorMembers>(NormalAndEHCleanup, DD);
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001847
John McCallf99a6312010-07-21 05:30:47 +00001848 // Destroy direct fields.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001849 for (const auto *Field : ClassDecl->fields()) {
1850 QualType type = Field->getType();
John McCall4bd0fb12011-07-12 16:41:08 +00001851 QualType::DestructionKind dtorKind = type.isDestructedType();
1852 if (!dtorKind) continue;
John McCallf99a6312010-07-21 05:30:47 +00001853
Richard Smith921bd202012-02-26 09:11:52 +00001854 // Anonymous union members do not have their destructors called.
1855 const RecordType *RT = type->getAsUnionType();
1856 if (RT && RT->getDecl()->isAnonymousStructOrUnion()) continue;
1857
John McCall4bd0fb12011-07-12 16:41:08 +00001858 CleanupKind cleanupKind = getCleanupKind(dtorKind);
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001859 EHStack.pushCleanup<DestroyField>(cleanupKind, Field,
John McCall4bd0fb12011-07-12 16:41:08 +00001860 getDestroyer(dtorKind),
1861 cleanupKind & EHCleanup);
Anders Carlssonfb404882009-12-24 22:46:43 +00001862 }
Anders Carlssonfb404882009-12-24 22:46:43 +00001863}
1864
John McCallf677a8e2011-07-13 06:10:41 +00001865/// EmitCXXAggrConstructorCall - Emit a loop to call a particular
1866/// constructor for each of several members of an array.
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001867///
John McCallf677a8e2011-07-13 06:10:41 +00001868/// \param ctor the constructor to call for each element
John McCallf677a8e2011-07-13 06:10:41 +00001869/// \param arrayType the type of the array to initialize
1870/// \param arrayBegin an arrayType*
1871/// \param zeroInitialize true if each element should be
1872/// zero-initialized before it is constructed
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001873void CodeGenFunction::EmitCXXAggrConstructorCall(
Alexey Bataeve7545b32016-04-29 09:39:50 +00001874 const CXXConstructorDecl *ctor, const ArrayType *arrayType,
Serge Pavlov37605182018-07-28 15:33:03 +00001875 Address arrayBegin, const CXXConstructExpr *E, bool NewPointerIsChecked,
1876 bool zeroInitialize) {
John McCallf677a8e2011-07-13 06:10:41 +00001877 QualType elementType;
1878 llvm::Value *numElements =
1879 emitArrayLength(arrayType, elementType, arrayBegin);
Anders Carlsson27da15b2010-01-01 20:29:01 +00001880
Serge Pavlov37605182018-07-28 15:33:03 +00001881 EmitCXXAggrConstructorCall(ctor, numElements, arrayBegin, E,
1882 NewPointerIsChecked, zeroInitialize);
Anders Carlsson27da15b2010-01-01 20:29:01 +00001883}
1884
John McCallf677a8e2011-07-13 06:10:41 +00001885/// EmitCXXAggrConstructorCall - Emit a loop to call a particular
1886/// constructor for each of several members of an array.
1887///
1888/// \param ctor the constructor to call for each element
1889/// \param numElements the number of elements in the array;
John McCall6549b312011-07-13 07:37:11 +00001890/// may be zero
NAKAMURA Takumiff7a9252015-09-08 09:42:41 +00001891/// \param arrayBase a T*, where T is the type constructed by ctor
John McCallf677a8e2011-07-13 06:10:41 +00001892/// \param zeroInitialize true if each element should be
1893/// zero-initialized before it is constructed
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001894void CodeGenFunction::EmitCXXAggrConstructorCall(const CXXConstructorDecl *ctor,
1895 llvm::Value *numElements,
John McCall7f416cc2015-09-08 08:05:57 +00001896 Address arrayBase,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001897 const CXXConstructExpr *E,
Serge Pavlov37605182018-07-28 15:33:03 +00001898 bool NewPointerIsChecked,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001899 bool zeroInitialize) {
John McCall6549b312011-07-13 07:37:11 +00001900 // It's legal for numElements to be zero. This can happen both
1901 // dynamically, because x can be zero in 'new A[x]', and statically,
1902 // because of GCC extensions that permit zero-length arrays. There
1903 // are probably legitimate places where we could assume that this
1904 // doesn't happen, but it's not clear that it's worth it.
Craig Topper8a13c412014-05-21 05:09:00 +00001905 llvm::BranchInst *zeroCheckBranch = nullptr;
John McCall6549b312011-07-13 07:37:11 +00001906
1907 // Optimize for a constant count.
1908 llvm::ConstantInt *constantCount
1909 = dyn_cast<llvm::ConstantInt>(numElements);
1910 if (constantCount) {
1911 // Just skip out if the constant count is zero.
1912 if (constantCount->isZero()) return;
1913
1914 // Otherwise, emit the check.
1915 } else {
1916 llvm::BasicBlock *loopBB = createBasicBlock("new.ctorloop");
1917 llvm::Value *iszero = Builder.CreateIsNull(numElements, "isempty");
1918 zeroCheckBranch = Builder.CreateCondBr(iszero, loopBB, loopBB);
1919 EmitBlock(loopBB);
1920 }
Justin Bogner1cd11f12015-05-20 15:53:59 +00001921
John McCallf677a8e2011-07-13 06:10:41 +00001922 // Find the end of the array.
John McCall7f416cc2015-09-08 08:05:57 +00001923 llvm::Value *arrayBegin = arrayBase.getPointer();
John McCallf677a8e2011-07-13 06:10:41 +00001924 llvm::Value *arrayEnd = Builder.CreateInBoundsGEP(arrayBegin, numElements,
1925 "arrayctor.end");
Anders Carlsson27da15b2010-01-01 20:29:01 +00001926
John McCallf677a8e2011-07-13 06:10:41 +00001927 // Enter the loop, setting up a phi for the current location to initialize.
1928 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
1929 llvm::BasicBlock *loopBB = createBasicBlock("arrayctor.loop");
1930 EmitBlock(loopBB);
1931 llvm::PHINode *cur = Builder.CreatePHI(arrayBegin->getType(), 2,
1932 "arrayctor.cur");
1933 cur->addIncoming(arrayBegin, entryBB);
Anders Carlsson27da15b2010-01-01 20:29:01 +00001934
Anders Carlsson27da15b2010-01-01 20:29:01 +00001935 // Inside the loop body, emit the constructor call on the array element.
John McCallf677a8e2011-07-13 06:10:41 +00001936
John McCall7f416cc2015-09-08 08:05:57 +00001937 // The alignment of the base, adjusted by the size of a single element,
1938 // provides a conservative estimate of the alignment of every element.
1939 // (This assumes we never start tracking offsetted alignments.)
Fangrui Song6907ce22018-07-30 19:24:48 +00001940 //
John McCall7f416cc2015-09-08 08:05:57 +00001941 // Note that these are complete objects and so we don't need to
1942 // use the non-virtual size or alignment.
John McCallf677a8e2011-07-13 06:10:41 +00001943 QualType type = getContext().getTypeDeclType(ctor->getParent());
John McCall7f416cc2015-09-08 08:05:57 +00001944 CharUnits eltAlignment =
1945 arrayBase.getAlignment()
1946 .alignmentOfArrayElement(getContext().getTypeSizeInChars(type));
1947 Address curAddr = Address(cur, eltAlignment);
Anders Carlsson27da15b2010-01-01 20:29:01 +00001948
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001949 // Zero initialize the storage, if requested.
John McCallf677a8e2011-07-13 06:10:41 +00001950 if (zeroInitialize)
John McCall7f416cc2015-09-08 08:05:57 +00001951 EmitNullInitialization(curAddr, type);
Justin Bogner1cd11f12015-05-20 15:53:59 +00001952
1953 // C++ [class.temporary]p4:
Anders Carlsson27da15b2010-01-01 20:29:01 +00001954 // There are two contexts in which temporaries are destroyed at a different
1955 // point than the end of the full-expression. The first context is when a
Justin Bogner1cd11f12015-05-20 15:53:59 +00001956 // default constructor is called to initialize an element of an array.
1957 // If the constructor has one or more default arguments, the destruction of
1958 // every temporary created in a default argument expression is sequenced
Anders Carlsson27da15b2010-01-01 20:29:01 +00001959 // before the construction of the next array element, if any.
Justin Bogner1cd11f12015-05-20 15:53:59 +00001960
Anders Carlssonb9fd57f2010-03-30 03:14:41 +00001961 {
John McCallbd309292010-07-06 01:34:17 +00001962 RunCleanupsScope Scope(*this);
Anders Carlsson27da15b2010-01-01 20:29:01 +00001963
John McCallf677a8e2011-07-13 06:10:41 +00001964 // Evaluate the constructor and its arguments in a regular
1965 // partial-destroy cleanup.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001966 if (getLangOpts().Exceptions &&
John McCallf677a8e2011-07-13 06:10:41 +00001967 !ctor->getParent()->hasTrivialDestructor()) {
1968 Destroyer *destroyer = destroyCXXObject;
John McCall7f416cc2015-09-08 08:05:57 +00001969 pushRegularPartialArrayCleanup(arrayBegin, cur, type, eltAlignment,
1970 *destroyer);
John McCallf677a8e2011-07-13 06:10:41 +00001971 }
1972
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001973 EmitCXXConstructorCall(ctor, Ctor_Complete, /*ForVirtualBase=*/false,
Richard Smithe78fac52018-04-05 20:52:58 +00001974 /*Delegating=*/false, curAddr, E,
Serge Pavlov37605182018-07-28 15:33:03 +00001975 AggValueSlot::DoesNotOverlap, NewPointerIsChecked);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +00001976 }
Anders Carlsson27da15b2010-01-01 20:29:01 +00001977
John McCallf677a8e2011-07-13 06:10:41 +00001978 // Go to the next element.
1979 llvm::Value *next =
1980 Builder.CreateInBoundsGEP(cur, llvm::ConstantInt::get(SizeTy, 1),
1981 "arrayctor.next");
1982 cur->addIncoming(next, Builder.GetInsertBlock());
Anders Carlsson27da15b2010-01-01 20:29:01 +00001983
John McCallf677a8e2011-07-13 06:10:41 +00001984 // Check whether that's the end of the loop.
1985 llvm::Value *done = Builder.CreateICmpEQ(next, arrayEnd, "arrayctor.done");
1986 llvm::BasicBlock *contBB = createBasicBlock("arrayctor.cont");
1987 Builder.CreateCondBr(done, contBB, loopBB);
Anders Carlsson27da15b2010-01-01 20:29:01 +00001988
John McCall6549b312011-07-13 07:37:11 +00001989 // Patch the earlier check to skip over the loop.
1990 if (zeroCheckBranch) zeroCheckBranch->setSuccessor(0, contBB);
1991
John McCallf677a8e2011-07-13 06:10:41 +00001992 EmitBlock(contBB);
Anders Carlsson27da15b2010-01-01 20:29:01 +00001993}
1994
John McCall82fe67b2011-07-09 01:37:26 +00001995void CodeGenFunction::destroyCXXObject(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001996 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00001997 QualType type) {
1998 const RecordType *rtype = type->castAs<RecordType>();
1999 const CXXRecordDecl *record = cast<CXXRecordDecl>(rtype->getDecl());
2000 const CXXDestructorDecl *dtor = record->getDestructor();
2001 assert(!dtor->isTrivial());
2002 CGF.EmitCXXDestructorCall(dtor, Dtor_Complete, /*for vbase*/ false,
Douglas Gregor61535002013-01-31 05:50:40 +00002003 /*Delegating=*/false, addr);
John McCall82fe67b2011-07-09 01:37:26 +00002004}
2005
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002006void CodeGenFunction::EmitCXXConstructorCall(const CXXConstructorDecl *D,
2007 CXXCtorType Type,
2008 bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +00002009 bool Delegating, Address This,
Richard Smithe78fac52018-04-05 20:52:58 +00002010 const CXXConstructExpr *E,
Serge Pavlov37605182018-07-28 15:33:03 +00002011 AggValueSlot::Overlap_t Overlap,
2012 bool NewPointerIsChecked) {
Richard Smith5179eb72016-06-28 19:03:57 +00002013 CallArgList Args;
2014
2015 // Push the this ptr.
2016 Args.add(RValue::get(This.getPointer()), D->getThisType(getContext()));
2017
2018 // If this is a trivial constructor, emit a memcpy now before we lose
2019 // the alignment information on the argument.
2020 // FIXME: It would be better to preserve alignment information into CallArg.
2021 if (isMemcpyEquivalentSpecialMember(D)) {
2022 assert(E->getNumArgs() == 1 && "unexpected argcount for trivial ctor");
2023
2024 const Expr *Arg = E->getArg(0);
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00002025 LValue Src = EmitLValue(Arg);
Richard Smith5179eb72016-06-28 19:03:57 +00002026 QualType DestTy = getContext().getTypeDeclType(D->getParent());
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00002027 LValue Dest = MakeAddrLValue(This, DestTy);
Richard Smithe78fac52018-04-05 20:52:58 +00002028 EmitAggregateCopyCtor(Dest, Src, Overlap);
Richard Smith5179eb72016-06-28 19:03:57 +00002029 return;
2030 }
2031
2032 // Add the rest of the user-supplied arguments.
2033 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
Hans Wennborg27dcc6c2017-02-01 02:21:07 +00002034 EvaluationOrder Order = E->isListInitialization()
2035 ? EvaluationOrder::ForceLeftToRight
2036 : EvaluationOrder::Default;
2037 EmitCallArgs(Args, FPT, E->arguments(), E->getConstructor(),
2038 /*ParamsToSkip*/ 0, Order);
Richard Smith5179eb72016-06-28 19:03:57 +00002039
Richard Smithe78fac52018-04-05 20:52:58 +00002040 EmitCXXConstructorCall(D, Type, ForVirtualBase, Delegating, This, Args,
Serge Pavlov37605182018-07-28 15:33:03 +00002041 Overlap, E->getExprLoc(), NewPointerIsChecked);
Richard Smith5179eb72016-06-28 19:03:57 +00002042}
2043
2044static bool canEmitDelegateCallArgs(CodeGenFunction &CGF,
2045 const CXXConstructorDecl *Ctor,
2046 CXXCtorType Type, CallArgList &Args) {
2047 // We can't forward a variadic call.
2048 if (Ctor->isVariadic())
2049 return false;
2050
2051 if (CGF.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2052 // If the parameters are callee-cleanup, it's not safe to forward.
2053 for (auto *P : Ctor->parameters())
2054 if (P->getType().isDestructedType())
2055 return false;
2056
2057 // Likewise if they're inalloca.
2058 const CGFunctionInfo &Info =
George Burgess IVd0a9e802017-02-23 22:07:35 +00002059 CGF.CGM.getTypes().arrangeCXXConstructorCall(Args, Ctor, Type, 0, 0);
Richard Smith5179eb72016-06-28 19:03:57 +00002060 if (Info.usesInAlloca())
2061 return false;
2062 }
2063
2064 // Anything else should be OK.
2065 return true;
2066}
2067
2068void CodeGenFunction::EmitCXXConstructorCall(const CXXConstructorDecl *D,
2069 CXXCtorType Type,
2070 bool ForVirtualBase,
2071 bool Delegating,
2072 Address This,
Richard Smithe78fac52018-04-05 20:52:58 +00002073 CallArgList &Args,
Igor Kudrineff8f9d2018-06-25 05:48:04 +00002074 AggValueSlot::Overlap_t Overlap,
Serge Pavlov37605182018-07-28 15:33:03 +00002075 SourceLocation Loc,
2076 bool NewPointerIsChecked) {
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002077 const CXXRecordDecl *ClassDecl = D->getParent();
2078
Serge Pavlov37605182018-07-28 15:33:03 +00002079 if (!NewPointerIsChecked)
2080 EmitTypeCheck(CodeGenFunction::TCK_ConstructorCall, Loc, This.getPointer(),
2081 getContext().getRecordType(ClassDecl), CharUnits::Zero());
John McCallca972cd2010-02-06 00:25:16 +00002082
Richard Smith419bd092015-04-29 19:26:57 +00002083 if (D->isTrivial() && D->isDefaultConstructor()) {
Richard Smith5179eb72016-06-28 19:03:57 +00002084 assert(Args.size() == 1 && "trivial default ctor with args");
Richard Smith419bd092015-04-29 19:26:57 +00002085 return;
2086 }
2087
2088 // If this is a trivial constructor, just emit what's needed. If this is a
2089 // union copy constructor, we must emit a memcpy, because the AST does not
2090 // model that copy.
2091 if (isMemcpyEquivalentSpecialMember(D)) {
Richard Smith5179eb72016-06-28 19:03:57 +00002092 assert(Args.size() == 2 && "unexpected argcount for trivial ctor");
John McCallca972cd2010-02-06 00:25:16 +00002093
Richard Smith5179eb72016-06-28 19:03:57 +00002094 QualType SrcTy = D->getParamDecl(0)->getType().getNonReferenceType();
Yaxun Liu5b330e82018-03-15 15:25:19 +00002095 Address Src(Args[1].getRValue(*this).getScalarVal(),
2096 getNaturalTypeAlignment(SrcTy));
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00002097 LValue SrcLVal = MakeAddrLValue(Src, SrcTy);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002098 QualType DestTy = getContext().getTypeDeclType(ClassDecl);
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00002099 LValue DestLVal = MakeAddrLValue(This, DestTy);
Richard Smithe78fac52018-04-05 20:52:58 +00002100 EmitAggregateCopyCtor(DestLVal, SrcLVal, Overlap);
Anders Carlsson27da15b2010-01-01 20:29:01 +00002101 return;
2102 }
2103
George Burgess IVd0a9e802017-02-23 22:07:35 +00002104 bool PassPrototypeArgs = true;
Richard Smith5179eb72016-06-28 19:03:57 +00002105 // Check whether we can actually emit the constructor before trying to do so.
2106 if (auto Inherited = D->getInheritedConstructor()) {
George Burgess IVd0a9e802017-02-23 22:07:35 +00002107 PassPrototypeArgs = getTypes().inheritingCtorHasParams(Inherited, Type);
2108 if (PassPrototypeArgs && !canEmitDelegateCallArgs(*this, D, Type, Args)) {
Richard Smith5179eb72016-06-28 19:03:57 +00002109 EmitInlinedInheritingCXXConstructorCall(D, Type, ForVirtualBase,
2110 Delegating, Args);
2111 return;
2112 }
2113 }
Reid Kleckner89077a12013-12-17 19:46:40 +00002114
2115 // Insert any ABI-specific implicit constructor arguments.
George Burgess IVf203dbf2017-02-22 20:28:02 +00002116 CGCXXABI::AddedStructorArgs ExtraArgs =
2117 CGM.getCXXABI().addImplicitConstructorArgs(*this, D, Type, ForVirtualBase,
2118 Delegating, Args);
Reid Kleckner89077a12013-12-17 19:46:40 +00002119
2120 // Emit the call.
John McCallb92ab1a2016-10-26 23:46:34 +00002121 llvm::Constant *CalleePtr =
2122 CGM.getAddrOfCXXStructor(D, getFromCtorType(Type));
George Burgess IVf203dbf2017-02-22 20:28:02 +00002123 const CGFunctionInfo &Info = CGM.getTypes().arrangeCXXConstructorCall(
George Burgess IVd0a9e802017-02-23 22:07:35 +00002124 Args, D, Type, ExtraArgs.Prefix, ExtraArgs.Suffix, PassPrototypeArgs);
Erich Keanede6480a32018-11-13 15:48:08 +00002125 CGCallee Callee = CGCallee::forDirect(CalleePtr, GlobalDecl(D, Type));
John McCallb92ab1a2016-10-26 23:46:34 +00002126 EmitCall(Info, Callee, ReturnValueSlot(), Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002127
2128 // Generate vtable assumptions if we're constructing a complete object
2129 // with a vtable. We don't do this for base subobjects for two reasons:
2130 // first, it's incorrect for classes with virtual bases, and second, we're
2131 // about to overwrite the vptrs anyway.
2132 // We also have to make sure if we can refer to vtable:
2133 // - Otherwise we can refer to vtable if it's safe to speculatively emit.
2134 // FIXME: If vtable is used by ctor/dtor, or if vtable is external and we are
2135 // sure that definition of vtable is not hidden,
2136 // then we are always safe to refer to it.
Piotr Padlewski69dc9712015-09-28 20:30:22 +00002137 // FIXME: It looks like InstCombine is very inefficient on dealing with
2138 // assumes. Make assumption loads require -fstrict-vtable-pointers temporarily.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002139 if (CGM.getCodeGenOpts().OptimizationLevel > 0 &&
2140 ClassDecl->isDynamicClass() && Type != Ctor_Base &&
Piotr Padlewski69dc9712015-09-28 20:30:22 +00002141 CGM.getCXXABI().canSpeculativelyEmitVTable(ClassDecl) &&
2142 CGM.getCodeGenOpts().StrictVTablePointers)
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002143 EmitVTableAssumptionLoads(ClassDecl, This);
2144}
2145
Richard Smith5179eb72016-06-28 19:03:57 +00002146void CodeGenFunction::EmitInheritedCXXConstructorCall(
2147 const CXXConstructorDecl *D, bool ForVirtualBase, Address This,
2148 bool InheritedFromVBase, const CXXInheritedCtorInitExpr *E) {
2149 CallArgList Args;
Yaxun Liu5b330e82018-03-15 15:25:19 +00002150 CallArg ThisArg(RValue::get(This.getPointer()), D->getThisType(getContext()));
Richard Smith5179eb72016-06-28 19:03:57 +00002151
2152 // Forward the parameters.
2153 if (InheritedFromVBase &&
2154 CGM.getTarget().getCXXABI().hasConstructorVariants()) {
2155 // Nothing to do; this construction is not responsible for constructing
2156 // the base class containing the inherited constructor.
2157 // FIXME: Can we just pass undef's for the remaining arguments if we don't
2158 // have constructor variants?
2159 Args.push_back(ThisArg);
2160 } else if (!CXXInheritedCtorInitExprArgs.empty()) {
2161 // The inheriting constructor was inlined; just inject its arguments.
2162 assert(CXXInheritedCtorInitExprArgs.size() >= D->getNumParams() &&
2163 "wrong number of parameters for inherited constructor call");
2164 Args = CXXInheritedCtorInitExprArgs;
2165 Args[0] = ThisArg;
2166 } else {
2167 // The inheriting constructor was not inlined. Emit delegating arguments.
2168 Args.push_back(ThisArg);
2169 const auto *OuterCtor = cast<CXXConstructorDecl>(CurCodeDecl);
2170 assert(OuterCtor->getNumParams() == D->getNumParams());
2171 assert(!OuterCtor->isVariadic() && "should have been inlined");
2172
2173 for (const auto *Param : OuterCtor->parameters()) {
2174 assert(getContext().hasSameUnqualifiedType(
2175 OuterCtor->getParamDecl(Param->getFunctionScopeIndex())->getType(),
2176 Param->getType()));
2177 EmitDelegateCallArg(Args, Param, E->getLocation());
2178
2179 // Forward __attribute__(pass_object_size).
2180 if (Param->hasAttr<PassObjectSizeAttr>()) {
2181 auto *POSParam = SizeArguments[Param];
2182 assert(POSParam && "missing pass_object_size value for forwarding");
2183 EmitDelegateCallArg(Args, POSParam, E->getLocation());
2184 }
2185 }
2186 }
2187
2188 EmitCXXConstructorCall(D, Ctor_Base, ForVirtualBase, /*Delegating*/false,
Igor Kudrineff8f9d2018-06-25 05:48:04 +00002189 This, Args, AggValueSlot::MayOverlap,
Serge Pavlov37605182018-07-28 15:33:03 +00002190 E->getLocation(), /*NewPointerIsChecked*/true);
Richard Smith5179eb72016-06-28 19:03:57 +00002191}
2192
2193void CodeGenFunction::EmitInlinedInheritingCXXConstructorCall(
2194 const CXXConstructorDecl *Ctor, CXXCtorType CtorType, bool ForVirtualBase,
2195 bool Delegating, CallArgList &Args) {
Adrian Prantlb7acfc02017-02-27 21:30:05 +00002196 GlobalDecl GD(Ctor, CtorType);
2197 InlinedInheritingConstructorScope Scope(*this, GD);
2198 ApplyInlineDebugLocation DebugScope(*this, GD);
Richard Smith5179eb72016-06-28 19:03:57 +00002199
2200 // Save the arguments to be passed to the inherited constructor.
2201 CXXInheritedCtorInitExprArgs = Args;
2202
2203 FunctionArgList Params;
2204 QualType RetType = BuildFunctionArgList(CurGD, Params);
2205 FnRetTy = RetType;
2206
2207 // Insert any ABI-specific implicit constructor arguments.
2208 CGM.getCXXABI().addImplicitConstructorArgs(*this, Ctor, CtorType,
2209 ForVirtualBase, Delegating, Args);
2210
2211 // Emit a simplified prolog. We only need to emit the implicit params.
2212 assert(Args.size() >= Params.size() && "too few arguments for call");
2213 for (unsigned I = 0, N = Args.size(); I != N; ++I) {
2214 if (I < Params.size() && isa<ImplicitParamDecl>(Params[I])) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00002215 const RValue &RV = Args[I].getRValue(*this);
Richard Smith5179eb72016-06-28 19:03:57 +00002216 assert(!RV.isComplex() && "complex indirect params not supported");
2217 ParamValue Val = RV.isScalar()
2218 ? ParamValue::forDirect(RV.getScalarVal())
2219 : ParamValue::forIndirect(RV.getAggregateAddress());
2220 EmitParmDecl(*Params[I], Val, I + 1);
2221 }
2222 }
2223
2224 // Create a return value slot if the ABI implementation wants one.
2225 // FIXME: This is dumb, we should ask the ABI not to try to set the return
2226 // value instead.
2227 if (!RetType->isVoidType())
2228 ReturnValue = CreateIRTemp(RetType, "retval.inhctor");
2229
2230 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
2231 CXXThisValue = CXXABIThisValue;
2232
2233 // Directly emit the constructor initializers.
2234 EmitCtorPrologue(Ctor, CtorType, Params);
2235}
2236
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002237void CodeGenFunction::EmitVTableAssumptionLoad(const VPtr &Vptr, Address This) {
2238 llvm::Value *VTableGlobal =
2239 CGM.getCXXABI().getVTableAddressPoint(Vptr.Base, Vptr.VTableClass);
2240 if (!VTableGlobal)
2241 return;
2242
2243 // We can just use the base offset in the complete class.
2244 CharUnits NonVirtualOffset = Vptr.Base.getBaseOffset();
2245
2246 if (!NonVirtualOffset.isZero())
2247 This =
2248 ApplyNonVirtualAndVirtualOffset(*this, This, NonVirtualOffset, nullptr,
2249 Vptr.VTableClass, Vptr.NearestVBase);
2250
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00002251 llvm::Value *VPtrValue =
2252 GetVTablePtr(This, VTableGlobal->getType(), Vptr.VTableClass);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002253 llvm::Value *Cmp =
2254 Builder.CreateICmpEQ(VPtrValue, VTableGlobal, "cmp.vtables");
2255 Builder.CreateAssumption(Cmp);
2256}
2257
2258void CodeGenFunction::EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl,
2259 Address This) {
2260 if (CGM.getCXXABI().doStructorsInitializeVPtrs(ClassDecl))
2261 for (const VPtr &Vptr : getVTablePointers(ClassDecl))
2262 EmitVTableAssumptionLoad(Vptr, This);
Anders Carlsson27da15b2010-01-01 20:29:01 +00002263}
2264
John McCallf8ff7b92010-02-23 00:48:20 +00002265void
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002266CodeGenFunction::EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002267 Address This, Address Src,
2268 const CXXConstructExpr *E) {
Reid Kleckner739756c2013-12-04 19:23:12 +00002269 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
Justin Bogner1cd11f12015-05-20 15:53:59 +00002270
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002271 CallArgList Args;
Justin Bogner1cd11f12015-05-20 15:53:59 +00002272
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002273 // Push the this ptr.
John McCall7f416cc2015-09-08 08:05:57 +00002274 Args.add(RValue::get(This.getPointer()), D->getThisType(getContext()));
Justin Bogner1cd11f12015-05-20 15:53:59 +00002275
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002276 // Push the src ptr.
Alp Toker9cacbab2014-01-20 20:26:09 +00002277 QualType QT = *(FPT->param_type_begin());
Chris Lattner2192fe52011-07-18 04:24:23 +00002278 llvm::Type *t = CGM.getTypes().ConvertType(QT);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002279 Src = Builder.CreateBitCast(Src, t);
John McCall7f416cc2015-09-08 08:05:57 +00002280 Args.add(RValue::get(Src.getPointer()), QT);
Reid Kleckner739756c2013-12-04 19:23:12 +00002281
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002282 // Skip over first argument (Src).
David Blaikief05779e2015-07-21 18:37:18 +00002283 EmitCallArgs(Args, FPT, drop_begin(E->arguments(), 1), E->getConstructor(),
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002284 /*ParamsToSkip*/ 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002285
Serge Pavlov37605182018-07-28 15:33:03 +00002286 EmitCXXConstructorCall(D, Ctor_Complete, /*ForVirtualBase*/false,
2287 /*Delegating*/false, This, Args,
2288 AggValueSlot::MayOverlap, E->getExprLoc(),
2289 /*NewPointerIsChecked*/false);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002290}
2291
2292void
John McCallf8ff7b92010-02-23 00:48:20 +00002293CodeGenFunction::EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2294 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002295 const FunctionArgList &Args,
2296 SourceLocation Loc) {
John McCallf8ff7b92010-02-23 00:48:20 +00002297 CallArgList DelegateArgs;
2298
2299 FunctionArgList::const_iterator I = Args.begin(), E = Args.end();
2300 assert(I != E && "no parameters to constructor");
2301
2302 // this
Richard Smith5179eb72016-06-28 19:03:57 +00002303 Address This = LoadCXXThisAddress();
2304 DelegateArgs.add(RValue::get(This.getPointer()), (*I)->getType());
John McCallf8ff7b92010-02-23 00:48:20 +00002305 ++I;
2306
Richard Smith5179eb72016-06-28 19:03:57 +00002307 // FIXME: The location of the VTT parameter in the parameter list is
2308 // specific to the Itanium ABI and shouldn't be hardcoded here.
2309 if (CGM.getCXXABI().NeedsVTTParameter(CurGD)) {
2310 assert(I != E && "cannot skip vtt parameter, already done with args");
2311 assert((*I)->getType()->isPointerType() &&
2312 "skipping parameter not of vtt type");
2313 ++I;
John McCallf8ff7b92010-02-23 00:48:20 +00002314 }
2315
2316 // Explicit arguments.
2317 for (; I != E; ++I) {
John McCall32ea9692011-03-11 20:59:21 +00002318 const VarDecl *param = *I;
Nick Lewycky2d84e842013-10-02 02:29:49 +00002319 // FIXME: per-argument source location
2320 EmitDelegateCallArg(DelegateArgs, param, Loc);
John McCallf8ff7b92010-02-23 00:48:20 +00002321 }
2322
Richard Smith5179eb72016-06-28 19:03:57 +00002323 EmitCXXConstructorCall(Ctor, CtorType, /*ForVirtualBase=*/false,
Richard Smithe78fac52018-04-05 20:52:58 +00002324 /*Delegating=*/true, This, DelegateArgs,
Serge Pavlov37605182018-07-28 15:33:03 +00002325 AggValueSlot::MayOverlap, Loc,
2326 /*NewPointerIsChecked=*/true);
John McCallf8ff7b92010-02-23 00:48:20 +00002327}
2328
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002329namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002330 struct CallDelegatingCtorDtor final : EHScopeStack::Cleanup {
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002331 const CXXDestructorDecl *Dtor;
John McCall7f416cc2015-09-08 08:05:57 +00002332 Address Addr;
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002333 CXXDtorType Type;
2334
John McCall7f416cc2015-09-08 08:05:57 +00002335 CallDelegatingCtorDtor(const CXXDestructorDecl *D, Address Addr,
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002336 CXXDtorType Type)
2337 : Dtor(D), Addr(Addr), Type(Type) {}
2338
Craig Topper4f12f102014-03-12 06:41:41 +00002339 void Emit(CodeGenFunction &CGF, Flags flags) override {
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002340 CGF.EmitCXXDestructorCall(Dtor, Type, /*ForVirtualBase=*/false,
Douglas Gregor61535002013-01-31 05:50:40 +00002341 /*Delegating=*/true, Addr);
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002342 }
2343 };
Hans Wennborgdcfba332015-10-06 23:40:43 +00002344} // end anonymous namespace
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002345
Alexis Hunt61bc1732011-05-01 07:04:31 +00002346void
2347CodeGenFunction::EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2348 const FunctionArgList &Args) {
2349 assert(Ctor->isDelegatingConstructor());
2350
John McCall7f416cc2015-09-08 08:05:57 +00002351 Address ThisPtr = LoadCXXThisAddress();
Alexis Hunt61bc1732011-05-01 07:04:31 +00002352
John McCall31168b02011-06-15 23:02:42 +00002353 AggValueSlot AggSlot =
John McCall7f416cc2015-09-08 08:05:57 +00002354 AggValueSlot::forAddr(ThisPtr, Qualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00002355 AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00002356 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00002357 AggValueSlot::IsNotAliased,
Serge Pavlov37605182018-07-28 15:33:03 +00002358 AggValueSlot::MayOverlap,
2359 AggValueSlot::IsNotZeroed,
2360 // Checks are made by the code that calls constructor.
2361 AggValueSlot::IsSanitizerChecked);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002362
2363 EmitAggExpr(Ctor->init_begin()[0]->getInit(), AggSlot);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002364
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002365 const CXXRecordDecl *ClassDecl = Ctor->getParent();
David Blaikiebbafb8a2012-03-11 07:00:24 +00002366 if (CGM.getLangOpts().Exceptions && !ClassDecl->hasTrivialDestructor()) {
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002367 CXXDtorType Type =
2368 CurGD.getCtorType() == Ctor_Complete ? Dtor_Complete : Dtor_Base;
2369
2370 EHStack.pushCleanup<CallDelegatingCtorDtor>(EHCleanup,
2371 ClassDecl->getDestructor(),
2372 ThisPtr, Type);
2373 }
2374}
Alexis Hunt61bc1732011-05-01 07:04:31 +00002375
Anders Carlsson27da15b2010-01-01 20:29:01 +00002376void CodeGenFunction::EmitCXXDestructorCall(const CXXDestructorDecl *DD,
2377 CXXDtorType Type,
Anders Carlssonf8a71f02010-05-02 23:29:11 +00002378 bool ForVirtualBase,
Douglas Gregor61535002013-01-31 05:50:40 +00002379 bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002380 Address This) {
Reid Kleckner6fe771a2013-12-13 00:53:54 +00002381 CGM.getCXXABI().EmitDestructorCall(*this, DD, Type, ForVirtualBase,
2382 Delegating, This);
Anders Carlsson27da15b2010-01-01 20:29:01 +00002383}
2384
John McCall53cad2e2010-07-21 01:41:18 +00002385namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002386 struct CallLocalDtor final : EHScopeStack::Cleanup {
John McCall53cad2e2010-07-21 01:41:18 +00002387 const CXXDestructorDecl *Dtor;
John McCall7f416cc2015-09-08 08:05:57 +00002388 Address Addr;
John McCall53cad2e2010-07-21 01:41:18 +00002389
John McCall7f416cc2015-09-08 08:05:57 +00002390 CallLocalDtor(const CXXDestructorDecl *D, Address Addr)
John McCall53cad2e2010-07-21 01:41:18 +00002391 : Dtor(D), Addr(Addr) {}
2392
Craig Topper4f12f102014-03-12 06:41:41 +00002393 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall53cad2e2010-07-21 01:41:18 +00002394 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
Douglas Gregor61535002013-01-31 05:50:40 +00002395 /*ForVirtualBase=*/false,
2396 /*Delegating=*/false, Addr);
John McCall53cad2e2010-07-21 01:41:18 +00002397 }
2398 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002399} // end anonymous namespace
John McCall53cad2e2010-07-21 01:41:18 +00002400
John McCall8680f872010-07-21 06:29:51 +00002401void CodeGenFunction::PushDestructorCleanup(const CXXDestructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002402 Address Addr) {
John McCallcda666c2010-07-21 07:22:38 +00002403 EHStack.pushCleanup<CallLocalDtor>(NormalAndEHCleanup, D, Addr);
John McCall8680f872010-07-21 06:29:51 +00002404}
2405
John McCall7f416cc2015-09-08 08:05:57 +00002406void CodeGenFunction::PushDestructorCleanup(QualType T, Address Addr) {
John McCallbd309292010-07-06 01:34:17 +00002407 CXXRecordDecl *ClassDecl = T->getAsCXXRecordDecl();
2408 if (!ClassDecl) return;
2409 if (ClassDecl->hasTrivialDestructor()) return;
2410
2411 const CXXDestructorDecl *D = ClassDecl->getDestructor();
John McCalla85af562011-04-28 02:15:35 +00002412 assert(D && D->isUsed() && "destructor not marked as used!");
John McCall8680f872010-07-21 06:29:51 +00002413 PushDestructorCleanup(D, Addr);
John McCallbd309292010-07-06 01:34:17 +00002414}
2415
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002416void CodeGenFunction::InitializeVTablePointer(const VPtr &Vptr) {
Anders Carlssone87fae92010-03-28 19:40:00 +00002417 // Compute the address point.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002418 llvm::Value *VTableAddressPoint =
2419 CGM.getCXXABI().getVTableAddressPointInStructor(
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002420 *this, Vptr.VTableClass, Vptr.Base, Vptr.NearestVBase);
2421
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002422 if (!VTableAddressPoint)
2423 return;
Anders Carlssone87fae92010-03-28 19:40:00 +00002424
Anders Carlsson6a0227d2010-04-20 16:22:16 +00002425 // Compute where to store the address point.
Craig Topper8a13c412014-05-21 05:09:00 +00002426 llvm::Value *VirtualOffset = nullptr;
Ken Dyckcfc332c2011-03-23 00:45:26 +00002427 CharUnits NonVirtualOffset = CharUnits::Zero();
Justin Bogner1cd11f12015-05-20 15:53:59 +00002428
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002429 if (CGM.getCXXABI().isVirtualOffsetNeededForVTableField(*this, Vptr)) {
Anders Carlsson91baecf2010-04-20 18:05:10 +00002430 // We need to use the virtual base offset offset because the virtual base
2431 // might have a different offset in the most derived class.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002432
2433 VirtualOffset = CGM.getCXXABI().GetVirtualBaseClassOffset(
2434 *this, LoadCXXThisAddress(), Vptr.VTableClass, Vptr.NearestVBase);
2435 NonVirtualOffset = Vptr.OffsetFromNearestVBase;
Anders Carlsson91baecf2010-04-20 18:05:10 +00002436 } else {
Anders Carlssonc58fb552010-05-03 00:29:58 +00002437 // We can just use the base offset in the complete class.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002438 NonVirtualOffset = Vptr.Base.getBaseOffset();
Anders Carlsson91baecf2010-04-20 18:05:10 +00002439 }
Justin Bogner1cd11f12015-05-20 15:53:59 +00002440
Anders Carlssonc58fb552010-05-03 00:29:58 +00002441 // Apply the offsets.
John McCall7f416cc2015-09-08 08:05:57 +00002442 Address VTableField = LoadCXXThisAddress();
Justin Bogner1cd11f12015-05-20 15:53:59 +00002443
Ken Dyckcfc332c2011-03-23 00:45:26 +00002444 if (!NonVirtualOffset.isZero() || VirtualOffset)
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002445 VTableField = ApplyNonVirtualAndVirtualOffset(
2446 *this, VTableField, NonVirtualOffset, VirtualOffset, Vptr.VTableClass,
2447 Vptr.NearestVBase);
Anders Carlsson6a0227d2010-04-20 16:22:16 +00002448
Reid Kleckner8d585132014-12-03 21:00:21 +00002449 // Finally, store the address point. Use the same LLVM types as the field to
2450 // support optimization.
2451 llvm::Type *VTablePtrTy =
2452 llvm::FunctionType::get(CGM.Int32Ty, /*isVarArg=*/true)
2453 ->getPointerTo()
2454 ->getPointerTo();
2455 VTableField = Builder.CreateBitCast(VTableField, VTablePtrTy->getPointerTo());
2456 VTableAddressPoint = Builder.CreateBitCast(VTableAddressPoint, VTablePtrTy);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002457
Kostya Serebryany141e46f2012-03-26 17:03:51 +00002458 llvm::StoreInst *Store = Builder.CreateStore(VTableAddressPoint, VTableField);
Ivan A. Kosarev4e50e702017-11-27 09:39:29 +00002459 TBAAAccessInfo TBAAInfo = CGM.getTBAAVTablePtrAccessInfo(VTablePtrTy);
2460 CGM.DecorateInstructionWithTBAA(Store, TBAAInfo);
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00002461 if (CGM.getCodeGenOpts().OptimizationLevel > 0 &&
2462 CGM.getCodeGenOpts().StrictVTablePointers)
2463 CGM.DecorateInstructionWithInvariantGroup(Store, Vptr.VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00002464}
2465
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002466CodeGenFunction::VPtrsVector
2467CodeGenFunction::getVTablePointers(const CXXRecordDecl *VTableClass) {
2468 CodeGenFunction::VPtrsVector VPtrsResult;
2469 VisitedVirtualBasesSetTy VBases;
2470 getVTablePointers(BaseSubobject(VTableClass, CharUnits::Zero()),
2471 /*NearestVBase=*/nullptr,
2472 /*OffsetFromNearestVBase=*/CharUnits::Zero(),
2473 /*BaseIsNonVirtualPrimaryBase=*/false, VTableClass, VBases,
2474 VPtrsResult);
2475 return VPtrsResult;
2476}
2477
2478void CodeGenFunction::getVTablePointers(BaseSubobject Base,
2479 const CXXRecordDecl *NearestVBase,
2480 CharUnits OffsetFromNearestVBase,
2481 bool BaseIsNonVirtualPrimaryBase,
2482 const CXXRecordDecl *VTableClass,
2483 VisitedVirtualBasesSetTy &VBases,
2484 VPtrsVector &Vptrs) {
Anders Carlssond5895932010-03-28 21:07:49 +00002485 // If this base is a non-virtual primary base the address point has already
2486 // been set.
2487 if (!BaseIsNonVirtualPrimaryBase) {
2488 // Initialize the vtable pointer for this base.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002489 VPtr Vptr = {Base, NearestVBase, OffsetFromNearestVBase, VTableClass};
2490 Vptrs.push_back(Vptr);
Anders Carlssond5895932010-03-28 21:07:49 +00002491 }
Justin Bogner1cd11f12015-05-20 15:53:59 +00002492
Anders Carlssond5895932010-03-28 21:07:49 +00002493 const CXXRecordDecl *RD = Base.getBase();
2494
2495 // Traverse bases.
Aaron Ballman574705e2014-03-13 15:41:46 +00002496 for (const auto &I : RD->bases()) {
Anders Carlssond5895932010-03-28 21:07:49 +00002497 CXXRecordDecl *BaseDecl
Aaron Ballman574705e2014-03-13 15:41:46 +00002498 = cast<CXXRecordDecl>(I.getType()->getAs<RecordType>()->getDecl());
Anders Carlssond5895932010-03-28 21:07:49 +00002499
2500 // Ignore classes without a vtable.
2501 if (!BaseDecl->isDynamicClass())
2502 continue;
2503
Ken Dyck3fb4c892011-03-23 01:04:18 +00002504 CharUnits BaseOffset;
2505 CharUnits BaseOffsetFromNearestVBase;
Anders Carlsson948d3f42010-03-29 01:16:41 +00002506 bool BaseDeclIsNonVirtualPrimaryBase;
Anders Carlssond5895932010-03-28 21:07:49 +00002507
Aaron Ballman574705e2014-03-13 15:41:46 +00002508 if (I.isVirtual()) {
Anders Carlssond5895932010-03-28 21:07:49 +00002509 // Check if we've visited this virtual base before.
David Blaikie82e95a32014-11-19 07:49:47 +00002510 if (!VBases.insert(BaseDecl).second)
Anders Carlssond5895932010-03-28 21:07:49 +00002511 continue;
2512
Justin Bogner1cd11f12015-05-20 15:53:59 +00002513 const ASTRecordLayout &Layout =
Anders Carlssond5895932010-03-28 21:07:49 +00002514 getContext().getASTRecordLayout(VTableClass);
2515
Ken Dyck3fb4c892011-03-23 01:04:18 +00002516 BaseOffset = Layout.getVBaseClassOffset(BaseDecl);
2517 BaseOffsetFromNearestVBase = CharUnits::Zero();
Anders Carlsson948d3f42010-03-29 01:16:41 +00002518 BaseDeclIsNonVirtualPrimaryBase = false;
Anders Carlssond5895932010-03-28 21:07:49 +00002519 } else {
2520 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
2521
Ken Dyck16ffcac2011-03-24 01:21:01 +00002522 BaseOffset = Base.getBaseOffset() + Layout.getBaseClassOffset(BaseDecl);
Justin Bogner1cd11f12015-05-20 15:53:59 +00002523 BaseOffsetFromNearestVBase =
Ken Dyck3fb4c892011-03-23 01:04:18 +00002524 OffsetFromNearestVBase + Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson948d3f42010-03-29 01:16:41 +00002525 BaseDeclIsNonVirtualPrimaryBase = Layout.getPrimaryBase() == BaseDecl;
Anders Carlssond5895932010-03-28 21:07:49 +00002526 }
Justin Bogner1cd11f12015-05-20 15:53:59 +00002527
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002528 getVTablePointers(
2529 BaseSubobject(BaseDecl, BaseOffset),
2530 I.isVirtual() ? BaseDecl : NearestVBase, BaseOffsetFromNearestVBase,
2531 BaseDeclIsNonVirtualPrimaryBase, VTableClass, VBases, Vptrs);
Anders Carlssond5895932010-03-28 21:07:49 +00002532 }
2533}
2534
2535void CodeGenFunction::InitializeVTablePointers(const CXXRecordDecl *RD) {
2536 // Ignore classes without a vtable.
Anders Carlsson1f9348c2010-03-26 04:39:42 +00002537 if (!RD->isDynamicClass())
Anders Carlsson27da15b2010-01-01 20:29:01 +00002538 return;
2539
Anders Carlssond5895932010-03-28 21:07:49 +00002540 // Initialize the vtable pointers for this class and all of its bases.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002541 if (CGM.getCXXABI().doStructorsInitializeVPtrs(RD))
2542 for (const VPtr &Vptr : getVTablePointers(RD))
2543 InitializeVTablePointer(Vptr);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00002544
2545 if (RD->getNumVBases())
2546 CGM.getCXXABI().initializeHiddenVirtualInheritanceMembers(*this, RD);
Anders Carlsson27da15b2010-01-01 20:29:01 +00002547}
Dan Gohman8fc50c22010-10-26 18:44:08 +00002548
John McCall7f416cc2015-09-08 08:05:57 +00002549llvm::Value *CodeGenFunction::GetVTablePtr(Address This,
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00002550 llvm::Type *VTableTy,
2551 const CXXRecordDecl *RD) {
2552 Address VTablePtrSrc = Builder.CreateElementBitCast(This, VTableTy);
Kostya Serebryany141e46f2012-03-26 17:03:51 +00002553 llvm::Instruction *VTable = Builder.CreateLoad(VTablePtrSrc, "vtable");
Ivan A. Kosarev4e50e702017-11-27 09:39:29 +00002554 TBAAAccessInfo TBAAInfo = CGM.getTBAAVTablePtrAccessInfo(VTableTy);
2555 CGM.DecorateInstructionWithTBAA(VTable, TBAAInfo);
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00002556
2557 if (CGM.getCodeGenOpts().OptimizationLevel > 0 &&
2558 CGM.getCodeGenOpts().StrictVTablePointers)
2559 CGM.DecorateInstructionWithInvariantGroup(VTable, RD);
2560
Kostya Serebryany141e46f2012-03-26 17:03:51 +00002561 return VTable;
Dan Gohman8fc50c22010-10-26 18:44:08 +00002562}
Anders Carlssonc36783e2011-05-08 20:32:23 +00002563
Peter Collingbourned2926c92015-03-14 02:42:25 +00002564// If a class has a single non-virtual base and does not introduce or override
2565// virtual member functions or fields, it will have the same layout as its base.
2566// This function returns the least derived such class.
2567//
2568// Casting an instance of a base class to such a derived class is technically
2569// undefined behavior, but it is a relatively common hack for introducing member
2570// functions on class instances with specific properties (e.g. llvm::Operator)
2571// that works under most compilers and should not have security implications, so
2572// we allow it by default. It can be disabled with -fsanitize=cfi-cast-strict.
2573static const CXXRecordDecl *
2574LeastDerivedClassWithSameLayout(const CXXRecordDecl *RD) {
2575 if (!RD->field_empty())
2576 return RD;
2577
2578 if (RD->getNumVBases() != 0)
2579 return RD;
2580
2581 if (RD->getNumBases() != 1)
2582 return RD;
2583
2584 for (const CXXMethodDecl *MD : RD->methods()) {
2585 if (MD->isVirtual()) {
2586 // Virtual member functions are only ok if they are implicit destructors
2587 // because the implicit destructor will have the same semantics as the
2588 // base class's destructor if no fields are added.
2589 if (isa<CXXDestructorDecl>(MD) && MD->isImplicit())
2590 continue;
2591 return RD;
2592 }
2593 }
2594
2595 return LeastDerivedClassWithSameLayout(
2596 RD->bases_begin()->getType()->getAsCXXRecordDecl());
2597}
2598
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002599void CodeGenFunction::EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
2600 llvm::Value *VTable,
2601 SourceLocation Loc) {
Peter Collingbourne396943a2017-07-31 22:35:33 +00002602 if (SanOpts.has(SanitizerKind::CFIVCall))
2603 EmitVTablePtrCheckForCall(RD, VTable, CodeGenFunction::CFITCK_VCall, Loc);
2604 else if (CGM.getCodeGenOpts().WholeProgramVTables &&
2605 CGM.HasHiddenLTOVisibility(RD)) {
Peter Collingbournefb532b92016-02-24 20:46:36 +00002606 llvm::Metadata *MD =
2607 CGM.CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002608 llvm::Value *TypeId =
Peter Collingbournefb532b92016-02-24 20:46:36 +00002609 llvm::MetadataAsValue::get(CGM.getLLVMContext(), MD);
2610
2611 llvm::Value *CastedVTable = Builder.CreateBitCast(VTable, Int8PtrTy);
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002612 llvm::Value *TypeTest =
2613 Builder.CreateCall(CGM.getIntrinsic(llvm::Intrinsic::type_test),
2614 {CastedVTable, TypeId});
2615 Builder.CreateCall(CGM.getIntrinsic(llvm::Intrinsic::assume), TypeTest);
Peter Collingbournefb532b92016-02-24 20:46:36 +00002616 }
Peter Collingbournefb532b92016-02-24 20:46:36 +00002617}
2618
2619void CodeGenFunction::EmitVTablePtrCheckForCall(const CXXRecordDecl *RD,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002620 llvm::Value *VTable,
2621 CFITypeCheckKind TCK,
2622 SourceLocation Loc) {
Peter Collingbourne1a7488a2015-04-02 00:23:30 +00002623 if (!SanOpts.has(SanitizerKind::CFICastStrict))
Peter Collingbournefb532b92016-02-24 20:46:36 +00002624 RD = LeastDerivedClassWithSameLayout(RD);
Peter Collingbourne1a7488a2015-04-02 00:23:30 +00002625
Peter Collingbournefb532b92016-02-24 20:46:36 +00002626 EmitVTablePtrCheck(RD, VTable, TCK, Loc);
Peter Collingbourne1a7488a2015-04-02 00:23:30 +00002627}
2628
Peter Collingbourned2926c92015-03-14 02:42:25 +00002629void CodeGenFunction::EmitVTablePtrCheckForCast(QualType T,
2630 llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002631 bool MayBeNull,
2632 CFITypeCheckKind TCK,
2633 SourceLocation Loc) {
Peter Collingbourned2926c92015-03-14 02:42:25 +00002634 if (!getLangOpts().CPlusPlus)
2635 return;
2636
2637 auto *ClassTy = T->getAs<RecordType>();
2638 if (!ClassTy)
2639 return;
2640
2641 const CXXRecordDecl *ClassDecl = cast<CXXRecordDecl>(ClassTy->getDecl());
2642
2643 if (!ClassDecl->isCompleteDefinition() || !ClassDecl->isDynamicClass())
2644 return;
2645
Peter Collingbourned2926c92015-03-14 02:42:25 +00002646 if (!SanOpts.has(SanitizerKind::CFICastStrict))
2647 ClassDecl = LeastDerivedClassWithSameLayout(ClassDecl);
2648
Hans Wennborgdcfba332015-10-06 23:40:43 +00002649 llvm::BasicBlock *ContBlock = nullptr;
Peter Collingbourned2926c92015-03-14 02:42:25 +00002650
2651 if (MayBeNull) {
2652 llvm::Value *DerivedNotNull =
2653 Builder.CreateIsNotNull(Derived, "cast.nonnull");
2654
2655 llvm::BasicBlock *CheckBlock = createBasicBlock("cast.check");
2656 ContBlock = createBasicBlock("cast.cont");
2657
2658 Builder.CreateCondBr(DerivedNotNull, CheckBlock, ContBlock);
2659
2660 EmitBlock(CheckBlock);
2661 }
2662
Peter Collingbourne60108802017-12-13 21:53:04 +00002663 llvm::Value *VTable;
2664 std::tie(VTable, ClassDecl) = CGM.getCXXABI().LoadVTablePtr(
2665 *this, Address(Derived, getPointerAlign()), ClassDecl);
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00002666
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002667 EmitVTablePtrCheck(ClassDecl, VTable, TCK, Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00002668
2669 if (MayBeNull) {
2670 Builder.CreateBr(ContBlock);
2671 EmitBlock(ContBlock);
2672 }
2673}
2674
2675void CodeGenFunction::EmitVTablePtrCheck(const CXXRecordDecl *RD,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002676 llvm::Value *VTable,
2677 CFITypeCheckKind TCK,
2678 SourceLocation Loc) {
Peter Collingbourne3afb2662016-04-28 17:09:37 +00002679 if (!CGM.getCodeGenOpts().SanitizeCfiCrossDso &&
2680 !CGM.HasHiddenLTOVisibility(RD))
2681 return;
2682
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +00002683 SanitizerMask M;
Peter Collingbournedc134532016-01-16 00:31:22 +00002684 llvm::SanitizerStatKind SSK;
2685 switch (TCK) {
2686 case CFITCK_VCall:
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +00002687 M = SanitizerKind::CFIVCall;
Peter Collingbournedc134532016-01-16 00:31:22 +00002688 SSK = llvm::SanStat_CFI_VCall;
2689 break;
2690 case CFITCK_NVCall:
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +00002691 M = SanitizerKind::CFINVCall;
Peter Collingbournedc134532016-01-16 00:31:22 +00002692 SSK = llvm::SanStat_CFI_NVCall;
2693 break;
2694 case CFITCK_DerivedCast:
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +00002695 M = SanitizerKind::CFIDerivedCast;
Peter Collingbournedc134532016-01-16 00:31:22 +00002696 SSK = llvm::SanStat_CFI_DerivedCast;
2697 break;
2698 case CFITCK_UnrelatedCast:
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +00002699 M = SanitizerKind::CFIUnrelatedCast;
Peter Collingbournedc134532016-01-16 00:31:22 +00002700 SSK = llvm::SanStat_CFI_UnrelatedCast;
2701 break;
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00002702 case CFITCK_ICall:
Peter Collingbournee44acad2018-06-26 02:15:47 +00002703 case CFITCK_NVMFCall:
2704 case CFITCK_VMFCall:
2705 llvm_unreachable("unexpected sanitizer kind");
Peter Collingbournedc134532016-01-16 00:31:22 +00002706 }
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +00002707
2708 std::string TypeName = RD->getQualifiedNameAsString();
2709 if (getContext().getSanitizerBlacklist().isBlacklistedType(M, TypeName))
2710 return;
2711
2712 SanitizerScope SanScope(this);
Peter Collingbournedc134532016-01-16 00:31:22 +00002713 EmitSanitizerStatReport(SSK);
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002714
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00002715 llvm::Metadata *MD =
2716 CGM.CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002717 llvm::Value *TypeId = llvm::MetadataAsValue::get(getLLVMContext(), MD);
Peter Collingbournea4ccff32015-02-20 20:30:56 +00002718
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002719 llvm::Value *CastedVTable = Builder.CreateBitCast(VTable, Int8PtrTy);
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002720 llvm::Value *TypeTest = Builder.CreateCall(
2721 CGM.getIntrinsic(llvm::Intrinsic::type_test), {CastedVTable, TypeId});
Peter Collingbournea4ccff32015-02-20 20:30:56 +00002722
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002723 llvm::Constant *StaticData[] = {
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00002724 llvm::ConstantInt::get(Int8Ty, TCK),
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00002725 EmitCheckSourceLocation(Loc),
2726 EmitCheckTypeDescriptor(QualType(RD->getTypeForDecl(), 0)),
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002727 };
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00002728
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002729 auto CrossDsoTypeId = CGM.CreateCrossDsoCfiTypeId(MD);
2730 if (CGM.getCodeGenOpts().SanitizeCfiCrossDso && CrossDsoTypeId) {
2731 EmitCfiSlowPathCheck(M, TypeTest, CrossDsoTypeId, CastedVTable, StaticData);
Evgeniy Stepanovf31ea302016-02-03 22:18:55 +00002732 return;
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00002733 }
Evgeniy Stepanovf31ea302016-02-03 22:18:55 +00002734
2735 if (CGM.getCodeGenOpts().SanitizeTrap.has(M)) {
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002736 EmitTrapCheck(TypeTest);
Evgeniy Stepanovf31ea302016-02-03 22:18:55 +00002737 return;
2738 }
2739
2740 llvm::Value *AllVtables = llvm::MetadataAsValue::get(
2741 CGM.getLLVMContext(),
2742 llvm::MDString::get(CGM.getLLVMContext(), "all-vtables"));
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002743 llvm::Value *ValidVtable = Builder.CreateCall(
2744 CGM.getIntrinsic(llvm::Intrinsic::type_test), {CastedVTable, AllVtables});
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00002745 EmitCheck(std::make_pair(TypeTest, M), SanitizerHandler::CFICheckFail,
2746 StaticData, {CastedVTable, ValidVtable});
Peter Collingbournea4ccff32015-02-20 20:30:56 +00002747}
Anders Carlssonc36783e2011-05-08 20:32:23 +00002748
Peter Collingbourne0ca03632016-06-25 00:24:06 +00002749bool CodeGenFunction::ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD) {
2750 if (!CGM.getCodeGenOpts().WholeProgramVTables ||
2751 !SanOpts.has(SanitizerKind::CFIVCall) ||
2752 !CGM.getCodeGenOpts().SanitizeTrap.has(SanitizerKind::CFIVCall) ||
2753 !CGM.HasHiddenLTOVisibility(RD))
2754 return false;
2755
2756 std::string TypeName = RD->getQualifiedNameAsString();
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +00002757 return !getContext().getSanitizerBlacklist().isBlacklistedType(
2758 SanitizerKind::CFIVCall, TypeName);
Peter Collingbourne0ca03632016-06-25 00:24:06 +00002759}
2760
2761llvm::Value *CodeGenFunction::EmitVTableTypeCheckedLoad(
2762 const CXXRecordDecl *RD, llvm::Value *VTable, uint64_t VTableByteOffset) {
2763 SanitizerScope SanScope(this);
2764
2765 EmitSanitizerStatReport(llvm::SanStat_CFI_VCall);
2766
2767 llvm::Metadata *MD =
2768 CGM.CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
2769 llvm::Value *TypeId = llvm::MetadataAsValue::get(CGM.getLLVMContext(), MD);
2770
2771 llvm::Value *CastedVTable = Builder.CreateBitCast(VTable, Int8PtrTy);
2772 llvm::Value *CheckedLoad = Builder.CreateCall(
2773 CGM.getIntrinsic(llvm::Intrinsic::type_checked_load),
2774 {CastedVTable, llvm::ConstantInt::get(Int32Ty, VTableByteOffset),
2775 TypeId});
2776 llvm::Value *CheckResult = Builder.CreateExtractValue(CheckedLoad, 1);
2777
2778 EmitCheck(std::make_pair(CheckResult, SanitizerKind::CFIVCall),
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00002779 SanitizerHandler::CFICheckFail, nullptr, nullptr);
Peter Collingbourne0ca03632016-06-25 00:24:06 +00002780
2781 return Builder.CreateBitCast(
2782 Builder.CreateExtractValue(CheckedLoad, 0),
2783 cast<llvm::PointerType>(VTable->getType())->getElementType());
2784}
2785
Faisal Vali571df122013-09-29 08:45:24 +00002786void CodeGenFunction::EmitForwardingCallToLambda(
2787 const CXXMethodDecl *callOperator,
2788 CallArgList &callArgs) {
Eli Friedman5b446882012-02-16 03:47:28 +00002789 // Get the address of the call operator.
John McCall8dda7b22012-07-07 06:41:13 +00002790 const CGFunctionInfo &calleeFnInfo =
2791 CGM.getTypes().arrangeCXXMethodDeclaration(callOperator);
John McCallb92ab1a2016-10-26 23:46:34 +00002792 llvm::Constant *calleePtr =
John McCall8dda7b22012-07-07 06:41:13 +00002793 CGM.GetAddrOfFunction(GlobalDecl(callOperator),
2794 CGM.getTypes().GetFunctionType(calleeFnInfo));
Eli Friedman5b446882012-02-16 03:47:28 +00002795
John McCall8dda7b22012-07-07 06:41:13 +00002796 // Prepare the return slot.
2797 const FunctionProtoType *FPT =
2798 callOperator->getType()->castAs<FunctionProtoType>();
Alp Toker314cc812014-01-25 16:55:45 +00002799 QualType resultType = FPT->getReturnType();
John McCall8dda7b22012-07-07 06:41:13 +00002800 ReturnValueSlot returnSlot;
2801 if (!resultType->isVoidType() &&
2802 calleeFnInfo.getReturnInfo().getKind() == ABIArgInfo::Indirect &&
John McCall47fb9502013-03-07 21:37:08 +00002803 !hasScalarEvaluationKind(calleeFnInfo.getReturnType()))
John McCall8dda7b22012-07-07 06:41:13 +00002804 returnSlot = ReturnValueSlot(ReturnValue, resultType.isVolatileQualified());
2805
2806 // We don't need to separately arrange the call arguments because
2807 // the call can't be variadic anyway --- it's impossible to forward
2808 // variadic arguments.
Justin Bogner1cd11f12015-05-20 15:53:59 +00002809
Eli Friedman5b446882012-02-16 03:47:28 +00002810 // Now emit our call.
Erich Keanede6480a32018-11-13 15:48:08 +00002811 auto callee = CGCallee::forDirect(calleePtr, GlobalDecl(callOperator));
John McCallb92ab1a2016-10-26 23:46:34 +00002812 RValue RV = EmitCall(calleeFnInfo, callee, returnSlot, callArgs);
Eli Friedman5b446882012-02-16 03:47:28 +00002813
John McCall8dda7b22012-07-07 06:41:13 +00002814 // If necessary, copy the returned value into the slot.
John McCall95088452017-12-14 18:21:14 +00002815 if (!resultType->isVoidType() && returnSlot.isNull()) {
2816 if (getLangOpts().ObjCAutoRefCount && resultType->isObjCRetainableType()) {
2817 RV = RValue::get(EmitARCRetainAutoreleasedReturnValue(RV.getScalarVal()));
2818 }
John McCall8dda7b22012-07-07 06:41:13 +00002819 EmitReturnOfRValue(RV, resultType);
John McCall95088452017-12-14 18:21:14 +00002820 } else
Eli Friedmanf5f4d2f2012-12-13 23:37:17 +00002821 EmitBranchThroughCleanup(ReturnBlock);
Eli Friedman5b446882012-02-16 03:47:28 +00002822}
2823
Eli Friedman2495ab02012-02-25 02:48:22 +00002824void CodeGenFunction::EmitLambdaBlockInvokeBody() {
2825 const BlockDecl *BD = BlockInfo->getBlockDecl();
2826 const VarDecl *variable = BD->capture_begin()->getVariable();
2827 const CXXRecordDecl *Lambda = variable->getType()->getAsCXXRecordDecl();
Reid Kleckner2d3c4212017-08-04 22:38:06 +00002828 const CXXMethodDecl *CallOp = Lambda->getLambdaCallOperator();
2829
2830 if (CallOp->isVariadic()) {
2831 // FIXME: Making this work correctly is nasty because it requires either
2832 // cloning the body of the call operator or making the call operator
2833 // forward.
2834 CGM.ErrorUnsupported(CurCodeDecl, "lambda conversion to variadic function");
2835 return;
2836 }
Eli Friedman2495ab02012-02-25 02:48:22 +00002837
2838 // Start building arguments for forwarding call
2839 CallArgList CallArgs;
2840
2841 QualType ThisType = getContext().getPointerType(getContext().getRecordType(Lambda));
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002842 Address ThisPtr = GetAddrOfBlockDecl(variable);
John McCall7f416cc2015-09-08 08:05:57 +00002843 CallArgs.add(RValue::get(ThisPtr.getPointer()), ThisType);
Eli Friedman2495ab02012-02-25 02:48:22 +00002844
2845 // Add the rest of the parameters.
David Majnemer59f77922016-06-24 04:05:48 +00002846 for (auto param : BD->parameters())
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002847 EmitDelegateCallArg(CallArgs, param, param->getBeginLoc());
Aaron Ballmanb2b8b1d2014-03-07 16:09:59 +00002848
Justin Bogner1cd11f12015-05-20 15:53:59 +00002849 assert(!Lambda->isGenericLambda() &&
Faisal Vali571df122013-09-29 08:45:24 +00002850 "generic lambda interconversion to block not implemented");
Reid Kleckner2d3c4212017-08-04 22:38:06 +00002851 EmitForwardingCallToLambda(CallOp, CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00002852}
2853
2854void CodeGenFunction::EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD) {
2855 const CXXRecordDecl *Lambda = MD->getParent();
2856
2857 // Start building arguments for forwarding call
2858 CallArgList CallArgs;
2859
2860 QualType ThisType = getContext().getPointerType(getContext().getRecordType(Lambda));
2861 llvm::Value *ThisPtr = llvm::UndefValue::get(getTypes().ConvertType(ThisType));
2862 CallArgs.add(RValue::get(ThisPtr), ThisType);
2863
2864 // Add the rest of the parameters.
David Majnemer59f77922016-06-24 04:05:48 +00002865 for (auto Param : MD->parameters())
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002866 EmitDelegateCallArg(CallArgs, Param, Param->getBeginLoc());
Aaron Ballmanf6bf62e2014-03-07 15:12:56 +00002867
Faisal Vali571df122013-09-29 08:45:24 +00002868 const CXXMethodDecl *CallOp = Lambda->getLambdaCallOperator();
2869 // For a generic lambda, find the corresponding call operator specialization
2870 // to which the call to the static-invoker shall be forwarded.
2871 if (Lambda->isGenericLambda()) {
2872 assert(MD->isFunctionTemplateSpecialization());
2873 const TemplateArgumentList *TAL = MD->getTemplateSpecializationArgs();
2874 FunctionTemplateDecl *CallOpTemplate = CallOp->getDescribedFunctionTemplate();
Craig Topper8a13c412014-05-21 05:09:00 +00002875 void *InsertPos = nullptr;
Justin Bogner1cd11f12015-05-20 15:53:59 +00002876 FunctionDecl *CorrespondingCallOpSpecialization =
Craig Topper7e0daca2014-06-26 04:58:53 +00002877 CallOpTemplate->findSpecialization(TAL->asArray(), InsertPos);
Faisal Vali571df122013-09-29 08:45:24 +00002878 assert(CorrespondingCallOpSpecialization);
2879 CallOp = cast<CXXMethodDecl>(CorrespondingCallOpSpecialization);
2880 }
2881 EmitForwardingCallToLambda(CallOp, CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00002882}
2883
Reid Kleckner2d3c4212017-08-04 22:38:06 +00002884void CodeGenFunction::EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD) {
Douglas Gregor355efbb2012-02-17 03:02:34 +00002885 if (MD->isVariadic()) {
Eli Friedman5b446882012-02-16 03:47:28 +00002886 // FIXME: Making this work correctly is nasty because it requires either
2887 // cloning the body of the call operator or making the call operator forward.
2888 CGM.ErrorUnsupported(MD, "lambda conversion to variadic function");
Eli Friedman2495ab02012-02-25 02:48:22 +00002889 return;
Eli Friedman5b446882012-02-16 03:47:28 +00002890 }
2891
Douglas Gregor355efbb2012-02-17 03:02:34 +00002892 EmitLambdaDelegatingInvokeBody(MD);
Eli Friedman5a6d5072012-02-16 01:37:33 +00002893}