blob: 635824e950352036996d0d6345affd3fa36cbfb1 [file] [log] [blame]
Hans Wennborgdcfba332015-10-06 23:40:43 +00001//===--- CGClass.cpp - Emit LLVM Code for C++ classes -----------*- C++ -*-===//
Anders Carlsson9a57c5a2009-09-12 04:27:24 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This contains code dealing with C++ code generation of classes
11//
12//===----------------------------------------------------------------------===//
13
Eli Friedman2495ab02012-02-25 02:48:22 +000014#include "CGBlocks.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000015#include "CGCXXABI.h"
Devang Pateld76c1db2010-08-11 21:04:37 +000016#include "CGDebugInfo.h"
Lang Hamesbf122742013-02-17 07:22:09 +000017#include "CGRecordLayout.h"
Anders Carlsson9a57c5a2009-09-12 04:27:24 +000018#include "CodeGenFunction.h"
Anders Carlssonc6d171e2009-10-06 22:43:30 +000019#include "clang/AST/CXXInheritance.h"
Faisal Vali571df122013-09-29 08:45:24 +000020#include "clang/AST/DeclTemplate.h"
John McCall769250e2010-09-17 02:31:44 +000021#include "clang/AST/EvaluatedExprVisitor.h"
Anders Carlsson9a57c5a2009-09-12 04:27:24 +000022#include "clang/AST/RecordLayout.h"
John McCallb81884d2010-02-19 09:25:03 +000023#include "clang/AST/StmtCXX.h"
Lang Hamesbf122742013-02-17 07:22:09 +000024#include "clang/Basic/TargetBuiltins.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000025#include "clang/CodeGen/CGFunctionInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000026#include "clang/Frontend/CodeGenOptions.h"
Peter Collingbournea4ccff32015-02-20 20:30:56 +000027#include "llvm/IR/Intrinsics.h"
Piotr Padlewski4b1ac722015-09-15 21:46:55 +000028#include "llvm/IR/Metadata.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000029#include "llvm/Transforms/Utils/SanitizerStats.h"
Anders Carlssonc6d171e2009-10-06 22:43:30 +000030
Anders Carlsson9a57c5a2009-09-12 04:27:24 +000031using namespace clang;
32using namespace CodeGen;
33
John McCall7f416cc2015-09-08 08:05:57 +000034/// Return the best known alignment for an unknown pointer to a
35/// particular class.
36CharUnits CodeGenModule::getClassPointerAlignment(const CXXRecordDecl *RD) {
37 if (!RD->isCompleteDefinition())
38 return CharUnits::One(); // Hopefully won't be used anywhere.
39
40 auto &layout = getContext().getASTRecordLayout(RD);
41
42 // If the class is final, then we know that the pointer points to an
43 // object of that type and can use the full alignment.
44 if (RD->hasAttr<FinalAttr>()) {
45 return layout.getAlignment();
46
47 // Otherwise, we have to assume it could be a subclass.
48 } else {
49 return layout.getNonVirtualAlignment();
50 }
51}
52
53/// Return the best known alignment for a pointer to a virtual base,
54/// given the alignment of a pointer to the derived class.
55CharUnits CodeGenModule::getVBaseAlignment(CharUnits actualDerivedAlign,
56 const CXXRecordDecl *derivedClass,
57 const CXXRecordDecl *vbaseClass) {
58 // The basic idea here is that an underaligned derived pointer might
59 // indicate an underaligned base pointer.
60
61 assert(vbaseClass->isCompleteDefinition());
62 auto &baseLayout = getContext().getASTRecordLayout(vbaseClass);
63 CharUnits expectedVBaseAlign = baseLayout.getNonVirtualAlignment();
64
65 return getDynamicOffsetAlignment(actualDerivedAlign, derivedClass,
66 expectedVBaseAlign);
67}
68
69CharUnits
70CodeGenModule::getDynamicOffsetAlignment(CharUnits actualBaseAlign,
71 const CXXRecordDecl *baseDecl,
72 CharUnits expectedTargetAlign) {
73 // If the base is an incomplete type (which is, alas, possible with
74 // member pointers), be pessimistic.
75 if (!baseDecl->isCompleteDefinition())
76 return std::min(actualBaseAlign, expectedTargetAlign);
77
78 auto &baseLayout = getContext().getASTRecordLayout(baseDecl);
79 CharUnits expectedBaseAlign = baseLayout.getNonVirtualAlignment();
80
81 // If the class is properly aligned, assume the target offset is, too.
82 //
83 // This actually isn't necessarily the right thing to do --- if the
84 // class is a complete object, but it's only properly aligned for a
85 // base subobject, then the alignments of things relative to it are
86 // probably off as well. (Note that this requires the alignment of
87 // the target to be greater than the NV alignment of the derived
88 // class.)
89 //
90 // However, our approach to this kind of under-alignment can only
91 // ever be best effort; after all, we're never going to propagate
92 // alignments through variables or parameters. Note, in particular,
93 // that constructing a polymorphic type in an address that's less
94 // than pointer-aligned will generally trap in the constructor,
95 // unless we someday add some sort of attribute to change the
96 // assumed alignment of 'this'. So our goal here is pretty much
97 // just to allow the user to explicitly say that a pointer is
Eric Christopherd160c502016-01-29 01:35:53 +000098 // under-aligned and then safely access its fields and vtables.
John McCall7f416cc2015-09-08 08:05:57 +000099 if (actualBaseAlign >= expectedBaseAlign) {
100 return expectedTargetAlign;
101 }
102
103 // Otherwise, we might be offset by an arbitrary multiple of the
104 // actual alignment. The correct adjustment is to take the min of
105 // the two alignments.
106 return std::min(actualBaseAlign, expectedTargetAlign);
107}
108
109Address CodeGenFunction::LoadCXXThisAddress() {
110 assert(CurFuncDecl && "loading 'this' without a func declaration?");
111 assert(isa<CXXMethodDecl>(CurFuncDecl));
112
113 // Lazily compute CXXThisAlignment.
114 if (CXXThisAlignment.isZero()) {
115 // Just use the best known alignment for the parent.
116 // TODO: if we're currently emitting a complete-object ctor/dtor,
117 // we can always use the complete-object alignment.
118 auto RD = cast<CXXMethodDecl>(CurFuncDecl)->getParent();
119 CXXThisAlignment = CGM.getClassPointerAlignment(RD);
120 }
121
122 return Address(LoadCXXThis(), CXXThisAlignment);
123}
124
125/// Emit the address of a field using a member data pointer.
126///
127/// \param E Only used for emergency diagnostics
128Address
129CodeGenFunction::EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
130 llvm::Value *memberPtr,
131 const MemberPointerType *memberPtrType,
132 AlignmentSource *alignSource) {
133 // Ask the ABI to compute the actual address.
134 llvm::Value *ptr =
135 CGM.getCXXABI().EmitMemberDataPointerAddress(*this, E, base,
136 memberPtr, memberPtrType);
137
138 QualType memberType = memberPtrType->getPointeeType();
139 CharUnits memberAlign = getNaturalTypeAlignment(memberType, alignSource);
140 memberAlign =
141 CGM.getDynamicOffsetAlignment(base.getAlignment(),
142 memberPtrType->getClass()->getAsCXXRecordDecl(),
143 memberAlign);
144 return Address(ptr, memberAlign);
145}
146
David Majnemerc1709d32015-06-23 07:31:11 +0000147CharUnits CodeGenModule::computeNonVirtualBaseClassOffset(
148 const CXXRecordDecl *DerivedClass, CastExpr::path_const_iterator Start,
149 CastExpr::path_const_iterator End) {
Ken Dycka1a4ae32011-03-22 00:53:26 +0000150 CharUnits Offset = CharUnits::Zero();
Justin Bogner1cd11f12015-05-20 15:53:59 +0000151
David Majnemerc1709d32015-06-23 07:31:11 +0000152 const ASTContext &Context = getContext();
Anders Carlssond829a022010-04-24 21:06:20 +0000153 const CXXRecordDecl *RD = DerivedClass;
Justin Bogner1cd11f12015-05-20 15:53:59 +0000154
John McCallcf142162010-08-07 06:22:56 +0000155 for (CastExpr::path_const_iterator I = Start; I != End; ++I) {
Anders Carlssond829a022010-04-24 21:06:20 +0000156 const CXXBaseSpecifier *Base = *I;
157 assert(!Base->isVirtual() && "Should not see virtual bases here!");
158
159 // Get the layout.
160 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000161
162 const CXXRecordDecl *BaseDecl =
Anders Carlssond829a022010-04-24 21:06:20 +0000163 cast<CXXRecordDecl>(Base->getType()->getAs<RecordType>()->getDecl());
Justin Bogner1cd11f12015-05-20 15:53:59 +0000164
Anders Carlssond829a022010-04-24 21:06:20 +0000165 // Add the offset.
Ken Dycka1a4ae32011-03-22 00:53:26 +0000166 Offset += Layout.getBaseClassOffset(BaseDecl);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000167
Anders Carlssond829a022010-04-24 21:06:20 +0000168 RD = BaseDecl;
169 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000170
Ken Dycka1a4ae32011-03-22 00:53:26 +0000171 return Offset;
Anders Carlssond829a022010-04-24 21:06:20 +0000172}
Anders Carlsson9a57c5a2009-09-12 04:27:24 +0000173
Anders Carlsson9150a2a2009-09-29 03:13:20 +0000174llvm::Constant *
Anders Carlsson8a64c1c2010-04-24 21:23:59 +0000175CodeGenModule::GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl,
John McCallcf142162010-08-07 06:22:56 +0000176 CastExpr::path_const_iterator PathBegin,
177 CastExpr::path_const_iterator PathEnd) {
178 assert(PathBegin != PathEnd && "Base path should not be empty!");
Anders Carlsson8a64c1c2010-04-24 21:23:59 +0000179
Justin Bogner1cd11f12015-05-20 15:53:59 +0000180 CharUnits Offset =
David Majnemerc1709d32015-06-23 07:31:11 +0000181 computeNonVirtualBaseClassOffset(ClassDecl, PathBegin, PathEnd);
Ken Dycka1a4ae32011-03-22 00:53:26 +0000182 if (Offset.isZero())
Craig Topper8a13c412014-05-21 05:09:00 +0000183 return nullptr;
184
Justin Bogner1cd11f12015-05-20 15:53:59 +0000185 llvm::Type *PtrDiffTy =
Anders Carlsson8a64c1c2010-04-24 21:23:59 +0000186 Types.ConvertType(getContext().getPointerDiffType());
Justin Bogner1cd11f12015-05-20 15:53:59 +0000187
Ken Dycka1a4ae32011-03-22 00:53:26 +0000188 return llvm::ConstantInt::get(PtrDiffTy, Offset.getQuantity());
Anders Carlsson9150a2a2009-09-29 03:13:20 +0000189}
190
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +0000191/// Gets the address of a direct base class within a complete object.
John McCall6ce74722010-02-16 04:15:37 +0000192/// This should only be used for (1) non-virtual bases or (2) virtual bases
193/// when the type is known to be complete (e.g. in complete destructors).
194///
195/// The object pointed to by 'This' is assumed to be non-null.
John McCall7f416cc2015-09-08 08:05:57 +0000196Address
197CodeGenFunction::GetAddressOfDirectBaseInCompleteClass(Address This,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +0000198 const CXXRecordDecl *Derived,
199 const CXXRecordDecl *Base,
200 bool BaseIsVirtual) {
John McCall6ce74722010-02-16 04:15:37 +0000201 // 'this' must be a pointer (in some address space) to Derived.
John McCall7f416cc2015-09-08 08:05:57 +0000202 assert(This.getElementType() == ConvertType(Derived));
John McCall6ce74722010-02-16 04:15:37 +0000203
204 // Compute the offset of the virtual base.
Ken Dyck6aa767c2011-03-22 01:21:15 +0000205 CharUnits Offset;
John McCall6ce74722010-02-16 04:15:37 +0000206 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(Derived);
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +0000207 if (BaseIsVirtual)
Ken Dyck6aa767c2011-03-22 01:21:15 +0000208 Offset = Layout.getVBaseClassOffset(Base);
John McCall6ce74722010-02-16 04:15:37 +0000209 else
Ken Dyck6aa767c2011-03-22 01:21:15 +0000210 Offset = Layout.getBaseClassOffset(Base);
John McCall6ce74722010-02-16 04:15:37 +0000211
212 // Shift and cast down to the base type.
213 // TODO: for complete types, this should be possible with a GEP.
John McCall7f416cc2015-09-08 08:05:57 +0000214 Address V = This;
215 if (!Offset.isZero()) {
216 V = Builder.CreateElementBitCast(V, Int8Ty);
217 V = Builder.CreateConstInBoundsByteGEP(V, Offset);
John McCall6ce74722010-02-16 04:15:37 +0000218 }
John McCall7f416cc2015-09-08 08:05:57 +0000219 V = Builder.CreateElementBitCast(V, ConvertType(Base));
John McCall6ce74722010-02-16 04:15:37 +0000220
221 return V;
Anders Carlssone87fae92010-03-28 19:40:00 +0000222}
John McCall6ce74722010-02-16 04:15:37 +0000223
John McCall7f416cc2015-09-08 08:05:57 +0000224static Address
225ApplyNonVirtualAndVirtualOffset(CodeGenFunction &CGF, Address addr,
John McCall13a39c62012-08-01 05:04:58 +0000226 CharUnits nonVirtualOffset,
John McCall7f416cc2015-09-08 08:05:57 +0000227 llvm::Value *virtualOffset,
228 const CXXRecordDecl *derivedClass,
229 const CXXRecordDecl *nearestVBase) {
John McCall13a39c62012-08-01 05:04:58 +0000230 // Assert that we have something to do.
Craig Topper8a13c412014-05-21 05:09:00 +0000231 assert(!nonVirtualOffset.isZero() || virtualOffset != nullptr);
John McCall13a39c62012-08-01 05:04:58 +0000232
233 // Compute the offset from the static and dynamic components.
234 llvm::Value *baseOffset;
235 if (!nonVirtualOffset.isZero()) {
236 baseOffset = llvm::ConstantInt::get(CGF.PtrDiffTy,
237 nonVirtualOffset.getQuantity());
238 if (virtualOffset) {
239 baseOffset = CGF.Builder.CreateAdd(virtualOffset, baseOffset);
240 }
241 } else {
242 baseOffset = virtualOffset;
243 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000244
Anders Carlsson53cebd12010-04-20 16:03:35 +0000245 // Apply the base offset.
John McCall7f416cc2015-09-08 08:05:57 +0000246 llvm::Value *ptr = addr.getPointer();
John McCall13a39c62012-08-01 05:04:58 +0000247 ptr = CGF.Builder.CreateBitCast(ptr, CGF.Int8PtrTy);
248 ptr = CGF.Builder.CreateInBoundsGEP(ptr, baseOffset, "add.ptr");
John McCall7f416cc2015-09-08 08:05:57 +0000249
250 // If we have a virtual component, the alignment of the result will
251 // be relative only to the known alignment of that vbase.
252 CharUnits alignment;
253 if (virtualOffset) {
254 assert(nearestVBase && "virtual offset without vbase?");
255 alignment = CGF.CGM.getVBaseAlignment(addr.getAlignment(),
256 derivedClass, nearestVBase);
257 } else {
258 alignment = addr.getAlignment();
259 }
260 alignment = alignment.alignmentAtOffset(nonVirtualOffset);
261
262 return Address(ptr, alignment);
Anders Carlsson53cebd12010-04-20 16:03:35 +0000263}
264
John McCall7f416cc2015-09-08 08:05:57 +0000265Address CodeGenFunction::GetAddressOfBaseClass(
266 Address Value, const CXXRecordDecl *Derived,
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000267 CastExpr::path_const_iterator PathBegin,
268 CastExpr::path_const_iterator PathEnd, bool NullCheckValue,
269 SourceLocation Loc) {
John McCallcf142162010-08-07 06:22:56 +0000270 assert(PathBegin != PathEnd && "Base path should not be empty!");
Anders Carlssond829a022010-04-24 21:06:20 +0000271
John McCallcf142162010-08-07 06:22:56 +0000272 CastExpr::path_const_iterator Start = PathBegin;
Craig Topper8a13c412014-05-21 05:09:00 +0000273 const CXXRecordDecl *VBase = nullptr;
274
John McCall13a39c62012-08-01 05:04:58 +0000275 // Sema has done some convenient canonicalization here: if the
276 // access path involved any virtual steps, the conversion path will
277 // *start* with a step down to the correct virtual base subobject,
278 // and hence will not require any further steps.
Anders Carlssond829a022010-04-24 21:06:20 +0000279 if ((*Start)->isVirtual()) {
Justin Bogner1cd11f12015-05-20 15:53:59 +0000280 VBase =
Anders Carlssond829a022010-04-24 21:06:20 +0000281 cast<CXXRecordDecl>((*Start)->getType()->getAs<RecordType>()->getDecl());
282 ++Start;
283 }
John McCall13a39c62012-08-01 05:04:58 +0000284
285 // Compute the static offset of the ultimate destination within its
286 // allocating subobject (the virtual base, if there is one, or else
287 // the "complete" object that we see).
David Majnemerc1709d32015-06-23 07:31:11 +0000288 CharUnits NonVirtualOffset = CGM.computeNonVirtualBaseClassOffset(
289 VBase ? VBase : Derived, Start, PathEnd);
Anders Carlssond829a022010-04-24 21:06:20 +0000290
John McCall13a39c62012-08-01 05:04:58 +0000291 // If there's a virtual step, we can sometimes "devirtualize" it.
292 // For now, that's limited to when the derived type is final.
293 // TODO: "devirtualize" this for accesses to known-complete objects.
294 if (VBase && Derived->hasAttr<FinalAttr>()) {
295 const ASTRecordLayout &layout = getContext().getASTRecordLayout(Derived);
296 CharUnits vBaseOffset = layout.getVBaseClassOffset(VBase);
297 NonVirtualOffset += vBaseOffset;
Craig Topper8a13c412014-05-21 05:09:00 +0000298 VBase = nullptr; // we no longer have a virtual step
John McCall13a39c62012-08-01 05:04:58 +0000299 }
300
Anders Carlssond829a022010-04-24 21:06:20 +0000301 // Get the base pointer type.
Justin Bogner1cd11f12015-05-20 15:53:59 +0000302 llvm::Type *BasePtrTy =
John McCallcf142162010-08-07 06:22:56 +0000303 ConvertType((PathEnd[-1])->getType())->getPointerTo();
John McCall13a39c62012-08-01 05:04:58 +0000304
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000305 QualType DerivedTy = getContext().getRecordType(Derived);
John McCall7f416cc2015-09-08 08:05:57 +0000306 CharUnits DerivedAlign = CGM.getClassPointerAlignment(Derived);
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000307
John McCall13a39c62012-08-01 05:04:58 +0000308 // If the static offset is zero and we don't have a virtual step,
309 // just do a bitcast; null checks are unnecessary.
Ken Dycka1a4ae32011-03-22 00:53:26 +0000310 if (NonVirtualOffset.isZero() && !VBase) {
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000311 if (sanitizePerformTypeCheck()) {
John McCall7f416cc2015-09-08 08:05:57 +0000312 EmitTypeCheck(TCK_Upcast, Loc, Value.getPointer(),
313 DerivedTy, DerivedAlign, !NullCheckValue);
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000314 }
Anders Carlssond829a022010-04-24 21:06:20 +0000315 return Builder.CreateBitCast(Value, BasePtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +0000316 }
John McCall13a39c62012-08-01 05:04:58 +0000317
Craig Topper8a13c412014-05-21 05:09:00 +0000318 llvm::BasicBlock *origBB = nullptr;
319 llvm::BasicBlock *endBB = nullptr;
320
John McCall13a39c62012-08-01 05:04:58 +0000321 // Skip over the offset (and the vtable load) if we're supposed to
322 // null-check the pointer.
Anders Carlssond829a022010-04-24 21:06:20 +0000323 if (NullCheckValue) {
John McCall13a39c62012-08-01 05:04:58 +0000324 origBB = Builder.GetInsertBlock();
325 llvm::BasicBlock *notNullBB = createBasicBlock("cast.notnull");
326 endBB = createBasicBlock("cast.end");
Justin Bogner1cd11f12015-05-20 15:53:59 +0000327
John McCall7f416cc2015-09-08 08:05:57 +0000328 llvm::Value *isNull = Builder.CreateIsNull(Value.getPointer());
John McCall13a39c62012-08-01 05:04:58 +0000329 Builder.CreateCondBr(isNull, endBB, notNullBB);
330 EmitBlock(notNullBB);
Anders Carlssond829a022010-04-24 21:06:20 +0000331 }
332
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000333 if (sanitizePerformTypeCheck()) {
John McCall7f416cc2015-09-08 08:05:57 +0000334 EmitTypeCheck(VBase ? TCK_UpcastToVirtualBase : TCK_Upcast, Loc,
335 Value.getPointer(), DerivedTy, DerivedAlign, true);
Alexey Samsonoveb47d8a2014-10-13 23:59:00 +0000336 }
337
John McCall13a39c62012-08-01 05:04:58 +0000338 // Compute the virtual offset.
Craig Topper8a13c412014-05-21 05:09:00 +0000339 llvm::Value *VirtualOffset = nullptr;
Anders Carlssona376b532011-01-29 03:18:56 +0000340 if (VBase) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000341 VirtualOffset =
342 CGM.getCXXABI().GetVirtualBaseClassOffset(*this, Value, Derived, VBase);
Anders Carlssona376b532011-01-29 03:18:56 +0000343 }
Anders Carlssond829a022010-04-24 21:06:20 +0000344
John McCall13a39c62012-08-01 05:04:58 +0000345 // Apply both offsets.
John McCall7f416cc2015-09-08 08:05:57 +0000346 Value = ApplyNonVirtualAndVirtualOffset(*this, Value, NonVirtualOffset,
347 VirtualOffset, Derived, VBase);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000348
John McCall13a39c62012-08-01 05:04:58 +0000349 // Cast to the destination type.
Anders Carlssond829a022010-04-24 21:06:20 +0000350 Value = Builder.CreateBitCast(Value, BasePtrTy);
John McCall13a39c62012-08-01 05:04:58 +0000351
352 // Build a phi if we needed a null check.
Anders Carlssond829a022010-04-24 21:06:20 +0000353 if (NullCheckValue) {
John McCall13a39c62012-08-01 05:04:58 +0000354 llvm::BasicBlock *notNullBB = Builder.GetInsertBlock();
355 Builder.CreateBr(endBB);
356 EmitBlock(endBB);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000357
John McCall13a39c62012-08-01 05:04:58 +0000358 llvm::PHINode *PHI = Builder.CreatePHI(BasePtrTy, 2, "cast.result");
John McCall7f416cc2015-09-08 08:05:57 +0000359 PHI->addIncoming(Value.getPointer(), notNullBB);
John McCall13a39c62012-08-01 05:04:58 +0000360 PHI->addIncoming(llvm::Constant::getNullValue(BasePtrTy), origBB);
John McCall7f416cc2015-09-08 08:05:57 +0000361 Value = Address(PHI, Value.getAlignment());
Anders Carlssond829a022010-04-24 21:06:20 +0000362 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000363
Anders Carlssond829a022010-04-24 21:06:20 +0000364 return Value;
365}
366
John McCall7f416cc2015-09-08 08:05:57 +0000367Address
368CodeGenFunction::GetAddressOfDerivedClass(Address BaseAddr,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +0000369 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +0000370 CastExpr::path_const_iterator PathBegin,
371 CastExpr::path_const_iterator PathEnd,
Anders Carlsson8c793172009-11-23 17:57:54 +0000372 bool NullCheckValue) {
John McCallcf142162010-08-07 06:22:56 +0000373 assert(PathBegin != PathEnd && "Base path should not be empty!");
Anders Carlsson8a64c1c2010-04-24 21:23:59 +0000374
Anders Carlsson8c793172009-11-23 17:57:54 +0000375 QualType DerivedTy =
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +0000376 getContext().getCanonicalType(getContext().getTagDeclType(Derived));
Chris Lattner2192fe52011-07-18 04:24:23 +0000377 llvm::Type *DerivedPtrTy = ConvertType(DerivedTy)->getPointerTo();
Richard Smith2c5868c2013-02-13 21:18:23 +0000378
Anders Carlsson600f7372010-01-31 01:43:37 +0000379 llvm::Value *NonVirtualOffset =
John McCallcf142162010-08-07 06:22:56 +0000380 CGM.GetNonVirtualBaseClassOffset(Derived, PathBegin, PathEnd);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000381
Anders Carlsson600f7372010-01-31 01:43:37 +0000382 if (!NonVirtualOffset) {
383 // No offset, we can just cast back.
John McCall7f416cc2015-09-08 08:05:57 +0000384 return Builder.CreateBitCast(BaseAddr, DerivedPtrTy);
Anders Carlsson600f7372010-01-31 01:43:37 +0000385 }
Craig Topper8a13c412014-05-21 05:09:00 +0000386
387 llvm::BasicBlock *CastNull = nullptr;
388 llvm::BasicBlock *CastNotNull = nullptr;
389 llvm::BasicBlock *CastEnd = nullptr;
390
Anders Carlsson8c793172009-11-23 17:57:54 +0000391 if (NullCheckValue) {
392 CastNull = createBasicBlock("cast.null");
393 CastNotNull = createBasicBlock("cast.notnull");
394 CastEnd = createBasicBlock("cast.end");
Justin Bogner1cd11f12015-05-20 15:53:59 +0000395
John McCall7f416cc2015-09-08 08:05:57 +0000396 llvm::Value *IsNull = Builder.CreateIsNull(BaseAddr.getPointer());
Anders Carlsson8c793172009-11-23 17:57:54 +0000397 Builder.CreateCondBr(IsNull, CastNull, CastNotNull);
398 EmitBlock(CastNotNull);
399 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000400
Anders Carlsson600f7372010-01-31 01:43:37 +0000401 // Apply the offset.
John McCall7f416cc2015-09-08 08:05:57 +0000402 llvm::Value *Value = Builder.CreateBitCast(BaseAddr.getPointer(), Int8PtrTy);
Eli Friedman87549262012-02-28 22:07:56 +0000403 Value = Builder.CreateGEP(Value, Builder.CreateNeg(NonVirtualOffset),
404 "sub.ptr");
Anders Carlsson600f7372010-01-31 01:43:37 +0000405
406 // Just cast.
407 Value = Builder.CreateBitCast(Value, DerivedPtrTy);
Anders Carlsson8c793172009-11-23 17:57:54 +0000408
John McCall7f416cc2015-09-08 08:05:57 +0000409 // Produce a PHI if we had a null-check.
Anders Carlsson8c793172009-11-23 17:57:54 +0000410 if (NullCheckValue) {
411 Builder.CreateBr(CastEnd);
412 EmitBlock(CastNull);
413 Builder.CreateBr(CastEnd);
414 EmitBlock(CastEnd);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000415
Jay Foad20c0f022011-03-30 11:28:58 +0000416 llvm::PHINode *PHI = Builder.CreatePHI(Value->getType(), 2);
Anders Carlsson8c793172009-11-23 17:57:54 +0000417 PHI->addIncoming(Value, CastNotNull);
John McCall7f416cc2015-09-08 08:05:57 +0000418 PHI->addIncoming(llvm::Constant::getNullValue(Value->getType()), CastNull);
Anders Carlsson8c793172009-11-23 17:57:54 +0000419 Value = PHI;
420 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000421
John McCall7f416cc2015-09-08 08:05:57 +0000422 return Address(Value, CGM.getClassPointerAlignment(Derived));
Anders Carlsson9a57c5a2009-09-12 04:27:24 +0000423}
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000424
425llvm::Value *CodeGenFunction::GetVTTParameter(GlobalDecl GD,
426 bool ForVirtualBase,
427 bool Delegating) {
Peter Collingbourne66f82e62013-06-28 20:45:28 +0000428 if (!CGM.getCXXABI().NeedsVTTParameter(GD)) {
Anders Carlssone36a6b32010-01-02 01:01:18 +0000429 // This constructor/destructor does not need a VTT parameter.
Craig Topper8a13c412014-05-21 05:09:00 +0000430 return nullptr;
Anders Carlssone36a6b32010-01-02 01:01:18 +0000431 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000432
John McCalldec348f72013-05-03 07:33:41 +0000433 const CXXRecordDecl *RD = cast<CXXMethodDecl>(CurCodeDecl)->getParent();
Anders Carlssone36a6b32010-01-02 01:01:18 +0000434 const CXXRecordDecl *Base = cast<CXXMethodDecl>(GD.getDecl())->getParent();
John McCall5c60a6f2010-02-18 19:59:28 +0000435
Anders Carlssone36a6b32010-01-02 01:01:18 +0000436 llvm::Value *VTT;
437
John McCall5c60a6f2010-02-18 19:59:28 +0000438 uint64_t SubVTTIndex;
439
Douglas Gregor61535002013-01-31 05:50:40 +0000440 if (Delegating) {
441 // If this is a delegating constructor call, just load the VTT.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000442 return LoadCXXVTT();
Douglas Gregor61535002013-01-31 05:50:40 +0000443 } else if (RD == Base) {
444 // If the record matches the base, this is the complete ctor/dtor
445 // variant calling the base variant in a class with virtual bases.
Peter Collingbourne66f82e62013-06-28 20:45:28 +0000446 assert(!CGM.getCXXABI().NeedsVTTParameter(CurGD) &&
John McCall5c60a6f2010-02-18 19:59:28 +0000447 "doing no-op VTT offset in base dtor/ctor?");
Anders Carlsson4d205ba2010-05-02 23:33:10 +0000448 assert(!ForVirtualBase && "Can't have same class as virtual base!");
John McCall5c60a6f2010-02-18 19:59:28 +0000449 SubVTTIndex = 0;
450 } else {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000451 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000452 CharUnits BaseOffset = ForVirtualBase ?
453 Layout.getVBaseClassOffset(Base) :
Ken Dyck16ffcac2011-03-24 01:21:01 +0000454 Layout.getBaseClassOffset(Base);
Anders Carlsson859b3062010-05-02 23:53:25 +0000455
Justin Bogner1cd11f12015-05-20 15:53:59 +0000456 SubVTTIndex =
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000457 CGM.getVTables().getSubVTTIndex(RD, BaseSubobject(Base, BaseOffset));
John McCall5c60a6f2010-02-18 19:59:28 +0000458 assert(SubVTTIndex != 0 && "Sub-VTT index must be greater than zero!");
459 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000460
Peter Collingbourne66f82e62013-06-28 20:45:28 +0000461 if (CGM.getCXXABI().NeedsVTTParameter(CurGD)) {
Anders Carlssone36a6b32010-01-02 01:01:18 +0000462 // A VTT parameter was passed to the constructor, use it.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000463 VTT = LoadCXXVTT();
464 VTT = Builder.CreateConstInBoundsGEP1_64(VTT, SubVTTIndex);
Anders Carlssone36a6b32010-01-02 01:01:18 +0000465 } else {
466 // We're the complete constructor, so get the VTT by name.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000467 VTT = CGM.getVTables().GetAddrOfVTT(RD);
468 VTT = Builder.CreateConstInBoundsGEP2_64(VTT, 0, SubVTTIndex);
Anders Carlssone36a6b32010-01-02 01:01:18 +0000469 }
470
471 return VTT;
472}
473
John McCall1d987562010-07-21 01:23:41 +0000474namespace {
John McCallf99a6312010-07-21 05:30:47 +0000475 /// Call the destructor for a direct base class.
David Blaikie7e70d682015-08-18 22:40:54 +0000476 struct CallBaseDtor final : EHScopeStack::Cleanup {
John McCallf99a6312010-07-21 05:30:47 +0000477 const CXXRecordDecl *BaseClass;
478 bool BaseIsVirtual;
479 CallBaseDtor(const CXXRecordDecl *Base, bool BaseIsVirtual)
480 : BaseClass(Base), BaseIsVirtual(BaseIsVirtual) {}
John McCall1d987562010-07-21 01:23:41 +0000481
Craig Topper4f12f102014-03-12 06:41:41 +0000482 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallf99a6312010-07-21 05:30:47 +0000483 const CXXRecordDecl *DerivedClass =
484 cast<CXXMethodDecl>(CGF.CurCodeDecl)->getParent();
485
486 const CXXDestructorDecl *D = BaseClass->getDestructor();
John McCall7f416cc2015-09-08 08:05:57 +0000487 Address Addr =
488 CGF.GetAddressOfDirectBaseInCompleteClass(CGF.LoadCXXThisAddress(),
John McCallf99a6312010-07-21 05:30:47 +0000489 DerivedClass, BaseClass,
490 BaseIsVirtual);
Douglas Gregor61535002013-01-31 05:50:40 +0000491 CGF.EmitCXXDestructorCall(D, Dtor_Base, BaseIsVirtual,
492 /*Delegating=*/false, Addr);
John McCall1d987562010-07-21 01:23:41 +0000493 }
494 };
John McCall769250e2010-09-17 02:31:44 +0000495
496 /// A visitor which checks whether an initializer uses 'this' in a
497 /// way which requires the vtable to be properly set.
Scott Douglass503fc392015-06-10 13:53:15 +0000498 struct DynamicThisUseChecker : ConstEvaluatedExprVisitor<DynamicThisUseChecker> {
499 typedef ConstEvaluatedExprVisitor<DynamicThisUseChecker> super;
John McCall769250e2010-09-17 02:31:44 +0000500
501 bool UsesThis;
502
Scott Douglass503fc392015-06-10 13:53:15 +0000503 DynamicThisUseChecker(const ASTContext &C) : super(C), UsesThis(false) {}
John McCall769250e2010-09-17 02:31:44 +0000504
505 // Black-list all explicit and implicit references to 'this'.
506 //
507 // Do we need to worry about external references to 'this' derived
508 // from arbitrary code? If so, then anything which runs arbitrary
509 // external code might potentially access the vtable.
Scott Douglass503fc392015-06-10 13:53:15 +0000510 void VisitCXXThisExpr(const CXXThisExpr *E) { UsesThis = true; }
John McCall769250e2010-09-17 02:31:44 +0000511 };
Hans Wennborgdcfba332015-10-06 23:40:43 +0000512} // end anonymous namespace
John McCall769250e2010-09-17 02:31:44 +0000513
514static bool BaseInitializerUsesThis(ASTContext &C, const Expr *Init) {
515 DynamicThisUseChecker Checker(C);
Scott Douglass503fc392015-06-10 13:53:15 +0000516 Checker.Visit(Init);
John McCall769250e2010-09-17 02:31:44 +0000517 return Checker.UsesThis;
John McCall1d987562010-07-21 01:23:41 +0000518}
519
Justin Bogner1cd11f12015-05-20 15:53:59 +0000520static void EmitBaseInitializer(CodeGenFunction &CGF,
Anders Carlssonfb404882009-12-24 22:46:43 +0000521 const CXXRecordDecl *ClassDecl,
Alexis Hunt1d792652011-01-08 20:30:50 +0000522 CXXCtorInitializer *BaseInit,
Anders Carlssonfb404882009-12-24 22:46:43 +0000523 CXXCtorType CtorType) {
524 assert(BaseInit->isBaseInitializer() &&
525 "Must have base initializer!");
526
John McCall7f416cc2015-09-08 08:05:57 +0000527 Address ThisPtr = CGF.LoadCXXThisAddress();
Justin Bogner1cd11f12015-05-20 15:53:59 +0000528
Anders Carlssonfb404882009-12-24 22:46:43 +0000529 const Type *BaseType = BaseInit->getBaseClass();
530 CXXRecordDecl *BaseClassDecl =
531 cast<CXXRecordDecl>(BaseType->getAs<RecordType>()->getDecl());
532
Anders Carlsson1c0f8bb2010-04-12 00:51:03 +0000533 bool isBaseVirtual = BaseInit->isBaseVirtual();
Anders Carlssonfb404882009-12-24 22:46:43 +0000534
535 // The base constructor doesn't construct virtual bases.
536 if (CtorType == Ctor_Base && isBaseVirtual)
537 return;
538
John McCall769250e2010-09-17 02:31:44 +0000539 // If the initializer for the base (other than the constructor
540 // itself) accesses 'this' in any way, we need to initialize the
541 // vtables.
542 if (BaseInitializerUsesThis(CGF.getContext(), BaseInit->getInit()))
543 CGF.InitializeVTablePointers(ClassDecl);
544
John McCall6ce74722010-02-16 04:15:37 +0000545 // We can pretend to be a complete class because it only matters for
546 // virtual bases, and we only do virtual bases for complete ctors.
John McCall7f416cc2015-09-08 08:05:57 +0000547 Address V =
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +0000548 CGF.GetAddressOfDirectBaseInCompleteClass(ThisPtr, ClassDecl,
John McCallf99a6312010-07-21 05:30:47 +0000549 BaseClassDecl,
550 isBaseVirtual);
John McCall8d6fc952011-08-25 20:40:09 +0000551 AggValueSlot AggSlot =
John McCall7f416cc2015-09-08 08:05:57 +0000552 AggValueSlot::forAddr(V, Qualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +0000553 AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +0000554 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +0000555 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +0000556
557 CGF.EmitAggExpr(BaseInit->getInit(), AggSlot);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000558
559 if (CGF.CGM.getLangOpts().Exceptions &&
Anders Carlsson08ce5ed2011-02-20 00:20:27 +0000560 !BaseClassDecl->hasTrivialDestructor())
John McCallcda666c2010-07-21 07:22:38 +0000561 CGF.EHStack.pushCleanup<CallBaseDtor>(EHCleanup, BaseClassDecl,
562 isBaseVirtual);
Anders Carlssonfb404882009-12-24 22:46:43 +0000563}
564
John McCall4c7718d2016-07-20 21:02:43 +0000565/// Initialize a member of aggregate type using the given expression
566/// as an initializer.
567///
568/// The member may be an array. If so:
569/// - the destination l-value will be a pointer of the *base* element type,
570/// - ArrayIndexVar will be a pointer to a variable containing the current
571/// index within the destination array, and
572/// - ArrayIndexes will be an array of index variables, one for each level
573/// of array nesting, which will need to be updated as appropriate for the
574/// array structure.
575///
576/// On an array, this function will invoke itself recursively. Each time,
577/// it drills into one nesting level of the member type and sets up a
578/// loop updating the appropriate array index variable.
Douglas Gregor94f9a482010-05-05 05:51:00 +0000579static void EmitAggMemberInitializer(CodeGenFunction &CGF,
580 LValue LHS,
Eli Friedman6ae63022012-02-14 02:15:49 +0000581 Expr *Init,
John McCall7f416cc2015-09-08 08:05:57 +0000582 Address ArrayIndexVar,
Douglas Gregor94f9a482010-05-05 05:51:00 +0000583 QualType T,
Eli Friedman6ae63022012-02-14 02:15:49 +0000584 ArrayRef<VarDecl *> ArrayIndexes,
Douglas Gregor94f9a482010-05-05 05:51:00 +0000585 unsigned Index) {
John McCall4c7718d2016-07-20 21:02:43 +0000586 assert(ArrayIndexVar.isValid() == (ArrayIndexes.size() != 0));
587
Eli Friedman6ae63022012-02-14 02:15:49 +0000588 if (Index == ArrayIndexes.size()) {
Eli Friedmanc1d85b92011-12-03 00:54:26 +0000589 LValue LV = LHS;
Eli Friedmanc1d85b92011-12-03 00:54:26 +0000590
John McCall4c7718d2016-07-20 21:02:43 +0000591 Optional<CodeGenFunction::RunCleanupsScope> Scope;
592
John McCall7f416cc2015-09-08 08:05:57 +0000593 if (ArrayIndexVar.isValid()) {
John McCall4c7718d2016-07-20 21:02:43 +0000594 // When we're processing an array, the temporaries from each
595 // element's construction are destroyed immediately.
596 Scope.emplace(CGF);
597
Richard Smithcc1b96d2013-06-12 22:31:48 +0000598 // If we have an array index variable, load it and use it as an offset.
599 // Then, increment the value.
John McCall7f416cc2015-09-08 08:05:57 +0000600 llvm::Value *Dest = LHS.getPointer();
Richard Smithcc1b96d2013-06-12 22:31:48 +0000601 llvm::Value *ArrayIndex = CGF.Builder.CreateLoad(ArrayIndexVar);
602 Dest = CGF.Builder.CreateInBoundsGEP(Dest, ArrayIndex, "destaddress");
603 llvm::Value *Next = llvm::ConstantInt::get(ArrayIndex->getType(), 1);
604 Next = CGF.Builder.CreateAdd(ArrayIndex, Next, "inc");
605 CGF.Builder.CreateStore(Next, ArrayIndexVar);
Sebastian Redl4e04dd12012-02-19 15:41:54 +0000606
Richard Smithcc1b96d2013-06-12 22:31:48 +0000607 // Update the LValue.
John McCall7f416cc2015-09-08 08:05:57 +0000608 CharUnits EltSize = CGF.getContext().getTypeSizeInChars(T);
609 CharUnits Align = LV.getAlignment().alignmentOfArrayElement(EltSize);
610 LV.setAddress(Address(Dest, Align));
John McCall4c7718d2016-07-20 21:02:43 +0000611
612 // Enter a partial-array EH cleanup to destroy previous members
613 // of the array if this initialization throws.
614 if (CGF.CGM.getLangOpts().Exceptions) {
615 if (auto DtorKind = T.isDestructedType()) {
616 if (CGF.needsEHCleanup(DtorKind)) {
617 CGF.pushRegularPartialArrayCleanup(LHS.getPointer(),
618 LV.getPointer(), T,
619 LV.getAlignment(),
620 CGF.getDestroyer(DtorKind));
621 }
622 }
623 }
Douglas Gregor94f9a482010-05-05 05:51:00 +0000624 }
John McCall7a626f62010-09-15 10:14:12 +0000625
Richard Smithcc1b96d2013-06-12 22:31:48 +0000626 switch (CGF.getEvaluationKind(T)) {
627 case TEK_Scalar:
Craig Topper8a13c412014-05-21 05:09:00 +0000628 CGF.EmitScalarInit(Init, /*decl*/ nullptr, LV, false);
Richard Smithcc1b96d2013-06-12 22:31:48 +0000629 break;
630 case TEK_Complex:
631 CGF.EmitComplexExprIntoLValue(Init, LV, /*isInit*/ true);
632 break;
633 case TEK_Aggregate: {
634 AggValueSlot Slot =
635 AggValueSlot::forLValue(LV,
636 AggValueSlot::IsDestructed,
637 AggValueSlot::DoesNotNeedGCBarriers,
638 AggValueSlot::IsNotAliased);
639
640 CGF.EmitAggExpr(Init, Slot);
641 break;
642 }
643 }
Sebastian Redl4e04dd12012-02-19 15:41:54 +0000644
Douglas Gregor94f9a482010-05-05 05:51:00 +0000645 return;
646 }
Richard Smithcc1b96d2013-06-12 22:31:48 +0000647
Douglas Gregor94f9a482010-05-05 05:51:00 +0000648 const ConstantArrayType *Array = CGF.getContext().getAsConstantArrayType(T);
649 assert(Array && "Array initialization without the array type?");
John McCall7f416cc2015-09-08 08:05:57 +0000650 Address IndexVar = CGF.GetAddrOfLocalVar(ArrayIndexes[Index]);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000651
Douglas Gregor94f9a482010-05-05 05:51:00 +0000652 // Initialize this index variable to zero.
653 llvm::Value* Zero
John McCall7f416cc2015-09-08 08:05:57 +0000654 = llvm::Constant::getNullValue(IndexVar.getElementType());
Douglas Gregor94f9a482010-05-05 05:51:00 +0000655 CGF.Builder.CreateStore(Zero, IndexVar);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000656
Douglas Gregor94f9a482010-05-05 05:51:00 +0000657 // Start the loop with a block that tests the condition.
658 llvm::BasicBlock *CondBlock = CGF.createBasicBlock("for.cond");
659 llvm::BasicBlock *AfterFor = CGF.createBasicBlock("for.end");
Justin Bogner1cd11f12015-05-20 15:53:59 +0000660
Douglas Gregor94f9a482010-05-05 05:51:00 +0000661 CGF.EmitBlock(CondBlock);
662
663 llvm::BasicBlock *ForBody = CGF.createBasicBlock("for.body");
664 // Generate: if (loop-index < number-of-elements) fall to the loop body,
665 // otherwise, go to the block after the for-loop.
666 uint64_t NumElements = Array->getSize().getZExtValue();
Douglas Gregor94f9a482010-05-05 05:51:00 +0000667 llvm::Value *Counter = CGF.Builder.CreateLoad(IndexVar);
Chris Lattner44456d22010-05-06 06:35:23 +0000668 llvm::Value *NumElementsPtr =
669 llvm::ConstantInt::get(Counter->getType(), NumElements);
Douglas Gregor94f9a482010-05-05 05:51:00 +0000670 llvm::Value *IsLess = CGF.Builder.CreateICmpULT(Counter, NumElementsPtr,
671 "isless");
Justin Bogner1cd11f12015-05-20 15:53:59 +0000672
Douglas Gregor94f9a482010-05-05 05:51:00 +0000673 // If the condition is true, execute the body.
674 CGF.Builder.CreateCondBr(IsLess, ForBody, AfterFor);
675
676 CGF.EmitBlock(ForBody);
677 llvm::BasicBlock *ContinueBlock = CGF.createBasicBlock("for.inc");
Richard Smithcc1b96d2013-06-12 22:31:48 +0000678
679 // Inside the loop body recurse to emit the inner loop or, eventually, the
680 // constructor call.
681 EmitAggMemberInitializer(CGF, LHS, Init, ArrayIndexVar,
682 Array->getElementType(), ArrayIndexes, Index + 1);
683
Douglas Gregor94f9a482010-05-05 05:51:00 +0000684 CGF.EmitBlock(ContinueBlock);
685
686 // Emit the increment of the loop counter.
687 llvm::Value *NextVal = llvm::ConstantInt::get(Counter->getType(), 1);
688 Counter = CGF.Builder.CreateLoad(IndexVar);
689 NextVal = CGF.Builder.CreateAdd(Counter, NextVal, "inc");
690 CGF.Builder.CreateStore(NextVal, IndexVar);
691
692 // Finally, branch back up to the condition for the next iteration.
693 CGF.EmitBranch(CondBlock);
694
695 // Emit the fall-through block.
696 CGF.EmitBlock(AfterFor, true);
697}
John McCall1d987562010-07-21 01:23:41 +0000698
Richard Smith419bd092015-04-29 19:26:57 +0000699static bool isMemcpyEquivalentSpecialMember(const CXXMethodDecl *D) {
700 auto *CD = dyn_cast<CXXConstructorDecl>(D);
701 if (!(CD && CD->isCopyOrMoveConstructor()) &&
702 !D->isCopyAssignmentOperator() && !D->isMoveAssignmentOperator())
703 return false;
704
705 // We can emit a memcpy for a trivial copy or move constructor/assignment.
706 if (D->isTrivial() && !D->getParent()->mayInsertExtraPadding())
707 return true;
708
709 // We *must* emit a memcpy for a defaulted union copy or move op.
710 if (D->getParent()->isUnion() && D->isDefaulted())
711 return true;
712
713 return false;
714}
715
Alexey Bataev152c71f2015-07-14 07:55:48 +0000716static void EmitLValueForAnyFieldInitialization(CodeGenFunction &CGF,
717 CXXCtorInitializer *MemberInit,
718 LValue &LHS) {
719 FieldDecl *Field = MemberInit->getAnyMember();
720 if (MemberInit->isIndirectMemberInitializer()) {
721 // If we are initializing an anonymous union field, drill down to the field.
722 IndirectFieldDecl *IndirectField = MemberInit->getIndirectMember();
723 for (const auto *I : IndirectField->chain())
724 LHS = CGF.EmitLValueForFieldInitialization(LHS, cast<FieldDecl>(I));
725 } else {
726 LHS = CGF.EmitLValueForFieldInitialization(LHS, Field);
727 }
728}
729
Anders Carlssonfb404882009-12-24 22:46:43 +0000730static void EmitMemberInitializer(CodeGenFunction &CGF,
731 const CXXRecordDecl *ClassDecl,
Alexis Hunt1d792652011-01-08 20:30:50 +0000732 CXXCtorInitializer *MemberInit,
Douglas Gregor94f9a482010-05-05 05:51:00 +0000733 const CXXConstructorDecl *Constructor,
734 FunctionArgList &Args) {
David Blaikiea81d4102015-01-18 00:12:58 +0000735 ApplyDebugLocation Loc(CGF, MemberInit->getSourceLocation());
Francois Pichetd583da02010-12-04 09:14:42 +0000736 assert(MemberInit->isAnyMemberInitializer() &&
Anders Carlssonfb404882009-12-24 22:46:43 +0000737 "Must have member initializer!");
Richard Smith938f40b2011-06-11 17:19:42 +0000738 assert(MemberInit->getInit() && "Must have initializer!");
Justin Bogner1cd11f12015-05-20 15:53:59 +0000739
Anders Carlssonfb404882009-12-24 22:46:43 +0000740 // non-static data member initializers.
Francois Pichetd583da02010-12-04 09:14:42 +0000741 FieldDecl *Field = MemberInit->getAnyMember();
Eli Friedman6ae63022012-02-14 02:15:49 +0000742 QualType FieldType = Field->getType();
Anders Carlssonfb404882009-12-24 22:46:43 +0000743
744 llvm::Value *ThisPtr = CGF.LoadCXXThis();
Eli Friedman7f1ff602012-04-16 03:54:45 +0000745 QualType RecordTy = CGF.getContext().getTypeDeclType(ClassDecl);
Eli Friedmanf6d21842012-08-08 03:51:37 +0000746 LValue LHS = CGF.MakeNaturalAlignAddrLValue(ThisPtr, RecordTy);
Eli Friedman7f1ff602012-04-16 03:54:45 +0000747
Alexey Bataev152c71f2015-07-14 07:55:48 +0000748 EmitLValueForAnyFieldInitialization(CGF, MemberInit, LHS);
Anders Carlssonfb404882009-12-24 22:46:43 +0000749
Eli Friedman6ae63022012-02-14 02:15:49 +0000750 // Special case: if we are in a copy or move constructor, and we are copying
751 // an array of PODs or classes with trivial copy constructors, ignore the
752 // AST and perform the copy we know is equivalent.
753 // FIXME: This is hacky at best... if we had a bit more explicit information
754 // in the AST, we could generalize it more easily.
755 const ConstantArrayType *Array
756 = CGF.getContext().getAsConstantArrayType(FieldType);
Jordan Rose54533f72013-08-07 16:16:48 +0000757 if (Array && Constructor->isDefaulted() &&
Eli Friedman6ae63022012-02-14 02:15:49 +0000758 Constructor->isCopyOrMoveConstructor()) {
759 QualType BaseElementTy = CGF.getContext().getBaseElementType(Array);
Richard Smith993f25a2012-11-07 23:56:21 +0000760 CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(MemberInit->getInit());
Eli Friedman6ae63022012-02-14 02:15:49 +0000761 if (BaseElementTy.isPODType(CGF.getContext()) ||
Richard Smith419bd092015-04-29 19:26:57 +0000762 (CE && isMemcpyEquivalentSpecialMember(CE->getConstructor()))) {
David Majnemer1573d732014-10-15 04:54:54 +0000763 unsigned SrcArgIndex =
764 CGF.CGM.getCXXABI().getSrcArgforCopyCtor(Constructor, Args);
Eli Friedman6ae63022012-02-14 02:15:49 +0000765 llvm::Value *SrcPtr
766 = CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(Args[SrcArgIndex]));
Eli Friedman7f1ff602012-04-16 03:54:45 +0000767 LValue ThisRHSLV = CGF.MakeNaturalAlignAddrLValue(SrcPtr, RecordTy);
768 LValue Src = CGF.EmitLValueForFieldInitialization(ThisRHSLV, Field);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000769
Eli Friedman6ae63022012-02-14 02:15:49 +0000770 // Copy the aggregate.
771 CGF.EmitAggregateCopy(LHS.getAddress(), Src.getAddress(), FieldType,
Chad Rosier615ed1a2012-03-29 17:37:10 +0000772 LHS.isVolatileQualified());
Alexey Bataev5d49b832015-07-08 07:31:02 +0000773 // Ensure that we destroy the objects if an exception is thrown later in
774 // the constructor.
775 QualType::DestructionKind dtorKind = FieldType.isDestructedType();
776 if (CGF.needsEHCleanup(dtorKind))
777 CGF.pushEHDestroy(dtorKind, LHS.getAddress(), FieldType);
Eli Friedman6ae63022012-02-14 02:15:49 +0000778 return;
779 }
780 }
781
782 ArrayRef<VarDecl *> ArrayIndexes;
783 if (MemberInit->getNumArrayIndices())
Richard Smithaa165cf2016-04-13 21:57:08 +0000784 ArrayIndexes = MemberInit->getArrayIndices();
David Blaikie66e41972015-01-14 07:38:27 +0000785 CGF.EmitInitializerForField(Field, LHS, MemberInit->getInit(), ArrayIndexes);
Eli Friedman6ae63022012-02-14 02:15:49 +0000786}
787
John McCall7f416cc2015-09-08 08:05:57 +0000788void CodeGenFunction::EmitInitializerForField(FieldDecl *Field, LValue LHS,
789 Expr *Init, ArrayRef<VarDecl *> ArrayIndexes) {
Eli Friedman6ae63022012-02-14 02:15:49 +0000790 QualType FieldType = Field->getType();
John McCall47fb9502013-03-07 21:37:08 +0000791 switch (getEvaluationKind(FieldType)) {
792 case TEK_Scalar:
John McCall31168b02011-06-15 23:02:42 +0000793 if (LHS.isSimple()) {
David Blaikie66e41972015-01-14 07:38:27 +0000794 EmitExprAsInit(Init, Field, LHS, false);
John McCall31168b02011-06-15 23:02:42 +0000795 } else {
Eli Friedman5f1a04f2012-02-14 02:31:03 +0000796 RValue RHS = RValue::get(EmitScalarExpr(Init));
797 EmitStoreThroughLValue(RHS, LHS);
John McCall31168b02011-06-15 23:02:42 +0000798 }
John McCall47fb9502013-03-07 21:37:08 +0000799 break;
800 case TEK_Complex:
David Blaikie66e41972015-01-14 07:38:27 +0000801 EmitComplexExprIntoLValue(Init, LHS, /*isInit*/ true);
John McCall47fb9502013-03-07 21:37:08 +0000802 break;
803 case TEK_Aggregate: {
John McCall7f416cc2015-09-08 08:05:57 +0000804 Address ArrayIndexVar = Address::invalid();
Eli Friedman6ae63022012-02-14 02:15:49 +0000805 if (ArrayIndexes.size()) {
Douglas Gregor94f9a482010-05-05 05:51:00 +0000806 // The LHS is a pointer to the first object we'll be constructing, as
807 // a flat array.
Eli Friedman5f1a04f2012-02-14 02:31:03 +0000808 QualType BaseElementTy = getContext().getBaseElementType(FieldType);
809 llvm::Type *BasePtr = ConvertType(BaseElementTy);
Douglas Gregor94f9a482010-05-05 05:51:00 +0000810 BasePtr = llvm::PointerType::getUnqual(BasePtr);
John McCall7f416cc2015-09-08 08:05:57 +0000811 Address BaseAddrPtr = Builder.CreateBitCast(LHS.getAddress(), BasePtr);
Eli Friedman5f1a04f2012-02-14 02:31:03 +0000812 LHS = MakeAddrLValue(BaseAddrPtr, BaseElementTy);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000813
Douglas Gregor94f9a482010-05-05 05:51:00 +0000814 // Create an array index that will be used to walk over all of the
815 // objects we're constructing.
John McCall7f416cc2015-09-08 08:05:57 +0000816 ArrayIndexVar = CreateMemTemp(getContext().getSizeType(), "object.index");
817 llvm::Value *Zero =
818 llvm::Constant::getNullValue(ArrayIndexVar.getElementType());
Eli Friedman5f1a04f2012-02-14 02:31:03 +0000819 Builder.CreateStore(Zero, ArrayIndexVar);
Justin Bogner1cd11f12015-05-20 15:53:59 +0000820
Douglas Gregor94f9a482010-05-05 05:51:00 +0000821 // Emit the block variables for the array indices, if any.
Eli Friedman6ae63022012-02-14 02:15:49 +0000822 for (unsigned I = 0, N = ArrayIndexes.size(); I != N; ++I)
Eli Friedman5f1a04f2012-02-14 02:31:03 +0000823 EmitAutoVarDecl(*ArrayIndexes[I]);
Douglas Gregor94f9a482010-05-05 05:51:00 +0000824 }
Justin Bogner1cd11f12015-05-20 15:53:59 +0000825
Eli Friedman5f1a04f2012-02-14 02:31:03 +0000826 EmitAggMemberInitializer(*this, LHS, Init, ArrayIndexVar, FieldType,
Eli Friedman6ae63022012-02-14 02:15:49 +0000827 ArrayIndexes, 0);
Anders Carlssonfb404882009-12-24 22:46:43 +0000828 }
John McCall47fb9502013-03-07 21:37:08 +0000829 }
John McCall12cc42a2013-02-01 05:11:40 +0000830
831 // Ensure that we destroy this object if an exception is thrown
832 // later in the constructor.
833 QualType::DestructionKind dtorKind = FieldType.isDestructedType();
834 if (needsEHCleanup(dtorKind))
835 pushEHDestroy(dtorKind, LHS.getAddress(), FieldType);
Anders Carlssonfb404882009-12-24 22:46:43 +0000836}
837
John McCallf8ff7b92010-02-23 00:48:20 +0000838/// Checks whether the given constructor is a valid subject for the
839/// complete-to-base constructor delegation optimization, i.e.
840/// emitting the complete constructor as a simple call to the base
841/// constructor.
842static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor) {
843
844 // Currently we disable the optimization for classes with virtual
845 // bases because (1) the addresses of parameter variables need to be
846 // consistent across all initializers but (2) the delegate function
847 // call necessarily creates a second copy of the parameter variable.
848 //
849 // The limiting example (purely theoretical AFAIK):
850 // struct A { A(int &c) { c++; } };
851 // struct B : virtual A {
852 // B(int count) : A(count) { printf("%d\n", count); }
853 // };
854 // ...although even this example could in principle be emitted as a
855 // delegation since the address of the parameter doesn't escape.
856 if (Ctor->getParent()->getNumVBases()) {
857 // TODO: white-list trivial vbase initializers. This case wouldn't
858 // be subject to the restrictions below.
859
860 // TODO: white-list cases where:
861 // - there are no non-reference parameters to the constructor
862 // - the initializers don't access any non-reference parameters
863 // - the initializers don't take the address of non-reference
864 // parameters
865 // - etc.
866 // If we ever add any of the above cases, remember that:
867 // - function-try-blocks will always blacklist this optimization
868 // - we need to perform the constructor prologue and cleanup in
869 // EmitConstructorBody.
870
871 return false;
872 }
873
874 // We also disable the optimization for variadic functions because
875 // it's impossible to "re-pass" varargs.
876 if (Ctor->getType()->getAs<FunctionProtoType>()->isVariadic())
877 return false;
878
Alexis Hunt61bc1732011-05-01 07:04:31 +0000879 // FIXME: Decide if we can do a delegation of a delegating constructor.
880 if (Ctor->isDelegatingConstructor())
881 return false;
882
John McCallf8ff7b92010-02-23 00:48:20 +0000883 return true;
884}
885
Kostya Serebryany293dc9b2014-10-16 20:54:52 +0000886// Emit code in ctor (Prologue==true) or dtor (Prologue==false)
887// to poison the extra field paddings inserted under
888// -fsanitize-address-field-padding=1|2.
889void CodeGenFunction::EmitAsanPrologueOrEpilogue(bool Prologue) {
890 ASTContext &Context = getContext();
891 const CXXRecordDecl *ClassDecl =
892 Prologue ? cast<CXXConstructorDecl>(CurGD.getDecl())->getParent()
893 : cast<CXXDestructorDecl>(CurGD.getDecl())->getParent();
894 if (!ClassDecl->mayInsertExtraPadding()) return;
895
896 struct SizeAndOffset {
897 uint64_t Size;
898 uint64_t Offset;
899 };
900
901 unsigned PtrSize = CGM.getDataLayout().getPointerSizeInBits();
902 const ASTRecordLayout &Info = Context.getASTRecordLayout(ClassDecl);
903
904 // Populate sizes and offsets of fields.
905 SmallVector<SizeAndOffset, 16> SSV(Info.getFieldCount());
906 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i)
907 SSV[i].Offset =
908 Context.toCharUnitsFromBits(Info.getFieldOffset(i)).getQuantity();
909
910 size_t NumFields = 0;
911 for (const auto *Field : ClassDecl->fields()) {
912 const FieldDecl *D = Field;
913 std::pair<CharUnits, CharUnits> FieldInfo =
914 Context.getTypeInfoInChars(D->getType());
915 CharUnits FieldSize = FieldInfo.first;
916 assert(NumFields < SSV.size());
917 SSV[NumFields].Size = D->isBitField() ? 0 : FieldSize.getQuantity();
918 NumFields++;
919 }
920 assert(NumFields == SSV.size());
921 if (SSV.size() <= 1) return;
922
923 // We will insert calls to __asan_* run-time functions.
924 // LLVM AddressSanitizer pass may decide to inline them later.
925 llvm::Type *Args[2] = {IntPtrTy, IntPtrTy};
926 llvm::FunctionType *FTy =
927 llvm::FunctionType::get(CGM.VoidTy, Args, false);
928 llvm::Constant *F = CGM.CreateRuntimeFunction(
929 FTy, Prologue ? "__asan_poison_intra_object_redzone"
930 : "__asan_unpoison_intra_object_redzone");
931
932 llvm::Value *ThisPtr = LoadCXXThis();
933 ThisPtr = Builder.CreatePtrToInt(ThisPtr, IntPtrTy);
Kostya Serebryany64449212014-10-17 21:02:13 +0000934 uint64_t TypeSize = Info.getNonVirtualSize().getQuantity();
Kostya Serebryany293dc9b2014-10-16 20:54:52 +0000935 // For each field check if it has sufficient padding,
936 // if so (un)poison it with a call.
937 for (size_t i = 0; i < SSV.size(); i++) {
938 uint64_t AsanAlignment = 8;
939 uint64_t NextField = i == SSV.size() - 1 ? TypeSize : SSV[i + 1].Offset;
940 uint64_t PoisonSize = NextField - SSV[i].Offset - SSV[i].Size;
941 uint64_t EndOffset = SSV[i].Offset + SSV[i].Size;
942 if (PoisonSize < AsanAlignment || !SSV[i].Size ||
943 (NextField % AsanAlignment) != 0)
944 continue;
David Blaikie43f9bb72015-05-18 22:14:03 +0000945 Builder.CreateCall(
946 F, {Builder.CreateAdd(ThisPtr, Builder.getIntN(PtrSize, EndOffset)),
947 Builder.getIntN(PtrSize, PoisonSize)});
Kostya Serebryany293dc9b2014-10-16 20:54:52 +0000948 }
949}
950
John McCallb81884d2010-02-19 09:25:03 +0000951/// EmitConstructorBody - Emits the body of the current constructor.
952void CodeGenFunction::EmitConstructorBody(FunctionArgList &Args) {
Kostya Serebryany293dc9b2014-10-16 20:54:52 +0000953 EmitAsanPrologueOrEpilogue(true);
John McCallb81884d2010-02-19 09:25:03 +0000954 const CXXConstructorDecl *Ctor = cast<CXXConstructorDecl>(CurGD.getDecl());
955 CXXCtorType CtorType = CurGD.getCtorType();
956
Reid Kleckner340ad862014-01-13 22:57:31 +0000957 assert((CGM.getTarget().getCXXABI().hasConstructorVariants() ||
958 CtorType == Ctor_Complete) &&
959 "can only generate complete ctor for this ABI");
960
John McCallf8ff7b92010-02-23 00:48:20 +0000961 // Before we go any further, try the complete->base constructor
962 // delegation optimization.
Timur Iskhodzhanovf32a3772012-04-20 08:05:00 +0000963 if (CtorType == Ctor_Complete && IsConstructorDelegationValid(Ctor) &&
John McCallc8e01702013-04-16 22:48:15 +0000964 CGM.getTarget().getCXXABI().hasConstructorVariants()) {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000965 EmitDelegateCXXConstructorCall(Ctor, Ctor_Base, Args, Ctor->getLocEnd());
John McCallf8ff7b92010-02-23 00:48:20 +0000966 return;
967 }
968
Hans Wennborgdcfba332015-10-06 23:40:43 +0000969 const FunctionDecl *Definition = nullptr;
Richard Smith46bb5812014-08-01 01:56:39 +0000970 Stmt *Body = Ctor->getBody(Definition);
971 assert(Definition == Ctor && "emitting wrong constructor body");
John McCallb81884d2010-02-19 09:25:03 +0000972
John McCallf8ff7b92010-02-23 00:48:20 +0000973 // Enter the function-try-block before the constructor prologue if
974 // applicable.
John McCallf8ff7b92010-02-23 00:48:20 +0000975 bool IsTryBody = (Body && isa<CXXTryStmt>(Body));
John McCallf8ff7b92010-02-23 00:48:20 +0000976 if (IsTryBody)
John McCallb609d3f2010-07-07 06:56:46 +0000977 EnterCXXTryStmt(*cast<CXXTryStmt>(Body), true);
John McCallb81884d2010-02-19 09:25:03 +0000978
Justin Bogner66242d62015-04-23 23:06:47 +0000979 incrementProfileCounter(Body);
Justin Bogner81c22c22014-01-23 02:54:27 +0000980
Richard Smithcc1b96d2013-06-12 22:31:48 +0000981 RunCleanupsScope RunCleanups(*this);
John McCallb81884d2010-02-19 09:25:03 +0000982
John McCall88313032012-03-30 04:25:03 +0000983 // TODO: in restricted cases, we can emit the vbase initializers of
984 // a complete ctor and then delegate to the base ctor.
985
John McCallf8ff7b92010-02-23 00:48:20 +0000986 // Emit the constructor prologue, i.e. the base and member
987 // initializers.
Douglas Gregor94f9a482010-05-05 05:51:00 +0000988 EmitCtorPrologue(Ctor, CtorType, Args);
John McCallb81884d2010-02-19 09:25:03 +0000989
990 // Emit the body of the statement.
John McCallf8ff7b92010-02-23 00:48:20 +0000991 if (IsTryBody)
John McCallb81884d2010-02-19 09:25:03 +0000992 EmitStmt(cast<CXXTryStmt>(Body)->getTryBlock());
993 else if (Body)
994 EmitStmt(Body);
John McCallb81884d2010-02-19 09:25:03 +0000995
996 // Emit any cleanup blocks associated with the member or base
997 // initializers, which includes (along the exceptional path) the
998 // destructors for those members and bases that were fully
999 // constructed.
Richard Smithcc1b96d2013-06-12 22:31:48 +00001000 RunCleanups.ForceCleanup();
John McCallb81884d2010-02-19 09:25:03 +00001001
John McCallf8ff7b92010-02-23 00:48:20 +00001002 if (IsTryBody)
John McCallb609d3f2010-07-07 06:56:46 +00001003 ExitCXXTryStmt(*cast<CXXTryStmt>(Body), true);
John McCallb81884d2010-02-19 09:25:03 +00001004}
1005
Lang Hamesbf122742013-02-17 07:22:09 +00001006namespace {
Nick Lewycky8b4e3792013-09-11 02:03:20 +00001007 /// RAII object to indicate that codegen is copying the value representation
1008 /// instead of the object representation. Useful when copying a struct or
1009 /// class which has uninitialized members and we're only performing
1010 /// lvalue-to-rvalue conversion on the object but not its members.
1011 class CopyingValueRepresentation {
1012 public:
1013 explicit CopyingValueRepresentation(CodeGenFunction &CGF)
Alexey Samsonov035462c2014-10-30 19:33:44 +00001014 : CGF(CGF), OldSanOpts(CGF.SanOpts) {
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001015 CGF.SanOpts.set(SanitizerKind::Bool, false);
1016 CGF.SanOpts.set(SanitizerKind::Enum, false);
Nick Lewycky8b4e3792013-09-11 02:03:20 +00001017 }
1018 ~CopyingValueRepresentation() {
1019 CGF.SanOpts = OldSanOpts;
1020 }
1021 private:
1022 CodeGenFunction &CGF;
Alexey Samsonova0416102014-11-11 01:26:14 +00001023 SanitizerSet OldSanOpts;
Nick Lewycky8b4e3792013-09-11 02:03:20 +00001024 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001025} // end anonymous namespace
Hans Wennborgdcfba332015-10-06 23:40:43 +00001026
Nick Lewycky8b4e3792013-09-11 02:03:20 +00001027namespace {
Lang Hamesbf122742013-02-17 07:22:09 +00001028 class FieldMemcpyizer {
1029 public:
1030 FieldMemcpyizer(CodeGenFunction &CGF, const CXXRecordDecl *ClassDecl,
1031 const VarDecl *SrcRec)
Justin Bogner1cd11f12015-05-20 15:53:59 +00001032 : CGF(CGF), ClassDecl(ClassDecl), SrcRec(SrcRec),
Lang Hamesbf122742013-02-17 07:22:09 +00001033 RecLayout(CGF.getContext().getASTRecordLayout(ClassDecl)),
Craig Topper8a13c412014-05-21 05:09:00 +00001034 FirstField(nullptr), LastField(nullptr), FirstFieldOffset(0),
1035 LastFieldOffset(0), LastAddedFieldIndex(0) {}
Lang Hamesbf122742013-02-17 07:22:09 +00001036
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001037 bool isMemcpyableField(FieldDecl *F) const {
1038 // Never memcpy fields when we are adding poisoned paddings.
Alexey Samsonova0416102014-11-11 01:26:14 +00001039 if (CGF.getContext().getLangOpts().SanitizeAddressFieldPadding)
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001040 return false;
Lang Hamesbf122742013-02-17 07:22:09 +00001041 Qualifiers Qual = F->getType().getQualifiers();
1042 if (Qual.hasVolatile() || Qual.hasObjCLifetime())
1043 return false;
1044 return true;
1045 }
1046
1047 void addMemcpyableField(FieldDecl *F) {
Craig Topper8a13c412014-05-21 05:09:00 +00001048 if (!FirstField)
Lang Hamesbf122742013-02-17 07:22:09 +00001049 addInitialField(F);
1050 else
1051 addNextField(F);
1052 }
1053
David Majnemera586eb22014-10-10 18:57:10 +00001054 CharUnits getMemcpySize(uint64_t FirstByteOffset) const {
Lang Hamesbf122742013-02-17 07:22:09 +00001055 unsigned LastFieldSize =
1056 LastField->isBitField() ?
1057 LastField->getBitWidthValue(CGF.getContext()) :
Justin Bogner1cd11f12015-05-20 15:53:59 +00001058 CGF.getContext().getTypeSize(LastField->getType());
Lang Hamesbf122742013-02-17 07:22:09 +00001059 uint64_t MemcpySizeBits =
David Majnemera586eb22014-10-10 18:57:10 +00001060 LastFieldOffset + LastFieldSize - FirstByteOffset +
Lang Hamesbf122742013-02-17 07:22:09 +00001061 CGF.getContext().getCharWidth() - 1;
1062 CharUnits MemcpySize =
1063 CGF.getContext().toCharUnitsFromBits(MemcpySizeBits);
1064 return MemcpySize;
1065 }
1066
1067 void emitMemcpy() {
1068 // Give the subclass a chance to bail out if it feels the memcpy isn't
1069 // worth it (e.g. Hasn't aggregated enough data).
Craig Topper8a13c412014-05-21 05:09:00 +00001070 if (!FirstField) {
Lang Hamesbf122742013-02-17 07:22:09 +00001071 return;
1072 }
1073
David Majnemera586eb22014-10-10 18:57:10 +00001074 uint64_t FirstByteOffset;
Lang Hamesbf122742013-02-17 07:22:09 +00001075 if (FirstField->isBitField()) {
1076 const CGRecordLayout &RL =
1077 CGF.getTypes().getCGRecordLayout(FirstField->getParent());
1078 const CGBitFieldInfo &BFInfo = RL.getBitFieldInfo(FirstField);
David Majnemera586eb22014-10-10 18:57:10 +00001079 // FirstFieldOffset is not appropriate for bitfields,
Ulrich Weigand73263d72015-07-13 11:52:14 +00001080 // we need to use the storage offset instead.
Ulrich Weigand03ce2a12015-07-10 17:30:00 +00001081 FirstByteOffset = CGF.getContext().toBits(BFInfo.StorageOffset);
Lang Hames1694e0d2013-02-27 04:14:49 +00001082 } else {
David Majnemera586eb22014-10-10 18:57:10 +00001083 FirstByteOffset = FirstFieldOffset;
Lang Hames1694e0d2013-02-27 04:14:49 +00001084 }
Lang Hamesbf122742013-02-17 07:22:09 +00001085
David Majnemera586eb22014-10-10 18:57:10 +00001086 CharUnits MemcpySize = getMemcpySize(FirstByteOffset);
Lang Hamesbf122742013-02-17 07:22:09 +00001087 QualType RecordTy = CGF.getContext().getTypeDeclType(ClassDecl);
John McCall7f416cc2015-09-08 08:05:57 +00001088 Address ThisPtr = CGF.LoadCXXThisAddress();
1089 LValue DestLV = CGF.MakeAddrLValue(ThisPtr, RecordTy);
Lang Hamesbf122742013-02-17 07:22:09 +00001090 LValue Dest = CGF.EmitLValueForFieldInitialization(DestLV, FirstField);
1091 llvm::Value *SrcPtr = CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(SrcRec));
1092 LValue SrcLV = CGF.MakeNaturalAlignAddrLValue(SrcPtr, RecordTy);
1093 LValue Src = CGF.EmitLValueForFieldInitialization(SrcLV, FirstField);
1094
John McCall7f416cc2015-09-08 08:05:57 +00001095 emitMemcpyIR(Dest.isBitField() ? Dest.getBitFieldAddress() : Dest.getAddress(),
1096 Src.isBitField() ? Src.getBitFieldAddress() : Src.getAddress(),
1097 MemcpySize);
Lang Hamesbf122742013-02-17 07:22:09 +00001098 reset();
1099 }
1100
1101 void reset() {
Craig Topper8a13c412014-05-21 05:09:00 +00001102 FirstField = nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001103 }
1104
1105 protected:
1106 CodeGenFunction &CGF;
1107 const CXXRecordDecl *ClassDecl;
1108
1109 private:
John McCall7f416cc2015-09-08 08:05:57 +00001110 void emitMemcpyIR(Address DestPtr, Address SrcPtr, CharUnits Size) {
1111 llvm::PointerType *DPT = DestPtr.getType();
Lang Hamesbf122742013-02-17 07:22:09 +00001112 llvm::Type *DBP =
1113 llvm::Type::getInt8PtrTy(CGF.getLLVMContext(), DPT->getAddressSpace());
1114 DestPtr = CGF.Builder.CreateBitCast(DestPtr, DBP);
1115
John McCall7f416cc2015-09-08 08:05:57 +00001116 llvm::PointerType *SPT = SrcPtr.getType();
Lang Hamesbf122742013-02-17 07:22:09 +00001117 llvm::Type *SBP =
1118 llvm::Type::getInt8PtrTy(CGF.getLLVMContext(), SPT->getAddressSpace());
1119 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, SBP);
1120
John McCall7f416cc2015-09-08 08:05:57 +00001121 CGF.Builder.CreateMemCpy(DestPtr, SrcPtr, Size.getQuantity());
Lang Hamesbf122742013-02-17 07:22:09 +00001122 }
1123
1124 void addInitialField(FieldDecl *F) {
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001125 FirstField = F;
1126 LastField = F;
1127 FirstFieldOffset = RecLayout.getFieldOffset(F->getFieldIndex());
1128 LastFieldOffset = FirstFieldOffset;
1129 LastAddedFieldIndex = F->getFieldIndex();
1130 }
Lang Hamesbf122742013-02-17 07:22:09 +00001131
1132 void addNextField(FieldDecl *F) {
John McCall6054d5a2013-05-07 05:20:46 +00001133 // For the most part, the following invariant will hold:
1134 // F->getFieldIndex() == LastAddedFieldIndex + 1
1135 // The one exception is that Sema won't add a copy-initializer for an
1136 // unnamed bitfield, which will show up here as a gap in the sequence.
1137 assert(F->getFieldIndex() >= LastAddedFieldIndex + 1 &&
1138 "Cannot aggregate fields out of order.");
Lang Hamesbf122742013-02-17 07:22:09 +00001139 LastAddedFieldIndex = F->getFieldIndex();
1140
1141 // The 'first' and 'last' fields are chosen by offset, rather than field
1142 // index. This allows the code to support bitfields, as well as regular
1143 // fields.
1144 uint64_t FOffset = RecLayout.getFieldOffset(F->getFieldIndex());
1145 if (FOffset < FirstFieldOffset) {
1146 FirstField = F;
1147 FirstFieldOffset = FOffset;
1148 } else if (FOffset > LastFieldOffset) {
1149 LastField = F;
1150 LastFieldOffset = FOffset;
1151 }
1152 }
1153
1154 const VarDecl *SrcRec;
1155 const ASTRecordLayout &RecLayout;
1156 FieldDecl *FirstField;
1157 FieldDecl *LastField;
1158 uint64_t FirstFieldOffset, LastFieldOffset;
1159 unsigned LastAddedFieldIndex;
1160 };
1161
1162 class ConstructorMemcpyizer : public FieldMemcpyizer {
1163 private:
Lang Hamesbf122742013-02-17 07:22:09 +00001164 /// Get source argument for copy constructor. Returns null if not a copy
David Majnemer196ac332014-09-11 23:05:02 +00001165 /// constructor.
1166 static const VarDecl *getTrivialCopySource(CodeGenFunction &CGF,
1167 const CXXConstructorDecl *CD,
Lang Hamesbf122742013-02-17 07:22:09 +00001168 FunctionArgList &Args) {
Jordan Rose54533f72013-08-07 16:16:48 +00001169 if (CD->isCopyOrMoveConstructor() && CD->isDefaulted())
David Majnemer196ac332014-09-11 23:05:02 +00001170 return Args[CGF.CGM.getCXXABI().getSrcArgforCopyCtor(CD, Args)];
Craig Topper8a13c412014-05-21 05:09:00 +00001171 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001172 }
1173
1174 // Returns true if a CXXCtorInitializer represents a member initialization
1175 // that can be rolled into a memcpy.
1176 bool isMemberInitMemcpyable(CXXCtorInitializer *MemberInit) const {
1177 if (!MemcpyableCtor)
1178 return false;
1179 FieldDecl *Field = MemberInit->getMember();
Craig Topper8a13c412014-05-21 05:09:00 +00001180 assert(Field && "No field for member init.");
Lang Hamesbf122742013-02-17 07:22:09 +00001181 QualType FieldType = Field->getType();
1182 CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(MemberInit->getInit());
1183
Richard Smith419bd092015-04-29 19:26:57 +00001184 // Bail out on non-memcpyable, not-trivially-copyable members.
1185 if (!(CE && isMemcpyEquivalentSpecialMember(CE->getConstructor())) &&
Lang Hamesbf122742013-02-17 07:22:09 +00001186 !(FieldType.isTriviallyCopyableType(CGF.getContext()) ||
1187 FieldType->isReferenceType()))
1188 return false;
1189
1190 // Bail out on volatile fields.
1191 if (!isMemcpyableField(Field))
1192 return false;
1193
1194 // Otherwise we're good.
1195 return true;
1196 }
1197
1198 public:
1199 ConstructorMemcpyizer(CodeGenFunction &CGF, const CXXConstructorDecl *CD,
1200 FunctionArgList &Args)
David Majnemer196ac332014-09-11 23:05:02 +00001201 : FieldMemcpyizer(CGF, CD->getParent(), getTrivialCopySource(CGF, CD, Args)),
Lang Hamesbf122742013-02-17 07:22:09 +00001202 ConstructorDecl(CD),
Jordan Rose54533f72013-08-07 16:16:48 +00001203 MemcpyableCtor(CD->isDefaulted() &&
Lang Hamesbf122742013-02-17 07:22:09 +00001204 CD->isCopyOrMoveConstructor() &&
1205 CGF.getLangOpts().getGC() == LangOptions::NonGC),
1206 Args(Args) { }
1207
1208 void addMemberInitializer(CXXCtorInitializer *MemberInit) {
1209 if (isMemberInitMemcpyable(MemberInit)) {
1210 AggregatedInits.push_back(MemberInit);
1211 addMemcpyableField(MemberInit->getMember());
1212 } else {
1213 emitAggregatedInits();
1214 EmitMemberInitializer(CGF, ConstructorDecl->getParent(), MemberInit,
1215 ConstructorDecl, Args);
1216 }
1217 }
1218
1219 void emitAggregatedInits() {
1220 if (AggregatedInits.size() <= 1) {
1221 // This memcpy is too small to be worthwhile. Fall back on default
1222 // codegen.
Nick Lewycky8b4e3792013-09-11 02:03:20 +00001223 if (!AggregatedInits.empty()) {
1224 CopyingValueRepresentation CVR(CGF);
Lang Hamesbf122742013-02-17 07:22:09 +00001225 EmitMemberInitializer(CGF, ConstructorDecl->getParent(),
Nick Lewycky8b4e3792013-09-11 02:03:20 +00001226 AggregatedInits[0], ConstructorDecl, Args);
Alexey Bataev152c71f2015-07-14 07:55:48 +00001227 AggregatedInits.clear();
Lang Hamesbf122742013-02-17 07:22:09 +00001228 }
1229 reset();
1230 return;
1231 }
1232
1233 pushEHDestructors();
1234 emitMemcpy();
1235 AggregatedInits.clear();
1236 }
1237
1238 void pushEHDestructors() {
John McCall7f416cc2015-09-08 08:05:57 +00001239 Address ThisPtr = CGF.LoadCXXThisAddress();
Lang Hamesbf122742013-02-17 07:22:09 +00001240 QualType RecordTy = CGF.getContext().getTypeDeclType(ClassDecl);
John McCall7f416cc2015-09-08 08:05:57 +00001241 LValue LHS = CGF.MakeAddrLValue(ThisPtr, RecordTy);
Lang Hamesbf122742013-02-17 07:22:09 +00001242
1243 for (unsigned i = 0; i < AggregatedInits.size(); ++i) {
Alexey Bataev152c71f2015-07-14 07:55:48 +00001244 CXXCtorInitializer *MemberInit = AggregatedInits[i];
1245 QualType FieldType = MemberInit->getAnyMember()->getType();
Lang Hamesbf122742013-02-17 07:22:09 +00001246 QualType::DestructionKind dtorKind = FieldType.isDestructedType();
Alexey Bataev152c71f2015-07-14 07:55:48 +00001247 if (!CGF.needsEHCleanup(dtorKind))
1248 continue;
1249 LValue FieldLHS = LHS;
1250 EmitLValueForAnyFieldInitialization(CGF, MemberInit, FieldLHS);
1251 CGF.pushEHDestroy(dtorKind, FieldLHS.getAddress(), FieldType);
Lang Hamesbf122742013-02-17 07:22:09 +00001252 }
1253 }
1254
1255 void finish() {
1256 emitAggregatedInits();
1257 }
1258
1259 private:
1260 const CXXConstructorDecl *ConstructorDecl;
1261 bool MemcpyableCtor;
1262 FunctionArgList &Args;
1263 SmallVector<CXXCtorInitializer*, 16> AggregatedInits;
1264 };
1265
1266 class AssignmentMemcpyizer : public FieldMemcpyizer {
1267 private:
Lang Hamesbf122742013-02-17 07:22:09 +00001268 // Returns the memcpyable field copied by the given statement, if one
Nick Lewycky8b4e3792013-09-11 02:03:20 +00001269 // exists. Otherwise returns null.
1270 FieldDecl *getMemcpyableField(Stmt *S) {
Lang Hamesbf122742013-02-17 07:22:09 +00001271 if (!AssignmentsMemcpyable)
Craig Topper8a13c412014-05-21 05:09:00 +00001272 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001273 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(S)) {
1274 // Recognise trivial assignments.
1275 if (BO->getOpcode() != BO_Assign)
Craig Topper8a13c412014-05-21 05:09:00 +00001276 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001277 MemberExpr *ME = dyn_cast<MemberExpr>(BO->getLHS());
1278 if (!ME)
Craig Topper8a13c412014-05-21 05:09:00 +00001279 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001280 FieldDecl *Field = dyn_cast<FieldDecl>(ME->getMemberDecl());
1281 if (!Field || !isMemcpyableField(Field))
Craig Topper8a13c412014-05-21 05:09:00 +00001282 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001283 Stmt *RHS = BO->getRHS();
1284 if (ImplicitCastExpr *EC = dyn_cast<ImplicitCastExpr>(RHS))
1285 RHS = EC->getSubExpr();
1286 if (!RHS)
Craig Topper8a13c412014-05-21 05:09:00 +00001287 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001288 MemberExpr *ME2 = dyn_cast<MemberExpr>(RHS);
1289 if (dyn_cast<FieldDecl>(ME2->getMemberDecl()) != Field)
Craig Topper8a13c412014-05-21 05:09:00 +00001290 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001291 return Field;
1292 } else if (CXXMemberCallExpr *MCE = dyn_cast<CXXMemberCallExpr>(S)) {
1293 CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MCE->getCalleeDecl());
Richard Smith419bd092015-04-29 19:26:57 +00001294 if (!(MD && isMemcpyEquivalentSpecialMember(MD)))
Craig Topper8a13c412014-05-21 05:09:00 +00001295 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001296 MemberExpr *IOA = dyn_cast<MemberExpr>(MCE->getImplicitObjectArgument());
1297 if (!IOA)
Craig Topper8a13c412014-05-21 05:09:00 +00001298 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001299 FieldDecl *Field = dyn_cast<FieldDecl>(IOA->getMemberDecl());
1300 if (!Field || !isMemcpyableField(Field))
Craig Topper8a13c412014-05-21 05:09:00 +00001301 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001302 MemberExpr *Arg0 = dyn_cast<MemberExpr>(MCE->getArg(0));
1303 if (!Arg0 || Field != dyn_cast<FieldDecl>(Arg0->getMemberDecl()))
Craig Topper8a13c412014-05-21 05:09:00 +00001304 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001305 return Field;
1306 } else if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
1307 FunctionDecl *FD = dyn_cast<FunctionDecl>(CE->getCalleeDecl());
1308 if (!FD || FD->getBuiltinID() != Builtin::BI__builtin_memcpy)
Craig Topper8a13c412014-05-21 05:09:00 +00001309 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001310 Expr *DstPtr = CE->getArg(0);
1311 if (ImplicitCastExpr *DC = dyn_cast<ImplicitCastExpr>(DstPtr))
1312 DstPtr = DC->getSubExpr();
1313 UnaryOperator *DUO = dyn_cast<UnaryOperator>(DstPtr);
1314 if (!DUO || DUO->getOpcode() != UO_AddrOf)
Craig Topper8a13c412014-05-21 05:09:00 +00001315 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001316 MemberExpr *ME = dyn_cast<MemberExpr>(DUO->getSubExpr());
1317 if (!ME)
Craig Topper8a13c412014-05-21 05:09:00 +00001318 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001319 FieldDecl *Field = dyn_cast<FieldDecl>(ME->getMemberDecl());
1320 if (!Field || !isMemcpyableField(Field))
Craig Topper8a13c412014-05-21 05:09:00 +00001321 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001322 Expr *SrcPtr = CE->getArg(1);
1323 if (ImplicitCastExpr *SC = dyn_cast<ImplicitCastExpr>(SrcPtr))
1324 SrcPtr = SC->getSubExpr();
1325 UnaryOperator *SUO = dyn_cast<UnaryOperator>(SrcPtr);
1326 if (!SUO || SUO->getOpcode() != UO_AddrOf)
Craig Topper8a13c412014-05-21 05:09:00 +00001327 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001328 MemberExpr *ME2 = dyn_cast<MemberExpr>(SUO->getSubExpr());
1329 if (!ME2 || Field != dyn_cast<FieldDecl>(ME2->getMemberDecl()))
Craig Topper8a13c412014-05-21 05:09:00 +00001330 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001331 return Field;
1332 }
1333
Craig Topper8a13c412014-05-21 05:09:00 +00001334 return nullptr;
Lang Hamesbf122742013-02-17 07:22:09 +00001335 }
1336
1337 bool AssignmentsMemcpyable;
1338 SmallVector<Stmt*, 16> AggregatedStmts;
1339
1340 public:
Lang Hamesbf122742013-02-17 07:22:09 +00001341 AssignmentMemcpyizer(CodeGenFunction &CGF, const CXXMethodDecl *AD,
1342 FunctionArgList &Args)
1343 : FieldMemcpyizer(CGF, AD->getParent(), Args[Args.size() - 1]),
1344 AssignmentsMemcpyable(CGF.getLangOpts().getGC() == LangOptions::NonGC) {
1345 assert(Args.size() == 2);
1346 }
1347
1348 void emitAssignment(Stmt *S) {
1349 FieldDecl *F = getMemcpyableField(S);
1350 if (F) {
1351 addMemcpyableField(F);
1352 AggregatedStmts.push_back(S);
Justin Bogner1cd11f12015-05-20 15:53:59 +00001353 } else {
Lang Hamesbf122742013-02-17 07:22:09 +00001354 emitAggregatedStmts();
1355 CGF.EmitStmt(S);
1356 }
1357 }
1358
1359 void emitAggregatedStmts() {
1360 if (AggregatedStmts.size() <= 1) {
Nick Lewycky8b4e3792013-09-11 02:03:20 +00001361 if (!AggregatedStmts.empty()) {
1362 CopyingValueRepresentation CVR(CGF);
1363 CGF.EmitStmt(AggregatedStmts[0]);
1364 }
Lang Hamesbf122742013-02-17 07:22:09 +00001365 reset();
1366 }
1367
1368 emitMemcpy();
1369 AggregatedStmts.clear();
1370 }
1371
1372 void finish() {
1373 emitAggregatedStmts();
1374 }
1375 };
Hans Wennborgdcfba332015-10-06 23:40:43 +00001376} // end anonymous namespace
Lang Hamesbf122742013-02-17 07:22:09 +00001377
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001378static bool isInitializerOfDynamicClass(const CXXCtorInitializer *BaseInit) {
1379 const Type *BaseType = BaseInit->getBaseClass();
1380 const auto *BaseClassDecl =
1381 cast<CXXRecordDecl>(BaseType->getAs<RecordType>()->getDecl());
1382 return BaseClassDecl->isDynamicClass();
1383}
1384
Anders Carlssonfb404882009-12-24 22:46:43 +00001385/// EmitCtorPrologue - This routine generates necessary code to initialize
1386/// base classes and non-static data members belonging to this constructor.
Anders Carlssonfb404882009-12-24 22:46:43 +00001387void CodeGenFunction::EmitCtorPrologue(const CXXConstructorDecl *CD,
Douglas Gregor94f9a482010-05-05 05:51:00 +00001388 CXXCtorType CtorType,
1389 FunctionArgList &Args) {
Alexis Hunt61bc1732011-05-01 07:04:31 +00001390 if (CD->isDelegatingConstructor())
1391 return EmitDelegatingCXXConstructorCall(CD, Args);
1392
Anders Carlssonfb404882009-12-24 22:46:43 +00001393 const CXXRecordDecl *ClassDecl = CD->getParent();
Anders Carlsson5dc86332010-02-02 19:58:43 +00001394
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001395 CXXConstructorDecl::init_const_iterator B = CD->init_begin(),
1396 E = CD->init_end();
1397
Craig Topper8a13c412014-05-21 05:09:00 +00001398 llvm::BasicBlock *BaseCtorContinueBB = nullptr;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001399 if (ClassDecl->getNumVBases() &&
1400 !CGM.getTarget().getCXXABI().hasConstructorVariants()) {
1401 // The ABIs that don't have constructor variants need to put a branch
1402 // before the virtual base initialization code.
Reid Kleckner7810af02013-06-19 15:20:38 +00001403 BaseCtorContinueBB =
1404 CGM.getCXXABI().EmitCtorCompleteObjectHandler(*this, ClassDecl);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001405 assert(BaseCtorContinueBB);
1406 }
1407
Piotr Padlewski276a78d2015-10-02 22:12:40 +00001408 llvm::Value *const OldThis = CXXThisValue;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001409 // Virtual base initializers first.
1410 for (; B != E && (*B)->isBaseInitializer() && (*B)->isBaseVirtual(); B++) {
Piotr Padlewski276a78d2015-10-02 22:12:40 +00001411 if (CGM.getCodeGenOpts().StrictVTablePointers &&
1412 CGM.getCodeGenOpts().OptimizationLevel > 0 &&
1413 isInitializerOfDynamicClass(*B))
1414 CXXThisValue = Builder.CreateInvariantGroupBarrier(LoadCXXThis());
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001415 EmitBaseInitializer(*this, ClassDecl, *B, CtorType);
1416 }
1417
1418 if (BaseCtorContinueBB) {
1419 // Complete object handler should continue to the remaining initializers.
1420 Builder.CreateBr(BaseCtorContinueBB);
1421 EmitBlock(BaseCtorContinueBB);
1422 }
1423
1424 // Then, non-virtual base initializers.
1425 for (; B != E && (*B)->isBaseInitializer(); B++) {
1426 assert(!(*B)->isBaseVirtual());
Piotr Padlewski276a78d2015-10-02 22:12:40 +00001427
1428 if (CGM.getCodeGenOpts().StrictVTablePointers &&
1429 CGM.getCodeGenOpts().OptimizationLevel > 0 &&
1430 isInitializerOfDynamicClass(*B))
1431 CXXThisValue = Builder.CreateInvariantGroupBarrier(LoadCXXThis());
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001432 EmitBaseInitializer(*this, ClassDecl, *B, CtorType);
Anders Carlssonfb404882009-12-24 22:46:43 +00001433 }
1434
Piotr Padlewski276a78d2015-10-02 22:12:40 +00001435 CXXThisValue = OldThis;
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001436
Anders Carlssond5895932010-03-28 21:07:49 +00001437 InitializeVTablePointers(ClassDecl);
Anders Carlsson5dc86332010-02-02 19:58:43 +00001438
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001439 // And finally, initialize class members.
John McCall7f416cc2015-09-08 08:05:57 +00001440 FieldConstructionScope FCS(*this, LoadCXXThisAddress());
Lang Hamesbf122742013-02-17 07:22:09 +00001441 ConstructorMemcpyizer CM(*this, CD, Args);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001442 for (; B != E; B++) {
1443 CXXCtorInitializer *Member = (*B);
1444 assert(!Member->isBaseInitializer());
1445 assert(Member->isAnyMemberInitializer() &&
1446 "Delegating initializer on non-delegating constructor");
1447 CM.addMemberInitializer(Member);
1448 }
Lang Hamesbf122742013-02-17 07:22:09 +00001449 CM.finish();
Anders Carlssonfb404882009-12-24 22:46:43 +00001450}
1451
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001452static bool
1453FieldHasTrivialDestructorBody(ASTContext &Context, const FieldDecl *Field);
1454
1455static bool
Justin Bogner1cd11f12015-05-20 15:53:59 +00001456HasTrivialDestructorBody(ASTContext &Context,
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001457 const CXXRecordDecl *BaseClassDecl,
1458 const CXXRecordDecl *MostDerivedClassDecl)
1459{
1460 // If the destructor is trivial we don't have to check anything else.
1461 if (BaseClassDecl->hasTrivialDestructor())
1462 return true;
1463
1464 if (!BaseClassDecl->getDestructor()->hasTrivialBody())
1465 return false;
1466
1467 // Check fields.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001468 for (const auto *Field : BaseClassDecl->fields())
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001469 if (!FieldHasTrivialDestructorBody(Context, Field))
1470 return false;
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001471
1472 // Check non-virtual bases.
Aaron Ballman574705e2014-03-13 15:41:46 +00001473 for (const auto &I : BaseClassDecl->bases()) {
1474 if (I.isVirtual())
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001475 continue;
1476
1477 const CXXRecordDecl *NonVirtualBase =
Aaron Ballman574705e2014-03-13 15:41:46 +00001478 cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001479 if (!HasTrivialDestructorBody(Context, NonVirtualBase,
1480 MostDerivedClassDecl))
1481 return false;
1482 }
1483
1484 if (BaseClassDecl == MostDerivedClassDecl) {
1485 // Check virtual bases.
Aaron Ballman445a9392014-03-13 16:15:17 +00001486 for (const auto &I : BaseClassDecl->vbases()) {
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001487 const CXXRecordDecl *VirtualBase =
Aaron Ballman445a9392014-03-13 16:15:17 +00001488 cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001489 if (!HasTrivialDestructorBody(Context, VirtualBase,
1490 MostDerivedClassDecl))
Justin Bogner1cd11f12015-05-20 15:53:59 +00001491 return false;
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001492 }
1493 }
1494
1495 return true;
1496}
1497
1498static bool
1499FieldHasTrivialDestructorBody(ASTContext &Context,
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001500 const FieldDecl *Field)
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001501{
1502 QualType FieldBaseElementType = Context.getBaseElementType(Field->getType());
1503
1504 const RecordType *RT = FieldBaseElementType->getAs<RecordType>();
1505 if (!RT)
1506 return true;
Justin Bogner1cd11f12015-05-20 15:53:59 +00001507
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001508 CXXRecordDecl *FieldClassDecl = cast<CXXRecordDecl>(RT->getDecl());
Davide Italiano982bbf42015-06-26 00:18:35 +00001509
1510 // The destructor for an implicit anonymous union member is never invoked.
1511 if (FieldClassDecl->isUnion() && FieldClassDecl->isAnonymousStructOrUnion())
1512 return false;
1513
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001514 return HasTrivialDestructorBody(Context, FieldClassDecl, FieldClassDecl);
1515}
1516
Anders Carlsson9bd7d162011-05-14 23:26:09 +00001517/// CanSkipVTablePointerInitialization - Check whether we need to initialize
1518/// any vtable pointers before calling this destructor.
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001519static bool CanSkipVTablePointerInitialization(CodeGenFunction &CGF,
Anders Carlssond6f15182011-05-16 04:08:36 +00001520 const CXXDestructorDecl *Dtor) {
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001521 const CXXRecordDecl *ClassDecl = Dtor->getParent();
1522 if (!ClassDecl->isDynamicClass())
1523 return true;
1524
Anders Carlsson9bd7d162011-05-14 23:26:09 +00001525 if (!Dtor->hasTrivialBody())
1526 return false;
1527
1528 // Check the fields.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001529 for (const auto *Field : ClassDecl->fields())
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001530 if (!FieldHasTrivialDestructorBody(CGF.getContext(), Field))
Anders Carlsson49c0bd22011-05-15 17:36:21 +00001531 return false;
Anders Carlsson9bd7d162011-05-14 23:26:09 +00001532
1533 return true;
1534}
1535
John McCallb81884d2010-02-19 09:25:03 +00001536/// EmitDestructorBody - Emits the body of the current destructor.
1537void CodeGenFunction::EmitDestructorBody(FunctionArgList &Args) {
1538 const CXXDestructorDecl *Dtor = cast<CXXDestructorDecl>(CurGD.getDecl());
1539 CXXDtorType DtorType = CurGD.getDtorType();
1540
Justin Bognerfb298222015-05-20 16:16:23 +00001541 Stmt *Body = Dtor->getBody();
1542 if (Body)
1543 incrementProfileCounter(Body);
1544
John McCallf99a6312010-07-21 05:30:47 +00001545 // The call to operator delete in a deleting destructor happens
1546 // outside of the function-try-block, which means it's always
1547 // possible to delegate the destructor body to the complete
1548 // destructor. Do so.
1549 if (DtorType == Dtor_Deleting) {
1550 EnterDtorCleanups(Dtor, Dtor_Deleting);
1551 EmitCXXDestructorCall(Dtor, Dtor_Complete, /*ForVirtualBase=*/false,
John McCall7f416cc2015-09-08 08:05:57 +00001552 /*Delegating=*/false, LoadCXXThisAddress());
John McCallf99a6312010-07-21 05:30:47 +00001553 PopCleanupBlock();
1554 return;
1555 }
1556
John McCallb81884d2010-02-19 09:25:03 +00001557 // If the body is a function-try-block, enter the try before
John McCallf99a6312010-07-21 05:30:47 +00001558 // anything else.
1559 bool isTryBody = (Body && isa<CXXTryStmt>(Body));
John McCallb81884d2010-02-19 09:25:03 +00001560 if (isTryBody)
John McCallb609d3f2010-07-07 06:56:46 +00001561 EnterCXXTryStmt(*cast<CXXTryStmt>(Body), true);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001562 EmitAsanPrologueOrEpilogue(false);
John McCallb81884d2010-02-19 09:25:03 +00001563
John McCallf99a6312010-07-21 05:30:47 +00001564 // Enter the epilogue cleanups.
1565 RunCleanupsScope DtorEpilogue(*this);
Justin Bogner1cd11f12015-05-20 15:53:59 +00001566
John McCallb81884d2010-02-19 09:25:03 +00001567 // If this is the complete variant, just invoke the base variant;
1568 // the epilogue will destruct the virtual bases. But we can't do
1569 // this optimization if the body is a function-try-block, because
Justin Bogner1cd11f12015-05-20 15:53:59 +00001570 // we'd introduce *two* handler blocks. In the Microsoft ABI, we
Reid Klecknere7de47e2013-07-22 13:51:44 +00001571 // always delegate because we might not have a definition in this TU.
John McCallf99a6312010-07-21 05:30:47 +00001572 switch (DtorType) {
Rafael Espindola1e4df922014-09-16 15:18:21 +00001573 case Dtor_Comdat:
1574 llvm_unreachable("not expecting a COMDAT");
1575
John McCallf99a6312010-07-21 05:30:47 +00001576 case Dtor_Deleting: llvm_unreachable("already handled deleting case");
1577
1578 case Dtor_Complete:
Reid Klecknere7de47e2013-07-22 13:51:44 +00001579 assert((Body || getTarget().getCXXABI().isMicrosoft()) &&
1580 "can't emit a dtor without a body for non-Microsoft ABIs");
1581
John McCallf99a6312010-07-21 05:30:47 +00001582 // Enter the cleanup scopes for virtual bases.
1583 EnterDtorCleanups(Dtor, Dtor_Complete);
1584
Reid Klecknere7de47e2013-07-22 13:51:44 +00001585 if (!isTryBody) {
John McCallf99a6312010-07-21 05:30:47 +00001586 EmitCXXDestructorCall(Dtor, Dtor_Base, /*ForVirtualBase=*/false,
John McCall7f416cc2015-09-08 08:05:57 +00001587 /*Delegating=*/false, LoadCXXThisAddress());
John McCallf99a6312010-07-21 05:30:47 +00001588 break;
1589 }
1590 // Fallthrough: act like we're in the base variant.
Justin Bogner1cd11f12015-05-20 15:53:59 +00001591
John McCallf99a6312010-07-21 05:30:47 +00001592 case Dtor_Base:
Reid Klecknere7de47e2013-07-22 13:51:44 +00001593 assert(Body);
1594
John McCallf99a6312010-07-21 05:30:47 +00001595 // Enter the cleanup scopes for fields and non-virtual bases.
1596 EnterDtorCleanups(Dtor, Dtor_Base);
1597
1598 // Initialize the vtable pointers before entering the body.
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001599 if (!CanSkipVTablePointerInitialization(*this, Dtor)) {
1600 // Insert the llvm.invariant.group.barrier intrinsic before initializing
1601 // the vptrs to cancel any previous assumptions we might have made.
1602 if (CGM.getCodeGenOpts().StrictVTablePointers &&
1603 CGM.getCodeGenOpts().OptimizationLevel > 0)
1604 CXXThisValue = Builder.CreateInvariantGroupBarrier(LoadCXXThis());
1605 InitializeVTablePointers(Dtor->getParent());
1606 }
John McCallf99a6312010-07-21 05:30:47 +00001607
1608 if (isTryBody)
1609 EmitStmt(cast<CXXTryStmt>(Body)->getTryBlock());
1610 else if (Body)
1611 EmitStmt(Body);
1612 else {
1613 assert(Dtor->isImplicit() && "bodyless dtor not implicit");
1614 // nothing to do besides what's in the epilogue
1615 }
Fariborz Jahanian0c12ed12011-02-02 23:12:46 +00001616 // -fapple-kext must inline any call to this dtor into
1617 // the caller's body.
Richard Smith9c6890a2012-11-01 22:30:59 +00001618 if (getLangOpts().AppleKext)
Evgeniy Stepanov6b2a61d2015-09-14 21:35:16 +00001619 CurFn->addFnAttr(llvm::Attribute::AlwaysInline);
Naomi Musgravee50cb9b2015-08-13 18:35:11 +00001620
John McCallf99a6312010-07-21 05:30:47 +00001621 break;
John McCallb81884d2010-02-19 09:25:03 +00001622 }
1623
John McCallf99a6312010-07-21 05:30:47 +00001624 // Jump out through the epilogue cleanups.
1625 DtorEpilogue.ForceCleanup();
John McCallb81884d2010-02-19 09:25:03 +00001626
1627 // Exit the try if applicable.
1628 if (isTryBody)
John McCallb609d3f2010-07-07 06:56:46 +00001629 ExitCXXTryStmt(*cast<CXXTryStmt>(Body), true);
John McCallb81884d2010-02-19 09:25:03 +00001630}
1631
Lang Hamesbf122742013-02-17 07:22:09 +00001632void CodeGenFunction::emitImplicitAssignmentOperatorBody(FunctionArgList &Args) {
1633 const CXXMethodDecl *AssignOp = cast<CXXMethodDecl>(CurGD.getDecl());
1634 const Stmt *RootS = AssignOp->getBody();
1635 assert(isa<CompoundStmt>(RootS) &&
1636 "Body of an implicit assignment operator should be compound stmt.");
1637 const CompoundStmt *RootCS = cast<CompoundStmt>(RootS);
1638
1639 LexicalScope Scope(*this, RootCS->getSourceRange());
1640
Xinliang David Lia951e8e2016-02-09 20:02:59 +00001641 incrementProfileCounter(RootCS);
Lang Hamesbf122742013-02-17 07:22:09 +00001642 AssignmentMemcpyizer AM(*this, AssignOp, Args);
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001643 for (auto *I : RootCS->body())
Justin Bogner1cd11f12015-05-20 15:53:59 +00001644 AM.emitAssignment(I);
Lang Hamesbf122742013-02-17 07:22:09 +00001645 AM.finish();
1646}
1647
John McCallf99a6312010-07-21 05:30:47 +00001648namespace {
1649 /// Call the operator delete associated with the current destructor.
David Blaikie7e70d682015-08-18 22:40:54 +00001650 struct CallDtorDelete final : EHScopeStack::Cleanup {
John McCallf99a6312010-07-21 05:30:47 +00001651 CallDtorDelete() {}
1652
Craig Topper4f12f102014-03-12 06:41:41 +00001653 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallf99a6312010-07-21 05:30:47 +00001654 const CXXDestructorDecl *Dtor = cast<CXXDestructorDecl>(CGF.CurCodeDecl);
1655 const CXXRecordDecl *ClassDecl = Dtor->getParent();
1656 CGF.EmitDeleteCall(Dtor->getOperatorDelete(), CGF.LoadCXXThis(),
1657 CGF.getContext().getTagDeclType(ClassDecl));
1658 }
1659 };
1660
David Blaikie7e70d682015-08-18 22:40:54 +00001661 struct CallDtorDeleteConditional final : EHScopeStack::Cleanup {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001662 llvm::Value *ShouldDeleteCondition;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001663
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001664 public:
1665 CallDtorDeleteConditional(llvm::Value *ShouldDeleteCondition)
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001666 : ShouldDeleteCondition(ShouldDeleteCondition) {
Craig Topper8a13c412014-05-21 05:09:00 +00001667 assert(ShouldDeleteCondition != nullptr);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001668 }
1669
Craig Topper4f12f102014-03-12 06:41:41 +00001670 void Emit(CodeGenFunction &CGF, Flags flags) override {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001671 llvm::BasicBlock *callDeleteBB = CGF.createBasicBlock("dtor.call_delete");
1672 llvm::BasicBlock *continueBB = CGF.createBasicBlock("dtor.continue");
1673 llvm::Value *ShouldCallDelete
1674 = CGF.Builder.CreateIsNull(ShouldDeleteCondition);
1675 CGF.Builder.CreateCondBr(ShouldCallDelete, continueBB, callDeleteBB);
1676
1677 CGF.EmitBlock(callDeleteBB);
1678 const CXXDestructorDecl *Dtor = cast<CXXDestructorDecl>(CGF.CurCodeDecl);
1679 const CXXRecordDecl *ClassDecl = Dtor->getParent();
1680 CGF.EmitDeleteCall(Dtor->getOperatorDelete(), CGF.LoadCXXThis(),
1681 CGF.getContext().getTagDeclType(ClassDecl));
1682 CGF.Builder.CreateBr(continueBB);
1683
1684 CGF.EmitBlock(continueBB);
1685 }
1686 };
1687
David Blaikie7e70d682015-08-18 22:40:54 +00001688 class DestroyField final : public EHScopeStack::Cleanup {
John McCall4bd0fb12011-07-12 16:41:08 +00001689 const FieldDecl *field;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001690 CodeGenFunction::Destroyer *destroyer;
John McCall4bd0fb12011-07-12 16:41:08 +00001691 bool useEHCleanupForArray;
John McCallf99a6312010-07-21 05:30:47 +00001692
John McCall4bd0fb12011-07-12 16:41:08 +00001693 public:
1694 DestroyField(const FieldDecl *field, CodeGenFunction::Destroyer *destroyer,
1695 bool useEHCleanupForArray)
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001696 : field(field), destroyer(destroyer),
1697 useEHCleanupForArray(useEHCleanupForArray) {}
John McCallf99a6312010-07-21 05:30:47 +00001698
Craig Topper4f12f102014-03-12 06:41:41 +00001699 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall4bd0fb12011-07-12 16:41:08 +00001700 // Find the address of the field.
John McCall7f416cc2015-09-08 08:05:57 +00001701 Address thisValue = CGF.LoadCXXThisAddress();
Eli Friedman7f1ff602012-04-16 03:54:45 +00001702 QualType RecordTy = CGF.getContext().getTagDeclType(field->getParent());
1703 LValue ThisLV = CGF.MakeAddrLValue(thisValue, RecordTy);
1704 LValue LV = CGF.EmitLValueForField(ThisLV, field);
John McCall4bd0fb12011-07-12 16:41:08 +00001705 assert(LV.isSimple());
Justin Bogner1cd11f12015-05-20 15:53:59 +00001706
John McCall4bd0fb12011-07-12 16:41:08 +00001707 CGF.emitDestroy(LV.getAddress(), field->getType(), destroyer,
John McCall30317fd2011-07-12 20:27:29 +00001708 flags.isForNormalCleanup() && useEHCleanupForArray);
John McCallf99a6312010-07-21 05:30:47 +00001709 }
1710 };
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001711
Naomi Musgrave703835c2015-09-16 00:38:22 +00001712 static void EmitSanitizerDtorCallback(CodeGenFunction &CGF, llvm::Value *Ptr,
1713 CharUnits::QuantityType PoisonSize) {
1714 // Pass in void pointer and size of region as arguments to runtime
1715 // function
1716 llvm::Value *Args[] = {CGF.Builder.CreateBitCast(Ptr, CGF.VoidPtrTy),
1717 llvm::ConstantInt::get(CGF.SizeTy, PoisonSize)};
1718
1719 llvm::Type *ArgTypes[] = {CGF.VoidPtrTy, CGF.SizeTy};
1720
1721 llvm::FunctionType *FnType =
1722 llvm::FunctionType::get(CGF.VoidTy, ArgTypes, false);
1723 llvm::Value *Fn =
1724 CGF.CGM.CreateRuntimeFunction(FnType, "__sanitizer_dtor_callback");
1725 CGF.EmitNounwindRuntimeCall(Fn, Args);
1726 }
1727
1728 class SanitizeDtorMembers final : public EHScopeStack::Cleanup {
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001729 const CXXDestructorDecl *Dtor;
1730
1731 public:
Naomi Musgrave703835c2015-09-16 00:38:22 +00001732 SanitizeDtorMembers(const CXXDestructorDecl *Dtor) : Dtor(Dtor) {}
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001733
1734 // Generate function call for handling object poisoning.
1735 // Disables tail call elimination, to prevent the current stack frame
1736 // from disappearing from the stack trace.
1737 void Emit(CodeGenFunction &CGF, Flags flags) override {
1738 const ASTRecordLayout &Layout =
1739 CGF.getContext().getASTRecordLayout(Dtor->getParent());
1740
1741 // Nothing to poison.
1742 if (Layout.getFieldCount() == 0)
1743 return;
1744
1745 // Prevent the current stack frame from disappearing from the stack trace.
1746 CGF.CurFn->addFnAttr("disable-tail-calls", "true");
1747
1748 // Construct pointer to region to begin poisoning, and calculate poison
1749 // size, so that only members declared in this class are poisoned.
1750 ASTContext &Context = CGF.getContext();
1751 unsigned fieldIndex = 0;
1752 int startIndex = -1;
1753 // RecordDecl::field_iterator Field;
1754 for (const FieldDecl *Field : Dtor->getParent()->fields()) {
1755 // Poison field if it is trivial
1756 if (FieldHasTrivialDestructorBody(Context, Field)) {
1757 // Start sanitizing at this field
1758 if (startIndex < 0)
1759 startIndex = fieldIndex;
1760
1761 // Currently on the last field, and it must be poisoned with the
1762 // current block.
1763 if (fieldIndex == Layout.getFieldCount() - 1) {
Naomi Musgrave703835c2015-09-16 00:38:22 +00001764 PoisonMembers(CGF, startIndex, Layout.getFieldCount());
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001765 }
1766 } else if (startIndex >= 0) {
1767 // No longer within a block of memory to poison, so poison the block
Naomi Musgrave703835c2015-09-16 00:38:22 +00001768 PoisonMembers(CGF, startIndex, fieldIndex);
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001769 // Re-set the start index
1770 startIndex = -1;
1771 }
1772 fieldIndex += 1;
1773 }
1774 }
1775
1776 private:
NAKAMURA Takumif6cef72f2015-09-04 05:19:31 +00001777 /// \param layoutStartOffset index of the ASTRecordLayout field to
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001778 /// start poisoning (inclusive)
NAKAMURA Takumif6cef72f2015-09-04 05:19:31 +00001779 /// \param layoutEndOffset index of the ASTRecordLayout field to
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001780 /// end poisoning (exclusive)
Naomi Musgrave703835c2015-09-16 00:38:22 +00001781 void PoisonMembers(CodeGenFunction &CGF, unsigned layoutStartOffset,
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001782 unsigned layoutEndOffset) {
1783 ASTContext &Context = CGF.getContext();
1784 const ASTRecordLayout &Layout =
1785 Context.getASTRecordLayout(Dtor->getParent());
1786
1787 llvm::ConstantInt *OffsetSizePtr = llvm::ConstantInt::get(
1788 CGF.SizeTy,
1789 Context.toCharUnitsFromBits(Layout.getFieldOffset(layoutStartOffset))
1790 .getQuantity());
1791
1792 llvm::Value *OffsetPtr = CGF.Builder.CreateGEP(
1793 CGF.Builder.CreateBitCast(CGF.LoadCXXThis(), CGF.Int8PtrTy),
1794 OffsetSizePtr);
1795
1796 CharUnits::QuantityType PoisonSize;
1797 if (layoutEndOffset >= Layout.getFieldCount()) {
1798 PoisonSize = Layout.getNonVirtualSize().getQuantity() -
1799 Context.toCharUnitsFromBits(
1800 Layout.getFieldOffset(layoutStartOffset))
1801 .getQuantity();
1802 } else {
1803 PoisonSize = Context.toCharUnitsFromBits(
1804 Layout.getFieldOffset(layoutEndOffset) -
1805 Layout.getFieldOffset(layoutStartOffset))
1806 .getQuantity();
1807 }
1808
1809 if (PoisonSize == 0)
1810 return;
1811
Naomi Musgrave703835c2015-09-16 00:38:22 +00001812 EmitSanitizerDtorCallback(CGF, OffsetPtr, PoisonSize);
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001813 }
1814 };
Naomi Musgrave703835c2015-09-16 00:38:22 +00001815
1816 class SanitizeDtorVTable final : public EHScopeStack::Cleanup {
1817 const CXXDestructorDecl *Dtor;
1818
1819 public:
1820 SanitizeDtorVTable(const CXXDestructorDecl *Dtor) : Dtor(Dtor) {}
1821
1822 // Generate function call for handling vtable pointer poisoning.
1823 void Emit(CodeGenFunction &CGF, Flags flags) override {
1824 assert(Dtor->getParent()->isDynamicClass());
NAKAMURA Takumiee82b492015-09-16 06:26:56 +00001825 (void)Dtor;
Naomi Musgrave703835c2015-09-16 00:38:22 +00001826 ASTContext &Context = CGF.getContext();
1827 // Poison vtable and vtable ptr if they exist for this class.
1828 llvm::Value *VTablePtr = CGF.LoadCXXThis();
1829
1830 CharUnits::QuantityType PoisonSize =
1831 Context.toCharUnitsFromBits(CGF.PointerWidthInBits).getQuantity();
1832 // Pass in void pointer and size of region as arguments to runtime
1833 // function
1834 EmitSanitizerDtorCallback(CGF, VTablePtr, PoisonSize);
1835 }
1836 };
Hans Wennborgdcfba332015-10-06 23:40:43 +00001837} // end anonymous namespace
John McCallf99a6312010-07-21 05:30:47 +00001838
Hans Wennborgdeff7032013-12-18 01:39:59 +00001839/// \brief Emit all code that comes at the end of class's
Anders Carlssonfb404882009-12-24 22:46:43 +00001840/// destructor. This is to call destructors on members and base classes
1841/// in reverse order of their construction.
John McCallf99a6312010-07-21 05:30:47 +00001842void CodeGenFunction::EnterDtorCleanups(const CXXDestructorDecl *DD,
1843 CXXDtorType DtorType) {
Hans Wennborg853ae942014-05-30 16:59:42 +00001844 assert((!DD->isTrivial() || DD->hasAttr<DLLExportAttr>()) &&
1845 "Should not emit dtor epilogue for non-exported trivial dtor!");
Anders Carlssonfb404882009-12-24 22:46:43 +00001846
John McCallf99a6312010-07-21 05:30:47 +00001847 // The deleting-destructor phase just needs to call the appropriate
1848 // operator delete that Sema picked up.
John McCall5c60a6f2010-02-18 19:59:28 +00001849 if (DtorType == Dtor_Deleting) {
Justin Bogner1cd11f12015-05-20 15:53:59 +00001850 assert(DD->getOperatorDelete() &&
Hans Wennborgdeff7032013-12-18 01:39:59 +00001851 "operator delete missing - EnterDtorCleanups");
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001852 if (CXXStructorImplicitParamValue) {
1853 // If there is an implicit param to the deleting dtor, it's a boolean
1854 // telling whether we should call delete at the end of the dtor.
1855 EHStack.pushCleanup<CallDtorDeleteConditional>(
1856 NormalAndEHCleanup, CXXStructorImplicitParamValue);
1857 } else {
1858 EHStack.pushCleanup<CallDtorDelete>(NormalAndEHCleanup);
1859 }
John McCall5c60a6f2010-02-18 19:59:28 +00001860 return;
1861 }
1862
John McCallf99a6312010-07-21 05:30:47 +00001863 const CXXRecordDecl *ClassDecl = DD->getParent();
1864
Richard Smith20104042011-09-18 12:11:43 +00001865 // Unions have no bases and do not call field destructors.
1866 if (ClassDecl->isUnion())
1867 return;
1868
John McCallf99a6312010-07-21 05:30:47 +00001869 // The complete-destructor phase just destructs all the virtual bases.
John McCall5c60a6f2010-02-18 19:59:28 +00001870 if (DtorType == Dtor_Complete) {
Naomi Musgrave703835c2015-09-16 00:38:22 +00001871 // Poison the vtable pointer such that access after the base
1872 // and member destructors are invoked is invalid.
1873 if (CGM.getCodeGenOpts().SanitizeMemoryUseAfterDtor &&
1874 SanOpts.has(SanitizerKind::Memory) && ClassDecl->getNumVBases() &&
1875 ClassDecl->isPolymorphic())
1876 EHStack.pushCleanup<SanitizeDtorVTable>(NormalAndEHCleanup, DD);
John McCallf99a6312010-07-21 05:30:47 +00001877
1878 // We push them in the forward order so that they'll be popped in
1879 // the reverse order.
Aaron Ballman445a9392014-03-13 16:15:17 +00001880 for (const auto &Base : ClassDecl->vbases()) {
John McCall5c60a6f2010-02-18 19:59:28 +00001881 CXXRecordDecl *BaseClassDecl
1882 = cast<CXXRecordDecl>(Base.getType()->getAs<RecordType>()->getDecl());
Justin Bogner1cd11f12015-05-20 15:53:59 +00001883
John McCall5c60a6f2010-02-18 19:59:28 +00001884 // Ignore trivial destructors.
1885 if (BaseClassDecl->hasTrivialDestructor())
1886 continue;
John McCallf99a6312010-07-21 05:30:47 +00001887
John McCallcda666c2010-07-21 07:22:38 +00001888 EHStack.pushCleanup<CallBaseDtor>(NormalAndEHCleanup,
1889 BaseClassDecl,
1890 /*BaseIsVirtual*/ true);
John McCall5c60a6f2010-02-18 19:59:28 +00001891 }
John McCallf99a6312010-07-21 05:30:47 +00001892
John McCall5c60a6f2010-02-18 19:59:28 +00001893 return;
1894 }
1895
1896 assert(DtorType == Dtor_Base);
Naomi Musgrave703835c2015-09-16 00:38:22 +00001897 // Poison the vtable pointer if it has no virtual bases, but inherits
1898 // virtual functions.
1899 if (CGM.getCodeGenOpts().SanitizeMemoryUseAfterDtor &&
1900 SanOpts.has(SanitizerKind::Memory) && !ClassDecl->getNumVBases() &&
1901 ClassDecl->isPolymorphic())
1902 EHStack.pushCleanup<SanitizeDtorVTable>(NormalAndEHCleanup, DD);
Justin Bogner1cd11f12015-05-20 15:53:59 +00001903
John McCallf99a6312010-07-21 05:30:47 +00001904 // Destroy non-virtual bases.
Aaron Ballman574705e2014-03-13 15:41:46 +00001905 for (const auto &Base : ClassDecl->bases()) {
John McCallf99a6312010-07-21 05:30:47 +00001906 // Ignore virtual bases.
1907 if (Base.isVirtual())
1908 continue;
Justin Bogner1cd11f12015-05-20 15:53:59 +00001909
John McCallf99a6312010-07-21 05:30:47 +00001910 CXXRecordDecl *BaseClassDecl = Base.getType()->getAsCXXRecordDecl();
Justin Bogner1cd11f12015-05-20 15:53:59 +00001911
John McCallf99a6312010-07-21 05:30:47 +00001912 // Ignore trivial destructors.
1913 if (BaseClassDecl->hasTrivialDestructor())
1914 continue;
John McCall5c60a6f2010-02-18 19:59:28 +00001915
John McCallcda666c2010-07-21 07:22:38 +00001916 EHStack.pushCleanup<CallBaseDtor>(NormalAndEHCleanup,
1917 BaseClassDecl,
1918 /*BaseIsVirtual*/ false);
John McCallf99a6312010-07-21 05:30:47 +00001919 }
1920
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001921 // Poison fields such that access after their destructors are
1922 // invoked, and before the base class destructor runs, is invalid.
1923 if (CGM.getCodeGenOpts().SanitizeMemoryUseAfterDtor &&
1924 SanOpts.has(SanitizerKind::Memory))
Naomi Musgrave703835c2015-09-16 00:38:22 +00001925 EHStack.pushCleanup<SanitizeDtorMembers>(NormalAndEHCleanup, DD);
Naomi Musgrave866af2d2015-09-03 23:02:30 +00001926
John McCallf99a6312010-07-21 05:30:47 +00001927 // Destroy direct fields.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001928 for (const auto *Field : ClassDecl->fields()) {
1929 QualType type = Field->getType();
John McCall4bd0fb12011-07-12 16:41:08 +00001930 QualType::DestructionKind dtorKind = type.isDestructedType();
1931 if (!dtorKind) continue;
John McCallf99a6312010-07-21 05:30:47 +00001932
Richard Smith921bd202012-02-26 09:11:52 +00001933 // Anonymous union members do not have their destructors called.
1934 const RecordType *RT = type->getAsUnionType();
1935 if (RT && RT->getDecl()->isAnonymousStructOrUnion()) continue;
1936
John McCall4bd0fb12011-07-12 16:41:08 +00001937 CleanupKind cleanupKind = getCleanupKind(dtorKind);
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001938 EHStack.pushCleanup<DestroyField>(cleanupKind, Field,
John McCall4bd0fb12011-07-12 16:41:08 +00001939 getDestroyer(dtorKind),
1940 cleanupKind & EHCleanup);
Anders Carlssonfb404882009-12-24 22:46:43 +00001941 }
Anders Carlssonfb404882009-12-24 22:46:43 +00001942}
1943
John McCallf677a8e2011-07-13 06:10:41 +00001944/// EmitCXXAggrConstructorCall - Emit a loop to call a particular
1945/// constructor for each of several members of an array.
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001946///
John McCallf677a8e2011-07-13 06:10:41 +00001947/// \param ctor the constructor to call for each element
John McCallf677a8e2011-07-13 06:10:41 +00001948/// \param arrayType the type of the array to initialize
1949/// \param arrayBegin an arrayType*
1950/// \param zeroInitialize true if each element should be
1951/// zero-initialized before it is constructed
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001952void CodeGenFunction::EmitCXXAggrConstructorCall(
Alexey Bataeve7545b32016-04-29 09:39:50 +00001953 const CXXConstructorDecl *ctor, const ArrayType *arrayType,
John McCall7f416cc2015-09-08 08:05:57 +00001954 Address arrayBegin, const CXXConstructExpr *E, bool zeroInitialize) {
John McCallf677a8e2011-07-13 06:10:41 +00001955 QualType elementType;
1956 llvm::Value *numElements =
1957 emitArrayLength(arrayType, elementType, arrayBegin);
Anders Carlsson27da15b2010-01-01 20:29:01 +00001958
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001959 EmitCXXAggrConstructorCall(ctor, numElements, arrayBegin, E, zeroInitialize);
Anders Carlsson27da15b2010-01-01 20:29:01 +00001960}
1961
John McCallf677a8e2011-07-13 06:10:41 +00001962/// EmitCXXAggrConstructorCall - Emit a loop to call a particular
1963/// constructor for each of several members of an array.
1964///
1965/// \param ctor the constructor to call for each element
1966/// \param numElements the number of elements in the array;
John McCall6549b312011-07-13 07:37:11 +00001967/// may be zero
NAKAMURA Takumiff7a9252015-09-08 09:42:41 +00001968/// \param arrayBase a T*, where T is the type constructed by ctor
John McCallf677a8e2011-07-13 06:10:41 +00001969/// \param zeroInitialize true if each element should be
1970/// zero-initialized before it is constructed
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001971void CodeGenFunction::EmitCXXAggrConstructorCall(const CXXConstructorDecl *ctor,
1972 llvm::Value *numElements,
John McCall7f416cc2015-09-08 08:05:57 +00001973 Address arrayBase,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001974 const CXXConstructExpr *E,
1975 bool zeroInitialize) {
John McCall6549b312011-07-13 07:37:11 +00001976 // It's legal for numElements to be zero. This can happen both
1977 // dynamically, because x can be zero in 'new A[x]', and statically,
1978 // because of GCC extensions that permit zero-length arrays. There
1979 // are probably legitimate places where we could assume that this
1980 // doesn't happen, but it's not clear that it's worth it.
Craig Topper8a13c412014-05-21 05:09:00 +00001981 llvm::BranchInst *zeroCheckBranch = nullptr;
John McCall6549b312011-07-13 07:37:11 +00001982
1983 // Optimize for a constant count.
1984 llvm::ConstantInt *constantCount
1985 = dyn_cast<llvm::ConstantInt>(numElements);
1986 if (constantCount) {
1987 // Just skip out if the constant count is zero.
1988 if (constantCount->isZero()) return;
1989
1990 // Otherwise, emit the check.
1991 } else {
1992 llvm::BasicBlock *loopBB = createBasicBlock("new.ctorloop");
1993 llvm::Value *iszero = Builder.CreateIsNull(numElements, "isempty");
1994 zeroCheckBranch = Builder.CreateCondBr(iszero, loopBB, loopBB);
1995 EmitBlock(loopBB);
1996 }
Justin Bogner1cd11f12015-05-20 15:53:59 +00001997
John McCallf677a8e2011-07-13 06:10:41 +00001998 // Find the end of the array.
John McCall7f416cc2015-09-08 08:05:57 +00001999 llvm::Value *arrayBegin = arrayBase.getPointer();
John McCallf677a8e2011-07-13 06:10:41 +00002000 llvm::Value *arrayEnd = Builder.CreateInBoundsGEP(arrayBegin, numElements,
2001 "arrayctor.end");
Anders Carlsson27da15b2010-01-01 20:29:01 +00002002
John McCallf677a8e2011-07-13 06:10:41 +00002003 // Enter the loop, setting up a phi for the current location to initialize.
2004 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
2005 llvm::BasicBlock *loopBB = createBasicBlock("arrayctor.loop");
2006 EmitBlock(loopBB);
2007 llvm::PHINode *cur = Builder.CreatePHI(arrayBegin->getType(), 2,
2008 "arrayctor.cur");
2009 cur->addIncoming(arrayBegin, entryBB);
Anders Carlsson27da15b2010-01-01 20:29:01 +00002010
Anders Carlsson27da15b2010-01-01 20:29:01 +00002011 // Inside the loop body, emit the constructor call on the array element.
John McCallf677a8e2011-07-13 06:10:41 +00002012
John McCall7f416cc2015-09-08 08:05:57 +00002013 // The alignment of the base, adjusted by the size of a single element,
2014 // provides a conservative estimate of the alignment of every element.
2015 // (This assumes we never start tracking offsetted alignments.)
2016 //
2017 // Note that these are complete objects and so we don't need to
2018 // use the non-virtual size or alignment.
John McCallf677a8e2011-07-13 06:10:41 +00002019 QualType type = getContext().getTypeDeclType(ctor->getParent());
John McCall7f416cc2015-09-08 08:05:57 +00002020 CharUnits eltAlignment =
2021 arrayBase.getAlignment()
2022 .alignmentOfArrayElement(getContext().getTypeSizeInChars(type));
2023 Address curAddr = Address(cur, eltAlignment);
Anders Carlsson27da15b2010-01-01 20:29:01 +00002024
Douglas Gregor05fc5be2010-07-21 01:10:17 +00002025 // Zero initialize the storage, if requested.
John McCallf677a8e2011-07-13 06:10:41 +00002026 if (zeroInitialize)
John McCall7f416cc2015-09-08 08:05:57 +00002027 EmitNullInitialization(curAddr, type);
Justin Bogner1cd11f12015-05-20 15:53:59 +00002028
2029 // C++ [class.temporary]p4:
Anders Carlsson27da15b2010-01-01 20:29:01 +00002030 // There are two contexts in which temporaries are destroyed at a different
2031 // point than the end of the full-expression. The first context is when a
Justin Bogner1cd11f12015-05-20 15:53:59 +00002032 // default constructor is called to initialize an element of an array.
2033 // If the constructor has one or more default arguments, the destruction of
2034 // every temporary created in a default argument expression is sequenced
Anders Carlsson27da15b2010-01-01 20:29:01 +00002035 // before the construction of the next array element, if any.
Justin Bogner1cd11f12015-05-20 15:53:59 +00002036
Anders Carlssonb9fd57f2010-03-30 03:14:41 +00002037 {
John McCallbd309292010-07-06 01:34:17 +00002038 RunCleanupsScope Scope(*this);
Anders Carlsson27da15b2010-01-01 20:29:01 +00002039
John McCallf677a8e2011-07-13 06:10:41 +00002040 // Evaluate the constructor and its arguments in a regular
2041 // partial-destroy cleanup.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002042 if (getLangOpts().Exceptions &&
John McCallf677a8e2011-07-13 06:10:41 +00002043 !ctor->getParent()->hasTrivialDestructor()) {
2044 Destroyer *destroyer = destroyCXXObject;
John McCall7f416cc2015-09-08 08:05:57 +00002045 pushRegularPartialArrayCleanup(arrayBegin, cur, type, eltAlignment,
2046 *destroyer);
John McCallf677a8e2011-07-13 06:10:41 +00002047 }
2048
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002049 EmitCXXConstructorCall(ctor, Ctor_Complete, /*ForVirtualBase=*/false,
John McCall7f416cc2015-09-08 08:05:57 +00002050 /*Delegating=*/false, curAddr, E);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +00002051 }
Anders Carlsson27da15b2010-01-01 20:29:01 +00002052
John McCallf677a8e2011-07-13 06:10:41 +00002053 // Go to the next element.
2054 llvm::Value *next =
2055 Builder.CreateInBoundsGEP(cur, llvm::ConstantInt::get(SizeTy, 1),
2056 "arrayctor.next");
2057 cur->addIncoming(next, Builder.GetInsertBlock());
Anders Carlsson27da15b2010-01-01 20:29:01 +00002058
John McCallf677a8e2011-07-13 06:10:41 +00002059 // Check whether that's the end of the loop.
2060 llvm::Value *done = Builder.CreateICmpEQ(next, arrayEnd, "arrayctor.done");
2061 llvm::BasicBlock *contBB = createBasicBlock("arrayctor.cont");
2062 Builder.CreateCondBr(done, contBB, loopBB);
Anders Carlsson27da15b2010-01-01 20:29:01 +00002063
John McCall6549b312011-07-13 07:37:11 +00002064 // Patch the earlier check to skip over the loop.
2065 if (zeroCheckBranch) zeroCheckBranch->setSuccessor(0, contBB);
2066
John McCallf677a8e2011-07-13 06:10:41 +00002067 EmitBlock(contBB);
Anders Carlsson27da15b2010-01-01 20:29:01 +00002068}
2069
John McCall82fe67b2011-07-09 01:37:26 +00002070void CodeGenFunction::destroyCXXObject(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002071 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002072 QualType type) {
2073 const RecordType *rtype = type->castAs<RecordType>();
2074 const CXXRecordDecl *record = cast<CXXRecordDecl>(rtype->getDecl());
2075 const CXXDestructorDecl *dtor = record->getDestructor();
2076 assert(!dtor->isTrivial());
2077 CGF.EmitCXXDestructorCall(dtor, Dtor_Complete, /*for vbase*/ false,
Douglas Gregor61535002013-01-31 05:50:40 +00002078 /*Delegating=*/false, addr);
John McCall82fe67b2011-07-09 01:37:26 +00002079}
2080
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002081void CodeGenFunction::EmitCXXConstructorCall(const CXXConstructorDecl *D,
2082 CXXCtorType Type,
2083 bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +00002084 bool Delegating, Address This,
Alexey Samsonov70b9c012014-08-21 20:26:47 +00002085 const CXXConstructExpr *E) {
Richard Smith5179eb72016-06-28 19:03:57 +00002086 CallArgList Args;
2087
2088 // Push the this ptr.
2089 Args.add(RValue::get(This.getPointer()), D->getThisType(getContext()));
2090
2091 // If this is a trivial constructor, emit a memcpy now before we lose
2092 // the alignment information on the argument.
2093 // FIXME: It would be better to preserve alignment information into CallArg.
2094 if (isMemcpyEquivalentSpecialMember(D)) {
2095 assert(E->getNumArgs() == 1 && "unexpected argcount for trivial ctor");
2096
2097 const Expr *Arg = E->getArg(0);
2098 QualType SrcTy = Arg->getType();
2099 Address Src = EmitLValue(Arg).getAddress();
2100 QualType DestTy = getContext().getTypeDeclType(D->getParent());
2101 EmitAggregateCopyCtor(This, Src, DestTy, SrcTy);
2102 return;
2103 }
2104
2105 // Add the rest of the user-supplied arguments.
2106 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
2107 EmitCallArgs(Args, FPT, E->arguments(), E->getConstructor());
2108
2109 EmitCXXConstructorCall(D, Type, ForVirtualBase, Delegating, This, Args);
2110}
2111
2112static bool canEmitDelegateCallArgs(CodeGenFunction &CGF,
2113 const CXXConstructorDecl *Ctor,
2114 CXXCtorType Type, CallArgList &Args) {
2115 // We can't forward a variadic call.
2116 if (Ctor->isVariadic())
2117 return false;
2118
2119 if (CGF.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2120 // If the parameters are callee-cleanup, it's not safe to forward.
2121 for (auto *P : Ctor->parameters())
2122 if (P->getType().isDestructedType())
2123 return false;
2124
2125 // Likewise if they're inalloca.
2126 const CGFunctionInfo &Info =
2127 CGF.CGM.getTypes().arrangeCXXConstructorCall(Args, Ctor, Type, 0);
2128 if (Info.usesInAlloca())
2129 return false;
2130 }
2131
2132 // Anything else should be OK.
2133 return true;
2134}
2135
2136void CodeGenFunction::EmitCXXConstructorCall(const CXXConstructorDecl *D,
2137 CXXCtorType Type,
2138 bool ForVirtualBase,
2139 bool Delegating,
2140 Address This,
2141 CallArgList &Args) {
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002142 const CXXRecordDecl *ClassDecl = D->getParent();
2143
Richard Smith419bd092015-04-29 19:26:57 +00002144 // C++11 [class.mfct.non-static]p2:
2145 // If a non-static member function of a class X is called for an object that
2146 // is not of type X, or of a type derived from X, the behavior is undefined.
2147 // FIXME: Provide a source location here.
John McCall7f416cc2015-09-08 08:05:57 +00002148 EmitTypeCheck(CodeGenFunction::TCK_ConstructorCall, SourceLocation(),
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002149 This.getPointer(), getContext().getRecordType(ClassDecl));
John McCallca972cd2010-02-06 00:25:16 +00002150
Richard Smith419bd092015-04-29 19:26:57 +00002151 if (D->isTrivial() && D->isDefaultConstructor()) {
Richard Smith5179eb72016-06-28 19:03:57 +00002152 assert(Args.size() == 1 && "trivial default ctor with args");
Richard Smith419bd092015-04-29 19:26:57 +00002153 return;
2154 }
2155
2156 // If this is a trivial constructor, just emit what's needed. If this is a
2157 // union copy constructor, we must emit a memcpy, because the AST does not
2158 // model that copy.
2159 if (isMemcpyEquivalentSpecialMember(D)) {
Richard Smith5179eb72016-06-28 19:03:57 +00002160 assert(Args.size() == 2 && "unexpected argcount for trivial ctor");
John McCallca972cd2010-02-06 00:25:16 +00002161
Richard Smith5179eb72016-06-28 19:03:57 +00002162 QualType SrcTy = D->getParamDecl(0)->getType().getNonReferenceType();
2163 Address Src(Args[1].RV.getScalarVal(), getNaturalTypeAlignment(SrcTy));
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002164 QualType DestTy = getContext().getTypeDeclType(ClassDecl);
David Majnemerfd1e7392015-02-03 23:04:06 +00002165 EmitAggregateCopyCtor(This, Src, DestTy, SrcTy);
Anders Carlsson27da15b2010-01-01 20:29:01 +00002166 return;
2167 }
2168
Richard Smith5179eb72016-06-28 19:03:57 +00002169 // Check whether we can actually emit the constructor before trying to do so.
2170 if (auto Inherited = D->getInheritedConstructor()) {
2171 if (getTypes().inheritingCtorHasParams(Inherited, Type) &&
2172 !canEmitDelegateCallArgs(*this, D, Type, Args)) {
2173 EmitInlinedInheritingCXXConstructorCall(D, Type, ForVirtualBase,
2174 Delegating, Args);
2175 return;
2176 }
2177 }
Reid Kleckner89077a12013-12-17 19:46:40 +00002178
2179 // Insert any ABI-specific implicit constructor arguments.
2180 unsigned ExtraArgs = CGM.getCXXABI().addImplicitConstructorArgs(
2181 *this, D, Type, ForVirtualBase, Delegating, Args);
2182
2183 // Emit the call.
John McCallb92ab1a2016-10-26 23:46:34 +00002184 llvm::Constant *CalleePtr =
2185 CGM.getAddrOfCXXStructor(D, getFromCtorType(Type));
Reid Kleckner89077a12013-12-17 19:46:40 +00002186 const CGFunctionInfo &Info =
John McCallb92ab1a2016-10-26 23:46:34 +00002187 CGM.getTypes().arrangeCXXConstructorCall(Args, D, Type, ExtraArgs);
2188 CGCallee Callee = CGCallee::forDirect(CalleePtr, D);
2189 EmitCall(Info, Callee, ReturnValueSlot(), Args);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002190
2191 // Generate vtable assumptions if we're constructing a complete object
2192 // with a vtable. We don't do this for base subobjects for two reasons:
2193 // first, it's incorrect for classes with virtual bases, and second, we're
2194 // about to overwrite the vptrs anyway.
2195 // We also have to make sure if we can refer to vtable:
2196 // - Otherwise we can refer to vtable if it's safe to speculatively emit.
2197 // FIXME: If vtable is used by ctor/dtor, or if vtable is external and we are
2198 // sure that definition of vtable is not hidden,
2199 // then we are always safe to refer to it.
Piotr Padlewski69dc9712015-09-28 20:30:22 +00002200 // FIXME: It looks like InstCombine is very inefficient on dealing with
2201 // assumes. Make assumption loads require -fstrict-vtable-pointers temporarily.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002202 if (CGM.getCodeGenOpts().OptimizationLevel > 0 &&
2203 ClassDecl->isDynamicClass() && Type != Ctor_Base &&
Piotr Padlewski69dc9712015-09-28 20:30:22 +00002204 CGM.getCXXABI().canSpeculativelyEmitVTable(ClassDecl) &&
2205 CGM.getCodeGenOpts().StrictVTablePointers)
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002206 EmitVTableAssumptionLoads(ClassDecl, This);
2207}
2208
Richard Smith5179eb72016-06-28 19:03:57 +00002209void CodeGenFunction::EmitInheritedCXXConstructorCall(
2210 const CXXConstructorDecl *D, bool ForVirtualBase, Address This,
2211 bool InheritedFromVBase, const CXXInheritedCtorInitExpr *E) {
2212 CallArgList Args;
2213 CallArg ThisArg(RValue::get(This.getPointer()), D->getThisType(getContext()),
2214 /*NeedsCopy=*/false);
2215
2216 // Forward the parameters.
2217 if (InheritedFromVBase &&
2218 CGM.getTarget().getCXXABI().hasConstructorVariants()) {
2219 // Nothing to do; this construction is not responsible for constructing
2220 // the base class containing the inherited constructor.
2221 // FIXME: Can we just pass undef's for the remaining arguments if we don't
2222 // have constructor variants?
2223 Args.push_back(ThisArg);
2224 } else if (!CXXInheritedCtorInitExprArgs.empty()) {
2225 // The inheriting constructor was inlined; just inject its arguments.
2226 assert(CXXInheritedCtorInitExprArgs.size() >= D->getNumParams() &&
2227 "wrong number of parameters for inherited constructor call");
2228 Args = CXXInheritedCtorInitExprArgs;
2229 Args[0] = ThisArg;
2230 } else {
2231 // The inheriting constructor was not inlined. Emit delegating arguments.
2232 Args.push_back(ThisArg);
2233 const auto *OuterCtor = cast<CXXConstructorDecl>(CurCodeDecl);
2234 assert(OuterCtor->getNumParams() == D->getNumParams());
2235 assert(!OuterCtor->isVariadic() && "should have been inlined");
2236
2237 for (const auto *Param : OuterCtor->parameters()) {
2238 assert(getContext().hasSameUnqualifiedType(
2239 OuterCtor->getParamDecl(Param->getFunctionScopeIndex())->getType(),
2240 Param->getType()));
2241 EmitDelegateCallArg(Args, Param, E->getLocation());
2242
2243 // Forward __attribute__(pass_object_size).
2244 if (Param->hasAttr<PassObjectSizeAttr>()) {
2245 auto *POSParam = SizeArguments[Param];
2246 assert(POSParam && "missing pass_object_size value for forwarding");
2247 EmitDelegateCallArg(Args, POSParam, E->getLocation());
2248 }
2249 }
2250 }
2251
2252 EmitCXXConstructorCall(D, Ctor_Base, ForVirtualBase, /*Delegating*/false,
2253 This, Args);
2254}
2255
2256void CodeGenFunction::EmitInlinedInheritingCXXConstructorCall(
2257 const CXXConstructorDecl *Ctor, CXXCtorType CtorType, bool ForVirtualBase,
2258 bool Delegating, CallArgList &Args) {
2259 InlinedInheritingConstructorScope Scope(*this, GlobalDecl(Ctor, CtorType));
2260
2261 // Save the arguments to be passed to the inherited constructor.
2262 CXXInheritedCtorInitExprArgs = Args;
2263
2264 FunctionArgList Params;
2265 QualType RetType = BuildFunctionArgList(CurGD, Params);
2266 FnRetTy = RetType;
2267
2268 // Insert any ABI-specific implicit constructor arguments.
2269 CGM.getCXXABI().addImplicitConstructorArgs(*this, Ctor, CtorType,
2270 ForVirtualBase, Delegating, Args);
2271
2272 // Emit a simplified prolog. We only need to emit the implicit params.
2273 assert(Args.size() >= Params.size() && "too few arguments for call");
2274 for (unsigned I = 0, N = Args.size(); I != N; ++I) {
2275 if (I < Params.size() && isa<ImplicitParamDecl>(Params[I])) {
2276 const RValue &RV = Args[I].RV;
2277 assert(!RV.isComplex() && "complex indirect params not supported");
2278 ParamValue Val = RV.isScalar()
2279 ? ParamValue::forDirect(RV.getScalarVal())
2280 : ParamValue::forIndirect(RV.getAggregateAddress());
2281 EmitParmDecl(*Params[I], Val, I + 1);
2282 }
2283 }
2284
2285 // Create a return value slot if the ABI implementation wants one.
2286 // FIXME: This is dumb, we should ask the ABI not to try to set the return
2287 // value instead.
2288 if (!RetType->isVoidType())
2289 ReturnValue = CreateIRTemp(RetType, "retval.inhctor");
2290
2291 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
2292 CXXThisValue = CXXABIThisValue;
2293
2294 // Directly emit the constructor initializers.
2295 EmitCtorPrologue(Ctor, CtorType, Params);
2296}
2297
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002298void CodeGenFunction::EmitVTableAssumptionLoad(const VPtr &Vptr, Address This) {
2299 llvm::Value *VTableGlobal =
2300 CGM.getCXXABI().getVTableAddressPoint(Vptr.Base, Vptr.VTableClass);
2301 if (!VTableGlobal)
2302 return;
2303
2304 // We can just use the base offset in the complete class.
2305 CharUnits NonVirtualOffset = Vptr.Base.getBaseOffset();
2306
2307 if (!NonVirtualOffset.isZero())
2308 This =
2309 ApplyNonVirtualAndVirtualOffset(*this, This, NonVirtualOffset, nullptr,
2310 Vptr.VTableClass, Vptr.NearestVBase);
2311
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00002312 llvm::Value *VPtrValue =
2313 GetVTablePtr(This, VTableGlobal->getType(), Vptr.VTableClass);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002314 llvm::Value *Cmp =
2315 Builder.CreateICmpEQ(VPtrValue, VTableGlobal, "cmp.vtables");
2316 Builder.CreateAssumption(Cmp);
2317}
2318
2319void CodeGenFunction::EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl,
2320 Address This) {
2321 if (CGM.getCXXABI().doStructorsInitializeVPtrs(ClassDecl))
2322 for (const VPtr &Vptr : getVTablePointers(ClassDecl))
2323 EmitVTableAssumptionLoad(Vptr, This);
Anders Carlsson27da15b2010-01-01 20:29:01 +00002324}
2325
John McCallf8ff7b92010-02-23 00:48:20 +00002326void
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002327CodeGenFunction::EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002328 Address This, Address Src,
2329 const CXXConstructExpr *E) {
Reid Kleckner739756c2013-12-04 19:23:12 +00002330 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
Justin Bogner1cd11f12015-05-20 15:53:59 +00002331
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002332 CallArgList Args;
Justin Bogner1cd11f12015-05-20 15:53:59 +00002333
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002334 // Push the this ptr.
John McCall7f416cc2015-09-08 08:05:57 +00002335 Args.add(RValue::get(This.getPointer()), D->getThisType(getContext()));
Justin Bogner1cd11f12015-05-20 15:53:59 +00002336
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002337 // Push the src ptr.
Alp Toker9cacbab2014-01-20 20:26:09 +00002338 QualType QT = *(FPT->param_type_begin());
Chris Lattner2192fe52011-07-18 04:24:23 +00002339 llvm::Type *t = CGM.getTypes().ConvertType(QT);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002340 Src = Builder.CreateBitCast(Src, t);
John McCall7f416cc2015-09-08 08:05:57 +00002341 Args.add(RValue::get(Src.getPointer()), QT);
Reid Kleckner739756c2013-12-04 19:23:12 +00002342
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002343 // Skip over first argument (Src).
David Blaikief05779e2015-07-21 18:37:18 +00002344 EmitCallArgs(Args, FPT, drop_begin(E->arguments(), 1), E->getConstructor(),
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002345 /*ParamsToSkip*/ 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002346
Richard Smith5179eb72016-06-28 19:03:57 +00002347 EmitCXXConstructorCall(D, Ctor_Complete, false, false, This, Args);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002348}
2349
2350void
John McCallf8ff7b92010-02-23 00:48:20 +00002351CodeGenFunction::EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2352 CXXCtorType CtorType,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002353 const FunctionArgList &Args,
2354 SourceLocation Loc) {
John McCallf8ff7b92010-02-23 00:48:20 +00002355 CallArgList DelegateArgs;
2356
2357 FunctionArgList::const_iterator I = Args.begin(), E = Args.end();
2358 assert(I != E && "no parameters to constructor");
2359
2360 // this
Richard Smith5179eb72016-06-28 19:03:57 +00002361 Address This = LoadCXXThisAddress();
2362 DelegateArgs.add(RValue::get(This.getPointer()), (*I)->getType());
John McCallf8ff7b92010-02-23 00:48:20 +00002363 ++I;
2364
Richard Smith5179eb72016-06-28 19:03:57 +00002365 // FIXME: The location of the VTT parameter in the parameter list is
2366 // specific to the Itanium ABI and shouldn't be hardcoded here.
2367 if (CGM.getCXXABI().NeedsVTTParameter(CurGD)) {
2368 assert(I != E && "cannot skip vtt parameter, already done with args");
2369 assert((*I)->getType()->isPointerType() &&
2370 "skipping parameter not of vtt type");
2371 ++I;
John McCallf8ff7b92010-02-23 00:48:20 +00002372 }
2373
2374 // Explicit arguments.
2375 for (; I != E; ++I) {
John McCall32ea9692011-03-11 20:59:21 +00002376 const VarDecl *param = *I;
Nick Lewycky2d84e842013-10-02 02:29:49 +00002377 // FIXME: per-argument source location
2378 EmitDelegateCallArg(DelegateArgs, param, Loc);
John McCallf8ff7b92010-02-23 00:48:20 +00002379 }
2380
Richard Smith5179eb72016-06-28 19:03:57 +00002381 EmitCXXConstructorCall(Ctor, CtorType, /*ForVirtualBase=*/false,
2382 /*Delegating=*/true, This, DelegateArgs);
John McCallf8ff7b92010-02-23 00:48:20 +00002383}
2384
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002385namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002386 struct CallDelegatingCtorDtor final : EHScopeStack::Cleanup {
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002387 const CXXDestructorDecl *Dtor;
John McCall7f416cc2015-09-08 08:05:57 +00002388 Address Addr;
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002389 CXXDtorType Type;
2390
John McCall7f416cc2015-09-08 08:05:57 +00002391 CallDelegatingCtorDtor(const CXXDestructorDecl *D, Address Addr,
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002392 CXXDtorType Type)
2393 : Dtor(D), Addr(Addr), Type(Type) {}
2394
Craig Topper4f12f102014-03-12 06:41:41 +00002395 void Emit(CodeGenFunction &CGF, Flags flags) override {
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002396 CGF.EmitCXXDestructorCall(Dtor, Type, /*ForVirtualBase=*/false,
Douglas Gregor61535002013-01-31 05:50:40 +00002397 /*Delegating=*/true, Addr);
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002398 }
2399 };
Hans Wennborgdcfba332015-10-06 23:40:43 +00002400} // end anonymous namespace
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002401
Alexis Hunt61bc1732011-05-01 07:04:31 +00002402void
2403CodeGenFunction::EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2404 const FunctionArgList &Args) {
2405 assert(Ctor->isDelegatingConstructor());
2406
John McCall7f416cc2015-09-08 08:05:57 +00002407 Address ThisPtr = LoadCXXThisAddress();
Alexis Hunt61bc1732011-05-01 07:04:31 +00002408
John McCall31168b02011-06-15 23:02:42 +00002409 AggValueSlot AggSlot =
John McCall7f416cc2015-09-08 08:05:57 +00002410 AggValueSlot::forAddr(ThisPtr, Qualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00002411 AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00002412 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00002413 AggValueSlot::IsNotAliased);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002414
2415 EmitAggExpr(Ctor->init_begin()[0]->getInit(), AggSlot);
Alexis Hunt61bc1732011-05-01 07:04:31 +00002416
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002417 const CXXRecordDecl *ClassDecl = Ctor->getParent();
David Blaikiebbafb8a2012-03-11 07:00:24 +00002418 if (CGM.getLangOpts().Exceptions && !ClassDecl->hasTrivialDestructor()) {
Alexis Hunt9d47faf2011-05-03 23:05:34 +00002419 CXXDtorType Type =
2420 CurGD.getCtorType() == Ctor_Complete ? Dtor_Complete : Dtor_Base;
2421
2422 EHStack.pushCleanup<CallDelegatingCtorDtor>(EHCleanup,
2423 ClassDecl->getDestructor(),
2424 ThisPtr, Type);
2425 }
2426}
Alexis Hunt61bc1732011-05-01 07:04:31 +00002427
Anders Carlsson27da15b2010-01-01 20:29:01 +00002428void CodeGenFunction::EmitCXXDestructorCall(const CXXDestructorDecl *DD,
2429 CXXDtorType Type,
Anders Carlssonf8a71f02010-05-02 23:29:11 +00002430 bool ForVirtualBase,
Douglas Gregor61535002013-01-31 05:50:40 +00002431 bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +00002432 Address This) {
Reid Kleckner6fe771a2013-12-13 00:53:54 +00002433 CGM.getCXXABI().EmitDestructorCall(*this, DD, Type, ForVirtualBase,
2434 Delegating, This);
Anders Carlsson27da15b2010-01-01 20:29:01 +00002435}
2436
John McCall53cad2e2010-07-21 01:41:18 +00002437namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002438 struct CallLocalDtor final : EHScopeStack::Cleanup {
John McCall53cad2e2010-07-21 01:41:18 +00002439 const CXXDestructorDecl *Dtor;
John McCall7f416cc2015-09-08 08:05:57 +00002440 Address Addr;
John McCall53cad2e2010-07-21 01:41:18 +00002441
John McCall7f416cc2015-09-08 08:05:57 +00002442 CallLocalDtor(const CXXDestructorDecl *D, Address Addr)
John McCall53cad2e2010-07-21 01:41:18 +00002443 : Dtor(D), Addr(Addr) {}
2444
Craig Topper4f12f102014-03-12 06:41:41 +00002445 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall53cad2e2010-07-21 01:41:18 +00002446 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
Douglas Gregor61535002013-01-31 05:50:40 +00002447 /*ForVirtualBase=*/false,
2448 /*Delegating=*/false, Addr);
John McCall53cad2e2010-07-21 01:41:18 +00002449 }
2450 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002451} // end anonymous namespace
John McCall53cad2e2010-07-21 01:41:18 +00002452
John McCall8680f872010-07-21 06:29:51 +00002453void CodeGenFunction::PushDestructorCleanup(const CXXDestructorDecl *D,
John McCall7f416cc2015-09-08 08:05:57 +00002454 Address Addr) {
John McCallcda666c2010-07-21 07:22:38 +00002455 EHStack.pushCleanup<CallLocalDtor>(NormalAndEHCleanup, D, Addr);
John McCall8680f872010-07-21 06:29:51 +00002456}
2457
John McCall7f416cc2015-09-08 08:05:57 +00002458void CodeGenFunction::PushDestructorCleanup(QualType T, Address Addr) {
John McCallbd309292010-07-06 01:34:17 +00002459 CXXRecordDecl *ClassDecl = T->getAsCXXRecordDecl();
2460 if (!ClassDecl) return;
2461 if (ClassDecl->hasTrivialDestructor()) return;
2462
2463 const CXXDestructorDecl *D = ClassDecl->getDestructor();
John McCalla85af562011-04-28 02:15:35 +00002464 assert(D && D->isUsed() && "destructor not marked as used!");
John McCall8680f872010-07-21 06:29:51 +00002465 PushDestructorCleanup(D, Addr);
John McCallbd309292010-07-06 01:34:17 +00002466}
2467
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002468void CodeGenFunction::InitializeVTablePointer(const VPtr &Vptr) {
Anders Carlssone87fae92010-03-28 19:40:00 +00002469 // Compute the address point.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002470 llvm::Value *VTableAddressPoint =
2471 CGM.getCXXABI().getVTableAddressPointInStructor(
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002472 *this, Vptr.VTableClass, Vptr.Base, Vptr.NearestVBase);
2473
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002474 if (!VTableAddressPoint)
2475 return;
Anders Carlssone87fae92010-03-28 19:40:00 +00002476
Anders Carlsson6a0227d2010-04-20 16:22:16 +00002477 // Compute where to store the address point.
Craig Topper8a13c412014-05-21 05:09:00 +00002478 llvm::Value *VirtualOffset = nullptr;
Ken Dyckcfc332c2011-03-23 00:45:26 +00002479 CharUnits NonVirtualOffset = CharUnits::Zero();
Justin Bogner1cd11f12015-05-20 15:53:59 +00002480
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002481 if (CGM.getCXXABI().isVirtualOffsetNeededForVTableField(*this, Vptr)) {
Anders Carlsson91baecf2010-04-20 18:05:10 +00002482 // We need to use the virtual base offset offset because the virtual base
2483 // might have a different offset in the most derived class.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002484
2485 VirtualOffset = CGM.getCXXABI().GetVirtualBaseClassOffset(
2486 *this, LoadCXXThisAddress(), Vptr.VTableClass, Vptr.NearestVBase);
2487 NonVirtualOffset = Vptr.OffsetFromNearestVBase;
Anders Carlsson91baecf2010-04-20 18:05:10 +00002488 } else {
Anders Carlssonc58fb552010-05-03 00:29:58 +00002489 // We can just use the base offset in the complete class.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002490 NonVirtualOffset = Vptr.Base.getBaseOffset();
Anders Carlsson91baecf2010-04-20 18:05:10 +00002491 }
Justin Bogner1cd11f12015-05-20 15:53:59 +00002492
Anders Carlssonc58fb552010-05-03 00:29:58 +00002493 // Apply the offsets.
John McCall7f416cc2015-09-08 08:05:57 +00002494 Address VTableField = LoadCXXThisAddress();
Justin Bogner1cd11f12015-05-20 15:53:59 +00002495
Ken Dyckcfc332c2011-03-23 00:45:26 +00002496 if (!NonVirtualOffset.isZero() || VirtualOffset)
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002497 VTableField = ApplyNonVirtualAndVirtualOffset(
2498 *this, VTableField, NonVirtualOffset, VirtualOffset, Vptr.VTableClass,
2499 Vptr.NearestVBase);
Anders Carlsson6a0227d2010-04-20 16:22:16 +00002500
Reid Kleckner8d585132014-12-03 21:00:21 +00002501 // Finally, store the address point. Use the same LLVM types as the field to
2502 // support optimization.
2503 llvm::Type *VTablePtrTy =
2504 llvm::FunctionType::get(CGM.Int32Ty, /*isVarArg=*/true)
2505 ->getPointerTo()
2506 ->getPointerTo();
2507 VTableField = Builder.CreateBitCast(VTableField, VTablePtrTy->getPointerTo());
2508 VTableAddressPoint = Builder.CreateBitCast(VTableAddressPoint, VTablePtrTy);
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002509
Kostya Serebryany141e46f2012-03-26 17:03:51 +00002510 llvm::StoreInst *Store = Builder.CreateStore(VTableAddressPoint, VTableField);
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00002511 CGM.DecorateInstructionWithTBAA(Store, CGM.getTBAAInfoForVTablePtr());
2512 if (CGM.getCodeGenOpts().OptimizationLevel > 0 &&
2513 CGM.getCodeGenOpts().StrictVTablePointers)
2514 CGM.DecorateInstructionWithInvariantGroup(Store, Vptr.VTableClass);
Anders Carlssone87fae92010-03-28 19:40:00 +00002515}
2516
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002517CodeGenFunction::VPtrsVector
2518CodeGenFunction::getVTablePointers(const CXXRecordDecl *VTableClass) {
2519 CodeGenFunction::VPtrsVector VPtrsResult;
2520 VisitedVirtualBasesSetTy VBases;
2521 getVTablePointers(BaseSubobject(VTableClass, CharUnits::Zero()),
2522 /*NearestVBase=*/nullptr,
2523 /*OffsetFromNearestVBase=*/CharUnits::Zero(),
2524 /*BaseIsNonVirtualPrimaryBase=*/false, VTableClass, VBases,
2525 VPtrsResult);
2526 return VPtrsResult;
2527}
2528
2529void CodeGenFunction::getVTablePointers(BaseSubobject Base,
2530 const CXXRecordDecl *NearestVBase,
2531 CharUnits OffsetFromNearestVBase,
2532 bool BaseIsNonVirtualPrimaryBase,
2533 const CXXRecordDecl *VTableClass,
2534 VisitedVirtualBasesSetTy &VBases,
2535 VPtrsVector &Vptrs) {
Anders Carlssond5895932010-03-28 21:07:49 +00002536 // If this base is a non-virtual primary base the address point has already
2537 // been set.
2538 if (!BaseIsNonVirtualPrimaryBase) {
2539 // Initialize the vtable pointer for this base.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002540 VPtr Vptr = {Base, NearestVBase, OffsetFromNearestVBase, VTableClass};
2541 Vptrs.push_back(Vptr);
Anders Carlssond5895932010-03-28 21:07:49 +00002542 }
Justin Bogner1cd11f12015-05-20 15:53:59 +00002543
Anders Carlssond5895932010-03-28 21:07:49 +00002544 const CXXRecordDecl *RD = Base.getBase();
2545
2546 // Traverse bases.
Aaron Ballman574705e2014-03-13 15:41:46 +00002547 for (const auto &I : RD->bases()) {
Anders Carlssond5895932010-03-28 21:07:49 +00002548 CXXRecordDecl *BaseDecl
Aaron Ballman574705e2014-03-13 15:41:46 +00002549 = cast<CXXRecordDecl>(I.getType()->getAs<RecordType>()->getDecl());
Anders Carlssond5895932010-03-28 21:07:49 +00002550
2551 // Ignore classes without a vtable.
2552 if (!BaseDecl->isDynamicClass())
2553 continue;
2554
Ken Dyck3fb4c892011-03-23 01:04:18 +00002555 CharUnits BaseOffset;
2556 CharUnits BaseOffsetFromNearestVBase;
Anders Carlsson948d3f42010-03-29 01:16:41 +00002557 bool BaseDeclIsNonVirtualPrimaryBase;
Anders Carlssond5895932010-03-28 21:07:49 +00002558
Aaron Ballman574705e2014-03-13 15:41:46 +00002559 if (I.isVirtual()) {
Anders Carlssond5895932010-03-28 21:07:49 +00002560 // Check if we've visited this virtual base before.
David Blaikie82e95a32014-11-19 07:49:47 +00002561 if (!VBases.insert(BaseDecl).second)
Anders Carlssond5895932010-03-28 21:07:49 +00002562 continue;
2563
Justin Bogner1cd11f12015-05-20 15:53:59 +00002564 const ASTRecordLayout &Layout =
Anders Carlssond5895932010-03-28 21:07:49 +00002565 getContext().getASTRecordLayout(VTableClass);
2566
Ken Dyck3fb4c892011-03-23 01:04:18 +00002567 BaseOffset = Layout.getVBaseClassOffset(BaseDecl);
2568 BaseOffsetFromNearestVBase = CharUnits::Zero();
Anders Carlsson948d3f42010-03-29 01:16:41 +00002569 BaseDeclIsNonVirtualPrimaryBase = false;
Anders Carlssond5895932010-03-28 21:07:49 +00002570 } else {
2571 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
2572
Ken Dyck16ffcac2011-03-24 01:21:01 +00002573 BaseOffset = Base.getBaseOffset() + Layout.getBaseClassOffset(BaseDecl);
Justin Bogner1cd11f12015-05-20 15:53:59 +00002574 BaseOffsetFromNearestVBase =
Ken Dyck3fb4c892011-03-23 01:04:18 +00002575 OffsetFromNearestVBase + Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson948d3f42010-03-29 01:16:41 +00002576 BaseDeclIsNonVirtualPrimaryBase = Layout.getPrimaryBase() == BaseDecl;
Anders Carlssond5895932010-03-28 21:07:49 +00002577 }
Justin Bogner1cd11f12015-05-20 15:53:59 +00002578
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002579 getVTablePointers(
2580 BaseSubobject(BaseDecl, BaseOffset),
2581 I.isVirtual() ? BaseDecl : NearestVBase, BaseOffsetFromNearestVBase,
2582 BaseDeclIsNonVirtualPrimaryBase, VTableClass, VBases, Vptrs);
Anders Carlssond5895932010-03-28 21:07:49 +00002583 }
2584}
2585
2586void CodeGenFunction::InitializeVTablePointers(const CXXRecordDecl *RD) {
2587 // Ignore classes without a vtable.
Anders Carlsson1f9348c2010-03-26 04:39:42 +00002588 if (!RD->isDynamicClass())
Anders Carlsson27da15b2010-01-01 20:29:01 +00002589 return;
2590
Anders Carlssond5895932010-03-28 21:07:49 +00002591 // Initialize the vtable pointers for this class and all of its bases.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00002592 if (CGM.getCXXABI().doStructorsInitializeVPtrs(RD))
2593 for (const VPtr &Vptr : getVTablePointers(RD))
2594 InitializeVTablePointer(Vptr);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00002595
2596 if (RD->getNumVBases())
2597 CGM.getCXXABI().initializeHiddenVirtualInheritanceMembers(*this, RD);
Anders Carlsson27da15b2010-01-01 20:29:01 +00002598}
Dan Gohman8fc50c22010-10-26 18:44:08 +00002599
John McCall7f416cc2015-09-08 08:05:57 +00002600llvm::Value *CodeGenFunction::GetVTablePtr(Address This,
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00002601 llvm::Type *VTableTy,
2602 const CXXRecordDecl *RD) {
2603 Address VTablePtrSrc = Builder.CreateElementBitCast(This, VTableTy);
Kostya Serebryany141e46f2012-03-26 17:03:51 +00002604 llvm::Instruction *VTable = Builder.CreateLoad(VTablePtrSrc, "vtable");
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00002605 CGM.DecorateInstructionWithTBAA(VTable, CGM.getTBAAInfoForVTablePtr());
2606
2607 if (CGM.getCodeGenOpts().OptimizationLevel > 0 &&
2608 CGM.getCodeGenOpts().StrictVTablePointers)
2609 CGM.DecorateInstructionWithInvariantGroup(VTable, RD);
2610
Kostya Serebryany141e46f2012-03-26 17:03:51 +00002611 return VTable;
Dan Gohman8fc50c22010-10-26 18:44:08 +00002612}
Anders Carlssonc36783e2011-05-08 20:32:23 +00002613
Peter Collingbourned2926c92015-03-14 02:42:25 +00002614// If a class has a single non-virtual base and does not introduce or override
2615// virtual member functions or fields, it will have the same layout as its base.
2616// This function returns the least derived such class.
2617//
2618// Casting an instance of a base class to such a derived class is technically
2619// undefined behavior, but it is a relatively common hack for introducing member
2620// functions on class instances with specific properties (e.g. llvm::Operator)
2621// that works under most compilers and should not have security implications, so
2622// we allow it by default. It can be disabled with -fsanitize=cfi-cast-strict.
2623static const CXXRecordDecl *
2624LeastDerivedClassWithSameLayout(const CXXRecordDecl *RD) {
2625 if (!RD->field_empty())
2626 return RD;
2627
2628 if (RD->getNumVBases() != 0)
2629 return RD;
2630
2631 if (RD->getNumBases() != 1)
2632 return RD;
2633
2634 for (const CXXMethodDecl *MD : RD->methods()) {
2635 if (MD->isVirtual()) {
2636 // Virtual member functions are only ok if they are implicit destructors
2637 // because the implicit destructor will have the same semantics as the
2638 // base class's destructor if no fields are added.
2639 if (isa<CXXDestructorDecl>(MD) && MD->isImplicit())
2640 continue;
2641 return RD;
2642 }
2643 }
2644
2645 return LeastDerivedClassWithSameLayout(
2646 RD->bases_begin()->getType()->getAsCXXRecordDecl());
2647}
2648
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002649void CodeGenFunction::EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
2650 llvm::Value *VTable,
2651 SourceLocation Loc) {
Peter Collingbournefb532b92016-02-24 20:46:36 +00002652 if (CGM.getCodeGenOpts().WholeProgramVTables &&
Peter Collingbourne3afb2662016-04-28 17:09:37 +00002653 CGM.HasHiddenLTOVisibility(RD)) {
Peter Collingbournefb532b92016-02-24 20:46:36 +00002654 llvm::Metadata *MD =
2655 CGM.CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002656 llvm::Value *TypeId =
Peter Collingbournefb532b92016-02-24 20:46:36 +00002657 llvm::MetadataAsValue::get(CGM.getLLVMContext(), MD);
2658
2659 llvm::Value *CastedVTable = Builder.CreateBitCast(VTable, Int8PtrTy);
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002660 llvm::Value *TypeTest =
2661 Builder.CreateCall(CGM.getIntrinsic(llvm::Intrinsic::type_test),
2662 {CastedVTable, TypeId});
2663 Builder.CreateCall(CGM.getIntrinsic(llvm::Intrinsic::assume), TypeTest);
Peter Collingbournefb532b92016-02-24 20:46:36 +00002664 }
2665
2666 if (SanOpts.has(SanitizerKind::CFIVCall))
2667 EmitVTablePtrCheckForCall(RD, VTable, CodeGenFunction::CFITCK_VCall, Loc);
2668}
2669
2670void CodeGenFunction::EmitVTablePtrCheckForCall(const CXXRecordDecl *RD,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002671 llvm::Value *VTable,
2672 CFITypeCheckKind TCK,
2673 SourceLocation Loc) {
Peter Collingbourne1a7488a2015-04-02 00:23:30 +00002674 if (!SanOpts.has(SanitizerKind::CFICastStrict))
Peter Collingbournefb532b92016-02-24 20:46:36 +00002675 RD = LeastDerivedClassWithSameLayout(RD);
Peter Collingbourne1a7488a2015-04-02 00:23:30 +00002676
Peter Collingbournefb532b92016-02-24 20:46:36 +00002677 EmitVTablePtrCheck(RD, VTable, TCK, Loc);
Peter Collingbourne1a7488a2015-04-02 00:23:30 +00002678}
2679
Peter Collingbourned2926c92015-03-14 02:42:25 +00002680void CodeGenFunction::EmitVTablePtrCheckForCast(QualType T,
2681 llvm::Value *Derived,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002682 bool MayBeNull,
2683 CFITypeCheckKind TCK,
2684 SourceLocation Loc) {
Peter Collingbourned2926c92015-03-14 02:42:25 +00002685 if (!getLangOpts().CPlusPlus)
2686 return;
2687
2688 auto *ClassTy = T->getAs<RecordType>();
2689 if (!ClassTy)
2690 return;
2691
2692 const CXXRecordDecl *ClassDecl = cast<CXXRecordDecl>(ClassTy->getDecl());
2693
2694 if (!ClassDecl->isCompleteDefinition() || !ClassDecl->isDynamicClass())
2695 return;
2696
Peter Collingbourned2926c92015-03-14 02:42:25 +00002697 if (!SanOpts.has(SanitizerKind::CFICastStrict))
2698 ClassDecl = LeastDerivedClassWithSameLayout(ClassDecl);
2699
Hans Wennborgdcfba332015-10-06 23:40:43 +00002700 llvm::BasicBlock *ContBlock = nullptr;
Peter Collingbourned2926c92015-03-14 02:42:25 +00002701
2702 if (MayBeNull) {
2703 llvm::Value *DerivedNotNull =
2704 Builder.CreateIsNotNull(Derived, "cast.nonnull");
2705
2706 llvm::BasicBlock *CheckBlock = createBasicBlock("cast.check");
2707 ContBlock = createBasicBlock("cast.cont");
2708
2709 Builder.CreateCondBr(DerivedNotNull, CheckBlock, ContBlock);
2710
2711 EmitBlock(CheckBlock);
2712 }
2713
John McCall7f416cc2015-09-08 08:05:57 +00002714 llvm::Value *VTable =
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00002715 GetVTablePtr(Address(Derived, getPointerAlign()), Int8PtrTy, ClassDecl);
2716
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002717 EmitVTablePtrCheck(ClassDecl, VTable, TCK, Loc);
Peter Collingbourned2926c92015-03-14 02:42:25 +00002718
2719 if (MayBeNull) {
2720 Builder.CreateBr(ContBlock);
2721 EmitBlock(ContBlock);
2722 }
2723}
2724
2725void CodeGenFunction::EmitVTablePtrCheck(const CXXRecordDecl *RD,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002726 llvm::Value *VTable,
2727 CFITypeCheckKind TCK,
2728 SourceLocation Loc) {
Peter Collingbourne3afb2662016-04-28 17:09:37 +00002729 if (!CGM.getCodeGenOpts().SanitizeCfiCrossDso &&
2730 !CGM.HasHiddenLTOVisibility(RD))
2731 return;
2732
2733 std::string TypeName = RD->getQualifiedNameAsString();
2734 if (getContext().getSanitizerBlacklist().isBlacklistedType(TypeName))
Peter Collingbournea4ccff32015-02-20 20:30:56 +00002735 return;
2736
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002737 SanitizerScope SanScope(this);
Peter Collingbournedc134532016-01-16 00:31:22 +00002738 llvm::SanitizerStatKind SSK;
2739 switch (TCK) {
2740 case CFITCK_VCall:
2741 SSK = llvm::SanStat_CFI_VCall;
2742 break;
2743 case CFITCK_NVCall:
2744 SSK = llvm::SanStat_CFI_NVCall;
2745 break;
2746 case CFITCK_DerivedCast:
2747 SSK = llvm::SanStat_CFI_DerivedCast;
2748 break;
2749 case CFITCK_UnrelatedCast:
2750 SSK = llvm::SanStat_CFI_UnrelatedCast;
2751 break;
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00002752 case CFITCK_ICall:
2753 llvm_unreachable("not expecting CFITCK_ICall");
Peter Collingbournedc134532016-01-16 00:31:22 +00002754 }
2755 EmitSanitizerStatReport(SSK);
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002756
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00002757 llvm::Metadata *MD =
2758 CGM.CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002759 llvm::Value *TypeId = llvm::MetadataAsValue::get(getLLVMContext(), MD);
Peter Collingbournea4ccff32015-02-20 20:30:56 +00002760
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002761 llvm::Value *CastedVTable = Builder.CreateBitCast(VTable, Int8PtrTy);
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002762 llvm::Value *TypeTest = Builder.CreateCall(
2763 CGM.getIntrinsic(llvm::Intrinsic::type_test), {CastedVTable, TypeId});
Peter Collingbournea4ccff32015-02-20 20:30:56 +00002764
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002765 SanitizerMask M;
2766 switch (TCK) {
2767 case CFITCK_VCall:
2768 M = SanitizerKind::CFIVCall;
2769 break;
2770 case CFITCK_NVCall:
2771 M = SanitizerKind::CFINVCall;
2772 break;
2773 case CFITCK_DerivedCast:
2774 M = SanitizerKind::CFIDerivedCast;
2775 break;
2776 case CFITCK_UnrelatedCast:
2777 M = SanitizerKind::CFIUnrelatedCast;
2778 break;
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00002779 case CFITCK_ICall:
2780 llvm_unreachable("not expecting CFITCK_ICall");
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002781 }
Peter Collingbournea4ccff32015-02-20 20:30:56 +00002782
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002783 llvm::Constant *StaticData[] = {
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00002784 llvm::ConstantInt::get(Int8Ty, TCK),
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00002785 EmitCheckSourceLocation(Loc),
2786 EmitCheckTypeDescriptor(QualType(RD->getTypeForDecl(), 0)),
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00002787 };
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00002788
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002789 auto CrossDsoTypeId = CGM.CreateCrossDsoCfiTypeId(MD);
2790 if (CGM.getCodeGenOpts().SanitizeCfiCrossDso && CrossDsoTypeId) {
2791 EmitCfiSlowPathCheck(M, TypeTest, CrossDsoTypeId, CastedVTable, StaticData);
Evgeniy Stepanovf31ea302016-02-03 22:18:55 +00002792 return;
Evgeniy Stepanov3fd61df2016-01-25 23:34:52 +00002793 }
Evgeniy Stepanovf31ea302016-02-03 22:18:55 +00002794
2795 if (CGM.getCodeGenOpts().SanitizeTrap.has(M)) {
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002796 EmitTrapCheck(TypeTest);
Evgeniy Stepanovf31ea302016-02-03 22:18:55 +00002797 return;
2798 }
2799
2800 llvm::Value *AllVtables = llvm::MetadataAsValue::get(
2801 CGM.getLLVMContext(),
2802 llvm::MDString::get(CGM.getLLVMContext(), "all-vtables"));
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00002803 llvm::Value *ValidVtable = Builder.CreateCall(
2804 CGM.getIntrinsic(llvm::Intrinsic::type_test), {CastedVTable, AllVtables});
2805 EmitCheck(std::make_pair(TypeTest, M), "cfi_check_fail", StaticData,
Evgeniy Stepanovf31ea302016-02-03 22:18:55 +00002806 {CastedVTable, ValidVtable});
Peter Collingbournea4ccff32015-02-20 20:30:56 +00002807}
Anders Carlssonc36783e2011-05-08 20:32:23 +00002808
Peter Collingbourne0ca03632016-06-25 00:24:06 +00002809bool CodeGenFunction::ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD) {
2810 if (!CGM.getCodeGenOpts().WholeProgramVTables ||
2811 !SanOpts.has(SanitizerKind::CFIVCall) ||
2812 !CGM.getCodeGenOpts().SanitizeTrap.has(SanitizerKind::CFIVCall) ||
2813 !CGM.HasHiddenLTOVisibility(RD))
2814 return false;
2815
2816 std::string TypeName = RD->getQualifiedNameAsString();
2817 return !getContext().getSanitizerBlacklist().isBlacklistedType(TypeName);
2818}
2819
2820llvm::Value *CodeGenFunction::EmitVTableTypeCheckedLoad(
2821 const CXXRecordDecl *RD, llvm::Value *VTable, uint64_t VTableByteOffset) {
2822 SanitizerScope SanScope(this);
2823
2824 EmitSanitizerStatReport(llvm::SanStat_CFI_VCall);
2825
2826 llvm::Metadata *MD =
2827 CGM.CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
2828 llvm::Value *TypeId = llvm::MetadataAsValue::get(CGM.getLLVMContext(), MD);
2829
2830 llvm::Value *CastedVTable = Builder.CreateBitCast(VTable, Int8PtrTy);
2831 llvm::Value *CheckedLoad = Builder.CreateCall(
2832 CGM.getIntrinsic(llvm::Intrinsic::type_checked_load),
2833 {CastedVTable, llvm::ConstantInt::get(Int32Ty, VTableByteOffset),
2834 TypeId});
2835 llvm::Value *CheckResult = Builder.CreateExtractValue(CheckedLoad, 1);
2836
2837 EmitCheck(std::make_pair(CheckResult, SanitizerKind::CFIVCall),
2838 "cfi_check_fail", nullptr, nullptr);
2839
2840 return Builder.CreateBitCast(
2841 Builder.CreateExtractValue(CheckedLoad, 0),
2842 cast<llvm::PointerType>(VTable->getType())->getElementType());
2843}
2844
Benjamin Kramer7463ed72013-08-25 22:46:27 +00002845bool
2846CodeGenFunction::CanDevirtualizeMemberFunctionCall(const Expr *Base,
2847 const CXXMethodDecl *MD) {
2848 // When building with -fapple-kext, all calls must go through the vtable since
2849 // the kernel linker can do runtime patching of vtables.
2850 if (getLangOpts().AppleKext)
2851 return false;
2852
Vedant Kumar2d38ae62016-10-20 18:44:14 +00002853 // If the member function is marked 'final', we know that it can't be
Richard Smitha2716862016-11-11 01:01:31 +00002854 // overridden and can therefore devirtualize it unless it's pure virtual.
Vedant Kumar2d38ae62016-10-20 18:44:14 +00002855 if (MD->hasAttr<FinalAttr>())
Richard Smitha2716862016-11-11 01:01:31 +00002856 return !MD->isPure();
Vedant Kumar2d38ae62016-10-20 18:44:14 +00002857
Richard Smith018ac392016-11-03 18:55:18 +00002858 // If the base expression (after skipping derived-to-base conversions) is a
2859 // class prvalue, then we can devirtualize.
2860 Base = Base->getBestDynamicClassTypeExpr();
2861 if (Base->isRValue() && Base->getType()->isRecordType())
2862 return true;
2863
Richard Smitha2716862016-11-11 01:01:31 +00002864 // If we don't even know what we would call, we can't devirtualize.
2865 const CXXRecordDecl *BestDynamicDecl = Base->getBestDynamicClassType();
2866 if (!BestDynamicDecl)
2867 return false;
Anders Carlssonc36783e2011-05-08 20:32:23 +00002868
Richard Smitha2716862016-11-11 01:01:31 +00002869 // There may be a method corresponding to MD in a derived class.
2870 const CXXMethodDecl *DevirtualizedMethod =
2871 MD->getCorrespondingMethodInClass(BestDynamicDecl);
2872
2873 // If that method is pure virtual, we can't devirtualize. If this code is
2874 // reached, the result would be UB, not a direct call to the derived class
2875 // function, and we can't assume the derived class function is defined.
2876 if (DevirtualizedMethod->isPure())
2877 return false;
2878
2879 // If that method is marked final, we can devirtualize it.
2880 if (DevirtualizedMethod->hasAttr<FinalAttr>())
2881 return true;
Anders Carlssonc36783e2011-05-08 20:32:23 +00002882
2883 // Similarly, if the class itself is marked 'final' it can't be overridden
2884 // and we can therefore devirtualize the member function call.
Richard Smitha2716862016-11-11 01:01:31 +00002885 if (BestDynamicDecl->hasAttr<FinalAttr>())
Anders Carlssonc36783e2011-05-08 20:32:23 +00002886 return true;
2887
Anders Carlssonc36783e2011-05-08 20:32:23 +00002888 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Base)) {
2889 if (const VarDecl *VD = dyn_cast<VarDecl>(DRE->getDecl())) {
2890 // This is a record decl. We know the type and can devirtualize it.
2891 return VD->getType()->isRecordType();
2892 }
Justin Bogner1cd11f12015-05-20 15:53:59 +00002893
Anders Carlssonc36783e2011-05-08 20:32:23 +00002894 return false;
2895 }
Benjamin Kramer7463ed72013-08-25 22:46:27 +00002896
2897 // We can devirtualize calls on an object accessed by a class member access
2898 // expression, since by C++11 [basic.life]p6 we know that it can't refer to
2899 // a derived class object constructed in the same location.
2900 if (const MemberExpr *ME = dyn_cast<MemberExpr>(Base))
2901 if (const ValueDecl *VD = dyn_cast<ValueDecl>(ME->getMemberDecl()))
2902 return VD->getType()->isRecordType();
2903
Richard Smith018ac392016-11-03 18:55:18 +00002904 // Likewise for calls on an object accessed by a (non-reference) pointer to
2905 // member access.
2906 if (auto *BO = dyn_cast<BinaryOperator>(Base)) {
2907 if (BO->isPtrMemOp()) {
2908 auto *MPT = BO->getRHS()->getType()->castAs<MemberPointerType>();
2909 if (MPT->getPointeeType()->isRecordType())
2910 return true;
2911 }
2912 }
Anders Carlssonc36783e2011-05-08 20:32:23 +00002913
2914 // We can't devirtualize the call.
2915 return false;
2916}
2917
Faisal Vali571df122013-09-29 08:45:24 +00002918void CodeGenFunction::EmitForwardingCallToLambda(
2919 const CXXMethodDecl *callOperator,
2920 CallArgList &callArgs) {
Eli Friedman5b446882012-02-16 03:47:28 +00002921 // Get the address of the call operator.
John McCall8dda7b22012-07-07 06:41:13 +00002922 const CGFunctionInfo &calleeFnInfo =
2923 CGM.getTypes().arrangeCXXMethodDeclaration(callOperator);
John McCallb92ab1a2016-10-26 23:46:34 +00002924 llvm::Constant *calleePtr =
John McCall8dda7b22012-07-07 06:41:13 +00002925 CGM.GetAddrOfFunction(GlobalDecl(callOperator),
2926 CGM.getTypes().GetFunctionType(calleeFnInfo));
Eli Friedman5b446882012-02-16 03:47:28 +00002927
John McCall8dda7b22012-07-07 06:41:13 +00002928 // Prepare the return slot.
2929 const FunctionProtoType *FPT =
2930 callOperator->getType()->castAs<FunctionProtoType>();
Alp Toker314cc812014-01-25 16:55:45 +00002931 QualType resultType = FPT->getReturnType();
John McCall8dda7b22012-07-07 06:41:13 +00002932 ReturnValueSlot returnSlot;
2933 if (!resultType->isVoidType() &&
2934 calleeFnInfo.getReturnInfo().getKind() == ABIArgInfo::Indirect &&
John McCall47fb9502013-03-07 21:37:08 +00002935 !hasScalarEvaluationKind(calleeFnInfo.getReturnType()))
John McCall8dda7b22012-07-07 06:41:13 +00002936 returnSlot = ReturnValueSlot(ReturnValue, resultType.isVolatileQualified());
2937
2938 // We don't need to separately arrange the call arguments because
2939 // the call can't be variadic anyway --- it's impossible to forward
2940 // variadic arguments.
Justin Bogner1cd11f12015-05-20 15:53:59 +00002941
Eli Friedman5b446882012-02-16 03:47:28 +00002942 // Now emit our call.
John McCallb92ab1a2016-10-26 23:46:34 +00002943 auto callee = CGCallee::forDirect(calleePtr, callOperator);
2944 RValue RV = EmitCall(calleeFnInfo, callee, returnSlot, callArgs);
Eli Friedman5b446882012-02-16 03:47:28 +00002945
John McCall8dda7b22012-07-07 06:41:13 +00002946 // If necessary, copy the returned value into the slot.
2947 if (!resultType->isVoidType() && returnSlot.isNull())
2948 EmitReturnOfRValue(RV, resultType);
Eli Friedmanf5f4d2f2012-12-13 23:37:17 +00002949 else
2950 EmitBranchThroughCleanup(ReturnBlock);
Eli Friedman5b446882012-02-16 03:47:28 +00002951}
2952
Eli Friedman2495ab02012-02-25 02:48:22 +00002953void CodeGenFunction::EmitLambdaBlockInvokeBody() {
2954 const BlockDecl *BD = BlockInfo->getBlockDecl();
2955 const VarDecl *variable = BD->capture_begin()->getVariable();
2956 const CXXRecordDecl *Lambda = variable->getType()->getAsCXXRecordDecl();
2957
2958 // Start building arguments for forwarding call
2959 CallArgList CallArgs;
2960
2961 QualType ThisType = getContext().getPointerType(getContext().getRecordType(Lambda));
John McCall7f416cc2015-09-08 08:05:57 +00002962 Address ThisPtr = GetAddrOfBlockDecl(variable, false);
2963 CallArgs.add(RValue::get(ThisPtr.getPointer()), ThisType);
Eli Friedman2495ab02012-02-25 02:48:22 +00002964
2965 // Add the rest of the parameters.
David Majnemer59f77922016-06-24 04:05:48 +00002966 for (auto param : BD->parameters())
Nick Lewycky2d84e842013-10-02 02:29:49 +00002967 EmitDelegateCallArg(CallArgs, param, param->getLocStart());
Aaron Ballmanb2b8b1d2014-03-07 16:09:59 +00002968
Justin Bogner1cd11f12015-05-20 15:53:59 +00002969 assert(!Lambda->isGenericLambda() &&
Faisal Vali571df122013-09-29 08:45:24 +00002970 "generic lambda interconversion to block not implemented");
2971 EmitForwardingCallToLambda(Lambda->getLambdaCallOperator(), CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00002972}
2973
2974void CodeGenFunction::EmitLambdaToBlockPointerBody(FunctionArgList &Args) {
John McCalldec348f72013-05-03 07:33:41 +00002975 if (cast<CXXMethodDecl>(CurCodeDecl)->isVariadic()) {
Eli Friedman2495ab02012-02-25 02:48:22 +00002976 // FIXME: Making this work correctly is nasty because it requires either
2977 // cloning the body of the call operator or making the call operator forward.
John McCalldec348f72013-05-03 07:33:41 +00002978 CGM.ErrorUnsupported(CurCodeDecl, "lambda conversion to variadic function");
Eli Friedman2495ab02012-02-25 02:48:22 +00002979 return;
2980 }
2981
Richard Smithb47c36f2013-11-05 09:12:18 +00002982 EmitFunctionBody(Args, cast<FunctionDecl>(CurGD.getDecl())->getBody());
Eli Friedman2495ab02012-02-25 02:48:22 +00002983}
2984
2985void CodeGenFunction::EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD) {
2986 const CXXRecordDecl *Lambda = MD->getParent();
2987
2988 // Start building arguments for forwarding call
2989 CallArgList CallArgs;
2990
2991 QualType ThisType = getContext().getPointerType(getContext().getRecordType(Lambda));
2992 llvm::Value *ThisPtr = llvm::UndefValue::get(getTypes().ConvertType(ThisType));
2993 CallArgs.add(RValue::get(ThisPtr), ThisType);
2994
2995 // Add the rest of the parameters.
David Majnemer59f77922016-06-24 04:05:48 +00002996 for (auto Param : MD->parameters())
Aaron Ballmanf6bf62e2014-03-07 15:12:56 +00002997 EmitDelegateCallArg(CallArgs, Param, Param->getLocStart());
2998
Faisal Vali571df122013-09-29 08:45:24 +00002999 const CXXMethodDecl *CallOp = Lambda->getLambdaCallOperator();
3000 // For a generic lambda, find the corresponding call operator specialization
3001 // to which the call to the static-invoker shall be forwarded.
3002 if (Lambda->isGenericLambda()) {
3003 assert(MD->isFunctionTemplateSpecialization());
3004 const TemplateArgumentList *TAL = MD->getTemplateSpecializationArgs();
3005 FunctionTemplateDecl *CallOpTemplate = CallOp->getDescribedFunctionTemplate();
Craig Topper8a13c412014-05-21 05:09:00 +00003006 void *InsertPos = nullptr;
Justin Bogner1cd11f12015-05-20 15:53:59 +00003007 FunctionDecl *CorrespondingCallOpSpecialization =
Craig Topper7e0daca2014-06-26 04:58:53 +00003008 CallOpTemplate->findSpecialization(TAL->asArray(), InsertPos);
Faisal Vali571df122013-09-29 08:45:24 +00003009 assert(CorrespondingCallOpSpecialization);
3010 CallOp = cast<CXXMethodDecl>(CorrespondingCallOpSpecialization);
3011 }
3012 EmitForwardingCallToLambda(CallOp, CallArgs);
Eli Friedman2495ab02012-02-25 02:48:22 +00003013}
3014
Douglas Gregor355efbb2012-02-17 03:02:34 +00003015void CodeGenFunction::EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD) {
3016 if (MD->isVariadic()) {
Eli Friedman5b446882012-02-16 03:47:28 +00003017 // FIXME: Making this work correctly is nasty because it requires either
3018 // cloning the body of the call operator or making the call operator forward.
3019 CGM.ErrorUnsupported(MD, "lambda conversion to variadic function");
Eli Friedman2495ab02012-02-25 02:48:22 +00003020 return;
Eli Friedman5b446882012-02-16 03:47:28 +00003021 }
3022
Douglas Gregor355efbb2012-02-17 03:02:34 +00003023 EmitLambdaDelegatingInvokeBody(MD);
Eli Friedman5a6d5072012-02-16 01:37:33 +00003024}