blob: 7ed891f426aaae112989440cf14c26d043f0c785 [file] [log] [blame]
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001//===--- CGClass.cpp - Emit LLVM Code for C++ classes -----------*- C++ -*-===//
Anders Carlsson5d58a1d2009-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 Friedman64bee652012-02-25 02:48:22 +000014#include "CGBlocks.h"
Stephen Hines651f13c2014-04-23 16:59:28 -070015#include "CGCXXABI.h"
Devang Pateld67ef0e2010-08-11 21:04:37 +000016#include "CGDebugInfo.h"
Lang Hames56c00c42013-02-17 07:22:09 +000017#include "CGRecordLayout.h"
Anders Carlsson5d58a1d2009-09-12 04:27:24 +000018#include "CodeGenFunction.h"
Anders Carlsson2f1986b2009-10-06 22:43:30 +000019#include "clang/AST/CXXInheritance.h"
Faisal Valid6992ab2013-09-29 08:45:24 +000020#include "clang/AST/DeclTemplate.h"
John McCall7e1dff72010-09-17 02:31:44 +000021#include "clang/AST/EvaluatedExprVisitor.h"
Anders Carlsson5d58a1d2009-09-12 04:27:24 +000022#include "clang/AST/RecordLayout.h"
John McCall9fc6a772010-02-19 09:25:03 +000023#include "clang/AST/StmtCXX.h"
Lang Hames56c00c42013-02-17 07:22:09 +000024#include "clang/Basic/TargetBuiltins.h"
Mark Lacey8b549992013-10-30 21:53:58 +000025#include "clang/CodeGen/CGFunctionInfo.h"
Devang Patel3ee36af2011-02-22 20:55:26 +000026#include "clang/Frontend/CodeGenOptions.h"
Stephen Hines0e2c34f2015-03-23 12:09:02 -070027#include "llvm/IR/Intrinsics.h"
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -080028#include "llvm/IR/Metadata.h"
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -070029#include "llvm/Transforms/Utils/SanitizerStats.h"
Anders Carlsson2f1986b2009-10-06 22:43:30 +000030
Anders Carlsson5d58a1d2009-09-12 04:27:24 +000031using namespace clang;
32using namespace CodeGen;
33
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -080034/// 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
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -070098 // under-aligned and then safely access its fields and vtables.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -080099 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
147CharUnits CodeGenModule::computeNonVirtualBaseClassOffset(
148 const CXXRecordDecl *DerivedClass, CastExpr::path_const_iterator Start,
149 CastExpr::path_const_iterator End) {
Ken Dyck55c02582011-03-22 00:53:26 +0000150 CharUnits Offset = CharUnits::Zero();
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700151
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800152 const ASTContext &Context = getContext();
Anders Carlsson34a2d382010-04-24 21:06:20 +0000153 const CXXRecordDecl *RD = DerivedClass;
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700154
John McCallf871d0c2010-08-07 06:22:56 +0000155 for (CastExpr::path_const_iterator I = Start; I != End; ++I) {
Anders Carlsson34a2d382010-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);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700161
162 const CXXRecordDecl *BaseDecl =
Anders Carlsson34a2d382010-04-24 21:06:20 +0000163 cast<CXXRecordDecl>(Base->getType()->getAs<RecordType>()->getDecl());
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700164
Anders Carlsson34a2d382010-04-24 21:06:20 +0000165 // Add the offset.
Ken Dyck55c02582011-03-22 00:53:26 +0000166 Offset += Layout.getBaseClassOffset(BaseDecl);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700167
Anders Carlsson34a2d382010-04-24 21:06:20 +0000168 RD = BaseDecl;
169 }
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700170
Ken Dyck55c02582011-03-22 00:53:26 +0000171 return Offset;
Anders Carlsson34a2d382010-04-24 21:06:20 +0000172}
Anders Carlsson5d58a1d2009-09-12 04:27:24 +0000173
Anders Carlsson84080ec2009-09-29 03:13:20 +0000174llvm::Constant *
Anders Carlssona04efdf2010-04-24 21:23:59 +0000175CodeGenModule::GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl,
John McCallf871d0c2010-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 Carlssona04efdf2010-04-24 21:23:59 +0000179
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700180 CharUnits Offset =
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800181 computeNonVirtualBaseClassOffset(ClassDecl, PathBegin, PathEnd);
Ken Dyck55c02582011-03-22 00:53:26 +0000182 if (Offset.isZero())
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700183 return nullptr;
184
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700185 llvm::Type *PtrDiffTy =
Anders Carlssona04efdf2010-04-24 21:23:59 +0000186 Types.ConvertType(getContext().getPointerDiffType());
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700187
Ken Dyck55c02582011-03-22 00:53:26 +0000188 return llvm::ConstantInt::get(PtrDiffTy, Offset.getQuantity());
Anders Carlsson84080ec2009-09-29 03:13:20 +0000189}
190
Anders Carlsson8561a862010-04-24 23:01:49 +0000191/// Gets the address of a direct base class within a complete object.
John McCallbff225e2010-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.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800196Address
197CodeGenFunction::GetAddressOfDirectBaseInCompleteClass(Address This,
Anders Carlsson8561a862010-04-24 23:01:49 +0000198 const CXXRecordDecl *Derived,
199 const CXXRecordDecl *Base,
200 bool BaseIsVirtual) {
John McCallbff225e2010-02-16 04:15:37 +0000201 // 'this' must be a pointer (in some address space) to Derived.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800202 assert(This.getElementType() == ConvertType(Derived));
John McCallbff225e2010-02-16 04:15:37 +0000203
204 // Compute the offset of the virtual base.
Ken Dyck5fff46b2011-03-22 01:21:15 +0000205 CharUnits Offset;
John McCallbff225e2010-02-16 04:15:37 +0000206 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(Derived);
Anders Carlsson8561a862010-04-24 23:01:49 +0000207 if (BaseIsVirtual)
Ken Dyck5fff46b2011-03-22 01:21:15 +0000208 Offset = Layout.getVBaseClassOffset(Base);
John McCallbff225e2010-02-16 04:15:37 +0000209 else
Ken Dyck5fff46b2011-03-22 01:21:15 +0000210 Offset = Layout.getBaseClassOffset(Base);
John McCallbff225e2010-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.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800214 Address V = This;
215 if (!Offset.isZero()) {
216 V = Builder.CreateElementBitCast(V, Int8Ty);
217 V = Builder.CreateConstInBoundsByteGEP(V, Offset);
John McCallbff225e2010-02-16 04:15:37 +0000218 }
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800219 V = Builder.CreateElementBitCast(V, ConvertType(Base));
John McCallbff225e2010-02-16 04:15:37 +0000220
221 return V;
Anders Carlssond103f9f2010-03-28 19:40:00 +0000222}
John McCallbff225e2010-02-16 04:15:37 +0000223
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800224static Address
225ApplyNonVirtualAndVirtualOffset(CodeGenFunction &CGF, Address addr,
John McCall7916c992012-08-01 05:04:58 +0000226 CharUnits nonVirtualOffset,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800227 llvm::Value *virtualOffset,
228 const CXXRecordDecl *derivedClass,
229 const CXXRecordDecl *nearestVBase) {
John McCall7916c992012-08-01 05:04:58 +0000230 // Assert that we have something to do.
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700231 assert(!nonVirtualOffset.isZero() || virtualOffset != nullptr);
John McCall7916c992012-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 }
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700244
Anders Carlsson9dc228a2010-04-20 16:03:35 +0000245 // Apply the base offset.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800246 llvm::Value *ptr = addr.getPointer();
John McCall7916c992012-08-01 05:04:58 +0000247 ptr = CGF.Builder.CreateBitCast(ptr, CGF.Int8PtrTy);
248 ptr = CGF.Builder.CreateInBoundsGEP(ptr, baseOffset, "add.ptr");
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800249
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 Carlsson9dc228a2010-04-20 16:03:35 +0000263}
264
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800265Address CodeGenFunction::GetAddressOfBaseClass(
266 Address Value, const CXXRecordDecl *Derived,
Stephen Hines176edba2014-12-01 14:53:08 -0800267 CastExpr::path_const_iterator PathBegin,
268 CastExpr::path_const_iterator PathEnd, bool NullCheckValue,
269 SourceLocation Loc) {
John McCallf871d0c2010-08-07 06:22:56 +0000270 assert(PathBegin != PathEnd && "Base path should not be empty!");
Anders Carlsson34a2d382010-04-24 21:06:20 +0000271
John McCallf871d0c2010-08-07 06:22:56 +0000272 CastExpr::path_const_iterator Start = PathBegin;
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700273 const CXXRecordDecl *VBase = nullptr;
274
John McCall7916c992012-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 Carlsson34a2d382010-04-24 21:06:20 +0000279 if ((*Start)->isVirtual()) {
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700280 VBase =
Anders Carlsson34a2d382010-04-24 21:06:20 +0000281 cast<CXXRecordDecl>((*Start)->getType()->getAs<RecordType>()->getDecl());
282 ++Start;
283 }
John McCall7916c992012-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).
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800288 CharUnits NonVirtualOffset = CGM.computeNonVirtualBaseClassOffset(
289 VBase ? VBase : Derived, Start, PathEnd);
Anders Carlsson34a2d382010-04-24 21:06:20 +0000290
John McCall7916c992012-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;
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700298 VBase = nullptr; // we no longer have a virtual step
John McCall7916c992012-08-01 05:04:58 +0000299 }
300
Anders Carlsson34a2d382010-04-24 21:06:20 +0000301 // Get the base pointer type.
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700302 llvm::Type *BasePtrTy =
John McCallf871d0c2010-08-07 06:22:56 +0000303 ConvertType((PathEnd[-1])->getType())->getPointerTo();
John McCall7916c992012-08-01 05:04:58 +0000304
Stephen Hines176edba2014-12-01 14:53:08 -0800305 QualType DerivedTy = getContext().getRecordType(Derived);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800306 CharUnits DerivedAlign = CGM.getClassPointerAlignment(Derived);
Stephen Hines176edba2014-12-01 14:53:08 -0800307
John McCall7916c992012-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 Dyck55c02582011-03-22 00:53:26 +0000310 if (NonVirtualOffset.isZero() && !VBase) {
Stephen Hines176edba2014-12-01 14:53:08 -0800311 if (sanitizePerformTypeCheck()) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800312 EmitTypeCheck(TCK_Upcast, Loc, Value.getPointer(),
313 DerivedTy, DerivedAlign, !NullCheckValue);
Stephen Hines176edba2014-12-01 14:53:08 -0800314 }
Anders Carlsson34a2d382010-04-24 21:06:20 +0000315 return Builder.CreateBitCast(Value, BasePtrTy);
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700316 }
John McCall7916c992012-08-01 05:04:58 +0000317
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700318 llvm::BasicBlock *origBB = nullptr;
319 llvm::BasicBlock *endBB = nullptr;
320
John McCall7916c992012-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 Carlsson34a2d382010-04-24 21:06:20 +0000323 if (NullCheckValue) {
John McCall7916c992012-08-01 05:04:58 +0000324 origBB = Builder.GetInsertBlock();
325 llvm::BasicBlock *notNullBB = createBasicBlock("cast.notnull");
326 endBB = createBasicBlock("cast.end");
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700327
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800328 llvm::Value *isNull = Builder.CreateIsNull(Value.getPointer());
John McCall7916c992012-08-01 05:04:58 +0000329 Builder.CreateCondBr(isNull, endBB, notNullBB);
330 EmitBlock(notNullBB);
Anders Carlsson34a2d382010-04-24 21:06:20 +0000331 }
332
Stephen Hines176edba2014-12-01 14:53:08 -0800333 if (sanitizePerformTypeCheck()) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800334 EmitTypeCheck(VBase ? TCK_UpcastToVirtualBase : TCK_Upcast, Loc,
335 Value.getPointer(), DerivedTy, DerivedAlign, true);
Stephen Hines176edba2014-12-01 14:53:08 -0800336 }
337
John McCall7916c992012-08-01 05:04:58 +0000338 // Compute the virtual offset.
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700339 llvm::Value *VirtualOffset = nullptr;
Anders Carlsson336a7dc2011-01-29 03:18:56 +0000340 if (VBase) {
Reid Klecknerb0f533e2013-05-29 18:02:47 +0000341 VirtualOffset =
342 CGM.getCXXABI().GetVirtualBaseClassOffset(*this, Value, Derived, VBase);
Anders Carlsson336a7dc2011-01-29 03:18:56 +0000343 }
Anders Carlsson34a2d382010-04-24 21:06:20 +0000344
John McCall7916c992012-08-01 05:04:58 +0000345 // Apply both offsets.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800346 Value = ApplyNonVirtualAndVirtualOffset(*this, Value, NonVirtualOffset,
347 VirtualOffset, Derived, VBase);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700348
John McCall7916c992012-08-01 05:04:58 +0000349 // Cast to the destination type.
Anders Carlsson34a2d382010-04-24 21:06:20 +0000350 Value = Builder.CreateBitCast(Value, BasePtrTy);
John McCall7916c992012-08-01 05:04:58 +0000351
352 // Build a phi if we needed a null check.
Anders Carlsson34a2d382010-04-24 21:06:20 +0000353 if (NullCheckValue) {
John McCall7916c992012-08-01 05:04:58 +0000354 llvm::BasicBlock *notNullBB = Builder.GetInsertBlock();
355 Builder.CreateBr(endBB);
356 EmitBlock(endBB);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700357
John McCall7916c992012-08-01 05:04:58 +0000358 llvm::PHINode *PHI = Builder.CreatePHI(BasePtrTy, 2, "cast.result");
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800359 PHI->addIncoming(Value.getPointer(), notNullBB);
John McCall7916c992012-08-01 05:04:58 +0000360 PHI->addIncoming(llvm::Constant::getNullValue(BasePtrTy), origBB);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800361 Value = Address(PHI, Value.getAlignment());
Anders Carlsson34a2d382010-04-24 21:06:20 +0000362 }
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700363
Anders Carlsson34a2d382010-04-24 21:06:20 +0000364 return Value;
365}
366
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800367Address
368CodeGenFunction::GetAddressOfDerivedClass(Address BaseAddr,
Anders Carlsson8561a862010-04-24 23:01:49 +0000369 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +0000370 CastExpr::path_const_iterator PathBegin,
371 CastExpr::path_const_iterator PathEnd,
Anders Carlssona3697c92009-11-23 17:57:54 +0000372 bool NullCheckValue) {
John McCallf871d0c2010-08-07 06:22:56 +0000373 assert(PathBegin != PathEnd && "Base path should not be empty!");
Anders Carlssona04efdf2010-04-24 21:23:59 +0000374
Anders Carlssona3697c92009-11-23 17:57:54 +0000375 QualType DerivedTy =
Anders Carlsson8561a862010-04-24 23:01:49 +0000376 getContext().getCanonicalType(getContext().getTagDeclType(Derived));
Chris Lattner2acc6e32011-07-18 04:24:23 +0000377 llvm::Type *DerivedPtrTy = ConvertType(DerivedTy)->getPointerTo();
Richard Smithc7648302013-02-13 21:18:23 +0000378
Anders Carlssona552ea72010-01-31 01:43:37 +0000379 llvm::Value *NonVirtualOffset =
John McCallf871d0c2010-08-07 06:22:56 +0000380 CGM.GetNonVirtualBaseClassOffset(Derived, PathBegin, PathEnd);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700381
Anders Carlssona552ea72010-01-31 01:43:37 +0000382 if (!NonVirtualOffset) {
383 // No offset, we can just cast back.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800384 return Builder.CreateBitCast(BaseAddr, DerivedPtrTy);
Anders Carlssona552ea72010-01-31 01:43:37 +0000385 }
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700386
387 llvm::BasicBlock *CastNull = nullptr;
388 llvm::BasicBlock *CastNotNull = nullptr;
389 llvm::BasicBlock *CastEnd = nullptr;
390
Anders Carlssona3697c92009-11-23 17:57:54 +0000391 if (NullCheckValue) {
392 CastNull = createBasicBlock("cast.null");
393 CastNotNull = createBasicBlock("cast.notnull");
394 CastEnd = createBasicBlock("cast.end");
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700395
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800396 llvm::Value *IsNull = Builder.CreateIsNull(BaseAddr.getPointer());
Anders Carlssona3697c92009-11-23 17:57:54 +0000397 Builder.CreateCondBr(IsNull, CastNull, CastNotNull);
398 EmitBlock(CastNotNull);
399 }
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700400
Anders Carlssona552ea72010-01-31 01:43:37 +0000401 // Apply the offset.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800402 llvm::Value *Value = Builder.CreateBitCast(BaseAddr.getPointer(), Int8PtrTy);
Eli Friedmanc5685432012-02-28 22:07:56 +0000403 Value = Builder.CreateGEP(Value, Builder.CreateNeg(NonVirtualOffset),
404 "sub.ptr");
Anders Carlssona552ea72010-01-31 01:43:37 +0000405
406 // Just cast.
407 Value = Builder.CreateBitCast(Value, DerivedPtrTy);
Anders Carlssona3697c92009-11-23 17:57:54 +0000408
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800409 // Produce a PHI if we had a null-check.
Anders Carlssona3697c92009-11-23 17:57:54 +0000410 if (NullCheckValue) {
411 Builder.CreateBr(CastEnd);
412 EmitBlock(CastNull);
413 Builder.CreateBr(CastEnd);
414 EmitBlock(CastEnd);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700415
Jay Foadbbf3bac2011-03-30 11:28:58 +0000416 llvm::PHINode *PHI = Builder.CreatePHI(Value->getType(), 2);
Anders Carlssona3697c92009-11-23 17:57:54 +0000417 PHI->addIncoming(Value, CastNotNull);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800418 PHI->addIncoming(llvm::Constant::getNullValue(Value->getType()), CastNull);
Anders Carlssona3697c92009-11-23 17:57:54 +0000419 Value = PHI;
420 }
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700421
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800422 return Address(Value, CGM.getClassPointerAlignment(Derived));
Anders Carlsson5d58a1d2009-09-12 04:27:24 +0000423}
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +0000424
425llvm::Value *CodeGenFunction::GetVTTParameter(GlobalDecl GD,
426 bool ForVirtualBase,
427 bool Delegating) {
Peter Collingbournee1e35f72013-06-28 20:45:28 +0000428 if (!CGM.getCXXABI().NeedsVTTParameter(GD)) {
Anders Carlssonc997d422010-01-02 01:01:18 +0000429 // This constructor/destructor does not need a VTT parameter.
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700430 return nullptr;
Anders Carlssonc997d422010-01-02 01:01:18 +0000431 }
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700432
John McCallf5ebf9b2013-05-03 07:33:41 +0000433 const CXXRecordDecl *RD = cast<CXXMethodDecl>(CurCodeDecl)->getParent();
Anders Carlssonc997d422010-01-02 01:01:18 +0000434 const CXXRecordDecl *Base = cast<CXXMethodDecl>(GD.getDecl())->getParent();
John McCall3b477332010-02-18 19:59:28 +0000435
Anders Carlssonc997d422010-01-02 01:01:18 +0000436 llvm::Value *VTT;
437
John McCall3b477332010-02-18 19:59:28 +0000438 uint64_t SubVTTIndex;
439
Douglas Gregor378e1e72013-01-31 05:50:40 +0000440 if (Delegating) {
441 // If this is a delegating constructor call, just load the VTT.
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +0000442 return LoadCXXVTT();
Douglas Gregor378e1e72013-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 Collingbournee1e35f72013-06-28 20:45:28 +0000446 assert(!CGM.getCXXABI().NeedsVTTParameter(CurGD) &&
John McCall3b477332010-02-18 19:59:28 +0000447 "doing no-op VTT offset in base dtor/ctor?");
Anders Carlsson314e6222010-05-02 23:33:10 +0000448 assert(!ForVirtualBase && "Can't have same class as virtual base!");
John McCall3b477332010-02-18 19:59:28 +0000449 SubVTTIndex = 0;
450 } else {
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +0000451 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700452 CharUnits BaseOffset = ForVirtualBase ?
453 Layout.getVBaseClassOffset(Base) :
Ken Dyck4230d522011-03-24 01:21:01 +0000454 Layout.getBaseClassOffset(Base);
Anders Carlssonc11bb212010-05-02 23:53:25 +0000455
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700456 SubVTTIndex =
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +0000457 CGM.getVTables().getSubVTTIndex(RD, BaseSubobject(Base, BaseOffset));
John McCall3b477332010-02-18 19:59:28 +0000458 assert(SubVTTIndex != 0 && "Sub-VTT index must be greater than zero!");
459 }
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700460
Peter Collingbournee1e35f72013-06-28 20:45:28 +0000461 if (CGM.getCXXABI().NeedsVTTParameter(CurGD)) {
Anders Carlssonc997d422010-01-02 01:01:18 +0000462 // A VTT parameter was passed to the constructor, use it.
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +0000463 VTT = LoadCXXVTT();
464 VTT = Builder.CreateConstInBoundsGEP1_64(VTT, SubVTTIndex);
Anders Carlssonc997d422010-01-02 01:01:18 +0000465 } else {
466 // We're the complete constructor, so get the VTT by name.
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +0000467 VTT = CGM.getVTables().GetAddrOfVTT(RD);
468 VTT = Builder.CreateConstInBoundsGEP2_64(VTT, 0, SubVTTIndex);
Anders Carlssonc997d422010-01-02 01:01:18 +0000469 }
470
471 return VTT;
472}
473
John McCall182ab512010-07-21 01:23:41 +0000474namespace {
John McCall50da2ca2010-07-21 05:30:47 +0000475 /// Call the destructor for a direct base class.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800476 struct CallBaseDtor final : EHScopeStack::Cleanup {
John McCall50da2ca2010-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 McCall182ab512010-07-21 01:23:41 +0000481
Stephen Hines651f13c2014-04-23 16:59:28 -0700482 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall50da2ca2010-07-21 05:30:47 +0000483 const CXXRecordDecl *DerivedClass =
484 cast<CXXMethodDecl>(CGF.CurCodeDecl)->getParent();
485
486 const CXXDestructorDecl *D = BaseClass->getDestructor();
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800487 Address Addr =
488 CGF.GetAddressOfDirectBaseInCompleteClass(CGF.LoadCXXThisAddress(),
John McCall50da2ca2010-07-21 05:30:47 +0000489 DerivedClass, BaseClass,
490 BaseIsVirtual);
Douglas Gregor378e1e72013-01-31 05:50:40 +0000491 CGF.EmitCXXDestructorCall(D, Dtor_Base, BaseIsVirtual,
492 /*Delegating=*/false, Addr);
John McCall182ab512010-07-21 01:23:41 +0000493 }
494 };
John McCall7e1dff72010-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.
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700498 struct DynamicThisUseChecker : ConstEvaluatedExprVisitor<DynamicThisUseChecker> {
499 typedef ConstEvaluatedExprVisitor<DynamicThisUseChecker> super;
John McCall7e1dff72010-09-17 02:31:44 +0000500
501 bool UsesThis;
502
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700503 DynamicThisUseChecker(const ASTContext &C) : super(C), UsesThis(false) {}
John McCall7e1dff72010-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.
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700510 void VisitCXXThisExpr(const CXXThisExpr *E) { UsesThis = true; }
John McCall7e1dff72010-09-17 02:31:44 +0000511 };
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800512} // end anonymous namespace
John McCall7e1dff72010-09-17 02:31:44 +0000513
514static bool BaseInitializerUsesThis(ASTContext &C, const Expr *Init) {
515 DynamicThisUseChecker Checker(C);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700516 Checker.Visit(Init);
John McCall7e1dff72010-09-17 02:31:44 +0000517 return Checker.UsesThis;
John McCall182ab512010-07-21 01:23:41 +0000518}
519
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700520static void EmitBaseInitializer(CodeGenFunction &CGF,
Anders Carlsson607d0372009-12-24 22:46:43 +0000521 const CXXRecordDecl *ClassDecl,
Sean Huntcbb67482011-01-08 20:30:50 +0000522 CXXCtorInitializer *BaseInit,
Anders Carlsson607d0372009-12-24 22:46:43 +0000523 CXXCtorType CtorType) {
524 assert(BaseInit->isBaseInitializer() &&
525 "Must have base initializer!");
526
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800527 Address ThisPtr = CGF.LoadCXXThisAddress();
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700528
Anders Carlsson607d0372009-12-24 22:46:43 +0000529 const Type *BaseType = BaseInit->getBaseClass();
530 CXXRecordDecl *BaseClassDecl =
531 cast<CXXRecordDecl>(BaseType->getAs<RecordType>()->getDecl());
532
Anders Carlsson80638c52010-04-12 00:51:03 +0000533 bool isBaseVirtual = BaseInit->isBaseVirtual();
Anders Carlsson607d0372009-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 McCall7e1dff72010-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 McCallbff225e2010-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.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800547 Address V =
Anders Carlsson8561a862010-04-24 23:01:49 +0000548 CGF.GetAddressOfDirectBaseInCompleteClass(ThisPtr, ClassDecl,
John McCall50da2ca2010-07-21 05:30:47 +0000549 BaseClassDecl,
550 isBaseVirtual);
John McCall7c2349b2011-08-25 20:40:09 +0000551 AggValueSlot AggSlot =
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800552 AggValueSlot::forAddr(V, Qualifiers(),
John McCall7c2349b2011-08-25 20:40:09 +0000553 AggValueSlot::IsDestructed,
John McCall410ffb22011-08-25 23:04:34 +0000554 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier649b4a12012-03-29 17:37:10 +0000555 AggValueSlot::IsNotAliased);
John McCall558d2ab2010-09-15 10:14:12 +0000556
557 CGF.EmitAggExpr(BaseInit->getInit(), AggSlot);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700558
559 if (CGF.CGM.getLangOpts().Exceptions &&
Anders Carlssonc1cfdf82011-02-20 00:20:27 +0000560 !BaseClassDecl->hasTrivialDestructor())
John McCall1f0fca52010-07-21 07:22:38 +0000561 CGF.EHStack.pushCleanup<CallBaseDtor>(EHCleanup, BaseClassDecl,
562 isBaseVirtual);
Anders Carlsson607d0372009-12-24 22:46:43 +0000563}
564
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000565static void EmitAggMemberInitializer(CodeGenFunction &CGF,
566 LValue LHS,
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000567 Expr *Init,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800568 Address ArrayIndexVar,
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000569 QualType T,
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000570 ArrayRef<VarDecl *> ArrayIndexes,
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000571 unsigned Index) {
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000572 if (Index == ArrayIndexes.size()) {
Eli Friedmanf3940782011-12-03 00:54:26 +0000573 LValue LV = LHS;
Eli Friedmanf3940782011-12-03 00:54:26 +0000574
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800575 if (ArrayIndexVar.isValid()) {
Richard Smith7c3e6152013-06-12 22:31:48 +0000576 // If we have an array index variable, load it and use it as an offset.
577 // Then, increment the value.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800578 llvm::Value *Dest = LHS.getPointer();
Richard Smith7c3e6152013-06-12 22:31:48 +0000579 llvm::Value *ArrayIndex = CGF.Builder.CreateLoad(ArrayIndexVar);
580 Dest = CGF.Builder.CreateInBoundsGEP(Dest, ArrayIndex, "destaddress");
581 llvm::Value *Next = llvm::ConstantInt::get(ArrayIndex->getType(), 1);
582 Next = CGF.Builder.CreateAdd(ArrayIndex, Next, "inc");
583 CGF.Builder.CreateStore(Next, ArrayIndexVar);
Sebastian Redl924db712012-02-19 15:41:54 +0000584
Richard Smith7c3e6152013-06-12 22:31:48 +0000585 // Update the LValue.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800586 CharUnits EltSize = CGF.getContext().getTypeSizeInChars(T);
587 CharUnits Align = LV.getAlignment().alignmentOfArrayElement(EltSize);
588 LV.setAddress(Address(Dest, Align));
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000589 }
John McCall558d2ab2010-09-15 10:14:12 +0000590
Richard Smith7c3e6152013-06-12 22:31:48 +0000591 switch (CGF.getEvaluationKind(T)) {
592 case TEK_Scalar:
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700593 CGF.EmitScalarInit(Init, /*decl*/ nullptr, LV, false);
Richard Smith7c3e6152013-06-12 22:31:48 +0000594 break;
595 case TEK_Complex:
596 CGF.EmitComplexExprIntoLValue(Init, LV, /*isInit*/ true);
597 break;
598 case TEK_Aggregate: {
599 AggValueSlot Slot =
600 AggValueSlot::forLValue(LV,
601 AggValueSlot::IsDestructed,
602 AggValueSlot::DoesNotNeedGCBarriers,
603 AggValueSlot::IsNotAliased);
604
605 CGF.EmitAggExpr(Init, Slot);
606 break;
607 }
608 }
Sebastian Redl924db712012-02-19 15:41:54 +0000609
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000610 return;
611 }
Richard Smith7c3e6152013-06-12 22:31:48 +0000612
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000613 const ConstantArrayType *Array = CGF.getContext().getAsConstantArrayType(T);
614 assert(Array && "Array initialization without the array type?");
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800615 Address IndexVar = CGF.GetAddrOfLocalVar(ArrayIndexes[Index]);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700616
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000617 // Initialize this index variable to zero.
618 llvm::Value* Zero
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800619 = llvm::Constant::getNullValue(IndexVar.getElementType());
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000620 CGF.Builder.CreateStore(Zero, IndexVar);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700621
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000622 // Start the loop with a block that tests the condition.
623 llvm::BasicBlock *CondBlock = CGF.createBasicBlock("for.cond");
624 llvm::BasicBlock *AfterFor = CGF.createBasicBlock("for.end");
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700625
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000626 CGF.EmitBlock(CondBlock);
627
628 llvm::BasicBlock *ForBody = CGF.createBasicBlock("for.body");
629 // Generate: if (loop-index < number-of-elements) fall to the loop body,
630 // otherwise, go to the block after the for-loop.
631 uint64_t NumElements = Array->getSize().getZExtValue();
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000632 llvm::Value *Counter = CGF.Builder.CreateLoad(IndexVar);
Chris Lattner985f7392010-05-06 06:35:23 +0000633 llvm::Value *NumElementsPtr =
634 llvm::ConstantInt::get(Counter->getType(), NumElements);
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000635 llvm::Value *IsLess = CGF.Builder.CreateICmpULT(Counter, NumElementsPtr,
636 "isless");
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700637
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000638 // If the condition is true, execute the body.
639 CGF.Builder.CreateCondBr(IsLess, ForBody, AfterFor);
640
641 CGF.EmitBlock(ForBody);
642 llvm::BasicBlock *ContinueBlock = CGF.createBasicBlock("for.inc");
Richard Smith7c3e6152013-06-12 22:31:48 +0000643
644 // Inside the loop body recurse to emit the inner loop or, eventually, the
645 // constructor call.
646 EmitAggMemberInitializer(CGF, LHS, Init, ArrayIndexVar,
647 Array->getElementType(), ArrayIndexes, Index + 1);
648
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000649 CGF.EmitBlock(ContinueBlock);
650
651 // Emit the increment of the loop counter.
652 llvm::Value *NextVal = llvm::ConstantInt::get(Counter->getType(), 1);
653 Counter = CGF.Builder.CreateLoad(IndexVar);
654 NextVal = CGF.Builder.CreateAdd(Counter, NextVal, "inc");
655 CGF.Builder.CreateStore(NextVal, IndexVar);
656
657 // Finally, branch back up to the condition for the next iteration.
658 CGF.EmitBranch(CondBlock);
659
660 // Emit the fall-through block.
661 CGF.EmitBlock(AfterFor, true);
662}
John McCall182ab512010-07-21 01:23:41 +0000663
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700664static bool isMemcpyEquivalentSpecialMember(const CXXMethodDecl *D) {
665 auto *CD = dyn_cast<CXXConstructorDecl>(D);
666 if (!(CD && CD->isCopyOrMoveConstructor()) &&
667 !D->isCopyAssignmentOperator() && !D->isMoveAssignmentOperator())
668 return false;
669
670 // We can emit a memcpy for a trivial copy or move constructor/assignment.
671 if (D->isTrivial() && !D->getParent()->mayInsertExtraPadding())
672 return true;
673
674 // We *must* emit a memcpy for a defaulted union copy or move op.
675 if (D->getParent()->isUnion() && D->isDefaulted())
676 return true;
677
678 return false;
679}
680
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800681static void EmitLValueForAnyFieldInitialization(CodeGenFunction &CGF,
682 CXXCtorInitializer *MemberInit,
683 LValue &LHS) {
684 FieldDecl *Field = MemberInit->getAnyMember();
685 if (MemberInit->isIndirectMemberInitializer()) {
686 // If we are initializing an anonymous union field, drill down to the field.
687 IndirectFieldDecl *IndirectField = MemberInit->getIndirectMember();
688 for (const auto *I : IndirectField->chain())
689 LHS = CGF.EmitLValueForFieldInitialization(LHS, cast<FieldDecl>(I));
690 } else {
691 LHS = CGF.EmitLValueForFieldInitialization(LHS, Field);
692 }
693}
694
Anders Carlsson607d0372009-12-24 22:46:43 +0000695static void EmitMemberInitializer(CodeGenFunction &CGF,
696 const CXXRecordDecl *ClassDecl,
Sean Huntcbb67482011-01-08 20:30:50 +0000697 CXXCtorInitializer *MemberInit,
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000698 const CXXConstructorDecl *Constructor,
699 FunctionArgList &Args) {
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700700 ApplyDebugLocation Loc(CGF, MemberInit->getSourceLocation());
Francois Pichet00eb3f92010-12-04 09:14:42 +0000701 assert(MemberInit->isAnyMemberInitializer() &&
Anders Carlsson607d0372009-12-24 22:46:43 +0000702 "Must have member initializer!");
Richard Smith7a614d82011-06-11 17:19:42 +0000703 assert(MemberInit->getInit() && "Must have initializer!");
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700704
Anders Carlsson607d0372009-12-24 22:46:43 +0000705 // non-static data member initializers.
Francois Pichet00eb3f92010-12-04 09:14:42 +0000706 FieldDecl *Field = MemberInit->getAnyMember();
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000707 QualType FieldType = Field->getType();
Anders Carlsson607d0372009-12-24 22:46:43 +0000708
709 llvm::Value *ThisPtr = CGF.LoadCXXThis();
Eli Friedman377ecc72012-04-16 03:54:45 +0000710 QualType RecordTy = CGF.getContext().getTypeDeclType(ClassDecl);
Eli Friedman859c65c2012-08-08 03:51:37 +0000711 LValue LHS = CGF.MakeNaturalAlignAddrLValue(ThisPtr, RecordTy);
Eli Friedman377ecc72012-04-16 03:54:45 +0000712
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800713 EmitLValueForAnyFieldInitialization(CGF, MemberInit, LHS);
Anders Carlsson607d0372009-12-24 22:46:43 +0000714
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000715 // Special case: if we are in a copy or move constructor, and we are copying
716 // an array of PODs or classes with trivial copy constructors, ignore the
717 // AST and perform the copy we know is equivalent.
718 // FIXME: This is hacky at best... if we had a bit more explicit information
719 // in the AST, we could generalize it more easily.
720 const ConstantArrayType *Array
721 = CGF.getContext().getAsConstantArrayType(FieldType);
Jordan Rosea7b87972013-08-07 16:16:48 +0000722 if (Array && Constructor->isDefaulted() &&
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000723 Constructor->isCopyOrMoveConstructor()) {
724 QualType BaseElementTy = CGF.getContext().getBaseElementType(Array);
Richard Smithe9385362012-11-07 23:56:21 +0000725 CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(MemberInit->getInit());
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000726 if (BaseElementTy.isPODType(CGF.getContext()) ||
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700727 (CE && isMemcpyEquivalentSpecialMember(CE->getConstructor()))) {
Stephen Hines176edba2014-12-01 14:53:08 -0800728 unsigned SrcArgIndex =
729 CGF.CGM.getCXXABI().getSrcArgforCopyCtor(Constructor, Args);
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000730 llvm::Value *SrcPtr
731 = CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(Args[SrcArgIndex]));
Eli Friedman377ecc72012-04-16 03:54:45 +0000732 LValue ThisRHSLV = CGF.MakeNaturalAlignAddrLValue(SrcPtr, RecordTy);
733 LValue Src = CGF.EmitLValueForFieldInitialization(ThisRHSLV, Field);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700734
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000735 // Copy the aggregate.
736 CGF.EmitAggregateCopy(LHS.getAddress(), Src.getAddress(), FieldType,
Chad Rosier649b4a12012-03-29 17:37:10 +0000737 LHS.isVolatileQualified());
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800738 // Ensure that we destroy the objects if an exception is thrown later in
739 // the constructor.
740 QualType::DestructionKind dtorKind = FieldType.isDestructedType();
741 if (CGF.needsEHCleanup(dtorKind))
742 CGF.pushEHDestroy(dtorKind, LHS.getAddress(), FieldType);
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000743 return;
744 }
745 }
746
747 ArrayRef<VarDecl *> ArrayIndexes;
748 if (MemberInit->getNumArrayIndices())
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700749 ArrayIndexes = MemberInit->getArrayIndices();
Eli Friedmanb74ed082012-02-14 02:31:03 +0000750 CGF.EmitInitializerForField(Field, LHS, MemberInit->getInit(), ArrayIndexes);
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000751}
752
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800753void CodeGenFunction::EmitInitializerForField(FieldDecl *Field, LValue LHS,
754 Expr *Init, ArrayRef<VarDecl *> ArrayIndexes) {
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000755 QualType FieldType = Field->getType();
John McCall9d232c82013-03-07 21:37:08 +0000756 switch (getEvaluationKind(FieldType)) {
757 case TEK_Scalar:
John McCallf85e1932011-06-15 23:02:42 +0000758 if (LHS.isSimple()) {
Eli Friedmanb74ed082012-02-14 02:31:03 +0000759 EmitExprAsInit(Init, Field, LHS, false);
John McCallf85e1932011-06-15 23:02:42 +0000760 } else {
Eli Friedmanb74ed082012-02-14 02:31:03 +0000761 RValue RHS = RValue::get(EmitScalarExpr(Init));
762 EmitStoreThroughLValue(RHS, LHS);
John McCallf85e1932011-06-15 23:02:42 +0000763 }
John McCall9d232c82013-03-07 21:37:08 +0000764 break;
765 case TEK_Complex:
766 EmitComplexExprIntoLValue(Init, LHS, /*isInit*/ true);
767 break;
768 case TEK_Aggregate: {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800769 Address ArrayIndexVar = Address::invalid();
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000770 if (ArrayIndexes.size()) {
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000771 // The LHS is a pointer to the first object we'll be constructing, as
772 // a flat array.
Eli Friedmanb74ed082012-02-14 02:31:03 +0000773 QualType BaseElementTy = getContext().getBaseElementType(FieldType);
774 llvm::Type *BasePtr = ConvertType(BaseElementTy);
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000775 BasePtr = llvm::PointerType::getUnqual(BasePtr);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800776 Address BaseAddrPtr = Builder.CreateBitCast(LHS.getAddress(), BasePtr);
Eli Friedmanb74ed082012-02-14 02:31:03 +0000777 LHS = MakeAddrLValue(BaseAddrPtr, BaseElementTy);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700778
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000779 // Create an array index that will be used to walk over all of the
780 // objects we're constructing.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800781 ArrayIndexVar = CreateMemTemp(getContext().getSizeType(), "object.index");
782 llvm::Value *Zero =
783 llvm::Constant::getNullValue(ArrayIndexVar.getElementType());
Eli Friedmanb74ed082012-02-14 02:31:03 +0000784 Builder.CreateStore(Zero, ArrayIndexVar);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700785
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000786 // Emit the block variables for the array indices, if any.
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000787 for (unsigned I = 0, N = ArrayIndexes.size(); I != N; ++I)
Eli Friedmanb74ed082012-02-14 02:31:03 +0000788 EmitAutoVarDecl(*ArrayIndexes[I]);
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000789 }
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700790
Eli Friedmanb74ed082012-02-14 02:31:03 +0000791 EmitAggMemberInitializer(*this, LHS, Init, ArrayIndexVar, FieldType,
Eli Friedman0bdb5aa2012-02-14 02:15:49 +0000792 ArrayIndexes, 0);
Anders Carlsson607d0372009-12-24 22:46:43 +0000793 }
John McCall9d232c82013-03-07 21:37:08 +0000794 }
John McCall074cae02013-02-01 05:11:40 +0000795
796 // Ensure that we destroy this object if an exception is thrown
797 // later in the constructor.
798 QualType::DestructionKind dtorKind = FieldType.isDestructedType();
799 if (needsEHCleanup(dtorKind))
800 pushEHDestroy(dtorKind, LHS.getAddress(), FieldType);
Anders Carlsson607d0372009-12-24 22:46:43 +0000801}
802
John McCallc0bf4622010-02-23 00:48:20 +0000803/// Checks whether the given constructor is a valid subject for the
804/// complete-to-base constructor delegation optimization, i.e.
805/// emitting the complete constructor as a simple call to the base
806/// constructor.
807static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor) {
808
809 // Currently we disable the optimization for classes with virtual
810 // bases because (1) the addresses of parameter variables need to be
811 // consistent across all initializers but (2) the delegate function
812 // call necessarily creates a second copy of the parameter variable.
813 //
814 // The limiting example (purely theoretical AFAIK):
815 // struct A { A(int &c) { c++; } };
816 // struct B : virtual A {
817 // B(int count) : A(count) { printf("%d\n", count); }
818 // };
819 // ...although even this example could in principle be emitted as a
820 // delegation since the address of the parameter doesn't escape.
821 if (Ctor->getParent()->getNumVBases()) {
822 // TODO: white-list trivial vbase initializers. This case wouldn't
823 // be subject to the restrictions below.
824
825 // TODO: white-list cases where:
826 // - there are no non-reference parameters to the constructor
827 // - the initializers don't access any non-reference parameters
828 // - the initializers don't take the address of non-reference
829 // parameters
830 // - etc.
831 // If we ever add any of the above cases, remember that:
832 // - function-try-blocks will always blacklist this optimization
833 // - we need to perform the constructor prologue and cleanup in
834 // EmitConstructorBody.
835
836 return false;
837 }
838
839 // We also disable the optimization for variadic functions because
840 // it's impossible to "re-pass" varargs.
841 if (Ctor->getType()->getAs<FunctionProtoType>()->isVariadic())
842 return false;
843
Sean Hunt059ce0d2011-05-01 07:04:31 +0000844 // FIXME: Decide if we can do a delegation of a delegating constructor.
845 if (Ctor->isDelegatingConstructor())
846 return false;
847
John McCallc0bf4622010-02-23 00:48:20 +0000848 return true;
849}
850
Stephen Hines176edba2014-12-01 14:53:08 -0800851// Emit code in ctor (Prologue==true) or dtor (Prologue==false)
852// to poison the extra field paddings inserted under
853// -fsanitize-address-field-padding=1|2.
854void CodeGenFunction::EmitAsanPrologueOrEpilogue(bool Prologue) {
855 ASTContext &Context = getContext();
856 const CXXRecordDecl *ClassDecl =
857 Prologue ? cast<CXXConstructorDecl>(CurGD.getDecl())->getParent()
858 : cast<CXXDestructorDecl>(CurGD.getDecl())->getParent();
859 if (!ClassDecl->mayInsertExtraPadding()) return;
860
861 struct SizeAndOffset {
862 uint64_t Size;
863 uint64_t Offset;
864 };
865
866 unsigned PtrSize = CGM.getDataLayout().getPointerSizeInBits();
867 const ASTRecordLayout &Info = Context.getASTRecordLayout(ClassDecl);
868
869 // Populate sizes and offsets of fields.
870 SmallVector<SizeAndOffset, 16> SSV(Info.getFieldCount());
871 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i)
872 SSV[i].Offset =
873 Context.toCharUnitsFromBits(Info.getFieldOffset(i)).getQuantity();
874
875 size_t NumFields = 0;
876 for (const auto *Field : ClassDecl->fields()) {
877 const FieldDecl *D = Field;
878 std::pair<CharUnits, CharUnits> FieldInfo =
879 Context.getTypeInfoInChars(D->getType());
880 CharUnits FieldSize = FieldInfo.first;
881 assert(NumFields < SSV.size());
882 SSV[NumFields].Size = D->isBitField() ? 0 : FieldSize.getQuantity();
883 NumFields++;
884 }
885 assert(NumFields == SSV.size());
886 if (SSV.size() <= 1) return;
887
888 // We will insert calls to __asan_* run-time functions.
889 // LLVM AddressSanitizer pass may decide to inline them later.
890 llvm::Type *Args[2] = {IntPtrTy, IntPtrTy};
891 llvm::FunctionType *FTy =
892 llvm::FunctionType::get(CGM.VoidTy, Args, false);
893 llvm::Constant *F = CGM.CreateRuntimeFunction(
894 FTy, Prologue ? "__asan_poison_intra_object_redzone"
895 : "__asan_unpoison_intra_object_redzone");
896
897 llvm::Value *ThisPtr = LoadCXXThis();
898 ThisPtr = Builder.CreatePtrToInt(ThisPtr, IntPtrTy);
899 uint64_t TypeSize = Info.getNonVirtualSize().getQuantity();
900 // For each field check if it has sufficient padding,
901 // if so (un)poison it with a call.
902 for (size_t i = 0; i < SSV.size(); i++) {
903 uint64_t AsanAlignment = 8;
904 uint64_t NextField = i == SSV.size() - 1 ? TypeSize : SSV[i + 1].Offset;
905 uint64_t PoisonSize = NextField - SSV[i].Offset - SSV[i].Size;
906 uint64_t EndOffset = SSV[i].Offset + SSV[i].Size;
907 if (PoisonSize < AsanAlignment || !SSV[i].Size ||
908 (NextField % AsanAlignment) != 0)
909 continue;
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700910 Builder.CreateCall(
911 F, {Builder.CreateAdd(ThisPtr, Builder.getIntN(PtrSize, EndOffset)),
912 Builder.getIntN(PtrSize, PoisonSize)});
Stephen Hines176edba2014-12-01 14:53:08 -0800913 }
914}
915
John McCall9fc6a772010-02-19 09:25:03 +0000916/// EmitConstructorBody - Emits the body of the current constructor.
917void CodeGenFunction::EmitConstructorBody(FunctionArgList &Args) {
Stephen Hines176edba2014-12-01 14:53:08 -0800918 EmitAsanPrologueOrEpilogue(true);
John McCall9fc6a772010-02-19 09:25:03 +0000919 const CXXConstructorDecl *Ctor = cast<CXXConstructorDecl>(CurGD.getDecl());
920 CXXCtorType CtorType = CurGD.getCtorType();
921
Stephen Hines651f13c2014-04-23 16:59:28 -0700922 assert((CGM.getTarget().getCXXABI().hasConstructorVariants() ||
923 CtorType == Ctor_Complete) &&
924 "can only generate complete ctor for this ABI");
925
John McCallc0bf4622010-02-23 00:48:20 +0000926 // Before we go any further, try the complete->base constructor
927 // delegation optimization.
Timur Iskhodzhanov85607912012-04-20 08:05:00 +0000928 if (CtorType == Ctor_Complete && IsConstructorDelegationValid(Ctor) &&
John McCall64aa4b32013-04-16 22:48:15 +0000929 CGM.getTarget().getCXXABI().hasConstructorVariants()) {
Nick Lewycky4ee7dc22013-10-02 02:29:49 +0000930 EmitDelegateCXXConstructorCall(Ctor, Ctor_Base, Args, Ctor->getLocEnd());
John McCallc0bf4622010-02-23 00:48:20 +0000931 return;
932 }
933
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800934 const FunctionDecl *Definition = nullptr;
Stephen Hines176edba2014-12-01 14:53:08 -0800935 Stmt *Body = Ctor->getBody(Definition);
936 assert(Definition == Ctor && "emitting wrong constructor body");
John McCall9fc6a772010-02-19 09:25:03 +0000937
John McCallc0bf4622010-02-23 00:48:20 +0000938 // Enter the function-try-block before the constructor prologue if
939 // applicable.
John McCallc0bf4622010-02-23 00:48:20 +0000940 bool IsTryBody = (Body && isa<CXXTryStmt>(Body));
John McCallc0bf4622010-02-23 00:48:20 +0000941 if (IsTryBody)
John McCall59a70002010-07-07 06:56:46 +0000942 EnterCXXTryStmt(*cast<CXXTryStmt>(Body), true);
John McCall9fc6a772010-02-19 09:25:03 +0000943
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700944 incrementProfileCounter(Body);
Stephen Hines651f13c2014-04-23 16:59:28 -0700945
Richard Smith7c3e6152013-06-12 22:31:48 +0000946 RunCleanupsScope RunCleanups(*this);
John McCall9fc6a772010-02-19 09:25:03 +0000947
John McCall56ea3772012-03-30 04:25:03 +0000948 // TODO: in restricted cases, we can emit the vbase initializers of
949 // a complete ctor and then delegate to the base ctor.
950
John McCallc0bf4622010-02-23 00:48:20 +0000951 // Emit the constructor prologue, i.e. the base and member
952 // initializers.
Douglas Gregorfb8cc252010-05-05 05:51:00 +0000953 EmitCtorPrologue(Ctor, CtorType, Args);
John McCall9fc6a772010-02-19 09:25:03 +0000954
955 // Emit the body of the statement.
John McCallc0bf4622010-02-23 00:48:20 +0000956 if (IsTryBody)
John McCall9fc6a772010-02-19 09:25:03 +0000957 EmitStmt(cast<CXXTryStmt>(Body)->getTryBlock());
958 else if (Body)
959 EmitStmt(Body);
John McCall9fc6a772010-02-19 09:25:03 +0000960
961 // Emit any cleanup blocks associated with the member or base
962 // initializers, which includes (along the exceptional path) the
963 // destructors for those members and bases that were fully
964 // constructed.
Richard Smith7c3e6152013-06-12 22:31:48 +0000965 RunCleanups.ForceCleanup();
John McCall9fc6a772010-02-19 09:25:03 +0000966
John McCallc0bf4622010-02-23 00:48:20 +0000967 if (IsTryBody)
John McCall59a70002010-07-07 06:56:46 +0000968 ExitCXXTryStmt(*cast<CXXTryStmt>(Body), true);
John McCall9fc6a772010-02-19 09:25:03 +0000969}
970
Lang Hames56c00c42013-02-17 07:22:09 +0000971namespace {
Nick Lewycky62a3bba2013-09-11 02:03:20 +0000972 /// RAII object to indicate that codegen is copying the value representation
973 /// instead of the object representation. Useful when copying a struct or
974 /// class which has uninitialized members and we're only performing
975 /// lvalue-to-rvalue conversion on the object but not its members.
976 class CopyingValueRepresentation {
977 public:
978 explicit CopyingValueRepresentation(CodeGenFunction &CGF)
Stephen Hines176edba2014-12-01 14:53:08 -0800979 : CGF(CGF), OldSanOpts(CGF.SanOpts) {
980 CGF.SanOpts.set(SanitizerKind::Bool, false);
981 CGF.SanOpts.set(SanitizerKind::Enum, false);
Nick Lewycky62a3bba2013-09-11 02:03:20 +0000982 }
983 ~CopyingValueRepresentation() {
984 CGF.SanOpts = OldSanOpts;
985 }
986 private:
987 CodeGenFunction &CGF;
Stephen Hines176edba2014-12-01 14:53:08 -0800988 SanitizerSet OldSanOpts;
Nick Lewycky62a3bba2013-09-11 02:03:20 +0000989 };
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700990} // end anonymous namespace
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800991
Nick Lewycky62a3bba2013-09-11 02:03:20 +0000992namespace {
Lang Hames56c00c42013-02-17 07:22:09 +0000993 class FieldMemcpyizer {
994 public:
995 FieldMemcpyizer(CodeGenFunction &CGF, const CXXRecordDecl *ClassDecl,
996 const VarDecl *SrcRec)
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700997 : CGF(CGF), ClassDecl(ClassDecl), SrcRec(SrcRec),
Lang Hames56c00c42013-02-17 07:22:09 +0000998 RecLayout(CGF.getContext().getASTRecordLayout(ClassDecl)),
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700999 FirstField(nullptr), LastField(nullptr), FirstFieldOffset(0),
1000 LastFieldOffset(0), LastAddedFieldIndex(0) {}
Lang Hames56c00c42013-02-17 07:22:09 +00001001
Stephen Hines176edba2014-12-01 14:53:08 -08001002 bool isMemcpyableField(FieldDecl *F) const {
1003 // Never memcpy fields when we are adding poisoned paddings.
1004 if (CGF.getContext().getLangOpts().SanitizeAddressFieldPadding)
1005 return false;
Lang Hames56c00c42013-02-17 07:22:09 +00001006 Qualifiers Qual = F->getType().getQualifiers();
1007 if (Qual.hasVolatile() || Qual.hasObjCLifetime())
1008 return false;
1009 return true;
1010 }
1011
1012 void addMemcpyableField(FieldDecl *F) {
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001013 if (!FirstField)
Lang Hames56c00c42013-02-17 07:22:09 +00001014 addInitialField(F);
1015 else
1016 addNextField(F);
1017 }
1018
Stephen Hines176edba2014-12-01 14:53:08 -08001019 CharUnits getMemcpySize(uint64_t FirstByteOffset) const {
Lang Hames56c00c42013-02-17 07:22:09 +00001020 unsigned LastFieldSize =
1021 LastField->isBitField() ?
1022 LastField->getBitWidthValue(CGF.getContext()) :
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001023 CGF.getContext().getTypeSize(LastField->getType());
Lang Hames56c00c42013-02-17 07:22:09 +00001024 uint64_t MemcpySizeBits =
Stephen Hines176edba2014-12-01 14:53:08 -08001025 LastFieldOffset + LastFieldSize - FirstByteOffset +
Lang Hames56c00c42013-02-17 07:22:09 +00001026 CGF.getContext().getCharWidth() - 1;
1027 CharUnits MemcpySize =
1028 CGF.getContext().toCharUnitsFromBits(MemcpySizeBits);
1029 return MemcpySize;
1030 }
1031
1032 void emitMemcpy() {
1033 // Give the subclass a chance to bail out if it feels the memcpy isn't
1034 // worth it (e.g. Hasn't aggregated enough data).
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001035 if (!FirstField) {
Lang Hames56c00c42013-02-17 07:22:09 +00001036 return;
1037 }
1038
Stephen Hines176edba2014-12-01 14:53:08 -08001039 uint64_t FirstByteOffset;
Lang Hames56c00c42013-02-17 07:22:09 +00001040 if (FirstField->isBitField()) {
1041 const CGRecordLayout &RL =
1042 CGF.getTypes().getCGRecordLayout(FirstField->getParent());
1043 const CGBitFieldInfo &BFInfo = RL.getBitFieldInfo(FirstField);
Stephen Hines176edba2014-12-01 14:53:08 -08001044 // FirstFieldOffset is not appropriate for bitfields,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001045 // we need to use the storage offset instead.
1046 FirstByteOffset = CGF.getContext().toBits(BFInfo.StorageOffset);
Lang Hames5e8577e2013-02-27 04:14:49 +00001047 } else {
Stephen Hines176edba2014-12-01 14:53:08 -08001048 FirstByteOffset = FirstFieldOffset;
Lang Hames5e8577e2013-02-27 04:14:49 +00001049 }
Lang Hames56c00c42013-02-17 07:22:09 +00001050
Stephen Hines176edba2014-12-01 14:53:08 -08001051 CharUnits MemcpySize = getMemcpySize(FirstByteOffset);
Lang Hames56c00c42013-02-17 07:22:09 +00001052 QualType RecordTy = CGF.getContext().getTypeDeclType(ClassDecl);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001053 Address ThisPtr = CGF.LoadCXXThisAddress();
1054 LValue DestLV = CGF.MakeAddrLValue(ThisPtr, RecordTy);
Lang Hames56c00c42013-02-17 07:22:09 +00001055 LValue Dest = CGF.EmitLValueForFieldInitialization(DestLV, FirstField);
1056 llvm::Value *SrcPtr = CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(SrcRec));
1057 LValue SrcLV = CGF.MakeNaturalAlignAddrLValue(SrcPtr, RecordTy);
1058 LValue Src = CGF.EmitLValueForFieldInitialization(SrcLV, FirstField);
1059
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001060 emitMemcpyIR(Dest.isBitField() ? Dest.getBitFieldAddress() : Dest.getAddress(),
1061 Src.isBitField() ? Src.getBitFieldAddress() : Src.getAddress(),
1062 MemcpySize);
Lang Hames56c00c42013-02-17 07:22:09 +00001063 reset();
1064 }
1065
1066 void reset() {
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001067 FirstField = nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001068 }
1069
1070 protected:
1071 CodeGenFunction &CGF;
1072 const CXXRecordDecl *ClassDecl;
1073
1074 private:
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001075 void emitMemcpyIR(Address DestPtr, Address SrcPtr, CharUnits Size) {
1076 llvm::PointerType *DPT = DestPtr.getType();
Lang Hames56c00c42013-02-17 07:22:09 +00001077 llvm::Type *DBP =
1078 llvm::Type::getInt8PtrTy(CGF.getLLVMContext(), DPT->getAddressSpace());
1079 DestPtr = CGF.Builder.CreateBitCast(DestPtr, DBP);
1080
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001081 llvm::PointerType *SPT = SrcPtr.getType();
Lang Hames56c00c42013-02-17 07:22:09 +00001082 llvm::Type *SBP =
1083 llvm::Type::getInt8PtrTy(CGF.getLLVMContext(), SPT->getAddressSpace());
1084 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, SBP);
1085
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001086 CGF.Builder.CreateMemCpy(DestPtr, SrcPtr, Size.getQuantity());
Lang Hames56c00c42013-02-17 07:22:09 +00001087 }
1088
1089 void addInitialField(FieldDecl *F) {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001090 FirstField = F;
1091 LastField = F;
1092 FirstFieldOffset = RecLayout.getFieldOffset(F->getFieldIndex());
1093 LastFieldOffset = FirstFieldOffset;
1094 LastAddedFieldIndex = F->getFieldIndex();
1095 }
Lang Hames56c00c42013-02-17 07:22:09 +00001096
1097 void addNextField(FieldDecl *F) {
John McCall402cd222013-05-07 05:20:46 +00001098 // For the most part, the following invariant will hold:
1099 // F->getFieldIndex() == LastAddedFieldIndex + 1
1100 // The one exception is that Sema won't add a copy-initializer for an
1101 // unnamed bitfield, which will show up here as a gap in the sequence.
1102 assert(F->getFieldIndex() >= LastAddedFieldIndex + 1 &&
1103 "Cannot aggregate fields out of order.");
Lang Hames56c00c42013-02-17 07:22:09 +00001104 LastAddedFieldIndex = F->getFieldIndex();
1105
1106 // The 'first' and 'last' fields are chosen by offset, rather than field
1107 // index. This allows the code to support bitfields, as well as regular
1108 // fields.
1109 uint64_t FOffset = RecLayout.getFieldOffset(F->getFieldIndex());
1110 if (FOffset < FirstFieldOffset) {
1111 FirstField = F;
1112 FirstFieldOffset = FOffset;
1113 } else if (FOffset > LastFieldOffset) {
1114 LastField = F;
1115 LastFieldOffset = FOffset;
1116 }
1117 }
1118
1119 const VarDecl *SrcRec;
1120 const ASTRecordLayout &RecLayout;
1121 FieldDecl *FirstField;
1122 FieldDecl *LastField;
1123 uint64_t FirstFieldOffset, LastFieldOffset;
1124 unsigned LastAddedFieldIndex;
1125 };
1126
1127 class ConstructorMemcpyizer : public FieldMemcpyizer {
1128 private:
Lang Hames56c00c42013-02-17 07:22:09 +00001129 /// Get source argument for copy constructor. Returns null if not a copy
Stephen Hines176edba2014-12-01 14:53:08 -08001130 /// constructor.
1131 static const VarDecl *getTrivialCopySource(CodeGenFunction &CGF,
1132 const CXXConstructorDecl *CD,
Lang Hames56c00c42013-02-17 07:22:09 +00001133 FunctionArgList &Args) {
Jordan Rosea7b87972013-08-07 16:16:48 +00001134 if (CD->isCopyOrMoveConstructor() && CD->isDefaulted())
Stephen Hines176edba2014-12-01 14:53:08 -08001135 return Args[CGF.CGM.getCXXABI().getSrcArgforCopyCtor(CD, Args)];
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001136 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001137 }
1138
1139 // Returns true if a CXXCtorInitializer represents a member initialization
1140 // that can be rolled into a memcpy.
1141 bool isMemberInitMemcpyable(CXXCtorInitializer *MemberInit) const {
1142 if (!MemcpyableCtor)
1143 return false;
1144 FieldDecl *Field = MemberInit->getMember();
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001145 assert(Field && "No field for member init.");
Lang Hames56c00c42013-02-17 07:22:09 +00001146 QualType FieldType = Field->getType();
1147 CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(MemberInit->getInit());
1148
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001149 // Bail out on non-memcpyable, not-trivially-copyable members.
1150 if (!(CE && isMemcpyEquivalentSpecialMember(CE->getConstructor())) &&
Lang Hames56c00c42013-02-17 07:22:09 +00001151 !(FieldType.isTriviallyCopyableType(CGF.getContext()) ||
1152 FieldType->isReferenceType()))
1153 return false;
1154
1155 // Bail out on volatile fields.
1156 if (!isMemcpyableField(Field))
1157 return false;
1158
1159 // Otherwise we're good.
1160 return true;
1161 }
1162
1163 public:
1164 ConstructorMemcpyizer(CodeGenFunction &CGF, const CXXConstructorDecl *CD,
1165 FunctionArgList &Args)
Stephen Hines176edba2014-12-01 14:53:08 -08001166 : FieldMemcpyizer(CGF, CD->getParent(), getTrivialCopySource(CGF, CD, Args)),
Lang Hames56c00c42013-02-17 07:22:09 +00001167 ConstructorDecl(CD),
Jordan Rosea7b87972013-08-07 16:16:48 +00001168 MemcpyableCtor(CD->isDefaulted() &&
Lang Hames56c00c42013-02-17 07:22:09 +00001169 CD->isCopyOrMoveConstructor() &&
1170 CGF.getLangOpts().getGC() == LangOptions::NonGC),
1171 Args(Args) { }
1172
1173 void addMemberInitializer(CXXCtorInitializer *MemberInit) {
1174 if (isMemberInitMemcpyable(MemberInit)) {
1175 AggregatedInits.push_back(MemberInit);
1176 addMemcpyableField(MemberInit->getMember());
1177 } else {
1178 emitAggregatedInits();
1179 EmitMemberInitializer(CGF, ConstructorDecl->getParent(), MemberInit,
1180 ConstructorDecl, Args);
1181 }
1182 }
1183
1184 void emitAggregatedInits() {
1185 if (AggregatedInits.size() <= 1) {
1186 // This memcpy is too small to be worthwhile. Fall back on default
1187 // codegen.
Nick Lewycky62a3bba2013-09-11 02:03:20 +00001188 if (!AggregatedInits.empty()) {
1189 CopyingValueRepresentation CVR(CGF);
Lang Hames56c00c42013-02-17 07:22:09 +00001190 EmitMemberInitializer(CGF, ConstructorDecl->getParent(),
Nick Lewycky62a3bba2013-09-11 02:03:20 +00001191 AggregatedInits[0], ConstructorDecl, Args);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001192 AggregatedInits.clear();
Lang Hames56c00c42013-02-17 07:22:09 +00001193 }
1194 reset();
1195 return;
1196 }
1197
1198 pushEHDestructors();
1199 emitMemcpy();
1200 AggregatedInits.clear();
1201 }
1202
1203 void pushEHDestructors() {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001204 Address ThisPtr = CGF.LoadCXXThisAddress();
Lang Hames56c00c42013-02-17 07:22:09 +00001205 QualType RecordTy = CGF.getContext().getTypeDeclType(ClassDecl);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001206 LValue LHS = CGF.MakeAddrLValue(ThisPtr, RecordTy);
Lang Hames56c00c42013-02-17 07:22:09 +00001207
1208 for (unsigned i = 0; i < AggregatedInits.size(); ++i) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001209 CXXCtorInitializer *MemberInit = AggregatedInits[i];
1210 QualType FieldType = MemberInit->getAnyMember()->getType();
Lang Hames56c00c42013-02-17 07:22:09 +00001211 QualType::DestructionKind dtorKind = FieldType.isDestructedType();
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001212 if (!CGF.needsEHCleanup(dtorKind))
1213 continue;
1214 LValue FieldLHS = LHS;
1215 EmitLValueForAnyFieldInitialization(CGF, MemberInit, FieldLHS);
1216 CGF.pushEHDestroy(dtorKind, FieldLHS.getAddress(), FieldType);
Lang Hames56c00c42013-02-17 07:22:09 +00001217 }
1218 }
1219
1220 void finish() {
1221 emitAggregatedInits();
1222 }
1223
1224 private:
1225 const CXXConstructorDecl *ConstructorDecl;
1226 bool MemcpyableCtor;
1227 FunctionArgList &Args;
1228 SmallVector<CXXCtorInitializer*, 16> AggregatedInits;
1229 };
1230
1231 class AssignmentMemcpyizer : public FieldMemcpyizer {
1232 private:
Lang Hames56c00c42013-02-17 07:22:09 +00001233 // Returns the memcpyable field copied by the given statement, if one
Nick Lewycky62a3bba2013-09-11 02:03:20 +00001234 // exists. Otherwise returns null.
1235 FieldDecl *getMemcpyableField(Stmt *S) {
Lang Hames56c00c42013-02-17 07:22:09 +00001236 if (!AssignmentsMemcpyable)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001237 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001238 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(S)) {
1239 // Recognise trivial assignments.
1240 if (BO->getOpcode() != BO_Assign)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001241 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001242 MemberExpr *ME = dyn_cast<MemberExpr>(BO->getLHS());
1243 if (!ME)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001244 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001245 FieldDecl *Field = dyn_cast<FieldDecl>(ME->getMemberDecl());
1246 if (!Field || !isMemcpyableField(Field))
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001247 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001248 Stmt *RHS = BO->getRHS();
1249 if (ImplicitCastExpr *EC = dyn_cast<ImplicitCastExpr>(RHS))
1250 RHS = EC->getSubExpr();
1251 if (!RHS)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001252 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001253 MemberExpr *ME2 = dyn_cast<MemberExpr>(RHS);
1254 if (dyn_cast<FieldDecl>(ME2->getMemberDecl()) != Field)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001255 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001256 return Field;
1257 } else if (CXXMemberCallExpr *MCE = dyn_cast<CXXMemberCallExpr>(S)) {
1258 CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MCE->getCalleeDecl());
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001259 if (!(MD && isMemcpyEquivalentSpecialMember(MD)))
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001260 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001261 MemberExpr *IOA = dyn_cast<MemberExpr>(MCE->getImplicitObjectArgument());
1262 if (!IOA)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001263 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001264 FieldDecl *Field = dyn_cast<FieldDecl>(IOA->getMemberDecl());
1265 if (!Field || !isMemcpyableField(Field))
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001266 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001267 MemberExpr *Arg0 = dyn_cast<MemberExpr>(MCE->getArg(0));
1268 if (!Arg0 || Field != dyn_cast<FieldDecl>(Arg0->getMemberDecl()))
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001269 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001270 return Field;
1271 } else if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
1272 FunctionDecl *FD = dyn_cast<FunctionDecl>(CE->getCalleeDecl());
1273 if (!FD || FD->getBuiltinID() != Builtin::BI__builtin_memcpy)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001274 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001275 Expr *DstPtr = CE->getArg(0);
1276 if (ImplicitCastExpr *DC = dyn_cast<ImplicitCastExpr>(DstPtr))
1277 DstPtr = DC->getSubExpr();
1278 UnaryOperator *DUO = dyn_cast<UnaryOperator>(DstPtr);
1279 if (!DUO || DUO->getOpcode() != UO_AddrOf)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001280 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001281 MemberExpr *ME = dyn_cast<MemberExpr>(DUO->getSubExpr());
1282 if (!ME)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001283 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001284 FieldDecl *Field = dyn_cast<FieldDecl>(ME->getMemberDecl());
1285 if (!Field || !isMemcpyableField(Field))
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001286 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001287 Expr *SrcPtr = CE->getArg(1);
1288 if (ImplicitCastExpr *SC = dyn_cast<ImplicitCastExpr>(SrcPtr))
1289 SrcPtr = SC->getSubExpr();
1290 UnaryOperator *SUO = dyn_cast<UnaryOperator>(SrcPtr);
1291 if (!SUO || SUO->getOpcode() != UO_AddrOf)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001292 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001293 MemberExpr *ME2 = dyn_cast<MemberExpr>(SUO->getSubExpr());
1294 if (!ME2 || Field != dyn_cast<FieldDecl>(ME2->getMemberDecl()))
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001295 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001296 return Field;
1297 }
1298
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001299 return nullptr;
Lang Hames56c00c42013-02-17 07:22:09 +00001300 }
1301
1302 bool AssignmentsMemcpyable;
1303 SmallVector<Stmt*, 16> AggregatedStmts;
1304
1305 public:
Lang Hames56c00c42013-02-17 07:22:09 +00001306 AssignmentMemcpyizer(CodeGenFunction &CGF, const CXXMethodDecl *AD,
1307 FunctionArgList &Args)
1308 : FieldMemcpyizer(CGF, AD->getParent(), Args[Args.size() - 1]),
1309 AssignmentsMemcpyable(CGF.getLangOpts().getGC() == LangOptions::NonGC) {
1310 assert(Args.size() == 2);
1311 }
1312
1313 void emitAssignment(Stmt *S) {
1314 FieldDecl *F = getMemcpyableField(S);
1315 if (F) {
1316 addMemcpyableField(F);
1317 AggregatedStmts.push_back(S);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001318 } else {
Lang Hames56c00c42013-02-17 07:22:09 +00001319 emitAggregatedStmts();
1320 CGF.EmitStmt(S);
1321 }
1322 }
1323
1324 void emitAggregatedStmts() {
1325 if (AggregatedStmts.size() <= 1) {
Nick Lewycky62a3bba2013-09-11 02:03:20 +00001326 if (!AggregatedStmts.empty()) {
1327 CopyingValueRepresentation CVR(CGF);
1328 CGF.EmitStmt(AggregatedStmts[0]);
1329 }
Lang Hames56c00c42013-02-17 07:22:09 +00001330 reset();
1331 }
1332
1333 emitMemcpy();
1334 AggregatedStmts.clear();
1335 }
1336
1337 void finish() {
1338 emitAggregatedStmts();
1339 }
1340 };
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001341} // end anonymous namespace
Lang Hames56c00c42013-02-17 07:22:09 +00001342
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001343static bool isInitializerOfDynamicClass(const CXXCtorInitializer *BaseInit) {
1344 const Type *BaseType = BaseInit->getBaseClass();
1345 const auto *BaseClassDecl =
1346 cast<CXXRecordDecl>(BaseType->getAs<RecordType>()->getDecl());
1347 return BaseClassDecl->isDynamicClass();
Lang Hames56c00c42013-02-17 07:22:09 +00001348}
1349
Anders Carlsson607d0372009-12-24 22:46:43 +00001350/// EmitCtorPrologue - This routine generates necessary code to initialize
1351/// base classes and non-static data members belonging to this constructor.
Anders Carlsson607d0372009-12-24 22:46:43 +00001352void CodeGenFunction::EmitCtorPrologue(const CXXConstructorDecl *CD,
Douglas Gregorfb8cc252010-05-05 05:51:00 +00001353 CXXCtorType CtorType,
1354 FunctionArgList &Args) {
Sean Hunt059ce0d2011-05-01 07:04:31 +00001355 if (CD->isDelegatingConstructor())
1356 return EmitDelegatingCXXConstructorCall(CD, Args);
1357
Anders Carlsson607d0372009-12-24 22:46:43 +00001358 const CXXRecordDecl *ClassDecl = CD->getParent();
Anders Carlssona78fa2c2010-02-02 19:58:43 +00001359
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +00001360 CXXConstructorDecl::init_const_iterator B = CD->init_begin(),
1361 E = CD->init_end();
1362
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001363 llvm::BasicBlock *BaseCtorContinueBB = nullptr;
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +00001364 if (ClassDecl->getNumVBases() &&
1365 !CGM.getTarget().getCXXABI().hasConstructorVariants()) {
1366 // The ABIs that don't have constructor variants need to put a branch
1367 // before the virtual base initialization code.
Reid Kleckner90633022013-06-19 15:20:38 +00001368 BaseCtorContinueBB =
1369 CGM.getCXXABI().EmitCtorCompleteObjectHandler(*this, ClassDecl);
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +00001370 assert(BaseCtorContinueBB);
1371 }
1372
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001373 llvm::Value *const OldThis = CXXThisValue;
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +00001374 // Virtual base initializers first.
1375 for (; B != E && (*B)->isBaseInitializer() && (*B)->isBaseVirtual(); B++) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001376 if (CGM.getCodeGenOpts().StrictVTablePointers &&
1377 CGM.getCodeGenOpts().OptimizationLevel > 0 &&
1378 isInitializerOfDynamicClass(*B))
1379 CXXThisValue = Builder.CreateInvariantGroupBarrier(LoadCXXThis());
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +00001380 EmitBaseInitializer(*this, ClassDecl, *B, CtorType);
1381 }
1382
1383 if (BaseCtorContinueBB) {
1384 // Complete object handler should continue to the remaining initializers.
1385 Builder.CreateBr(BaseCtorContinueBB);
1386 EmitBlock(BaseCtorContinueBB);
1387 }
1388
1389 // Then, non-virtual base initializers.
1390 for (; B != E && (*B)->isBaseInitializer(); B++) {
1391 assert(!(*B)->isBaseVirtual());
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001392
1393 if (CGM.getCodeGenOpts().StrictVTablePointers &&
1394 CGM.getCodeGenOpts().OptimizationLevel > 0 &&
1395 isInitializerOfDynamicClass(*B))
1396 CXXThisValue = Builder.CreateInvariantGroupBarrier(LoadCXXThis());
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +00001397 EmitBaseInitializer(*this, ClassDecl, *B, CtorType);
Anders Carlsson607d0372009-12-24 22:46:43 +00001398 }
1399
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001400 CXXThisValue = OldThis;
1401
Anders Carlsson603d6d12010-03-28 21:07:49 +00001402 InitializeVTablePointers(ClassDecl);
Anders Carlssona78fa2c2010-02-02 19:58:43 +00001403
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +00001404 // And finally, initialize class members.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001405 FieldConstructionScope FCS(*this, LoadCXXThisAddress());
Lang Hames56c00c42013-02-17 07:22:09 +00001406 ConstructorMemcpyizer CM(*this, CD, Args);
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +00001407 for (; B != E; B++) {
1408 CXXCtorInitializer *Member = (*B);
1409 assert(!Member->isBaseInitializer());
1410 assert(Member->isAnyMemberInitializer() &&
1411 "Delegating initializer on non-delegating constructor");
1412 CM.addMemberInitializer(Member);
1413 }
Lang Hames56c00c42013-02-17 07:22:09 +00001414 CM.finish();
Anders Carlsson607d0372009-12-24 22:46:43 +00001415}
1416
Anders Carlssonadf5dc32011-05-15 17:36:21 +00001417static bool
1418FieldHasTrivialDestructorBody(ASTContext &Context, const FieldDecl *Field);
1419
1420static bool
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001421HasTrivialDestructorBody(ASTContext &Context,
Anders Carlssonadf5dc32011-05-15 17:36:21 +00001422 const CXXRecordDecl *BaseClassDecl,
1423 const CXXRecordDecl *MostDerivedClassDecl)
1424{
1425 // If the destructor is trivial we don't have to check anything else.
1426 if (BaseClassDecl->hasTrivialDestructor())
1427 return true;
1428
1429 if (!BaseClassDecl->getDestructor()->hasTrivialBody())
1430 return false;
1431
1432 // Check fields.
Stephen Hines651f13c2014-04-23 16:59:28 -07001433 for (const auto *Field : BaseClassDecl->fields())
Anders Carlssonadf5dc32011-05-15 17:36:21 +00001434 if (!FieldHasTrivialDestructorBody(Context, Field))
1435 return false;
Anders Carlssonadf5dc32011-05-15 17:36:21 +00001436
1437 // Check non-virtual bases.
Stephen Hines651f13c2014-04-23 16:59:28 -07001438 for (const auto &I : BaseClassDecl->bases()) {
1439 if (I.isVirtual())
Anders Carlssonadf5dc32011-05-15 17:36:21 +00001440 continue;
1441
1442 const CXXRecordDecl *NonVirtualBase =
Stephen Hines651f13c2014-04-23 16:59:28 -07001443 cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
Anders Carlssonadf5dc32011-05-15 17:36:21 +00001444 if (!HasTrivialDestructorBody(Context, NonVirtualBase,
1445 MostDerivedClassDecl))
1446 return false;
1447 }
1448
1449 if (BaseClassDecl == MostDerivedClassDecl) {
1450 // Check virtual bases.
Stephen Hines651f13c2014-04-23 16:59:28 -07001451 for (const auto &I : BaseClassDecl->vbases()) {
Anders Carlssonadf5dc32011-05-15 17:36:21 +00001452 const CXXRecordDecl *VirtualBase =
Stephen Hines651f13c2014-04-23 16:59:28 -07001453 cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
Anders Carlssonadf5dc32011-05-15 17:36:21 +00001454 if (!HasTrivialDestructorBody(Context, VirtualBase,
1455 MostDerivedClassDecl))
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001456 return false;
Anders Carlssonadf5dc32011-05-15 17:36:21 +00001457 }
1458 }
1459
1460 return true;
1461}
1462
1463static bool
1464FieldHasTrivialDestructorBody(ASTContext &Context,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001465 const FieldDecl *Field)
Anders Carlssonadf5dc32011-05-15 17:36:21 +00001466{
1467 QualType FieldBaseElementType = Context.getBaseElementType(Field->getType());
1468
1469 const RecordType *RT = FieldBaseElementType->getAs<RecordType>();
1470 if (!RT)
1471 return true;
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001472
Anders Carlssonadf5dc32011-05-15 17:36:21 +00001473 CXXRecordDecl *FieldClassDecl = cast<CXXRecordDecl>(RT->getDecl());
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001474
1475 // The destructor for an implicit anonymous union member is never invoked.
1476 if (FieldClassDecl->isUnion() && FieldClassDecl->isAnonymousStructOrUnion())
1477 return false;
1478
Anders Carlssonadf5dc32011-05-15 17:36:21 +00001479 return HasTrivialDestructorBody(Context, FieldClassDecl, FieldClassDecl);
1480}
1481
Anders Carlssonffb945f2011-05-14 23:26:09 +00001482/// CanSkipVTablePointerInitialization - Check whether we need to initialize
1483/// any vtable pointers before calling this destructor.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001484static bool CanSkipVTablePointerInitialization(CodeGenFunction &CGF,
Anders Carlssone3d6cf22011-05-16 04:08:36 +00001485 const CXXDestructorDecl *Dtor) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001486 const CXXRecordDecl *ClassDecl = Dtor->getParent();
1487 if (!ClassDecl->isDynamicClass())
1488 return true;
1489
Anders Carlssonffb945f2011-05-14 23:26:09 +00001490 if (!Dtor->hasTrivialBody())
1491 return false;
1492
1493 // Check the fields.
Stephen Hines651f13c2014-04-23 16:59:28 -07001494 for (const auto *Field : ClassDecl->fields())
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001495 if (!FieldHasTrivialDestructorBody(CGF.getContext(), Field))
Anders Carlssonadf5dc32011-05-15 17:36:21 +00001496 return false;
Anders Carlssonffb945f2011-05-14 23:26:09 +00001497
1498 return true;
1499}
1500
John McCall9fc6a772010-02-19 09:25:03 +00001501/// EmitDestructorBody - Emits the body of the current destructor.
1502void CodeGenFunction::EmitDestructorBody(FunctionArgList &Args) {
1503 const CXXDestructorDecl *Dtor = cast<CXXDestructorDecl>(CurGD.getDecl());
1504 CXXDtorType DtorType = CurGD.getDtorType();
1505
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001506 Stmt *Body = Dtor->getBody();
1507 if (Body)
1508 incrementProfileCounter(Body);
1509
John McCall50da2ca2010-07-21 05:30:47 +00001510 // The call to operator delete in a deleting destructor happens
1511 // outside of the function-try-block, which means it's always
1512 // possible to delegate the destructor body to the complete
1513 // destructor. Do so.
1514 if (DtorType == Dtor_Deleting) {
1515 EnterDtorCleanups(Dtor, Dtor_Deleting);
1516 EmitCXXDestructorCall(Dtor, Dtor_Complete, /*ForVirtualBase=*/false,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001517 /*Delegating=*/false, LoadCXXThisAddress());
John McCall50da2ca2010-07-21 05:30:47 +00001518 PopCleanupBlock();
1519 return;
1520 }
1521
John McCall9fc6a772010-02-19 09:25:03 +00001522 // If the body is a function-try-block, enter the try before
John McCall50da2ca2010-07-21 05:30:47 +00001523 // anything else.
1524 bool isTryBody = (Body && isa<CXXTryStmt>(Body));
John McCall9fc6a772010-02-19 09:25:03 +00001525 if (isTryBody)
John McCall59a70002010-07-07 06:56:46 +00001526 EnterCXXTryStmt(*cast<CXXTryStmt>(Body), true);
Stephen Hines176edba2014-12-01 14:53:08 -08001527 EmitAsanPrologueOrEpilogue(false);
John McCall9fc6a772010-02-19 09:25:03 +00001528
John McCall50da2ca2010-07-21 05:30:47 +00001529 // Enter the epilogue cleanups.
1530 RunCleanupsScope DtorEpilogue(*this);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001531
John McCall9fc6a772010-02-19 09:25:03 +00001532 // If this is the complete variant, just invoke the base variant;
1533 // the epilogue will destruct the virtual bases. But we can't do
1534 // this optimization if the body is a function-try-block, because
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001535 // we'd introduce *two* handler blocks. In the Microsoft ABI, we
Reid Klecknera4130ba2013-07-22 13:51:44 +00001536 // always delegate because we might not have a definition in this TU.
John McCall50da2ca2010-07-21 05:30:47 +00001537 switch (DtorType) {
Stephen Hines176edba2014-12-01 14:53:08 -08001538 case Dtor_Comdat:
1539 llvm_unreachable("not expecting a COMDAT");
1540
John McCall50da2ca2010-07-21 05:30:47 +00001541 case Dtor_Deleting: llvm_unreachable("already handled deleting case");
1542
1543 case Dtor_Complete:
Reid Klecknera4130ba2013-07-22 13:51:44 +00001544 assert((Body || getTarget().getCXXABI().isMicrosoft()) &&
1545 "can't emit a dtor without a body for non-Microsoft ABIs");
1546
John McCall50da2ca2010-07-21 05:30:47 +00001547 // Enter the cleanup scopes for virtual bases.
1548 EnterDtorCleanups(Dtor, Dtor_Complete);
1549
Reid Klecknera4130ba2013-07-22 13:51:44 +00001550 if (!isTryBody) {
John McCall50da2ca2010-07-21 05:30:47 +00001551 EmitCXXDestructorCall(Dtor, Dtor_Base, /*ForVirtualBase=*/false,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001552 /*Delegating=*/false, LoadCXXThisAddress());
John McCall50da2ca2010-07-21 05:30:47 +00001553 break;
1554 }
1555 // Fallthrough: act like we're in the base variant.
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001556
John McCall50da2ca2010-07-21 05:30:47 +00001557 case Dtor_Base:
Reid Klecknera4130ba2013-07-22 13:51:44 +00001558 assert(Body);
1559
John McCall50da2ca2010-07-21 05:30:47 +00001560 // Enter the cleanup scopes for fields and non-virtual bases.
1561 EnterDtorCleanups(Dtor, Dtor_Base);
1562
1563 // Initialize the vtable pointers before entering the body.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001564 if (!CanSkipVTablePointerInitialization(*this, Dtor)) {
1565 // Insert the llvm.invariant.group.barrier intrinsic before initializing
1566 // the vptrs to cancel any previous assumptions we might have made.
1567 if (CGM.getCodeGenOpts().StrictVTablePointers &&
1568 CGM.getCodeGenOpts().OptimizationLevel > 0)
1569 CXXThisValue = Builder.CreateInvariantGroupBarrier(LoadCXXThis());
1570 InitializeVTablePointers(Dtor->getParent());
1571 }
John McCall50da2ca2010-07-21 05:30:47 +00001572
1573 if (isTryBody)
1574 EmitStmt(cast<CXXTryStmt>(Body)->getTryBlock());
1575 else if (Body)
1576 EmitStmt(Body);
1577 else {
1578 assert(Dtor->isImplicit() && "bodyless dtor not implicit");
1579 // nothing to do besides what's in the epilogue
1580 }
Fariborz Jahanian5abec142011-02-02 23:12:46 +00001581 // -fapple-kext must inline any call to this dtor into
1582 // the caller's body.
Richard Smith7edf9e32012-11-01 22:30:59 +00001583 if (getLangOpts().AppleKext)
Bill Wendling72390b32012-12-20 19:27:06 +00001584 CurFn->addFnAttr(llvm::Attribute::AlwaysInline);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001585
John McCall50da2ca2010-07-21 05:30:47 +00001586 break;
John McCall9fc6a772010-02-19 09:25:03 +00001587 }
1588
John McCall50da2ca2010-07-21 05:30:47 +00001589 // Jump out through the epilogue cleanups.
1590 DtorEpilogue.ForceCleanup();
John McCall9fc6a772010-02-19 09:25:03 +00001591
1592 // Exit the try if applicable.
1593 if (isTryBody)
John McCall59a70002010-07-07 06:56:46 +00001594 ExitCXXTryStmt(*cast<CXXTryStmt>(Body), true);
John McCall9fc6a772010-02-19 09:25:03 +00001595}
1596
Lang Hames56c00c42013-02-17 07:22:09 +00001597void CodeGenFunction::emitImplicitAssignmentOperatorBody(FunctionArgList &Args) {
1598 const CXXMethodDecl *AssignOp = cast<CXXMethodDecl>(CurGD.getDecl());
1599 const Stmt *RootS = AssignOp->getBody();
1600 assert(isa<CompoundStmt>(RootS) &&
1601 "Body of an implicit assignment operator should be compound stmt.");
1602 const CompoundStmt *RootCS = cast<CompoundStmt>(RootS);
1603
1604 LexicalScope Scope(*this, RootCS->getSourceRange());
1605
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001606 incrementProfileCounter(RootCS);
Lang Hames56c00c42013-02-17 07:22:09 +00001607 AssignmentMemcpyizer AM(*this, AssignOp, Args);
Stephen Hines651f13c2014-04-23 16:59:28 -07001608 for (auto *I : RootCS->body())
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001609 AM.emitAssignment(I);
Lang Hames56c00c42013-02-17 07:22:09 +00001610 AM.finish();
1611}
1612
John McCall50da2ca2010-07-21 05:30:47 +00001613namespace {
1614 /// Call the operator delete associated with the current destructor.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001615 struct CallDtorDelete final : EHScopeStack::Cleanup {
John McCall50da2ca2010-07-21 05:30:47 +00001616 CallDtorDelete() {}
1617
Stephen Hines651f13c2014-04-23 16:59:28 -07001618 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall50da2ca2010-07-21 05:30:47 +00001619 const CXXDestructorDecl *Dtor = cast<CXXDestructorDecl>(CGF.CurCodeDecl);
1620 const CXXRecordDecl *ClassDecl = Dtor->getParent();
1621 CGF.EmitDeleteCall(Dtor->getOperatorDelete(), CGF.LoadCXXThis(),
1622 CGF.getContext().getTagDeclType(ClassDecl));
1623 }
1624 };
1625
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001626 struct CallDtorDeleteConditional final : EHScopeStack::Cleanup {
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00001627 llvm::Value *ShouldDeleteCondition;
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001628
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00001629 public:
1630 CallDtorDeleteConditional(llvm::Value *ShouldDeleteCondition)
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001631 : ShouldDeleteCondition(ShouldDeleteCondition) {
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001632 assert(ShouldDeleteCondition != nullptr);
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00001633 }
1634
Stephen Hines651f13c2014-04-23 16:59:28 -07001635 void Emit(CodeGenFunction &CGF, Flags flags) override {
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00001636 llvm::BasicBlock *callDeleteBB = CGF.createBasicBlock("dtor.call_delete");
1637 llvm::BasicBlock *continueBB = CGF.createBasicBlock("dtor.continue");
1638 llvm::Value *ShouldCallDelete
1639 = CGF.Builder.CreateIsNull(ShouldDeleteCondition);
1640 CGF.Builder.CreateCondBr(ShouldCallDelete, continueBB, callDeleteBB);
1641
1642 CGF.EmitBlock(callDeleteBB);
1643 const CXXDestructorDecl *Dtor = cast<CXXDestructorDecl>(CGF.CurCodeDecl);
1644 const CXXRecordDecl *ClassDecl = Dtor->getParent();
1645 CGF.EmitDeleteCall(Dtor->getOperatorDelete(), CGF.LoadCXXThis(),
1646 CGF.getContext().getTagDeclType(ClassDecl));
1647 CGF.Builder.CreateBr(continueBB);
1648
1649 CGF.EmitBlock(continueBB);
1650 }
1651 };
1652
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001653 class DestroyField final : public EHScopeStack::Cleanup {
John McCall9928c482011-07-12 16:41:08 +00001654 const FieldDecl *field;
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001655 CodeGenFunction::Destroyer *destroyer;
John McCall9928c482011-07-12 16:41:08 +00001656 bool useEHCleanupForArray;
John McCall50da2ca2010-07-21 05:30:47 +00001657
John McCall9928c482011-07-12 16:41:08 +00001658 public:
1659 DestroyField(const FieldDecl *field, CodeGenFunction::Destroyer *destroyer,
1660 bool useEHCleanupForArray)
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001661 : field(field), destroyer(destroyer),
1662 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall50da2ca2010-07-21 05:30:47 +00001663
Stephen Hines651f13c2014-04-23 16:59:28 -07001664 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall9928c482011-07-12 16:41:08 +00001665 // Find the address of the field.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001666 Address thisValue = CGF.LoadCXXThisAddress();
Eli Friedman377ecc72012-04-16 03:54:45 +00001667 QualType RecordTy = CGF.getContext().getTagDeclType(field->getParent());
1668 LValue ThisLV = CGF.MakeAddrLValue(thisValue, RecordTy);
1669 LValue LV = CGF.EmitLValueForField(ThisLV, field);
John McCall9928c482011-07-12 16:41:08 +00001670 assert(LV.isSimple());
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001671
John McCall9928c482011-07-12 16:41:08 +00001672 CGF.emitDestroy(LV.getAddress(), field->getType(), destroyer,
John McCallad346f42011-07-12 20:27:29 +00001673 flags.isForNormalCleanup() && useEHCleanupForArray);
John McCall50da2ca2010-07-21 05:30:47 +00001674 }
1675 };
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001676
1677 static void EmitSanitizerDtorCallback(CodeGenFunction &CGF, llvm::Value *Ptr,
1678 CharUnits::QuantityType PoisonSize) {
1679 // Pass in void pointer and size of region as arguments to runtime
1680 // function
1681 llvm::Value *Args[] = {CGF.Builder.CreateBitCast(Ptr, CGF.VoidPtrTy),
1682 llvm::ConstantInt::get(CGF.SizeTy, PoisonSize)};
1683
1684 llvm::Type *ArgTypes[] = {CGF.VoidPtrTy, CGF.SizeTy};
1685
1686 llvm::FunctionType *FnType =
1687 llvm::FunctionType::get(CGF.VoidTy, ArgTypes, false);
1688 llvm::Value *Fn =
1689 CGF.CGM.CreateRuntimeFunction(FnType, "__sanitizer_dtor_callback");
1690 CGF.EmitNounwindRuntimeCall(Fn, Args);
1691 }
1692
1693 class SanitizeDtorMembers final : public EHScopeStack::Cleanup {
1694 const CXXDestructorDecl *Dtor;
1695
1696 public:
1697 SanitizeDtorMembers(const CXXDestructorDecl *Dtor) : Dtor(Dtor) {}
1698
1699 // Generate function call for handling object poisoning.
1700 // Disables tail call elimination, to prevent the current stack frame
1701 // from disappearing from the stack trace.
1702 void Emit(CodeGenFunction &CGF, Flags flags) override {
1703 const ASTRecordLayout &Layout =
1704 CGF.getContext().getASTRecordLayout(Dtor->getParent());
1705
1706 // Nothing to poison.
1707 if (Layout.getFieldCount() == 0)
1708 return;
1709
1710 // Prevent the current stack frame from disappearing from the stack trace.
1711 CGF.CurFn->addFnAttr("disable-tail-calls", "true");
1712
1713 // Construct pointer to region to begin poisoning, and calculate poison
1714 // size, so that only members declared in this class are poisoned.
1715 ASTContext &Context = CGF.getContext();
1716 unsigned fieldIndex = 0;
1717 int startIndex = -1;
1718 // RecordDecl::field_iterator Field;
1719 for (const FieldDecl *Field : Dtor->getParent()->fields()) {
1720 // Poison field if it is trivial
1721 if (FieldHasTrivialDestructorBody(Context, Field)) {
1722 // Start sanitizing at this field
1723 if (startIndex < 0)
1724 startIndex = fieldIndex;
1725
1726 // Currently on the last field, and it must be poisoned with the
1727 // current block.
1728 if (fieldIndex == Layout.getFieldCount() - 1) {
1729 PoisonMembers(CGF, startIndex, Layout.getFieldCount());
1730 }
1731 } else if (startIndex >= 0) {
1732 // No longer within a block of memory to poison, so poison the block
1733 PoisonMembers(CGF, startIndex, fieldIndex);
1734 // Re-set the start index
1735 startIndex = -1;
1736 }
1737 fieldIndex += 1;
1738 }
1739 }
1740
1741 private:
1742 /// \param layoutStartOffset index of the ASTRecordLayout field to
1743 /// start poisoning (inclusive)
1744 /// \param layoutEndOffset index of the ASTRecordLayout field to
1745 /// end poisoning (exclusive)
1746 void PoisonMembers(CodeGenFunction &CGF, unsigned layoutStartOffset,
1747 unsigned layoutEndOffset) {
1748 ASTContext &Context = CGF.getContext();
1749 const ASTRecordLayout &Layout =
1750 Context.getASTRecordLayout(Dtor->getParent());
1751
1752 llvm::ConstantInt *OffsetSizePtr = llvm::ConstantInt::get(
1753 CGF.SizeTy,
1754 Context.toCharUnitsFromBits(Layout.getFieldOffset(layoutStartOffset))
1755 .getQuantity());
1756
1757 llvm::Value *OffsetPtr = CGF.Builder.CreateGEP(
1758 CGF.Builder.CreateBitCast(CGF.LoadCXXThis(), CGF.Int8PtrTy),
1759 OffsetSizePtr);
1760
1761 CharUnits::QuantityType PoisonSize;
1762 if (layoutEndOffset >= Layout.getFieldCount()) {
1763 PoisonSize = Layout.getNonVirtualSize().getQuantity() -
1764 Context.toCharUnitsFromBits(
1765 Layout.getFieldOffset(layoutStartOffset))
1766 .getQuantity();
1767 } else {
1768 PoisonSize = Context.toCharUnitsFromBits(
1769 Layout.getFieldOffset(layoutEndOffset) -
1770 Layout.getFieldOffset(layoutStartOffset))
1771 .getQuantity();
1772 }
1773
1774 if (PoisonSize == 0)
1775 return;
1776
1777 EmitSanitizerDtorCallback(CGF, OffsetPtr, PoisonSize);
1778 }
1779 };
1780
1781 class SanitizeDtorVTable final : public EHScopeStack::Cleanup {
1782 const CXXDestructorDecl *Dtor;
1783
1784 public:
1785 SanitizeDtorVTable(const CXXDestructorDecl *Dtor) : Dtor(Dtor) {}
1786
1787 // Generate function call for handling vtable pointer poisoning.
1788 void Emit(CodeGenFunction &CGF, Flags flags) override {
1789 assert(Dtor->getParent()->isDynamicClass());
1790 (void)Dtor;
1791 ASTContext &Context = CGF.getContext();
1792 // Poison vtable and vtable ptr if they exist for this class.
1793 llvm::Value *VTablePtr = CGF.LoadCXXThis();
1794
1795 CharUnits::QuantityType PoisonSize =
1796 Context.toCharUnitsFromBits(CGF.PointerWidthInBits).getQuantity();
1797 // Pass in void pointer and size of region as arguments to runtime
1798 // function
1799 EmitSanitizerDtorCallback(CGF, VTablePtr, PoisonSize);
1800 }
1801 };
1802} // end anonymous namespace
John McCall50da2ca2010-07-21 05:30:47 +00001803
Stephen Hines651f13c2014-04-23 16:59:28 -07001804/// \brief Emit all code that comes at the end of class's
Anders Carlsson607d0372009-12-24 22:46:43 +00001805/// destructor. This is to call destructors on members and base classes
1806/// in reverse order of their construction.
John McCall50da2ca2010-07-21 05:30:47 +00001807void CodeGenFunction::EnterDtorCleanups(const CXXDestructorDecl *DD,
1808 CXXDtorType DtorType) {
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001809 assert((!DD->isTrivial() || DD->hasAttr<DLLExportAttr>()) &&
1810 "Should not emit dtor epilogue for non-exported trivial dtor!");
Anders Carlsson607d0372009-12-24 22:46:43 +00001811
John McCall50da2ca2010-07-21 05:30:47 +00001812 // The deleting-destructor phase just needs to call the appropriate
1813 // operator delete that Sema picked up.
John McCall3b477332010-02-18 19:59:28 +00001814 if (DtorType == Dtor_Deleting) {
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001815 assert(DD->getOperatorDelete() &&
Stephen Hines651f13c2014-04-23 16:59:28 -07001816 "operator delete missing - EnterDtorCleanups");
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00001817 if (CXXStructorImplicitParamValue) {
1818 // If there is an implicit param to the deleting dtor, it's a boolean
1819 // telling whether we should call delete at the end of the dtor.
1820 EHStack.pushCleanup<CallDtorDeleteConditional>(
1821 NormalAndEHCleanup, CXXStructorImplicitParamValue);
1822 } else {
1823 EHStack.pushCleanup<CallDtorDelete>(NormalAndEHCleanup);
1824 }
John McCall3b477332010-02-18 19:59:28 +00001825 return;
1826 }
1827
John McCall50da2ca2010-07-21 05:30:47 +00001828 const CXXRecordDecl *ClassDecl = DD->getParent();
1829
Richard Smith416f63e2011-09-18 12:11:43 +00001830 // Unions have no bases and do not call field destructors.
1831 if (ClassDecl->isUnion())
1832 return;
1833
John McCall50da2ca2010-07-21 05:30:47 +00001834 // The complete-destructor phase just destructs all the virtual bases.
John McCall3b477332010-02-18 19:59:28 +00001835 if (DtorType == Dtor_Complete) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001836 // Poison the vtable pointer such that access after the base
1837 // and member destructors are invoked is invalid.
1838 if (CGM.getCodeGenOpts().SanitizeMemoryUseAfterDtor &&
1839 SanOpts.has(SanitizerKind::Memory) && ClassDecl->getNumVBases() &&
1840 ClassDecl->isPolymorphic())
1841 EHStack.pushCleanup<SanitizeDtorVTable>(NormalAndEHCleanup, DD);
John McCall50da2ca2010-07-21 05:30:47 +00001842
1843 // We push them in the forward order so that they'll be popped in
1844 // the reverse order.
Stephen Hines651f13c2014-04-23 16:59:28 -07001845 for (const auto &Base : ClassDecl->vbases()) {
John McCall3b477332010-02-18 19:59:28 +00001846 CXXRecordDecl *BaseClassDecl
1847 = cast<CXXRecordDecl>(Base.getType()->getAs<RecordType>()->getDecl());
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001848
John McCall3b477332010-02-18 19:59:28 +00001849 // Ignore trivial destructors.
1850 if (BaseClassDecl->hasTrivialDestructor())
1851 continue;
John McCall50da2ca2010-07-21 05:30:47 +00001852
John McCall1f0fca52010-07-21 07:22:38 +00001853 EHStack.pushCleanup<CallBaseDtor>(NormalAndEHCleanup,
1854 BaseClassDecl,
1855 /*BaseIsVirtual*/ true);
John McCall3b477332010-02-18 19:59:28 +00001856 }
John McCall50da2ca2010-07-21 05:30:47 +00001857
John McCall3b477332010-02-18 19:59:28 +00001858 return;
1859 }
1860
1861 assert(DtorType == Dtor_Base);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001862 // Poison the vtable pointer if it has no virtual bases, but inherits
1863 // virtual functions.
1864 if (CGM.getCodeGenOpts().SanitizeMemoryUseAfterDtor &&
1865 SanOpts.has(SanitizerKind::Memory) && !ClassDecl->getNumVBases() &&
1866 ClassDecl->isPolymorphic())
1867 EHStack.pushCleanup<SanitizeDtorVTable>(NormalAndEHCleanup, DD);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001868
John McCall50da2ca2010-07-21 05:30:47 +00001869 // Destroy non-virtual bases.
Stephen Hines651f13c2014-04-23 16:59:28 -07001870 for (const auto &Base : ClassDecl->bases()) {
John McCall50da2ca2010-07-21 05:30:47 +00001871 // Ignore virtual bases.
1872 if (Base.isVirtual())
1873 continue;
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001874
John McCall50da2ca2010-07-21 05:30:47 +00001875 CXXRecordDecl *BaseClassDecl = Base.getType()->getAsCXXRecordDecl();
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001876
John McCall50da2ca2010-07-21 05:30:47 +00001877 // Ignore trivial destructors.
1878 if (BaseClassDecl->hasTrivialDestructor())
1879 continue;
John McCall3b477332010-02-18 19:59:28 +00001880
John McCall1f0fca52010-07-21 07:22:38 +00001881 EHStack.pushCleanup<CallBaseDtor>(NormalAndEHCleanup,
1882 BaseClassDecl,
1883 /*BaseIsVirtual*/ false);
John McCall50da2ca2010-07-21 05:30:47 +00001884 }
1885
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001886 // Poison fields such that access after their destructors are
1887 // invoked, and before the base class destructor runs, is invalid.
1888 if (CGM.getCodeGenOpts().SanitizeMemoryUseAfterDtor &&
1889 SanOpts.has(SanitizerKind::Memory))
1890 EHStack.pushCleanup<SanitizeDtorMembers>(NormalAndEHCleanup, DD);
1891
John McCall50da2ca2010-07-21 05:30:47 +00001892 // Destroy direct fields.
Stephen Hines651f13c2014-04-23 16:59:28 -07001893 for (const auto *Field : ClassDecl->fields()) {
1894 QualType type = Field->getType();
John McCall9928c482011-07-12 16:41:08 +00001895 QualType::DestructionKind dtorKind = type.isDestructedType();
1896 if (!dtorKind) continue;
John McCall50da2ca2010-07-21 05:30:47 +00001897
Richard Smith9a561d52012-02-26 09:11:52 +00001898 // Anonymous union members do not have their destructors called.
1899 const RecordType *RT = type->getAsUnionType();
1900 if (RT && RT->getDecl()->isAnonymousStructOrUnion()) continue;
1901
John McCall9928c482011-07-12 16:41:08 +00001902 CleanupKind cleanupKind = getCleanupKind(dtorKind);
Stephen Hines651f13c2014-04-23 16:59:28 -07001903 EHStack.pushCleanup<DestroyField>(cleanupKind, Field,
John McCall9928c482011-07-12 16:41:08 +00001904 getDestroyer(dtorKind),
1905 cleanupKind & EHCleanup);
Anders Carlsson607d0372009-12-24 22:46:43 +00001906 }
Anders Carlsson607d0372009-12-24 22:46:43 +00001907}
1908
John McCallc3c07662011-07-13 06:10:41 +00001909/// EmitCXXAggrConstructorCall - Emit a loop to call a particular
1910/// constructor for each of several members of an array.
Douglas Gregor59174c02010-07-21 01:10:17 +00001911///
John McCallc3c07662011-07-13 06:10:41 +00001912/// \param ctor the constructor to call for each element
John McCallc3c07662011-07-13 06:10:41 +00001913/// \param arrayType the type of the array to initialize
1914/// \param arrayBegin an arrayType*
1915/// \param zeroInitialize true if each element should be
1916/// zero-initialized before it is constructed
Stephen Hines176edba2014-12-01 14:53:08 -08001917void CodeGenFunction::EmitCXXAggrConstructorCall(
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001918 const CXXConstructorDecl *ctor, const ArrayType *arrayType,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001919 Address arrayBegin, const CXXConstructExpr *E, bool zeroInitialize) {
John McCallc3c07662011-07-13 06:10:41 +00001920 QualType elementType;
1921 llvm::Value *numElements =
1922 emitArrayLength(arrayType, elementType, arrayBegin);
Anders Carlsson3b5ad222010-01-01 20:29:01 +00001923
Stephen Hines176edba2014-12-01 14:53:08 -08001924 EmitCXXAggrConstructorCall(ctor, numElements, arrayBegin, E, zeroInitialize);
Anders Carlsson3b5ad222010-01-01 20:29:01 +00001925}
1926
John McCallc3c07662011-07-13 06:10:41 +00001927/// EmitCXXAggrConstructorCall - Emit a loop to call a particular
1928/// constructor for each of several members of an array.
1929///
1930/// \param ctor the constructor to call for each element
1931/// \param numElements the number of elements in the array;
John McCalldd376ca2011-07-13 07:37:11 +00001932/// may be zero
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001933/// \param arrayBase a T*, where T is the type constructed by ctor
John McCallc3c07662011-07-13 06:10:41 +00001934/// \param zeroInitialize true if each element should be
1935/// zero-initialized before it is constructed
Stephen Hines176edba2014-12-01 14:53:08 -08001936void CodeGenFunction::EmitCXXAggrConstructorCall(const CXXConstructorDecl *ctor,
1937 llvm::Value *numElements,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001938 Address arrayBase,
Stephen Hines176edba2014-12-01 14:53:08 -08001939 const CXXConstructExpr *E,
1940 bool zeroInitialize) {
John McCalldd376ca2011-07-13 07:37:11 +00001941 // It's legal for numElements to be zero. This can happen both
1942 // dynamically, because x can be zero in 'new A[x]', and statically,
1943 // because of GCC extensions that permit zero-length arrays. There
1944 // are probably legitimate places where we could assume that this
1945 // doesn't happen, but it's not clear that it's worth it.
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001946 llvm::BranchInst *zeroCheckBranch = nullptr;
John McCalldd376ca2011-07-13 07:37:11 +00001947
1948 // Optimize for a constant count.
1949 llvm::ConstantInt *constantCount
1950 = dyn_cast<llvm::ConstantInt>(numElements);
1951 if (constantCount) {
1952 // Just skip out if the constant count is zero.
1953 if (constantCount->isZero()) return;
1954
1955 // Otherwise, emit the check.
1956 } else {
1957 llvm::BasicBlock *loopBB = createBasicBlock("new.ctorloop");
1958 llvm::Value *iszero = Builder.CreateIsNull(numElements, "isempty");
1959 zeroCheckBranch = Builder.CreateCondBr(iszero, loopBB, loopBB);
1960 EmitBlock(loopBB);
1961 }
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001962
John McCallc3c07662011-07-13 06:10:41 +00001963 // Find the end of the array.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001964 llvm::Value *arrayBegin = arrayBase.getPointer();
John McCallc3c07662011-07-13 06:10:41 +00001965 llvm::Value *arrayEnd = Builder.CreateInBoundsGEP(arrayBegin, numElements,
1966 "arrayctor.end");
Anders Carlsson3b5ad222010-01-01 20:29:01 +00001967
John McCallc3c07662011-07-13 06:10:41 +00001968 // Enter the loop, setting up a phi for the current location to initialize.
1969 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
1970 llvm::BasicBlock *loopBB = createBasicBlock("arrayctor.loop");
1971 EmitBlock(loopBB);
1972 llvm::PHINode *cur = Builder.CreatePHI(arrayBegin->getType(), 2,
1973 "arrayctor.cur");
1974 cur->addIncoming(arrayBegin, entryBB);
Anders Carlsson3b5ad222010-01-01 20:29:01 +00001975
Anders Carlsson3b5ad222010-01-01 20:29:01 +00001976 // Inside the loop body, emit the constructor call on the array element.
John McCallc3c07662011-07-13 06:10:41 +00001977
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001978 // The alignment of the base, adjusted by the size of a single element,
1979 // provides a conservative estimate of the alignment of every element.
1980 // (This assumes we never start tracking offsetted alignments.)
1981 //
1982 // Note that these are complete objects and so we don't need to
1983 // use the non-virtual size or alignment.
John McCallc3c07662011-07-13 06:10:41 +00001984 QualType type = getContext().getTypeDeclType(ctor->getParent());
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001985 CharUnits eltAlignment =
1986 arrayBase.getAlignment()
1987 .alignmentOfArrayElement(getContext().getTypeSizeInChars(type));
1988 Address curAddr = Address(cur, eltAlignment);
Anders Carlsson3b5ad222010-01-01 20:29:01 +00001989
Douglas Gregor59174c02010-07-21 01:10:17 +00001990 // Zero initialize the storage, if requested.
John McCallc3c07662011-07-13 06:10:41 +00001991 if (zeroInitialize)
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001992 EmitNullInitialization(curAddr, type);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001993
1994 // C++ [class.temporary]p4:
Anders Carlsson3b5ad222010-01-01 20:29:01 +00001995 // There are two contexts in which temporaries are destroyed at a different
1996 // point than the end of the full-expression. The first context is when a
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07001997 // default constructor is called to initialize an element of an array.
1998 // If the constructor has one or more default arguments, the destruction of
1999 // every temporary created in a default argument expression is sequenced
Anders Carlsson3b5ad222010-01-01 20:29:01 +00002000 // before the construction of the next array element, if any.
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002001
Anders Carlsson44ec82b2010-03-30 03:14:41 +00002002 {
John McCallf1549f62010-07-06 01:34:17 +00002003 RunCleanupsScope Scope(*this);
Anders Carlsson3b5ad222010-01-01 20:29:01 +00002004
John McCallc3c07662011-07-13 06:10:41 +00002005 // Evaluate the constructor and its arguments in a regular
2006 // partial-destroy cleanup.
David Blaikie4e4d0842012-03-11 07:00:24 +00002007 if (getLangOpts().Exceptions &&
John McCallc3c07662011-07-13 06:10:41 +00002008 !ctor->getParent()->hasTrivialDestructor()) {
2009 Destroyer *destroyer = destroyCXXObject;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002010 pushRegularPartialArrayCleanup(arrayBegin, cur, type, eltAlignment,
2011 *destroyer);
John McCallc3c07662011-07-13 06:10:41 +00002012 }
2013
Stephen Hines176edba2014-12-01 14:53:08 -08002014 EmitCXXConstructorCall(ctor, Ctor_Complete, /*ForVirtualBase=*/false,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002015 /*Delegating=*/false, curAddr, E);
Anders Carlsson44ec82b2010-03-30 03:14:41 +00002016 }
Anders Carlsson3b5ad222010-01-01 20:29:01 +00002017
John McCallc3c07662011-07-13 06:10:41 +00002018 // Go to the next element.
2019 llvm::Value *next =
2020 Builder.CreateInBoundsGEP(cur, llvm::ConstantInt::get(SizeTy, 1),
2021 "arrayctor.next");
2022 cur->addIncoming(next, Builder.GetInsertBlock());
Anders Carlsson3b5ad222010-01-01 20:29:01 +00002023
John McCallc3c07662011-07-13 06:10:41 +00002024 // Check whether that's the end of the loop.
2025 llvm::Value *done = Builder.CreateICmpEQ(next, arrayEnd, "arrayctor.done");
2026 llvm::BasicBlock *contBB = createBasicBlock("arrayctor.cont");
2027 Builder.CreateCondBr(done, contBB, loopBB);
Anders Carlsson3b5ad222010-01-01 20:29:01 +00002028
John McCalldd376ca2011-07-13 07:37:11 +00002029 // Patch the earlier check to skip over the loop.
2030 if (zeroCheckBranch) zeroCheckBranch->setSuccessor(0, contBB);
2031
John McCallc3c07662011-07-13 06:10:41 +00002032 EmitBlock(contBB);
Anders Carlsson3b5ad222010-01-01 20:29:01 +00002033}
2034
John McCallbdc4d802011-07-09 01:37:26 +00002035void CodeGenFunction::destroyCXXObject(CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002036 Address addr,
John McCallbdc4d802011-07-09 01:37:26 +00002037 QualType type) {
2038 const RecordType *rtype = type->castAs<RecordType>();
2039 const CXXRecordDecl *record = cast<CXXRecordDecl>(rtype->getDecl());
2040 const CXXDestructorDecl *dtor = record->getDestructor();
2041 assert(!dtor->isTrivial());
2042 CGF.EmitCXXDestructorCall(dtor, Dtor_Complete, /*for vbase*/ false,
Douglas Gregor378e1e72013-01-31 05:50:40 +00002043 /*Delegating=*/false, addr);
John McCallbdc4d802011-07-09 01:37:26 +00002044}
2045
Stephen Hines176edba2014-12-01 14:53:08 -08002046void CodeGenFunction::EmitCXXConstructorCall(const CXXConstructorDecl *D,
2047 CXXCtorType Type,
2048 bool ForVirtualBase,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002049 bool Delegating, Address This,
Stephen Hines176edba2014-12-01 14:53:08 -08002050 const CXXConstructExpr *E) {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002051 CallArgList Args;
2052
2053 // Push the this ptr.
2054 Args.add(RValue::get(This.getPointer()), D->getThisType(getContext()));
2055
2056 // If this is a trivial constructor, emit a memcpy now before we lose
2057 // the alignment information on the argument.
2058 // FIXME: It would be better to preserve alignment information into CallArg.
2059 if (isMemcpyEquivalentSpecialMember(D)) {
2060 assert(E->getNumArgs() == 1 && "unexpected argcount for trivial ctor");
2061
2062 const Expr *Arg = E->getArg(0);
2063 QualType SrcTy = Arg->getType();
2064 Address Src = EmitLValue(Arg).getAddress();
2065 QualType DestTy = getContext().getTypeDeclType(D->getParent());
2066 EmitAggregateCopyCtor(This, Src, DestTy, SrcTy);
2067 return;
2068 }
2069
2070 // Add the rest of the user-supplied arguments.
2071 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
2072 EmitCallArgs(Args, FPT, E->arguments(), E->getConstructor());
2073
2074 EmitCXXConstructorCall(D, Type, ForVirtualBase, Delegating, This, Args);
2075}
2076
2077static bool canEmitDelegateCallArgs(CodeGenFunction &CGF,
2078 const CXXConstructorDecl *Ctor,
2079 CXXCtorType Type, CallArgList &Args) {
2080 // We can't forward a variadic call.
2081 if (Ctor->isVariadic())
2082 return false;
2083
2084 if (CGF.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2085 // If the parameters are callee-cleanup, it's not safe to forward.
2086 for (auto *P : Ctor->parameters())
2087 if (P->getType().isDestructedType())
2088 return false;
2089
2090 // Likewise if they're inalloca.
2091 const CGFunctionInfo &Info =
2092 CGF.CGM.getTypes().arrangeCXXConstructorCall(Args, Ctor, Type, 0);
2093 if (Info.usesInAlloca())
2094 return false;
2095 }
2096
2097 // Anything else should be OK.
2098 return true;
2099}
2100
2101void CodeGenFunction::EmitCXXConstructorCall(const CXXConstructorDecl *D,
2102 CXXCtorType Type,
2103 bool ForVirtualBase,
2104 bool Delegating,
2105 Address This,
2106 CallArgList &Args) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002107 const CXXRecordDecl *ClassDecl = D->getParent();
2108
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002109 // C++11 [class.mfct.non-static]p2:
2110 // If a non-static member function of a class X is called for an object that
2111 // is not of type X, or of a type derived from X, the behavior is undefined.
2112 // FIXME: Provide a source location here.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002113 EmitTypeCheck(CodeGenFunction::TCK_ConstructorCall, SourceLocation(),
2114 This.getPointer(), getContext().getRecordType(ClassDecl));
John McCall8b6bbeb2010-02-06 00:25:16 +00002115
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002116 if (D->isTrivial() && D->isDefaultConstructor()) {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002117 assert(Args.size() == 1 && "trivial default ctor with args");
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002118 return;
2119 }
2120
2121 // If this is a trivial constructor, just emit what's needed. If this is a
2122 // union copy constructor, we must emit a memcpy, because the AST does not
2123 // model that copy.
2124 if (isMemcpyEquivalentSpecialMember(D)) {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002125 assert(Args.size() == 2 && "unexpected argcount for trivial ctor");
John McCall8b6bbeb2010-02-06 00:25:16 +00002126
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002127 QualType SrcTy = D->getParamDecl(0)->getType().getNonReferenceType();
2128 Address Src(Args[1].RV.getScalarVal(), getNaturalTypeAlignment(SrcTy));
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002129 QualType DestTy = getContext().getTypeDeclType(ClassDecl);
Stephen Hines0e2c34f2015-03-23 12:09:02 -07002130 EmitAggregateCopyCtor(This, Src, DestTy, SrcTy);
Anders Carlsson3b5ad222010-01-01 20:29:01 +00002131 return;
2132 }
2133
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002134 // Check whether we can actually emit the constructor before trying to do so.
2135 if (auto Inherited = D->getInheritedConstructor()) {
2136 if (getTypes().inheritingCtorHasParams(Inherited, Type) &&
2137 !canEmitDelegateCallArgs(*this, D, Type, Args)) {
2138 EmitInlinedInheritingCXXConstructorCall(D, Type, ForVirtualBase,
2139 Delegating, Args);
2140 return;
2141 }
2142 }
Stephen Hines651f13c2014-04-23 16:59:28 -07002143
2144 // Insert any ABI-specific implicit constructor arguments.
2145 unsigned ExtraArgs = CGM.getCXXABI().addImplicitConstructorArgs(
2146 *this, D, Type, ForVirtualBase, Delegating, Args);
2147
2148 // Emit the call.
Stephen Hines176edba2014-12-01 14:53:08 -08002149 llvm::Value *Callee = CGM.getAddrOfCXXStructor(D, getFromCtorType(Type));
Stephen Hines651f13c2014-04-23 16:59:28 -07002150 const CGFunctionInfo &Info =
2151 CGM.getTypes().arrangeCXXConstructorCall(Args, D, Type, ExtraArgs);
2152 EmitCall(Info, Callee, ReturnValueSlot(), Args, D);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002153
2154 // Generate vtable assumptions if we're constructing a complete object
2155 // with a vtable. We don't do this for base subobjects for two reasons:
2156 // first, it's incorrect for classes with virtual bases, and second, we're
2157 // about to overwrite the vptrs anyway.
2158 // We also have to make sure if we can refer to vtable:
2159 // - Otherwise we can refer to vtable if it's safe to speculatively emit.
2160 // FIXME: If vtable is used by ctor/dtor, or if vtable is external and we are
2161 // sure that definition of vtable is not hidden,
2162 // then we are always safe to refer to it.
2163 // FIXME: It looks like InstCombine is very inefficient on dealing with
2164 // assumes. Make assumption loads require -fstrict-vtable-pointers temporarily.
2165 if (CGM.getCodeGenOpts().OptimizationLevel > 0 &&
2166 ClassDecl->isDynamicClass() && Type != Ctor_Base &&
2167 CGM.getCXXABI().canSpeculativelyEmitVTable(ClassDecl) &&
2168 CGM.getCodeGenOpts().StrictVTablePointers)
2169 EmitVTableAssumptionLoads(ClassDecl, This);
2170}
2171
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002172void CodeGenFunction::EmitInheritedCXXConstructorCall(
2173 const CXXConstructorDecl *D, bool ForVirtualBase, Address This,
2174 bool InheritedFromVBase, const CXXInheritedCtorInitExpr *E) {
2175 CallArgList Args;
2176 CallArg ThisArg(RValue::get(This.getPointer()), D->getThisType(getContext()),
2177 /*NeedsCopy=*/false);
2178
2179 // Forward the parameters.
2180 if (InheritedFromVBase &&
2181 CGM.getTarget().getCXXABI().hasConstructorVariants()) {
2182 // Nothing to do; this construction is not responsible for constructing
2183 // the base class containing the inherited constructor.
2184 // FIXME: Can we just pass undef's for the remaining arguments if we don't
2185 // have constructor variants?
2186 Args.push_back(ThisArg);
2187 } else if (!CXXInheritedCtorInitExprArgs.empty()) {
2188 // The inheriting constructor was inlined; just inject its arguments.
2189 assert(CXXInheritedCtorInitExprArgs.size() >= D->getNumParams() &&
2190 "wrong number of parameters for inherited constructor call");
2191 Args = CXXInheritedCtorInitExprArgs;
2192 Args[0] = ThisArg;
2193 } else {
2194 // The inheriting constructor was not inlined. Emit delegating arguments.
2195 Args.push_back(ThisArg);
2196 const auto *OuterCtor = cast<CXXConstructorDecl>(CurCodeDecl);
2197 assert(OuterCtor->getNumParams() == D->getNumParams());
2198 assert(!OuterCtor->isVariadic() && "should have been inlined");
2199
2200 for (const auto *Param : OuterCtor->parameters()) {
2201 assert(getContext().hasSameUnqualifiedType(
2202 OuterCtor->getParamDecl(Param->getFunctionScopeIndex())->getType(),
2203 Param->getType()));
2204 EmitDelegateCallArg(Args, Param, E->getLocation());
2205
2206 // Forward __attribute__(pass_object_size).
2207 if (Param->hasAttr<PassObjectSizeAttr>()) {
2208 auto *POSParam = SizeArguments[Param];
2209 assert(POSParam && "missing pass_object_size value for forwarding");
2210 EmitDelegateCallArg(Args, POSParam, E->getLocation());
2211 }
2212 }
2213 }
2214
2215 EmitCXXConstructorCall(D, Ctor_Base, ForVirtualBase, /*Delegating*/false,
2216 This, Args);
2217}
2218
2219void CodeGenFunction::EmitInlinedInheritingCXXConstructorCall(
2220 const CXXConstructorDecl *Ctor, CXXCtorType CtorType, bool ForVirtualBase,
2221 bool Delegating, CallArgList &Args) {
2222 InlinedInheritingConstructorScope Scope(*this, GlobalDecl(Ctor, CtorType));
2223
2224 // Save the arguments to be passed to the inherited constructor.
2225 CXXInheritedCtorInitExprArgs = Args;
2226
2227 FunctionArgList Params;
2228 QualType RetType = BuildFunctionArgList(CurGD, Params);
2229 FnRetTy = RetType;
2230
2231 // Insert any ABI-specific implicit constructor arguments.
2232 CGM.getCXXABI().addImplicitConstructorArgs(*this, Ctor, CtorType,
2233 ForVirtualBase, Delegating, Args);
2234
2235 // Emit a simplified prolog. We only need to emit the implicit params.
2236 assert(Args.size() >= Params.size() && "too few arguments for call");
2237 for (unsigned I = 0, N = Args.size(); I != N; ++I) {
2238 if (I < Params.size() && isa<ImplicitParamDecl>(Params[I])) {
2239 const RValue &RV = Args[I].RV;
2240 assert(!RV.isComplex() && "complex indirect params not supported");
2241 ParamValue Val = RV.isScalar()
2242 ? ParamValue::forDirect(RV.getScalarVal())
2243 : ParamValue::forIndirect(RV.getAggregateAddress());
2244 EmitParmDecl(*Params[I], Val, I + 1);
2245 }
2246 }
2247
2248 // Create a return value slot if the ABI implementation wants one.
2249 // FIXME: This is dumb, we should ask the ABI not to try to set the return
2250 // value instead.
2251 if (!RetType->isVoidType())
2252 ReturnValue = CreateIRTemp(RetType, "retval.inhctor");
2253
2254 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
2255 CXXThisValue = CXXABIThisValue;
2256
2257 // Directly emit the constructor initializers.
2258 EmitCtorPrologue(Ctor, CtorType, Params);
2259}
2260
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002261void CodeGenFunction::EmitVTableAssumptionLoad(const VPtr &Vptr, Address This) {
2262 llvm::Value *VTableGlobal =
2263 CGM.getCXXABI().getVTableAddressPoint(Vptr.Base, Vptr.VTableClass);
2264 if (!VTableGlobal)
2265 return;
2266
2267 // We can just use the base offset in the complete class.
2268 CharUnits NonVirtualOffset = Vptr.Base.getBaseOffset();
2269
2270 if (!NonVirtualOffset.isZero())
2271 This =
2272 ApplyNonVirtualAndVirtualOffset(*this, This, NonVirtualOffset, nullptr,
2273 Vptr.VTableClass, Vptr.NearestVBase);
2274
2275 llvm::Value *VPtrValue =
2276 GetVTablePtr(This, VTableGlobal->getType(), Vptr.VTableClass);
2277 llvm::Value *Cmp =
2278 Builder.CreateICmpEQ(VPtrValue, VTableGlobal, "cmp.vtables");
2279 Builder.CreateAssumption(Cmp);
2280}
2281
2282void CodeGenFunction::EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl,
2283 Address This) {
2284 if (CGM.getCXXABI().doStructorsInitializeVPtrs(ClassDecl))
2285 for (const VPtr &Vptr : getVTablePointers(ClassDecl))
2286 EmitVTableAssumptionLoad(Vptr, This);
Anders Carlsson3b5ad222010-01-01 20:29:01 +00002287}
2288
John McCallc0bf4622010-02-23 00:48:20 +00002289void
Fariborz Jahanian34999872010-11-13 21:53:34 +00002290CodeGenFunction::EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002291 Address This, Address Src,
2292 const CXXConstructExpr *E) {
Stephen Hines651f13c2014-04-23 16:59:28 -07002293 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002294
Fariborz Jahanian34999872010-11-13 21:53:34 +00002295 CallArgList Args;
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002296
Fariborz Jahanian34999872010-11-13 21:53:34 +00002297 // Push the this ptr.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002298 Args.add(RValue::get(This.getPointer()), D->getThisType(getContext()));
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002299
Fariborz Jahanian34999872010-11-13 21:53:34 +00002300 // Push the src ptr.
Stephen Hines651f13c2014-04-23 16:59:28 -07002301 QualType QT = *(FPT->param_type_begin());
Chris Lattner2acc6e32011-07-18 04:24:23 +00002302 llvm::Type *t = CGM.getTypes().ConvertType(QT);
Fariborz Jahanian34999872010-11-13 21:53:34 +00002303 Src = Builder.CreateBitCast(Src, t);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002304 Args.add(RValue::get(Src.getPointer()), QT);
Stephen Hines651f13c2014-04-23 16:59:28 -07002305
Fariborz Jahanian34999872010-11-13 21:53:34 +00002306 // Skip over first argument (Src).
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002307 EmitCallArgs(Args, FPT, drop_begin(E->arguments(), 1), E->getConstructor(),
Stephen Hines176edba2014-12-01 14:53:08 -08002308 /*ParamsToSkip*/ 1);
Stephen Hines651f13c2014-04-23 16:59:28 -07002309
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002310 EmitCXXConstructorCall(D, Ctor_Complete, false, false, This, Args);
Fariborz Jahanian34999872010-11-13 21:53:34 +00002311}
2312
2313void
John McCallc0bf4622010-02-23 00:48:20 +00002314CodeGenFunction::EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2315 CXXCtorType CtorType,
Nick Lewycky4ee7dc22013-10-02 02:29:49 +00002316 const FunctionArgList &Args,
2317 SourceLocation Loc) {
John McCallc0bf4622010-02-23 00:48:20 +00002318 CallArgList DelegateArgs;
2319
2320 FunctionArgList::const_iterator I = Args.begin(), E = Args.end();
2321 assert(I != E && "no parameters to constructor");
2322
2323 // this
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002324 Address This = LoadCXXThisAddress();
2325 DelegateArgs.add(RValue::get(This.getPointer()), (*I)->getType());
John McCallc0bf4622010-02-23 00:48:20 +00002326 ++I;
2327
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002328 // FIXME: The location of the VTT parameter in the parameter list is
2329 // specific to the Itanium ABI and shouldn't be hardcoded here.
2330 if (CGM.getCXXABI().NeedsVTTParameter(CurGD)) {
2331 assert(I != E && "cannot skip vtt parameter, already done with args");
2332 assert((*I)->getType()->isPointerType() &&
2333 "skipping parameter not of vtt type");
2334 ++I;
John McCallc0bf4622010-02-23 00:48:20 +00002335 }
2336
2337 // Explicit arguments.
2338 for (; I != E; ++I) {
John McCall413ebdb2011-03-11 20:59:21 +00002339 const VarDecl *param = *I;
Nick Lewycky4ee7dc22013-10-02 02:29:49 +00002340 // FIXME: per-argument source location
2341 EmitDelegateCallArg(DelegateArgs, param, Loc);
John McCallc0bf4622010-02-23 00:48:20 +00002342 }
2343
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002344 EmitCXXConstructorCall(Ctor, CtorType, /*ForVirtualBase=*/false,
2345 /*Delegating=*/true, This, DelegateArgs);
John McCallc0bf4622010-02-23 00:48:20 +00002346}
2347
Sean Huntb76af9c2011-05-03 23:05:34 +00002348namespace {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002349 struct CallDelegatingCtorDtor final : EHScopeStack::Cleanup {
Sean Huntb76af9c2011-05-03 23:05:34 +00002350 const CXXDestructorDecl *Dtor;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002351 Address Addr;
Sean Huntb76af9c2011-05-03 23:05:34 +00002352 CXXDtorType Type;
2353
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002354 CallDelegatingCtorDtor(const CXXDestructorDecl *D, Address Addr,
Sean Huntb76af9c2011-05-03 23:05:34 +00002355 CXXDtorType Type)
2356 : Dtor(D), Addr(Addr), Type(Type) {}
2357
Stephen Hines651f13c2014-04-23 16:59:28 -07002358 void Emit(CodeGenFunction &CGF, Flags flags) override {
Sean Huntb76af9c2011-05-03 23:05:34 +00002359 CGF.EmitCXXDestructorCall(Dtor, Type, /*ForVirtualBase=*/false,
Douglas Gregor378e1e72013-01-31 05:50:40 +00002360 /*Delegating=*/true, Addr);
Sean Huntb76af9c2011-05-03 23:05:34 +00002361 }
2362 };
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002363} // end anonymous namespace
Sean Huntb76af9c2011-05-03 23:05:34 +00002364
Sean Hunt059ce0d2011-05-01 07:04:31 +00002365void
2366CodeGenFunction::EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2367 const FunctionArgList &Args) {
2368 assert(Ctor->isDelegatingConstructor());
2369
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002370 Address ThisPtr = LoadCXXThisAddress();
Sean Hunt059ce0d2011-05-01 07:04:31 +00002371
John McCallf85e1932011-06-15 23:02:42 +00002372 AggValueSlot AggSlot =
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002373 AggValueSlot::forAddr(ThisPtr, Qualifiers(),
John McCall7c2349b2011-08-25 20:40:09 +00002374 AggValueSlot::IsDestructed,
John McCall410ffb22011-08-25 23:04:34 +00002375 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier649b4a12012-03-29 17:37:10 +00002376 AggValueSlot::IsNotAliased);
Sean Hunt059ce0d2011-05-01 07:04:31 +00002377
2378 EmitAggExpr(Ctor->init_begin()[0]->getInit(), AggSlot);
Sean Hunt059ce0d2011-05-01 07:04:31 +00002379
Sean Huntb76af9c2011-05-03 23:05:34 +00002380 const CXXRecordDecl *ClassDecl = Ctor->getParent();
David Blaikie4e4d0842012-03-11 07:00:24 +00002381 if (CGM.getLangOpts().Exceptions && !ClassDecl->hasTrivialDestructor()) {
Sean Huntb76af9c2011-05-03 23:05:34 +00002382 CXXDtorType Type =
2383 CurGD.getCtorType() == Ctor_Complete ? Dtor_Complete : Dtor_Base;
2384
2385 EHStack.pushCleanup<CallDelegatingCtorDtor>(EHCleanup,
2386 ClassDecl->getDestructor(),
2387 ThisPtr, Type);
2388 }
2389}
Sean Hunt059ce0d2011-05-01 07:04:31 +00002390
Anders Carlsson3b5ad222010-01-01 20:29:01 +00002391void CodeGenFunction::EmitCXXDestructorCall(const CXXDestructorDecl *DD,
2392 CXXDtorType Type,
Anders Carlsson8e6404c2010-05-02 23:29:11 +00002393 bool ForVirtualBase,
Douglas Gregor378e1e72013-01-31 05:50:40 +00002394 bool Delegating,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002395 Address This) {
Stephen Hines651f13c2014-04-23 16:59:28 -07002396 CGM.getCXXABI().EmitDestructorCall(*this, DD, Type, ForVirtualBase,
2397 Delegating, This);
Anders Carlsson3b5ad222010-01-01 20:29:01 +00002398}
2399
John McCall291ae942010-07-21 01:41:18 +00002400namespace {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002401 struct CallLocalDtor final : EHScopeStack::Cleanup {
John McCall291ae942010-07-21 01:41:18 +00002402 const CXXDestructorDecl *Dtor;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002403 Address Addr;
John McCall291ae942010-07-21 01:41:18 +00002404
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002405 CallLocalDtor(const CXXDestructorDecl *D, Address Addr)
John McCall291ae942010-07-21 01:41:18 +00002406 : Dtor(D), Addr(Addr) {}
2407
Stephen Hines651f13c2014-04-23 16:59:28 -07002408 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall291ae942010-07-21 01:41:18 +00002409 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
Douglas Gregor378e1e72013-01-31 05:50:40 +00002410 /*ForVirtualBase=*/false,
2411 /*Delegating=*/false, Addr);
John McCall291ae942010-07-21 01:41:18 +00002412 }
2413 };
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002414} // end anonymous namespace
John McCall291ae942010-07-21 01:41:18 +00002415
John McCall81407d42010-07-21 06:29:51 +00002416void CodeGenFunction::PushDestructorCleanup(const CXXDestructorDecl *D,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002417 Address Addr) {
John McCall1f0fca52010-07-21 07:22:38 +00002418 EHStack.pushCleanup<CallLocalDtor>(NormalAndEHCleanup, D, Addr);
John McCall81407d42010-07-21 06:29:51 +00002419}
2420
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002421void CodeGenFunction::PushDestructorCleanup(QualType T, Address Addr) {
John McCallf1549f62010-07-06 01:34:17 +00002422 CXXRecordDecl *ClassDecl = T->getAsCXXRecordDecl();
2423 if (!ClassDecl) return;
2424 if (ClassDecl->hasTrivialDestructor()) return;
2425
2426 const CXXDestructorDecl *D = ClassDecl->getDestructor();
John McCall642a75f2011-04-28 02:15:35 +00002427 assert(D && D->isUsed() && "destructor not marked as used!");
John McCall81407d42010-07-21 06:29:51 +00002428 PushDestructorCleanup(D, Addr);
John McCallf1549f62010-07-06 01:34:17 +00002429}
2430
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002431void CodeGenFunction::InitializeVTablePointer(const VPtr &Vptr) {
Anders Carlssond103f9f2010-03-28 19:40:00 +00002432 // Compute the address point.
Timur Iskhodzhanova53d7a02013-09-27 14:48:01 +00002433 llvm::Value *VTableAddressPoint =
2434 CGM.getCXXABI().getVTableAddressPointInStructor(
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002435 *this, Vptr.VTableClass, Vptr.Base, Vptr.NearestVBase);
2436
Timur Iskhodzhanova53d7a02013-09-27 14:48:01 +00002437 if (!VTableAddressPoint)
2438 return;
Anders Carlssond103f9f2010-03-28 19:40:00 +00002439
Anders Carlsson36fd6be2010-04-20 16:22:16 +00002440 // Compute where to store the address point.
Stephen Hines6bcf27b2014-05-29 04:14:42 -07002441 llvm::Value *VirtualOffset = nullptr;
Ken Dyck9a8ad9b2011-03-23 00:45:26 +00002442 CharUnits NonVirtualOffset = CharUnits::Zero();
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002443
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002444 if (CGM.getCXXABI().isVirtualOffsetNeededForVTableField(*this, Vptr)) {
Anders Carlsson3e79c302010-04-20 18:05:10 +00002445 // We need to use the virtual base offset offset because the virtual base
2446 // might have a different offset in the most derived class.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002447
2448 VirtualOffset = CGM.getCXXABI().GetVirtualBaseClassOffset(
2449 *this, LoadCXXThisAddress(), Vptr.VTableClass, Vptr.NearestVBase);
2450 NonVirtualOffset = Vptr.OffsetFromNearestVBase;
Anders Carlsson3e79c302010-04-20 18:05:10 +00002451 } else {
Anders Carlsson8246cc72010-05-03 00:29:58 +00002452 // We can just use the base offset in the complete class.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002453 NonVirtualOffset = Vptr.Base.getBaseOffset();
Anders Carlsson3e79c302010-04-20 18:05:10 +00002454 }
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002455
Anders Carlsson8246cc72010-05-03 00:29:58 +00002456 // Apply the offsets.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002457 Address VTableField = LoadCXXThisAddress();
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002458
Ken Dyck9a8ad9b2011-03-23 00:45:26 +00002459 if (!NonVirtualOffset.isZero() || VirtualOffset)
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002460 VTableField = ApplyNonVirtualAndVirtualOffset(
2461 *this, VTableField, NonVirtualOffset, VirtualOffset, Vptr.VTableClass,
2462 Vptr.NearestVBase);
Anders Carlsson36fd6be2010-04-20 16:22:16 +00002463
Stephen Hines0e2c34f2015-03-23 12:09:02 -07002464 // Finally, store the address point. Use the same LLVM types as the field to
2465 // support optimization.
2466 llvm::Type *VTablePtrTy =
2467 llvm::FunctionType::get(CGM.Int32Ty, /*isVarArg=*/true)
2468 ->getPointerTo()
2469 ->getPointerTo();
2470 VTableField = Builder.CreateBitCast(VTableField, VTablePtrTy->getPointerTo());
2471 VTableAddressPoint = Builder.CreateBitCast(VTableAddressPoint, VTablePtrTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002472
Kostya Serebryany8cb4a072012-03-26 17:03:51 +00002473 llvm::StoreInst *Store = Builder.CreateStore(VTableAddressPoint, VTableField);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002474 CGM.DecorateInstructionWithTBAA(Store, CGM.getTBAAInfoForVTablePtr());
2475 if (CGM.getCodeGenOpts().OptimizationLevel > 0 &&
2476 CGM.getCodeGenOpts().StrictVTablePointers)
2477 CGM.DecorateInstructionWithInvariantGroup(Store, Vptr.VTableClass);
Anders Carlssond103f9f2010-03-28 19:40:00 +00002478}
2479
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002480CodeGenFunction::VPtrsVector
2481CodeGenFunction::getVTablePointers(const CXXRecordDecl *VTableClass) {
2482 CodeGenFunction::VPtrsVector VPtrsResult;
2483 VisitedVirtualBasesSetTy VBases;
2484 getVTablePointers(BaseSubobject(VTableClass, CharUnits::Zero()),
2485 /*NearestVBase=*/nullptr,
2486 /*OffsetFromNearestVBase=*/CharUnits::Zero(),
2487 /*BaseIsNonVirtualPrimaryBase=*/false, VTableClass, VBases,
2488 VPtrsResult);
2489 return VPtrsResult;
2490}
2491
2492void CodeGenFunction::getVTablePointers(BaseSubobject Base,
2493 const CXXRecordDecl *NearestVBase,
2494 CharUnits OffsetFromNearestVBase,
2495 bool BaseIsNonVirtualPrimaryBase,
2496 const CXXRecordDecl *VTableClass,
2497 VisitedVirtualBasesSetTy &VBases,
2498 VPtrsVector &Vptrs) {
Anders Carlsson603d6d12010-03-28 21:07:49 +00002499 // If this base is a non-virtual primary base the address point has already
2500 // been set.
2501 if (!BaseIsNonVirtualPrimaryBase) {
2502 // Initialize the vtable pointer for this base.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002503 VPtr Vptr = {Base, NearestVBase, OffsetFromNearestVBase, VTableClass};
2504 Vptrs.push_back(Vptr);
Anders Carlsson603d6d12010-03-28 21:07:49 +00002505 }
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002506
Anders Carlsson603d6d12010-03-28 21:07:49 +00002507 const CXXRecordDecl *RD = Base.getBase();
2508
2509 // Traverse bases.
Stephen Hines651f13c2014-04-23 16:59:28 -07002510 for (const auto &I : RD->bases()) {
Anders Carlsson603d6d12010-03-28 21:07:49 +00002511 CXXRecordDecl *BaseDecl
Stephen Hines651f13c2014-04-23 16:59:28 -07002512 = cast<CXXRecordDecl>(I.getType()->getAs<RecordType>()->getDecl());
Anders Carlsson603d6d12010-03-28 21:07:49 +00002513
2514 // Ignore classes without a vtable.
2515 if (!BaseDecl->isDynamicClass())
2516 continue;
2517
Ken Dyckd6fb21f2011-03-23 01:04:18 +00002518 CharUnits BaseOffset;
2519 CharUnits BaseOffsetFromNearestVBase;
Anders Carlsson14da9de2010-03-29 01:16:41 +00002520 bool BaseDeclIsNonVirtualPrimaryBase;
Anders Carlsson603d6d12010-03-28 21:07:49 +00002521
Stephen Hines651f13c2014-04-23 16:59:28 -07002522 if (I.isVirtual()) {
Anders Carlsson603d6d12010-03-28 21:07:49 +00002523 // Check if we've visited this virtual base before.
Stephen Hines176edba2014-12-01 14:53:08 -08002524 if (!VBases.insert(BaseDecl).second)
Anders Carlsson603d6d12010-03-28 21:07:49 +00002525 continue;
2526
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002527 const ASTRecordLayout &Layout =
Anders Carlsson603d6d12010-03-28 21:07:49 +00002528 getContext().getASTRecordLayout(VTableClass);
2529
Ken Dyckd6fb21f2011-03-23 01:04:18 +00002530 BaseOffset = Layout.getVBaseClassOffset(BaseDecl);
2531 BaseOffsetFromNearestVBase = CharUnits::Zero();
Anders Carlsson14da9de2010-03-29 01:16:41 +00002532 BaseDeclIsNonVirtualPrimaryBase = false;
Anders Carlsson603d6d12010-03-28 21:07:49 +00002533 } else {
2534 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
2535
Ken Dyck4230d522011-03-24 01:21:01 +00002536 BaseOffset = Base.getBaseOffset() + Layout.getBaseClassOffset(BaseDecl);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002537 BaseOffsetFromNearestVBase =
Ken Dyckd6fb21f2011-03-23 01:04:18 +00002538 OffsetFromNearestVBase + Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson14da9de2010-03-29 01:16:41 +00002539 BaseDeclIsNonVirtualPrimaryBase = Layout.getPrimaryBase() == BaseDecl;
Anders Carlsson603d6d12010-03-28 21:07:49 +00002540 }
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002541
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002542 getVTablePointers(
2543 BaseSubobject(BaseDecl, BaseOffset),
2544 I.isVirtual() ? BaseDecl : NearestVBase, BaseOffsetFromNearestVBase,
2545 BaseDeclIsNonVirtualPrimaryBase, VTableClass, VBases, Vptrs);
Anders Carlsson603d6d12010-03-28 21:07:49 +00002546 }
2547}
2548
2549void CodeGenFunction::InitializeVTablePointers(const CXXRecordDecl *RD) {
2550 // Ignore classes without a vtable.
Anders Carlsson07036902010-03-26 04:39:42 +00002551 if (!RD->isDynamicClass())
Anders Carlsson3b5ad222010-01-01 20:29:01 +00002552 return;
2553
Anders Carlsson603d6d12010-03-28 21:07:49 +00002554 // Initialize the vtable pointers for this class and all of its bases.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002555 if (CGM.getCXXABI().doStructorsInitializeVPtrs(RD))
2556 for (const VPtr &Vptr : getVTablePointers(RD))
2557 InitializeVTablePointer(Vptr);
Timur Iskhodzhanov5bd0d442013-10-09 18:16:58 +00002558
2559 if (RD->getNumVBases())
2560 CGM.getCXXABI().initializeHiddenVirtualInheritanceMembers(*this, RD);
Anders Carlsson3b5ad222010-01-01 20:29:01 +00002561}
Dan Gohman043fb9a2010-10-26 18:44:08 +00002562
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002563llvm::Value *CodeGenFunction::GetVTablePtr(Address This,
2564 llvm::Type *VTableTy,
2565 const CXXRecordDecl *RD) {
2566 Address VTablePtrSrc = Builder.CreateElementBitCast(This, VTableTy);
Kostya Serebryany8cb4a072012-03-26 17:03:51 +00002567 llvm::Instruction *VTable = Builder.CreateLoad(VTablePtrSrc, "vtable");
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002568 CGM.DecorateInstructionWithTBAA(VTable, CGM.getTBAAInfoForVTablePtr());
2569
2570 if (CGM.getCodeGenOpts().OptimizationLevel > 0 &&
2571 CGM.getCodeGenOpts().StrictVTablePointers)
2572 CGM.DecorateInstructionWithInvariantGroup(VTable, RD);
2573
Kostya Serebryany8cb4a072012-03-26 17:03:51 +00002574 return VTable;
Dan Gohman043fb9a2010-10-26 18:44:08 +00002575}
Anders Carlssona2447e02011-05-08 20:32:23 +00002576
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -07002577// If a class has a single non-virtual base and does not introduce or override
2578// virtual member functions or fields, it will have the same layout as its base.
2579// This function returns the least derived such class.
2580//
2581// Casting an instance of a base class to such a derived class is technically
2582// undefined behavior, but it is a relatively common hack for introducing member
2583// functions on class instances with specific properties (e.g. llvm::Operator)
2584// that works under most compilers and should not have security implications, so
2585// we allow it by default. It can be disabled with -fsanitize=cfi-cast-strict.
2586static const CXXRecordDecl *
2587LeastDerivedClassWithSameLayout(const CXXRecordDecl *RD) {
2588 if (!RD->field_empty())
2589 return RD;
2590
2591 if (RD->getNumVBases() != 0)
2592 return RD;
2593
2594 if (RD->getNumBases() != 1)
2595 return RD;
2596
2597 for (const CXXMethodDecl *MD : RD->methods()) {
2598 if (MD->isVirtual()) {
2599 // Virtual member functions are only ok if they are implicit destructors
2600 // because the implicit destructor will have the same semantics as the
2601 // base class's destructor if no fields are added.
2602 if (isa<CXXDestructorDecl>(MD) && MD->isImplicit())
2603 continue;
2604 return RD;
2605 }
2606 }
2607
2608 return LeastDerivedClassWithSameLayout(
2609 RD->bases_begin()->getType()->getAsCXXRecordDecl());
2610}
2611
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002612void CodeGenFunction::EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
2613 llvm::Value *VTable,
2614 SourceLocation Loc) {
2615 if (CGM.getCodeGenOpts().WholeProgramVTables &&
2616 CGM.HasHiddenLTOVisibility(RD)) {
2617 llvm::Metadata *MD =
2618 CGM.CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
2619 llvm::Value *TypeId =
2620 llvm::MetadataAsValue::get(CGM.getLLVMContext(), MD);
2621
2622 llvm::Value *CastedVTable = Builder.CreateBitCast(VTable, Int8PtrTy);
2623 llvm::Value *TypeTest =
2624 Builder.CreateCall(CGM.getIntrinsic(llvm::Intrinsic::type_test),
2625 {CastedVTable, TypeId});
2626 Builder.CreateCall(CGM.getIntrinsic(llvm::Intrinsic::assume), TypeTest);
2627 }
2628
2629 if (SanOpts.has(SanitizerKind::CFIVCall))
2630 EmitVTablePtrCheckForCall(RD, VTable, CodeGenFunction::CFITCK_VCall, Loc);
2631}
2632
2633void CodeGenFunction::EmitVTablePtrCheckForCall(const CXXRecordDecl *RD,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002634 llvm::Value *VTable,
2635 CFITypeCheckKind TCK,
2636 SourceLocation Loc) {
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07002637 if (!SanOpts.has(SanitizerKind::CFICastStrict))
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002638 RD = LeastDerivedClassWithSameLayout(RD);
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07002639
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002640 EmitVTablePtrCheck(RD, VTable, TCK, Loc);
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07002641}
2642
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -07002643void CodeGenFunction::EmitVTablePtrCheckForCast(QualType T,
2644 llvm::Value *Derived,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002645 bool MayBeNull,
2646 CFITypeCheckKind TCK,
2647 SourceLocation Loc) {
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -07002648 if (!getLangOpts().CPlusPlus)
2649 return;
2650
2651 auto *ClassTy = T->getAs<RecordType>();
2652 if (!ClassTy)
2653 return;
2654
2655 const CXXRecordDecl *ClassDecl = cast<CXXRecordDecl>(ClassTy->getDecl());
2656
2657 if (!ClassDecl->isCompleteDefinition() || !ClassDecl->isDynamicClass())
2658 return;
2659
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -07002660 if (!SanOpts.has(SanitizerKind::CFICastStrict))
2661 ClassDecl = LeastDerivedClassWithSameLayout(ClassDecl);
2662
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002663 llvm::BasicBlock *ContBlock = nullptr;
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -07002664
2665 if (MayBeNull) {
2666 llvm::Value *DerivedNotNull =
2667 Builder.CreateIsNotNull(Derived, "cast.nonnull");
2668
2669 llvm::BasicBlock *CheckBlock = createBasicBlock("cast.check");
2670 ContBlock = createBasicBlock("cast.cont");
2671
2672 Builder.CreateCondBr(DerivedNotNull, CheckBlock, ContBlock);
2673
2674 EmitBlock(CheckBlock);
2675 }
2676
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002677 llvm::Value *VTable =
2678 GetVTablePtr(Address(Derived, getPointerAlign()), Int8PtrTy, ClassDecl);
2679
2680 EmitVTablePtrCheck(ClassDecl, VTable, TCK, Loc);
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -07002681
2682 if (MayBeNull) {
2683 Builder.CreateBr(ContBlock);
2684 EmitBlock(ContBlock);
2685 }
2686}
2687
2688void CodeGenFunction::EmitVTablePtrCheck(const CXXRecordDecl *RD,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002689 llvm::Value *VTable,
2690 CFITypeCheckKind TCK,
2691 SourceLocation Loc) {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002692 if (!CGM.getCodeGenOpts().SanitizeCfiCrossDso &&
2693 !CGM.HasHiddenLTOVisibility(RD))
2694 return;
2695
2696 std::string TypeName = RD->getQualifiedNameAsString();
2697 if (getContext().getSanitizerBlacklist().isBlacklistedType(TypeName))
Stephen Hines0e2c34f2015-03-23 12:09:02 -07002698 return;
2699
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002700 SanitizerScope SanScope(this);
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002701 llvm::SanitizerStatKind SSK;
2702 switch (TCK) {
2703 case CFITCK_VCall:
2704 SSK = llvm::SanStat_CFI_VCall;
2705 break;
2706 case CFITCK_NVCall:
2707 SSK = llvm::SanStat_CFI_NVCall;
2708 break;
2709 case CFITCK_DerivedCast:
2710 SSK = llvm::SanStat_CFI_DerivedCast;
2711 break;
2712 case CFITCK_UnrelatedCast:
2713 SSK = llvm::SanStat_CFI_UnrelatedCast;
2714 break;
2715 case CFITCK_ICall:
2716 llvm_unreachable("not expecting CFITCK_ICall");
2717 }
2718 EmitSanitizerStatReport(SSK);
Stephen Hines0e2c34f2015-03-23 12:09:02 -07002719
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002720 llvm::Metadata *MD =
2721 CGM.CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002722 llvm::Value *TypeId = llvm::MetadataAsValue::get(getLLVMContext(), MD);
Stephen Hines0e2c34f2015-03-23 12:09:02 -07002723
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002724 llvm::Value *CastedVTable = Builder.CreateBitCast(VTable, Int8PtrTy);
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002725 llvm::Value *TypeTest = Builder.CreateCall(
2726 CGM.getIntrinsic(llvm::Intrinsic::type_test), {CastedVTable, TypeId});
Stephen Hines0e2c34f2015-03-23 12:09:02 -07002727
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002728 SanitizerMask M;
2729 switch (TCK) {
2730 case CFITCK_VCall:
2731 M = SanitizerKind::CFIVCall;
2732 break;
2733 case CFITCK_NVCall:
2734 M = SanitizerKind::CFINVCall;
2735 break;
2736 case CFITCK_DerivedCast:
2737 M = SanitizerKind::CFIDerivedCast;
2738 break;
2739 case CFITCK_UnrelatedCast:
2740 M = SanitizerKind::CFIUnrelatedCast;
2741 break;
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002742 case CFITCK_ICall:
2743 llvm_unreachable("not expecting CFITCK_ICall");
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002744 }
Stephen Hines0e2c34f2015-03-23 12:09:02 -07002745
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002746 llvm::Constant *StaticData[] = {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002747 llvm::ConstantInt::get(Int8Ty, TCK),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002748 EmitCheckSourceLocation(Loc),
2749 EmitCheckTypeDescriptor(QualType(RD->getTypeForDecl(), 0)),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002750 };
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002751
2752 auto CrossDsoTypeId = CGM.CreateCrossDsoCfiTypeId(MD);
2753 if (CGM.getCodeGenOpts().SanitizeCfiCrossDso && CrossDsoTypeId) {
2754 EmitCfiSlowPathCheck(M, TypeTest, CrossDsoTypeId, CastedVTable, StaticData);
2755 return;
2756 }
2757
2758 if (CGM.getCodeGenOpts().SanitizeTrap.has(M)) {
2759 EmitTrapCheck(TypeTest);
2760 return;
2761 }
2762
2763 llvm::Value *AllVtables = llvm::MetadataAsValue::get(
2764 CGM.getLLVMContext(),
2765 llvm::MDString::get(CGM.getLLVMContext(), "all-vtables"));
2766 llvm::Value *ValidVtable = Builder.CreateCall(
2767 CGM.getIntrinsic(llvm::Intrinsic::type_test), {CastedVTable, AllVtables});
2768 EmitCheck(std::make_pair(TypeTest, M), "cfi_check_fail", StaticData,
2769 {CastedVTable, ValidVtable});
2770}
2771
2772bool CodeGenFunction::ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD) {
2773 if (!CGM.getCodeGenOpts().WholeProgramVTables ||
2774 !SanOpts.has(SanitizerKind::CFIVCall) ||
2775 !CGM.getCodeGenOpts().SanitizeTrap.has(SanitizerKind::CFIVCall) ||
2776 !CGM.HasHiddenLTOVisibility(RD))
2777 return false;
2778
2779 std::string TypeName = RD->getQualifiedNameAsString();
2780 return !getContext().getSanitizerBlacklist().isBlacklistedType(TypeName);
2781}
2782
2783llvm::Value *CodeGenFunction::EmitVTableTypeCheckedLoad(
2784 const CXXRecordDecl *RD, llvm::Value *VTable, uint64_t VTableByteOffset) {
2785 SanitizerScope SanScope(this);
2786
2787 EmitSanitizerStatReport(llvm::SanStat_CFI_VCall);
2788
2789 llvm::Metadata *MD =
2790 CGM.CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
2791 llvm::Value *TypeId = llvm::MetadataAsValue::get(CGM.getLLVMContext(), MD);
2792
2793 llvm::Value *CastedVTable = Builder.CreateBitCast(VTable, Int8PtrTy);
2794 llvm::Value *CheckedLoad = Builder.CreateCall(
2795 CGM.getIntrinsic(llvm::Intrinsic::type_checked_load),
2796 {CastedVTable, llvm::ConstantInt::get(Int32Ty, VTableByteOffset),
2797 TypeId});
2798 llvm::Value *CheckResult = Builder.CreateExtractValue(CheckedLoad, 1);
2799
2800 EmitCheck(std::make_pair(CheckResult, SanitizerKind::CFIVCall),
2801 "cfi_check_fail", nullptr, nullptr);
2802
2803 return Builder.CreateBitCast(
2804 Builder.CreateExtractValue(CheckedLoad, 0),
2805 cast<llvm::PointerType>(VTable->getType())->getElementType());
Stephen Hines0e2c34f2015-03-23 12:09:02 -07002806}
Anders Carlssona2447e02011-05-08 20:32:23 +00002807
2808// FIXME: Ideally Expr::IgnoreParenNoopCasts should do this, but it doesn't do
2809// quite what we want.
2810static const Expr *skipNoOpCastsAndParens(const Expr *E) {
2811 while (true) {
2812 if (const ParenExpr *PE = dyn_cast<ParenExpr>(E)) {
2813 E = PE->getSubExpr();
2814 continue;
2815 }
2816
2817 if (const CastExpr *CE = dyn_cast<CastExpr>(E)) {
2818 if (CE->getCastKind() == CK_NoOp) {
2819 E = CE->getSubExpr();
2820 continue;
2821 }
2822 }
2823 if (const UnaryOperator *UO = dyn_cast<UnaryOperator>(E)) {
2824 if (UO->getOpcode() == UO_Extension) {
2825 E = UO->getSubExpr();
2826 continue;
2827 }
2828 }
2829 return E;
2830 }
2831}
2832
Benjamin Kramer9581ed02013-08-25 22:46:27 +00002833bool
2834CodeGenFunction::CanDevirtualizeMemberFunctionCall(const Expr *Base,
2835 const CXXMethodDecl *MD) {
2836 // When building with -fapple-kext, all calls must go through the vtable since
2837 // the kernel linker can do runtime patching of vtables.
2838 if (getLangOpts().AppleKext)
2839 return false;
2840
Anders Carlssona2447e02011-05-08 20:32:23 +00002841 // If the most derived class is marked final, we know that no subclass can
2842 // override this member function and so we can devirtualize it. For example:
2843 //
2844 // struct A { virtual void f(); }
2845 // struct B final : A { };
2846 //
2847 // void f(B *b) {
2848 // b->f();
2849 // }
2850 //
Benjamin Kramer9581ed02013-08-25 22:46:27 +00002851 const CXXRecordDecl *MostDerivedClassDecl = Base->getBestDynamicClassType();
Anders Carlssona2447e02011-05-08 20:32:23 +00002852 if (MostDerivedClassDecl->hasAttr<FinalAttr>())
2853 return true;
2854
2855 // If the member function is marked 'final', we know that it can't be
2856 // overridden and can therefore devirtualize it.
2857 if (MD->hasAttr<FinalAttr>())
2858 return true;
2859
2860 // Similarly, if the class itself is marked 'final' it can't be overridden
2861 // and we can therefore devirtualize the member function call.
2862 if (MD->getParent()->hasAttr<FinalAttr>())
2863 return true;
2864
2865 Base = skipNoOpCastsAndParens(Base);
2866 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Base)) {
2867 if (const VarDecl *VD = dyn_cast<VarDecl>(DRE->getDecl())) {
2868 // This is a record decl. We know the type and can devirtualize it.
2869 return VD->getType()->isRecordType();
2870 }
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002871
Anders Carlssona2447e02011-05-08 20:32:23 +00002872 return false;
2873 }
Benjamin Kramer9581ed02013-08-25 22:46:27 +00002874
2875 // We can devirtualize calls on an object accessed by a class member access
2876 // expression, since by C++11 [basic.life]p6 we know that it can't refer to
2877 // a derived class object constructed in the same location.
2878 if (const MemberExpr *ME = dyn_cast<MemberExpr>(Base))
2879 if (const ValueDecl *VD = dyn_cast<ValueDecl>(ME->getMemberDecl()))
2880 return VD->getType()->isRecordType();
2881
Anders Carlssona2447e02011-05-08 20:32:23 +00002882 // We can always devirtualize calls on temporary object expressions.
2883 if (isa<CXXConstructExpr>(Base))
2884 return true;
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002885
Anders Carlssona2447e02011-05-08 20:32:23 +00002886 // And calls on bound temporaries.
2887 if (isa<CXXBindTemporaryExpr>(Base))
2888 return true;
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002889
Anders Carlssona2447e02011-05-08 20:32:23 +00002890 // Check if this is a call expr that returns a record type.
2891 if (const CallExpr *CE = dyn_cast<CallExpr>(Base))
Stephen Hines0e2c34f2015-03-23 12:09:02 -07002892 return CE->getCallReturnType(getContext())->isRecordType();
Anders Carlssona2447e02011-05-08 20:32:23 +00002893
2894 // We can't devirtualize the call.
2895 return false;
2896}
2897
Faisal Valid6992ab2013-09-29 08:45:24 +00002898void CodeGenFunction::EmitForwardingCallToLambda(
2899 const CXXMethodDecl *callOperator,
2900 CallArgList &callArgs) {
Eli Friedman21f6ed92012-02-16 03:47:28 +00002901 // Get the address of the call operator.
John McCall0f3d0972012-07-07 06:41:13 +00002902 const CGFunctionInfo &calleeFnInfo =
2903 CGM.getTypes().arrangeCXXMethodDeclaration(callOperator);
2904 llvm::Value *callee =
2905 CGM.GetAddrOfFunction(GlobalDecl(callOperator),
2906 CGM.getTypes().GetFunctionType(calleeFnInfo));
Eli Friedman21f6ed92012-02-16 03:47:28 +00002907
John McCall0f3d0972012-07-07 06:41:13 +00002908 // Prepare the return slot.
2909 const FunctionProtoType *FPT =
2910 callOperator->getType()->castAs<FunctionProtoType>();
Stephen Hines651f13c2014-04-23 16:59:28 -07002911 QualType resultType = FPT->getReturnType();
John McCall0f3d0972012-07-07 06:41:13 +00002912 ReturnValueSlot returnSlot;
2913 if (!resultType->isVoidType() &&
2914 calleeFnInfo.getReturnInfo().getKind() == ABIArgInfo::Indirect &&
John McCall9d232c82013-03-07 21:37:08 +00002915 !hasScalarEvaluationKind(calleeFnInfo.getReturnType()))
John McCall0f3d0972012-07-07 06:41:13 +00002916 returnSlot = ReturnValueSlot(ReturnValue, resultType.isVolatileQualified());
2917
2918 // We don't need to separately arrange the call arguments because
2919 // the call can't be variadic anyway --- it's impossible to forward
2920 // variadic arguments.
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002921
Eli Friedman21f6ed92012-02-16 03:47:28 +00002922 // Now emit our call.
John McCall0f3d0972012-07-07 06:41:13 +00002923 RValue RV = EmitCall(calleeFnInfo, callee, returnSlot,
2924 callArgs, callOperator);
Eli Friedman21f6ed92012-02-16 03:47:28 +00002925
John McCall0f3d0972012-07-07 06:41:13 +00002926 // If necessary, copy the returned value into the slot.
2927 if (!resultType->isVoidType() && returnSlot.isNull())
2928 EmitReturnOfRValue(RV, resultType);
Eli Friedman50f089a2012-12-13 23:37:17 +00002929 else
2930 EmitBranchThroughCleanup(ReturnBlock);
Eli Friedman21f6ed92012-02-16 03:47:28 +00002931}
2932
Eli Friedman64bee652012-02-25 02:48:22 +00002933void CodeGenFunction::EmitLambdaBlockInvokeBody() {
2934 const BlockDecl *BD = BlockInfo->getBlockDecl();
2935 const VarDecl *variable = BD->capture_begin()->getVariable();
2936 const CXXRecordDecl *Lambda = variable->getType()->getAsCXXRecordDecl();
2937
2938 // Start building arguments for forwarding call
2939 CallArgList CallArgs;
2940
2941 QualType ThisType = getContext().getPointerType(getContext().getRecordType(Lambda));
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002942 Address ThisPtr = GetAddrOfBlockDecl(variable, false);
2943 CallArgs.add(RValue::get(ThisPtr.getPointer()), ThisType);
Eli Friedman64bee652012-02-25 02:48:22 +00002944
2945 // Add the rest of the parameters.
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002946 for (auto param : BD->parameters())
Nick Lewycky4ee7dc22013-10-02 02:29:49 +00002947 EmitDelegateCallArg(CallArgs, param, param->getLocStart());
Stephen Hines651f13c2014-04-23 16:59:28 -07002948
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002949 assert(!Lambda->isGenericLambda() &&
Faisal Valid6992ab2013-09-29 08:45:24 +00002950 "generic lambda interconversion to block not implemented");
2951 EmitForwardingCallToLambda(Lambda->getLambdaCallOperator(), CallArgs);
Eli Friedman64bee652012-02-25 02:48:22 +00002952}
2953
2954void CodeGenFunction::EmitLambdaToBlockPointerBody(FunctionArgList &Args) {
John McCallf5ebf9b2013-05-03 07:33:41 +00002955 if (cast<CXXMethodDecl>(CurCodeDecl)->isVariadic()) {
Eli Friedman64bee652012-02-25 02:48:22 +00002956 // FIXME: Making this work correctly is nasty because it requires either
2957 // cloning the body of the call operator or making the call operator forward.
John McCallf5ebf9b2013-05-03 07:33:41 +00002958 CGM.ErrorUnsupported(CurCodeDecl, "lambda conversion to variadic function");
Eli Friedman64bee652012-02-25 02:48:22 +00002959 return;
2960 }
2961
Richard Smith3cebc732013-11-05 09:12:18 +00002962 EmitFunctionBody(Args, cast<FunctionDecl>(CurGD.getDecl())->getBody());
Eli Friedman64bee652012-02-25 02:48:22 +00002963}
2964
2965void CodeGenFunction::EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD) {
2966 const CXXRecordDecl *Lambda = MD->getParent();
2967
2968 // Start building arguments for forwarding call
2969 CallArgList CallArgs;
2970
2971 QualType ThisType = getContext().getPointerType(getContext().getRecordType(Lambda));
2972 llvm::Value *ThisPtr = llvm::UndefValue::get(getTypes().ConvertType(ThisType));
2973 CallArgs.add(RValue::get(ThisPtr), ThisType);
2974
2975 // Add the rest of the parameters.
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002976 for (auto Param : MD->parameters())
Stephen Hines651f13c2014-04-23 16:59:28 -07002977 EmitDelegateCallArg(CallArgs, Param, Param->getLocStart());
2978
Faisal Valid6992ab2013-09-29 08:45:24 +00002979 const CXXMethodDecl *CallOp = Lambda->getLambdaCallOperator();
2980 // For a generic lambda, find the corresponding call operator specialization
2981 // to which the call to the static-invoker shall be forwarded.
2982 if (Lambda->isGenericLambda()) {
2983 assert(MD->isFunctionTemplateSpecialization());
2984 const TemplateArgumentList *TAL = MD->getTemplateSpecializationArgs();
2985 FunctionTemplateDecl *CallOpTemplate = CallOp->getDescribedFunctionTemplate();
Stephen Hines6bcf27b2014-05-29 04:14:42 -07002986 void *InsertPos = nullptr;
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -07002987 FunctionDecl *CorrespondingCallOpSpecialization =
Stephen Hinesc568f1e2014-07-21 00:47:37 -07002988 CallOpTemplate->findSpecialization(TAL->asArray(), InsertPos);
Faisal Valid6992ab2013-09-29 08:45:24 +00002989 assert(CorrespondingCallOpSpecialization);
2990 CallOp = cast<CXXMethodDecl>(CorrespondingCallOpSpecialization);
2991 }
2992 EmitForwardingCallToLambda(CallOp, CallArgs);
Eli Friedman64bee652012-02-25 02:48:22 +00002993}
2994
Douglas Gregor27dd7d92012-02-17 03:02:34 +00002995void CodeGenFunction::EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD) {
2996 if (MD->isVariadic()) {
Eli Friedman21f6ed92012-02-16 03:47:28 +00002997 // FIXME: Making this work correctly is nasty because it requires either
2998 // cloning the body of the call operator or making the call operator forward.
2999 CGM.ErrorUnsupported(MD, "lambda conversion to variadic function");
Eli Friedman64bee652012-02-25 02:48:22 +00003000 return;
Eli Friedman21f6ed92012-02-16 03:47:28 +00003001 }
3002
Douglas Gregor27dd7d92012-02-17 03:02:34 +00003003 EmitLambdaDelegatingInvokeBody(MD);
Eli Friedmanbd89f8c2012-02-16 01:37:33 +00003004}