1 //===--- VTableBuilder.cpp - C++ vtable layout builder --------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This contains code dealing with generation of the layout of virtual tables.
12 //===----------------------------------------------------------------------===//
14 #include "clang/AST/VTableBuilder.h"
15 #include "clang/AST/ASTContext.h"
16 #include "clang/AST/ASTDiagnostic.h"
17 #include "clang/AST/CXXInheritance.h"
18 #include "clang/AST/RecordLayout.h"
19 #include "clang/Basic/TargetInfo.h"
20 #include "llvm/ADT/SetOperations.h"
21 #include "llvm/ADT/SmallPtrSet.h"
22 #include "llvm/Support/Format.h"
23 #include "llvm/Support/raw_ostream.h"
27 using namespace clang;
29 #define DUMP_OVERRIDERS 0
33 /// BaseOffset - Represents an offset from a derived class to a direct or
34 /// indirect base class.
36 /// DerivedClass - The derived class.
37 const CXXRecordDecl *DerivedClass;
39 /// VirtualBase - If the path from the derived class to the base class
40 /// involves virtual base classes, this holds the declaration of the last
41 /// virtual base in this path (i.e. closest to the base class).
42 const CXXRecordDecl *VirtualBase;
44 /// NonVirtualOffset - The offset from the derived class to the base class.
45 /// (Or the offset from the virtual base class to the base class, if the
46 /// path from the derived class to the base class involves a virtual base
48 CharUnits NonVirtualOffset;
50 BaseOffset() : DerivedClass(nullptr), VirtualBase(nullptr),
51 NonVirtualOffset(CharUnits::Zero()) { }
52 BaseOffset(const CXXRecordDecl *DerivedClass,
53 const CXXRecordDecl *VirtualBase, CharUnits NonVirtualOffset)
54 : DerivedClass(DerivedClass), VirtualBase(VirtualBase),
55 NonVirtualOffset(NonVirtualOffset) { }
57 bool isEmpty() const { return NonVirtualOffset.isZero() && !VirtualBase; }
60 /// FinalOverriders - Contains the final overrider member functions for all
61 /// member functions in the base subobjects of a class.
62 class FinalOverriders {
64 /// OverriderInfo - Information about a final overrider.
65 struct OverriderInfo {
66 /// Method - The method decl of the overrider.
67 const CXXMethodDecl *Method;
69 /// VirtualBase - The virtual base class subobject of this overrider.
70 /// Note that this records the closest derived virtual base class subobject.
71 const CXXRecordDecl *VirtualBase;
73 /// Offset - the base offset of the overrider's parent in the layout class.
76 OverriderInfo() : Method(nullptr), VirtualBase(nullptr),
77 Offset(CharUnits::Zero()) { }
81 /// MostDerivedClass - The most derived class for which the final overriders
83 const CXXRecordDecl *MostDerivedClass;
85 /// MostDerivedClassOffset - If we're building final overriders for a
86 /// construction vtable, this holds the offset from the layout class to the
87 /// most derived class.
88 const CharUnits MostDerivedClassOffset;
90 /// LayoutClass - The class we're using for layout information. Will be
91 /// different than the most derived class if the final overriders are for a
92 /// construction vtable.
93 const CXXRecordDecl *LayoutClass;
97 /// MostDerivedClassLayout - the AST record layout of the most derived class.
98 const ASTRecordLayout &MostDerivedClassLayout;
100 /// MethodBaseOffsetPairTy - Uniquely identifies a member function
101 /// in a base subobject.
102 typedef std::pair<const CXXMethodDecl *, CharUnits> MethodBaseOffsetPairTy;
104 typedef llvm::DenseMap<MethodBaseOffsetPairTy,
105 OverriderInfo> OverridersMapTy;
107 /// OverridersMap - The final overriders for all virtual member functions of
108 /// all the base subobjects of the most derived class.
109 OverridersMapTy OverridersMap;
111 /// SubobjectsToOffsetsMapTy - A mapping from a base subobject (represented
112 /// as a record decl and a subobject number) and its offsets in the most
113 /// derived class as well as the layout class.
114 typedef llvm::DenseMap<std::pair<const CXXRecordDecl *, unsigned>,
115 CharUnits> SubobjectOffsetMapTy;
117 typedef llvm::DenseMap<const CXXRecordDecl *, unsigned> SubobjectCountMapTy;
119 /// ComputeBaseOffsets - Compute the offsets for all base subobjects of the
121 void ComputeBaseOffsets(BaseSubobject Base, bool IsVirtual,
122 CharUnits OffsetInLayoutClass,
123 SubobjectOffsetMapTy &SubobjectOffsets,
124 SubobjectOffsetMapTy &SubobjectLayoutClassOffsets,
125 SubobjectCountMapTy &SubobjectCounts);
127 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
129 /// dump - dump the final overriders for a base subobject, and all its direct
130 /// and indirect base subobjects.
131 void dump(raw_ostream &Out, BaseSubobject Base,
132 VisitedVirtualBasesSetTy& VisitedVirtualBases);
135 FinalOverriders(const CXXRecordDecl *MostDerivedClass,
136 CharUnits MostDerivedClassOffset,
137 const CXXRecordDecl *LayoutClass);
139 /// getOverrider - Get the final overrider for the given method declaration in
140 /// the subobject with the given base offset.
141 OverriderInfo getOverrider(const CXXMethodDecl *MD,
142 CharUnits BaseOffset) const {
143 assert(OverridersMap.count(std::make_pair(MD, BaseOffset)) &&
144 "Did not find overrider!");
146 return OverridersMap.lookup(std::make_pair(MD, BaseOffset));
149 /// dump - dump the final overriders.
151 VisitedVirtualBasesSetTy VisitedVirtualBases;
152 dump(llvm::errs(), BaseSubobject(MostDerivedClass, CharUnits::Zero()),
153 VisitedVirtualBases);
158 FinalOverriders::FinalOverriders(const CXXRecordDecl *MostDerivedClass,
159 CharUnits MostDerivedClassOffset,
160 const CXXRecordDecl *LayoutClass)
161 : MostDerivedClass(MostDerivedClass),
162 MostDerivedClassOffset(MostDerivedClassOffset), LayoutClass(LayoutClass),
163 Context(MostDerivedClass->getASTContext()),
164 MostDerivedClassLayout(Context.getASTRecordLayout(MostDerivedClass)) {
166 // Compute base offsets.
167 SubobjectOffsetMapTy SubobjectOffsets;
168 SubobjectOffsetMapTy SubobjectLayoutClassOffsets;
169 SubobjectCountMapTy SubobjectCounts;
170 ComputeBaseOffsets(BaseSubobject(MostDerivedClass, CharUnits::Zero()),
172 MostDerivedClassOffset,
173 SubobjectOffsets, SubobjectLayoutClassOffsets,
176 // Get the final overriders.
177 CXXFinalOverriderMap FinalOverriders;
178 MostDerivedClass->getFinalOverriders(FinalOverriders);
180 for (const auto &Overrider : FinalOverriders) {
181 const CXXMethodDecl *MD = Overrider.first;
182 const OverridingMethods &Methods = Overrider.second;
184 for (const auto &M : Methods) {
185 unsigned SubobjectNumber = M.first;
186 assert(SubobjectOffsets.count(std::make_pair(MD->getParent(),
188 "Did not find subobject offset!");
190 CharUnits BaseOffset = SubobjectOffsets[std::make_pair(MD->getParent(),
193 assert(M.second.size() == 1 && "Final overrider is not unique!");
194 const UniqueVirtualMethod &Method = M.second.front();
196 const CXXRecordDecl *OverriderRD = Method.Method->getParent();
197 assert(SubobjectLayoutClassOffsets.count(
198 std::make_pair(OverriderRD, Method.Subobject))
199 && "Did not find subobject offset!");
200 CharUnits OverriderOffset =
201 SubobjectLayoutClassOffsets[std::make_pair(OverriderRD,
204 OverriderInfo& Overrider = OverridersMap[std::make_pair(MD, BaseOffset)];
205 assert(!Overrider.Method && "Overrider should not exist yet!");
207 Overrider.Offset = OverriderOffset;
208 Overrider.Method = Method.Method;
209 Overrider.VirtualBase = Method.InVirtualSubobject;
214 // And dump them (for now).
219 static BaseOffset ComputeBaseOffset(const ASTContext &Context,
220 const CXXRecordDecl *DerivedRD,
221 const CXXBasePath &Path) {
222 CharUnits NonVirtualOffset = CharUnits::Zero();
224 unsigned NonVirtualStart = 0;
225 const CXXRecordDecl *VirtualBase = nullptr;
227 // First, look for the virtual base class.
228 for (int I = Path.size(), E = 0; I != E; --I) {
229 const CXXBasePathElement &Element = Path[I - 1];
231 if (Element.Base->isVirtual()) {
233 QualType VBaseType = Element.Base->getType();
234 VirtualBase = VBaseType->getAsCXXRecordDecl();
239 // Now compute the non-virtual offset.
240 for (unsigned I = NonVirtualStart, E = Path.size(); I != E; ++I) {
241 const CXXBasePathElement &Element = Path[I];
243 // Check the base class offset.
244 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Element.Class);
246 const CXXRecordDecl *Base = Element.Base->getType()->getAsCXXRecordDecl();
248 NonVirtualOffset += Layout.getBaseClassOffset(Base);
251 // FIXME: This should probably use CharUnits or something. Maybe we should
252 // even change the base offsets in ASTRecordLayout to be specified in
254 return BaseOffset(DerivedRD, VirtualBase, NonVirtualOffset);
258 static BaseOffset ComputeBaseOffset(const ASTContext &Context,
259 const CXXRecordDecl *BaseRD,
260 const CXXRecordDecl *DerivedRD) {
261 CXXBasePaths Paths(/*FindAmbiguities=*/false,
262 /*RecordPaths=*/true, /*DetectVirtual=*/false);
264 if (!DerivedRD->isDerivedFrom(BaseRD, Paths))
265 llvm_unreachable("Class must be derived from the passed in base class!");
267 return ComputeBaseOffset(Context, DerivedRD, Paths.front());
271 ComputeReturnAdjustmentBaseOffset(ASTContext &Context,
272 const CXXMethodDecl *DerivedMD,
273 const CXXMethodDecl *BaseMD) {
274 const FunctionType *BaseFT = BaseMD->getType()->getAs<FunctionType>();
275 const FunctionType *DerivedFT = DerivedMD->getType()->getAs<FunctionType>();
277 // Canonicalize the return types.
278 CanQualType CanDerivedReturnType =
279 Context.getCanonicalType(DerivedFT->getReturnType());
280 CanQualType CanBaseReturnType =
281 Context.getCanonicalType(BaseFT->getReturnType());
283 assert(CanDerivedReturnType->getTypeClass() ==
284 CanBaseReturnType->getTypeClass() &&
285 "Types must have same type class!");
287 if (CanDerivedReturnType == CanBaseReturnType) {
288 // No adjustment needed.
292 if (isa<ReferenceType>(CanDerivedReturnType)) {
293 CanDerivedReturnType =
294 CanDerivedReturnType->getAs<ReferenceType>()->getPointeeType();
296 CanBaseReturnType->getAs<ReferenceType>()->getPointeeType();
297 } else if (isa<PointerType>(CanDerivedReturnType)) {
298 CanDerivedReturnType =
299 CanDerivedReturnType->getAs<PointerType>()->getPointeeType();
301 CanBaseReturnType->getAs<PointerType>()->getPointeeType();
303 llvm_unreachable("Unexpected return type!");
306 // We need to compare unqualified types here; consider
307 // const T *Base::foo();
308 // T *Derived::foo();
309 if (CanDerivedReturnType.getUnqualifiedType() ==
310 CanBaseReturnType.getUnqualifiedType()) {
311 // No adjustment needed.
315 const CXXRecordDecl *DerivedRD =
316 cast<CXXRecordDecl>(cast<RecordType>(CanDerivedReturnType)->getDecl());
318 const CXXRecordDecl *BaseRD =
319 cast<CXXRecordDecl>(cast<RecordType>(CanBaseReturnType)->getDecl());
321 return ComputeBaseOffset(Context, BaseRD, DerivedRD);
325 FinalOverriders::ComputeBaseOffsets(BaseSubobject Base, bool IsVirtual,
326 CharUnits OffsetInLayoutClass,
327 SubobjectOffsetMapTy &SubobjectOffsets,
328 SubobjectOffsetMapTy &SubobjectLayoutClassOffsets,
329 SubobjectCountMapTy &SubobjectCounts) {
330 const CXXRecordDecl *RD = Base.getBase();
332 unsigned SubobjectNumber = 0;
334 SubobjectNumber = ++SubobjectCounts[RD];
336 // Set up the subobject to offset mapping.
337 assert(!SubobjectOffsets.count(std::make_pair(RD, SubobjectNumber))
338 && "Subobject offset already exists!");
339 assert(!SubobjectLayoutClassOffsets.count(std::make_pair(RD, SubobjectNumber))
340 && "Subobject offset already exists!");
342 SubobjectOffsets[std::make_pair(RD, SubobjectNumber)] = Base.getBaseOffset();
343 SubobjectLayoutClassOffsets[std::make_pair(RD, SubobjectNumber)] =
346 // Traverse our bases.
347 for (const auto &B : RD->bases()) {
348 const CXXRecordDecl *BaseDecl = B.getType()->getAsCXXRecordDecl();
350 CharUnits BaseOffset;
351 CharUnits BaseOffsetInLayoutClass;
353 // Check if we've visited this virtual base before.
354 if (SubobjectOffsets.count(std::make_pair(BaseDecl, 0)))
357 const ASTRecordLayout &LayoutClassLayout =
358 Context.getASTRecordLayout(LayoutClass);
360 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
361 BaseOffsetInLayoutClass =
362 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
364 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
365 CharUnits Offset = Layout.getBaseClassOffset(BaseDecl);
367 BaseOffset = Base.getBaseOffset() + Offset;
368 BaseOffsetInLayoutClass = OffsetInLayoutClass + Offset;
371 ComputeBaseOffsets(BaseSubobject(BaseDecl, BaseOffset),
372 B.isVirtual(), BaseOffsetInLayoutClass,
373 SubobjectOffsets, SubobjectLayoutClassOffsets,
378 void FinalOverriders::dump(raw_ostream &Out, BaseSubobject Base,
379 VisitedVirtualBasesSetTy &VisitedVirtualBases) {
380 const CXXRecordDecl *RD = Base.getBase();
381 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
383 for (const auto &B : RD->bases()) {
384 const CXXRecordDecl *BaseDecl = B.getType()->getAsCXXRecordDecl();
386 // Ignore bases that don't have any virtual member functions.
387 if (!BaseDecl->isPolymorphic())
390 CharUnits BaseOffset;
392 if (!VisitedVirtualBases.insert(BaseDecl).second) {
393 // We've visited this base before.
397 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
399 BaseOffset = Layout.getBaseClassOffset(BaseDecl) + Base.getBaseOffset();
402 dump(Out, BaseSubobject(BaseDecl, BaseOffset), VisitedVirtualBases);
405 Out << "Final overriders for (";
406 RD->printQualifiedName(Out);
408 Out << Base.getBaseOffset().getQuantity() << ")\n";
410 // Now dump the overriders for this base subobject.
411 for (const auto *MD : RD->methods()) {
412 if (!MD->isVirtual())
414 MD = MD->getCanonicalDecl();
416 OverriderInfo Overrider = getOverrider(MD, Base.getBaseOffset());
419 MD->printQualifiedName(Out);
421 Overrider.Method->printQualifiedName(Out);
422 Out << ", " << Overrider.Offset.getQuantity() << ')';
425 if (!Overrider.Method->isPure())
426 Offset = ComputeReturnAdjustmentBaseOffset(Context, Overrider.Method, MD);
428 if (!Offset.isEmpty()) {
429 Out << " [ret-adj: ";
430 if (Offset.VirtualBase) {
431 Offset.VirtualBase->printQualifiedName(Out);
435 Out << Offset.NonVirtualOffset.getQuantity() << " nv]";
442 /// VCallOffsetMap - Keeps track of vcall offsets when building a vtable.
443 struct VCallOffsetMap {
445 typedef std::pair<const CXXMethodDecl *, CharUnits> MethodAndOffsetPairTy;
447 /// Offsets - Keeps track of methods and their offsets.
448 // FIXME: This should be a real map and not a vector.
449 SmallVector<MethodAndOffsetPairTy, 16> Offsets;
451 /// MethodsCanShareVCallOffset - Returns whether two virtual member functions
452 /// can share the same vcall offset.
453 static bool MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
454 const CXXMethodDecl *RHS);
457 /// AddVCallOffset - Adds a vcall offset to the map. Returns true if the
458 /// add was successful, or false if there was already a member function with
459 /// the same signature in the map.
460 bool AddVCallOffset(const CXXMethodDecl *MD, CharUnits OffsetOffset);
462 /// getVCallOffsetOffset - Returns the vcall offset offset (relative to the
463 /// vtable address point) for the given virtual member function.
464 CharUnits getVCallOffsetOffset(const CXXMethodDecl *MD);
466 // empty - Return whether the offset map is empty or not.
467 bool empty() const { return Offsets.empty(); }
470 static bool HasSameVirtualSignature(const CXXMethodDecl *LHS,
471 const CXXMethodDecl *RHS) {
472 const FunctionProtoType *LT =
473 cast<FunctionProtoType>(LHS->getType().getCanonicalType());
474 const FunctionProtoType *RT =
475 cast<FunctionProtoType>(RHS->getType().getCanonicalType());
477 // Fast-path matches in the canonical types.
478 if (LT == RT) return true;
480 // Force the signatures to match. We can't rely on the overrides
481 // list here because there isn't necessarily an inheritance
482 // relationship between the two methods.
483 if (LT->getTypeQuals() != RT->getTypeQuals())
485 return LT->getParamTypes() == RT->getParamTypes();
488 bool VCallOffsetMap::MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
489 const CXXMethodDecl *RHS) {
490 assert(LHS->isVirtual() && "LHS must be virtual!");
491 assert(RHS->isVirtual() && "LHS must be virtual!");
493 // A destructor can share a vcall offset with another destructor.
494 if (isa<CXXDestructorDecl>(LHS))
495 return isa<CXXDestructorDecl>(RHS);
497 // FIXME: We need to check more things here.
499 // The methods must have the same name.
500 DeclarationName LHSName = LHS->getDeclName();
501 DeclarationName RHSName = RHS->getDeclName();
502 if (LHSName != RHSName)
505 // And the same signatures.
506 return HasSameVirtualSignature(LHS, RHS);
509 bool VCallOffsetMap::AddVCallOffset(const CXXMethodDecl *MD,
510 CharUnits OffsetOffset) {
511 // Check if we can reuse an offset.
512 for (const auto &OffsetPair : Offsets) {
513 if (MethodsCanShareVCallOffset(OffsetPair.first, MD))
518 Offsets.push_back(MethodAndOffsetPairTy(MD, OffsetOffset));
522 CharUnits VCallOffsetMap::getVCallOffsetOffset(const CXXMethodDecl *MD) {
523 // Look for an offset.
524 for (const auto &OffsetPair : Offsets) {
525 if (MethodsCanShareVCallOffset(OffsetPair.first, MD))
526 return OffsetPair.second;
529 llvm_unreachable("Should always find a vcall offset offset!");
532 /// VCallAndVBaseOffsetBuilder - Class for building vcall and vbase offsets.
533 class VCallAndVBaseOffsetBuilder {
535 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits>
536 VBaseOffsetOffsetsMapTy;
539 /// MostDerivedClass - The most derived class for which we're building vcall
540 /// and vbase offsets.
541 const CXXRecordDecl *MostDerivedClass;
543 /// LayoutClass - The class we're using for layout information. Will be
544 /// different than the most derived class if we're building a construction
546 const CXXRecordDecl *LayoutClass;
548 /// Context - The ASTContext which we will use for layout information.
551 /// Components - vcall and vbase offset components
552 typedef SmallVector<VTableComponent, 64> VTableComponentVectorTy;
553 VTableComponentVectorTy Components;
555 /// VisitedVirtualBases - Visited virtual bases.
556 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
558 /// VCallOffsets - Keeps track of vcall offsets.
559 VCallOffsetMap VCallOffsets;
562 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets,
563 /// relative to the address point.
564 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
566 /// FinalOverriders - The final overriders of the most derived class.
567 /// (Can be null when we're not building a vtable of the most derived class).
568 const FinalOverriders *Overriders;
570 /// AddVCallAndVBaseOffsets - Add vcall offsets and vbase offsets for the
571 /// given base subobject.
572 void AddVCallAndVBaseOffsets(BaseSubobject Base, bool BaseIsVirtual,
573 CharUnits RealBaseOffset);
575 /// AddVCallOffsets - Add vcall offsets for the given base subobject.
576 void AddVCallOffsets(BaseSubobject Base, CharUnits VBaseOffset);
578 /// AddVBaseOffsets - Add vbase offsets for the given class.
579 void AddVBaseOffsets(const CXXRecordDecl *Base,
580 CharUnits OffsetInLayoutClass);
582 /// getCurrentOffsetOffset - Get the current vcall or vbase offset offset in
583 /// chars, relative to the vtable address point.
584 CharUnits getCurrentOffsetOffset() const;
587 VCallAndVBaseOffsetBuilder(const CXXRecordDecl *MostDerivedClass,
588 const CXXRecordDecl *LayoutClass,
589 const FinalOverriders *Overriders,
590 BaseSubobject Base, bool BaseIsVirtual,
591 CharUnits OffsetInLayoutClass)
592 : MostDerivedClass(MostDerivedClass), LayoutClass(LayoutClass),
593 Context(MostDerivedClass->getASTContext()), Overriders(Overriders) {
595 // Add vcall and vbase offsets.
596 AddVCallAndVBaseOffsets(Base, BaseIsVirtual, OffsetInLayoutClass);
599 /// Methods for iterating over the components.
600 typedef VTableComponentVectorTy::const_reverse_iterator const_iterator;
601 const_iterator components_begin() const { return Components.rbegin(); }
602 const_iterator components_end() const { return Components.rend(); }
604 const VCallOffsetMap &getVCallOffsets() const { return VCallOffsets; }
605 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
606 return VBaseOffsetOffsets;
611 VCallAndVBaseOffsetBuilder::AddVCallAndVBaseOffsets(BaseSubobject Base,
613 CharUnits RealBaseOffset) {
614 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base.getBase());
616 // Itanium C++ ABI 2.5.2:
617 // ..in classes sharing a virtual table with a primary base class, the vcall
618 // and vbase offsets added by the derived class all come before the vcall
619 // and vbase offsets required by the base class, so that the latter may be
620 // laid out as required by the base class without regard to additions from
621 // the derived class(es).
623 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
624 // emit them for the primary base first).
625 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
626 bool PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
628 CharUnits PrimaryBaseOffset;
630 // Get the base offset of the primary base.
631 if (PrimaryBaseIsVirtual) {
632 assert(Layout.getVBaseClassOffset(PrimaryBase).isZero() &&
633 "Primary vbase should have a zero offset!");
635 const ASTRecordLayout &MostDerivedClassLayout =
636 Context.getASTRecordLayout(MostDerivedClass);
639 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
641 assert(Layout.getBaseClassOffset(PrimaryBase).isZero() &&
642 "Primary base should have a zero offset!");
644 PrimaryBaseOffset = Base.getBaseOffset();
647 AddVCallAndVBaseOffsets(
648 BaseSubobject(PrimaryBase,PrimaryBaseOffset),
649 PrimaryBaseIsVirtual, RealBaseOffset);
652 AddVBaseOffsets(Base.getBase(), RealBaseOffset);
654 // We only want to add vcall offsets for virtual bases.
656 AddVCallOffsets(Base, RealBaseOffset);
659 CharUnits VCallAndVBaseOffsetBuilder::getCurrentOffsetOffset() const {
660 // OffsetIndex is the index of this vcall or vbase offset, relative to the
661 // vtable address point. (We subtract 3 to account for the information just
662 // above the address point, the RTTI info, the offset to top, and the
663 // vcall offset itself).
664 int64_t OffsetIndex = -(int64_t)(3 + Components.size());
666 CharUnits PointerWidth =
667 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
668 CharUnits OffsetOffset = PointerWidth * OffsetIndex;
672 void VCallAndVBaseOffsetBuilder::AddVCallOffsets(BaseSubobject Base,
673 CharUnits VBaseOffset) {
674 const CXXRecordDecl *RD = Base.getBase();
675 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
677 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
679 // Handle the primary base first.
680 // We only want to add vcall offsets if the base is non-virtual; a virtual
681 // primary base will have its vcall and vbase offsets emitted already.
682 if (PrimaryBase && !Layout.isPrimaryBaseVirtual()) {
683 // Get the base offset of the primary base.
684 assert(Layout.getBaseClassOffset(PrimaryBase).isZero() &&
685 "Primary base should have a zero offset!");
687 AddVCallOffsets(BaseSubobject(PrimaryBase, Base.getBaseOffset()),
691 // Add the vcall offsets.
692 for (const auto *MD : RD->methods()) {
693 if (!MD->isVirtual())
695 MD = MD->getCanonicalDecl();
697 CharUnits OffsetOffset = getCurrentOffsetOffset();
699 // Don't add a vcall offset if we already have one for this member function
701 if (!VCallOffsets.AddVCallOffset(MD, OffsetOffset))
704 CharUnits Offset = CharUnits::Zero();
707 // Get the final overrider.
708 FinalOverriders::OverriderInfo Overrider =
709 Overriders->getOverrider(MD, Base.getBaseOffset());
711 /// The vcall offset is the offset from the virtual base to the object
712 /// where the function was overridden.
713 Offset = Overrider.Offset - VBaseOffset;
716 Components.push_back(
717 VTableComponent::MakeVCallOffset(Offset));
720 // And iterate over all non-virtual bases (ignoring the primary base).
721 for (const auto &B : RD->bases()) {
725 const CXXRecordDecl *BaseDecl = B.getType()->getAsCXXRecordDecl();
726 if (BaseDecl == PrimaryBase)
729 // Get the base offset of this base.
730 CharUnits BaseOffset = Base.getBaseOffset() +
731 Layout.getBaseClassOffset(BaseDecl);
733 AddVCallOffsets(BaseSubobject(BaseDecl, BaseOffset),
739 VCallAndVBaseOffsetBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
740 CharUnits OffsetInLayoutClass) {
741 const ASTRecordLayout &LayoutClassLayout =
742 Context.getASTRecordLayout(LayoutClass);
744 // Add vbase offsets.
745 for (const auto &B : RD->bases()) {
746 const CXXRecordDecl *BaseDecl = B.getType()->getAsCXXRecordDecl();
748 // Check if this is a virtual base that we haven't visited before.
749 if (B.isVirtual() && VisitedVirtualBases.insert(BaseDecl).second) {
751 LayoutClassLayout.getVBaseClassOffset(BaseDecl) - OffsetInLayoutClass;
753 // Add the vbase offset offset.
754 assert(!VBaseOffsetOffsets.count(BaseDecl) &&
755 "vbase offset offset already exists!");
757 CharUnits VBaseOffsetOffset = getCurrentOffsetOffset();
758 VBaseOffsetOffsets.insert(
759 std::make_pair(BaseDecl, VBaseOffsetOffset));
761 Components.push_back(
762 VTableComponent::MakeVBaseOffset(Offset));
765 // Check the base class looking for more vbase offsets.
766 AddVBaseOffsets(BaseDecl, OffsetInLayoutClass);
770 /// ItaniumVTableBuilder - Class for building vtable layout information.
771 class ItaniumVTableBuilder {
773 /// PrimaryBasesSetVectorTy - A set vector of direct and indirect
775 typedef llvm::SmallSetVector<const CXXRecordDecl *, 8>
776 PrimaryBasesSetVectorTy;
778 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits>
779 VBaseOffsetOffsetsMapTy;
781 typedef VTableLayout::AddressPointsMapTy AddressPointsMapTy;
783 typedef llvm::DenseMap<GlobalDecl, int64_t> MethodVTableIndicesTy;
786 /// VTables - Global vtable information.
787 ItaniumVTableContext &VTables;
789 /// MostDerivedClass - The most derived class for which we're building this
791 const CXXRecordDecl *MostDerivedClass;
793 /// MostDerivedClassOffset - If we're building a construction vtable, this
794 /// holds the offset from the layout class to the most derived class.
795 const CharUnits MostDerivedClassOffset;
797 /// MostDerivedClassIsVirtual - Whether the most derived class is a virtual
798 /// base. (This only makes sense when building a construction vtable).
799 bool MostDerivedClassIsVirtual;
801 /// LayoutClass - The class we're using for layout information. Will be
802 /// different than the most derived class if we're building a construction
804 const CXXRecordDecl *LayoutClass;
806 /// Context - The ASTContext which we will use for layout information.
809 /// FinalOverriders - The final overriders of the most derived class.
810 const FinalOverriders Overriders;
812 /// VCallOffsetsForVBases - Keeps track of vcall offsets for the virtual
813 /// bases in this vtable.
814 llvm::DenseMap<const CXXRecordDecl *, VCallOffsetMap> VCallOffsetsForVBases;
816 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets for
817 /// the most derived class.
818 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
820 /// Components - The components of the vtable being built.
821 SmallVector<VTableComponent, 64> Components;
823 /// AddressPoints - Address points for the vtable being built.
824 AddressPointsMapTy AddressPoints;
826 /// MethodInfo - Contains information about a method in a vtable.
827 /// (Used for computing 'this' pointer adjustment thunks.
829 /// BaseOffset - The base offset of this method.
830 const CharUnits BaseOffset;
832 /// BaseOffsetInLayoutClass - The base offset in the layout class of this
834 const CharUnits BaseOffsetInLayoutClass;
836 /// VTableIndex - The index in the vtable that this method has.
837 /// (For destructors, this is the index of the complete destructor).
838 const uint64_t VTableIndex;
840 MethodInfo(CharUnits BaseOffset, CharUnits BaseOffsetInLayoutClass,
841 uint64_t VTableIndex)
842 : BaseOffset(BaseOffset),
843 BaseOffsetInLayoutClass(BaseOffsetInLayoutClass),
844 VTableIndex(VTableIndex) { }
847 : BaseOffset(CharUnits::Zero()),
848 BaseOffsetInLayoutClass(CharUnits::Zero()),
852 typedef llvm::DenseMap<const CXXMethodDecl *, MethodInfo> MethodInfoMapTy;
854 /// MethodInfoMap - The information for all methods in the vtable we're
855 /// currently building.
856 MethodInfoMapTy MethodInfoMap;
858 /// MethodVTableIndices - Contains the index (relative to the vtable address
859 /// point) where the function pointer for a virtual function is stored.
860 MethodVTableIndicesTy MethodVTableIndices;
862 typedef llvm::DenseMap<uint64_t, ThunkInfo> VTableThunksMapTy;
864 /// VTableThunks - The thunks by vtable index in the vtable currently being
866 VTableThunksMapTy VTableThunks;
868 typedef SmallVector<ThunkInfo, 1> ThunkInfoVectorTy;
869 typedef llvm::DenseMap<const CXXMethodDecl *, ThunkInfoVectorTy> ThunksMapTy;
871 /// Thunks - A map that contains all the thunks needed for all methods in the
872 /// most derived class for which the vtable is currently being built.
875 /// AddThunk - Add a thunk for the given method.
876 void AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk);
878 /// ComputeThisAdjustments - Compute the 'this' pointer adjustments for the
879 /// part of the vtable we're currently building.
880 void ComputeThisAdjustments();
882 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
884 /// PrimaryVirtualBases - All known virtual bases who are a primary base of
886 VisitedVirtualBasesSetTy PrimaryVirtualBases;
888 /// ComputeReturnAdjustment - Compute the return adjustment given a return
889 /// adjustment base offset.
890 ReturnAdjustment ComputeReturnAdjustment(BaseOffset Offset);
892 /// ComputeThisAdjustmentBaseOffset - Compute the base offset for adjusting
893 /// the 'this' pointer from the base subobject to the derived subobject.
894 BaseOffset ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
895 BaseSubobject Derived) const;
897 /// ComputeThisAdjustment - Compute the 'this' pointer adjustment for the
898 /// given virtual member function, its offset in the layout class and its
901 ComputeThisAdjustment(const CXXMethodDecl *MD,
902 CharUnits BaseOffsetInLayoutClass,
903 FinalOverriders::OverriderInfo Overrider);
905 /// AddMethod - Add a single virtual member function to the vtable
906 /// components vector.
907 void AddMethod(const CXXMethodDecl *MD, ReturnAdjustment ReturnAdjustment);
909 /// IsOverriderUsed - Returns whether the overrider will ever be used in this
910 /// part of the vtable.
912 /// Itanium C++ ABI 2.5.2:
914 /// struct A { virtual void f(); };
915 /// struct B : virtual public A { int i; };
916 /// struct C : virtual public A { int j; };
917 /// struct D : public B, public C {};
919 /// When B and C are declared, A is a primary base in each case, so although
920 /// vcall offsets are allocated in the A-in-B and A-in-C vtables, no this
921 /// adjustment is required and no thunk is generated. However, inside D
922 /// objects, A is no longer a primary base of C, so if we allowed calls to
923 /// C::f() to use the copy of A's vtable in the C subobject, we would need
924 /// to adjust this from C* to B::A*, which would require a third-party
925 /// thunk. Since we require that a call to C::f() first convert to A*,
926 /// C-in-D's copy of A's vtable is never referenced, so this is not
928 bool IsOverriderUsed(const CXXMethodDecl *Overrider,
929 CharUnits BaseOffsetInLayoutClass,
930 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
931 CharUnits FirstBaseOffsetInLayoutClass) const;
934 /// AddMethods - Add the methods of this base subobject and all its
935 /// primary bases to the vtable components vector.
936 void AddMethods(BaseSubobject Base, CharUnits BaseOffsetInLayoutClass,
937 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
938 CharUnits FirstBaseOffsetInLayoutClass,
939 PrimaryBasesSetVectorTy &PrimaryBases);
941 // LayoutVTable - Layout the vtable for the given base class, including its
942 // secondary vtables and any vtables for virtual bases.
945 /// LayoutPrimaryAndSecondaryVTables - Layout the primary vtable for the
946 /// given base subobject, as well as all its secondary vtables.
948 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
949 /// or a direct or indirect base of a virtual base.
951 /// \param BaseIsVirtualInLayoutClass - Whether the base subobject is virtual
952 /// in the layout class.
953 void LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
954 bool BaseIsMorallyVirtual,
955 bool BaseIsVirtualInLayoutClass,
956 CharUnits OffsetInLayoutClass);
958 /// LayoutSecondaryVTables - Layout the secondary vtables for the given base
961 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
962 /// or a direct or indirect base of a virtual base.
963 void LayoutSecondaryVTables(BaseSubobject Base, bool BaseIsMorallyVirtual,
964 CharUnits OffsetInLayoutClass);
966 /// DeterminePrimaryVirtualBases - Determine the primary virtual bases in this
968 void DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
969 CharUnits OffsetInLayoutClass,
970 VisitedVirtualBasesSetTy &VBases);
972 /// LayoutVTablesForVirtualBases - Layout vtables for all virtual bases of the
973 /// given base (excluding any primary bases).
974 void LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
975 VisitedVirtualBasesSetTy &VBases);
977 /// isBuildingConstructionVTable - Return whether this vtable builder is
978 /// building a construction vtable.
979 bool isBuildingConstructorVTable() const {
980 return MostDerivedClass != LayoutClass;
984 /// Component indices of the first component of each of the vtables in the
986 SmallVector<size_t, 4> VTableIndices;
988 ItaniumVTableBuilder(ItaniumVTableContext &VTables,
989 const CXXRecordDecl *MostDerivedClass,
990 CharUnits MostDerivedClassOffset,
991 bool MostDerivedClassIsVirtual,
992 const CXXRecordDecl *LayoutClass)
993 : VTables(VTables), MostDerivedClass(MostDerivedClass),
994 MostDerivedClassOffset(MostDerivedClassOffset),
995 MostDerivedClassIsVirtual(MostDerivedClassIsVirtual),
996 LayoutClass(LayoutClass), Context(MostDerivedClass->getASTContext()),
997 Overriders(MostDerivedClass, MostDerivedClassOffset, LayoutClass) {
998 assert(!Context.getTargetInfo().getCXXABI().isMicrosoft());
1002 if (Context.getLangOpts().DumpVTableLayouts)
1003 dumpLayout(llvm::outs());
1006 uint64_t getNumThunks() const {
1007 return Thunks.size();
1010 ThunksMapTy::const_iterator thunks_begin() const {
1011 return Thunks.begin();
1014 ThunksMapTy::const_iterator thunks_end() const {
1015 return Thunks.end();
1018 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
1019 return VBaseOffsetOffsets;
1022 const AddressPointsMapTy &getAddressPoints() const {
1023 return AddressPoints;
1026 MethodVTableIndicesTy::const_iterator vtable_indices_begin() const {
1027 return MethodVTableIndices.begin();
1030 MethodVTableIndicesTy::const_iterator vtable_indices_end() const {
1031 return MethodVTableIndices.end();
1034 ArrayRef<VTableComponent> vtable_components() const { return Components; }
1036 AddressPointsMapTy::const_iterator address_points_begin() const {
1037 return AddressPoints.begin();
1040 AddressPointsMapTy::const_iterator address_points_end() const {
1041 return AddressPoints.end();
1044 VTableThunksMapTy::const_iterator vtable_thunks_begin() const {
1045 return VTableThunks.begin();
1048 VTableThunksMapTy::const_iterator vtable_thunks_end() const {
1049 return VTableThunks.end();
1052 /// dumpLayout - Dump the vtable layout.
1053 void dumpLayout(raw_ostream&);
1056 void ItaniumVTableBuilder::AddThunk(const CXXMethodDecl *MD,
1057 const ThunkInfo &Thunk) {
1058 assert(!isBuildingConstructorVTable() &&
1059 "Can't add thunks for construction vtable");
1061 SmallVectorImpl<ThunkInfo> &ThunksVector = Thunks[MD];
1063 // Check if we have this thunk already.
1064 if (std::find(ThunksVector.begin(), ThunksVector.end(), Thunk) !=
1068 ThunksVector.push_back(Thunk);
1071 typedef llvm::SmallPtrSet<const CXXMethodDecl *, 8> OverriddenMethodsSetTy;
1073 /// Visit all the methods overridden by the given method recursively,
1074 /// in a depth-first pre-order. The Visitor's visitor method returns a bool
1075 /// indicating whether to continue the recursion for the given overridden
1076 /// method (i.e. returning false stops the iteration).
1077 template <class VisitorTy>
1079 visitAllOverriddenMethods(const CXXMethodDecl *MD, VisitorTy &Visitor) {
1080 assert(MD->isVirtual() && "Method is not virtual!");
1082 for (const CXXMethodDecl *OverriddenMD : MD->overridden_methods()) {
1083 if (!Visitor(OverriddenMD))
1085 visitAllOverriddenMethods(OverriddenMD, Visitor);
1089 /// ComputeAllOverriddenMethods - Given a method decl, will return a set of all
1090 /// the overridden methods that the function decl overrides.
1092 ComputeAllOverriddenMethods(const CXXMethodDecl *MD,
1093 OverriddenMethodsSetTy& OverriddenMethods) {
1094 auto OverriddenMethodsCollector = [&](const CXXMethodDecl *MD) {
1095 // Don't recurse on this method if we've already collected it.
1096 return OverriddenMethods.insert(MD).second;
1098 visitAllOverriddenMethods(MD, OverriddenMethodsCollector);
1101 void ItaniumVTableBuilder::ComputeThisAdjustments() {
1102 // Now go through the method info map and see if any of the methods need
1103 // 'this' pointer adjustments.
1104 for (const auto &MI : MethodInfoMap) {
1105 const CXXMethodDecl *MD = MI.first;
1106 const MethodInfo &MethodInfo = MI.second;
1108 // Ignore adjustments for unused function pointers.
1109 uint64_t VTableIndex = MethodInfo.VTableIndex;
1110 if (Components[VTableIndex].getKind() ==
1111 VTableComponent::CK_UnusedFunctionPointer)
1114 // Get the final overrider for this method.
1115 FinalOverriders::OverriderInfo Overrider =
1116 Overriders.getOverrider(MD, MethodInfo.BaseOffset);
1118 // Check if we need an adjustment at all.
1119 if (MethodInfo.BaseOffsetInLayoutClass == Overrider.Offset) {
1120 // When a return thunk is needed by a derived class that overrides a
1121 // virtual base, gcc uses a virtual 'this' adjustment as well.
1122 // While the thunk itself might be needed by vtables in subclasses or
1123 // in construction vtables, there doesn't seem to be a reason for using
1124 // the thunk in this vtable. Still, we do so to match gcc.
1125 if (VTableThunks.lookup(VTableIndex).Return.isEmpty())
1129 ThisAdjustment ThisAdjustment =
1130 ComputeThisAdjustment(MD, MethodInfo.BaseOffsetInLayoutClass, Overrider);
1132 if (ThisAdjustment.isEmpty())
1136 VTableThunks[VTableIndex].This = ThisAdjustment;
1138 if (isa<CXXDestructorDecl>(MD)) {
1139 // Add an adjustment for the deleting destructor as well.
1140 VTableThunks[VTableIndex + 1].This = ThisAdjustment;
1144 /// Clear the method info map.
1145 MethodInfoMap.clear();
1147 if (isBuildingConstructorVTable()) {
1148 // We don't need to store thunk information for construction vtables.
1152 for (const auto &TI : VTableThunks) {
1153 const VTableComponent &Component = Components[TI.first];
1154 const ThunkInfo &Thunk = TI.second;
1155 const CXXMethodDecl *MD;
1157 switch (Component.getKind()) {
1159 llvm_unreachable("Unexpected vtable component kind!");
1160 case VTableComponent::CK_FunctionPointer:
1161 MD = Component.getFunctionDecl();
1163 case VTableComponent::CK_CompleteDtorPointer:
1164 MD = Component.getDestructorDecl();
1166 case VTableComponent::CK_DeletingDtorPointer:
1167 // We've already added the thunk when we saw the complete dtor pointer.
1171 if (MD->getParent() == MostDerivedClass)
1172 AddThunk(MD, Thunk);
1177 ItaniumVTableBuilder::ComputeReturnAdjustment(BaseOffset Offset) {
1178 ReturnAdjustment Adjustment;
1180 if (!Offset.isEmpty()) {
1181 if (Offset.VirtualBase) {
1182 // Get the virtual base offset offset.
1183 if (Offset.DerivedClass == MostDerivedClass) {
1184 // We can get the offset offset directly from our map.
1185 Adjustment.Virtual.Itanium.VBaseOffsetOffset =
1186 VBaseOffsetOffsets.lookup(Offset.VirtualBase).getQuantity();
1188 Adjustment.Virtual.Itanium.VBaseOffsetOffset =
1189 VTables.getVirtualBaseOffsetOffset(Offset.DerivedClass,
1190 Offset.VirtualBase).getQuantity();
1194 Adjustment.NonVirtual = Offset.NonVirtualOffset.getQuantity();
1200 BaseOffset ItaniumVTableBuilder::ComputeThisAdjustmentBaseOffset(
1201 BaseSubobject Base, BaseSubobject Derived) const {
1202 const CXXRecordDecl *BaseRD = Base.getBase();
1203 const CXXRecordDecl *DerivedRD = Derived.getBase();
1205 CXXBasePaths Paths(/*FindAmbiguities=*/true,
1206 /*RecordPaths=*/true, /*DetectVirtual=*/true);
1208 if (!DerivedRD->isDerivedFrom(BaseRD, Paths))
1209 llvm_unreachable("Class must be derived from the passed in base class!");
1211 // We have to go through all the paths, and see which one leads us to the
1212 // right base subobject.
1213 for (const CXXBasePath &Path : Paths) {
1214 BaseOffset Offset = ComputeBaseOffset(Context, DerivedRD, Path);
1216 CharUnits OffsetToBaseSubobject = Offset.NonVirtualOffset;
1218 if (Offset.VirtualBase) {
1219 // If we have a virtual base class, the non-virtual offset is relative
1220 // to the virtual base class offset.
1221 const ASTRecordLayout &LayoutClassLayout =
1222 Context.getASTRecordLayout(LayoutClass);
1224 /// Get the virtual base offset, relative to the most derived class
1226 OffsetToBaseSubobject +=
1227 LayoutClassLayout.getVBaseClassOffset(Offset.VirtualBase);
1229 // Otherwise, the non-virtual offset is relative to the derived class
1231 OffsetToBaseSubobject += Derived.getBaseOffset();
1234 // Check if this path gives us the right base subobject.
1235 if (OffsetToBaseSubobject == Base.getBaseOffset()) {
1236 // Since we're going from the base class _to_ the derived class, we'll
1237 // invert the non-virtual offset here.
1238 Offset.NonVirtualOffset = -Offset.NonVirtualOffset;
1243 return BaseOffset();
1246 ThisAdjustment ItaniumVTableBuilder::ComputeThisAdjustment(
1247 const CXXMethodDecl *MD, CharUnits BaseOffsetInLayoutClass,
1248 FinalOverriders::OverriderInfo Overrider) {
1249 // Ignore adjustments for pure virtual member functions.
1250 if (Overrider.Method->isPure())
1251 return ThisAdjustment();
1253 BaseSubobject OverriddenBaseSubobject(MD->getParent(),
1254 BaseOffsetInLayoutClass);
1256 BaseSubobject OverriderBaseSubobject(Overrider.Method->getParent(),
1259 // Compute the adjustment offset.
1260 BaseOffset Offset = ComputeThisAdjustmentBaseOffset(OverriddenBaseSubobject,
1261 OverriderBaseSubobject);
1262 if (Offset.isEmpty())
1263 return ThisAdjustment();
1265 ThisAdjustment Adjustment;
1267 if (Offset.VirtualBase) {
1268 // Get the vcall offset map for this virtual base.
1269 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Offset.VirtualBase];
1271 if (VCallOffsets.empty()) {
1272 // We don't have vcall offsets for this virtual base, go ahead and
1274 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, MostDerivedClass,
1275 /*FinalOverriders=*/nullptr,
1276 BaseSubobject(Offset.VirtualBase,
1278 /*BaseIsVirtual=*/true,
1279 /*OffsetInLayoutClass=*/
1282 VCallOffsets = Builder.getVCallOffsets();
1285 Adjustment.Virtual.Itanium.VCallOffsetOffset =
1286 VCallOffsets.getVCallOffsetOffset(MD).getQuantity();
1289 // Set the non-virtual part of the adjustment.
1290 Adjustment.NonVirtual = Offset.NonVirtualOffset.getQuantity();
1295 void ItaniumVTableBuilder::AddMethod(const CXXMethodDecl *MD,
1296 ReturnAdjustment ReturnAdjustment) {
1297 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1298 assert(ReturnAdjustment.isEmpty() &&
1299 "Destructor can't have return adjustment!");
1301 // Add both the complete destructor and the deleting destructor.
1302 Components.push_back(VTableComponent::MakeCompleteDtor(DD));
1303 Components.push_back(VTableComponent::MakeDeletingDtor(DD));
1305 // Add the return adjustment if necessary.
1306 if (!ReturnAdjustment.isEmpty())
1307 VTableThunks[Components.size()].Return = ReturnAdjustment;
1309 // Add the function.
1310 Components.push_back(VTableComponent::MakeFunction(MD));
1314 /// OverridesIndirectMethodInBase - Return whether the given member function
1315 /// overrides any methods in the set of given bases.
1316 /// Unlike OverridesMethodInBase, this checks "overriders of overriders".
1317 /// For example, if we have:
1319 /// struct A { virtual void f(); }
1320 /// struct B : A { virtual void f(); }
1321 /// struct C : B { virtual void f(); }
1323 /// OverridesIndirectMethodInBase will return true if given C::f as the method
1324 /// and { A } as the set of bases.
1325 static bool OverridesIndirectMethodInBases(
1326 const CXXMethodDecl *MD,
1327 ItaniumVTableBuilder::PrimaryBasesSetVectorTy &Bases) {
1328 if (Bases.count(MD->getParent()))
1331 for (const CXXMethodDecl *OverriddenMD : MD->overridden_methods()) {
1332 // Check "indirect overriders".
1333 if (OverridesIndirectMethodInBases(OverriddenMD, Bases))
1340 bool ItaniumVTableBuilder::IsOverriderUsed(
1341 const CXXMethodDecl *Overrider, CharUnits BaseOffsetInLayoutClass,
1342 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1343 CharUnits FirstBaseOffsetInLayoutClass) const {
1344 // If the base and the first base in the primary base chain have the same
1345 // offsets, then this overrider will be used.
1346 if (BaseOffsetInLayoutClass == FirstBaseOffsetInLayoutClass)
1349 // We know now that Base (or a direct or indirect base of it) is a primary
1350 // base in part of the class hierarchy, but not a primary base in the most
1353 // If the overrider is the first base in the primary base chain, we know
1354 // that the overrider will be used.
1355 if (Overrider->getParent() == FirstBaseInPrimaryBaseChain)
1358 ItaniumVTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
1360 const CXXRecordDecl *RD = FirstBaseInPrimaryBaseChain;
1361 PrimaryBases.insert(RD);
1363 // Now traverse the base chain, starting with the first base, until we find
1364 // the base that is no longer a primary base.
1366 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1367 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1372 if (Layout.isPrimaryBaseVirtual()) {
1373 assert(Layout.getVBaseClassOffset(PrimaryBase).isZero() &&
1374 "Primary base should always be at offset 0!");
1376 const ASTRecordLayout &LayoutClassLayout =
1377 Context.getASTRecordLayout(LayoutClass);
1379 // Now check if this is the primary base that is not a primary base in the
1380 // most derived class.
1381 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
1382 FirstBaseOffsetInLayoutClass) {
1383 // We found it, stop walking the chain.
1387 assert(Layout.getBaseClassOffset(PrimaryBase).isZero() &&
1388 "Primary base should always be at offset 0!");
1391 if (!PrimaryBases.insert(PrimaryBase))
1392 llvm_unreachable("Found a duplicate primary base!");
1397 // If the final overrider is an override of one of the primary bases,
1398 // then we know that it will be used.
1399 return OverridesIndirectMethodInBases(Overrider, PrimaryBases);
1402 typedef llvm::SmallSetVector<const CXXRecordDecl *, 8> BasesSetVectorTy;
1404 /// FindNearestOverriddenMethod - Given a method, returns the overridden method
1405 /// from the nearest base. Returns null if no method was found.
1406 /// The Bases are expected to be sorted in a base-to-derived order.
1407 static const CXXMethodDecl *
1408 FindNearestOverriddenMethod(const CXXMethodDecl *MD,
1409 BasesSetVectorTy &Bases) {
1410 OverriddenMethodsSetTy OverriddenMethods;
1411 ComputeAllOverriddenMethods(MD, OverriddenMethods);
1413 for (const CXXRecordDecl *PrimaryBase :
1414 llvm::make_range(Bases.rbegin(), Bases.rend())) {
1415 // Now check the overridden methods.
1416 for (const CXXMethodDecl *OverriddenMD : OverriddenMethods) {
1417 // We found our overridden method.
1418 if (OverriddenMD->getParent() == PrimaryBase)
1419 return OverriddenMD;
1426 void ItaniumVTableBuilder::AddMethods(
1427 BaseSubobject Base, CharUnits BaseOffsetInLayoutClass,
1428 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1429 CharUnits FirstBaseOffsetInLayoutClass,
1430 PrimaryBasesSetVectorTy &PrimaryBases) {
1431 // Itanium C++ ABI 2.5.2:
1432 // The order of the virtual function pointers in a virtual table is the
1433 // order of declaration of the corresponding member functions in the class.
1435 // There is an entry for any virtual function declared in a class,
1436 // whether it is a new function or overrides a base class function,
1437 // unless it overrides a function from the primary base, and conversion
1438 // between their return types does not require an adjustment.
1440 const CXXRecordDecl *RD = Base.getBase();
1441 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1443 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
1444 CharUnits PrimaryBaseOffset;
1445 CharUnits PrimaryBaseOffsetInLayoutClass;
1446 if (Layout.isPrimaryBaseVirtual()) {
1447 assert(Layout.getVBaseClassOffset(PrimaryBase).isZero() &&
1448 "Primary vbase should have a zero offset!");
1450 const ASTRecordLayout &MostDerivedClassLayout =
1451 Context.getASTRecordLayout(MostDerivedClass);
1454 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
1456 const ASTRecordLayout &LayoutClassLayout =
1457 Context.getASTRecordLayout(LayoutClass);
1459 PrimaryBaseOffsetInLayoutClass =
1460 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
1462 assert(Layout.getBaseClassOffset(PrimaryBase).isZero() &&
1463 "Primary base should have a zero offset!");
1465 PrimaryBaseOffset = Base.getBaseOffset();
1466 PrimaryBaseOffsetInLayoutClass = BaseOffsetInLayoutClass;
1469 AddMethods(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
1470 PrimaryBaseOffsetInLayoutClass, FirstBaseInPrimaryBaseChain,
1471 FirstBaseOffsetInLayoutClass, PrimaryBases);
1473 if (!PrimaryBases.insert(PrimaryBase))
1474 llvm_unreachable("Found a duplicate primary base!");
1477 const CXXDestructorDecl *ImplicitVirtualDtor = nullptr;
1479 typedef llvm::SmallVector<const CXXMethodDecl *, 8> NewVirtualFunctionsTy;
1480 NewVirtualFunctionsTy NewVirtualFunctions;
1482 // Now go through all virtual member functions and add them.
1483 for (const auto *MD : RD->methods()) {
1484 if (!MD->isVirtual())
1486 MD = MD->getCanonicalDecl();
1488 // Get the final overrider.
1489 FinalOverriders::OverriderInfo Overrider =
1490 Overriders.getOverrider(MD, Base.getBaseOffset());
1492 // Check if this virtual member function overrides a method in a primary
1493 // base. If this is the case, and the return type doesn't require adjustment
1494 // then we can just use the member function from the primary base.
1495 if (const CXXMethodDecl *OverriddenMD =
1496 FindNearestOverriddenMethod(MD, PrimaryBases)) {
1497 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
1498 OverriddenMD).isEmpty()) {
1499 // Replace the method info of the overridden method with our own
1501 assert(MethodInfoMap.count(OverriddenMD) &&
1502 "Did not find the overridden method!");
1503 MethodInfo &OverriddenMethodInfo = MethodInfoMap[OverriddenMD];
1505 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
1506 OverriddenMethodInfo.VTableIndex);
1508 assert(!MethodInfoMap.count(MD) &&
1509 "Should not have method info for this method yet!");
1511 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
1512 MethodInfoMap.erase(OverriddenMD);
1514 // If the overridden method exists in a virtual base class or a direct
1515 // or indirect base class of a virtual base class, we need to emit a
1516 // thunk if we ever have a class hierarchy where the base class is not
1517 // a primary base in the complete object.
1518 if (!isBuildingConstructorVTable() && OverriddenMD != MD) {
1519 // Compute the this adjustment.
1520 ThisAdjustment ThisAdjustment =
1521 ComputeThisAdjustment(OverriddenMD, BaseOffsetInLayoutClass,
1524 if (ThisAdjustment.Virtual.Itanium.VCallOffsetOffset &&
1525 Overrider.Method->getParent() == MostDerivedClass) {
1527 // There's no return adjustment from OverriddenMD and MD,
1528 // but that doesn't mean there isn't one between MD and
1529 // the final overrider.
1530 BaseOffset ReturnAdjustmentOffset =
1531 ComputeReturnAdjustmentBaseOffset(Context, Overrider.Method, MD);
1532 ReturnAdjustment ReturnAdjustment =
1533 ComputeReturnAdjustment(ReturnAdjustmentOffset);
1535 // This is a virtual thunk for the most derived class, add it.
1536 AddThunk(Overrider.Method,
1537 ThunkInfo(ThisAdjustment, ReturnAdjustment));
1545 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1546 if (MD->isImplicit()) {
1547 // Itanium C++ ABI 2.5.2:
1548 // If a class has an implicitly-defined virtual destructor,
1549 // its entries come after the declared virtual function pointers.
1551 assert(!ImplicitVirtualDtor &&
1552 "Did already see an implicit virtual dtor!");
1553 ImplicitVirtualDtor = DD;
1558 NewVirtualFunctions.push_back(MD);
1561 if (ImplicitVirtualDtor)
1562 NewVirtualFunctions.push_back(ImplicitVirtualDtor);
1564 for (const CXXMethodDecl *MD : NewVirtualFunctions) {
1565 // Get the final overrider.
1566 FinalOverriders::OverriderInfo Overrider =
1567 Overriders.getOverrider(MD, Base.getBaseOffset());
1569 // Insert the method info for this method.
1570 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
1573 assert(!MethodInfoMap.count(MD) &&
1574 "Should not have method info for this method yet!");
1575 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
1577 // Check if this overrider is going to be used.
1578 const CXXMethodDecl *OverriderMD = Overrider.Method;
1579 if (!IsOverriderUsed(OverriderMD, BaseOffsetInLayoutClass,
1580 FirstBaseInPrimaryBaseChain,
1581 FirstBaseOffsetInLayoutClass)) {
1582 Components.push_back(VTableComponent::MakeUnusedFunction(OverriderMD));
1586 // Check if this overrider needs a return adjustment.
1587 // We don't want to do this for pure virtual member functions.
1588 BaseOffset ReturnAdjustmentOffset;
1589 if (!OverriderMD->isPure()) {
1590 ReturnAdjustmentOffset =
1591 ComputeReturnAdjustmentBaseOffset(Context, OverriderMD, MD);
1594 ReturnAdjustment ReturnAdjustment =
1595 ComputeReturnAdjustment(ReturnAdjustmentOffset);
1597 AddMethod(Overrider.Method, ReturnAdjustment);
1601 void ItaniumVTableBuilder::LayoutVTable() {
1602 LayoutPrimaryAndSecondaryVTables(BaseSubobject(MostDerivedClass,
1604 /*BaseIsMorallyVirtual=*/false,
1605 MostDerivedClassIsVirtual,
1606 MostDerivedClassOffset);
1608 VisitedVirtualBasesSetTy VBases;
1610 // Determine the primary virtual bases.
1611 DeterminePrimaryVirtualBases(MostDerivedClass, MostDerivedClassOffset,
1615 LayoutVTablesForVirtualBases(MostDerivedClass, VBases);
1617 // -fapple-kext adds an extra entry at end of vtbl.
1618 bool IsAppleKext = Context.getLangOpts().AppleKext;
1620 Components.push_back(VTableComponent::MakeVCallOffset(CharUnits::Zero()));
1623 void ItaniumVTableBuilder::LayoutPrimaryAndSecondaryVTables(
1624 BaseSubobject Base, bool BaseIsMorallyVirtual,
1625 bool BaseIsVirtualInLayoutClass, CharUnits OffsetInLayoutClass) {
1626 assert(Base.getBase()->isDynamicClass() && "class does not have a vtable!");
1628 unsigned VTableIndex = Components.size();
1629 VTableIndices.push_back(VTableIndex);
1631 // Add vcall and vbase offsets for this vtable.
1632 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, LayoutClass, &Overriders,
1633 Base, BaseIsVirtualInLayoutClass,
1634 OffsetInLayoutClass);
1635 Components.append(Builder.components_begin(), Builder.components_end());
1637 // Check if we need to add these vcall offsets.
1638 if (BaseIsVirtualInLayoutClass && !Builder.getVCallOffsets().empty()) {
1639 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Base.getBase()];
1641 if (VCallOffsets.empty())
1642 VCallOffsets = Builder.getVCallOffsets();
1645 // If we're laying out the most derived class we want to keep track of the
1646 // virtual base class offset offsets.
1647 if (Base.getBase() == MostDerivedClass)
1648 VBaseOffsetOffsets = Builder.getVBaseOffsetOffsets();
1650 // Add the offset to top.
1651 CharUnits OffsetToTop = MostDerivedClassOffset - OffsetInLayoutClass;
1652 Components.push_back(VTableComponent::MakeOffsetToTop(OffsetToTop));
1654 // Next, add the RTTI.
1655 Components.push_back(VTableComponent::MakeRTTI(MostDerivedClass));
1657 uint64_t AddressPoint = Components.size();
1659 // Now go through all virtual member functions and add them.
1660 PrimaryBasesSetVectorTy PrimaryBases;
1661 AddMethods(Base, OffsetInLayoutClass,
1662 Base.getBase(), OffsetInLayoutClass,
1665 const CXXRecordDecl *RD = Base.getBase();
1666 if (RD == MostDerivedClass) {
1667 assert(MethodVTableIndices.empty());
1668 for (const auto &I : MethodInfoMap) {
1669 const CXXMethodDecl *MD = I.first;
1670 const MethodInfo &MI = I.second;
1671 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1672 MethodVTableIndices[GlobalDecl(DD, Dtor_Complete)]
1673 = MI.VTableIndex - AddressPoint;
1674 MethodVTableIndices[GlobalDecl(DD, Dtor_Deleting)]
1675 = MI.VTableIndex + 1 - AddressPoint;
1677 MethodVTableIndices[MD] = MI.VTableIndex - AddressPoint;
1682 // Compute 'this' pointer adjustments.
1683 ComputeThisAdjustments();
1685 // Add all address points.
1687 AddressPoints.insert(
1688 std::make_pair(BaseSubobject(RD, OffsetInLayoutClass),
1689 VTableLayout::AddressPointLocation{
1690 unsigned(VTableIndices.size() - 1),
1691 unsigned(AddressPoint - VTableIndex)}));
1693 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1694 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1699 if (Layout.isPrimaryBaseVirtual()) {
1700 // Check if this virtual primary base is a primary base in the layout
1701 // class. If it's not, we don't want to add it.
1702 const ASTRecordLayout &LayoutClassLayout =
1703 Context.getASTRecordLayout(LayoutClass);
1705 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
1706 OffsetInLayoutClass) {
1707 // We don't want to add this class (or any of its primary bases).
1715 // Layout secondary vtables.
1716 LayoutSecondaryVTables(Base, BaseIsMorallyVirtual, OffsetInLayoutClass);
1720 ItaniumVTableBuilder::LayoutSecondaryVTables(BaseSubobject Base,
1721 bool BaseIsMorallyVirtual,
1722 CharUnits OffsetInLayoutClass) {
1723 // Itanium C++ ABI 2.5.2:
1724 // Following the primary virtual table of a derived class are secondary
1725 // virtual tables for each of its proper base classes, except any primary
1726 // base(s) with which it shares its primary virtual table.
1728 const CXXRecordDecl *RD = Base.getBase();
1729 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1730 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1732 for (const auto &B : RD->bases()) {
1733 // Ignore virtual bases, we'll emit them later.
1737 const CXXRecordDecl *BaseDecl = B.getType()->getAsCXXRecordDecl();
1739 // Ignore bases that don't have a vtable.
1740 if (!BaseDecl->isDynamicClass())
1743 if (isBuildingConstructorVTable()) {
1744 // Itanium C++ ABI 2.6.4:
1745 // Some of the base class subobjects may not need construction virtual
1746 // tables, which will therefore not be present in the construction
1747 // virtual table group, even though the subobject virtual tables are
1748 // present in the main virtual table group for the complete object.
1749 if (!BaseIsMorallyVirtual && !BaseDecl->getNumVBases())
1753 // Get the base offset of this base.
1754 CharUnits RelativeBaseOffset = Layout.getBaseClassOffset(BaseDecl);
1755 CharUnits BaseOffset = Base.getBaseOffset() + RelativeBaseOffset;
1757 CharUnits BaseOffsetInLayoutClass =
1758 OffsetInLayoutClass + RelativeBaseOffset;
1760 // Don't emit a secondary vtable for a primary base. We might however want
1761 // to emit secondary vtables for other bases of this base.
1762 if (BaseDecl == PrimaryBase) {
1763 LayoutSecondaryVTables(BaseSubobject(BaseDecl, BaseOffset),
1764 BaseIsMorallyVirtual, BaseOffsetInLayoutClass);
1768 // Layout the primary vtable (and any secondary vtables) for this base.
1769 LayoutPrimaryAndSecondaryVTables(
1770 BaseSubobject(BaseDecl, BaseOffset),
1771 BaseIsMorallyVirtual,
1772 /*BaseIsVirtualInLayoutClass=*/false,
1773 BaseOffsetInLayoutClass);
1777 void ItaniumVTableBuilder::DeterminePrimaryVirtualBases(
1778 const CXXRecordDecl *RD, CharUnits OffsetInLayoutClass,
1779 VisitedVirtualBasesSetTy &VBases) {
1780 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1782 // Check if this base has a primary base.
1783 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
1785 // Check if it's virtual.
1786 if (Layout.isPrimaryBaseVirtual()) {
1787 bool IsPrimaryVirtualBase = true;
1789 if (isBuildingConstructorVTable()) {
1790 // Check if the base is actually a primary base in the class we use for
1792 const ASTRecordLayout &LayoutClassLayout =
1793 Context.getASTRecordLayout(LayoutClass);
1795 CharUnits PrimaryBaseOffsetInLayoutClass =
1796 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
1798 // We know that the base is not a primary base in the layout class if
1799 // the base offsets are different.
1800 if (PrimaryBaseOffsetInLayoutClass != OffsetInLayoutClass)
1801 IsPrimaryVirtualBase = false;
1804 if (IsPrimaryVirtualBase)
1805 PrimaryVirtualBases.insert(PrimaryBase);
1809 // Traverse bases, looking for more primary virtual bases.
1810 for (const auto &B : RD->bases()) {
1811 const CXXRecordDecl *BaseDecl = B.getType()->getAsCXXRecordDecl();
1813 CharUnits BaseOffsetInLayoutClass;
1815 if (B.isVirtual()) {
1816 if (!VBases.insert(BaseDecl).second)
1819 const ASTRecordLayout &LayoutClassLayout =
1820 Context.getASTRecordLayout(LayoutClass);
1822 BaseOffsetInLayoutClass =
1823 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
1825 BaseOffsetInLayoutClass =
1826 OffsetInLayoutClass + Layout.getBaseClassOffset(BaseDecl);
1829 DeterminePrimaryVirtualBases(BaseDecl, BaseOffsetInLayoutClass, VBases);
1833 void ItaniumVTableBuilder::LayoutVTablesForVirtualBases(
1834 const CXXRecordDecl *RD, VisitedVirtualBasesSetTy &VBases) {
1835 // Itanium C++ ABI 2.5.2:
1836 // Then come the virtual base virtual tables, also in inheritance graph
1837 // order, and again excluding primary bases (which share virtual tables with
1838 // the classes for which they are primary).
1839 for (const auto &B : RD->bases()) {
1840 const CXXRecordDecl *BaseDecl = B.getType()->getAsCXXRecordDecl();
1842 // Check if this base needs a vtable. (If it's virtual, not a primary base
1843 // of some other class, and we haven't visited it before).
1844 if (B.isVirtual() && BaseDecl->isDynamicClass() &&
1845 !PrimaryVirtualBases.count(BaseDecl) &&
1846 VBases.insert(BaseDecl).second) {
1847 const ASTRecordLayout &MostDerivedClassLayout =
1848 Context.getASTRecordLayout(MostDerivedClass);
1849 CharUnits BaseOffset =
1850 MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
1852 const ASTRecordLayout &LayoutClassLayout =
1853 Context.getASTRecordLayout(LayoutClass);
1854 CharUnits BaseOffsetInLayoutClass =
1855 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
1857 LayoutPrimaryAndSecondaryVTables(
1858 BaseSubobject(BaseDecl, BaseOffset),
1859 /*BaseIsMorallyVirtual=*/true,
1860 /*BaseIsVirtualInLayoutClass=*/true,
1861 BaseOffsetInLayoutClass);
1864 // We only need to check the base for virtual base vtables if it actually
1865 // has virtual bases.
1866 if (BaseDecl->getNumVBases())
1867 LayoutVTablesForVirtualBases(BaseDecl, VBases);
1871 /// dumpLayout - Dump the vtable layout.
1872 void ItaniumVTableBuilder::dumpLayout(raw_ostream &Out) {
1873 // FIXME: write more tests that actually use the dumpLayout output to prevent
1874 // ItaniumVTableBuilder regressions.
1876 if (isBuildingConstructorVTable()) {
1877 Out << "Construction vtable for ('";
1878 MostDerivedClass->printQualifiedName(Out);
1880 Out << MostDerivedClassOffset.getQuantity() << ") in '";
1881 LayoutClass->printQualifiedName(Out);
1883 Out << "Vtable for '";
1884 MostDerivedClass->printQualifiedName(Out);
1886 Out << "' (" << Components.size() << " entries).\n";
1888 // Iterate through the address points and insert them into a new map where
1889 // they are keyed by the index and not the base object.
1890 // Since an address point can be shared by multiple subobjects, we use an
1892 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
1893 for (const auto &AP : AddressPoints) {
1894 const BaseSubobject &Base = AP.first;
1896 VTableIndices[AP.second.VTableIndex] + AP.second.AddressPointIndex;
1898 AddressPointsByIndex.insert(std::make_pair(Index, Base));
1901 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
1904 Out << llvm::format("%4d | ", I);
1906 const VTableComponent &Component = Components[I];
1908 // Dump the component.
1909 switch (Component.getKind()) {
1911 case VTableComponent::CK_VCallOffset:
1912 Out << "vcall_offset ("
1913 << Component.getVCallOffset().getQuantity()
1917 case VTableComponent::CK_VBaseOffset:
1918 Out << "vbase_offset ("
1919 << Component.getVBaseOffset().getQuantity()
1923 case VTableComponent::CK_OffsetToTop:
1924 Out << "offset_to_top ("
1925 << Component.getOffsetToTop().getQuantity()
1929 case VTableComponent::CK_RTTI:
1930 Component.getRTTIDecl()->printQualifiedName(Out);
1934 case VTableComponent::CK_FunctionPointer: {
1935 const CXXMethodDecl *MD = Component.getFunctionDecl();
1938 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
1944 if (MD->isDeleted())
1945 Out << " [deleted]";
1947 ThunkInfo Thunk = VTableThunks.lookup(I);
1948 if (!Thunk.isEmpty()) {
1949 // If this function pointer has a return adjustment, dump it.
1950 if (!Thunk.Return.isEmpty()) {
1951 Out << "\n [return adjustment: ";
1952 Out << Thunk.Return.NonVirtual << " non-virtual";
1954 if (Thunk.Return.Virtual.Itanium.VBaseOffsetOffset) {
1955 Out << ", " << Thunk.Return.Virtual.Itanium.VBaseOffsetOffset;
1956 Out << " vbase offset offset";
1962 // If this function pointer has a 'this' pointer adjustment, dump it.
1963 if (!Thunk.This.isEmpty()) {
1964 Out << "\n [this adjustment: ";
1965 Out << Thunk.This.NonVirtual << " non-virtual";
1967 if (Thunk.This.Virtual.Itanium.VCallOffsetOffset) {
1968 Out << ", " << Thunk.This.Virtual.Itanium.VCallOffsetOffset;
1969 Out << " vcall offset offset";
1979 case VTableComponent::CK_CompleteDtorPointer:
1980 case VTableComponent::CK_DeletingDtorPointer: {
1982 Component.getKind() == VTableComponent::CK_CompleteDtorPointer;
1984 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1986 DD->printQualifiedName(Out);
1988 Out << "() [complete]";
1990 Out << "() [deleting]";
1995 ThunkInfo Thunk = VTableThunks.lookup(I);
1996 if (!Thunk.isEmpty()) {
1997 // If this destructor has a 'this' pointer adjustment, dump it.
1998 if (!Thunk.This.isEmpty()) {
1999 Out << "\n [this adjustment: ";
2000 Out << Thunk.This.NonVirtual << " non-virtual";
2002 if (Thunk.This.Virtual.Itanium.VCallOffsetOffset) {
2003 Out << ", " << Thunk.This.Virtual.Itanium.VCallOffsetOffset;
2004 Out << " vcall offset offset";
2014 case VTableComponent::CK_UnusedFunctionPointer: {
2015 const CXXMethodDecl *MD = Component.getUnusedFunctionDecl();
2018 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2020 Out << "[unused] " << Str;
2029 // Dump the next address point.
2030 uint64_t NextIndex = Index + 1;
2031 if (AddressPointsByIndex.count(NextIndex)) {
2032 if (AddressPointsByIndex.count(NextIndex) == 1) {
2033 const BaseSubobject &Base =
2034 AddressPointsByIndex.find(NextIndex)->second;
2037 Base.getBase()->printQualifiedName(Out);
2038 Out << ", " << Base.getBaseOffset().getQuantity();
2039 Out << ") vtable address --\n";
2041 CharUnits BaseOffset =
2042 AddressPointsByIndex.lower_bound(NextIndex)->second.getBaseOffset();
2044 // We store the class names in a set to get a stable order.
2045 std::set<std::string> ClassNames;
2046 for (const auto &I :
2047 llvm::make_range(AddressPointsByIndex.equal_range(NextIndex))) {
2048 assert(I.second.getBaseOffset() == BaseOffset &&
2049 "Invalid base offset!");
2050 const CXXRecordDecl *RD = I.second.getBase();
2051 ClassNames.insert(RD->getQualifiedNameAsString());
2054 for (const std::string &Name : ClassNames) {
2055 Out << " -- (" << Name;
2056 Out << ", " << BaseOffset.getQuantity() << ") vtable address --\n";
2064 if (isBuildingConstructorVTable())
2067 if (MostDerivedClass->getNumVBases()) {
2068 // We store the virtual base class names and their offsets in a map to get
2071 std::map<std::string, CharUnits> ClassNamesAndOffsets;
2072 for (const auto &I : VBaseOffsetOffsets) {
2073 std::string ClassName = I.first->getQualifiedNameAsString();
2074 CharUnits OffsetOffset = I.second;
2075 ClassNamesAndOffsets.insert(std::make_pair(ClassName, OffsetOffset));
2078 Out << "Virtual base offset offsets for '";
2079 MostDerivedClass->printQualifiedName(Out);
2081 Out << ClassNamesAndOffsets.size();
2082 Out << (ClassNamesAndOffsets.size() == 1 ? " entry" : " entries") << ").\n";
2084 for (const auto &I : ClassNamesAndOffsets)
2085 Out << " " << I.first << " | " << I.second.getQuantity() << '\n';
2090 if (!Thunks.empty()) {
2091 // We store the method names in a map to get a stable order.
2092 std::map<std::string, const CXXMethodDecl *> MethodNamesAndDecls;
2094 for (const auto &I : Thunks) {
2095 const CXXMethodDecl *MD = I.first;
2096 std::string MethodName =
2097 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2100 MethodNamesAndDecls.insert(std::make_pair(MethodName, MD));
2103 for (const auto &I : MethodNamesAndDecls) {
2104 const std::string &MethodName = I.first;
2105 const CXXMethodDecl *MD = I.second;
2107 ThunkInfoVectorTy ThunksVector = Thunks[MD];
2108 std::sort(ThunksVector.begin(), ThunksVector.end(),
2109 [](const ThunkInfo &LHS, const ThunkInfo &RHS) {
2110 assert(LHS.Method == nullptr && RHS.Method == nullptr);
2111 return std::tie(LHS.This, LHS.Return) < std::tie(RHS.This, RHS.Return);
2114 Out << "Thunks for '" << MethodName << "' (" << ThunksVector.size();
2115 Out << (ThunksVector.size() == 1 ? " entry" : " entries") << ").\n";
2117 for (unsigned I = 0, E = ThunksVector.size(); I != E; ++I) {
2118 const ThunkInfo &Thunk = ThunksVector[I];
2120 Out << llvm::format("%4d | ", I);
2122 // If this function pointer has a return pointer adjustment, dump it.
2123 if (!Thunk.Return.isEmpty()) {
2124 Out << "return adjustment: " << Thunk.Return.NonVirtual;
2125 Out << " non-virtual";
2126 if (Thunk.Return.Virtual.Itanium.VBaseOffsetOffset) {
2127 Out << ", " << Thunk.Return.Virtual.Itanium.VBaseOffsetOffset;
2128 Out << " vbase offset offset";
2131 if (!Thunk.This.isEmpty())
2135 // If this function pointer has a 'this' pointer adjustment, dump it.
2136 if (!Thunk.This.isEmpty()) {
2137 Out << "this adjustment: ";
2138 Out << Thunk.This.NonVirtual << " non-virtual";
2140 if (Thunk.This.Virtual.Itanium.VCallOffsetOffset) {
2141 Out << ", " << Thunk.This.Virtual.Itanium.VCallOffsetOffset;
2142 Out << " vcall offset offset";
2153 // Compute the vtable indices for all the member functions.
2154 // Store them in a map keyed by the index so we'll get a sorted table.
2155 std::map<uint64_t, std::string> IndicesMap;
2157 for (const auto *MD : MostDerivedClass->methods()) {
2158 // We only want virtual member functions.
2159 if (!MD->isVirtual())
2161 MD = MD->getCanonicalDecl();
2163 std::string MethodName =
2164 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2167 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2168 GlobalDecl GD(DD, Dtor_Complete);
2169 assert(MethodVTableIndices.count(GD));
2170 uint64_t VTableIndex = MethodVTableIndices[GD];
2171 IndicesMap[VTableIndex] = MethodName + " [complete]";
2172 IndicesMap[VTableIndex + 1] = MethodName + " [deleting]";
2174 assert(MethodVTableIndices.count(MD));
2175 IndicesMap[MethodVTableIndices[MD]] = MethodName;
2179 // Print the vtable indices for all the member functions.
2180 if (!IndicesMap.empty()) {
2181 Out << "VTable indices for '";
2182 MostDerivedClass->printQualifiedName(Out);
2183 Out << "' (" << IndicesMap.size() << " entries).\n";
2185 for (const auto &I : IndicesMap) {
2186 uint64_t VTableIndex = I.first;
2187 const std::string &MethodName = I.second;
2189 Out << llvm::format("%4" PRIu64 " | ", VTableIndex) << MethodName
2198 VTableLayout::VTableLayout(ArrayRef<size_t> VTableIndices,
2199 ArrayRef<VTableComponent> VTableComponents,
2200 ArrayRef<VTableThunkTy> VTableThunks,
2201 const AddressPointsMapTy &AddressPoints)
2202 : VTableComponents(VTableComponents), VTableThunks(VTableThunks),
2203 AddressPoints(AddressPoints) {
2204 if (VTableIndices.size() <= 1)
2205 assert(VTableIndices.size() == 1 && VTableIndices[0] == 0);
2207 this->VTableIndices = OwningArrayRef<size_t>(VTableIndices);
2209 std::sort(this->VTableThunks.begin(), this->VTableThunks.end(),
2210 [](const VTableLayout::VTableThunkTy &LHS,
2211 const VTableLayout::VTableThunkTy &RHS) {
2212 assert((LHS.first != RHS.first || LHS.second == RHS.second) &&
2213 "Different thunks should have unique indices!");
2214 return LHS.first < RHS.first;
2218 VTableLayout::~VTableLayout() { }
2220 ItaniumVTableContext::ItaniumVTableContext(ASTContext &Context)
2221 : VTableContextBase(/*MS=*/false) {}
2223 ItaniumVTableContext::~ItaniumVTableContext() {}
2225 uint64_t ItaniumVTableContext::getMethodVTableIndex(GlobalDecl GD) {
2226 MethodVTableIndicesTy::iterator I = MethodVTableIndices.find(GD);
2227 if (I != MethodVTableIndices.end())
2230 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
2232 computeVTableRelatedInformation(RD);
2234 I = MethodVTableIndices.find(GD);
2235 assert(I != MethodVTableIndices.end() && "Did not find index!");
2240 ItaniumVTableContext::getVirtualBaseOffsetOffset(const CXXRecordDecl *RD,
2241 const CXXRecordDecl *VBase) {
2242 ClassPairTy ClassPair(RD, VBase);
2244 VirtualBaseClassOffsetOffsetsMapTy::iterator I =
2245 VirtualBaseClassOffsetOffsets.find(ClassPair);
2246 if (I != VirtualBaseClassOffsetOffsets.end())
2249 VCallAndVBaseOffsetBuilder Builder(RD, RD, /*FinalOverriders=*/nullptr,
2250 BaseSubobject(RD, CharUnits::Zero()),
2251 /*BaseIsVirtual=*/false,
2252 /*OffsetInLayoutClass=*/CharUnits::Zero());
2254 for (const auto &I : Builder.getVBaseOffsetOffsets()) {
2255 // Insert all types.
2256 ClassPairTy ClassPair(RD, I.first);
2258 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I.second));
2261 I = VirtualBaseClassOffsetOffsets.find(ClassPair);
2262 assert(I != VirtualBaseClassOffsetOffsets.end() && "Did not find index!");
2267 static std::unique_ptr<VTableLayout>
2268 CreateVTableLayout(const ItaniumVTableBuilder &Builder) {
2269 SmallVector<VTableLayout::VTableThunkTy, 1>
2270 VTableThunks(Builder.vtable_thunks_begin(), Builder.vtable_thunks_end());
2272 return llvm::make_unique<VTableLayout>(
2273 Builder.VTableIndices, Builder.vtable_components(), VTableThunks,
2274 Builder.getAddressPoints());
2278 ItaniumVTableContext::computeVTableRelatedInformation(const CXXRecordDecl *RD) {
2279 std::unique_ptr<const VTableLayout> &Entry = VTableLayouts[RD];
2281 // Check if we've computed this information before.
2285 ItaniumVTableBuilder Builder(*this, RD, CharUnits::Zero(),
2286 /*MostDerivedClassIsVirtual=*/0, RD);
2287 Entry = CreateVTableLayout(Builder);
2289 MethodVTableIndices.insert(Builder.vtable_indices_begin(),
2290 Builder.vtable_indices_end());
2292 // Add the known thunks.
2293 Thunks.insert(Builder.thunks_begin(), Builder.thunks_end());
2295 // If we don't have the vbase information for this class, insert it.
2296 // getVirtualBaseOffsetOffset will compute it separately without computing
2297 // the rest of the vtable related information.
2298 if (!RD->getNumVBases())
2301 const CXXRecordDecl *VBase =
2302 RD->vbases_begin()->getType()->getAsCXXRecordDecl();
2304 if (VirtualBaseClassOffsetOffsets.count(std::make_pair(RD, VBase)))
2307 for (const auto &I : Builder.getVBaseOffsetOffsets()) {
2308 // Insert all types.
2309 ClassPairTy ClassPair(RD, I.first);
2311 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I.second));
2315 std::unique_ptr<VTableLayout>
2316 ItaniumVTableContext::createConstructionVTableLayout(
2317 const CXXRecordDecl *MostDerivedClass, CharUnits MostDerivedClassOffset,
2318 bool MostDerivedClassIsVirtual, const CXXRecordDecl *LayoutClass) {
2319 ItaniumVTableBuilder Builder(*this, MostDerivedClass, MostDerivedClassOffset,
2320 MostDerivedClassIsVirtual, LayoutClass);
2321 return CreateVTableLayout(Builder);
2326 // Vtables in the Microsoft ABI are different from the Itanium ABI.
2328 // The main differences are:
2329 // 1. Separate vftable and vbtable.
2331 // 2. Each subobject with a vfptr gets its own vftable rather than an address
2332 // point in a single vtable shared between all the subobjects.
2333 // Each vftable is represented by a separate section and virtual calls
2334 // must be done using the vftable which has a slot for the function to be
2337 // 3. Virtual method definitions expect their 'this' parameter to point to the
2338 // first vfptr whose table provides a compatible overridden method. In many
2339 // cases, this permits the original vf-table entry to directly call
2340 // the method instead of passing through a thunk.
2341 // See example before VFTableBuilder::ComputeThisOffset below.
2343 // A compatible overridden method is one which does not have a non-trivial
2344 // covariant-return adjustment.
2346 // The first vfptr is the one with the lowest offset in the complete-object
2347 // layout of the defining class, and the method definition will subtract
2348 // that constant offset from the parameter value to get the real 'this'
2349 // value. Therefore, if the offset isn't really constant (e.g. if a virtual
2350 // function defined in a virtual base is overridden in a more derived
2351 // virtual base and these bases have a reverse order in the complete
2352 // object), the vf-table may require a this-adjustment thunk.
2354 // 4. vftables do not contain new entries for overrides that merely require
2355 // this-adjustment. Together with #3, this keeps vf-tables smaller and
2356 // eliminates the need for this-adjustment thunks in many cases, at the cost
2357 // of often requiring redundant work to adjust the "this" pointer.
2359 // 5. Instead of VTT and constructor vtables, vbtables and vtordisps are used.
2360 // Vtordisps are emitted into the class layout if a class has
2361 // a) a user-defined ctor/dtor
2363 // b) a method overriding a method in a virtual base.
2365 // To get a better understanding of this code,
2366 // you might want to see examples in test/CodeGenCXX/microsoft-abi-vtables-*.cpp
2368 class VFTableBuilder {
2370 typedef MicrosoftVTableContext::MethodVFTableLocation MethodVFTableLocation;
2372 typedef llvm::DenseMap<GlobalDecl, MethodVFTableLocation>
2373 MethodVFTableLocationsTy;
2375 typedef llvm::iterator_range<MethodVFTableLocationsTy::const_iterator>
2376 method_locations_range;
2379 /// VTables - Global vtable information.
2380 MicrosoftVTableContext &VTables;
2382 /// Context - The ASTContext which we will use for layout information.
2383 ASTContext &Context;
2385 /// MostDerivedClass - The most derived class for which we're building this
2387 const CXXRecordDecl *MostDerivedClass;
2389 const ASTRecordLayout &MostDerivedClassLayout;
2391 const VPtrInfo &WhichVFPtr;
2393 /// FinalOverriders - The final overriders of the most derived class.
2394 const FinalOverriders Overriders;
2396 /// Components - The components of the vftable being built.
2397 SmallVector<VTableComponent, 64> Components;
2399 MethodVFTableLocationsTy MethodVFTableLocations;
2401 /// \brief Does this class have an RTTI component?
2402 bool HasRTTIComponent = false;
2404 /// MethodInfo - Contains information about a method in a vtable.
2405 /// (Used for computing 'this' pointer adjustment thunks.
2407 /// VBTableIndex - The nonzero index in the vbtable that
2408 /// this method's base has, or zero.
2409 const uint64_t VBTableIndex;
2411 /// VFTableIndex - The index in the vftable that this method has.
2412 const uint64_t VFTableIndex;
2414 /// Shadowed - Indicates if this vftable slot is shadowed by
2415 /// a slot for a covariant-return override. If so, it shouldn't be printed
2416 /// or used for vcalls in the most derived class.
2419 /// UsesExtraSlot - Indicates if this vftable slot was created because
2420 /// any of the overridden slots required a return adjusting thunk.
2423 MethodInfo(uint64_t VBTableIndex, uint64_t VFTableIndex,
2424 bool UsesExtraSlot = false)
2425 : VBTableIndex(VBTableIndex), VFTableIndex(VFTableIndex),
2426 Shadowed(false), UsesExtraSlot(UsesExtraSlot) {}
2429 : VBTableIndex(0), VFTableIndex(0), Shadowed(false),
2430 UsesExtraSlot(false) {}
2433 typedef llvm::DenseMap<const CXXMethodDecl *, MethodInfo> MethodInfoMapTy;
2435 /// MethodInfoMap - The information for all methods in the vftable we're
2436 /// currently building.
2437 MethodInfoMapTy MethodInfoMap;
2439 typedef llvm::DenseMap<uint64_t, ThunkInfo> VTableThunksMapTy;
2441 /// VTableThunks - The thunks by vftable index in the vftable currently being
2443 VTableThunksMapTy VTableThunks;
2445 typedef SmallVector<ThunkInfo, 1> ThunkInfoVectorTy;
2446 typedef llvm::DenseMap<const CXXMethodDecl *, ThunkInfoVectorTy> ThunksMapTy;
2448 /// Thunks - A map that contains all the thunks needed for all methods in the
2449 /// most derived class for which the vftable is currently being built.
2452 /// AddThunk - Add a thunk for the given method.
2453 void AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk) {
2454 SmallVector<ThunkInfo, 1> &ThunksVector = Thunks[MD];
2456 // Check if we have this thunk already.
2457 if (std::find(ThunksVector.begin(), ThunksVector.end(), Thunk) !=
2461 ThunksVector.push_back(Thunk);
2464 /// ComputeThisOffset - Returns the 'this' argument offset for the given
2465 /// method, relative to the beginning of the MostDerivedClass.
2466 CharUnits ComputeThisOffset(FinalOverriders::OverriderInfo Overrider);
2468 void CalculateVtordispAdjustment(FinalOverriders::OverriderInfo Overrider,
2469 CharUnits ThisOffset, ThisAdjustment &TA);
2471 /// AddMethod - Add a single virtual member function to the vftable
2472 /// components vector.
2473 void AddMethod(const CXXMethodDecl *MD, ThunkInfo TI) {
2474 if (!TI.isEmpty()) {
2475 VTableThunks[Components.size()] = TI;
2478 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2479 assert(TI.Return.isEmpty() &&
2480 "Destructor can't have return adjustment!");
2481 Components.push_back(VTableComponent::MakeDeletingDtor(DD));
2483 Components.push_back(VTableComponent::MakeFunction(MD));
2487 /// AddMethods - Add the methods of this base subobject and the relevant
2488 /// subbases to the vftable we're currently laying out.
2489 void AddMethods(BaseSubobject Base, unsigned BaseDepth,
2490 const CXXRecordDecl *LastVBase,
2491 BasesSetVectorTy &VisitedBases);
2493 void LayoutVFTable() {
2494 // RTTI data goes before all other entries.
2495 if (HasRTTIComponent)
2496 Components.push_back(VTableComponent::MakeRTTI(MostDerivedClass));
2498 BasesSetVectorTy VisitedBases;
2499 AddMethods(BaseSubobject(MostDerivedClass, CharUnits::Zero()), 0, nullptr,
2501 assert((HasRTTIComponent ? Components.size() - 1 : Components.size()) &&
2502 "vftable can't be empty");
2504 assert(MethodVFTableLocations.empty());
2505 for (const auto &I : MethodInfoMap) {
2506 const CXXMethodDecl *MD = I.first;
2507 const MethodInfo &MI = I.second;
2508 // Skip the methods that the MostDerivedClass didn't override
2509 // and the entries shadowed by return adjusting thunks.
2510 if (MD->getParent() != MostDerivedClass || MI.Shadowed)
2512 MethodVFTableLocation Loc(MI.VBTableIndex, WhichVFPtr.getVBaseWithVPtr(),
2513 WhichVFPtr.NonVirtualOffset, MI.VFTableIndex);
2514 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2515 MethodVFTableLocations[GlobalDecl(DD, Dtor_Deleting)] = Loc;
2517 MethodVFTableLocations[MD] = Loc;
2523 VFTableBuilder(MicrosoftVTableContext &VTables,
2524 const CXXRecordDecl *MostDerivedClass, const VPtrInfo &Which)
2526 Context(MostDerivedClass->getASTContext()),
2527 MostDerivedClass(MostDerivedClass),
2528 MostDerivedClassLayout(Context.getASTRecordLayout(MostDerivedClass)),
2530 Overriders(MostDerivedClass, CharUnits(), MostDerivedClass) {
2531 // Provide the RTTI component if RTTIData is enabled. If the vftable would
2532 // be available externally, we should not provide the RTTI componenent. It
2533 // is currently impossible to get available externally vftables with either
2534 // dllimport or extern template instantiations, but eventually we may add a
2535 // flag to support additional devirtualization that needs this.
2536 if (Context.getLangOpts().RTTIData)
2537 HasRTTIComponent = true;
2541 if (Context.getLangOpts().DumpVTableLayouts)
2542 dumpLayout(llvm::outs());
2545 uint64_t getNumThunks() const { return Thunks.size(); }
2547 ThunksMapTy::const_iterator thunks_begin() const { return Thunks.begin(); }
2549 ThunksMapTy::const_iterator thunks_end() const { return Thunks.end(); }
2551 method_locations_range vtable_locations() const {
2552 return method_locations_range(MethodVFTableLocations.begin(),
2553 MethodVFTableLocations.end());
2556 ArrayRef<VTableComponent> vtable_components() const { return Components; }
2558 VTableThunksMapTy::const_iterator vtable_thunks_begin() const {
2559 return VTableThunks.begin();
2562 VTableThunksMapTy::const_iterator vtable_thunks_end() const {
2563 return VTableThunks.end();
2566 void dumpLayout(raw_ostream &);
2571 // Let's study one class hierarchy as an example:
2573 // virtual void f();
2577 // struct B : virtual A {
2578 // virtual void f();
2583 // 0 | (A vftable pointer)
2587 // 0 | (B vbtable pointer)
2588 // 4 | struct A (virtual base)
2589 // 4 | (A vftable pointer)
2592 // Let's assume we have a pointer to the A part of an object of dynamic type B:
2597 // In this hierarchy, f() belongs to the vftable of A, so B::f() expects
2598 // "this" parameter to point at the A subobject, which is B+4.
2599 // In the B::f() prologue, it adjusts "this" back to B by subtracting 4,
2600 // performed as a *static* adjustment.
2602 // Interesting thing happens when we alter the relative placement of A and B
2603 // subobjects in a class:
2604 // struct C : virtual B { };
2610 // Respective record layout is:
2611 // 0 | (C vbtable pointer)
2612 // 4 | struct A (virtual base)
2613 // 4 | (A vftable pointer)
2615 // 12 | struct B (virtual base)
2616 // 12 | (B vbtable pointer)
2618 // The final overrider of f() in class C is still B::f(), so B+4 should be
2619 // passed as "this" to that code. However, "a" points at B-8, so the respective
2620 // vftable entry should hold a thunk that adds 12 to the "this" argument before
2621 // performing a tail call to B::f().
2623 // With this example in mind, we can now calculate the 'this' argument offset
2624 // for the given method, relative to the beginning of the MostDerivedClass.
2626 VFTableBuilder::ComputeThisOffset(FinalOverriders::OverriderInfo Overrider) {
2627 BasesSetVectorTy Bases;
2630 // Find the set of least derived bases that define the given method.
2631 OverriddenMethodsSetTy VisitedOverriddenMethods;
2632 auto InitialOverriddenDefinitionCollector = [&](
2633 const CXXMethodDecl *OverriddenMD) {
2634 if (OverriddenMD->size_overridden_methods() == 0)
2635 Bases.insert(OverriddenMD->getParent());
2636 // Don't recurse on this method if we've already collected it.
2637 return VisitedOverriddenMethods.insert(OverriddenMD).second;
2639 visitAllOverriddenMethods(Overrider.Method,
2640 InitialOverriddenDefinitionCollector);
2643 // If there are no overrides then 'this' is located
2644 // in the base that defines the method.
2645 if (Bases.size() == 0)
2646 return Overrider.Offset;
2649 Overrider.Method->getParent()->lookupInBases(
2650 [&Bases](const CXXBaseSpecifier *Specifier, CXXBasePath &) {
2651 return Bases.count(Specifier->getType()->getAsCXXRecordDecl());
2655 // This will hold the smallest this offset among overridees of MD.
2656 // This implies that an offset of a non-virtual base will dominate an offset
2657 // of a virtual base to potentially reduce the number of thunks required
2658 // in the derived classes that inherit this method.
2662 const ASTRecordLayout &OverriderRDLayout =
2663 Context.getASTRecordLayout(Overrider.Method->getParent());
2664 for (const CXXBasePath &Path : Paths) {
2665 CharUnits ThisOffset = Overrider.Offset;
2666 CharUnits LastVBaseOffset;
2668 // For each path from the overrider to the parents of the overridden
2669 // methods, traverse the path, calculating the this offset in the most
2671 for (const CXXBasePathElement &Element : Path) {
2672 QualType CurTy = Element.Base->getType();
2673 const CXXRecordDecl *PrevRD = Element.Class,
2674 *CurRD = CurTy->getAsCXXRecordDecl();
2675 const ASTRecordLayout &Layout = Context.getASTRecordLayout(PrevRD);
2677 if (Element.Base->isVirtual()) {
2678 // The interesting things begin when you have virtual inheritance.
2679 // The final overrider will use a static adjustment equal to the offset
2680 // of the vbase in the final overrider class.
2681 // For example, if the final overrider is in a vbase B of the most
2682 // derived class and it overrides a method of the B's own vbase A,
2683 // it uses A* as "this". In its prologue, it can cast A* to B* with
2684 // a static offset. This offset is used regardless of the actual
2685 // offset of A from B in the most derived class, requiring an
2686 // this-adjusting thunk in the vftable if A and B are laid out
2687 // differently in the most derived class.
2688 LastVBaseOffset = ThisOffset =
2689 Overrider.Offset + OverriderRDLayout.getVBaseClassOffset(CurRD);
2691 ThisOffset += Layout.getBaseClassOffset(CurRD);
2695 if (isa<CXXDestructorDecl>(Overrider.Method)) {
2696 if (LastVBaseOffset.isZero()) {
2697 // If a "Base" class has at least one non-virtual base with a virtual
2698 // destructor, the "Base" virtual destructor will take the address
2699 // of the "Base" subobject as the "this" argument.
2700 ThisOffset = Overrider.Offset;
2702 // A virtual destructor of a virtual base takes the address of the
2703 // virtual base subobject as the "this" argument.
2704 ThisOffset = LastVBaseOffset;
2708 if (Ret > ThisOffset || First) {
2714 assert(!First && "Method not found in the given subobject?");
2718 // Things are getting even more complex when the "this" adjustment has to
2719 // use a dynamic offset instead of a static one, or even two dynamic offsets.
2720 // This is sometimes required when a virtual call happens in the middle of
2721 // a non-most-derived class construction or destruction.
2723 // Let's take a look at the following example:
2725 // virtual void f();
2728 // void foo(A *a) { a->f(); } // Knows nothing about siblings of A.
2730 // struct B : virtual A {
2731 // virtual void f();
2737 // struct C : virtual B {
2738 // virtual void f();
2741 // Record layouts for these classes are:
2743 // 0 | (A vftable pointer)
2746 // 0 | (B vbtable pointer)
2747 // 4 | (vtordisp for vbase A)
2748 // 8 | struct A (virtual base)
2749 // 8 | (A vftable pointer)
2752 // 0 | (C vbtable pointer)
2753 // 4 | (vtordisp for vbase A)
2754 // 8 | struct A (virtual base) // A precedes B!
2755 // 8 | (A vftable pointer)
2756 // 12 | struct B (virtual base)
2757 // 12 | (B vbtable pointer)
2759 // When one creates an object of type C, the C constructor:
2760 // - initializes all the vbptrs, then
2761 // - calls the A subobject constructor
2762 // (initializes A's vfptr with an address of A vftable), then
2763 // - calls the B subobject constructor
2764 // (initializes A's vfptr with an address of B vftable and vtordisp for A),
2765 // that in turn calls foo(), then
2766 // - initializes A's vfptr with an address of C vftable and zeroes out the
2768 // FIXME: if a structor knows it belongs to MDC, why doesn't it use a vftable
2769 // without vtordisp thunks?
2770 // FIXME: how are vtordisp handled in the presence of nooverride/final?
2772 // When foo() is called, an object with a layout of class C has a vftable
2773 // referencing B::f() that assumes a B layout, so the "this" adjustments are
2774 // incorrect, unless an extra adjustment is done. This adjustment is called
2775 // "vtordisp adjustment". Vtordisp basically holds the difference between the
2776 // actual location of a vbase in the layout class and the location assumed by
2777 // the vftable of the class being constructed/destructed. Vtordisp is only
2778 // needed if "this" escapes a
2779 // structor (or we can't prove otherwise).
2780 // [i.e. vtordisp is a dynamic adjustment for a static adjustment, which is an
2781 // estimation of a dynamic adjustment]
2783 // foo() gets a pointer to the A vbase and doesn't know anything about B or C,
2784 // so it just passes that pointer as "this" in a virtual call.
2785 // If there was no vtordisp, that would just dispatch to B::f().
2786 // However, B::f() assumes B+8 is passed as "this",
2787 // yet the pointer foo() passes along is B-4 (i.e. C+8).
2788 // An extra adjustment is needed, so we emit a thunk into the B vftable.
2789 // This vtordisp thunk subtracts the value of vtordisp
2790 // from the "this" argument (-12) before making a tailcall to B::f().
2792 // Let's consider an even more complex example:
2793 // struct D : virtual B, virtual C {
2800 // 0 | (D vbtable pointer)
2801 // 4 | (vtordisp for vbase A)
2802 // 8 | struct A (virtual base) // A precedes both B and C!
2803 // 8 | (A vftable pointer)
2804 // 12 | struct B (virtual base) // B precedes C!
2805 // 12 | (B vbtable pointer)
2806 // 16 | struct C (virtual base)
2807 // 16 | (C vbtable pointer)
2809 // When D::D() calls foo(), we find ourselves in a thunk that should tailcall
2810 // to C::f(), which assumes C+8 as its "this" parameter. This time, foo()
2811 // passes along A, which is C-8. The A vtordisp holds
2812 // "D.vbptr[index_of_A] - offset_of_A_in_D"
2813 // and we statically know offset_of_A_in_D, so can get a pointer to D.
2814 // When we know it, we can make an extra vbtable lookup to locate the C vbase
2815 // and one extra static adjustment to calculate the expected value of C+8.
2816 void VFTableBuilder::CalculateVtordispAdjustment(
2817 FinalOverriders::OverriderInfo Overrider, CharUnits ThisOffset,
2818 ThisAdjustment &TA) {
2819 const ASTRecordLayout::VBaseOffsetsMapTy &VBaseMap =
2820 MostDerivedClassLayout.getVBaseOffsetsMap();
2821 const ASTRecordLayout::VBaseOffsetsMapTy::const_iterator &VBaseMapEntry =
2822 VBaseMap.find(WhichVFPtr.getVBaseWithVPtr());
2823 assert(VBaseMapEntry != VBaseMap.end());
2825 // If there's no vtordisp or the final overrider is defined in the same vbase
2826 // as the initial declaration, we don't need any vtordisp adjustment.
2827 if (!VBaseMapEntry->second.hasVtorDisp() ||
2828 Overrider.VirtualBase == WhichVFPtr.getVBaseWithVPtr())
2831 // OK, now we know we need to use a vtordisp thunk.
2832 // The implicit vtordisp field is located right before the vbase.
2833 CharUnits OffsetOfVBaseWithVFPtr = VBaseMapEntry->second.VBaseOffset;
2834 TA.Virtual.Microsoft.VtordispOffset =
2835 (OffsetOfVBaseWithVFPtr - WhichVFPtr.FullOffsetInMDC).getQuantity() - 4;
2837 // A simple vtordisp thunk will suffice if the final overrider is defined
2838 // in either the most derived class or its non-virtual base.
2839 if (Overrider.Method->getParent() == MostDerivedClass ||
2840 !Overrider.VirtualBase)
2843 // Otherwise, we need to do use the dynamic offset of the final overrider
2844 // in order to get "this" adjustment right.
2845 TA.Virtual.Microsoft.VBPtrOffset =
2846 (OffsetOfVBaseWithVFPtr + WhichVFPtr.NonVirtualOffset -
2847 MostDerivedClassLayout.getVBPtrOffset()).getQuantity();
2848 TA.Virtual.Microsoft.VBOffsetOffset =
2849 Context.getTypeSizeInChars(Context.IntTy).getQuantity() *
2850 VTables.getVBTableIndex(MostDerivedClass, Overrider.VirtualBase);
2852 TA.NonVirtual = (ThisOffset - Overrider.Offset).getQuantity();
2855 static void GroupNewVirtualOverloads(
2856 const CXXRecordDecl *RD,
2857 SmallVector<const CXXMethodDecl *, 10> &VirtualMethods) {
2858 // Put the virtual methods into VirtualMethods in the proper order:
2859 // 1) Group overloads by declaration name. New groups are added to the
2860 // vftable in the order of their first declarations in this class
2861 // (including overrides, non-virtual methods and any other named decl that
2862 // might be nested within the class).
2863 // 2) In each group, new overloads appear in the reverse order of declaration.
2864 typedef SmallVector<const CXXMethodDecl *, 1> MethodGroup;
2865 SmallVector<MethodGroup, 10> Groups;
2866 typedef llvm::DenseMap<DeclarationName, unsigned> VisitedGroupIndicesTy;
2867 VisitedGroupIndicesTy VisitedGroupIndices;
2868 for (const auto *D : RD->decls()) {
2869 const auto *ND = dyn_cast<NamedDecl>(D);
2872 VisitedGroupIndicesTy::iterator J;
2874 std::tie(J, Inserted) = VisitedGroupIndices.insert(
2875 std::make_pair(ND->getDeclName(), Groups.size()));
2877 Groups.push_back(MethodGroup());
2878 if (const auto *MD = dyn_cast<CXXMethodDecl>(ND))
2879 if (MD->isVirtual())
2880 Groups[J->second].push_back(MD->getCanonicalDecl());
2883 for (const MethodGroup &Group : Groups)
2884 VirtualMethods.append(Group.rbegin(), Group.rend());
2887 static bool isDirectVBase(const CXXRecordDecl *Base, const CXXRecordDecl *RD) {
2888 for (const auto &B : RD->bases()) {
2889 if (B.isVirtual() && B.getType()->getAsCXXRecordDecl() == Base)
2895 void VFTableBuilder::AddMethods(BaseSubobject Base, unsigned BaseDepth,
2896 const CXXRecordDecl *LastVBase,
2897 BasesSetVectorTy &VisitedBases) {
2898 const CXXRecordDecl *RD = Base.getBase();
2899 if (!RD->isPolymorphic())
2902 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
2904 // See if this class expands a vftable of the base we look at, which is either
2905 // the one defined by the vfptr base path or the primary base of the current
2907 const CXXRecordDecl *NextBase = nullptr, *NextLastVBase = LastVBase;
2908 CharUnits NextBaseOffset;
2909 if (BaseDepth < WhichVFPtr.PathToIntroducingObject.size()) {
2910 NextBase = WhichVFPtr.PathToIntroducingObject[BaseDepth];
2911 if (isDirectVBase(NextBase, RD)) {
2912 NextLastVBase = NextBase;
2913 NextBaseOffset = MostDerivedClassLayout.getVBaseClassOffset(NextBase);
2916 Base.getBaseOffset() + Layout.getBaseClassOffset(NextBase);
2918 } else if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
2919 assert(!Layout.isPrimaryBaseVirtual() &&
2920 "No primary virtual bases in this ABI");
2921 NextBase = PrimaryBase;
2922 NextBaseOffset = Base.getBaseOffset();
2926 AddMethods(BaseSubobject(NextBase, NextBaseOffset), BaseDepth + 1,
2927 NextLastVBase, VisitedBases);
2928 if (!VisitedBases.insert(NextBase))
2929 llvm_unreachable("Found a duplicate primary base!");
2932 SmallVector<const CXXMethodDecl*, 10> VirtualMethods;
2933 // Put virtual methods in the proper order.
2934 GroupNewVirtualOverloads(RD, VirtualMethods);
2936 // Now go through all virtual member functions and add them to the current
2937 // vftable. This is done by
2938 // - replacing overridden methods in their existing slots, as long as they
2939 // don't require return adjustment; calculating This adjustment if needed.
2940 // - adding new slots for methods of the current base not present in any
2942 // - adding new slots for methods that require Return adjustment.
2943 // We keep track of the methods visited in the sub-bases in MethodInfoMap.
2944 for (const CXXMethodDecl *MD : VirtualMethods) {
2945 FinalOverriders::OverriderInfo FinalOverrider =
2946 Overriders.getOverrider(MD, Base.getBaseOffset());
2947 const CXXMethodDecl *FinalOverriderMD = FinalOverrider.Method;
2948 const CXXMethodDecl *OverriddenMD =
2949 FindNearestOverriddenMethod(MD, VisitedBases);
2951 ThisAdjustment ThisAdjustmentOffset;
2952 bool ReturnAdjustingThunk = false, ForceReturnAdjustmentMangling = false;
2953 CharUnits ThisOffset = ComputeThisOffset(FinalOverrider);
2954 ThisAdjustmentOffset.NonVirtual =
2955 (ThisOffset - WhichVFPtr.FullOffsetInMDC).getQuantity();
2956 if ((OverriddenMD || FinalOverriderMD != MD) &&
2957 WhichVFPtr.getVBaseWithVPtr())
2958 CalculateVtordispAdjustment(FinalOverrider, ThisOffset,
2959 ThisAdjustmentOffset);
2962 LastVBase ? VTables.getVBTableIndex(MostDerivedClass, LastVBase) : 0;
2965 // If MD overrides anything in this vftable, we need to update the
2967 MethodInfoMapTy::iterator OverriddenMDIterator =
2968 MethodInfoMap.find(OverriddenMD);
2970 // If the overridden method went to a different vftable, skip it.
2971 if (OverriddenMDIterator == MethodInfoMap.end())
2974 MethodInfo &OverriddenMethodInfo = OverriddenMDIterator->second;
2976 VBIndex = OverriddenMethodInfo.VBTableIndex;
2978 // Let's check if the overrider requires any return adjustments.
2979 // We must create a new slot if the MD's return type is not trivially
2980 // convertible to the OverriddenMD's one.
2981 // Once a chain of method overrides adds a return adjusting vftable slot,
2982 // all subsequent overrides will also use an extra method slot.
2983 ReturnAdjustingThunk = !ComputeReturnAdjustmentBaseOffset(
2984 Context, MD, OverriddenMD).isEmpty() ||
2985 OverriddenMethodInfo.UsesExtraSlot;
2987 if (!ReturnAdjustingThunk) {
2988 // No return adjustment needed - just replace the overridden method info
2989 // with the current info.
2990 MethodInfo MI(VBIndex, OverriddenMethodInfo.VFTableIndex);
2991 MethodInfoMap.erase(OverriddenMDIterator);
2993 assert(!MethodInfoMap.count(MD) &&
2994 "Should not have method info for this method yet!");
2995 MethodInfoMap.insert(std::make_pair(MD, MI));
2999 // In case we need a return adjustment, we'll add a new slot for
3000 // the overrider. Mark the overriden method as shadowed by the new slot.
3001 OverriddenMethodInfo.Shadowed = true;
3003 // Force a special name mangling for a return-adjusting thunk
3004 // unless the method is the final overrider without this adjustment.
3005 ForceReturnAdjustmentMangling =
3006 !(MD == FinalOverriderMD && ThisAdjustmentOffset.isEmpty());
3007 } else if (Base.getBaseOffset() != WhichVFPtr.FullOffsetInMDC ||
3008 MD->size_overridden_methods()) {
3009 // Skip methods that don't belong to the vftable of the current class,
3010 // e.g. each method that wasn't seen in any of the visited sub-bases
3011 // but overrides multiple methods of other sub-bases.
3015 // If we got here, MD is a method not seen in any of the sub-bases or
3016 // it requires return adjustment. Insert the method info for this method.
3017 MethodInfo MI(VBIndex,
3018 HasRTTIComponent ? Components.size() - 1 : Components.size(),
3019 ReturnAdjustingThunk);
3021 assert(!MethodInfoMap.count(MD) &&
3022 "Should not have method info for this method yet!");
3023 MethodInfoMap.insert(std::make_pair(MD, MI));
3025 // Check if this overrider needs a return adjustment.
3026 // We don't want to do this for pure virtual member functions.
3027 BaseOffset ReturnAdjustmentOffset;
3028 ReturnAdjustment ReturnAdjustment;
3029 if (!FinalOverriderMD->isPure()) {
3030 ReturnAdjustmentOffset =
3031 ComputeReturnAdjustmentBaseOffset(Context, FinalOverriderMD, MD);
3033 if (!ReturnAdjustmentOffset.isEmpty()) {
3034 ForceReturnAdjustmentMangling = true;
3035 ReturnAdjustment.NonVirtual =
3036 ReturnAdjustmentOffset.NonVirtualOffset.getQuantity();
3037 if (ReturnAdjustmentOffset.VirtualBase) {
3038 const ASTRecordLayout &DerivedLayout =
3039 Context.getASTRecordLayout(ReturnAdjustmentOffset.DerivedClass);
3040 ReturnAdjustment.Virtual.Microsoft.VBPtrOffset =
3041 DerivedLayout.getVBPtrOffset().getQuantity();
3042 ReturnAdjustment.Virtual.Microsoft.VBIndex =
3043 VTables.getVBTableIndex(ReturnAdjustmentOffset.DerivedClass,
3044 ReturnAdjustmentOffset.VirtualBase);
3048 AddMethod(FinalOverriderMD,
3049 ThunkInfo(ThisAdjustmentOffset, ReturnAdjustment,
3050 ForceReturnAdjustmentMangling ? MD : nullptr));
3054 static void PrintBasePath(const VPtrInfo::BasePath &Path, raw_ostream &Out) {
3055 for (const CXXRecordDecl *Elem :
3056 llvm::make_range(Path.rbegin(), Path.rend())) {
3058 Elem->printQualifiedName(Out);
3063 static void dumpMicrosoftThunkAdjustment(const ThunkInfo &TI, raw_ostream &Out,
3064 bool ContinueFirstLine) {
3065 const ReturnAdjustment &R = TI.Return;
3066 bool Multiline = false;
3067 const char *LinePrefix = "\n ";
3068 if (!R.isEmpty() || TI.Method) {
3069 if (!ContinueFirstLine)
3071 Out << "[return adjustment (to type '"
3072 << TI.Method->getReturnType().getCanonicalType().getAsString()
3074 if (R.Virtual.Microsoft.VBPtrOffset)
3075 Out << "vbptr at offset " << R.Virtual.Microsoft.VBPtrOffset << ", ";
3076 if (R.Virtual.Microsoft.VBIndex)
3077 Out << "vbase #" << R.Virtual.Microsoft.VBIndex << ", ";
3078 Out << R.NonVirtual << " non-virtual]";
3082 const ThisAdjustment &T = TI.This;
3084 if (Multiline || !ContinueFirstLine)
3086 Out << "[this adjustment: ";
3087 if (!TI.This.Virtual.isEmpty()) {
3088 assert(T.Virtual.Microsoft.VtordispOffset < 0);
3089 Out << "vtordisp at " << T.Virtual.Microsoft.VtordispOffset << ", ";
3090 if (T.Virtual.Microsoft.VBPtrOffset) {
3091 Out << "vbptr at " << T.Virtual.Microsoft.VBPtrOffset
3093 assert(T.Virtual.Microsoft.VBOffsetOffset > 0);
3094 Out << LinePrefix << " vboffset at "
3095 << T.Virtual.Microsoft.VBOffsetOffset << " in the vbtable, ";
3098 Out << T.NonVirtual << " non-virtual]";
3102 void VFTableBuilder::dumpLayout(raw_ostream &Out) {
3103 Out << "VFTable for ";
3104 PrintBasePath(WhichVFPtr.PathToIntroducingObject, Out);
3106 MostDerivedClass->printQualifiedName(Out);
3107 Out << "' (" << Components.size()
3108 << (Components.size() == 1 ? " entry" : " entries") << ").\n";
3110 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
3111 Out << llvm::format("%4d | ", I);
3113 const VTableComponent &Component = Components[I];
3115 // Dump the component.
3116 switch (Component.getKind()) {
3117 case VTableComponent::CK_RTTI:
3118 Component.getRTTIDecl()->printQualifiedName(Out);
3122 case VTableComponent::CK_FunctionPointer: {
3123 const CXXMethodDecl *MD = Component.getFunctionDecl();
3125 // FIXME: Figure out how to print the real thunk type, since they can
3126 // differ in the return type.
3127 std::string Str = PredefinedExpr::ComputeName(
3128 PredefinedExpr::PrettyFunctionNoVirtual, MD);
3133 if (MD->isDeleted())
3134 Out << " [deleted]";
3136 ThunkInfo Thunk = VTableThunks.lookup(I);
3137 if (!Thunk.isEmpty())
3138 dumpMicrosoftThunkAdjustment(Thunk, Out, /*ContinueFirstLine=*/false);
3143 case VTableComponent::CK_DeletingDtorPointer: {
3144 const CXXDestructorDecl *DD = Component.getDestructorDecl();
3146 DD->printQualifiedName(Out);
3147 Out << "() [scalar deleting]";
3152 ThunkInfo Thunk = VTableThunks.lookup(I);
3153 if (!Thunk.isEmpty()) {
3154 assert(Thunk.Return.isEmpty() &&
3155 "No return adjustment needed for destructors!");
3156 dumpMicrosoftThunkAdjustment(Thunk, Out, /*ContinueFirstLine=*/false);
3163 DiagnosticsEngine &Diags = Context.getDiagnostics();
3164 unsigned DiagID = Diags.getCustomDiagID(
3165 DiagnosticsEngine::Error,
3166 "Unexpected vftable component type %0 for component number %1");
3167 Diags.Report(MostDerivedClass->getLocation(), DiagID)
3168 << I << Component.getKind();
3176 if (!Thunks.empty()) {
3177 // We store the method names in a map to get a stable order.
3178 std::map<std::string, const CXXMethodDecl *> MethodNamesAndDecls;
3180 for (const auto &I : Thunks) {
3181 const CXXMethodDecl *MD = I.first;
3182 std::string MethodName = PredefinedExpr::ComputeName(
3183 PredefinedExpr::PrettyFunctionNoVirtual, MD);
3185 MethodNamesAndDecls.insert(std::make_pair(MethodName, MD));
3188 for (const auto &MethodNameAndDecl : MethodNamesAndDecls) {
3189 const std::string &MethodName = MethodNameAndDecl.first;
3190 const CXXMethodDecl *MD = MethodNameAndDecl.second;
3192 ThunkInfoVectorTy ThunksVector = Thunks[MD];
3193 std::stable_sort(ThunksVector.begin(), ThunksVector.end(),
3194 [](const ThunkInfo &LHS, const ThunkInfo &RHS) {
3195 // Keep different thunks with the same adjustments in the order they
3196 // were put into the vector.
3197 return std::tie(LHS.This, LHS.Return) < std::tie(RHS.This, RHS.Return);
3200 Out << "Thunks for '" << MethodName << "' (" << ThunksVector.size();
3201 Out << (ThunksVector.size() == 1 ? " entry" : " entries") << ").\n";
3203 for (unsigned I = 0, E = ThunksVector.size(); I != E; ++I) {
3204 const ThunkInfo &Thunk = ThunksVector[I];
3206 Out << llvm::format("%4d | ", I);
3207 dumpMicrosoftThunkAdjustment(Thunk, Out, /*ContinueFirstLine=*/true);
3218 static bool setsIntersect(const llvm::SmallPtrSet<const CXXRecordDecl *, 4> &A,
3219 ArrayRef<const CXXRecordDecl *> B) {
3220 for (const CXXRecordDecl *Decl : B) {
3227 static bool rebucketPaths(VPtrInfoVector &Paths);
3229 /// Produces MSVC-compatible vbtable data. The symbols produced by this
3230 /// algorithm match those produced by MSVC 2012 and newer, which is different
3233 /// MSVC 2012 appears to minimize the vbtable names using the following
3234 /// algorithm. First, walk the class hierarchy in the usual order, depth first,
3235 /// left to right, to find all of the subobjects which contain a vbptr field.
3236 /// Visiting each class node yields a list of inheritance paths to vbptrs. Each
3237 /// record with a vbptr creates an initially empty path.
3239 /// To combine paths from child nodes, the paths are compared to check for
3240 /// ambiguity. Paths are "ambiguous" if multiple paths have the same set of
3241 /// components in the same order. Each group of ambiguous paths is extended by
3242 /// appending the class of the base from which it came. If the current class
3243 /// node produced an ambiguous path, its path is extended with the current class.
3244 /// After extending paths, MSVC again checks for ambiguity, and extends any
3245 /// ambiguous path which wasn't already extended. Because each node yields an
3246 /// unambiguous set of paths, MSVC doesn't need to extend any path more than once
3247 /// to produce an unambiguous set of paths.
3249 /// TODO: Presumably vftables use the same algorithm.
3250 void MicrosoftVTableContext::computeVTablePaths(bool ForVBTables,
3251 const CXXRecordDecl *RD,
3252 VPtrInfoVector &Paths) {
3253 assert(Paths.empty());
3254 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
3256 // Base case: this subobject has its own vptr.
3257 if (ForVBTables ? Layout.hasOwnVBPtr() : Layout.hasOwnVFPtr())
3258 Paths.push_back(llvm::make_unique<VPtrInfo>(RD));
3260 // Recursive case: get all the vbtables from our bases and remove anything
3261 // that shares a virtual base.
3262 llvm::SmallPtrSet<const CXXRecordDecl*, 4> VBasesSeen;
3263 for (const auto &B : RD->bases()) {
3264 const CXXRecordDecl *Base = B.getType()->getAsCXXRecordDecl();
3265 if (B.isVirtual() && VBasesSeen.count(Base))
3268 if (!Base->isDynamicClass())
3271 const VPtrInfoVector &BasePaths =
3272 ForVBTables ? enumerateVBTables(Base) : getVFPtrOffsets(Base);
3274 for (const std::unique_ptr<VPtrInfo> &BaseInfo : BasePaths) {
3275 // Don't include the path if it goes through a virtual base that we've
3276 // already included.
3277 if (setsIntersect(VBasesSeen, BaseInfo->ContainingVBases))
3280 // Copy the path and adjust it as necessary.
3281 auto P = llvm::make_unique<VPtrInfo>(*BaseInfo);
3283 // We mangle Base into the path if the path would've been ambiguous and it
3284 // wasn't already extended with Base.
3285 if (P->MangledPath.empty() || P->MangledPath.back() != Base)
3286 P->NextBaseToMangle = Base;
3288 // Keep track of which vtable the derived class is going to extend with
3289 // new methods or bases. We append to either the vftable of our primary
3290 // base, or the first non-virtual base that has a vbtable.
3291 if (P->ObjectWithVPtr == Base &&
3292 Base == (ForVBTables ? Layout.getBaseSharingVBPtr()
3293 : Layout.getPrimaryBase()))
3294 P->ObjectWithVPtr = RD;
3296 // Keep track of the full adjustment from the MDC to this vtable. The
3297 // adjustment is captured by an optional vbase and a non-virtual offset.
3299 P->ContainingVBases.push_back(Base);
3300 else if (P->ContainingVBases.empty())
3301 P->NonVirtualOffset += Layout.getBaseClassOffset(Base);
3303 // Update the full offset in the MDC.
3304 P->FullOffsetInMDC = P->NonVirtualOffset;
3305 if (const CXXRecordDecl *VB = P->getVBaseWithVPtr())
3306 P->FullOffsetInMDC += Layout.getVBaseClassOffset(VB);
3308 Paths.push_back(std::move(P));
3312 VBasesSeen.insert(Base);
3314 // After visiting any direct base, we've transitively visited all of its
3315 // morally virtual bases.
3316 for (const auto &VB : Base->vbases())
3317 VBasesSeen.insert(VB.getType()->getAsCXXRecordDecl());
3320 // Sort the paths into buckets, and if any of them are ambiguous, extend all
3321 // paths in ambiguous buckets.
3322 bool Changed = true;
3324 Changed = rebucketPaths(Paths);
3327 static bool extendPath(VPtrInfo &P) {
3328 if (P.NextBaseToMangle) {
3329 P.MangledPath.push_back(P.NextBaseToMangle);
3330 P.NextBaseToMangle = nullptr;// Prevent the path from being extended twice.
3336 static bool rebucketPaths(VPtrInfoVector &Paths) {
3337 // What we're essentially doing here is bucketing together ambiguous paths.
3338 // Any bucket with more than one path in it gets extended by NextBase, which
3339 // is usually the direct base of the inherited the vbptr. This code uses a
3340 // sorted vector to implement a multiset to form the buckets. Note that the
3341 // ordering is based on pointers, but it doesn't change our output order. The
3342 // current algorithm is designed to match MSVC 2012's names.
3343 llvm::SmallVector<std::reference_wrapper<VPtrInfo>, 2> PathsSorted;
3344 PathsSorted.reserve(Paths.size());
3345 for (auto& P : Paths)
3346 PathsSorted.push_back(*P);
3347 std::sort(PathsSorted.begin(), PathsSorted.end(),
3348 [](const VPtrInfo &LHS, const VPtrInfo &RHS) {
3349 return LHS.MangledPath < RHS.MangledPath;
3351 bool Changed = false;
3352 for (size_t I = 0, E = PathsSorted.size(); I != E;) {
3353 // Scan forward to find the end of the bucket.
3354 size_t BucketStart = I;
3358 PathsSorted[BucketStart].get().MangledPath ==
3359 PathsSorted[I].get().MangledPath);
3361 // If this bucket has multiple paths, extend them all.
3362 if (I - BucketStart > 1) {
3363 for (size_t II = BucketStart; II != I; ++II)
3364 Changed |= extendPath(PathsSorted[II]);
3365 assert(Changed && "no paths were extended to fix ambiguity");
3371 MicrosoftVTableContext::~MicrosoftVTableContext() {}
3374 typedef llvm::SetVector<BaseSubobject, std::vector<BaseSubobject>,
3375 llvm::DenseSet<BaseSubobject>> FullPathTy;
3378 // This recursive function finds all paths from a subobject centered at
3379 // (RD, Offset) to the subobject located at IntroducingObject.
3380 static void findPathsToSubobject(ASTContext &Context,
3381 const ASTRecordLayout &MostDerivedLayout,
3382 const CXXRecordDecl *RD, CharUnits Offset,
3383 BaseSubobject IntroducingObject,
3384 FullPathTy &FullPath,
3385 std::list<FullPathTy> &Paths) {
3386 if (BaseSubobject(RD, Offset) == IntroducingObject) {
3387 Paths.push_back(FullPath);
3391 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
3393 for (const CXXBaseSpecifier &BS : RD->bases()) {
3394 const CXXRecordDecl *Base = BS.getType()->getAsCXXRecordDecl();
3395 CharUnits NewOffset = BS.isVirtual()
3396 ? MostDerivedLayout.getVBaseClassOffset(Base)
3397 : Offset + Layout.getBaseClassOffset(Base);
3398 FullPath.insert(BaseSubobject(Base, NewOffset));
3399 findPathsToSubobject(Context, MostDerivedLayout, Base, NewOffset,
3400 IntroducingObject, FullPath, Paths);
3401 FullPath.pop_back();
3405 // Return the paths which are not subsets of other paths.
3406 static void removeRedundantPaths(std::list<FullPathTy> &FullPaths) {
3407 FullPaths.remove_if([&](const FullPathTy &SpecificPath) {
3408 for (const FullPathTy &OtherPath : FullPaths) {
3409 if (&SpecificPath == &OtherPath)
3411 if (std::all_of(SpecificPath.begin(), SpecificPath.end(),
3412 [&](const BaseSubobject &BSO) {
3413 return OtherPath.count(BSO) != 0;
3422 static CharUnits getOffsetOfFullPath(ASTContext &Context,
3423 const CXXRecordDecl *RD,
3424 const FullPathTy &FullPath) {
3425 const ASTRecordLayout &MostDerivedLayout =
3426 Context.getASTRecordLayout(RD);
3427 CharUnits Offset = CharUnits::fromQuantity(-1);
3428 for (const BaseSubobject &BSO : FullPath) {
3429 const CXXRecordDecl *Base = BSO.getBase();
3430 // The first entry in the path is always the most derived record, skip it.
3432 assert(Offset.getQuantity() == -1);
3433 Offset = CharUnits::Zero();
3436 assert(Offset.getQuantity() != -1);
3437 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
3438 // While we know which base has to be traversed, we don't know if that base
3439 // was a virtual base.
3440 const CXXBaseSpecifier *BaseBS = std::find_if(
3441 RD->bases_begin(), RD->bases_end(), [&](const CXXBaseSpecifier &BS) {
3442 return BS.getType()->getAsCXXRecordDecl() == Base;
3444 Offset = BaseBS->isVirtual() ? MostDerivedLayout.getVBaseClassOffset(Base)
3445 : Offset + Layout.getBaseClassOffset(Base);
3451 // We want to select the path which introduces the most covariant overrides. If
3452 // two paths introduce overrides which the other path doesn't contain, issue a
3454 static const FullPathTy *selectBestPath(ASTContext &Context,
3455 const CXXRecordDecl *RD,
3456 const VPtrInfo &Info,
3457 std::list<FullPathTy> &FullPaths) {
3458 // Handle some easy cases first.
3459 if (FullPaths.empty())
3461 if (FullPaths.size() == 1)
3462 return &FullPaths.front();
3464 const FullPathTy *BestPath = nullptr;
3465 typedef std::set<const CXXMethodDecl *> OverriderSetTy;
3466 OverriderSetTy LastOverrides;
3467 for (const FullPathTy &SpecificPath : FullPaths) {
3468 assert(!SpecificPath.empty());
3469 OverriderSetTy CurrentOverrides;
3470 const CXXRecordDecl *TopLevelRD = SpecificPath.begin()->getBase();
3471 // Find the distance from the start of the path to the subobject with the
3473 CharUnits BaseOffset =
3474 getOffsetOfFullPath(Context, TopLevelRD, SpecificPath);
3475 FinalOverriders Overriders(TopLevelRD, CharUnits::Zero(), TopLevelRD);
3476 for (const CXXMethodDecl *MD : Info.IntroducingObject->methods()) {
3477 if (!MD->isVirtual())
3479 FinalOverriders::OverriderInfo OI =
3480 Overriders.getOverrider(MD->getCanonicalDecl(), BaseOffset);
3481 const CXXMethodDecl *OverridingMethod = OI.Method;
3482 // Only overriders which have a return adjustment introduce problematic
3484 if (ComputeReturnAdjustmentBaseOffset(Context, OverridingMethod, MD)
3487 // It's possible that the overrider isn't in this path. If so, skip it
3488 // because this path didn't introduce it.
3489 const CXXRecordDecl *OverridingParent = OverridingMethod->getParent();
3490 if (std::none_of(SpecificPath.begin(), SpecificPath.end(),
3491 [&](const BaseSubobject &BSO) {
3492 return BSO.getBase() == OverridingParent;
3495 CurrentOverrides.insert(OverridingMethod);
3497 OverriderSetTy NewOverrides =
3498 llvm::set_difference(CurrentOverrides, LastOverrides);
3499 if (NewOverrides.empty())
3501 OverriderSetTy MissingOverrides =
3502 llvm::set_difference(LastOverrides, CurrentOverrides);
3503 if (MissingOverrides.empty()) {
3504 // This path is a strict improvement over the last path, let's use it.
3505 BestPath = &SpecificPath;
3506 std::swap(CurrentOverrides, LastOverrides);
3508 // This path introduces an overrider with a conflicting covariant thunk.
3509 DiagnosticsEngine &Diags = Context.getDiagnostics();
3510 const CXXMethodDecl *CovariantMD = *NewOverrides.begin();
3511 const CXXMethodDecl *ConflictMD = *MissingOverrides.begin();
3512 Diags.Report(RD->getLocation(), diag::err_vftable_ambiguous_component)
3514 Diags.Report(CovariantMD->getLocation(), diag::note_covariant_thunk)
3516 Diags.Report(ConflictMD->getLocation(), diag::note_covariant_thunk)
3520 // Go with the path that introduced the most covariant overrides. If there is
3521 // no such path, pick the first path.
3522 return BestPath ? BestPath : &FullPaths.front();
3525 static void computeFullPathsForVFTables(ASTContext &Context,
3526 const CXXRecordDecl *RD,
3527 VPtrInfoVector &Paths) {
3528 const ASTRecordLayout &MostDerivedLayout = Context.getASTRecordLayout(RD);
3529 FullPathTy FullPath;
3530 std::list<FullPathTy> FullPaths;
3531 for (const std::unique_ptr<VPtrInfo>& Info : Paths) {
3532 findPathsToSubobject(
3533 Context, MostDerivedLayout, RD, CharUnits::Zero(),
3534 BaseSubobject(Info->IntroducingObject, Info->FullOffsetInMDC), FullPath,
3537 removeRedundantPaths(FullPaths);
3538 Info->PathToIntroducingObject.clear();
3539 if (const FullPathTy *BestPath =
3540 selectBestPath(Context, RD, *Info, FullPaths))
3541 for (const BaseSubobject &BSO : *BestPath)
3542 Info->PathToIntroducingObject.push_back(BSO.getBase());
3547 void MicrosoftVTableContext::computeVTableRelatedInformation(
3548 const CXXRecordDecl *RD) {
3549 assert(RD->isDynamicClass());
3551 // Check if we've computed this information before.
3552 if (VFPtrLocations.count(RD))
3555 const VTableLayout::AddressPointsMapTy EmptyAddressPointsMap;
3558 VPtrInfoVector VFPtrs;
3559 computeVTablePaths(/*ForVBTables=*/false, RD, VFPtrs);
3560 computeFullPathsForVFTables(Context, RD, VFPtrs);
3561 VFPtrLocations[RD] = std::move(VFPtrs);
3564 MethodVFTableLocationsTy NewMethodLocations;
3565 for (const std::unique_ptr<VPtrInfo> &VFPtr : VFPtrLocations[RD]) {
3566 VFTableBuilder Builder(*this, RD, *VFPtr);
3568 VFTableIdTy id(RD, VFPtr->FullOffsetInMDC);
3569 assert(VFTableLayouts.count(id) == 0);
3570 SmallVector<VTableLayout::VTableThunkTy, 1> VTableThunks(
3571 Builder.vtable_thunks_begin(), Builder.vtable_thunks_end());
3572 VFTableLayouts[id] = llvm::make_unique<VTableLayout>(
3573 ArrayRef<size_t>{0}, Builder.vtable_components(), VTableThunks,
3574 EmptyAddressPointsMap);
3575 Thunks.insert(Builder.thunks_begin(), Builder.thunks_end());
3577 for (const auto &Loc : Builder.vtable_locations()) {
3578 GlobalDecl GD = Loc.first;
3579 MethodVFTableLocation NewLoc = Loc.second;
3580 auto M = NewMethodLocations.find(GD);
3581 if (M == NewMethodLocations.end() || NewLoc < M->second)
3582 NewMethodLocations[GD] = NewLoc;
3586 MethodVFTableLocations.insert(NewMethodLocations.begin(),
3587 NewMethodLocations.end());
3588 if (Context.getLangOpts().DumpVTableLayouts)
3589 dumpMethodLocations(RD, NewMethodLocations, llvm::outs());
3592 void MicrosoftVTableContext::dumpMethodLocations(
3593 const CXXRecordDecl *RD, const MethodVFTableLocationsTy &NewMethods,
3595 // Compute the vtable indices for all the member functions.
3596 // Store them in a map keyed by the location so we'll get a sorted table.
3597 std::map<MethodVFTableLocation, std::string> IndicesMap;
3598 bool HasNonzeroOffset = false;
3600 for (const auto &I : NewMethods) {
3601 const CXXMethodDecl *MD = cast<const CXXMethodDecl>(I.first.getDecl());
3602 assert(MD->isVirtual());
3604 std::string MethodName = PredefinedExpr::ComputeName(
3605 PredefinedExpr::PrettyFunctionNoVirtual, MD);
3607 if (isa<CXXDestructorDecl>(MD)) {
3608 IndicesMap[I.second] = MethodName + " [scalar deleting]";
3610 IndicesMap[I.second] = MethodName;
3613 if (!I.second.VFPtrOffset.isZero() || I.second.VBTableIndex != 0)
3614 HasNonzeroOffset = true;
3617 // Print the vtable indices for all the member functions.
3618 if (!IndicesMap.empty()) {
3619 Out << "VFTable indices for ";
3621 RD->printQualifiedName(Out);
3622 Out << "' (" << IndicesMap.size()
3623 << (IndicesMap.size() == 1 ? " entry" : " entries") << ").\n";
3625 CharUnits LastVFPtrOffset = CharUnits::fromQuantity(-1);
3626 uint64_t LastVBIndex = 0;
3627 for (const auto &I : IndicesMap) {
3628 CharUnits VFPtrOffset = I.first.VFPtrOffset;
3629 uint64_t VBIndex = I.first.VBTableIndex;
3630 if (HasNonzeroOffset &&
3631 (VFPtrOffset != LastVFPtrOffset || VBIndex != LastVBIndex)) {
3632 assert(VBIndex > LastVBIndex || VFPtrOffset > LastVFPtrOffset);
3633 Out << " -- accessible via ";
3635 Out << "vbtable index " << VBIndex << ", ";
3636 Out << "vfptr at offset " << VFPtrOffset.getQuantity() << " --\n";
3637 LastVFPtrOffset = VFPtrOffset;
3638 LastVBIndex = VBIndex;
3641 uint64_t VTableIndex = I.first.Index;
3642 const std::string &MethodName = I.second;
3643 Out << llvm::format("%4" PRIu64 " | ", VTableIndex) << MethodName << '\n';
3651 const VirtualBaseInfo &MicrosoftVTableContext::computeVBTableRelatedInformation(
3652 const CXXRecordDecl *RD) {
3653 VirtualBaseInfo *VBI;
3656 // Get or create a VBI for RD. Don't hold a reference to the DenseMap cell,
3657 // as it may be modified and rehashed under us.
3658 std::unique_ptr<VirtualBaseInfo> &Entry = VBaseInfo[RD];
3661 Entry = llvm::make_unique<VirtualBaseInfo>();
3665 computeVTablePaths(/*ForVBTables=*/true, RD, VBI->VBPtrPaths);
3667 // First, see if the Derived class shared the vbptr with a non-virtual base.
3668 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
3669 if (const CXXRecordDecl *VBPtrBase = Layout.getBaseSharingVBPtr()) {
3670 // If the Derived class shares the vbptr with a non-virtual base, the shared
3671 // virtual bases come first so that the layout is the same.
3672 const VirtualBaseInfo &BaseInfo =
3673 computeVBTableRelatedInformation(VBPtrBase);
3674 VBI->VBTableIndices.insert(BaseInfo.VBTableIndices.begin(),
3675 BaseInfo.VBTableIndices.end());
3678 // New vbases are added to the end of the vbtable.
3679 // Skip the self entry and vbases visited in the non-virtual base, if any.
3680 unsigned VBTableIndex = 1 + VBI->VBTableIndices.size();
3681 for (const auto &VB : RD->vbases()) {
3682 const CXXRecordDecl *CurVBase = VB.getType()->getAsCXXRecordDecl();
3683 if (!VBI->VBTableIndices.count(CurVBase))
3684 VBI->VBTableIndices[CurVBase] = VBTableIndex++;
3690 unsigned MicrosoftVTableContext::getVBTableIndex(const CXXRecordDecl *Derived,
3691 const CXXRecordDecl *VBase) {
3692 const VirtualBaseInfo &VBInfo = computeVBTableRelatedInformation(Derived);
3693 assert(VBInfo.VBTableIndices.count(VBase));
3694 return VBInfo.VBTableIndices.find(VBase)->second;
3697 const VPtrInfoVector &
3698 MicrosoftVTableContext::enumerateVBTables(const CXXRecordDecl *RD) {
3699 return computeVBTableRelatedInformation(RD).VBPtrPaths;
3702 const VPtrInfoVector &
3703 MicrosoftVTableContext::getVFPtrOffsets(const CXXRecordDecl *RD) {
3704 computeVTableRelatedInformation(RD);
3706 assert(VFPtrLocations.count(RD) && "Couldn't find vfptr locations");
3707 return VFPtrLocations[RD];
3710 const VTableLayout &
3711 MicrosoftVTableContext::getVFTableLayout(const CXXRecordDecl *RD,
3712 CharUnits VFPtrOffset) {
3713 computeVTableRelatedInformation(RD);
3715 VFTableIdTy id(RD, VFPtrOffset);
3716 assert(VFTableLayouts.count(id) && "Couldn't find a VFTable at this offset");
3717 return *VFTableLayouts[id];
3720 const MicrosoftVTableContext::MethodVFTableLocation &
3721 MicrosoftVTableContext::getMethodVFTableLocation(GlobalDecl GD) {
3722 assert(cast<CXXMethodDecl>(GD.getDecl())->isVirtual() &&
3723 "Only use this method for virtual methods or dtors");
3724 if (isa<CXXDestructorDecl>(GD.getDecl()))
3725 assert(GD.getDtorType() == Dtor_Deleting);
3727 MethodVFTableLocationsTy::iterator I = MethodVFTableLocations.find(GD);
3728 if (I != MethodVFTableLocations.end())
3731 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
3733 computeVTableRelatedInformation(RD);
3735 I = MethodVFTableLocations.find(GD);
3736 assert(I != MethodVFTableLocations.end() && "Did not find index!");