1*67e74705SXin Li //===--- CGClass.cpp - Emit LLVM Code for C++ classes -----------*- C++ -*-===//
2*67e74705SXin Li //
3*67e74705SXin Li // The LLVM Compiler Infrastructure
4*67e74705SXin Li //
5*67e74705SXin Li // This file is distributed under the University of Illinois Open Source
6*67e74705SXin Li // License. See LICENSE.TXT for details.
7*67e74705SXin Li //
8*67e74705SXin Li //===----------------------------------------------------------------------===//
9*67e74705SXin Li //
10*67e74705SXin Li // This contains code dealing with C++ code generation of classes
11*67e74705SXin Li //
12*67e74705SXin Li //===----------------------------------------------------------------------===//
13*67e74705SXin Li
14*67e74705SXin Li #include "CGBlocks.h"
15*67e74705SXin Li #include "CGCXXABI.h"
16*67e74705SXin Li #include "CGDebugInfo.h"
17*67e74705SXin Li #include "CGRecordLayout.h"
18*67e74705SXin Li #include "CodeGenFunction.h"
19*67e74705SXin Li #include "clang/AST/CXXInheritance.h"
20*67e74705SXin Li #include "clang/AST/DeclTemplate.h"
21*67e74705SXin Li #include "clang/AST/EvaluatedExprVisitor.h"
22*67e74705SXin Li #include "clang/AST/RecordLayout.h"
23*67e74705SXin Li #include "clang/AST/StmtCXX.h"
24*67e74705SXin Li #include "clang/Basic/TargetBuiltins.h"
25*67e74705SXin Li #include "clang/CodeGen/CGFunctionInfo.h"
26*67e74705SXin Li #include "clang/Frontend/CodeGenOptions.h"
27*67e74705SXin Li #include "llvm/IR/Intrinsics.h"
28*67e74705SXin Li #include "llvm/IR/Metadata.h"
29*67e74705SXin Li #include "llvm/Transforms/Utils/SanitizerStats.h"
30*67e74705SXin Li
31*67e74705SXin Li using namespace clang;
32*67e74705SXin Li using namespace CodeGen;
33*67e74705SXin Li
34*67e74705SXin Li /// Return the best known alignment for an unknown pointer to a
35*67e74705SXin Li /// particular class.
getClassPointerAlignment(const CXXRecordDecl * RD)36*67e74705SXin Li CharUnits CodeGenModule::getClassPointerAlignment(const CXXRecordDecl *RD) {
37*67e74705SXin Li if (!RD->isCompleteDefinition())
38*67e74705SXin Li return CharUnits::One(); // Hopefully won't be used anywhere.
39*67e74705SXin Li
40*67e74705SXin Li auto &layout = getContext().getASTRecordLayout(RD);
41*67e74705SXin Li
42*67e74705SXin Li // If the class is final, then we know that the pointer points to an
43*67e74705SXin Li // object of that type and can use the full alignment.
44*67e74705SXin Li if (RD->hasAttr<FinalAttr>()) {
45*67e74705SXin Li return layout.getAlignment();
46*67e74705SXin Li
47*67e74705SXin Li // Otherwise, we have to assume it could be a subclass.
48*67e74705SXin Li } else {
49*67e74705SXin Li return layout.getNonVirtualAlignment();
50*67e74705SXin Li }
51*67e74705SXin Li }
52*67e74705SXin Li
53*67e74705SXin Li /// Return the best known alignment for a pointer to a virtual base,
54*67e74705SXin Li /// given the alignment of a pointer to the derived class.
getVBaseAlignment(CharUnits actualDerivedAlign,const CXXRecordDecl * derivedClass,const CXXRecordDecl * vbaseClass)55*67e74705SXin Li CharUnits CodeGenModule::getVBaseAlignment(CharUnits actualDerivedAlign,
56*67e74705SXin Li const CXXRecordDecl *derivedClass,
57*67e74705SXin Li const CXXRecordDecl *vbaseClass) {
58*67e74705SXin Li // The basic idea here is that an underaligned derived pointer might
59*67e74705SXin Li // indicate an underaligned base pointer.
60*67e74705SXin Li
61*67e74705SXin Li assert(vbaseClass->isCompleteDefinition());
62*67e74705SXin Li auto &baseLayout = getContext().getASTRecordLayout(vbaseClass);
63*67e74705SXin Li CharUnits expectedVBaseAlign = baseLayout.getNonVirtualAlignment();
64*67e74705SXin Li
65*67e74705SXin Li return getDynamicOffsetAlignment(actualDerivedAlign, derivedClass,
66*67e74705SXin Li expectedVBaseAlign);
67*67e74705SXin Li }
68*67e74705SXin Li
69*67e74705SXin Li CharUnits
getDynamicOffsetAlignment(CharUnits actualBaseAlign,const CXXRecordDecl * baseDecl,CharUnits expectedTargetAlign)70*67e74705SXin Li CodeGenModule::getDynamicOffsetAlignment(CharUnits actualBaseAlign,
71*67e74705SXin Li const CXXRecordDecl *baseDecl,
72*67e74705SXin Li CharUnits expectedTargetAlign) {
73*67e74705SXin Li // If the base is an incomplete type (which is, alas, possible with
74*67e74705SXin Li // member pointers), be pessimistic.
75*67e74705SXin Li if (!baseDecl->isCompleteDefinition())
76*67e74705SXin Li return std::min(actualBaseAlign, expectedTargetAlign);
77*67e74705SXin Li
78*67e74705SXin Li auto &baseLayout = getContext().getASTRecordLayout(baseDecl);
79*67e74705SXin Li CharUnits expectedBaseAlign = baseLayout.getNonVirtualAlignment();
80*67e74705SXin Li
81*67e74705SXin Li // If the class is properly aligned, assume the target offset is, too.
82*67e74705SXin Li //
83*67e74705SXin Li // This actually isn't necessarily the right thing to do --- if the
84*67e74705SXin Li // class is a complete object, but it's only properly aligned for a
85*67e74705SXin Li // base subobject, then the alignments of things relative to it are
86*67e74705SXin Li // probably off as well. (Note that this requires the alignment of
87*67e74705SXin Li // the target to be greater than the NV alignment of the derived
88*67e74705SXin Li // class.)
89*67e74705SXin Li //
90*67e74705SXin Li // However, our approach to this kind of under-alignment can only
91*67e74705SXin Li // ever be best effort; after all, we're never going to propagate
92*67e74705SXin Li // alignments through variables or parameters. Note, in particular,
93*67e74705SXin Li // that constructing a polymorphic type in an address that's less
94*67e74705SXin Li // than pointer-aligned will generally trap in the constructor,
95*67e74705SXin Li // unless we someday add some sort of attribute to change the
96*67e74705SXin Li // assumed alignment of 'this'. So our goal here is pretty much
97*67e74705SXin Li // just to allow the user to explicitly say that a pointer is
98*67e74705SXin Li // under-aligned and then safely access its fields and vtables.
99*67e74705SXin Li if (actualBaseAlign >= expectedBaseAlign) {
100*67e74705SXin Li return expectedTargetAlign;
101*67e74705SXin Li }
102*67e74705SXin Li
103*67e74705SXin Li // Otherwise, we might be offset by an arbitrary multiple of the
104*67e74705SXin Li // actual alignment. The correct adjustment is to take the min of
105*67e74705SXin Li // the two alignments.
106*67e74705SXin Li return std::min(actualBaseAlign, expectedTargetAlign);
107*67e74705SXin Li }
108*67e74705SXin Li
LoadCXXThisAddress()109*67e74705SXin Li Address CodeGenFunction::LoadCXXThisAddress() {
110*67e74705SXin Li assert(CurFuncDecl && "loading 'this' without a func declaration?");
111*67e74705SXin Li assert(isa<CXXMethodDecl>(CurFuncDecl));
112*67e74705SXin Li
113*67e74705SXin Li // Lazily compute CXXThisAlignment.
114*67e74705SXin Li if (CXXThisAlignment.isZero()) {
115*67e74705SXin Li // Just use the best known alignment for the parent.
116*67e74705SXin Li // TODO: if we're currently emitting a complete-object ctor/dtor,
117*67e74705SXin Li // we can always use the complete-object alignment.
118*67e74705SXin Li auto RD = cast<CXXMethodDecl>(CurFuncDecl)->getParent();
119*67e74705SXin Li CXXThisAlignment = CGM.getClassPointerAlignment(RD);
120*67e74705SXin Li }
121*67e74705SXin Li
122*67e74705SXin Li return Address(LoadCXXThis(), CXXThisAlignment);
123*67e74705SXin Li }
124*67e74705SXin Li
125*67e74705SXin Li /// Emit the address of a field using a member data pointer.
126*67e74705SXin Li ///
127*67e74705SXin Li /// \param E Only used for emergency diagnostics
128*67e74705SXin Li Address
EmitCXXMemberDataPointerAddress(const Expr * E,Address base,llvm::Value * memberPtr,const MemberPointerType * memberPtrType,AlignmentSource * alignSource)129*67e74705SXin Li CodeGenFunction::EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
130*67e74705SXin Li llvm::Value *memberPtr,
131*67e74705SXin Li const MemberPointerType *memberPtrType,
132*67e74705SXin Li AlignmentSource *alignSource) {
133*67e74705SXin Li // Ask the ABI to compute the actual address.
134*67e74705SXin Li llvm::Value *ptr =
135*67e74705SXin Li CGM.getCXXABI().EmitMemberDataPointerAddress(*this, E, base,
136*67e74705SXin Li memberPtr, memberPtrType);
137*67e74705SXin Li
138*67e74705SXin Li QualType memberType = memberPtrType->getPointeeType();
139*67e74705SXin Li CharUnits memberAlign = getNaturalTypeAlignment(memberType, alignSource);
140*67e74705SXin Li memberAlign =
141*67e74705SXin Li CGM.getDynamicOffsetAlignment(base.getAlignment(),
142*67e74705SXin Li memberPtrType->getClass()->getAsCXXRecordDecl(),
143*67e74705SXin Li memberAlign);
144*67e74705SXin Li return Address(ptr, memberAlign);
145*67e74705SXin Li }
146*67e74705SXin Li
computeNonVirtualBaseClassOffset(const CXXRecordDecl * DerivedClass,CastExpr::path_const_iterator Start,CastExpr::path_const_iterator End)147*67e74705SXin Li CharUnits CodeGenModule::computeNonVirtualBaseClassOffset(
148*67e74705SXin Li const CXXRecordDecl *DerivedClass, CastExpr::path_const_iterator Start,
149*67e74705SXin Li CastExpr::path_const_iterator End) {
150*67e74705SXin Li CharUnits Offset = CharUnits::Zero();
151*67e74705SXin Li
152*67e74705SXin Li const ASTContext &Context = getContext();
153*67e74705SXin Li const CXXRecordDecl *RD = DerivedClass;
154*67e74705SXin Li
155*67e74705SXin Li for (CastExpr::path_const_iterator I = Start; I != End; ++I) {
156*67e74705SXin Li const CXXBaseSpecifier *Base = *I;
157*67e74705SXin Li assert(!Base->isVirtual() && "Should not see virtual bases here!");
158*67e74705SXin Li
159*67e74705SXin Li // Get the layout.
160*67e74705SXin Li const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
161*67e74705SXin Li
162*67e74705SXin Li const CXXRecordDecl *BaseDecl =
163*67e74705SXin Li cast<CXXRecordDecl>(Base->getType()->getAs<RecordType>()->getDecl());
164*67e74705SXin Li
165*67e74705SXin Li // Add the offset.
166*67e74705SXin Li Offset += Layout.getBaseClassOffset(BaseDecl);
167*67e74705SXin Li
168*67e74705SXin Li RD = BaseDecl;
169*67e74705SXin Li }
170*67e74705SXin Li
171*67e74705SXin Li return Offset;
172*67e74705SXin Li }
173*67e74705SXin Li
174*67e74705SXin Li llvm::Constant *
GetNonVirtualBaseClassOffset(const CXXRecordDecl * ClassDecl,CastExpr::path_const_iterator PathBegin,CastExpr::path_const_iterator PathEnd)175*67e74705SXin Li CodeGenModule::GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl,
176*67e74705SXin Li CastExpr::path_const_iterator PathBegin,
177*67e74705SXin Li CastExpr::path_const_iterator PathEnd) {
178*67e74705SXin Li assert(PathBegin != PathEnd && "Base path should not be empty!");
179*67e74705SXin Li
180*67e74705SXin Li CharUnits Offset =
181*67e74705SXin Li computeNonVirtualBaseClassOffset(ClassDecl, PathBegin, PathEnd);
182*67e74705SXin Li if (Offset.isZero())
183*67e74705SXin Li return nullptr;
184*67e74705SXin Li
185*67e74705SXin Li llvm::Type *PtrDiffTy =
186*67e74705SXin Li Types.ConvertType(getContext().getPointerDiffType());
187*67e74705SXin Li
188*67e74705SXin Li return llvm::ConstantInt::get(PtrDiffTy, Offset.getQuantity());
189*67e74705SXin Li }
190*67e74705SXin Li
191*67e74705SXin Li /// Gets the address of a direct base class within a complete object.
192*67e74705SXin Li /// This should only be used for (1) non-virtual bases or (2) virtual bases
193*67e74705SXin Li /// when the type is known to be complete (e.g. in complete destructors).
194*67e74705SXin Li ///
195*67e74705SXin Li /// The object pointed to by 'This' is assumed to be non-null.
196*67e74705SXin Li Address
GetAddressOfDirectBaseInCompleteClass(Address This,const CXXRecordDecl * Derived,const CXXRecordDecl * Base,bool BaseIsVirtual)197*67e74705SXin Li CodeGenFunction::GetAddressOfDirectBaseInCompleteClass(Address This,
198*67e74705SXin Li const CXXRecordDecl *Derived,
199*67e74705SXin Li const CXXRecordDecl *Base,
200*67e74705SXin Li bool BaseIsVirtual) {
201*67e74705SXin Li // 'this' must be a pointer (in some address space) to Derived.
202*67e74705SXin Li assert(This.getElementType() == ConvertType(Derived));
203*67e74705SXin Li
204*67e74705SXin Li // Compute the offset of the virtual base.
205*67e74705SXin Li CharUnits Offset;
206*67e74705SXin Li const ASTRecordLayout &Layout = getContext().getASTRecordLayout(Derived);
207*67e74705SXin Li if (BaseIsVirtual)
208*67e74705SXin Li Offset = Layout.getVBaseClassOffset(Base);
209*67e74705SXin Li else
210*67e74705SXin Li Offset = Layout.getBaseClassOffset(Base);
211*67e74705SXin Li
212*67e74705SXin Li // Shift and cast down to the base type.
213*67e74705SXin Li // TODO: for complete types, this should be possible with a GEP.
214*67e74705SXin Li Address V = This;
215*67e74705SXin Li if (!Offset.isZero()) {
216*67e74705SXin Li V = Builder.CreateElementBitCast(V, Int8Ty);
217*67e74705SXin Li V = Builder.CreateConstInBoundsByteGEP(V, Offset);
218*67e74705SXin Li }
219*67e74705SXin Li V = Builder.CreateElementBitCast(V, ConvertType(Base));
220*67e74705SXin Li
221*67e74705SXin Li return V;
222*67e74705SXin Li }
223*67e74705SXin Li
224*67e74705SXin Li static Address
ApplyNonVirtualAndVirtualOffset(CodeGenFunction & CGF,Address addr,CharUnits nonVirtualOffset,llvm::Value * virtualOffset,const CXXRecordDecl * derivedClass,const CXXRecordDecl * nearestVBase)225*67e74705SXin Li ApplyNonVirtualAndVirtualOffset(CodeGenFunction &CGF, Address addr,
226*67e74705SXin Li CharUnits nonVirtualOffset,
227*67e74705SXin Li llvm::Value *virtualOffset,
228*67e74705SXin Li const CXXRecordDecl *derivedClass,
229*67e74705SXin Li const CXXRecordDecl *nearestVBase) {
230*67e74705SXin Li // Assert that we have something to do.
231*67e74705SXin Li assert(!nonVirtualOffset.isZero() || virtualOffset != nullptr);
232*67e74705SXin Li
233*67e74705SXin Li // Compute the offset from the static and dynamic components.
234*67e74705SXin Li llvm::Value *baseOffset;
235*67e74705SXin Li if (!nonVirtualOffset.isZero()) {
236*67e74705SXin Li baseOffset = llvm::ConstantInt::get(CGF.PtrDiffTy,
237*67e74705SXin Li nonVirtualOffset.getQuantity());
238*67e74705SXin Li if (virtualOffset) {
239*67e74705SXin Li baseOffset = CGF.Builder.CreateAdd(virtualOffset, baseOffset);
240*67e74705SXin Li }
241*67e74705SXin Li } else {
242*67e74705SXin Li baseOffset = virtualOffset;
243*67e74705SXin Li }
244*67e74705SXin Li
245*67e74705SXin Li // Apply the base offset.
246*67e74705SXin Li llvm::Value *ptr = addr.getPointer();
247*67e74705SXin Li ptr = CGF.Builder.CreateBitCast(ptr, CGF.Int8PtrTy);
248*67e74705SXin Li ptr = CGF.Builder.CreateInBoundsGEP(ptr, baseOffset, "add.ptr");
249*67e74705SXin Li
250*67e74705SXin Li // If we have a virtual component, the alignment of the result will
251*67e74705SXin Li // be relative only to the known alignment of that vbase.
252*67e74705SXin Li CharUnits alignment;
253*67e74705SXin Li if (virtualOffset) {
254*67e74705SXin Li assert(nearestVBase && "virtual offset without vbase?");
255*67e74705SXin Li alignment = CGF.CGM.getVBaseAlignment(addr.getAlignment(),
256*67e74705SXin Li derivedClass, nearestVBase);
257*67e74705SXin Li } else {
258*67e74705SXin Li alignment = addr.getAlignment();
259*67e74705SXin Li }
260*67e74705SXin Li alignment = alignment.alignmentAtOffset(nonVirtualOffset);
261*67e74705SXin Li
262*67e74705SXin Li return Address(ptr, alignment);
263*67e74705SXin Li }
264*67e74705SXin Li
GetAddressOfBaseClass(Address Value,const CXXRecordDecl * Derived,CastExpr::path_const_iterator PathBegin,CastExpr::path_const_iterator PathEnd,bool NullCheckValue,SourceLocation Loc)265*67e74705SXin Li Address CodeGenFunction::GetAddressOfBaseClass(
266*67e74705SXin Li Address Value, const CXXRecordDecl *Derived,
267*67e74705SXin Li CastExpr::path_const_iterator PathBegin,
268*67e74705SXin Li CastExpr::path_const_iterator PathEnd, bool NullCheckValue,
269*67e74705SXin Li SourceLocation Loc) {
270*67e74705SXin Li assert(PathBegin != PathEnd && "Base path should not be empty!");
271*67e74705SXin Li
272*67e74705SXin Li CastExpr::path_const_iterator Start = PathBegin;
273*67e74705SXin Li const CXXRecordDecl *VBase = nullptr;
274*67e74705SXin Li
275*67e74705SXin Li // Sema has done some convenient canonicalization here: if the
276*67e74705SXin Li // access path involved any virtual steps, the conversion path will
277*67e74705SXin Li // *start* with a step down to the correct virtual base subobject,
278*67e74705SXin Li // and hence will not require any further steps.
279*67e74705SXin Li if ((*Start)->isVirtual()) {
280*67e74705SXin Li VBase =
281*67e74705SXin Li cast<CXXRecordDecl>((*Start)->getType()->getAs<RecordType>()->getDecl());
282*67e74705SXin Li ++Start;
283*67e74705SXin Li }
284*67e74705SXin Li
285*67e74705SXin Li // Compute the static offset of the ultimate destination within its
286*67e74705SXin Li // allocating subobject (the virtual base, if there is one, or else
287*67e74705SXin Li // the "complete" object that we see).
288*67e74705SXin Li CharUnits NonVirtualOffset = CGM.computeNonVirtualBaseClassOffset(
289*67e74705SXin Li VBase ? VBase : Derived, Start, PathEnd);
290*67e74705SXin Li
291*67e74705SXin Li // If there's a virtual step, we can sometimes "devirtualize" it.
292*67e74705SXin Li // For now, that's limited to when the derived type is final.
293*67e74705SXin Li // TODO: "devirtualize" this for accesses to known-complete objects.
294*67e74705SXin Li if (VBase && Derived->hasAttr<FinalAttr>()) {
295*67e74705SXin Li const ASTRecordLayout &layout = getContext().getASTRecordLayout(Derived);
296*67e74705SXin Li CharUnits vBaseOffset = layout.getVBaseClassOffset(VBase);
297*67e74705SXin Li NonVirtualOffset += vBaseOffset;
298*67e74705SXin Li VBase = nullptr; // we no longer have a virtual step
299*67e74705SXin Li }
300*67e74705SXin Li
301*67e74705SXin Li // Get the base pointer type.
302*67e74705SXin Li llvm::Type *BasePtrTy =
303*67e74705SXin Li ConvertType((PathEnd[-1])->getType())->getPointerTo();
304*67e74705SXin Li
305*67e74705SXin Li QualType DerivedTy = getContext().getRecordType(Derived);
306*67e74705SXin Li CharUnits DerivedAlign = CGM.getClassPointerAlignment(Derived);
307*67e74705SXin Li
308*67e74705SXin Li // If the static offset is zero and we don't have a virtual step,
309*67e74705SXin Li // just do a bitcast; null checks are unnecessary.
310*67e74705SXin Li if (NonVirtualOffset.isZero() && !VBase) {
311*67e74705SXin Li if (sanitizePerformTypeCheck()) {
312*67e74705SXin Li EmitTypeCheck(TCK_Upcast, Loc, Value.getPointer(),
313*67e74705SXin Li DerivedTy, DerivedAlign, !NullCheckValue);
314*67e74705SXin Li }
315*67e74705SXin Li return Builder.CreateBitCast(Value, BasePtrTy);
316*67e74705SXin Li }
317*67e74705SXin Li
318*67e74705SXin Li llvm::BasicBlock *origBB = nullptr;
319*67e74705SXin Li llvm::BasicBlock *endBB = nullptr;
320*67e74705SXin Li
321*67e74705SXin Li // Skip over the offset (and the vtable load) if we're supposed to
322*67e74705SXin Li // null-check the pointer.
323*67e74705SXin Li if (NullCheckValue) {
324*67e74705SXin Li origBB = Builder.GetInsertBlock();
325*67e74705SXin Li llvm::BasicBlock *notNullBB = createBasicBlock("cast.notnull");
326*67e74705SXin Li endBB = createBasicBlock("cast.end");
327*67e74705SXin Li
328*67e74705SXin Li llvm::Value *isNull = Builder.CreateIsNull(Value.getPointer());
329*67e74705SXin Li Builder.CreateCondBr(isNull, endBB, notNullBB);
330*67e74705SXin Li EmitBlock(notNullBB);
331*67e74705SXin Li }
332*67e74705SXin Li
333*67e74705SXin Li if (sanitizePerformTypeCheck()) {
334*67e74705SXin Li EmitTypeCheck(VBase ? TCK_UpcastToVirtualBase : TCK_Upcast, Loc,
335*67e74705SXin Li Value.getPointer(), DerivedTy, DerivedAlign, true);
336*67e74705SXin Li }
337*67e74705SXin Li
338*67e74705SXin Li // Compute the virtual offset.
339*67e74705SXin Li llvm::Value *VirtualOffset = nullptr;
340*67e74705SXin Li if (VBase) {
341*67e74705SXin Li VirtualOffset =
342*67e74705SXin Li CGM.getCXXABI().GetVirtualBaseClassOffset(*this, Value, Derived, VBase);
343*67e74705SXin Li }
344*67e74705SXin Li
345*67e74705SXin Li // Apply both offsets.
346*67e74705SXin Li Value = ApplyNonVirtualAndVirtualOffset(*this, Value, NonVirtualOffset,
347*67e74705SXin Li VirtualOffset, Derived, VBase);
348*67e74705SXin Li
349*67e74705SXin Li // Cast to the destination type.
350*67e74705SXin Li Value = Builder.CreateBitCast(Value, BasePtrTy);
351*67e74705SXin Li
352*67e74705SXin Li // Build a phi if we needed a null check.
353*67e74705SXin Li if (NullCheckValue) {
354*67e74705SXin Li llvm::BasicBlock *notNullBB = Builder.GetInsertBlock();
355*67e74705SXin Li Builder.CreateBr(endBB);
356*67e74705SXin Li EmitBlock(endBB);
357*67e74705SXin Li
358*67e74705SXin Li llvm::PHINode *PHI = Builder.CreatePHI(BasePtrTy, 2, "cast.result");
359*67e74705SXin Li PHI->addIncoming(Value.getPointer(), notNullBB);
360*67e74705SXin Li PHI->addIncoming(llvm::Constant::getNullValue(BasePtrTy), origBB);
361*67e74705SXin Li Value = Address(PHI, Value.getAlignment());
362*67e74705SXin Li }
363*67e74705SXin Li
364*67e74705SXin Li return Value;
365*67e74705SXin Li }
366*67e74705SXin Li
367*67e74705SXin Li Address
GetAddressOfDerivedClass(Address BaseAddr,const CXXRecordDecl * Derived,CastExpr::path_const_iterator PathBegin,CastExpr::path_const_iterator PathEnd,bool NullCheckValue)368*67e74705SXin Li CodeGenFunction::GetAddressOfDerivedClass(Address BaseAddr,
369*67e74705SXin Li const CXXRecordDecl *Derived,
370*67e74705SXin Li CastExpr::path_const_iterator PathBegin,
371*67e74705SXin Li CastExpr::path_const_iterator PathEnd,
372*67e74705SXin Li bool NullCheckValue) {
373*67e74705SXin Li assert(PathBegin != PathEnd && "Base path should not be empty!");
374*67e74705SXin Li
375*67e74705SXin Li QualType DerivedTy =
376*67e74705SXin Li getContext().getCanonicalType(getContext().getTagDeclType(Derived));
377*67e74705SXin Li llvm::Type *DerivedPtrTy = ConvertType(DerivedTy)->getPointerTo();
378*67e74705SXin Li
379*67e74705SXin Li llvm::Value *NonVirtualOffset =
380*67e74705SXin Li CGM.GetNonVirtualBaseClassOffset(Derived, PathBegin, PathEnd);
381*67e74705SXin Li
382*67e74705SXin Li if (!NonVirtualOffset) {
383*67e74705SXin Li // No offset, we can just cast back.
384*67e74705SXin Li return Builder.CreateBitCast(BaseAddr, DerivedPtrTy);
385*67e74705SXin Li }
386*67e74705SXin Li
387*67e74705SXin Li llvm::BasicBlock *CastNull = nullptr;
388*67e74705SXin Li llvm::BasicBlock *CastNotNull = nullptr;
389*67e74705SXin Li llvm::BasicBlock *CastEnd = nullptr;
390*67e74705SXin Li
391*67e74705SXin Li if (NullCheckValue) {
392*67e74705SXin Li CastNull = createBasicBlock("cast.null");
393*67e74705SXin Li CastNotNull = createBasicBlock("cast.notnull");
394*67e74705SXin Li CastEnd = createBasicBlock("cast.end");
395*67e74705SXin Li
396*67e74705SXin Li llvm::Value *IsNull = Builder.CreateIsNull(BaseAddr.getPointer());
397*67e74705SXin Li Builder.CreateCondBr(IsNull, CastNull, CastNotNull);
398*67e74705SXin Li EmitBlock(CastNotNull);
399*67e74705SXin Li }
400*67e74705SXin Li
401*67e74705SXin Li // Apply the offset.
402*67e74705SXin Li llvm::Value *Value = Builder.CreateBitCast(BaseAddr.getPointer(), Int8PtrTy);
403*67e74705SXin Li Value = Builder.CreateGEP(Value, Builder.CreateNeg(NonVirtualOffset),
404*67e74705SXin Li "sub.ptr");
405*67e74705SXin Li
406*67e74705SXin Li // Just cast.
407*67e74705SXin Li Value = Builder.CreateBitCast(Value, DerivedPtrTy);
408*67e74705SXin Li
409*67e74705SXin Li // Produce a PHI if we had a null-check.
410*67e74705SXin Li if (NullCheckValue) {
411*67e74705SXin Li Builder.CreateBr(CastEnd);
412*67e74705SXin Li EmitBlock(CastNull);
413*67e74705SXin Li Builder.CreateBr(CastEnd);
414*67e74705SXin Li EmitBlock(CastEnd);
415*67e74705SXin Li
416*67e74705SXin Li llvm::PHINode *PHI = Builder.CreatePHI(Value->getType(), 2);
417*67e74705SXin Li PHI->addIncoming(Value, CastNotNull);
418*67e74705SXin Li PHI->addIncoming(llvm::Constant::getNullValue(Value->getType()), CastNull);
419*67e74705SXin Li Value = PHI;
420*67e74705SXin Li }
421*67e74705SXin Li
422*67e74705SXin Li return Address(Value, CGM.getClassPointerAlignment(Derived));
423*67e74705SXin Li }
424*67e74705SXin Li
GetVTTParameter(GlobalDecl GD,bool ForVirtualBase,bool Delegating)425*67e74705SXin Li llvm::Value *CodeGenFunction::GetVTTParameter(GlobalDecl GD,
426*67e74705SXin Li bool ForVirtualBase,
427*67e74705SXin Li bool Delegating) {
428*67e74705SXin Li if (!CGM.getCXXABI().NeedsVTTParameter(GD)) {
429*67e74705SXin Li // This constructor/destructor does not need a VTT parameter.
430*67e74705SXin Li return nullptr;
431*67e74705SXin Li }
432*67e74705SXin Li
433*67e74705SXin Li const CXXRecordDecl *RD = cast<CXXMethodDecl>(CurCodeDecl)->getParent();
434*67e74705SXin Li const CXXRecordDecl *Base = cast<CXXMethodDecl>(GD.getDecl())->getParent();
435*67e74705SXin Li
436*67e74705SXin Li llvm::Value *VTT;
437*67e74705SXin Li
438*67e74705SXin Li uint64_t SubVTTIndex;
439*67e74705SXin Li
440*67e74705SXin Li if (Delegating) {
441*67e74705SXin Li // If this is a delegating constructor call, just load the VTT.
442*67e74705SXin Li return LoadCXXVTT();
443*67e74705SXin Li } else if (RD == Base) {
444*67e74705SXin Li // If the record matches the base, this is the complete ctor/dtor
445*67e74705SXin Li // variant calling the base variant in a class with virtual bases.
446*67e74705SXin Li assert(!CGM.getCXXABI().NeedsVTTParameter(CurGD) &&
447*67e74705SXin Li "doing no-op VTT offset in base dtor/ctor?");
448*67e74705SXin Li assert(!ForVirtualBase && "Can't have same class as virtual base!");
449*67e74705SXin Li SubVTTIndex = 0;
450*67e74705SXin Li } else {
451*67e74705SXin Li const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
452*67e74705SXin Li CharUnits BaseOffset = ForVirtualBase ?
453*67e74705SXin Li Layout.getVBaseClassOffset(Base) :
454*67e74705SXin Li Layout.getBaseClassOffset(Base);
455*67e74705SXin Li
456*67e74705SXin Li SubVTTIndex =
457*67e74705SXin Li CGM.getVTables().getSubVTTIndex(RD, BaseSubobject(Base, BaseOffset));
458*67e74705SXin Li assert(SubVTTIndex != 0 && "Sub-VTT index must be greater than zero!");
459*67e74705SXin Li }
460*67e74705SXin Li
461*67e74705SXin Li if (CGM.getCXXABI().NeedsVTTParameter(CurGD)) {
462*67e74705SXin Li // A VTT parameter was passed to the constructor, use it.
463*67e74705SXin Li VTT = LoadCXXVTT();
464*67e74705SXin Li VTT = Builder.CreateConstInBoundsGEP1_64(VTT, SubVTTIndex);
465*67e74705SXin Li } else {
466*67e74705SXin Li // We're the complete constructor, so get the VTT by name.
467*67e74705SXin Li VTT = CGM.getVTables().GetAddrOfVTT(RD);
468*67e74705SXin Li VTT = Builder.CreateConstInBoundsGEP2_64(VTT, 0, SubVTTIndex);
469*67e74705SXin Li }
470*67e74705SXin Li
471*67e74705SXin Li return VTT;
472*67e74705SXin Li }
473*67e74705SXin Li
474*67e74705SXin Li namespace {
475*67e74705SXin Li /// Call the destructor for a direct base class.
476*67e74705SXin Li struct CallBaseDtor final : EHScopeStack::Cleanup {
477*67e74705SXin Li const CXXRecordDecl *BaseClass;
478*67e74705SXin Li bool BaseIsVirtual;
CallBaseDtor__anon6bf721160111::CallBaseDtor479*67e74705SXin Li CallBaseDtor(const CXXRecordDecl *Base, bool BaseIsVirtual)
480*67e74705SXin Li : BaseClass(Base), BaseIsVirtual(BaseIsVirtual) {}
481*67e74705SXin Li
Emit__anon6bf721160111::CallBaseDtor482*67e74705SXin Li void Emit(CodeGenFunction &CGF, Flags flags) override {
483*67e74705SXin Li const CXXRecordDecl *DerivedClass =
484*67e74705SXin Li cast<CXXMethodDecl>(CGF.CurCodeDecl)->getParent();
485*67e74705SXin Li
486*67e74705SXin Li const CXXDestructorDecl *D = BaseClass->getDestructor();
487*67e74705SXin Li Address Addr =
488*67e74705SXin Li CGF.GetAddressOfDirectBaseInCompleteClass(CGF.LoadCXXThisAddress(),
489*67e74705SXin Li DerivedClass, BaseClass,
490*67e74705SXin Li BaseIsVirtual);
491*67e74705SXin Li CGF.EmitCXXDestructorCall(D, Dtor_Base, BaseIsVirtual,
492*67e74705SXin Li /*Delegating=*/false, Addr);
493*67e74705SXin Li }
494*67e74705SXin Li };
495*67e74705SXin Li
496*67e74705SXin Li /// A visitor which checks whether an initializer uses 'this' in a
497*67e74705SXin Li /// way which requires the vtable to be properly set.
498*67e74705SXin Li struct DynamicThisUseChecker : ConstEvaluatedExprVisitor<DynamicThisUseChecker> {
499*67e74705SXin Li typedef ConstEvaluatedExprVisitor<DynamicThisUseChecker> super;
500*67e74705SXin Li
501*67e74705SXin Li bool UsesThis;
502*67e74705SXin Li
DynamicThisUseChecker__anon6bf721160111::DynamicThisUseChecker503*67e74705SXin Li DynamicThisUseChecker(const ASTContext &C) : super(C), UsesThis(false) {}
504*67e74705SXin Li
505*67e74705SXin Li // Black-list all explicit and implicit references to 'this'.
506*67e74705SXin Li //
507*67e74705SXin Li // Do we need to worry about external references to 'this' derived
508*67e74705SXin Li // from arbitrary code? If so, then anything which runs arbitrary
509*67e74705SXin Li // external code might potentially access the vtable.
VisitCXXThisExpr__anon6bf721160111::DynamicThisUseChecker510*67e74705SXin Li void VisitCXXThisExpr(const CXXThisExpr *E) { UsesThis = true; }
511*67e74705SXin Li };
512*67e74705SXin Li } // end anonymous namespace
513*67e74705SXin Li
BaseInitializerUsesThis(ASTContext & C,const Expr * Init)514*67e74705SXin Li static bool BaseInitializerUsesThis(ASTContext &C, const Expr *Init) {
515*67e74705SXin Li DynamicThisUseChecker Checker(C);
516*67e74705SXin Li Checker.Visit(Init);
517*67e74705SXin Li return Checker.UsesThis;
518*67e74705SXin Li }
519*67e74705SXin Li
EmitBaseInitializer(CodeGenFunction & CGF,const CXXRecordDecl * ClassDecl,CXXCtorInitializer * BaseInit,CXXCtorType CtorType)520*67e74705SXin Li static void EmitBaseInitializer(CodeGenFunction &CGF,
521*67e74705SXin Li const CXXRecordDecl *ClassDecl,
522*67e74705SXin Li CXXCtorInitializer *BaseInit,
523*67e74705SXin Li CXXCtorType CtorType) {
524*67e74705SXin Li assert(BaseInit->isBaseInitializer() &&
525*67e74705SXin Li "Must have base initializer!");
526*67e74705SXin Li
527*67e74705SXin Li Address ThisPtr = CGF.LoadCXXThisAddress();
528*67e74705SXin Li
529*67e74705SXin Li const Type *BaseType = BaseInit->getBaseClass();
530*67e74705SXin Li CXXRecordDecl *BaseClassDecl =
531*67e74705SXin Li cast<CXXRecordDecl>(BaseType->getAs<RecordType>()->getDecl());
532*67e74705SXin Li
533*67e74705SXin Li bool isBaseVirtual = BaseInit->isBaseVirtual();
534*67e74705SXin Li
535*67e74705SXin Li // The base constructor doesn't construct virtual bases.
536*67e74705SXin Li if (CtorType == Ctor_Base && isBaseVirtual)
537*67e74705SXin Li return;
538*67e74705SXin Li
539*67e74705SXin Li // If the initializer for the base (other than the constructor
540*67e74705SXin Li // itself) accesses 'this' in any way, we need to initialize the
541*67e74705SXin Li // vtables.
542*67e74705SXin Li if (BaseInitializerUsesThis(CGF.getContext(), BaseInit->getInit()))
543*67e74705SXin Li CGF.InitializeVTablePointers(ClassDecl);
544*67e74705SXin Li
545*67e74705SXin Li // We can pretend to be a complete class because it only matters for
546*67e74705SXin Li // virtual bases, and we only do virtual bases for complete ctors.
547*67e74705SXin Li Address V =
548*67e74705SXin Li CGF.GetAddressOfDirectBaseInCompleteClass(ThisPtr, ClassDecl,
549*67e74705SXin Li BaseClassDecl,
550*67e74705SXin Li isBaseVirtual);
551*67e74705SXin Li AggValueSlot AggSlot =
552*67e74705SXin Li AggValueSlot::forAddr(V, Qualifiers(),
553*67e74705SXin Li AggValueSlot::IsDestructed,
554*67e74705SXin Li AggValueSlot::DoesNotNeedGCBarriers,
555*67e74705SXin Li AggValueSlot::IsNotAliased);
556*67e74705SXin Li
557*67e74705SXin Li CGF.EmitAggExpr(BaseInit->getInit(), AggSlot);
558*67e74705SXin Li
559*67e74705SXin Li if (CGF.CGM.getLangOpts().Exceptions &&
560*67e74705SXin Li !BaseClassDecl->hasTrivialDestructor())
561*67e74705SXin Li CGF.EHStack.pushCleanup<CallBaseDtor>(EHCleanup, BaseClassDecl,
562*67e74705SXin Li isBaseVirtual);
563*67e74705SXin Li }
564*67e74705SXin Li
EmitAggMemberInitializer(CodeGenFunction & CGF,LValue LHS,Expr * Init,Address ArrayIndexVar,QualType T,ArrayRef<VarDecl * > ArrayIndexes,unsigned Index)565*67e74705SXin Li static void EmitAggMemberInitializer(CodeGenFunction &CGF,
566*67e74705SXin Li LValue LHS,
567*67e74705SXin Li Expr *Init,
568*67e74705SXin Li Address ArrayIndexVar,
569*67e74705SXin Li QualType T,
570*67e74705SXin Li ArrayRef<VarDecl *> ArrayIndexes,
571*67e74705SXin Li unsigned Index) {
572*67e74705SXin Li if (Index == ArrayIndexes.size()) {
573*67e74705SXin Li LValue LV = LHS;
574*67e74705SXin Li
575*67e74705SXin Li if (ArrayIndexVar.isValid()) {
576*67e74705SXin Li // If we have an array index variable, load it and use it as an offset.
577*67e74705SXin Li // Then, increment the value.
578*67e74705SXin Li llvm::Value *Dest = LHS.getPointer();
579*67e74705SXin Li llvm::Value *ArrayIndex = CGF.Builder.CreateLoad(ArrayIndexVar);
580*67e74705SXin Li Dest = CGF.Builder.CreateInBoundsGEP(Dest, ArrayIndex, "destaddress");
581*67e74705SXin Li llvm::Value *Next = llvm::ConstantInt::get(ArrayIndex->getType(), 1);
582*67e74705SXin Li Next = CGF.Builder.CreateAdd(ArrayIndex, Next, "inc");
583*67e74705SXin Li CGF.Builder.CreateStore(Next, ArrayIndexVar);
584*67e74705SXin Li
585*67e74705SXin Li // Update the LValue.
586*67e74705SXin Li CharUnits EltSize = CGF.getContext().getTypeSizeInChars(T);
587*67e74705SXin Li CharUnits Align = LV.getAlignment().alignmentOfArrayElement(EltSize);
588*67e74705SXin Li LV.setAddress(Address(Dest, Align));
589*67e74705SXin Li }
590*67e74705SXin Li
591*67e74705SXin Li switch (CGF.getEvaluationKind(T)) {
592*67e74705SXin Li case TEK_Scalar:
593*67e74705SXin Li CGF.EmitScalarInit(Init, /*decl*/ nullptr, LV, false);
594*67e74705SXin Li break;
595*67e74705SXin Li case TEK_Complex:
596*67e74705SXin Li CGF.EmitComplexExprIntoLValue(Init, LV, /*isInit*/ true);
597*67e74705SXin Li break;
598*67e74705SXin Li case TEK_Aggregate: {
599*67e74705SXin Li AggValueSlot Slot =
600*67e74705SXin Li AggValueSlot::forLValue(LV,
601*67e74705SXin Li AggValueSlot::IsDestructed,
602*67e74705SXin Li AggValueSlot::DoesNotNeedGCBarriers,
603*67e74705SXin Li AggValueSlot::IsNotAliased);
604*67e74705SXin Li
605*67e74705SXin Li CGF.EmitAggExpr(Init, Slot);
606*67e74705SXin Li break;
607*67e74705SXin Li }
608*67e74705SXin Li }
609*67e74705SXin Li
610*67e74705SXin Li return;
611*67e74705SXin Li }
612*67e74705SXin Li
613*67e74705SXin Li const ConstantArrayType *Array = CGF.getContext().getAsConstantArrayType(T);
614*67e74705SXin Li assert(Array && "Array initialization without the array type?");
615*67e74705SXin Li Address IndexVar = CGF.GetAddrOfLocalVar(ArrayIndexes[Index]);
616*67e74705SXin Li
617*67e74705SXin Li // Initialize this index variable to zero.
618*67e74705SXin Li llvm::Value* Zero
619*67e74705SXin Li = llvm::Constant::getNullValue(IndexVar.getElementType());
620*67e74705SXin Li CGF.Builder.CreateStore(Zero, IndexVar);
621*67e74705SXin Li
622*67e74705SXin Li // Start the loop with a block that tests the condition.
623*67e74705SXin Li llvm::BasicBlock *CondBlock = CGF.createBasicBlock("for.cond");
624*67e74705SXin Li llvm::BasicBlock *AfterFor = CGF.createBasicBlock("for.end");
625*67e74705SXin Li
626*67e74705SXin Li CGF.EmitBlock(CondBlock);
627*67e74705SXin Li
628*67e74705SXin Li llvm::BasicBlock *ForBody = CGF.createBasicBlock("for.body");
629*67e74705SXin Li // Generate: if (loop-index < number-of-elements) fall to the loop body,
630*67e74705SXin Li // otherwise, go to the block after the for-loop.
631*67e74705SXin Li uint64_t NumElements = Array->getSize().getZExtValue();
632*67e74705SXin Li llvm::Value *Counter = CGF.Builder.CreateLoad(IndexVar);
633*67e74705SXin Li llvm::Value *NumElementsPtr =
634*67e74705SXin Li llvm::ConstantInt::get(Counter->getType(), NumElements);
635*67e74705SXin Li llvm::Value *IsLess = CGF.Builder.CreateICmpULT(Counter, NumElementsPtr,
636*67e74705SXin Li "isless");
637*67e74705SXin Li
638*67e74705SXin Li // If the condition is true, execute the body.
639*67e74705SXin Li CGF.Builder.CreateCondBr(IsLess, ForBody, AfterFor);
640*67e74705SXin Li
641*67e74705SXin Li CGF.EmitBlock(ForBody);
642*67e74705SXin Li llvm::BasicBlock *ContinueBlock = CGF.createBasicBlock("for.inc");
643*67e74705SXin Li
644*67e74705SXin Li // Inside the loop body recurse to emit the inner loop or, eventually, the
645*67e74705SXin Li // constructor call.
646*67e74705SXin Li EmitAggMemberInitializer(CGF, LHS, Init, ArrayIndexVar,
647*67e74705SXin Li Array->getElementType(), ArrayIndexes, Index + 1);
648*67e74705SXin Li
649*67e74705SXin Li CGF.EmitBlock(ContinueBlock);
650*67e74705SXin Li
651*67e74705SXin Li // Emit the increment of the loop counter.
652*67e74705SXin Li llvm::Value *NextVal = llvm::ConstantInt::get(Counter->getType(), 1);
653*67e74705SXin Li Counter = CGF.Builder.CreateLoad(IndexVar);
654*67e74705SXin Li NextVal = CGF.Builder.CreateAdd(Counter, NextVal, "inc");
655*67e74705SXin Li CGF.Builder.CreateStore(NextVal, IndexVar);
656*67e74705SXin Li
657*67e74705SXin Li // Finally, branch back up to the condition for the next iteration.
658*67e74705SXin Li CGF.EmitBranch(CondBlock);
659*67e74705SXin Li
660*67e74705SXin Li // Emit the fall-through block.
661*67e74705SXin Li CGF.EmitBlock(AfterFor, true);
662*67e74705SXin Li }
663*67e74705SXin Li
isMemcpyEquivalentSpecialMember(const CXXMethodDecl * D)664*67e74705SXin Li static bool isMemcpyEquivalentSpecialMember(const CXXMethodDecl *D) {
665*67e74705SXin Li auto *CD = dyn_cast<CXXConstructorDecl>(D);
666*67e74705SXin Li if (!(CD && CD->isCopyOrMoveConstructor()) &&
667*67e74705SXin Li !D->isCopyAssignmentOperator() && !D->isMoveAssignmentOperator())
668*67e74705SXin Li return false;
669*67e74705SXin Li
670*67e74705SXin Li // We can emit a memcpy for a trivial copy or move constructor/assignment.
671*67e74705SXin Li if (D->isTrivial() && !D->getParent()->mayInsertExtraPadding())
672*67e74705SXin Li return true;
673*67e74705SXin Li
674*67e74705SXin Li // We *must* emit a memcpy for a defaulted union copy or move op.
675*67e74705SXin Li if (D->getParent()->isUnion() && D->isDefaulted())
676*67e74705SXin Li return true;
677*67e74705SXin Li
678*67e74705SXin Li return false;
679*67e74705SXin Li }
680*67e74705SXin Li
EmitLValueForAnyFieldInitialization(CodeGenFunction & CGF,CXXCtorInitializer * MemberInit,LValue & LHS)681*67e74705SXin Li static void EmitLValueForAnyFieldInitialization(CodeGenFunction &CGF,
682*67e74705SXin Li CXXCtorInitializer *MemberInit,
683*67e74705SXin Li LValue &LHS) {
684*67e74705SXin Li FieldDecl *Field = MemberInit->getAnyMember();
685*67e74705SXin Li if (MemberInit->isIndirectMemberInitializer()) {
686*67e74705SXin Li // If we are initializing an anonymous union field, drill down to the field.
687*67e74705SXin Li IndirectFieldDecl *IndirectField = MemberInit->getIndirectMember();
688*67e74705SXin Li for (const auto *I : IndirectField->chain())
689*67e74705SXin Li LHS = CGF.EmitLValueForFieldInitialization(LHS, cast<FieldDecl>(I));
690*67e74705SXin Li } else {
691*67e74705SXin Li LHS = CGF.EmitLValueForFieldInitialization(LHS, Field);
692*67e74705SXin Li }
693*67e74705SXin Li }
694*67e74705SXin Li
EmitMemberInitializer(CodeGenFunction & CGF,const CXXRecordDecl * ClassDecl,CXXCtorInitializer * MemberInit,const CXXConstructorDecl * Constructor,FunctionArgList & Args)695*67e74705SXin Li static void EmitMemberInitializer(CodeGenFunction &CGF,
696*67e74705SXin Li const CXXRecordDecl *ClassDecl,
697*67e74705SXin Li CXXCtorInitializer *MemberInit,
698*67e74705SXin Li const CXXConstructorDecl *Constructor,
699*67e74705SXin Li FunctionArgList &Args) {
700*67e74705SXin Li ApplyDebugLocation Loc(CGF, MemberInit->getSourceLocation());
701*67e74705SXin Li assert(MemberInit->isAnyMemberInitializer() &&
702*67e74705SXin Li "Must have member initializer!");
703*67e74705SXin Li assert(MemberInit->getInit() && "Must have initializer!");
704*67e74705SXin Li
705*67e74705SXin Li // non-static data member initializers.
706*67e74705SXin Li FieldDecl *Field = MemberInit->getAnyMember();
707*67e74705SXin Li QualType FieldType = Field->getType();
708*67e74705SXin Li
709*67e74705SXin Li llvm::Value *ThisPtr = CGF.LoadCXXThis();
710*67e74705SXin Li QualType RecordTy = CGF.getContext().getTypeDeclType(ClassDecl);
711*67e74705SXin Li LValue LHS = CGF.MakeNaturalAlignAddrLValue(ThisPtr, RecordTy);
712*67e74705SXin Li
713*67e74705SXin Li EmitLValueForAnyFieldInitialization(CGF, MemberInit, LHS);
714*67e74705SXin Li
715*67e74705SXin Li // Special case: if we are in a copy or move constructor, and we are copying
716*67e74705SXin Li // an array of PODs or classes with trivial copy constructors, ignore the
717*67e74705SXin Li // AST and perform the copy we know is equivalent.
718*67e74705SXin Li // FIXME: This is hacky at best... if we had a bit more explicit information
719*67e74705SXin Li // in the AST, we could generalize it more easily.
720*67e74705SXin Li const ConstantArrayType *Array
721*67e74705SXin Li = CGF.getContext().getAsConstantArrayType(FieldType);
722*67e74705SXin Li if (Array && Constructor->isDefaulted() &&
723*67e74705SXin Li Constructor->isCopyOrMoveConstructor()) {
724*67e74705SXin Li QualType BaseElementTy = CGF.getContext().getBaseElementType(Array);
725*67e74705SXin Li CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(MemberInit->getInit());
726*67e74705SXin Li if (BaseElementTy.isPODType(CGF.getContext()) ||
727*67e74705SXin Li (CE && isMemcpyEquivalentSpecialMember(CE->getConstructor()))) {
728*67e74705SXin Li unsigned SrcArgIndex =
729*67e74705SXin Li CGF.CGM.getCXXABI().getSrcArgforCopyCtor(Constructor, Args);
730*67e74705SXin Li llvm::Value *SrcPtr
731*67e74705SXin Li = CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(Args[SrcArgIndex]));
732*67e74705SXin Li LValue ThisRHSLV = CGF.MakeNaturalAlignAddrLValue(SrcPtr, RecordTy);
733*67e74705SXin Li LValue Src = CGF.EmitLValueForFieldInitialization(ThisRHSLV, Field);
734*67e74705SXin Li
735*67e74705SXin Li // Copy the aggregate.
736*67e74705SXin Li CGF.EmitAggregateCopy(LHS.getAddress(), Src.getAddress(), FieldType,
737*67e74705SXin Li LHS.isVolatileQualified());
738*67e74705SXin Li // Ensure that we destroy the objects if an exception is thrown later in
739*67e74705SXin Li // the constructor.
740*67e74705SXin Li QualType::DestructionKind dtorKind = FieldType.isDestructedType();
741*67e74705SXin Li if (CGF.needsEHCleanup(dtorKind))
742*67e74705SXin Li CGF.pushEHDestroy(dtorKind, LHS.getAddress(), FieldType);
743*67e74705SXin Li return;
744*67e74705SXin Li }
745*67e74705SXin Li }
746*67e74705SXin Li
747*67e74705SXin Li ArrayRef<VarDecl *> ArrayIndexes;
748*67e74705SXin Li if (MemberInit->getNumArrayIndices())
749*67e74705SXin Li ArrayIndexes = MemberInit->getArrayIndices();
750*67e74705SXin Li CGF.EmitInitializerForField(Field, LHS, MemberInit->getInit(), ArrayIndexes);
751*67e74705SXin Li }
752*67e74705SXin Li
EmitInitializerForField(FieldDecl * Field,LValue LHS,Expr * Init,ArrayRef<VarDecl * > ArrayIndexes)753*67e74705SXin Li void CodeGenFunction::EmitInitializerForField(FieldDecl *Field, LValue LHS,
754*67e74705SXin Li Expr *Init, ArrayRef<VarDecl *> ArrayIndexes) {
755*67e74705SXin Li QualType FieldType = Field->getType();
756*67e74705SXin Li switch (getEvaluationKind(FieldType)) {
757*67e74705SXin Li case TEK_Scalar:
758*67e74705SXin Li if (LHS.isSimple()) {
759*67e74705SXin Li EmitExprAsInit(Init, Field, LHS, false);
760*67e74705SXin Li } else {
761*67e74705SXin Li RValue RHS = RValue::get(EmitScalarExpr(Init));
762*67e74705SXin Li EmitStoreThroughLValue(RHS, LHS);
763*67e74705SXin Li }
764*67e74705SXin Li break;
765*67e74705SXin Li case TEK_Complex:
766*67e74705SXin Li EmitComplexExprIntoLValue(Init, LHS, /*isInit*/ true);
767*67e74705SXin Li break;
768*67e74705SXin Li case TEK_Aggregate: {
769*67e74705SXin Li Address ArrayIndexVar = Address::invalid();
770*67e74705SXin Li if (ArrayIndexes.size()) {
771*67e74705SXin Li // The LHS is a pointer to the first object we'll be constructing, as
772*67e74705SXin Li // a flat array.
773*67e74705SXin Li QualType BaseElementTy = getContext().getBaseElementType(FieldType);
774*67e74705SXin Li llvm::Type *BasePtr = ConvertType(BaseElementTy);
775*67e74705SXin Li BasePtr = llvm::PointerType::getUnqual(BasePtr);
776*67e74705SXin Li Address BaseAddrPtr = Builder.CreateBitCast(LHS.getAddress(), BasePtr);
777*67e74705SXin Li LHS = MakeAddrLValue(BaseAddrPtr, BaseElementTy);
778*67e74705SXin Li
779*67e74705SXin Li // Create an array index that will be used to walk over all of the
780*67e74705SXin Li // objects we're constructing.
781*67e74705SXin Li ArrayIndexVar = CreateMemTemp(getContext().getSizeType(), "object.index");
782*67e74705SXin Li llvm::Value *Zero =
783*67e74705SXin Li llvm::Constant::getNullValue(ArrayIndexVar.getElementType());
784*67e74705SXin Li Builder.CreateStore(Zero, ArrayIndexVar);
785*67e74705SXin Li
786*67e74705SXin Li // Emit the block variables for the array indices, if any.
787*67e74705SXin Li for (unsigned I = 0, N = ArrayIndexes.size(); I != N; ++I)
788*67e74705SXin Li EmitAutoVarDecl(*ArrayIndexes[I]);
789*67e74705SXin Li }
790*67e74705SXin Li
791*67e74705SXin Li EmitAggMemberInitializer(*this, LHS, Init, ArrayIndexVar, FieldType,
792*67e74705SXin Li ArrayIndexes, 0);
793*67e74705SXin Li }
794*67e74705SXin Li }
795*67e74705SXin Li
796*67e74705SXin Li // Ensure that we destroy this object if an exception is thrown
797*67e74705SXin Li // later in the constructor.
798*67e74705SXin Li QualType::DestructionKind dtorKind = FieldType.isDestructedType();
799*67e74705SXin Li if (needsEHCleanup(dtorKind))
800*67e74705SXin Li pushEHDestroy(dtorKind, LHS.getAddress(), FieldType);
801*67e74705SXin Li }
802*67e74705SXin Li
803*67e74705SXin Li /// Checks whether the given constructor is a valid subject for the
804*67e74705SXin Li /// complete-to-base constructor delegation optimization, i.e.
805*67e74705SXin Li /// emitting the complete constructor as a simple call to the base
806*67e74705SXin Li /// constructor.
IsConstructorDelegationValid(const CXXConstructorDecl * Ctor)807*67e74705SXin Li static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor) {
808*67e74705SXin Li
809*67e74705SXin Li // Currently we disable the optimization for classes with virtual
810*67e74705SXin Li // bases because (1) the addresses of parameter variables need to be
811*67e74705SXin Li // consistent across all initializers but (2) the delegate function
812*67e74705SXin Li // call necessarily creates a second copy of the parameter variable.
813*67e74705SXin Li //
814*67e74705SXin Li // The limiting example (purely theoretical AFAIK):
815*67e74705SXin Li // struct A { A(int &c) { c++; } };
816*67e74705SXin Li // struct B : virtual A {
817*67e74705SXin Li // B(int count) : A(count) { printf("%d\n", count); }
818*67e74705SXin Li // };
819*67e74705SXin Li // ...although even this example could in principle be emitted as a
820*67e74705SXin Li // delegation since the address of the parameter doesn't escape.
821*67e74705SXin Li if (Ctor->getParent()->getNumVBases()) {
822*67e74705SXin Li // TODO: white-list trivial vbase initializers. This case wouldn't
823*67e74705SXin Li // be subject to the restrictions below.
824*67e74705SXin Li
825*67e74705SXin Li // TODO: white-list cases where:
826*67e74705SXin Li // - there are no non-reference parameters to the constructor
827*67e74705SXin Li // - the initializers don't access any non-reference parameters
828*67e74705SXin Li // - the initializers don't take the address of non-reference
829*67e74705SXin Li // parameters
830*67e74705SXin Li // - etc.
831*67e74705SXin Li // If we ever add any of the above cases, remember that:
832*67e74705SXin Li // - function-try-blocks will always blacklist this optimization
833*67e74705SXin Li // - we need to perform the constructor prologue and cleanup in
834*67e74705SXin Li // EmitConstructorBody.
835*67e74705SXin Li
836*67e74705SXin Li return false;
837*67e74705SXin Li }
838*67e74705SXin Li
839*67e74705SXin Li // We also disable the optimization for variadic functions because
840*67e74705SXin Li // it's impossible to "re-pass" varargs.
841*67e74705SXin Li if (Ctor->getType()->getAs<FunctionProtoType>()->isVariadic())
842*67e74705SXin Li return false;
843*67e74705SXin Li
844*67e74705SXin Li // FIXME: Decide if we can do a delegation of a delegating constructor.
845*67e74705SXin Li if (Ctor->isDelegatingConstructor())
846*67e74705SXin Li return false;
847*67e74705SXin Li
848*67e74705SXin Li return true;
849*67e74705SXin Li }
850*67e74705SXin Li
851*67e74705SXin Li // Emit code in ctor (Prologue==true) or dtor (Prologue==false)
852*67e74705SXin Li // to poison the extra field paddings inserted under
853*67e74705SXin Li // -fsanitize-address-field-padding=1|2.
EmitAsanPrologueOrEpilogue(bool Prologue)854*67e74705SXin Li void CodeGenFunction::EmitAsanPrologueOrEpilogue(bool Prologue) {
855*67e74705SXin Li ASTContext &Context = getContext();
856*67e74705SXin Li const CXXRecordDecl *ClassDecl =
857*67e74705SXin Li Prologue ? cast<CXXConstructorDecl>(CurGD.getDecl())->getParent()
858*67e74705SXin Li : cast<CXXDestructorDecl>(CurGD.getDecl())->getParent();
859*67e74705SXin Li if (!ClassDecl->mayInsertExtraPadding()) return;
860*67e74705SXin Li
861*67e74705SXin Li struct SizeAndOffset {
862*67e74705SXin Li uint64_t Size;
863*67e74705SXin Li uint64_t Offset;
864*67e74705SXin Li };
865*67e74705SXin Li
866*67e74705SXin Li unsigned PtrSize = CGM.getDataLayout().getPointerSizeInBits();
867*67e74705SXin Li const ASTRecordLayout &Info = Context.getASTRecordLayout(ClassDecl);
868*67e74705SXin Li
869*67e74705SXin Li // Populate sizes and offsets of fields.
870*67e74705SXin Li SmallVector<SizeAndOffset, 16> SSV(Info.getFieldCount());
871*67e74705SXin Li for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i)
872*67e74705SXin Li SSV[i].Offset =
873*67e74705SXin Li Context.toCharUnitsFromBits(Info.getFieldOffset(i)).getQuantity();
874*67e74705SXin Li
875*67e74705SXin Li size_t NumFields = 0;
876*67e74705SXin Li for (const auto *Field : ClassDecl->fields()) {
877*67e74705SXin Li const FieldDecl *D = Field;
878*67e74705SXin Li std::pair<CharUnits, CharUnits> FieldInfo =
879*67e74705SXin Li Context.getTypeInfoInChars(D->getType());
880*67e74705SXin Li CharUnits FieldSize = FieldInfo.first;
881*67e74705SXin Li assert(NumFields < SSV.size());
882*67e74705SXin Li SSV[NumFields].Size = D->isBitField() ? 0 : FieldSize.getQuantity();
883*67e74705SXin Li NumFields++;
884*67e74705SXin Li }
885*67e74705SXin Li assert(NumFields == SSV.size());
886*67e74705SXin Li if (SSV.size() <= 1) return;
887*67e74705SXin Li
888*67e74705SXin Li // We will insert calls to __asan_* run-time functions.
889*67e74705SXin Li // LLVM AddressSanitizer pass may decide to inline them later.
890*67e74705SXin Li llvm::Type *Args[2] = {IntPtrTy, IntPtrTy};
891*67e74705SXin Li llvm::FunctionType *FTy =
892*67e74705SXin Li llvm::FunctionType::get(CGM.VoidTy, Args, false);
893*67e74705SXin Li llvm::Constant *F = CGM.CreateRuntimeFunction(
894*67e74705SXin Li FTy, Prologue ? "__asan_poison_intra_object_redzone"
895*67e74705SXin Li : "__asan_unpoison_intra_object_redzone");
896*67e74705SXin Li
897*67e74705SXin Li llvm::Value *ThisPtr = LoadCXXThis();
898*67e74705SXin Li ThisPtr = Builder.CreatePtrToInt(ThisPtr, IntPtrTy);
899*67e74705SXin Li uint64_t TypeSize = Info.getNonVirtualSize().getQuantity();
900*67e74705SXin Li // For each field check if it has sufficient padding,
901*67e74705SXin Li // if so (un)poison it with a call.
902*67e74705SXin Li for (size_t i = 0; i < SSV.size(); i++) {
903*67e74705SXin Li uint64_t AsanAlignment = 8;
904*67e74705SXin Li uint64_t NextField = i == SSV.size() - 1 ? TypeSize : SSV[i + 1].Offset;
905*67e74705SXin Li uint64_t PoisonSize = NextField - SSV[i].Offset - SSV[i].Size;
906*67e74705SXin Li uint64_t EndOffset = SSV[i].Offset + SSV[i].Size;
907*67e74705SXin Li if (PoisonSize < AsanAlignment || !SSV[i].Size ||
908*67e74705SXin Li (NextField % AsanAlignment) != 0)
909*67e74705SXin Li continue;
910*67e74705SXin Li Builder.CreateCall(
911*67e74705SXin Li F, {Builder.CreateAdd(ThisPtr, Builder.getIntN(PtrSize, EndOffset)),
912*67e74705SXin Li Builder.getIntN(PtrSize, PoisonSize)});
913*67e74705SXin Li }
914*67e74705SXin Li }
915*67e74705SXin Li
916*67e74705SXin Li /// EmitConstructorBody - Emits the body of the current constructor.
EmitConstructorBody(FunctionArgList & Args)917*67e74705SXin Li void CodeGenFunction::EmitConstructorBody(FunctionArgList &Args) {
918*67e74705SXin Li EmitAsanPrologueOrEpilogue(true);
919*67e74705SXin Li const CXXConstructorDecl *Ctor = cast<CXXConstructorDecl>(CurGD.getDecl());
920*67e74705SXin Li CXXCtorType CtorType = CurGD.getCtorType();
921*67e74705SXin Li
922*67e74705SXin Li assert((CGM.getTarget().getCXXABI().hasConstructorVariants() ||
923*67e74705SXin Li CtorType == Ctor_Complete) &&
924*67e74705SXin Li "can only generate complete ctor for this ABI");
925*67e74705SXin Li
926*67e74705SXin Li // Before we go any further, try the complete->base constructor
927*67e74705SXin Li // delegation optimization.
928*67e74705SXin Li if (CtorType == Ctor_Complete && IsConstructorDelegationValid(Ctor) &&
929*67e74705SXin Li CGM.getTarget().getCXXABI().hasConstructorVariants()) {
930*67e74705SXin Li EmitDelegateCXXConstructorCall(Ctor, Ctor_Base, Args, Ctor->getLocEnd());
931*67e74705SXin Li return;
932*67e74705SXin Li }
933*67e74705SXin Li
934*67e74705SXin Li const FunctionDecl *Definition = nullptr;
935*67e74705SXin Li Stmt *Body = Ctor->getBody(Definition);
936*67e74705SXin Li assert(Definition == Ctor && "emitting wrong constructor body");
937*67e74705SXin Li
938*67e74705SXin Li // Enter the function-try-block before the constructor prologue if
939*67e74705SXin Li // applicable.
940*67e74705SXin Li bool IsTryBody = (Body && isa<CXXTryStmt>(Body));
941*67e74705SXin Li if (IsTryBody)
942*67e74705SXin Li EnterCXXTryStmt(*cast<CXXTryStmt>(Body), true);
943*67e74705SXin Li
944*67e74705SXin Li incrementProfileCounter(Body);
945*67e74705SXin Li
946*67e74705SXin Li RunCleanupsScope RunCleanups(*this);
947*67e74705SXin Li
948*67e74705SXin Li // TODO: in restricted cases, we can emit the vbase initializers of
949*67e74705SXin Li // a complete ctor and then delegate to the base ctor.
950*67e74705SXin Li
951*67e74705SXin Li // Emit the constructor prologue, i.e. the base and member
952*67e74705SXin Li // initializers.
953*67e74705SXin Li EmitCtorPrologue(Ctor, CtorType, Args);
954*67e74705SXin Li
955*67e74705SXin Li // Emit the body of the statement.
956*67e74705SXin Li if (IsTryBody)
957*67e74705SXin Li EmitStmt(cast<CXXTryStmt>(Body)->getTryBlock());
958*67e74705SXin Li else if (Body)
959*67e74705SXin Li EmitStmt(Body);
960*67e74705SXin Li
961*67e74705SXin Li // Emit any cleanup blocks associated with the member or base
962*67e74705SXin Li // initializers, which includes (along the exceptional path) the
963*67e74705SXin Li // destructors for those members and bases that were fully
964*67e74705SXin Li // constructed.
965*67e74705SXin Li RunCleanups.ForceCleanup();
966*67e74705SXin Li
967*67e74705SXin Li if (IsTryBody)
968*67e74705SXin Li ExitCXXTryStmt(*cast<CXXTryStmt>(Body), true);
969*67e74705SXin Li }
970*67e74705SXin Li
971*67e74705SXin Li namespace {
972*67e74705SXin Li /// RAII object to indicate that codegen is copying the value representation
973*67e74705SXin Li /// instead of the object representation. Useful when copying a struct or
974*67e74705SXin Li /// class which has uninitialized members and we're only performing
975*67e74705SXin Li /// lvalue-to-rvalue conversion on the object but not its members.
976*67e74705SXin Li class CopyingValueRepresentation {
977*67e74705SXin Li public:
CopyingValueRepresentation(CodeGenFunction & CGF)978*67e74705SXin Li explicit CopyingValueRepresentation(CodeGenFunction &CGF)
979*67e74705SXin Li : CGF(CGF), OldSanOpts(CGF.SanOpts) {
980*67e74705SXin Li CGF.SanOpts.set(SanitizerKind::Bool, false);
981*67e74705SXin Li CGF.SanOpts.set(SanitizerKind::Enum, false);
982*67e74705SXin Li }
~CopyingValueRepresentation()983*67e74705SXin Li ~CopyingValueRepresentation() {
984*67e74705SXin Li CGF.SanOpts = OldSanOpts;
985*67e74705SXin Li }
986*67e74705SXin Li private:
987*67e74705SXin Li CodeGenFunction &CGF;
988*67e74705SXin Li SanitizerSet OldSanOpts;
989*67e74705SXin Li };
990*67e74705SXin Li } // end anonymous namespace
991*67e74705SXin Li
992*67e74705SXin Li namespace {
993*67e74705SXin Li class FieldMemcpyizer {
994*67e74705SXin Li public:
FieldMemcpyizer(CodeGenFunction & CGF,const CXXRecordDecl * ClassDecl,const VarDecl * SrcRec)995*67e74705SXin Li FieldMemcpyizer(CodeGenFunction &CGF, const CXXRecordDecl *ClassDecl,
996*67e74705SXin Li const VarDecl *SrcRec)
997*67e74705SXin Li : CGF(CGF), ClassDecl(ClassDecl), SrcRec(SrcRec),
998*67e74705SXin Li RecLayout(CGF.getContext().getASTRecordLayout(ClassDecl)),
999*67e74705SXin Li FirstField(nullptr), LastField(nullptr), FirstFieldOffset(0),
1000*67e74705SXin Li LastFieldOffset(0), LastAddedFieldIndex(0) {}
1001*67e74705SXin Li
isMemcpyableField(FieldDecl * F) const1002*67e74705SXin Li bool isMemcpyableField(FieldDecl *F) const {
1003*67e74705SXin Li // Never memcpy fields when we are adding poisoned paddings.
1004*67e74705SXin Li if (CGF.getContext().getLangOpts().SanitizeAddressFieldPadding)
1005*67e74705SXin Li return false;
1006*67e74705SXin Li Qualifiers Qual = F->getType().getQualifiers();
1007*67e74705SXin Li if (Qual.hasVolatile() || Qual.hasObjCLifetime())
1008*67e74705SXin Li return false;
1009*67e74705SXin Li return true;
1010*67e74705SXin Li }
1011*67e74705SXin Li
addMemcpyableField(FieldDecl * F)1012*67e74705SXin Li void addMemcpyableField(FieldDecl *F) {
1013*67e74705SXin Li if (!FirstField)
1014*67e74705SXin Li addInitialField(F);
1015*67e74705SXin Li else
1016*67e74705SXin Li addNextField(F);
1017*67e74705SXin Li }
1018*67e74705SXin Li
getMemcpySize(uint64_t FirstByteOffset) const1019*67e74705SXin Li CharUnits getMemcpySize(uint64_t FirstByteOffset) const {
1020*67e74705SXin Li unsigned LastFieldSize =
1021*67e74705SXin Li LastField->isBitField() ?
1022*67e74705SXin Li LastField->getBitWidthValue(CGF.getContext()) :
1023*67e74705SXin Li CGF.getContext().getTypeSize(LastField->getType());
1024*67e74705SXin Li uint64_t MemcpySizeBits =
1025*67e74705SXin Li LastFieldOffset + LastFieldSize - FirstByteOffset +
1026*67e74705SXin Li CGF.getContext().getCharWidth() - 1;
1027*67e74705SXin Li CharUnits MemcpySize =
1028*67e74705SXin Li CGF.getContext().toCharUnitsFromBits(MemcpySizeBits);
1029*67e74705SXin Li return MemcpySize;
1030*67e74705SXin Li }
1031*67e74705SXin Li
emitMemcpy()1032*67e74705SXin Li void emitMemcpy() {
1033*67e74705SXin Li // Give the subclass a chance to bail out if it feels the memcpy isn't
1034*67e74705SXin Li // worth it (e.g. Hasn't aggregated enough data).
1035*67e74705SXin Li if (!FirstField) {
1036*67e74705SXin Li return;
1037*67e74705SXin Li }
1038*67e74705SXin Li
1039*67e74705SXin Li uint64_t FirstByteOffset;
1040*67e74705SXin Li if (FirstField->isBitField()) {
1041*67e74705SXin Li const CGRecordLayout &RL =
1042*67e74705SXin Li CGF.getTypes().getCGRecordLayout(FirstField->getParent());
1043*67e74705SXin Li const CGBitFieldInfo &BFInfo = RL.getBitFieldInfo(FirstField);
1044*67e74705SXin Li // FirstFieldOffset is not appropriate for bitfields,
1045*67e74705SXin Li // we need to use the storage offset instead.
1046*67e74705SXin Li FirstByteOffset = CGF.getContext().toBits(BFInfo.StorageOffset);
1047*67e74705SXin Li } else {
1048*67e74705SXin Li FirstByteOffset = FirstFieldOffset;
1049*67e74705SXin Li }
1050*67e74705SXin Li
1051*67e74705SXin Li CharUnits MemcpySize = getMemcpySize(FirstByteOffset);
1052*67e74705SXin Li QualType RecordTy = CGF.getContext().getTypeDeclType(ClassDecl);
1053*67e74705SXin Li Address ThisPtr = CGF.LoadCXXThisAddress();
1054*67e74705SXin Li LValue DestLV = CGF.MakeAddrLValue(ThisPtr, RecordTy);
1055*67e74705SXin Li LValue Dest = CGF.EmitLValueForFieldInitialization(DestLV, FirstField);
1056*67e74705SXin Li llvm::Value *SrcPtr = CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(SrcRec));
1057*67e74705SXin Li LValue SrcLV = CGF.MakeNaturalAlignAddrLValue(SrcPtr, RecordTy);
1058*67e74705SXin Li LValue Src = CGF.EmitLValueForFieldInitialization(SrcLV, FirstField);
1059*67e74705SXin Li
1060*67e74705SXin Li emitMemcpyIR(Dest.isBitField() ? Dest.getBitFieldAddress() : Dest.getAddress(),
1061*67e74705SXin Li Src.isBitField() ? Src.getBitFieldAddress() : Src.getAddress(),
1062*67e74705SXin Li MemcpySize);
1063*67e74705SXin Li reset();
1064*67e74705SXin Li }
1065*67e74705SXin Li
reset()1066*67e74705SXin Li void reset() {
1067*67e74705SXin Li FirstField = nullptr;
1068*67e74705SXin Li }
1069*67e74705SXin Li
1070*67e74705SXin Li protected:
1071*67e74705SXin Li CodeGenFunction &CGF;
1072*67e74705SXin Li const CXXRecordDecl *ClassDecl;
1073*67e74705SXin Li
1074*67e74705SXin Li private:
emitMemcpyIR(Address DestPtr,Address SrcPtr,CharUnits Size)1075*67e74705SXin Li void emitMemcpyIR(Address DestPtr, Address SrcPtr, CharUnits Size) {
1076*67e74705SXin Li llvm::PointerType *DPT = DestPtr.getType();
1077*67e74705SXin Li llvm::Type *DBP =
1078*67e74705SXin Li llvm::Type::getInt8PtrTy(CGF.getLLVMContext(), DPT->getAddressSpace());
1079*67e74705SXin Li DestPtr = CGF.Builder.CreateBitCast(DestPtr, DBP);
1080*67e74705SXin Li
1081*67e74705SXin Li llvm::PointerType *SPT = SrcPtr.getType();
1082*67e74705SXin Li llvm::Type *SBP =
1083*67e74705SXin Li llvm::Type::getInt8PtrTy(CGF.getLLVMContext(), SPT->getAddressSpace());
1084*67e74705SXin Li SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, SBP);
1085*67e74705SXin Li
1086*67e74705SXin Li CGF.Builder.CreateMemCpy(DestPtr, SrcPtr, Size.getQuantity());
1087*67e74705SXin Li }
1088*67e74705SXin Li
addInitialField(FieldDecl * F)1089*67e74705SXin Li void addInitialField(FieldDecl *F) {
1090*67e74705SXin Li FirstField = F;
1091*67e74705SXin Li LastField = F;
1092*67e74705SXin Li FirstFieldOffset = RecLayout.getFieldOffset(F->getFieldIndex());
1093*67e74705SXin Li LastFieldOffset = FirstFieldOffset;
1094*67e74705SXin Li LastAddedFieldIndex = F->getFieldIndex();
1095*67e74705SXin Li }
1096*67e74705SXin Li
addNextField(FieldDecl * F)1097*67e74705SXin Li void addNextField(FieldDecl *F) {
1098*67e74705SXin Li // For the most part, the following invariant will hold:
1099*67e74705SXin Li // F->getFieldIndex() == LastAddedFieldIndex + 1
1100*67e74705SXin Li // The one exception is that Sema won't add a copy-initializer for an
1101*67e74705SXin Li // unnamed bitfield, which will show up here as a gap in the sequence.
1102*67e74705SXin Li assert(F->getFieldIndex() >= LastAddedFieldIndex + 1 &&
1103*67e74705SXin Li "Cannot aggregate fields out of order.");
1104*67e74705SXin Li LastAddedFieldIndex = F->getFieldIndex();
1105*67e74705SXin Li
1106*67e74705SXin Li // The 'first' and 'last' fields are chosen by offset, rather than field
1107*67e74705SXin Li // index. This allows the code to support bitfields, as well as regular
1108*67e74705SXin Li // fields.
1109*67e74705SXin Li uint64_t FOffset = RecLayout.getFieldOffset(F->getFieldIndex());
1110*67e74705SXin Li if (FOffset < FirstFieldOffset) {
1111*67e74705SXin Li FirstField = F;
1112*67e74705SXin Li FirstFieldOffset = FOffset;
1113*67e74705SXin Li } else if (FOffset > LastFieldOffset) {
1114*67e74705SXin Li LastField = F;
1115*67e74705SXin Li LastFieldOffset = FOffset;
1116*67e74705SXin Li }
1117*67e74705SXin Li }
1118*67e74705SXin Li
1119*67e74705SXin Li const VarDecl *SrcRec;
1120*67e74705SXin Li const ASTRecordLayout &RecLayout;
1121*67e74705SXin Li FieldDecl *FirstField;
1122*67e74705SXin Li FieldDecl *LastField;
1123*67e74705SXin Li uint64_t FirstFieldOffset, LastFieldOffset;
1124*67e74705SXin Li unsigned LastAddedFieldIndex;
1125*67e74705SXin Li };
1126*67e74705SXin Li
1127*67e74705SXin Li class ConstructorMemcpyizer : public FieldMemcpyizer {
1128*67e74705SXin Li private:
1129*67e74705SXin Li /// Get source argument for copy constructor. Returns null if not a copy
1130*67e74705SXin Li /// constructor.
getTrivialCopySource(CodeGenFunction & CGF,const CXXConstructorDecl * CD,FunctionArgList & Args)1131*67e74705SXin Li static const VarDecl *getTrivialCopySource(CodeGenFunction &CGF,
1132*67e74705SXin Li const CXXConstructorDecl *CD,
1133*67e74705SXin Li FunctionArgList &Args) {
1134*67e74705SXin Li if (CD->isCopyOrMoveConstructor() && CD->isDefaulted())
1135*67e74705SXin Li return Args[CGF.CGM.getCXXABI().getSrcArgforCopyCtor(CD, Args)];
1136*67e74705SXin Li return nullptr;
1137*67e74705SXin Li }
1138*67e74705SXin Li
1139*67e74705SXin Li // Returns true if a CXXCtorInitializer represents a member initialization
1140*67e74705SXin Li // that can be rolled into a memcpy.
isMemberInitMemcpyable(CXXCtorInitializer * MemberInit) const1141*67e74705SXin Li bool isMemberInitMemcpyable(CXXCtorInitializer *MemberInit) const {
1142*67e74705SXin Li if (!MemcpyableCtor)
1143*67e74705SXin Li return false;
1144*67e74705SXin Li FieldDecl *Field = MemberInit->getMember();
1145*67e74705SXin Li assert(Field && "No field for member init.");
1146*67e74705SXin Li QualType FieldType = Field->getType();
1147*67e74705SXin Li CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(MemberInit->getInit());
1148*67e74705SXin Li
1149*67e74705SXin Li // Bail out on non-memcpyable, not-trivially-copyable members.
1150*67e74705SXin Li if (!(CE && isMemcpyEquivalentSpecialMember(CE->getConstructor())) &&
1151*67e74705SXin Li !(FieldType.isTriviallyCopyableType(CGF.getContext()) ||
1152*67e74705SXin Li FieldType->isReferenceType()))
1153*67e74705SXin Li return false;
1154*67e74705SXin Li
1155*67e74705SXin Li // Bail out on volatile fields.
1156*67e74705SXin Li if (!isMemcpyableField(Field))
1157*67e74705SXin Li return false;
1158*67e74705SXin Li
1159*67e74705SXin Li // Otherwise we're good.
1160*67e74705SXin Li return true;
1161*67e74705SXin Li }
1162*67e74705SXin Li
1163*67e74705SXin Li public:
ConstructorMemcpyizer(CodeGenFunction & CGF,const CXXConstructorDecl * CD,FunctionArgList & Args)1164*67e74705SXin Li ConstructorMemcpyizer(CodeGenFunction &CGF, const CXXConstructorDecl *CD,
1165*67e74705SXin Li FunctionArgList &Args)
1166*67e74705SXin Li : FieldMemcpyizer(CGF, CD->getParent(), getTrivialCopySource(CGF, CD, Args)),
1167*67e74705SXin Li ConstructorDecl(CD),
1168*67e74705SXin Li MemcpyableCtor(CD->isDefaulted() &&
1169*67e74705SXin Li CD->isCopyOrMoveConstructor() &&
1170*67e74705SXin Li CGF.getLangOpts().getGC() == LangOptions::NonGC),
1171*67e74705SXin Li Args(Args) { }
1172*67e74705SXin Li
addMemberInitializer(CXXCtorInitializer * MemberInit)1173*67e74705SXin Li void addMemberInitializer(CXXCtorInitializer *MemberInit) {
1174*67e74705SXin Li if (isMemberInitMemcpyable(MemberInit)) {
1175*67e74705SXin Li AggregatedInits.push_back(MemberInit);
1176*67e74705SXin Li addMemcpyableField(MemberInit->getMember());
1177*67e74705SXin Li } else {
1178*67e74705SXin Li emitAggregatedInits();
1179*67e74705SXin Li EmitMemberInitializer(CGF, ConstructorDecl->getParent(), MemberInit,
1180*67e74705SXin Li ConstructorDecl, Args);
1181*67e74705SXin Li }
1182*67e74705SXin Li }
1183*67e74705SXin Li
emitAggregatedInits()1184*67e74705SXin Li void emitAggregatedInits() {
1185*67e74705SXin Li if (AggregatedInits.size() <= 1) {
1186*67e74705SXin Li // This memcpy is too small to be worthwhile. Fall back on default
1187*67e74705SXin Li // codegen.
1188*67e74705SXin Li if (!AggregatedInits.empty()) {
1189*67e74705SXin Li CopyingValueRepresentation CVR(CGF);
1190*67e74705SXin Li EmitMemberInitializer(CGF, ConstructorDecl->getParent(),
1191*67e74705SXin Li AggregatedInits[0], ConstructorDecl, Args);
1192*67e74705SXin Li AggregatedInits.clear();
1193*67e74705SXin Li }
1194*67e74705SXin Li reset();
1195*67e74705SXin Li return;
1196*67e74705SXin Li }
1197*67e74705SXin Li
1198*67e74705SXin Li pushEHDestructors();
1199*67e74705SXin Li emitMemcpy();
1200*67e74705SXin Li AggregatedInits.clear();
1201*67e74705SXin Li }
1202*67e74705SXin Li
pushEHDestructors()1203*67e74705SXin Li void pushEHDestructors() {
1204*67e74705SXin Li Address ThisPtr = CGF.LoadCXXThisAddress();
1205*67e74705SXin Li QualType RecordTy = CGF.getContext().getTypeDeclType(ClassDecl);
1206*67e74705SXin Li LValue LHS = CGF.MakeAddrLValue(ThisPtr, RecordTy);
1207*67e74705SXin Li
1208*67e74705SXin Li for (unsigned i = 0; i < AggregatedInits.size(); ++i) {
1209*67e74705SXin Li CXXCtorInitializer *MemberInit = AggregatedInits[i];
1210*67e74705SXin Li QualType FieldType = MemberInit->getAnyMember()->getType();
1211*67e74705SXin Li QualType::DestructionKind dtorKind = FieldType.isDestructedType();
1212*67e74705SXin Li if (!CGF.needsEHCleanup(dtorKind))
1213*67e74705SXin Li continue;
1214*67e74705SXin Li LValue FieldLHS = LHS;
1215*67e74705SXin Li EmitLValueForAnyFieldInitialization(CGF, MemberInit, FieldLHS);
1216*67e74705SXin Li CGF.pushEHDestroy(dtorKind, FieldLHS.getAddress(), FieldType);
1217*67e74705SXin Li }
1218*67e74705SXin Li }
1219*67e74705SXin Li
finish()1220*67e74705SXin Li void finish() {
1221*67e74705SXin Li emitAggregatedInits();
1222*67e74705SXin Li }
1223*67e74705SXin Li
1224*67e74705SXin Li private:
1225*67e74705SXin Li const CXXConstructorDecl *ConstructorDecl;
1226*67e74705SXin Li bool MemcpyableCtor;
1227*67e74705SXin Li FunctionArgList &Args;
1228*67e74705SXin Li SmallVector<CXXCtorInitializer*, 16> AggregatedInits;
1229*67e74705SXin Li };
1230*67e74705SXin Li
1231*67e74705SXin Li class AssignmentMemcpyizer : public FieldMemcpyizer {
1232*67e74705SXin Li private:
1233*67e74705SXin Li // Returns the memcpyable field copied by the given statement, if one
1234*67e74705SXin Li // exists. Otherwise returns null.
getMemcpyableField(Stmt * S)1235*67e74705SXin Li FieldDecl *getMemcpyableField(Stmt *S) {
1236*67e74705SXin Li if (!AssignmentsMemcpyable)
1237*67e74705SXin Li return nullptr;
1238*67e74705SXin Li if (BinaryOperator *BO = dyn_cast<BinaryOperator>(S)) {
1239*67e74705SXin Li // Recognise trivial assignments.
1240*67e74705SXin Li if (BO->getOpcode() != BO_Assign)
1241*67e74705SXin Li return nullptr;
1242*67e74705SXin Li MemberExpr *ME = dyn_cast<MemberExpr>(BO->getLHS());
1243*67e74705SXin Li if (!ME)
1244*67e74705SXin Li return nullptr;
1245*67e74705SXin Li FieldDecl *Field = dyn_cast<FieldDecl>(ME->getMemberDecl());
1246*67e74705SXin Li if (!Field || !isMemcpyableField(Field))
1247*67e74705SXin Li return nullptr;
1248*67e74705SXin Li Stmt *RHS = BO->getRHS();
1249*67e74705SXin Li if (ImplicitCastExpr *EC = dyn_cast<ImplicitCastExpr>(RHS))
1250*67e74705SXin Li RHS = EC->getSubExpr();
1251*67e74705SXin Li if (!RHS)
1252*67e74705SXin Li return nullptr;
1253*67e74705SXin Li MemberExpr *ME2 = dyn_cast<MemberExpr>(RHS);
1254*67e74705SXin Li if (dyn_cast<FieldDecl>(ME2->getMemberDecl()) != Field)
1255*67e74705SXin Li return nullptr;
1256*67e74705SXin Li return Field;
1257*67e74705SXin Li } else if (CXXMemberCallExpr *MCE = dyn_cast<CXXMemberCallExpr>(S)) {
1258*67e74705SXin Li CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MCE->getCalleeDecl());
1259*67e74705SXin Li if (!(MD && isMemcpyEquivalentSpecialMember(MD)))
1260*67e74705SXin Li return nullptr;
1261*67e74705SXin Li MemberExpr *IOA = dyn_cast<MemberExpr>(MCE->getImplicitObjectArgument());
1262*67e74705SXin Li if (!IOA)
1263*67e74705SXin Li return nullptr;
1264*67e74705SXin Li FieldDecl *Field = dyn_cast<FieldDecl>(IOA->getMemberDecl());
1265*67e74705SXin Li if (!Field || !isMemcpyableField(Field))
1266*67e74705SXin Li return nullptr;
1267*67e74705SXin Li MemberExpr *Arg0 = dyn_cast<MemberExpr>(MCE->getArg(0));
1268*67e74705SXin Li if (!Arg0 || Field != dyn_cast<FieldDecl>(Arg0->getMemberDecl()))
1269*67e74705SXin Li return nullptr;
1270*67e74705SXin Li return Field;
1271*67e74705SXin Li } else if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
1272*67e74705SXin Li FunctionDecl *FD = dyn_cast<FunctionDecl>(CE->getCalleeDecl());
1273*67e74705SXin Li if (!FD || FD->getBuiltinID() != Builtin::BI__builtin_memcpy)
1274*67e74705SXin Li return nullptr;
1275*67e74705SXin Li Expr *DstPtr = CE->getArg(0);
1276*67e74705SXin Li if (ImplicitCastExpr *DC = dyn_cast<ImplicitCastExpr>(DstPtr))
1277*67e74705SXin Li DstPtr = DC->getSubExpr();
1278*67e74705SXin Li UnaryOperator *DUO = dyn_cast<UnaryOperator>(DstPtr);
1279*67e74705SXin Li if (!DUO || DUO->getOpcode() != UO_AddrOf)
1280*67e74705SXin Li return nullptr;
1281*67e74705SXin Li MemberExpr *ME = dyn_cast<MemberExpr>(DUO->getSubExpr());
1282*67e74705SXin Li if (!ME)
1283*67e74705SXin Li return nullptr;
1284*67e74705SXin Li FieldDecl *Field = dyn_cast<FieldDecl>(ME->getMemberDecl());
1285*67e74705SXin Li if (!Field || !isMemcpyableField(Field))
1286*67e74705SXin Li return nullptr;
1287*67e74705SXin Li Expr *SrcPtr = CE->getArg(1);
1288*67e74705SXin Li if (ImplicitCastExpr *SC = dyn_cast<ImplicitCastExpr>(SrcPtr))
1289*67e74705SXin Li SrcPtr = SC->getSubExpr();
1290*67e74705SXin Li UnaryOperator *SUO = dyn_cast<UnaryOperator>(SrcPtr);
1291*67e74705SXin Li if (!SUO || SUO->getOpcode() != UO_AddrOf)
1292*67e74705SXin Li return nullptr;
1293*67e74705SXin Li MemberExpr *ME2 = dyn_cast<MemberExpr>(SUO->getSubExpr());
1294*67e74705SXin Li if (!ME2 || Field != dyn_cast<FieldDecl>(ME2->getMemberDecl()))
1295*67e74705SXin Li return nullptr;
1296*67e74705SXin Li return Field;
1297*67e74705SXin Li }
1298*67e74705SXin Li
1299*67e74705SXin Li return nullptr;
1300*67e74705SXin Li }
1301*67e74705SXin Li
1302*67e74705SXin Li bool AssignmentsMemcpyable;
1303*67e74705SXin Li SmallVector<Stmt*, 16> AggregatedStmts;
1304*67e74705SXin Li
1305*67e74705SXin Li public:
AssignmentMemcpyizer(CodeGenFunction & CGF,const CXXMethodDecl * AD,FunctionArgList & Args)1306*67e74705SXin Li AssignmentMemcpyizer(CodeGenFunction &CGF, const CXXMethodDecl *AD,
1307*67e74705SXin Li FunctionArgList &Args)
1308*67e74705SXin Li : FieldMemcpyizer(CGF, AD->getParent(), Args[Args.size() - 1]),
1309*67e74705SXin Li AssignmentsMemcpyable(CGF.getLangOpts().getGC() == LangOptions::NonGC) {
1310*67e74705SXin Li assert(Args.size() == 2);
1311*67e74705SXin Li }
1312*67e74705SXin Li
emitAssignment(Stmt * S)1313*67e74705SXin Li void emitAssignment(Stmt *S) {
1314*67e74705SXin Li FieldDecl *F = getMemcpyableField(S);
1315*67e74705SXin Li if (F) {
1316*67e74705SXin Li addMemcpyableField(F);
1317*67e74705SXin Li AggregatedStmts.push_back(S);
1318*67e74705SXin Li } else {
1319*67e74705SXin Li emitAggregatedStmts();
1320*67e74705SXin Li CGF.EmitStmt(S);
1321*67e74705SXin Li }
1322*67e74705SXin Li }
1323*67e74705SXin Li
emitAggregatedStmts()1324*67e74705SXin Li void emitAggregatedStmts() {
1325*67e74705SXin Li if (AggregatedStmts.size() <= 1) {
1326*67e74705SXin Li if (!AggregatedStmts.empty()) {
1327*67e74705SXin Li CopyingValueRepresentation CVR(CGF);
1328*67e74705SXin Li CGF.EmitStmt(AggregatedStmts[0]);
1329*67e74705SXin Li }
1330*67e74705SXin Li reset();
1331*67e74705SXin Li }
1332*67e74705SXin Li
1333*67e74705SXin Li emitMemcpy();
1334*67e74705SXin Li AggregatedStmts.clear();
1335*67e74705SXin Li }
1336*67e74705SXin Li
finish()1337*67e74705SXin Li void finish() {
1338*67e74705SXin Li emitAggregatedStmts();
1339*67e74705SXin Li }
1340*67e74705SXin Li };
1341*67e74705SXin Li } // end anonymous namespace
1342*67e74705SXin Li
isInitializerOfDynamicClass(const CXXCtorInitializer * BaseInit)1343*67e74705SXin Li static bool isInitializerOfDynamicClass(const CXXCtorInitializer *BaseInit) {
1344*67e74705SXin Li const Type *BaseType = BaseInit->getBaseClass();
1345*67e74705SXin Li const auto *BaseClassDecl =
1346*67e74705SXin Li cast<CXXRecordDecl>(BaseType->getAs<RecordType>()->getDecl());
1347*67e74705SXin Li return BaseClassDecl->isDynamicClass();
1348*67e74705SXin Li }
1349*67e74705SXin Li
1350*67e74705SXin Li /// EmitCtorPrologue - This routine generates necessary code to initialize
1351*67e74705SXin Li /// base classes and non-static data members belonging to this constructor.
EmitCtorPrologue(const CXXConstructorDecl * CD,CXXCtorType CtorType,FunctionArgList & Args)1352*67e74705SXin Li void CodeGenFunction::EmitCtorPrologue(const CXXConstructorDecl *CD,
1353*67e74705SXin Li CXXCtorType CtorType,
1354*67e74705SXin Li FunctionArgList &Args) {
1355*67e74705SXin Li if (CD->isDelegatingConstructor())
1356*67e74705SXin Li return EmitDelegatingCXXConstructorCall(CD, Args);
1357*67e74705SXin Li
1358*67e74705SXin Li const CXXRecordDecl *ClassDecl = CD->getParent();
1359*67e74705SXin Li
1360*67e74705SXin Li CXXConstructorDecl::init_const_iterator B = CD->init_begin(),
1361*67e74705SXin Li E = CD->init_end();
1362*67e74705SXin Li
1363*67e74705SXin Li llvm::BasicBlock *BaseCtorContinueBB = nullptr;
1364*67e74705SXin Li if (ClassDecl->getNumVBases() &&
1365*67e74705SXin Li !CGM.getTarget().getCXXABI().hasConstructorVariants()) {
1366*67e74705SXin Li // The ABIs that don't have constructor variants need to put a branch
1367*67e74705SXin Li // before the virtual base initialization code.
1368*67e74705SXin Li BaseCtorContinueBB =
1369*67e74705SXin Li CGM.getCXXABI().EmitCtorCompleteObjectHandler(*this, ClassDecl);
1370*67e74705SXin Li assert(BaseCtorContinueBB);
1371*67e74705SXin Li }
1372*67e74705SXin Li
1373*67e74705SXin Li llvm::Value *const OldThis = CXXThisValue;
1374*67e74705SXin Li // Virtual base initializers first.
1375*67e74705SXin Li for (; B != E && (*B)->isBaseInitializer() && (*B)->isBaseVirtual(); B++) {
1376*67e74705SXin Li if (CGM.getCodeGenOpts().StrictVTablePointers &&
1377*67e74705SXin Li CGM.getCodeGenOpts().OptimizationLevel > 0 &&
1378*67e74705SXin Li isInitializerOfDynamicClass(*B))
1379*67e74705SXin Li CXXThisValue = Builder.CreateInvariantGroupBarrier(LoadCXXThis());
1380*67e74705SXin Li EmitBaseInitializer(*this, ClassDecl, *B, CtorType);
1381*67e74705SXin Li }
1382*67e74705SXin Li
1383*67e74705SXin Li if (BaseCtorContinueBB) {
1384*67e74705SXin Li // Complete object handler should continue to the remaining initializers.
1385*67e74705SXin Li Builder.CreateBr(BaseCtorContinueBB);
1386*67e74705SXin Li EmitBlock(BaseCtorContinueBB);
1387*67e74705SXin Li }
1388*67e74705SXin Li
1389*67e74705SXin Li // Then, non-virtual base initializers.
1390*67e74705SXin Li for (; B != E && (*B)->isBaseInitializer(); B++) {
1391*67e74705SXin Li assert(!(*B)->isBaseVirtual());
1392*67e74705SXin Li
1393*67e74705SXin Li if (CGM.getCodeGenOpts().StrictVTablePointers &&
1394*67e74705SXin Li CGM.getCodeGenOpts().OptimizationLevel > 0 &&
1395*67e74705SXin Li isInitializerOfDynamicClass(*B))
1396*67e74705SXin Li CXXThisValue = Builder.CreateInvariantGroupBarrier(LoadCXXThis());
1397*67e74705SXin Li EmitBaseInitializer(*this, ClassDecl, *B, CtorType);
1398*67e74705SXin Li }
1399*67e74705SXin Li
1400*67e74705SXin Li CXXThisValue = OldThis;
1401*67e74705SXin Li
1402*67e74705SXin Li InitializeVTablePointers(ClassDecl);
1403*67e74705SXin Li
1404*67e74705SXin Li // And finally, initialize class members.
1405*67e74705SXin Li FieldConstructionScope FCS(*this, LoadCXXThisAddress());
1406*67e74705SXin Li ConstructorMemcpyizer CM(*this, CD, Args);
1407*67e74705SXin Li for (; B != E; B++) {
1408*67e74705SXin Li CXXCtorInitializer *Member = (*B);
1409*67e74705SXin Li assert(!Member->isBaseInitializer());
1410*67e74705SXin Li assert(Member->isAnyMemberInitializer() &&
1411*67e74705SXin Li "Delegating initializer on non-delegating constructor");
1412*67e74705SXin Li CM.addMemberInitializer(Member);
1413*67e74705SXin Li }
1414*67e74705SXin Li CM.finish();
1415*67e74705SXin Li }
1416*67e74705SXin Li
1417*67e74705SXin Li static bool
1418*67e74705SXin Li FieldHasTrivialDestructorBody(ASTContext &Context, const FieldDecl *Field);
1419*67e74705SXin Li
1420*67e74705SXin Li static bool
HasTrivialDestructorBody(ASTContext & Context,const CXXRecordDecl * BaseClassDecl,const CXXRecordDecl * MostDerivedClassDecl)1421*67e74705SXin Li HasTrivialDestructorBody(ASTContext &Context,
1422*67e74705SXin Li const CXXRecordDecl *BaseClassDecl,
1423*67e74705SXin Li const CXXRecordDecl *MostDerivedClassDecl)
1424*67e74705SXin Li {
1425*67e74705SXin Li // If the destructor is trivial we don't have to check anything else.
1426*67e74705SXin Li if (BaseClassDecl->hasTrivialDestructor())
1427*67e74705SXin Li return true;
1428*67e74705SXin Li
1429*67e74705SXin Li if (!BaseClassDecl->getDestructor()->hasTrivialBody())
1430*67e74705SXin Li return false;
1431*67e74705SXin Li
1432*67e74705SXin Li // Check fields.
1433*67e74705SXin Li for (const auto *Field : BaseClassDecl->fields())
1434*67e74705SXin Li if (!FieldHasTrivialDestructorBody(Context, Field))
1435*67e74705SXin Li return false;
1436*67e74705SXin Li
1437*67e74705SXin Li // Check non-virtual bases.
1438*67e74705SXin Li for (const auto &I : BaseClassDecl->bases()) {
1439*67e74705SXin Li if (I.isVirtual())
1440*67e74705SXin Li continue;
1441*67e74705SXin Li
1442*67e74705SXin Li const CXXRecordDecl *NonVirtualBase =
1443*67e74705SXin Li cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
1444*67e74705SXin Li if (!HasTrivialDestructorBody(Context, NonVirtualBase,
1445*67e74705SXin Li MostDerivedClassDecl))
1446*67e74705SXin Li return false;
1447*67e74705SXin Li }
1448*67e74705SXin Li
1449*67e74705SXin Li if (BaseClassDecl == MostDerivedClassDecl) {
1450*67e74705SXin Li // Check virtual bases.
1451*67e74705SXin Li for (const auto &I : BaseClassDecl->vbases()) {
1452*67e74705SXin Li const CXXRecordDecl *VirtualBase =
1453*67e74705SXin Li cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
1454*67e74705SXin Li if (!HasTrivialDestructorBody(Context, VirtualBase,
1455*67e74705SXin Li MostDerivedClassDecl))
1456*67e74705SXin Li return false;
1457*67e74705SXin Li }
1458*67e74705SXin Li }
1459*67e74705SXin Li
1460*67e74705SXin Li return true;
1461*67e74705SXin Li }
1462*67e74705SXin Li
1463*67e74705SXin Li static bool
FieldHasTrivialDestructorBody(ASTContext & Context,const FieldDecl * Field)1464*67e74705SXin Li FieldHasTrivialDestructorBody(ASTContext &Context,
1465*67e74705SXin Li const FieldDecl *Field)
1466*67e74705SXin Li {
1467*67e74705SXin Li QualType FieldBaseElementType = Context.getBaseElementType(Field->getType());
1468*67e74705SXin Li
1469*67e74705SXin Li const RecordType *RT = FieldBaseElementType->getAs<RecordType>();
1470*67e74705SXin Li if (!RT)
1471*67e74705SXin Li return true;
1472*67e74705SXin Li
1473*67e74705SXin Li CXXRecordDecl *FieldClassDecl = cast<CXXRecordDecl>(RT->getDecl());
1474*67e74705SXin Li
1475*67e74705SXin Li // The destructor for an implicit anonymous union member is never invoked.
1476*67e74705SXin Li if (FieldClassDecl->isUnion() && FieldClassDecl->isAnonymousStructOrUnion())
1477*67e74705SXin Li return false;
1478*67e74705SXin Li
1479*67e74705SXin Li return HasTrivialDestructorBody(Context, FieldClassDecl, FieldClassDecl);
1480*67e74705SXin Li }
1481*67e74705SXin Li
1482*67e74705SXin Li /// CanSkipVTablePointerInitialization - Check whether we need to initialize
1483*67e74705SXin Li /// any vtable pointers before calling this destructor.
CanSkipVTablePointerInitialization(CodeGenFunction & CGF,const CXXDestructorDecl * Dtor)1484*67e74705SXin Li static bool CanSkipVTablePointerInitialization(CodeGenFunction &CGF,
1485*67e74705SXin Li const CXXDestructorDecl *Dtor) {
1486*67e74705SXin Li const CXXRecordDecl *ClassDecl = Dtor->getParent();
1487*67e74705SXin Li if (!ClassDecl->isDynamicClass())
1488*67e74705SXin Li return true;
1489*67e74705SXin Li
1490*67e74705SXin Li if (!Dtor->hasTrivialBody())
1491*67e74705SXin Li return false;
1492*67e74705SXin Li
1493*67e74705SXin Li // Check the fields.
1494*67e74705SXin Li for (const auto *Field : ClassDecl->fields())
1495*67e74705SXin Li if (!FieldHasTrivialDestructorBody(CGF.getContext(), Field))
1496*67e74705SXin Li return false;
1497*67e74705SXin Li
1498*67e74705SXin Li return true;
1499*67e74705SXin Li }
1500*67e74705SXin Li
1501*67e74705SXin Li /// EmitDestructorBody - Emits the body of the current destructor.
EmitDestructorBody(FunctionArgList & Args)1502*67e74705SXin Li void CodeGenFunction::EmitDestructorBody(FunctionArgList &Args) {
1503*67e74705SXin Li const CXXDestructorDecl *Dtor = cast<CXXDestructorDecl>(CurGD.getDecl());
1504*67e74705SXin Li CXXDtorType DtorType = CurGD.getDtorType();
1505*67e74705SXin Li
1506*67e74705SXin Li Stmt *Body = Dtor->getBody();
1507*67e74705SXin Li if (Body)
1508*67e74705SXin Li incrementProfileCounter(Body);
1509*67e74705SXin Li
1510*67e74705SXin Li // The call to operator delete in a deleting destructor happens
1511*67e74705SXin Li // outside of the function-try-block, which means it's always
1512*67e74705SXin Li // possible to delegate the destructor body to the complete
1513*67e74705SXin Li // destructor. Do so.
1514*67e74705SXin Li if (DtorType == Dtor_Deleting) {
1515*67e74705SXin Li EnterDtorCleanups(Dtor, Dtor_Deleting);
1516*67e74705SXin Li EmitCXXDestructorCall(Dtor, Dtor_Complete, /*ForVirtualBase=*/false,
1517*67e74705SXin Li /*Delegating=*/false, LoadCXXThisAddress());
1518*67e74705SXin Li PopCleanupBlock();
1519*67e74705SXin Li return;
1520*67e74705SXin Li }
1521*67e74705SXin Li
1522*67e74705SXin Li // If the body is a function-try-block, enter the try before
1523*67e74705SXin Li // anything else.
1524*67e74705SXin Li bool isTryBody = (Body && isa<CXXTryStmt>(Body));
1525*67e74705SXin Li if (isTryBody)
1526*67e74705SXin Li EnterCXXTryStmt(*cast<CXXTryStmt>(Body), true);
1527*67e74705SXin Li EmitAsanPrologueOrEpilogue(false);
1528*67e74705SXin Li
1529*67e74705SXin Li // Enter the epilogue cleanups.
1530*67e74705SXin Li RunCleanupsScope DtorEpilogue(*this);
1531*67e74705SXin Li
1532*67e74705SXin Li // If this is the complete variant, just invoke the base variant;
1533*67e74705SXin Li // the epilogue will destruct the virtual bases. But we can't do
1534*67e74705SXin Li // this optimization if the body is a function-try-block, because
1535*67e74705SXin Li // we'd introduce *two* handler blocks. In the Microsoft ABI, we
1536*67e74705SXin Li // always delegate because we might not have a definition in this TU.
1537*67e74705SXin Li switch (DtorType) {
1538*67e74705SXin Li case Dtor_Comdat:
1539*67e74705SXin Li llvm_unreachable("not expecting a COMDAT");
1540*67e74705SXin Li
1541*67e74705SXin Li case Dtor_Deleting: llvm_unreachable("already handled deleting case");
1542*67e74705SXin Li
1543*67e74705SXin Li case Dtor_Complete:
1544*67e74705SXin Li assert((Body || getTarget().getCXXABI().isMicrosoft()) &&
1545*67e74705SXin Li "can't emit a dtor without a body for non-Microsoft ABIs");
1546*67e74705SXin Li
1547*67e74705SXin Li // Enter the cleanup scopes for virtual bases.
1548*67e74705SXin Li EnterDtorCleanups(Dtor, Dtor_Complete);
1549*67e74705SXin Li
1550*67e74705SXin Li if (!isTryBody) {
1551*67e74705SXin Li EmitCXXDestructorCall(Dtor, Dtor_Base, /*ForVirtualBase=*/false,
1552*67e74705SXin Li /*Delegating=*/false, LoadCXXThisAddress());
1553*67e74705SXin Li break;
1554*67e74705SXin Li }
1555*67e74705SXin Li // Fallthrough: act like we're in the base variant.
1556*67e74705SXin Li
1557*67e74705SXin Li case Dtor_Base:
1558*67e74705SXin Li assert(Body);
1559*67e74705SXin Li
1560*67e74705SXin Li // Enter the cleanup scopes for fields and non-virtual bases.
1561*67e74705SXin Li EnterDtorCleanups(Dtor, Dtor_Base);
1562*67e74705SXin Li
1563*67e74705SXin Li // Initialize the vtable pointers before entering the body.
1564*67e74705SXin Li if (!CanSkipVTablePointerInitialization(*this, Dtor)) {
1565*67e74705SXin Li // Insert the llvm.invariant.group.barrier intrinsic before initializing
1566*67e74705SXin Li // the vptrs to cancel any previous assumptions we might have made.
1567*67e74705SXin Li if (CGM.getCodeGenOpts().StrictVTablePointers &&
1568*67e74705SXin Li CGM.getCodeGenOpts().OptimizationLevel > 0)
1569*67e74705SXin Li CXXThisValue = Builder.CreateInvariantGroupBarrier(LoadCXXThis());
1570*67e74705SXin Li InitializeVTablePointers(Dtor->getParent());
1571*67e74705SXin Li }
1572*67e74705SXin Li
1573*67e74705SXin Li if (isTryBody)
1574*67e74705SXin Li EmitStmt(cast<CXXTryStmt>(Body)->getTryBlock());
1575*67e74705SXin Li else if (Body)
1576*67e74705SXin Li EmitStmt(Body);
1577*67e74705SXin Li else {
1578*67e74705SXin Li assert(Dtor->isImplicit() && "bodyless dtor not implicit");
1579*67e74705SXin Li // nothing to do besides what's in the epilogue
1580*67e74705SXin Li }
1581*67e74705SXin Li // -fapple-kext must inline any call to this dtor into
1582*67e74705SXin Li // the caller's body.
1583*67e74705SXin Li if (getLangOpts().AppleKext)
1584*67e74705SXin Li CurFn->addFnAttr(llvm::Attribute::AlwaysInline);
1585*67e74705SXin Li
1586*67e74705SXin Li break;
1587*67e74705SXin Li }
1588*67e74705SXin Li
1589*67e74705SXin Li // Jump out through the epilogue cleanups.
1590*67e74705SXin Li DtorEpilogue.ForceCleanup();
1591*67e74705SXin Li
1592*67e74705SXin Li // Exit the try if applicable.
1593*67e74705SXin Li if (isTryBody)
1594*67e74705SXin Li ExitCXXTryStmt(*cast<CXXTryStmt>(Body), true);
1595*67e74705SXin Li }
1596*67e74705SXin Li
emitImplicitAssignmentOperatorBody(FunctionArgList & Args)1597*67e74705SXin Li void CodeGenFunction::emitImplicitAssignmentOperatorBody(FunctionArgList &Args) {
1598*67e74705SXin Li const CXXMethodDecl *AssignOp = cast<CXXMethodDecl>(CurGD.getDecl());
1599*67e74705SXin Li const Stmt *RootS = AssignOp->getBody();
1600*67e74705SXin Li assert(isa<CompoundStmt>(RootS) &&
1601*67e74705SXin Li "Body of an implicit assignment operator should be compound stmt.");
1602*67e74705SXin Li const CompoundStmt *RootCS = cast<CompoundStmt>(RootS);
1603*67e74705SXin Li
1604*67e74705SXin Li LexicalScope Scope(*this, RootCS->getSourceRange());
1605*67e74705SXin Li
1606*67e74705SXin Li incrementProfileCounter(RootCS);
1607*67e74705SXin Li AssignmentMemcpyizer AM(*this, AssignOp, Args);
1608*67e74705SXin Li for (auto *I : RootCS->body())
1609*67e74705SXin Li AM.emitAssignment(I);
1610*67e74705SXin Li AM.finish();
1611*67e74705SXin Li }
1612*67e74705SXin Li
1613*67e74705SXin Li namespace {
1614*67e74705SXin Li /// Call the operator delete associated with the current destructor.
1615*67e74705SXin Li struct CallDtorDelete final : EHScopeStack::Cleanup {
CallDtorDelete__anon6bf721160411::CallDtorDelete1616*67e74705SXin Li CallDtorDelete() {}
1617*67e74705SXin Li
Emit__anon6bf721160411::CallDtorDelete1618*67e74705SXin Li void Emit(CodeGenFunction &CGF, Flags flags) override {
1619*67e74705SXin Li const CXXDestructorDecl *Dtor = cast<CXXDestructorDecl>(CGF.CurCodeDecl);
1620*67e74705SXin Li const CXXRecordDecl *ClassDecl = Dtor->getParent();
1621*67e74705SXin Li CGF.EmitDeleteCall(Dtor->getOperatorDelete(), CGF.LoadCXXThis(),
1622*67e74705SXin Li CGF.getContext().getTagDeclType(ClassDecl));
1623*67e74705SXin Li }
1624*67e74705SXin Li };
1625*67e74705SXin Li
1626*67e74705SXin Li struct CallDtorDeleteConditional final : EHScopeStack::Cleanup {
1627*67e74705SXin Li llvm::Value *ShouldDeleteCondition;
1628*67e74705SXin Li
1629*67e74705SXin Li public:
CallDtorDeleteConditional__anon6bf721160411::CallDtorDeleteConditional1630*67e74705SXin Li CallDtorDeleteConditional(llvm::Value *ShouldDeleteCondition)
1631*67e74705SXin Li : ShouldDeleteCondition(ShouldDeleteCondition) {
1632*67e74705SXin Li assert(ShouldDeleteCondition != nullptr);
1633*67e74705SXin Li }
1634*67e74705SXin Li
Emit__anon6bf721160411::CallDtorDeleteConditional1635*67e74705SXin Li void Emit(CodeGenFunction &CGF, Flags flags) override {
1636*67e74705SXin Li llvm::BasicBlock *callDeleteBB = CGF.createBasicBlock("dtor.call_delete");
1637*67e74705SXin Li llvm::BasicBlock *continueBB = CGF.createBasicBlock("dtor.continue");
1638*67e74705SXin Li llvm::Value *ShouldCallDelete
1639*67e74705SXin Li = CGF.Builder.CreateIsNull(ShouldDeleteCondition);
1640*67e74705SXin Li CGF.Builder.CreateCondBr(ShouldCallDelete, continueBB, callDeleteBB);
1641*67e74705SXin Li
1642*67e74705SXin Li CGF.EmitBlock(callDeleteBB);
1643*67e74705SXin Li const CXXDestructorDecl *Dtor = cast<CXXDestructorDecl>(CGF.CurCodeDecl);
1644*67e74705SXin Li const CXXRecordDecl *ClassDecl = Dtor->getParent();
1645*67e74705SXin Li CGF.EmitDeleteCall(Dtor->getOperatorDelete(), CGF.LoadCXXThis(),
1646*67e74705SXin Li CGF.getContext().getTagDeclType(ClassDecl));
1647*67e74705SXin Li CGF.Builder.CreateBr(continueBB);
1648*67e74705SXin Li
1649*67e74705SXin Li CGF.EmitBlock(continueBB);
1650*67e74705SXin Li }
1651*67e74705SXin Li };
1652*67e74705SXin Li
1653*67e74705SXin Li class DestroyField final : public EHScopeStack::Cleanup {
1654*67e74705SXin Li const FieldDecl *field;
1655*67e74705SXin Li CodeGenFunction::Destroyer *destroyer;
1656*67e74705SXin Li bool useEHCleanupForArray;
1657*67e74705SXin Li
1658*67e74705SXin Li public:
DestroyField(const FieldDecl * field,CodeGenFunction::Destroyer * destroyer,bool useEHCleanupForArray)1659*67e74705SXin Li DestroyField(const FieldDecl *field, CodeGenFunction::Destroyer *destroyer,
1660*67e74705SXin Li bool useEHCleanupForArray)
1661*67e74705SXin Li : field(field), destroyer(destroyer),
1662*67e74705SXin Li useEHCleanupForArray(useEHCleanupForArray) {}
1663*67e74705SXin Li
Emit(CodeGenFunction & CGF,Flags flags)1664*67e74705SXin Li void Emit(CodeGenFunction &CGF, Flags flags) override {
1665*67e74705SXin Li // Find the address of the field.
1666*67e74705SXin Li Address thisValue = CGF.LoadCXXThisAddress();
1667*67e74705SXin Li QualType RecordTy = CGF.getContext().getTagDeclType(field->getParent());
1668*67e74705SXin Li LValue ThisLV = CGF.MakeAddrLValue(thisValue, RecordTy);
1669*67e74705SXin Li LValue LV = CGF.EmitLValueForField(ThisLV, field);
1670*67e74705SXin Li assert(LV.isSimple());
1671*67e74705SXin Li
1672*67e74705SXin Li CGF.emitDestroy(LV.getAddress(), field->getType(), destroyer,
1673*67e74705SXin Li flags.isForNormalCleanup() && useEHCleanupForArray);
1674*67e74705SXin Li }
1675*67e74705SXin Li };
1676*67e74705SXin Li
EmitSanitizerDtorCallback(CodeGenFunction & CGF,llvm::Value * Ptr,CharUnits::QuantityType PoisonSize)1677*67e74705SXin Li static void EmitSanitizerDtorCallback(CodeGenFunction &CGF, llvm::Value *Ptr,
1678*67e74705SXin Li CharUnits::QuantityType PoisonSize) {
1679*67e74705SXin Li // Pass in void pointer and size of region as arguments to runtime
1680*67e74705SXin Li // function
1681*67e74705SXin Li llvm::Value *Args[] = {CGF.Builder.CreateBitCast(Ptr, CGF.VoidPtrTy),
1682*67e74705SXin Li llvm::ConstantInt::get(CGF.SizeTy, PoisonSize)};
1683*67e74705SXin Li
1684*67e74705SXin Li llvm::Type *ArgTypes[] = {CGF.VoidPtrTy, CGF.SizeTy};
1685*67e74705SXin Li
1686*67e74705SXin Li llvm::FunctionType *FnType =
1687*67e74705SXin Li llvm::FunctionType::get(CGF.VoidTy, ArgTypes, false);
1688*67e74705SXin Li llvm::Value *Fn =
1689*67e74705SXin Li CGF.CGM.CreateRuntimeFunction(FnType, "__sanitizer_dtor_callback");
1690*67e74705SXin Li CGF.EmitNounwindRuntimeCall(Fn, Args);
1691*67e74705SXin Li }
1692*67e74705SXin Li
1693*67e74705SXin Li class SanitizeDtorMembers final : public EHScopeStack::Cleanup {
1694*67e74705SXin Li const CXXDestructorDecl *Dtor;
1695*67e74705SXin Li
1696*67e74705SXin Li public:
SanitizeDtorMembers(const CXXDestructorDecl * Dtor)1697*67e74705SXin Li SanitizeDtorMembers(const CXXDestructorDecl *Dtor) : Dtor(Dtor) {}
1698*67e74705SXin Li
1699*67e74705SXin Li // Generate function call for handling object poisoning.
1700*67e74705SXin Li // Disables tail call elimination, to prevent the current stack frame
1701*67e74705SXin Li // from disappearing from the stack trace.
Emit(CodeGenFunction & CGF,Flags flags)1702*67e74705SXin Li void Emit(CodeGenFunction &CGF, Flags flags) override {
1703*67e74705SXin Li const ASTRecordLayout &Layout =
1704*67e74705SXin Li CGF.getContext().getASTRecordLayout(Dtor->getParent());
1705*67e74705SXin Li
1706*67e74705SXin Li // Nothing to poison.
1707*67e74705SXin Li if (Layout.getFieldCount() == 0)
1708*67e74705SXin Li return;
1709*67e74705SXin Li
1710*67e74705SXin Li // Prevent the current stack frame from disappearing from the stack trace.
1711*67e74705SXin Li CGF.CurFn->addFnAttr("disable-tail-calls", "true");
1712*67e74705SXin Li
1713*67e74705SXin Li // Construct pointer to region to begin poisoning, and calculate poison
1714*67e74705SXin Li // size, so that only members declared in this class are poisoned.
1715*67e74705SXin Li ASTContext &Context = CGF.getContext();
1716*67e74705SXin Li unsigned fieldIndex = 0;
1717*67e74705SXin Li int startIndex = -1;
1718*67e74705SXin Li // RecordDecl::field_iterator Field;
1719*67e74705SXin Li for (const FieldDecl *Field : Dtor->getParent()->fields()) {
1720*67e74705SXin Li // Poison field if it is trivial
1721*67e74705SXin Li if (FieldHasTrivialDestructorBody(Context, Field)) {
1722*67e74705SXin Li // Start sanitizing at this field
1723*67e74705SXin Li if (startIndex < 0)
1724*67e74705SXin Li startIndex = fieldIndex;
1725*67e74705SXin Li
1726*67e74705SXin Li // Currently on the last field, and it must be poisoned with the
1727*67e74705SXin Li // current block.
1728*67e74705SXin Li if (fieldIndex == Layout.getFieldCount() - 1) {
1729*67e74705SXin Li PoisonMembers(CGF, startIndex, Layout.getFieldCount());
1730*67e74705SXin Li }
1731*67e74705SXin Li } else if (startIndex >= 0) {
1732*67e74705SXin Li // No longer within a block of memory to poison, so poison the block
1733*67e74705SXin Li PoisonMembers(CGF, startIndex, fieldIndex);
1734*67e74705SXin Li // Re-set the start index
1735*67e74705SXin Li startIndex = -1;
1736*67e74705SXin Li }
1737*67e74705SXin Li fieldIndex += 1;
1738*67e74705SXin Li }
1739*67e74705SXin Li }
1740*67e74705SXin Li
1741*67e74705SXin Li private:
1742*67e74705SXin Li /// \param layoutStartOffset index of the ASTRecordLayout field to
1743*67e74705SXin Li /// start poisoning (inclusive)
1744*67e74705SXin Li /// \param layoutEndOffset index of the ASTRecordLayout field to
1745*67e74705SXin Li /// end poisoning (exclusive)
PoisonMembers(CodeGenFunction & CGF,unsigned layoutStartOffset,unsigned layoutEndOffset)1746*67e74705SXin Li void PoisonMembers(CodeGenFunction &CGF, unsigned layoutStartOffset,
1747*67e74705SXin Li unsigned layoutEndOffset) {
1748*67e74705SXin Li ASTContext &Context = CGF.getContext();
1749*67e74705SXin Li const ASTRecordLayout &Layout =
1750*67e74705SXin Li Context.getASTRecordLayout(Dtor->getParent());
1751*67e74705SXin Li
1752*67e74705SXin Li llvm::ConstantInt *OffsetSizePtr = llvm::ConstantInt::get(
1753*67e74705SXin Li CGF.SizeTy,
1754*67e74705SXin Li Context.toCharUnitsFromBits(Layout.getFieldOffset(layoutStartOffset))
1755*67e74705SXin Li .getQuantity());
1756*67e74705SXin Li
1757*67e74705SXin Li llvm::Value *OffsetPtr = CGF.Builder.CreateGEP(
1758*67e74705SXin Li CGF.Builder.CreateBitCast(CGF.LoadCXXThis(), CGF.Int8PtrTy),
1759*67e74705SXin Li OffsetSizePtr);
1760*67e74705SXin Li
1761*67e74705SXin Li CharUnits::QuantityType PoisonSize;
1762*67e74705SXin Li if (layoutEndOffset >= Layout.getFieldCount()) {
1763*67e74705SXin Li PoisonSize = Layout.getNonVirtualSize().getQuantity() -
1764*67e74705SXin Li Context.toCharUnitsFromBits(
1765*67e74705SXin Li Layout.getFieldOffset(layoutStartOffset))
1766*67e74705SXin Li .getQuantity();
1767*67e74705SXin Li } else {
1768*67e74705SXin Li PoisonSize = Context.toCharUnitsFromBits(
1769*67e74705SXin Li Layout.getFieldOffset(layoutEndOffset) -
1770*67e74705SXin Li Layout.getFieldOffset(layoutStartOffset))
1771*67e74705SXin Li .getQuantity();
1772*67e74705SXin Li }
1773*67e74705SXin Li
1774*67e74705SXin Li if (PoisonSize == 0)
1775*67e74705SXin Li return;
1776*67e74705SXin Li
1777*67e74705SXin Li EmitSanitizerDtorCallback(CGF, OffsetPtr, PoisonSize);
1778*67e74705SXin Li }
1779*67e74705SXin Li };
1780*67e74705SXin Li
1781*67e74705SXin Li class SanitizeDtorVTable final : public EHScopeStack::Cleanup {
1782*67e74705SXin Li const CXXDestructorDecl *Dtor;
1783*67e74705SXin Li
1784*67e74705SXin Li public:
SanitizeDtorVTable(const CXXDestructorDecl * Dtor)1785*67e74705SXin Li SanitizeDtorVTable(const CXXDestructorDecl *Dtor) : Dtor(Dtor) {}
1786*67e74705SXin Li
1787*67e74705SXin Li // Generate function call for handling vtable pointer poisoning.
Emit(CodeGenFunction & CGF,Flags flags)1788*67e74705SXin Li void Emit(CodeGenFunction &CGF, Flags flags) override {
1789*67e74705SXin Li assert(Dtor->getParent()->isDynamicClass());
1790*67e74705SXin Li (void)Dtor;
1791*67e74705SXin Li ASTContext &Context = CGF.getContext();
1792*67e74705SXin Li // Poison vtable and vtable ptr if they exist for this class.
1793*67e74705SXin Li llvm::Value *VTablePtr = CGF.LoadCXXThis();
1794*67e74705SXin Li
1795*67e74705SXin Li CharUnits::QuantityType PoisonSize =
1796*67e74705SXin Li Context.toCharUnitsFromBits(CGF.PointerWidthInBits).getQuantity();
1797*67e74705SXin Li // Pass in void pointer and size of region as arguments to runtime
1798*67e74705SXin Li // function
1799*67e74705SXin Li EmitSanitizerDtorCallback(CGF, VTablePtr, PoisonSize);
1800*67e74705SXin Li }
1801*67e74705SXin Li };
1802*67e74705SXin Li } // end anonymous namespace
1803*67e74705SXin Li
1804*67e74705SXin Li /// \brief Emit all code that comes at the end of class's
1805*67e74705SXin Li /// destructor. This is to call destructors on members and base classes
1806*67e74705SXin Li /// in reverse order of their construction.
EnterDtorCleanups(const CXXDestructorDecl * DD,CXXDtorType DtorType)1807*67e74705SXin Li void CodeGenFunction::EnterDtorCleanups(const CXXDestructorDecl *DD,
1808*67e74705SXin Li CXXDtorType DtorType) {
1809*67e74705SXin Li assert((!DD->isTrivial() || DD->hasAttr<DLLExportAttr>()) &&
1810*67e74705SXin Li "Should not emit dtor epilogue for non-exported trivial dtor!");
1811*67e74705SXin Li
1812*67e74705SXin Li // The deleting-destructor phase just needs to call the appropriate
1813*67e74705SXin Li // operator delete that Sema picked up.
1814*67e74705SXin Li if (DtorType == Dtor_Deleting) {
1815*67e74705SXin Li assert(DD->getOperatorDelete() &&
1816*67e74705SXin Li "operator delete missing - EnterDtorCleanups");
1817*67e74705SXin Li if (CXXStructorImplicitParamValue) {
1818*67e74705SXin Li // If there is an implicit param to the deleting dtor, it's a boolean
1819*67e74705SXin Li // telling whether we should call delete at the end of the dtor.
1820*67e74705SXin Li EHStack.pushCleanup<CallDtorDeleteConditional>(
1821*67e74705SXin Li NormalAndEHCleanup, CXXStructorImplicitParamValue);
1822*67e74705SXin Li } else {
1823*67e74705SXin Li EHStack.pushCleanup<CallDtorDelete>(NormalAndEHCleanup);
1824*67e74705SXin Li }
1825*67e74705SXin Li return;
1826*67e74705SXin Li }
1827*67e74705SXin Li
1828*67e74705SXin Li const CXXRecordDecl *ClassDecl = DD->getParent();
1829*67e74705SXin Li
1830*67e74705SXin Li // Unions have no bases and do not call field destructors.
1831*67e74705SXin Li if (ClassDecl->isUnion())
1832*67e74705SXin Li return;
1833*67e74705SXin Li
1834*67e74705SXin Li // The complete-destructor phase just destructs all the virtual bases.
1835*67e74705SXin Li if (DtorType == Dtor_Complete) {
1836*67e74705SXin Li // Poison the vtable pointer such that access after the base
1837*67e74705SXin Li // and member destructors are invoked is invalid.
1838*67e74705SXin Li if (CGM.getCodeGenOpts().SanitizeMemoryUseAfterDtor &&
1839*67e74705SXin Li SanOpts.has(SanitizerKind::Memory) && ClassDecl->getNumVBases() &&
1840*67e74705SXin Li ClassDecl->isPolymorphic())
1841*67e74705SXin Li EHStack.pushCleanup<SanitizeDtorVTable>(NormalAndEHCleanup, DD);
1842*67e74705SXin Li
1843*67e74705SXin Li // We push them in the forward order so that they'll be popped in
1844*67e74705SXin Li // the reverse order.
1845*67e74705SXin Li for (const auto &Base : ClassDecl->vbases()) {
1846*67e74705SXin Li CXXRecordDecl *BaseClassDecl
1847*67e74705SXin Li = cast<CXXRecordDecl>(Base.getType()->getAs<RecordType>()->getDecl());
1848*67e74705SXin Li
1849*67e74705SXin Li // Ignore trivial destructors.
1850*67e74705SXin Li if (BaseClassDecl->hasTrivialDestructor())
1851*67e74705SXin Li continue;
1852*67e74705SXin Li
1853*67e74705SXin Li EHStack.pushCleanup<CallBaseDtor>(NormalAndEHCleanup,
1854*67e74705SXin Li BaseClassDecl,
1855*67e74705SXin Li /*BaseIsVirtual*/ true);
1856*67e74705SXin Li }
1857*67e74705SXin Li
1858*67e74705SXin Li return;
1859*67e74705SXin Li }
1860*67e74705SXin Li
1861*67e74705SXin Li assert(DtorType == Dtor_Base);
1862*67e74705SXin Li // Poison the vtable pointer if it has no virtual bases, but inherits
1863*67e74705SXin Li // virtual functions.
1864*67e74705SXin Li if (CGM.getCodeGenOpts().SanitizeMemoryUseAfterDtor &&
1865*67e74705SXin Li SanOpts.has(SanitizerKind::Memory) && !ClassDecl->getNumVBases() &&
1866*67e74705SXin Li ClassDecl->isPolymorphic())
1867*67e74705SXin Li EHStack.pushCleanup<SanitizeDtorVTable>(NormalAndEHCleanup, DD);
1868*67e74705SXin Li
1869*67e74705SXin Li // Destroy non-virtual bases.
1870*67e74705SXin Li for (const auto &Base : ClassDecl->bases()) {
1871*67e74705SXin Li // Ignore virtual bases.
1872*67e74705SXin Li if (Base.isVirtual())
1873*67e74705SXin Li continue;
1874*67e74705SXin Li
1875*67e74705SXin Li CXXRecordDecl *BaseClassDecl = Base.getType()->getAsCXXRecordDecl();
1876*67e74705SXin Li
1877*67e74705SXin Li // Ignore trivial destructors.
1878*67e74705SXin Li if (BaseClassDecl->hasTrivialDestructor())
1879*67e74705SXin Li continue;
1880*67e74705SXin Li
1881*67e74705SXin Li EHStack.pushCleanup<CallBaseDtor>(NormalAndEHCleanup,
1882*67e74705SXin Li BaseClassDecl,
1883*67e74705SXin Li /*BaseIsVirtual*/ false);
1884*67e74705SXin Li }
1885*67e74705SXin Li
1886*67e74705SXin Li // Poison fields such that access after their destructors are
1887*67e74705SXin Li // invoked, and before the base class destructor runs, is invalid.
1888*67e74705SXin Li if (CGM.getCodeGenOpts().SanitizeMemoryUseAfterDtor &&
1889*67e74705SXin Li SanOpts.has(SanitizerKind::Memory))
1890*67e74705SXin Li EHStack.pushCleanup<SanitizeDtorMembers>(NormalAndEHCleanup, DD);
1891*67e74705SXin Li
1892*67e74705SXin Li // Destroy direct fields.
1893*67e74705SXin Li for (const auto *Field : ClassDecl->fields()) {
1894*67e74705SXin Li QualType type = Field->getType();
1895*67e74705SXin Li QualType::DestructionKind dtorKind = type.isDestructedType();
1896*67e74705SXin Li if (!dtorKind) continue;
1897*67e74705SXin Li
1898*67e74705SXin Li // Anonymous union members do not have their destructors called.
1899*67e74705SXin Li const RecordType *RT = type->getAsUnionType();
1900*67e74705SXin Li if (RT && RT->getDecl()->isAnonymousStructOrUnion()) continue;
1901*67e74705SXin Li
1902*67e74705SXin Li CleanupKind cleanupKind = getCleanupKind(dtorKind);
1903*67e74705SXin Li EHStack.pushCleanup<DestroyField>(cleanupKind, Field,
1904*67e74705SXin Li getDestroyer(dtorKind),
1905*67e74705SXin Li cleanupKind & EHCleanup);
1906*67e74705SXin Li }
1907*67e74705SXin Li }
1908*67e74705SXin Li
1909*67e74705SXin Li /// EmitCXXAggrConstructorCall - Emit a loop to call a particular
1910*67e74705SXin Li /// constructor for each of several members of an array.
1911*67e74705SXin Li ///
1912*67e74705SXin Li /// \param ctor the constructor to call for each element
1913*67e74705SXin Li /// \param arrayType the type of the array to initialize
1914*67e74705SXin Li /// \param arrayBegin an arrayType*
1915*67e74705SXin Li /// \param zeroInitialize true if each element should be
1916*67e74705SXin Li /// zero-initialized before it is constructed
EmitCXXAggrConstructorCall(const CXXConstructorDecl * ctor,const ArrayType * arrayType,Address arrayBegin,const CXXConstructExpr * E,bool zeroInitialize)1917*67e74705SXin Li void CodeGenFunction::EmitCXXAggrConstructorCall(
1918*67e74705SXin Li const CXXConstructorDecl *ctor, const ArrayType *arrayType,
1919*67e74705SXin Li Address arrayBegin, const CXXConstructExpr *E, bool zeroInitialize) {
1920*67e74705SXin Li QualType elementType;
1921*67e74705SXin Li llvm::Value *numElements =
1922*67e74705SXin Li emitArrayLength(arrayType, elementType, arrayBegin);
1923*67e74705SXin Li
1924*67e74705SXin Li EmitCXXAggrConstructorCall(ctor, numElements, arrayBegin, E, zeroInitialize);
1925*67e74705SXin Li }
1926*67e74705SXin Li
1927*67e74705SXin Li /// EmitCXXAggrConstructorCall - Emit a loop to call a particular
1928*67e74705SXin Li /// constructor for each of several members of an array.
1929*67e74705SXin Li ///
1930*67e74705SXin Li /// \param ctor the constructor to call for each element
1931*67e74705SXin Li /// \param numElements the number of elements in the array;
1932*67e74705SXin Li /// may be zero
1933*67e74705SXin Li /// \param arrayBase a T*, where T is the type constructed by ctor
1934*67e74705SXin Li /// \param zeroInitialize true if each element should be
1935*67e74705SXin Li /// zero-initialized before it is constructed
EmitCXXAggrConstructorCall(const CXXConstructorDecl * ctor,llvm::Value * numElements,Address arrayBase,const CXXConstructExpr * E,bool zeroInitialize)1936*67e74705SXin Li void CodeGenFunction::EmitCXXAggrConstructorCall(const CXXConstructorDecl *ctor,
1937*67e74705SXin Li llvm::Value *numElements,
1938*67e74705SXin Li Address arrayBase,
1939*67e74705SXin Li const CXXConstructExpr *E,
1940*67e74705SXin Li bool zeroInitialize) {
1941*67e74705SXin Li // It's legal for numElements to be zero. This can happen both
1942*67e74705SXin Li // dynamically, because x can be zero in 'new A[x]', and statically,
1943*67e74705SXin Li // because of GCC extensions that permit zero-length arrays. There
1944*67e74705SXin Li // are probably legitimate places where we could assume that this
1945*67e74705SXin Li // doesn't happen, but it's not clear that it's worth it.
1946*67e74705SXin Li llvm::BranchInst *zeroCheckBranch = nullptr;
1947*67e74705SXin Li
1948*67e74705SXin Li // Optimize for a constant count.
1949*67e74705SXin Li llvm::ConstantInt *constantCount
1950*67e74705SXin Li = dyn_cast<llvm::ConstantInt>(numElements);
1951*67e74705SXin Li if (constantCount) {
1952*67e74705SXin Li // Just skip out if the constant count is zero.
1953*67e74705SXin Li if (constantCount->isZero()) return;
1954*67e74705SXin Li
1955*67e74705SXin Li // Otherwise, emit the check.
1956*67e74705SXin Li } else {
1957*67e74705SXin Li llvm::BasicBlock *loopBB = createBasicBlock("new.ctorloop");
1958*67e74705SXin Li llvm::Value *iszero = Builder.CreateIsNull(numElements, "isempty");
1959*67e74705SXin Li zeroCheckBranch = Builder.CreateCondBr(iszero, loopBB, loopBB);
1960*67e74705SXin Li EmitBlock(loopBB);
1961*67e74705SXin Li }
1962*67e74705SXin Li
1963*67e74705SXin Li // Find the end of the array.
1964*67e74705SXin Li llvm::Value *arrayBegin = arrayBase.getPointer();
1965*67e74705SXin Li llvm::Value *arrayEnd = Builder.CreateInBoundsGEP(arrayBegin, numElements,
1966*67e74705SXin Li "arrayctor.end");
1967*67e74705SXin Li
1968*67e74705SXin Li // Enter the loop, setting up a phi for the current location to initialize.
1969*67e74705SXin Li llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
1970*67e74705SXin Li llvm::BasicBlock *loopBB = createBasicBlock("arrayctor.loop");
1971*67e74705SXin Li EmitBlock(loopBB);
1972*67e74705SXin Li llvm::PHINode *cur = Builder.CreatePHI(arrayBegin->getType(), 2,
1973*67e74705SXin Li "arrayctor.cur");
1974*67e74705SXin Li cur->addIncoming(arrayBegin, entryBB);
1975*67e74705SXin Li
1976*67e74705SXin Li // Inside the loop body, emit the constructor call on the array element.
1977*67e74705SXin Li
1978*67e74705SXin Li // The alignment of the base, adjusted by the size of a single element,
1979*67e74705SXin Li // provides a conservative estimate of the alignment of every element.
1980*67e74705SXin Li // (This assumes we never start tracking offsetted alignments.)
1981*67e74705SXin Li //
1982*67e74705SXin Li // Note that these are complete objects and so we don't need to
1983*67e74705SXin Li // use the non-virtual size or alignment.
1984*67e74705SXin Li QualType type = getContext().getTypeDeclType(ctor->getParent());
1985*67e74705SXin Li CharUnits eltAlignment =
1986*67e74705SXin Li arrayBase.getAlignment()
1987*67e74705SXin Li .alignmentOfArrayElement(getContext().getTypeSizeInChars(type));
1988*67e74705SXin Li Address curAddr = Address(cur, eltAlignment);
1989*67e74705SXin Li
1990*67e74705SXin Li // Zero initialize the storage, if requested.
1991*67e74705SXin Li if (zeroInitialize)
1992*67e74705SXin Li EmitNullInitialization(curAddr, type);
1993*67e74705SXin Li
1994*67e74705SXin Li // C++ [class.temporary]p4:
1995*67e74705SXin Li // There are two contexts in which temporaries are destroyed at a different
1996*67e74705SXin Li // point than the end of the full-expression. The first context is when a
1997*67e74705SXin Li // default constructor is called to initialize an element of an array.
1998*67e74705SXin Li // If the constructor has one or more default arguments, the destruction of
1999*67e74705SXin Li // every temporary created in a default argument expression is sequenced
2000*67e74705SXin Li // before the construction of the next array element, if any.
2001*67e74705SXin Li
2002*67e74705SXin Li {
2003*67e74705SXin Li RunCleanupsScope Scope(*this);
2004*67e74705SXin Li
2005*67e74705SXin Li // Evaluate the constructor and its arguments in a regular
2006*67e74705SXin Li // partial-destroy cleanup.
2007*67e74705SXin Li if (getLangOpts().Exceptions &&
2008*67e74705SXin Li !ctor->getParent()->hasTrivialDestructor()) {
2009*67e74705SXin Li Destroyer *destroyer = destroyCXXObject;
2010*67e74705SXin Li pushRegularPartialArrayCleanup(arrayBegin, cur, type, eltAlignment,
2011*67e74705SXin Li *destroyer);
2012*67e74705SXin Li }
2013*67e74705SXin Li
2014*67e74705SXin Li EmitCXXConstructorCall(ctor, Ctor_Complete, /*ForVirtualBase=*/false,
2015*67e74705SXin Li /*Delegating=*/false, curAddr, E);
2016*67e74705SXin Li }
2017*67e74705SXin Li
2018*67e74705SXin Li // Go to the next element.
2019*67e74705SXin Li llvm::Value *next =
2020*67e74705SXin Li Builder.CreateInBoundsGEP(cur, llvm::ConstantInt::get(SizeTy, 1),
2021*67e74705SXin Li "arrayctor.next");
2022*67e74705SXin Li cur->addIncoming(next, Builder.GetInsertBlock());
2023*67e74705SXin Li
2024*67e74705SXin Li // Check whether that's the end of the loop.
2025*67e74705SXin Li llvm::Value *done = Builder.CreateICmpEQ(next, arrayEnd, "arrayctor.done");
2026*67e74705SXin Li llvm::BasicBlock *contBB = createBasicBlock("arrayctor.cont");
2027*67e74705SXin Li Builder.CreateCondBr(done, contBB, loopBB);
2028*67e74705SXin Li
2029*67e74705SXin Li // Patch the earlier check to skip over the loop.
2030*67e74705SXin Li if (zeroCheckBranch) zeroCheckBranch->setSuccessor(0, contBB);
2031*67e74705SXin Li
2032*67e74705SXin Li EmitBlock(contBB);
2033*67e74705SXin Li }
2034*67e74705SXin Li
destroyCXXObject(CodeGenFunction & CGF,Address addr,QualType type)2035*67e74705SXin Li void CodeGenFunction::destroyCXXObject(CodeGenFunction &CGF,
2036*67e74705SXin Li Address addr,
2037*67e74705SXin Li QualType type) {
2038*67e74705SXin Li const RecordType *rtype = type->castAs<RecordType>();
2039*67e74705SXin Li const CXXRecordDecl *record = cast<CXXRecordDecl>(rtype->getDecl());
2040*67e74705SXin Li const CXXDestructorDecl *dtor = record->getDestructor();
2041*67e74705SXin Li assert(!dtor->isTrivial());
2042*67e74705SXin Li CGF.EmitCXXDestructorCall(dtor, Dtor_Complete, /*for vbase*/ false,
2043*67e74705SXin Li /*Delegating=*/false, addr);
2044*67e74705SXin Li }
2045*67e74705SXin Li
EmitCXXConstructorCall(const CXXConstructorDecl * D,CXXCtorType Type,bool ForVirtualBase,bool Delegating,Address This,const CXXConstructExpr * E)2046*67e74705SXin Li void CodeGenFunction::EmitCXXConstructorCall(const CXXConstructorDecl *D,
2047*67e74705SXin Li CXXCtorType Type,
2048*67e74705SXin Li bool ForVirtualBase,
2049*67e74705SXin Li bool Delegating, Address This,
2050*67e74705SXin Li const CXXConstructExpr *E) {
2051*67e74705SXin Li CallArgList Args;
2052*67e74705SXin Li
2053*67e74705SXin Li // Push the this ptr.
2054*67e74705SXin Li Args.add(RValue::get(This.getPointer()), D->getThisType(getContext()));
2055*67e74705SXin Li
2056*67e74705SXin Li // If this is a trivial constructor, emit a memcpy now before we lose
2057*67e74705SXin Li // the alignment information on the argument.
2058*67e74705SXin Li // FIXME: It would be better to preserve alignment information into CallArg.
2059*67e74705SXin Li if (isMemcpyEquivalentSpecialMember(D)) {
2060*67e74705SXin Li assert(E->getNumArgs() == 1 && "unexpected argcount for trivial ctor");
2061*67e74705SXin Li
2062*67e74705SXin Li const Expr *Arg = E->getArg(0);
2063*67e74705SXin Li QualType SrcTy = Arg->getType();
2064*67e74705SXin Li Address Src = EmitLValue(Arg).getAddress();
2065*67e74705SXin Li QualType DestTy = getContext().getTypeDeclType(D->getParent());
2066*67e74705SXin Li EmitAggregateCopyCtor(This, Src, DestTy, SrcTy);
2067*67e74705SXin Li return;
2068*67e74705SXin Li }
2069*67e74705SXin Li
2070*67e74705SXin Li // Add the rest of the user-supplied arguments.
2071*67e74705SXin Li const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
2072*67e74705SXin Li EmitCallArgs(Args, FPT, E->arguments(), E->getConstructor());
2073*67e74705SXin Li
2074*67e74705SXin Li EmitCXXConstructorCall(D, Type, ForVirtualBase, Delegating, This, Args);
2075*67e74705SXin Li }
2076*67e74705SXin Li
canEmitDelegateCallArgs(CodeGenFunction & CGF,const CXXConstructorDecl * Ctor,CXXCtorType Type,CallArgList & Args)2077*67e74705SXin Li static bool canEmitDelegateCallArgs(CodeGenFunction &CGF,
2078*67e74705SXin Li const CXXConstructorDecl *Ctor,
2079*67e74705SXin Li CXXCtorType Type, CallArgList &Args) {
2080*67e74705SXin Li // We can't forward a variadic call.
2081*67e74705SXin Li if (Ctor->isVariadic())
2082*67e74705SXin Li return false;
2083*67e74705SXin Li
2084*67e74705SXin Li if (CGF.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2085*67e74705SXin Li // If the parameters are callee-cleanup, it's not safe to forward.
2086*67e74705SXin Li for (auto *P : Ctor->parameters())
2087*67e74705SXin Li if (P->getType().isDestructedType())
2088*67e74705SXin Li return false;
2089*67e74705SXin Li
2090*67e74705SXin Li // Likewise if they're inalloca.
2091*67e74705SXin Li const CGFunctionInfo &Info =
2092*67e74705SXin Li CGF.CGM.getTypes().arrangeCXXConstructorCall(Args, Ctor, Type, 0);
2093*67e74705SXin Li if (Info.usesInAlloca())
2094*67e74705SXin Li return false;
2095*67e74705SXin Li }
2096*67e74705SXin Li
2097*67e74705SXin Li // Anything else should be OK.
2098*67e74705SXin Li return true;
2099*67e74705SXin Li }
2100*67e74705SXin Li
EmitCXXConstructorCall(const CXXConstructorDecl * D,CXXCtorType Type,bool ForVirtualBase,bool Delegating,Address This,CallArgList & Args)2101*67e74705SXin Li void CodeGenFunction::EmitCXXConstructorCall(const CXXConstructorDecl *D,
2102*67e74705SXin Li CXXCtorType Type,
2103*67e74705SXin Li bool ForVirtualBase,
2104*67e74705SXin Li bool Delegating,
2105*67e74705SXin Li Address This,
2106*67e74705SXin Li CallArgList &Args) {
2107*67e74705SXin Li const CXXRecordDecl *ClassDecl = D->getParent();
2108*67e74705SXin Li
2109*67e74705SXin Li // C++11 [class.mfct.non-static]p2:
2110*67e74705SXin Li // If a non-static member function of a class X is called for an object that
2111*67e74705SXin Li // is not of type X, or of a type derived from X, the behavior is undefined.
2112*67e74705SXin Li // FIXME: Provide a source location here.
2113*67e74705SXin Li EmitTypeCheck(CodeGenFunction::TCK_ConstructorCall, SourceLocation(),
2114*67e74705SXin Li This.getPointer(), getContext().getRecordType(ClassDecl));
2115*67e74705SXin Li
2116*67e74705SXin Li if (D->isTrivial() && D->isDefaultConstructor()) {
2117*67e74705SXin Li assert(Args.size() == 1 && "trivial default ctor with args");
2118*67e74705SXin Li return;
2119*67e74705SXin Li }
2120*67e74705SXin Li
2121*67e74705SXin Li // If this is a trivial constructor, just emit what's needed. If this is a
2122*67e74705SXin Li // union copy constructor, we must emit a memcpy, because the AST does not
2123*67e74705SXin Li // model that copy.
2124*67e74705SXin Li if (isMemcpyEquivalentSpecialMember(D)) {
2125*67e74705SXin Li assert(Args.size() == 2 && "unexpected argcount for trivial ctor");
2126*67e74705SXin Li
2127*67e74705SXin Li QualType SrcTy = D->getParamDecl(0)->getType().getNonReferenceType();
2128*67e74705SXin Li Address Src(Args[1].RV.getScalarVal(), getNaturalTypeAlignment(SrcTy));
2129*67e74705SXin Li QualType DestTy = getContext().getTypeDeclType(ClassDecl);
2130*67e74705SXin Li EmitAggregateCopyCtor(This, Src, DestTy, SrcTy);
2131*67e74705SXin Li return;
2132*67e74705SXin Li }
2133*67e74705SXin Li
2134*67e74705SXin Li // Check whether we can actually emit the constructor before trying to do so.
2135*67e74705SXin Li if (auto Inherited = D->getInheritedConstructor()) {
2136*67e74705SXin Li if (getTypes().inheritingCtorHasParams(Inherited, Type) &&
2137*67e74705SXin Li !canEmitDelegateCallArgs(*this, D, Type, Args)) {
2138*67e74705SXin Li EmitInlinedInheritingCXXConstructorCall(D, Type, ForVirtualBase,
2139*67e74705SXin Li Delegating, Args);
2140*67e74705SXin Li return;
2141*67e74705SXin Li }
2142*67e74705SXin Li }
2143*67e74705SXin Li
2144*67e74705SXin Li // Insert any ABI-specific implicit constructor arguments.
2145*67e74705SXin Li unsigned ExtraArgs = CGM.getCXXABI().addImplicitConstructorArgs(
2146*67e74705SXin Li *this, D, Type, ForVirtualBase, Delegating, Args);
2147*67e74705SXin Li
2148*67e74705SXin Li // Emit the call.
2149*67e74705SXin Li llvm::Value *Callee = CGM.getAddrOfCXXStructor(D, getFromCtorType(Type));
2150*67e74705SXin Li const CGFunctionInfo &Info =
2151*67e74705SXin Li CGM.getTypes().arrangeCXXConstructorCall(Args, D, Type, ExtraArgs);
2152*67e74705SXin Li EmitCall(Info, Callee, ReturnValueSlot(), Args, D);
2153*67e74705SXin Li
2154*67e74705SXin Li // Generate vtable assumptions if we're constructing a complete object
2155*67e74705SXin Li // with a vtable. We don't do this for base subobjects for two reasons:
2156*67e74705SXin Li // first, it's incorrect for classes with virtual bases, and second, we're
2157*67e74705SXin Li // about to overwrite the vptrs anyway.
2158*67e74705SXin Li // We also have to make sure if we can refer to vtable:
2159*67e74705SXin Li // - Otherwise we can refer to vtable if it's safe to speculatively emit.
2160*67e74705SXin Li // FIXME: If vtable is used by ctor/dtor, or if vtable is external and we are
2161*67e74705SXin Li // sure that definition of vtable is not hidden,
2162*67e74705SXin Li // then we are always safe to refer to it.
2163*67e74705SXin Li // FIXME: It looks like InstCombine is very inefficient on dealing with
2164*67e74705SXin Li // assumes. Make assumption loads require -fstrict-vtable-pointers temporarily.
2165*67e74705SXin Li if (CGM.getCodeGenOpts().OptimizationLevel > 0 &&
2166*67e74705SXin Li ClassDecl->isDynamicClass() && Type != Ctor_Base &&
2167*67e74705SXin Li CGM.getCXXABI().canSpeculativelyEmitVTable(ClassDecl) &&
2168*67e74705SXin Li CGM.getCodeGenOpts().StrictVTablePointers)
2169*67e74705SXin Li EmitVTableAssumptionLoads(ClassDecl, This);
2170*67e74705SXin Li }
2171*67e74705SXin Li
EmitInheritedCXXConstructorCall(const CXXConstructorDecl * D,bool ForVirtualBase,Address This,bool InheritedFromVBase,const CXXInheritedCtorInitExpr * E)2172*67e74705SXin Li void CodeGenFunction::EmitInheritedCXXConstructorCall(
2173*67e74705SXin Li const CXXConstructorDecl *D, bool ForVirtualBase, Address This,
2174*67e74705SXin Li bool InheritedFromVBase, const CXXInheritedCtorInitExpr *E) {
2175*67e74705SXin Li CallArgList Args;
2176*67e74705SXin Li CallArg ThisArg(RValue::get(This.getPointer()), D->getThisType(getContext()),
2177*67e74705SXin Li /*NeedsCopy=*/false);
2178*67e74705SXin Li
2179*67e74705SXin Li // Forward the parameters.
2180*67e74705SXin Li if (InheritedFromVBase &&
2181*67e74705SXin Li CGM.getTarget().getCXXABI().hasConstructorVariants()) {
2182*67e74705SXin Li // Nothing to do; this construction is not responsible for constructing
2183*67e74705SXin Li // the base class containing the inherited constructor.
2184*67e74705SXin Li // FIXME: Can we just pass undef's for the remaining arguments if we don't
2185*67e74705SXin Li // have constructor variants?
2186*67e74705SXin Li Args.push_back(ThisArg);
2187*67e74705SXin Li } else if (!CXXInheritedCtorInitExprArgs.empty()) {
2188*67e74705SXin Li // The inheriting constructor was inlined; just inject its arguments.
2189*67e74705SXin Li assert(CXXInheritedCtorInitExprArgs.size() >= D->getNumParams() &&
2190*67e74705SXin Li "wrong number of parameters for inherited constructor call");
2191*67e74705SXin Li Args = CXXInheritedCtorInitExprArgs;
2192*67e74705SXin Li Args[0] = ThisArg;
2193*67e74705SXin Li } else {
2194*67e74705SXin Li // The inheriting constructor was not inlined. Emit delegating arguments.
2195*67e74705SXin Li Args.push_back(ThisArg);
2196*67e74705SXin Li const auto *OuterCtor = cast<CXXConstructorDecl>(CurCodeDecl);
2197*67e74705SXin Li assert(OuterCtor->getNumParams() == D->getNumParams());
2198*67e74705SXin Li assert(!OuterCtor->isVariadic() && "should have been inlined");
2199*67e74705SXin Li
2200*67e74705SXin Li for (const auto *Param : OuterCtor->parameters()) {
2201*67e74705SXin Li assert(getContext().hasSameUnqualifiedType(
2202*67e74705SXin Li OuterCtor->getParamDecl(Param->getFunctionScopeIndex())->getType(),
2203*67e74705SXin Li Param->getType()));
2204*67e74705SXin Li EmitDelegateCallArg(Args, Param, E->getLocation());
2205*67e74705SXin Li
2206*67e74705SXin Li // Forward __attribute__(pass_object_size).
2207*67e74705SXin Li if (Param->hasAttr<PassObjectSizeAttr>()) {
2208*67e74705SXin Li auto *POSParam = SizeArguments[Param];
2209*67e74705SXin Li assert(POSParam && "missing pass_object_size value for forwarding");
2210*67e74705SXin Li EmitDelegateCallArg(Args, POSParam, E->getLocation());
2211*67e74705SXin Li }
2212*67e74705SXin Li }
2213*67e74705SXin Li }
2214*67e74705SXin Li
2215*67e74705SXin Li EmitCXXConstructorCall(D, Ctor_Base, ForVirtualBase, /*Delegating*/false,
2216*67e74705SXin Li This, Args);
2217*67e74705SXin Li }
2218*67e74705SXin Li
EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl * Ctor,CXXCtorType CtorType,bool ForVirtualBase,bool Delegating,CallArgList & Args)2219*67e74705SXin Li void CodeGenFunction::EmitInlinedInheritingCXXConstructorCall(
2220*67e74705SXin Li const CXXConstructorDecl *Ctor, CXXCtorType CtorType, bool ForVirtualBase,
2221*67e74705SXin Li bool Delegating, CallArgList &Args) {
2222*67e74705SXin Li InlinedInheritingConstructorScope Scope(*this, GlobalDecl(Ctor, CtorType));
2223*67e74705SXin Li
2224*67e74705SXin Li // Save the arguments to be passed to the inherited constructor.
2225*67e74705SXin Li CXXInheritedCtorInitExprArgs = Args;
2226*67e74705SXin Li
2227*67e74705SXin Li FunctionArgList Params;
2228*67e74705SXin Li QualType RetType = BuildFunctionArgList(CurGD, Params);
2229*67e74705SXin Li FnRetTy = RetType;
2230*67e74705SXin Li
2231*67e74705SXin Li // Insert any ABI-specific implicit constructor arguments.
2232*67e74705SXin Li CGM.getCXXABI().addImplicitConstructorArgs(*this, Ctor, CtorType,
2233*67e74705SXin Li ForVirtualBase, Delegating, Args);
2234*67e74705SXin Li
2235*67e74705SXin Li // Emit a simplified prolog. We only need to emit the implicit params.
2236*67e74705SXin Li assert(Args.size() >= Params.size() && "too few arguments for call");
2237*67e74705SXin Li for (unsigned I = 0, N = Args.size(); I != N; ++I) {
2238*67e74705SXin Li if (I < Params.size() && isa<ImplicitParamDecl>(Params[I])) {
2239*67e74705SXin Li const RValue &RV = Args[I].RV;
2240*67e74705SXin Li assert(!RV.isComplex() && "complex indirect params not supported");
2241*67e74705SXin Li ParamValue Val = RV.isScalar()
2242*67e74705SXin Li ? ParamValue::forDirect(RV.getScalarVal())
2243*67e74705SXin Li : ParamValue::forIndirect(RV.getAggregateAddress());
2244*67e74705SXin Li EmitParmDecl(*Params[I], Val, I + 1);
2245*67e74705SXin Li }
2246*67e74705SXin Li }
2247*67e74705SXin Li
2248*67e74705SXin Li // Create a return value slot if the ABI implementation wants one.
2249*67e74705SXin Li // FIXME: This is dumb, we should ask the ABI not to try to set the return
2250*67e74705SXin Li // value instead.
2251*67e74705SXin Li if (!RetType->isVoidType())
2252*67e74705SXin Li ReturnValue = CreateIRTemp(RetType, "retval.inhctor");
2253*67e74705SXin Li
2254*67e74705SXin Li CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
2255*67e74705SXin Li CXXThisValue = CXXABIThisValue;
2256*67e74705SXin Li
2257*67e74705SXin Li // Directly emit the constructor initializers.
2258*67e74705SXin Li EmitCtorPrologue(Ctor, CtorType, Params);
2259*67e74705SXin Li }
2260*67e74705SXin Li
EmitVTableAssumptionLoad(const VPtr & Vptr,Address This)2261*67e74705SXin Li void CodeGenFunction::EmitVTableAssumptionLoad(const VPtr &Vptr, Address This) {
2262*67e74705SXin Li llvm::Value *VTableGlobal =
2263*67e74705SXin Li CGM.getCXXABI().getVTableAddressPoint(Vptr.Base, Vptr.VTableClass);
2264*67e74705SXin Li if (!VTableGlobal)
2265*67e74705SXin Li return;
2266*67e74705SXin Li
2267*67e74705SXin Li // We can just use the base offset in the complete class.
2268*67e74705SXin Li CharUnits NonVirtualOffset = Vptr.Base.getBaseOffset();
2269*67e74705SXin Li
2270*67e74705SXin Li if (!NonVirtualOffset.isZero())
2271*67e74705SXin Li This =
2272*67e74705SXin Li ApplyNonVirtualAndVirtualOffset(*this, This, NonVirtualOffset, nullptr,
2273*67e74705SXin Li Vptr.VTableClass, Vptr.NearestVBase);
2274*67e74705SXin Li
2275*67e74705SXin Li llvm::Value *VPtrValue =
2276*67e74705SXin Li GetVTablePtr(This, VTableGlobal->getType(), Vptr.VTableClass);
2277*67e74705SXin Li llvm::Value *Cmp =
2278*67e74705SXin Li Builder.CreateICmpEQ(VPtrValue, VTableGlobal, "cmp.vtables");
2279*67e74705SXin Li Builder.CreateAssumption(Cmp);
2280*67e74705SXin Li }
2281*67e74705SXin Li
EmitVTableAssumptionLoads(const CXXRecordDecl * ClassDecl,Address This)2282*67e74705SXin Li void CodeGenFunction::EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl,
2283*67e74705SXin Li Address This) {
2284*67e74705SXin Li if (CGM.getCXXABI().doStructorsInitializeVPtrs(ClassDecl))
2285*67e74705SXin Li for (const VPtr &Vptr : getVTablePointers(ClassDecl))
2286*67e74705SXin Li EmitVTableAssumptionLoad(Vptr, This);
2287*67e74705SXin Li }
2288*67e74705SXin Li
2289*67e74705SXin Li void
EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl * D,Address This,Address Src,const CXXConstructExpr * E)2290*67e74705SXin Li CodeGenFunction::EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
2291*67e74705SXin Li Address This, Address Src,
2292*67e74705SXin Li const CXXConstructExpr *E) {
2293*67e74705SXin Li const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
2294*67e74705SXin Li
2295*67e74705SXin Li CallArgList Args;
2296*67e74705SXin Li
2297*67e74705SXin Li // Push the this ptr.
2298*67e74705SXin Li Args.add(RValue::get(This.getPointer()), D->getThisType(getContext()));
2299*67e74705SXin Li
2300*67e74705SXin Li // Push the src ptr.
2301*67e74705SXin Li QualType QT = *(FPT->param_type_begin());
2302*67e74705SXin Li llvm::Type *t = CGM.getTypes().ConvertType(QT);
2303*67e74705SXin Li Src = Builder.CreateBitCast(Src, t);
2304*67e74705SXin Li Args.add(RValue::get(Src.getPointer()), QT);
2305*67e74705SXin Li
2306*67e74705SXin Li // Skip over first argument (Src).
2307*67e74705SXin Li EmitCallArgs(Args, FPT, drop_begin(E->arguments(), 1), E->getConstructor(),
2308*67e74705SXin Li /*ParamsToSkip*/ 1);
2309*67e74705SXin Li
2310*67e74705SXin Li EmitCXXConstructorCall(D, Ctor_Complete, false, false, This, Args);
2311*67e74705SXin Li }
2312*67e74705SXin Li
2313*67e74705SXin Li void
EmitDelegateCXXConstructorCall(const CXXConstructorDecl * Ctor,CXXCtorType CtorType,const FunctionArgList & Args,SourceLocation Loc)2314*67e74705SXin Li CodeGenFunction::EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2315*67e74705SXin Li CXXCtorType CtorType,
2316*67e74705SXin Li const FunctionArgList &Args,
2317*67e74705SXin Li SourceLocation Loc) {
2318*67e74705SXin Li CallArgList DelegateArgs;
2319*67e74705SXin Li
2320*67e74705SXin Li FunctionArgList::const_iterator I = Args.begin(), E = Args.end();
2321*67e74705SXin Li assert(I != E && "no parameters to constructor");
2322*67e74705SXin Li
2323*67e74705SXin Li // this
2324*67e74705SXin Li Address This = LoadCXXThisAddress();
2325*67e74705SXin Li DelegateArgs.add(RValue::get(This.getPointer()), (*I)->getType());
2326*67e74705SXin Li ++I;
2327*67e74705SXin Li
2328*67e74705SXin Li // FIXME: The location of the VTT parameter in the parameter list is
2329*67e74705SXin Li // specific to the Itanium ABI and shouldn't be hardcoded here.
2330*67e74705SXin Li if (CGM.getCXXABI().NeedsVTTParameter(CurGD)) {
2331*67e74705SXin Li assert(I != E && "cannot skip vtt parameter, already done with args");
2332*67e74705SXin Li assert((*I)->getType()->isPointerType() &&
2333*67e74705SXin Li "skipping parameter not of vtt type");
2334*67e74705SXin Li ++I;
2335*67e74705SXin Li }
2336*67e74705SXin Li
2337*67e74705SXin Li // Explicit arguments.
2338*67e74705SXin Li for (; I != E; ++I) {
2339*67e74705SXin Li const VarDecl *param = *I;
2340*67e74705SXin Li // FIXME: per-argument source location
2341*67e74705SXin Li EmitDelegateCallArg(DelegateArgs, param, Loc);
2342*67e74705SXin Li }
2343*67e74705SXin Li
2344*67e74705SXin Li EmitCXXConstructorCall(Ctor, CtorType, /*ForVirtualBase=*/false,
2345*67e74705SXin Li /*Delegating=*/true, This, DelegateArgs);
2346*67e74705SXin Li }
2347*67e74705SXin Li
2348*67e74705SXin Li namespace {
2349*67e74705SXin Li struct CallDelegatingCtorDtor final : EHScopeStack::Cleanup {
2350*67e74705SXin Li const CXXDestructorDecl *Dtor;
2351*67e74705SXin Li Address Addr;
2352*67e74705SXin Li CXXDtorType Type;
2353*67e74705SXin Li
CallDelegatingCtorDtor__anon6bf721160511::CallDelegatingCtorDtor2354*67e74705SXin Li CallDelegatingCtorDtor(const CXXDestructorDecl *D, Address Addr,
2355*67e74705SXin Li CXXDtorType Type)
2356*67e74705SXin Li : Dtor(D), Addr(Addr), Type(Type) {}
2357*67e74705SXin Li
Emit__anon6bf721160511::CallDelegatingCtorDtor2358*67e74705SXin Li void Emit(CodeGenFunction &CGF, Flags flags) override {
2359*67e74705SXin Li CGF.EmitCXXDestructorCall(Dtor, Type, /*ForVirtualBase=*/false,
2360*67e74705SXin Li /*Delegating=*/true, Addr);
2361*67e74705SXin Li }
2362*67e74705SXin Li };
2363*67e74705SXin Li } // end anonymous namespace
2364*67e74705SXin Li
2365*67e74705SXin Li void
EmitDelegatingCXXConstructorCall(const CXXConstructorDecl * Ctor,const FunctionArgList & Args)2366*67e74705SXin Li CodeGenFunction::EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2367*67e74705SXin Li const FunctionArgList &Args) {
2368*67e74705SXin Li assert(Ctor->isDelegatingConstructor());
2369*67e74705SXin Li
2370*67e74705SXin Li Address ThisPtr = LoadCXXThisAddress();
2371*67e74705SXin Li
2372*67e74705SXin Li AggValueSlot AggSlot =
2373*67e74705SXin Li AggValueSlot::forAddr(ThisPtr, Qualifiers(),
2374*67e74705SXin Li AggValueSlot::IsDestructed,
2375*67e74705SXin Li AggValueSlot::DoesNotNeedGCBarriers,
2376*67e74705SXin Li AggValueSlot::IsNotAliased);
2377*67e74705SXin Li
2378*67e74705SXin Li EmitAggExpr(Ctor->init_begin()[0]->getInit(), AggSlot);
2379*67e74705SXin Li
2380*67e74705SXin Li const CXXRecordDecl *ClassDecl = Ctor->getParent();
2381*67e74705SXin Li if (CGM.getLangOpts().Exceptions && !ClassDecl->hasTrivialDestructor()) {
2382*67e74705SXin Li CXXDtorType Type =
2383*67e74705SXin Li CurGD.getCtorType() == Ctor_Complete ? Dtor_Complete : Dtor_Base;
2384*67e74705SXin Li
2385*67e74705SXin Li EHStack.pushCleanup<CallDelegatingCtorDtor>(EHCleanup,
2386*67e74705SXin Li ClassDecl->getDestructor(),
2387*67e74705SXin Li ThisPtr, Type);
2388*67e74705SXin Li }
2389*67e74705SXin Li }
2390*67e74705SXin Li
EmitCXXDestructorCall(const CXXDestructorDecl * DD,CXXDtorType Type,bool ForVirtualBase,bool Delegating,Address This)2391*67e74705SXin Li void CodeGenFunction::EmitCXXDestructorCall(const CXXDestructorDecl *DD,
2392*67e74705SXin Li CXXDtorType Type,
2393*67e74705SXin Li bool ForVirtualBase,
2394*67e74705SXin Li bool Delegating,
2395*67e74705SXin Li Address This) {
2396*67e74705SXin Li CGM.getCXXABI().EmitDestructorCall(*this, DD, Type, ForVirtualBase,
2397*67e74705SXin Li Delegating, This);
2398*67e74705SXin Li }
2399*67e74705SXin Li
2400*67e74705SXin Li namespace {
2401*67e74705SXin Li struct CallLocalDtor final : EHScopeStack::Cleanup {
2402*67e74705SXin Li const CXXDestructorDecl *Dtor;
2403*67e74705SXin Li Address Addr;
2404*67e74705SXin Li
CallLocalDtor__anon6bf721160611::CallLocalDtor2405*67e74705SXin Li CallLocalDtor(const CXXDestructorDecl *D, Address Addr)
2406*67e74705SXin Li : Dtor(D), Addr(Addr) {}
2407*67e74705SXin Li
Emit__anon6bf721160611::CallLocalDtor2408*67e74705SXin Li void Emit(CodeGenFunction &CGF, Flags flags) override {
2409*67e74705SXin Li CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
2410*67e74705SXin Li /*ForVirtualBase=*/false,
2411*67e74705SXin Li /*Delegating=*/false, Addr);
2412*67e74705SXin Li }
2413*67e74705SXin Li };
2414*67e74705SXin Li } // end anonymous namespace
2415*67e74705SXin Li
PushDestructorCleanup(const CXXDestructorDecl * D,Address Addr)2416*67e74705SXin Li void CodeGenFunction::PushDestructorCleanup(const CXXDestructorDecl *D,
2417*67e74705SXin Li Address Addr) {
2418*67e74705SXin Li EHStack.pushCleanup<CallLocalDtor>(NormalAndEHCleanup, D, Addr);
2419*67e74705SXin Li }
2420*67e74705SXin Li
PushDestructorCleanup(QualType T,Address Addr)2421*67e74705SXin Li void CodeGenFunction::PushDestructorCleanup(QualType T, Address Addr) {
2422*67e74705SXin Li CXXRecordDecl *ClassDecl = T->getAsCXXRecordDecl();
2423*67e74705SXin Li if (!ClassDecl) return;
2424*67e74705SXin Li if (ClassDecl->hasTrivialDestructor()) return;
2425*67e74705SXin Li
2426*67e74705SXin Li const CXXDestructorDecl *D = ClassDecl->getDestructor();
2427*67e74705SXin Li assert(D && D->isUsed() && "destructor not marked as used!");
2428*67e74705SXin Li PushDestructorCleanup(D, Addr);
2429*67e74705SXin Li }
2430*67e74705SXin Li
InitializeVTablePointer(const VPtr & Vptr)2431*67e74705SXin Li void CodeGenFunction::InitializeVTablePointer(const VPtr &Vptr) {
2432*67e74705SXin Li // Compute the address point.
2433*67e74705SXin Li llvm::Value *VTableAddressPoint =
2434*67e74705SXin Li CGM.getCXXABI().getVTableAddressPointInStructor(
2435*67e74705SXin Li *this, Vptr.VTableClass, Vptr.Base, Vptr.NearestVBase);
2436*67e74705SXin Li
2437*67e74705SXin Li if (!VTableAddressPoint)
2438*67e74705SXin Li return;
2439*67e74705SXin Li
2440*67e74705SXin Li // Compute where to store the address point.
2441*67e74705SXin Li llvm::Value *VirtualOffset = nullptr;
2442*67e74705SXin Li CharUnits NonVirtualOffset = CharUnits::Zero();
2443*67e74705SXin Li
2444*67e74705SXin Li if (CGM.getCXXABI().isVirtualOffsetNeededForVTableField(*this, Vptr)) {
2445*67e74705SXin Li // We need to use the virtual base offset offset because the virtual base
2446*67e74705SXin Li // might have a different offset in the most derived class.
2447*67e74705SXin Li
2448*67e74705SXin Li VirtualOffset = CGM.getCXXABI().GetVirtualBaseClassOffset(
2449*67e74705SXin Li *this, LoadCXXThisAddress(), Vptr.VTableClass, Vptr.NearestVBase);
2450*67e74705SXin Li NonVirtualOffset = Vptr.OffsetFromNearestVBase;
2451*67e74705SXin Li } else {
2452*67e74705SXin Li // We can just use the base offset in the complete class.
2453*67e74705SXin Li NonVirtualOffset = Vptr.Base.getBaseOffset();
2454*67e74705SXin Li }
2455*67e74705SXin Li
2456*67e74705SXin Li // Apply the offsets.
2457*67e74705SXin Li Address VTableField = LoadCXXThisAddress();
2458*67e74705SXin Li
2459*67e74705SXin Li if (!NonVirtualOffset.isZero() || VirtualOffset)
2460*67e74705SXin Li VTableField = ApplyNonVirtualAndVirtualOffset(
2461*67e74705SXin Li *this, VTableField, NonVirtualOffset, VirtualOffset, Vptr.VTableClass,
2462*67e74705SXin Li Vptr.NearestVBase);
2463*67e74705SXin Li
2464*67e74705SXin Li // Finally, store the address point. Use the same LLVM types as the field to
2465*67e74705SXin Li // support optimization.
2466*67e74705SXin Li llvm::Type *VTablePtrTy =
2467*67e74705SXin Li llvm::FunctionType::get(CGM.Int32Ty, /*isVarArg=*/true)
2468*67e74705SXin Li ->getPointerTo()
2469*67e74705SXin Li ->getPointerTo();
2470*67e74705SXin Li VTableField = Builder.CreateBitCast(VTableField, VTablePtrTy->getPointerTo());
2471*67e74705SXin Li VTableAddressPoint = Builder.CreateBitCast(VTableAddressPoint, VTablePtrTy);
2472*67e74705SXin Li
2473*67e74705SXin Li llvm::StoreInst *Store = Builder.CreateStore(VTableAddressPoint, VTableField);
2474*67e74705SXin Li CGM.DecorateInstructionWithTBAA(Store, CGM.getTBAAInfoForVTablePtr());
2475*67e74705SXin Li if (CGM.getCodeGenOpts().OptimizationLevel > 0 &&
2476*67e74705SXin Li CGM.getCodeGenOpts().StrictVTablePointers)
2477*67e74705SXin Li CGM.DecorateInstructionWithInvariantGroup(Store, Vptr.VTableClass);
2478*67e74705SXin Li }
2479*67e74705SXin Li
2480*67e74705SXin Li CodeGenFunction::VPtrsVector
getVTablePointers(const CXXRecordDecl * VTableClass)2481*67e74705SXin Li CodeGenFunction::getVTablePointers(const CXXRecordDecl *VTableClass) {
2482*67e74705SXin Li CodeGenFunction::VPtrsVector VPtrsResult;
2483*67e74705SXin Li VisitedVirtualBasesSetTy VBases;
2484*67e74705SXin Li getVTablePointers(BaseSubobject(VTableClass, CharUnits::Zero()),
2485*67e74705SXin Li /*NearestVBase=*/nullptr,
2486*67e74705SXin Li /*OffsetFromNearestVBase=*/CharUnits::Zero(),
2487*67e74705SXin Li /*BaseIsNonVirtualPrimaryBase=*/false, VTableClass, VBases,
2488*67e74705SXin Li VPtrsResult);
2489*67e74705SXin Li return VPtrsResult;
2490*67e74705SXin Li }
2491*67e74705SXin Li
getVTablePointers(BaseSubobject Base,const CXXRecordDecl * NearestVBase,CharUnits OffsetFromNearestVBase,bool BaseIsNonVirtualPrimaryBase,const CXXRecordDecl * VTableClass,VisitedVirtualBasesSetTy & VBases,VPtrsVector & Vptrs)2492*67e74705SXin Li void CodeGenFunction::getVTablePointers(BaseSubobject Base,
2493*67e74705SXin Li const CXXRecordDecl *NearestVBase,
2494*67e74705SXin Li CharUnits OffsetFromNearestVBase,
2495*67e74705SXin Li bool BaseIsNonVirtualPrimaryBase,
2496*67e74705SXin Li const CXXRecordDecl *VTableClass,
2497*67e74705SXin Li VisitedVirtualBasesSetTy &VBases,
2498*67e74705SXin Li VPtrsVector &Vptrs) {
2499*67e74705SXin Li // If this base is a non-virtual primary base the address point has already
2500*67e74705SXin Li // been set.
2501*67e74705SXin Li if (!BaseIsNonVirtualPrimaryBase) {
2502*67e74705SXin Li // Initialize the vtable pointer for this base.
2503*67e74705SXin Li VPtr Vptr = {Base, NearestVBase, OffsetFromNearestVBase, VTableClass};
2504*67e74705SXin Li Vptrs.push_back(Vptr);
2505*67e74705SXin Li }
2506*67e74705SXin Li
2507*67e74705SXin Li const CXXRecordDecl *RD = Base.getBase();
2508*67e74705SXin Li
2509*67e74705SXin Li // Traverse bases.
2510*67e74705SXin Li for (const auto &I : RD->bases()) {
2511*67e74705SXin Li CXXRecordDecl *BaseDecl
2512*67e74705SXin Li = cast<CXXRecordDecl>(I.getType()->getAs<RecordType>()->getDecl());
2513*67e74705SXin Li
2514*67e74705SXin Li // Ignore classes without a vtable.
2515*67e74705SXin Li if (!BaseDecl->isDynamicClass())
2516*67e74705SXin Li continue;
2517*67e74705SXin Li
2518*67e74705SXin Li CharUnits BaseOffset;
2519*67e74705SXin Li CharUnits BaseOffsetFromNearestVBase;
2520*67e74705SXin Li bool BaseDeclIsNonVirtualPrimaryBase;
2521*67e74705SXin Li
2522*67e74705SXin Li if (I.isVirtual()) {
2523*67e74705SXin Li // Check if we've visited this virtual base before.
2524*67e74705SXin Li if (!VBases.insert(BaseDecl).second)
2525*67e74705SXin Li continue;
2526*67e74705SXin Li
2527*67e74705SXin Li const ASTRecordLayout &Layout =
2528*67e74705SXin Li getContext().getASTRecordLayout(VTableClass);
2529*67e74705SXin Li
2530*67e74705SXin Li BaseOffset = Layout.getVBaseClassOffset(BaseDecl);
2531*67e74705SXin Li BaseOffsetFromNearestVBase = CharUnits::Zero();
2532*67e74705SXin Li BaseDeclIsNonVirtualPrimaryBase = false;
2533*67e74705SXin Li } else {
2534*67e74705SXin Li const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
2535*67e74705SXin Li
2536*67e74705SXin Li BaseOffset = Base.getBaseOffset() + Layout.getBaseClassOffset(BaseDecl);
2537*67e74705SXin Li BaseOffsetFromNearestVBase =
2538*67e74705SXin Li OffsetFromNearestVBase + Layout.getBaseClassOffset(BaseDecl);
2539*67e74705SXin Li BaseDeclIsNonVirtualPrimaryBase = Layout.getPrimaryBase() == BaseDecl;
2540*67e74705SXin Li }
2541*67e74705SXin Li
2542*67e74705SXin Li getVTablePointers(
2543*67e74705SXin Li BaseSubobject(BaseDecl, BaseOffset),
2544*67e74705SXin Li I.isVirtual() ? BaseDecl : NearestVBase, BaseOffsetFromNearestVBase,
2545*67e74705SXin Li BaseDeclIsNonVirtualPrimaryBase, VTableClass, VBases, Vptrs);
2546*67e74705SXin Li }
2547*67e74705SXin Li }
2548*67e74705SXin Li
InitializeVTablePointers(const CXXRecordDecl * RD)2549*67e74705SXin Li void CodeGenFunction::InitializeVTablePointers(const CXXRecordDecl *RD) {
2550*67e74705SXin Li // Ignore classes without a vtable.
2551*67e74705SXin Li if (!RD->isDynamicClass())
2552*67e74705SXin Li return;
2553*67e74705SXin Li
2554*67e74705SXin Li // Initialize the vtable pointers for this class and all of its bases.
2555*67e74705SXin Li if (CGM.getCXXABI().doStructorsInitializeVPtrs(RD))
2556*67e74705SXin Li for (const VPtr &Vptr : getVTablePointers(RD))
2557*67e74705SXin Li InitializeVTablePointer(Vptr);
2558*67e74705SXin Li
2559*67e74705SXin Li if (RD->getNumVBases())
2560*67e74705SXin Li CGM.getCXXABI().initializeHiddenVirtualInheritanceMembers(*this, RD);
2561*67e74705SXin Li }
2562*67e74705SXin Li
GetVTablePtr(Address This,llvm::Type * VTableTy,const CXXRecordDecl * RD)2563*67e74705SXin Li llvm::Value *CodeGenFunction::GetVTablePtr(Address This,
2564*67e74705SXin Li llvm::Type *VTableTy,
2565*67e74705SXin Li const CXXRecordDecl *RD) {
2566*67e74705SXin Li Address VTablePtrSrc = Builder.CreateElementBitCast(This, VTableTy);
2567*67e74705SXin Li llvm::Instruction *VTable = Builder.CreateLoad(VTablePtrSrc, "vtable");
2568*67e74705SXin Li CGM.DecorateInstructionWithTBAA(VTable, CGM.getTBAAInfoForVTablePtr());
2569*67e74705SXin Li
2570*67e74705SXin Li if (CGM.getCodeGenOpts().OptimizationLevel > 0 &&
2571*67e74705SXin Li CGM.getCodeGenOpts().StrictVTablePointers)
2572*67e74705SXin Li CGM.DecorateInstructionWithInvariantGroup(VTable, RD);
2573*67e74705SXin Li
2574*67e74705SXin Li return VTable;
2575*67e74705SXin Li }
2576*67e74705SXin Li
2577*67e74705SXin Li // If a class has a single non-virtual base and does not introduce or override
2578*67e74705SXin Li // virtual member functions or fields, it will have the same layout as its base.
2579*67e74705SXin Li // This function returns the least derived such class.
2580*67e74705SXin Li //
2581*67e74705SXin Li // Casting an instance of a base class to such a derived class is technically
2582*67e74705SXin Li // undefined behavior, but it is a relatively common hack for introducing member
2583*67e74705SXin Li // functions on class instances with specific properties (e.g. llvm::Operator)
2584*67e74705SXin Li // that works under most compilers and should not have security implications, so
2585*67e74705SXin Li // we allow it by default. It can be disabled with -fsanitize=cfi-cast-strict.
2586*67e74705SXin Li static const CXXRecordDecl *
LeastDerivedClassWithSameLayout(const CXXRecordDecl * RD)2587*67e74705SXin Li LeastDerivedClassWithSameLayout(const CXXRecordDecl *RD) {
2588*67e74705SXin Li if (!RD->field_empty())
2589*67e74705SXin Li return RD;
2590*67e74705SXin Li
2591*67e74705SXin Li if (RD->getNumVBases() != 0)
2592*67e74705SXin Li return RD;
2593*67e74705SXin Li
2594*67e74705SXin Li if (RD->getNumBases() != 1)
2595*67e74705SXin Li return RD;
2596*67e74705SXin Li
2597*67e74705SXin Li for (const CXXMethodDecl *MD : RD->methods()) {
2598*67e74705SXin Li if (MD->isVirtual()) {
2599*67e74705SXin Li // Virtual member functions are only ok if they are implicit destructors
2600*67e74705SXin Li // because the implicit destructor will have the same semantics as the
2601*67e74705SXin Li // base class's destructor if no fields are added.
2602*67e74705SXin Li if (isa<CXXDestructorDecl>(MD) && MD->isImplicit())
2603*67e74705SXin Li continue;
2604*67e74705SXin Li return RD;
2605*67e74705SXin Li }
2606*67e74705SXin Li }
2607*67e74705SXin Li
2608*67e74705SXin Li return LeastDerivedClassWithSameLayout(
2609*67e74705SXin Li RD->bases_begin()->getType()->getAsCXXRecordDecl());
2610*67e74705SXin Li }
2611*67e74705SXin Li
EmitTypeMetadataCodeForVCall(const CXXRecordDecl * RD,llvm::Value * VTable,SourceLocation Loc)2612*67e74705SXin Li void CodeGenFunction::EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
2613*67e74705SXin Li llvm::Value *VTable,
2614*67e74705SXin Li SourceLocation Loc) {
2615*67e74705SXin Li if (CGM.getCodeGenOpts().WholeProgramVTables &&
2616*67e74705SXin Li CGM.HasHiddenLTOVisibility(RD)) {
2617*67e74705SXin Li llvm::Metadata *MD =
2618*67e74705SXin Li CGM.CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
2619*67e74705SXin Li llvm::Value *TypeId =
2620*67e74705SXin Li llvm::MetadataAsValue::get(CGM.getLLVMContext(), MD);
2621*67e74705SXin Li
2622*67e74705SXin Li llvm::Value *CastedVTable = Builder.CreateBitCast(VTable, Int8PtrTy);
2623*67e74705SXin Li llvm::Value *TypeTest =
2624*67e74705SXin Li Builder.CreateCall(CGM.getIntrinsic(llvm::Intrinsic::type_test),
2625*67e74705SXin Li {CastedVTable, TypeId});
2626*67e74705SXin Li Builder.CreateCall(CGM.getIntrinsic(llvm::Intrinsic::assume), TypeTest);
2627*67e74705SXin Li }
2628*67e74705SXin Li
2629*67e74705SXin Li if (SanOpts.has(SanitizerKind::CFIVCall))
2630*67e74705SXin Li EmitVTablePtrCheckForCall(RD, VTable, CodeGenFunction::CFITCK_VCall, Loc);
2631*67e74705SXin Li }
2632*67e74705SXin Li
EmitVTablePtrCheckForCall(const CXXRecordDecl * RD,llvm::Value * VTable,CFITypeCheckKind TCK,SourceLocation Loc)2633*67e74705SXin Li void CodeGenFunction::EmitVTablePtrCheckForCall(const CXXRecordDecl *RD,
2634*67e74705SXin Li llvm::Value *VTable,
2635*67e74705SXin Li CFITypeCheckKind TCK,
2636*67e74705SXin Li SourceLocation Loc) {
2637*67e74705SXin Li if (!SanOpts.has(SanitizerKind::CFICastStrict))
2638*67e74705SXin Li RD = LeastDerivedClassWithSameLayout(RD);
2639*67e74705SXin Li
2640*67e74705SXin Li EmitVTablePtrCheck(RD, VTable, TCK, Loc);
2641*67e74705SXin Li }
2642*67e74705SXin Li
EmitVTablePtrCheckForCast(QualType T,llvm::Value * Derived,bool MayBeNull,CFITypeCheckKind TCK,SourceLocation Loc)2643*67e74705SXin Li void CodeGenFunction::EmitVTablePtrCheckForCast(QualType T,
2644*67e74705SXin Li llvm::Value *Derived,
2645*67e74705SXin Li bool MayBeNull,
2646*67e74705SXin Li CFITypeCheckKind TCK,
2647*67e74705SXin Li SourceLocation Loc) {
2648*67e74705SXin Li if (!getLangOpts().CPlusPlus)
2649*67e74705SXin Li return;
2650*67e74705SXin Li
2651*67e74705SXin Li auto *ClassTy = T->getAs<RecordType>();
2652*67e74705SXin Li if (!ClassTy)
2653*67e74705SXin Li return;
2654*67e74705SXin Li
2655*67e74705SXin Li const CXXRecordDecl *ClassDecl = cast<CXXRecordDecl>(ClassTy->getDecl());
2656*67e74705SXin Li
2657*67e74705SXin Li if (!ClassDecl->isCompleteDefinition() || !ClassDecl->isDynamicClass())
2658*67e74705SXin Li return;
2659*67e74705SXin Li
2660*67e74705SXin Li if (!SanOpts.has(SanitizerKind::CFICastStrict))
2661*67e74705SXin Li ClassDecl = LeastDerivedClassWithSameLayout(ClassDecl);
2662*67e74705SXin Li
2663*67e74705SXin Li llvm::BasicBlock *ContBlock = nullptr;
2664*67e74705SXin Li
2665*67e74705SXin Li if (MayBeNull) {
2666*67e74705SXin Li llvm::Value *DerivedNotNull =
2667*67e74705SXin Li Builder.CreateIsNotNull(Derived, "cast.nonnull");
2668*67e74705SXin Li
2669*67e74705SXin Li llvm::BasicBlock *CheckBlock = createBasicBlock("cast.check");
2670*67e74705SXin Li ContBlock = createBasicBlock("cast.cont");
2671*67e74705SXin Li
2672*67e74705SXin Li Builder.CreateCondBr(DerivedNotNull, CheckBlock, ContBlock);
2673*67e74705SXin Li
2674*67e74705SXin Li EmitBlock(CheckBlock);
2675*67e74705SXin Li }
2676*67e74705SXin Li
2677*67e74705SXin Li llvm::Value *VTable =
2678*67e74705SXin Li GetVTablePtr(Address(Derived, getPointerAlign()), Int8PtrTy, ClassDecl);
2679*67e74705SXin Li
2680*67e74705SXin Li EmitVTablePtrCheck(ClassDecl, VTable, TCK, Loc);
2681*67e74705SXin Li
2682*67e74705SXin Li if (MayBeNull) {
2683*67e74705SXin Li Builder.CreateBr(ContBlock);
2684*67e74705SXin Li EmitBlock(ContBlock);
2685*67e74705SXin Li }
2686*67e74705SXin Li }
2687*67e74705SXin Li
EmitVTablePtrCheck(const CXXRecordDecl * RD,llvm::Value * VTable,CFITypeCheckKind TCK,SourceLocation Loc)2688*67e74705SXin Li void CodeGenFunction::EmitVTablePtrCheck(const CXXRecordDecl *RD,
2689*67e74705SXin Li llvm::Value *VTable,
2690*67e74705SXin Li CFITypeCheckKind TCK,
2691*67e74705SXin Li SourceLocation Loc) {
2692*67e74705SXin Li if (!CGM.getCodeGenOpts().SanitizeCfiCrossDso &&
2693*67e74705SXin Li !CGM.HasHiddenLTOVisibility(RD))
2694*67e74705SXin Li return;
2695*67e74705SXin Li
2696*67e74705SXin Li std::string TypeName = RD->getQualifiedNameAsString();
2697*67e74705SXin Li if (getContext().getSanitizerBlacklist().isBlacklistedType(TypeName))
2698*67e74705SXin Li return;
2699*67e74705SXin Li
2700*67e74705SXin Li SanitizerScope SanScope(this);
2701*67e74705SXin Li llvm::SanitizerStatKind SSK;
2702*67e74705SXin Li switch (TCK) {
2703*67e74705SXin Li case CFITCK_VCall:
2704*67e74705SXin Li SSK = llvm::SanStat_CFI_VCall;
2705*67e74705SXin Li break;
2706*67e74705SXin Li case CFITCK_NVCall:
2707*67e74705SXin Li SSK = llvm::SanStat_CFI_NVCall;
2708*67e74705SXin Li break;
2709*67e74705SXin Li case CFITCK_DerivedCast:
2710*67e74705SXin Li SSK = llvm::SanStat_CFI_DerivedCast;
2711*67e74705SXin Li break;
2712*67e74705SXin Li case CFITCK_UnrelatedCast:
2713*67e74705SXin Li SSK = llvm::SanStat_CFI_UnrelatedCast;
2714*67e74705SXin Li break;
2715*67e74705SXin Li case CFITCK_ICall:
2716*67e74705SXin Li llvm_unreachable("not expecting CFITCK_ICall");
2717*67e74705SXin Li }
2718*67e74705SXin Li EmitSanitizerStatReport(SSK);
2719*67e74705SXin Li
2720*67e74705SXin Li llvm::Metadata *MD =
2721*67e74705SXin Li CGM.CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
2722*67e74705SXin Li llvm::Value *TypeId = llvm::MetadataAsValue::get(getLLVMContext(), MD);
2723*67e74705SXin Li
2724*67e74705SXin Li llvm::Value *CastedVTable = Builder.CreateBitCast(VTable, Int8PtrTy);
2725*67e74705SXin Li llvm::Value *TypeTest = Builder.CreateCall(
2726*67e74705SXin Li CGM.getIntrinsic(llvm::Intrinsic::type_test), {CastedVTable, TypeId});
2727*67e74705SXin Li
2728*67e74705SXin Li SanitizerMask M;
2729*67e74705SXin Li switch (TCK) {
2730*67e74705SXin Li case CFITCK_VCall:
2731*67e74705SXin Li M = SanitizerKind::CFIVCall;
2732*67e74705SXin Li break;
2733*67e74705SXin Li case CFITCK_NVCall:
2734*67e74705SXin Li M = SanitizerKind::CFINVCall;
2735*67e74705SXin Li break;
2736*67e74705SXin Li case CFITCK_DerivedCast:
2737*67e74705SXin Li M = SanitizerKind::CFIDerivedCast;
2738*67e74705SXin Li break;
2739*67e74705SXin Li case CFITCK_UnrelatedCast:
2740*67e74705SXin Li M = SanitizerKind::CFIUnrelatedCast;
2741*67e74705SXin Li break;
2742*67e74705SXin Li case CFITCK_ICall:
2743*67e74705SXin Li llvm_unreachable("not expecting CFITCK_ICall");
2744*67e74705SXin Li }
2745*67e74705SXin Li
2746*67e74705SXin Li llvm::Constant *StaticData[] = {
2747*67e74705SXin Li llvm::ConstantInt::get(Int8Ty, TCK),
2748*67e74705SXin Li EmitCheckSourceLocation(Loc),
2749*67e74705SXin Li EmitCheckTypeDescriptor(QualType(RD->getTypeForDecl(), 0)),
2750*67e74705SXin Li };
2751*67e74705SXin Li
2752*67e74705SXin Li auto CrossDsoTypeId = CGM.CreateCrossDsoCfiTypeId(MD);
2753*67e74705SXin Li if (CGM.getCodeGenOpts().SanitizeCfiCrossDso && CrossDsoTypeId) {
2754*67e74705SXin Li EmitCfiSlowPathCheck(M, TypeTest, CrossDsoTypeId, CastedVTable, StaticData);
2755*67e74705SXin Li return;
2756*67e74705SXin Li }
2757*67e74705SXin Li
2758*67e74705SXin Li if (CGM.getCodeGenOpts().SanitizeTrap.has(M)) {
2759*67e74705SXin Li EmitTrapCheck(TypeTest);
2760*67e74705SXin Li return;
2761*67e74705SXin Li }
2762*67e74705SXin Li
2763*67e74705SXin Li llvm::Value *AllVtables = llvm::MetadataAsValue::get(
2764*67e74705SXin Li CGM.getLLVMContext(),
2765*67e74705SXin Li llvm::MDString::get(CGM.getLLVMContext(), "all-vtables"));
2766*67e74705SXin Li llvm::Value *ValidVtable = Builder.CreateCall(
2767*67e74705SXin Li CGM.getIntrinsic(llvm::Intrinsic::type_test), {CastedVTable, AllVtables});
2768*67e74705SXin Li EmitCheck(std::make_pair(TypeTest, M), "cfi_check_fail", StaticData,
2769*67e74705SXin Li {CastedVTable, ValidVtable});
2770*67e74705SXin Li }
2771*67e74705SXin Li
ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl * RD)2772*67e74705SXin Li bool CodeGenFunction::ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD) {
2773*67e74705SXin Li if (!CGM.getCodeGenOpts().WholeProgramVTables ||
2774*67e74705SXin Li !SanOpts.has(SanitizerKind::CFIVCall) ||
2775*67e74705SXin Li !CGM.getCodeGenOpts().SanitizeTrap.has(SanitizerKind::CFIVCall) ||
2776*67e74705SXin Li !CGM.HasHiddenLTOVisibility(RD))
2777*67e74705SXin Li return false;
2778*67e74705SXin Li
2779*67e74705SXin Li std::string TypeName = RD->getQualifiedNameAsString();
2780*67e74705SXin Li return !getContext().getSanitizerBlacklist().isBlacklistedType(TypeName);
2781*67e74705SXin Li }
2782*67e74705SXin Li
EmitVTableTypeCheckedLoad(const CXXRecordDecl * RD,llvm::Value * VTable,uint64_t VTableByteOffset)2783*67e74705SXin Li llvm::Value *CodeGenFunction::EmitVTableTypeCheckedLoad(
2784*67e74705SXin Li const CXXRecordDecl *RD, llvm::Value *VTable, uint64_t VTableByteOffset) {
2785*67e74705SXin Li SanitizerScope SanScope(this);
2786*67e74705SXin Li
2787*67e74705SXin Li EmitSanitizerStatReport(llvm::SanStat_CFI_VCall);
2788*67e74705SXin Li
2789*67e74705SXin Li llvm::Metadata *MD =
2790*67e74705SXin Li CGM.CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
2791*67e74705SXin Li llvm::Value *TypeId = llvm::MetadataAsValue::get(CGM.getLLVMContext(), MD);
2792*67e74705SXin Li
2793*67e74705SXin Li llvm::Value *CastedVTable = Builder.CreateBitCast(VTable, Int8PtrTy);
2794*67e74705SXin Li llvm::Value *CheckedLoad = Builder.CreateCall(
2795*67e74705SXin Li CGM.getIntrinsic(llvm::Intrinsic::type_checked_load),
2796*67e74705SXin Li {CastedVTable, llvm::ConstantInt::get(Int32Ty, VTableByteOffset),
2797*67e74705SXin Li TypeId});
2798*67e74705SXin Li llvm::Value *CheckResult = Builder.CreateExtractValue(CheckedLoad, 1);
2799*67e74705SXin Li
2800*67e74705SXin Li EmitCheck(std::make_pair(CheckResult, SanitizerKind::CFIVCall),
2801*67e74705SXin Li "cfi_check_fail", nullptr, nullptr);
2802*67e74705SXin Li
2803*67e74705SXin Li return Builder.CreateBitCast(
2804*67e74705SXin Li Builder.CreateExtractValue(CheckedLoad, 0),
2805*67e74705SXin Li cast<llvm::PointerType>(VTable->getType())->getElementType());
2806*67e74705SXin Li }
2807*67e74705SXin Li
2808*67e74705SXin Li // FIXME: Ideally Expr::IgnoreParenNoopCasts should do this, but it doesn't do
2809*67e74705SXin Li // quite what we want.
skipNoOpCastsAndParens(const Expr * E)2810*67e74705SXin Li static const Expr *skipNoOpCastsAndParens(const Expr *E) {
2811*67e74705SXin Li while (true) {
2812*67e74705SXin Li if (const ParenExpr *PE = dyn_cast<ParenExpr>(E)) {
2813*67e74705SXin Li E = PE->getSubExpr();
2814*67e74705SXin Li continue;
2815*67e74705SXin Li }
2816*67e74705SXin Li
2817*67e74705SXin Li if (const CastExpr *CE = dyn_cast<CastExpr>(E)) {
2818*67e74705SXin Li if (CE->getCastKind() == CK_NoOp) {
2819*67e74705SXin Li E = CE->getSubExpr();
2820*67e74705SXin Li continue;
2821*67e74705SXin Li }
2822*67e74705SXin Li }
2823*67e74705SXin Li if (const UnaryOperator *UO = dyn_cast<UnaryOperator>(E)) {
2824*67e74705SXin Li if (UO->getOpcode() == UO_Extension) {
2825*67e74705SXin Li E = UO->getSubExpr();
2826*67e74705SXin Li continue;
2827*67e74705SXin Li }
2828*67e74705SXin Li }
2829*67e74705SXin Li return E;
2830*67e74705SXin Li }
2831*67e74705SXin Li }
2832*67e74705SXin Li
2833*67e74705SXin Li bool
CanDevirtualizeMemberFunctionCall(const Expr * Base,const CXXMethodDecl * MD)2834*67e74705SXin Li CodeGenFunction::CanDevirtualizeMemberFunctionCall(const Expr *Base,
2835*67e74705SXin Li const CXXMethodDecl *MD) {
2836*67e74705SXin Li // When building with -fapple-kext, all calls must go through the vtable since
2837*67e74705SXin Li // the kernel linker can do runtime patching of vtables.
2838*67e74705SXin Li if (getLangOpts().AppleKext)
2839*67e74705SXin Li return false;
2840*67e74705SXin Li
2841*67e74705SXin Li // If the most derived class is marked final, we know that no subclass can
2842*67e74705SXin Li // override this member function and so we can devirtualize it. For example:
2843*67e74705SXin Li //
2844*67e74705SXin Li // struct A { virtual void f(); }
2845*67e74705SXin Li // struct B final : A { };
2846*67e74705SXin Li //
2847*67e74705SXin Li // void f(B *b) {
2848*67e74705SXin Li // b->f();
2849*67e74705SXin Li // }
2850*67e74705SXin Li //
2851*67e74705SXin Li const CXXRecordDecl *MostDerivedClassDecl = Base->getBestDynamicClassType();
2852*67e74705SXin Li if (MostDerivedClassDecl->hasAttr<FinalAttr>())
2853*67e74705SXin Li return true;
2854*67e74705SXin Li
2855*67e74705SXin Li // If the member function is marked 'final', we know that it can't be
2856*67e74705SXin Li // overridden and can therefore devirtualize it.
2857*67e74705SXin Li if (MD->hasAttr<FinalAttr>())
2858*67e74705SXin Li return true;
2859*67e74705SXin Li
2860*67e74705SXin Li // Similarly, if the class itself is marked 'final' it can't be overridden
2861*67e74705SXin Li // and we can therefore devirtualize the member function call.
2862*67e74705SXin Li if (MD->getParent()->hasAttr<FinalAttr>())
2863*67e74705SXin Li return true;
2864*67e74705SXin Li
2865*67e74705SXin Li Base = skipNoOpCastsAndParens(Base);
2866*67e74705SXin Li if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Base)) {
2867*67e74705SXin Li if (const VarDecl *VD = dyn_cast<VarDecl>(DRE->getDecl())) {
2868*67e74705SXin Li // This is a record decl. We know the type and can devirtualize it.
2869*67e74705SXin Li return VD->getType()->isRecordType();
2870*67e74705SXin Li }
2871*67e74705SXin Li
2872*67e74705SXin Li return false;
2873*67e74705SXin Li }
2874*67e74705SXin Li
2875*67e74705SXin Li // We can devirtualize calls on an object accessed by a class member access
2876*67e74705SXin Li // expression, since by C++11 [basic.life]p6 we know that it can't refer to
2877*67e74705SXin Li // a derived class object constructed in the same location.
2878*67e74705SXin Li if (const MemberExpr *ME = dyn_cast<MemberExpr>(Base))
2879*67e74705SXin Li if (const ValueDecl *VD = dyn_cast<ValueDecl>(ME->getMemberDecl()))
2880*67e74705SXin Li return VD->getType()->isRecordType();
2881*67e74705SXin Li
2882*67e74705SXin Li // We can always devirtualize calls on temporary object expressions.
2883*67e74705SXin Li if (isa<CXXConstructExpr>(Base))
2884*67e74705SXin Li return true;
2885*67e74705SXin Li
2886*67e74705SXin Li // And calls on bound temporaries.
2887*67e74705SXin Li if (isa<CXXBindTemporaryExpr>(Base))
2888*67e74705SXin Li return true;
2889*67e74705SXin Li
2890*67e74705SXin Li // Check if this is a call expr that returns a record type.
2891*67e74705SXin Li if (const CallExpr *CE = dyn_cast<CallExpr>(Base))
2892*67e74705SXin Li return CE->getCallReturnType(getContext())->isRecordType();
2893*67e74705SXin Li
2894*67e74705SXin Li // We can't devirtualize the call.
2895*67e74705SXin Li return false;
2896*67e74705SXin Li }
2897*67e74705SXin Li
EmitForwardingCallToLambda(const CXXMethodDecl * callOperator,CallArgList & callArgs)2898*67e74705SXin Li void CodeGenFunction::EmitForwardingCallToLambda(
2899*67e74705SXin Li const CXXMethodDecl *callOperator,
2900*67e74705SXin Li CallArgList &callArgs) {
2901*67e74705SXin Li // Get the address of the call operator.
2902*67e74705SXin Li const CGFunctionInfo &calleeFnInfo =
2903*67e74705SXin Li CGM.getTypes().arrangeCXXMethodDeclaration(callOperator);
2904*67e74705SXin Li llvm::Value *callee =
2905*67e74705SXin Li CGM.GetAddrOfFunction(GlobalDecl(callOperator),
2906*67e74705SXin Li CGM.getTypes().GetFunctionType(calleeFnInfo));
2907*67e74705SXin Li
2908*67e74705SXin Li // Prepare the return slot.
2909*67e74705SXin Li const FunctionProtoType *FPT =
2910*67e74705SXin Li callOperator->getType()->castAs<FunctionProtoType>();
2911*67e74705SXin Li QualType resultType = FPT->getReturnType();
2912*67e74705SXin Li ReturnValueSlot returnSlot;
2913*67e74705SXin Li if (!resultType->isVoidType() &&
2914*67e74705SXin Li calleeFnInfo.getReturnInfo().getKind() == ABIArgInfo::Indirect &&
2915*67e74705SXin Li !hasScalarEvaluationKind(calleeFnInfo.getReturnType()))
2916*67e74705SXin Li returnSlot = ReturnValueSlot(ReturnValue, resultType.isVolatileQualified());
2917*67e74705SXin Li
2918*67e74705SXin Li // We don't need to separately arrange the call arguments because
2919*67e74705SXin Li // the call can't be variadic anyway --- it's impossible to forward
2920*67e74705SXin Li // variadic arguments.
2921*67e74705SXin Li
2922*67e74705SXin Li // Now emit our call.
2923*67e74705SXin Li RValue RV = EmitCall(calleeFnInfo, callee, returnSlot,
2924*67e74705SXin Li callArgs, callOperator);
2925*67e74705SXin Li
2926*67e74705SXin Li // If necessary, copy the returned value into the slot.
2927*67e74705SXin Li if (!resultType->isVoidType() && returnSlot.isNull())
2928*67e74705SXin Li EmitReturnOfRValue(RV, resultType);
2929*67e74705SXin Li else
2930*67e74705SXin Li EmitBranchThroughCleanup(ReturnBlock);
2931*67e74705SXin Li }
2932*67e74705SXin Li
EmitLambdaBlockInvokeBody()2933*67e74705SXin Li void CodeGenFunction::EmitLambdaBlockInvokeBody() {
2934*67e74705SXin Li const BlockDecl *BD = BlockInfo->getBlockDecl();
2935*67e74705SXin Li const VarDecl *variable = BD->capture_begin()->getVariable();
2936*67e74705SXin Li const CXXRecordDecl *Lambda = variable->getType()->getAsCXXRecordDecl();
2937*67e74705SXin Li
2938*67e74705SXin Li // Start building arguments for forwarding call
2939*67e74705SXin Li CallArgList CallArgs;
2940*67e74705SXin Li
2941*67e74705SXin Li QualType ThisType = getContext().getPointerType(getContext().getRecordType(Lambda));
2942*67e74705SXin Li Address ThisPtr = GetAddrOfBlockDecl(variable, false);
2943*67e74705SXin Li CallArgs.add(RValue::get(ThisPtr.getPointer()), ThisType);
2944*67e74705SXin Li
2945*67e74705SXin Li // Add the rest of the parameters.
2946*67e74705SXin Li for (auto param : BD->parameters())
2947*67e74705SXin Li EmitDelegateCallArg(CallArgs, param, param->getLocStart());
2948*67e74705SXin Li
2949*67e74705SXin Li assert(!Lambda->isGenericLambda() &&
2950*67e74705SXin Li "generic lambda interconversion to block not implemented");
2951*67e74705SXin Li EmitForwardingCallToLambda(Lambda->getLambdaCallOperator(), CallArgs);
2952*67e74705SXin Li }
2953*67e74705SXin Li
EmitLambdaToBlockPointerBody(FunctionArgList & Args)2954*67e74705SXin Li void CodeGenFunction::EmitLambdaToBlockPointerBody(FunctionArgList &Args) {
2955*67e74705SXin Li if (cast<CXXMethodDecl>(CurCodeDecl)->isVariadic()) {
2956*67e74705SXin Li // FIXME: Making this work correctly is nasty because it requires either
2957*67e74705SXin Li // cloning the body of the call operator or making the call operator forward.
2958*67e74705SXin Li CGM.ErrorUnsupported(CurCodeDecl, "lambda conversion to variadic function");
2959*67e74705SXin Li return;
2960*67e74705SXin Li }
2961*67e74705SXin Li
2962*67e74705SXin Li EmitFunctionBody(Args, cast<FunctionDecl>(CurGD.getDecl())->getBody());
2963*67e74705SXin Li }
2964*67e74705SXin Li
EmitLambdaDelegatingInvokeBody(const CXXMethodDecl * MD)2965*67e74705SXin Li void CodeGenFunction::EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD) {
2966*67e74705SXin Li const CXXRecordDecl *Lambda = MD->getParent();
2967*67e74705SXin Li
2968*67e74705SXin Li // Start building arguments for forwarding call
2969*67e74705SXin Li CallArgList CallArgs;
2970*67e74705SXin Li
2971*67e74705SXin Li QualType ThisType = getContext().getPointerType(getContext().getRecordType(Lambda));
2972*67e74705SXin Li llvm::Value *ThisPtr = llvm::UndefValue::get(getTypes().ConvertType(ThisType));
2973*67e74705SXin Li CallArgs.add(RValue::get(ThisPtr), ThisType);
2974*67e74705SXin Li
2975*67e74705SXin Li // Add the rest of the parameters.
2976*67e74705SXin Li for (auto Param : MD->parameters())
2977*67e74705SXin Li EmitDelegateCallArg(CallArgs, Param, Param->getLocStart());
2978*67e74705SXin Li
2979*67e74705SXin Li const CXXMethodDecl *CallOp = Lambda->getLambdaCallOperator();
2980*67e74705SXin Li // For a generic lambda, find the corresponding call operator specialization
2981*67e74705SXin Li // to which the call to the static-invoker shall be forwarded.
2982*67e74705SXin Li if (Lambda->isGenericLambda()) {
2983*67e74705SXin Li assert(MD->isFunctionTemplateSpecialization());
2984*67e74705SXin Li const TemplateArgumentList *TAL = MD->getTemplateSpecializationArgs();
2985*67e74705SXin Li FunctionTemplateDecl *CallOpTemplate = CallOp->getDescribedFunctionTemplate();
2986*67e74705SXin Li void *InsertPos = nullptr;
2987*67e74705SXin Li FunctionDecl *CorrespondingCallOpSpecialization =
2988*67e74705SXin Li CallOpTemplate->findSpecialization(TAL->asArray(), InsertPos);
2989*67e74705SXin Li assert(CorrespondingCallOpSpecialization);
2990*67e74705SXin Li CallOp = cast<CXXMethodDecl>(CorrespondingCallOpSpecialization);
2991*67e74705SXin Li }
2992*67e74705SXin Li EmitForwardingCallToLambda(CallOp, CallArgs);
2993*67e74705SXin Li }
2994*67e74705SXin Li
EmitLambdaStaticInvokeFunction(const CXXMethodDecl * MD)2995*67e74705SXin Li void CodeGenFunction::EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD) {
2996*67e74705SXin Li if (MD->isVariadic()) {
2997*67e74705SXin Li // FIXME: Making this work correctly is nasty because it requires either
2998*67e74705SXin Li // cloning the body of the call operator or making the call operator forward.
2999*67e74705SXin Li CGM.ErrorUnsupported(MD, "lambda conversion to variadic function");
3000*67e74705SXin Li return;
3001*67e74705SXin Li }
3002*67e74705SXin Li
3003*67e74705SXin Li EmitLambdaDelegatingInvokeBody(MD);
3004*67e74705SXin Li }
3005