xref: /netbsd-src/external/apache2/llvm/dist/clang/lib/AST/CXXInheritance.cpp (revision e038c9c4676b0f19b1b7dd08a940c6ed64a6d5ae)
17330f729Sjoerg //===- CXXInheritance.cpp - C++ Inheritance -------------------------------===//
27330f729Sjoerg //
37330f729Sjoerg // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
47330f729Sjoerg // See https://llvm.org/LICENSE.txt for license information.
57330f729Sjoerg // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
67330f729Sjoerg //
77330f729Sjoerg //===----------------------------------------------------------------------===//
87330f729Sjoerg //
97330f729Sjoerg // This file provides routines that help analyzing C++ inheritance hierarchies.
107330f729Sjoerg //
117330f729Sjoerg //===----------------------------------------------------------------------===//
127330f729Sjoerg 
137330f729Sjoerg #include "clang/AST/CXXInheritance.h"
147330f729Sjoerg #include "clang/AST/ASTContext.h"
157330f729Sjoerg #include "clang/AST/Decl.h"
167330f729Sjoerg #include "clang/AST/DeclBase.h"
177330f729Sjoerg #include "clang/AST/DeclCXX.h"
187330f729Sjoerg #include "clang/AST/DeclTemplate.h"
197330f729Sjoerg #include "clang/AST/RecordLayout.h"
207330f729Sjoerg #include "clang/AST/TemplateName.h"
217330f729Sjoerg #include "clang/AST/Type.h"
227330f729Sjoerg #include "clang/Basic/LLVM.h"
237330f729Sjoerg #include "llvm/ADT/DenseMap.h"
247330f729Sjoerg #include "llvm/ADT/STLExtras.h"
257330f729Sjoerg #include "llvm/ADT/SetVector.h"
267330f729Sjoerg #include "llvm/ADT/SmallVector.h"
277330f729Sjoerg #include "llvm/ADT/iterator_range.h"
287330f729Sjoerg #include "llvm/Support/Casting.h"
297330f729Sjoerg #include <algorithm>
307330f729Sjoerg #include <utility>
317330f729Sjoerg #include <cassert>
327330f729Sjoerg #include <vector>
337330f729Sjoerg 
347330f729Sjoerg using namespace clang;
357330f729Sjoerg 
367330f729Sjoerg /// isAmbiguous - Determines whether the set of paths provided is
377330f729Sjoerg /// ambiguous, i.e., there are two or more paths that refer to
387330f729Sjoerg /// different base class subobjects of the same type. BaseType must be
397330f729Sjoerg /// an unqualified, canonical class type.
isAmbiguous(CanQualType BaseType)407330f729Sjoerg bool CXXBasePaths::isAmbiguous(CanQualType BaseType) {
417330f729Sjoerg   BaseType = BaseType.getUnqualifiedType();
427330f729Sjoerg   IsVirtBaseAndNumberNonVirtBases Subobjects = ClassSubobjects[BaseType];
437330f729Sjoerg   return Subobjects.NumberOfNonVirtBases + (Subobjects.IsVirtBase ? 1 : 0) > 1;
447330f729Sjoerg }
457330f729Sjoerg 
467330f729Sjoerg /// clear - Clear out all prior path information.
clear()477330f729Sjoerg void CXXBasePaths::clear() {
487330f729Sjoerg   Paths.clear();
497330f729Sjoerg   ClassSubobjects.clear();
507330f729Sjoerg   VisitedDependentRecords.clear();
517330f729Sjoerg   ScratchPath.clear();
527330f729Sjoerg   DetectedVirtual = nullptr;
537330f729Sjoerg }
547330f729Sjoerg 
557330f729Sjoerg /// Swaps the contents of this CXXBasePaths structure with the
567330f729Sjoerg /// contents of Other.
swap(CXXBasePaths & Other)577330f729Sjoerg void CXXBasePaths::swap(CXXBasePaths &Other) {
587330f729Sjoerg   std::swap(Origin, Other.Origin);
597330f729Sjoerg   Paths.swap(Other.Paths);
607330f729Sjoerg   ClassSubobjects.swap(Other.ClassSubobjects);
617330f729Sjoerg   VisitedDependentRecords.swap(Other.VisitedDependentRecords);
627330f729Sjoerg   std::swap(FindAmbiguities, Other.FindAmbiguities);
637330f729Sjoerg   std::swap(RecordPaths, Other.RecordPaths);
647330f729Sjoerg   std::swap(DetectVirtual, Other.DetectVirtual);
657330f729Sjoerg   std::swap(DetectedVirtual, Other.DetectedVirtual);
667330f729Sjoerg }
677330f729Sjoerg 
isDerivedFrom(const CXXRecordDecl * Base) const687330f729Sjoerg bool CXXRecordDecl::isDerivedFrom(const CXXRecordDecl *Base) const {
697330f729Sjoerg   CXXBasePaths Paths(/*FindAmbiguities=*/false, /*RecordPaths=*/false,
707330f729Sjoerg                      /*DetectVirtual=*/false);
717330f729Sjoerg   return isDerivedFrom(Base, Paths);
727330f729Sjoerg }
737330f729Sjoerg 
isDerivedFrom(const CXXRecordDecl * Base,CXXBasePaths & Paths) const747330f729Sjoerg bool CXXRecordDecl::isDerivedFrom(const CXXRecordDecl *Base,
757330f729Sjoerg                                   CXXBasePaths &Paths) const {
767330f729Sjoerg   if (getCanonicalDecl() == Base->getCanonicalDecl())
777330f729Sjoerg     return false;
787330f729Sjoerg 
797330f729Sjoerg   Paths.setOrigin(const_cast<CXXRecordDecl*>(this));
807330f729Sjoerg 
817330f729Sjoerg   const CXXRecordDecl *BaseDecl = Base->getCanonicalDecl();
827330f729Sjoerg   return lookupInBases(
837330f729Sjoerg       [BaseDecl](const CXXBaseSpecifier *Specifier, CXXBasePath &Path) {
847330f729Sjoerg         return FindBaseClass(Specifier, Path, BaseDecl);
857330f729Sjoerg       },
867330f729Sjoerg       Paths);
877330f729Sjoerg }
887330f729Sjoerg 
isVirtuallyDerivedFrom(const CXXRecordDecl * Base) const897330f729Sjoerg bool CXXRecordDecl::isVirtuallyDerivedFrom(const CXXRecordDecl *Base) const {
907330f729Sjoerg   if (!getNumVBases())
917330f729Sjoerg     return false;
927330f729Sjoerg 
937330f729Sjoerg   CXXBasePaths Paths(/*FindAmbiguities=*/false, /*RecordPaths=*/false,
947330f729Sjoerg                      /*DetectVirtual=*/false);
957330f729Sjoerg 
967330f729Sjoerg   if (getCanonicalDecl() == Base->getCanonicalDecl())
977330f729Sjoerg     return false;
987330f729Sjoerg 
997330f729Sjoerg   Paths.setOrigin(const_cast<CXXRecordDecl*>(this));
1007330f729Sjoerg 
1017330f729Sjoerg   const CXXRecordDecl *BaseDecl = Base->getCanonicalDecl();
1027330f729Sjoerg   return lookupInBases(
1037330f729Sjoerg       [BaseDecl](const CXXBaseSpecifier *Specifier, CXXBasePath &Path) {
1047330f729Sjoerg         return FindVirtualBaseClass(Specifier, Path, BaseDecl);
1057330f729Sjoerg       },
1067330f729Sjoerg       Paths);
1077330f729Sjoerg }
1087330f729Sjoerg 
isProvablyNotDerivedFrom(const CXXRecordDecl * Base) const1097330f729Sjoerg bool CXXRecordDecl::isProvablyNotDerivedFrom(const CXXRecordDecl *Base) const {
1107330f729Sjoerg   const CXXRecordDecl *TargetDecl = Base->getCanonicalDecl();
1117330f729Sjoerg   return forallBases([TargetDecl](const CXXRecordDecl *Base) {
1127330f729Sjoerg     return Base->getCanonicalDecl() != TargetDecl;
1137330f729Sjoerg   });
1147330f729Sjoerg }
1157330f729Sjoerg 
1167330f729Sjoerg bool
isCurrentInstantiation(const DeclContext * CurContext) const1177330f729Sjoerg CXXRecordDecl::isCurrentInstantiation(const DeclContext *CurContext) const {
1187330f729Sjoerg   assert(isDependentContext());
1197330f729Sjoerg 
1207330f729Sjoerg   for (; !CurContext->isFileContext(); CurContext = CurContext->getParent())
1217330f729Sjoerg     if (CurContext->Equals(this))
1227330f729Sjoerg       return true;
1237330f729Sjoerg 
1247330f729Sjoerg   return false;
1257330f729Sjoerg }
1267330f729Sjoerg 
forallBases(ForallBasesCallback BaseMatches) const127*e038c9c4Sjoerg bool CXXRecordDecl::forallBases(ForallBasesCallback BaseMatches) const {
1287330f729Sjoerg   SmallVector<const CXXRecordDecl*, 8> Queue;
1297330f729Sjoerg 
1307330f729Sjoerg   const CXXRecordDecl *Record = this;
1317330f729Sjoerg   while (true) {
1327330f729Sjoerg     for (const auto &I : Record->bases()) {
1337330f729Sjoerg       const RecordType *Ty = I.getType()->getAs<RecordType>();
134*e038c9c4Sjoerg       if (!Ty)
135*e038c9c4Sjoerg         return false;
1367330f729Sjoerg 
1377330f729Sjoerg       CXXRecordDecl *Base =
1387330f729Sjoerg             cast_or_null<CXXRecordDecl>(Ty->getDecl()->getDefinition());
1397330f729Sjoerg       if (!Base ||
1407330f729Sjoerg           (Base->isDependentContext() &&
1417330f729Sjoerg            !Base->isCurrentInstantiation(Record))) {
142*e038c9c4Sjoerg         return false;
1437330f729Sjoerg       }
1447330f729Sjoerg 
1457330f729Sjoerg       Queue.push_back(Base);
146*e038c9c4Sjoerg       if (!BaseMatches(Base))
147*e038c9c4Sjoerg         return false;
1487330f729Sjoerg     }
1497330f729Sjoerg 
1507330f729Sjoerg     if (Queue.empty())
1517330f729Sjoerg       break;
1527330f729Sjoerg     Record = Queue.pop_back_val(); // not actually a queue.
1537330f729Sjoerg   }
1547330f729Sjoerg 
155*e038c9c4Sjoerg   return true;
1567330f729Sjoerg }
1577330f729Sjoerg 
lookupInBases(ASTContext & Context,const CXXRecordDecl * Record,CXXRecordDecl::BaseMatchesCallback BaseMatches,bool LookupInDependent)1587330f729Sjoerg bool CXXBasePaths::lookupInBases(ASTContext &Context,
1597330f729Sjoerg                                  const CXXRecordDecl *Record,
1607330f729Sjoerg                                  CXXRecordDecl::BaseMatchesCallback BaseMatches,
1617330f729Sjoerg                                  bool LookupInDependent) {
1627330f729Sjoerg   bool FoundPath = false;
1637330f729Sjoerg 
1647330f729Sjoerg   // The access of the path down to this record.
1657330f729Sjoerg   AccessSpecifier AccessToHere = ScratchPath.Access;
1667330f729Sjoerg   bool IsFirstStep = ScratchPath.empty();
1677330f729Sjoerg 
1687330f729Sjoerg   for (const auto &BaseSpec : Record->bases()) {
1697330f729Sjoerg     // Find the record of the base class subobjects for this type.
1707330f729Sjoerg     QualType BaseType =
1717330f729Sjoerg         Context.getCanonicalType(BaseSpec.getType()).getUnqualifiedType();
1727330f729Sjoerg 
1737330f729Sjoerg     // C++ [temp.dep]p3:
1747330f729Sjoerg     //   In the definition of a class template or a member of a class template,
1757330f729Sjoerg     //   if a base class of the class template depends on a template-parameter,
1767330f729Sjoerg     //   the base class scope is not examined during unqualified name lookup
1777330f729Sjoerg     //   either at the point of definition of the class template or member or
1787330f729Sjoerg     //   during an instantiation of the class tem- plate or member.
1797330f729Sjoerg     if (!LookupInDependent && BaseType->isDependentType())
1807330f729Sjoerg       continue;
1817330f729Sjoerg 
1827330f729Sjoerg     // Determine whether we need to visit this base class at all,
1837330f729Sjoerg     // updating the count of subobjects appropriately.
1847330f729Sjoerg     IsVirtBaseAndNumberNonVirtBases &Subobjects = ClassSubobjects[BaseType];
1857330f729Sjoerg     bool VisitBase = true;
1867330f729Sjoerg     bool SetVirtual = false;
1877330f729Sjoerg     if (BaseSpec.isVirtual()) {
1887330f729Sjoerg       VisitBase = !Subobjects.IsVirtBase;
1897330f729Sjoerg       Subobjects.IsVirtBase = true;
1907330f729Sjoerg       if (isDetectingVirtual() && DetectedVirtual == nullptr) {
1917330f729Sjoerg         // If this is the first virtual we find, remember it. If it turns out
1927330f729Sjoerg         // there is no base path here, we'll reset it later.
1937330f729Sjoerg         DetectedVirtual = BaseType->getAs<RecordType>();
1947330f729Sjoerg         SetVirtual = true;
1957330f729Sjoerg       }
1967330f729Sjoerg     } else {
1977330f729Sjoerg       ++Subobjects.NumberOfNonVirtBases;
1987330f729Sjoerg     }
1997330f729Sjoerg     if (isRecordingPaths()) {
2007330f729Sjoerg       // Add this base specifier to the current path.
2017330f729Sjoerg       CXXBasePathElement Element;
2027330f729Sjoerg       Element.Base = &BaseSpec;
2037330f729Sjoerg       Element.Class = Record;
2047330f729Sjoerg       if (BaseSpec.isVirtual())
2057330f729Sjoerg         Element.SubobjectNumber = 0;
2067330f729Sjoerg       else
2077330f729Sjoerg         Element.SubobjectNumber = Subobjects.NumberOfNonVirtBases;
2087330f729Sjoerg       ScratchPath.push_back(Element);
2097330f729Sjoerg 
2107330f729Sjoerg       // Calculate the "top-down" access to this base class.
2117330f729Sjoerg       // The spec actually describes this bottom-up, but top-down is
2127330f729Sjoerg       // equivalent because the definition works out as follows:
2137330f729Sjoerg       // 1. Write down the access along each step in the inheritance
2147330f729Sjoerg       //    chain, followed by the access of the decl itself.
2157330f729Sjoerg       //    For example, in
2167330f729Sjoerg       //      class A { public: int foo; };
2177330f729Sjoerg       //      class B : protected A {};
2187330f729Sjoerg       //      class C : public B {};
2197330f729Sjoerg       //      class D : private C {};
2207330f729Sjoerg       //    we would write:
2217330f729Sjoerg       //      private public protected public
2227330f729Sjoerg       // 2. If 'private' appears anywhere except far-left, access is denied.
2237330f729Sjoerg       // 3. Otherwise, overall access is determined by the most restrictive
2247330f729Sjoerg       //    access in the sequence.
2257330f729Sjoerg       if (IsFirstStep)
2267330f729Sjoerg         ScratchPath.Access = BaseSpec.getAccessSpecifier();
2277330f729Sjoerg       else
2287330f729Sjoerg         ScratchPath.Access = CXXRecordDecl::MergeAccess(AccessToHere,
2297330f729Sjoerg                                                  BaseSpec.getAccessSpecifier());
2307330f729Sjoerg     }
2317330f729Sjoerg 
2327330f729Sjoerg     // Track whether there's a path involving this specific base.
2337330f729Sjoerg     bool FoundPathThroughBase = false;
2347330f729Sjoerg 
2357330f729Sjoerg     if (BaseMatches(&BaseSpec, ScratchPath)) {
2367330f729Sjoerg       // We've found a path that terminates at this base.
2377330f729Sjoerg       FoundPath = FoundPathThroughBase = true;
2387330f729Sjoerg       if (isRecordingPaths()) {
2397330f729Sjoerg         // We have a path. Make a copy of it before moving on.
2407330f729Sjoerg         Paths.push_back(ScratchPath);
2417330f729Sjoerg       } else if (!isFindingAmbiguities()) {
2427330f729Sjoerg         // We found a path and we don't care about ambiguities;
2437330f729Sjoerg         // return immediately.
2447330f729Sjoerg         return FoundPath;
2457330f729Sjoerg       }
2467330f729Sjoerg     } else if (VisitBase) {
2477330f729Sjoerg       CXXRecordDecl *BaseRecord;
2487330f729Sjoerg       if (LookupInDependent) {
2497330f729Sjoerg         BaseRecord = nullptr;
2507330f729Sjoerg         const TemplateSpecializationType *TST =
2517330f729Sjoerg             BaseSpec.getType()->getAs<TemplateSpecializationType>();
2527330f729Sjoerg         if (!TST) {
2537330f729Sjoerg           if (auto *RT = BaseSpec.getType()->getAs<RecordType>())
2547330f729Sjoerg             BaseRecord = cast<CXXRecordDecl>(RT->getDecl());
2557330f729Sjoerg         } else {
2567330f729Sjoerg           TemplateName TN = TST->getTemplateName();
2577330f729Sjoerg           if (auto *TD =
2587330f729Sjoerg                   dyn_cast_or_null<ClassTemplateDecl>(TN.getAsTemplateDecl()))
2597330f729Sjoerg             BaseRecord = TD->getTemplatedDecl();
2607330f729Sjoerg         }
2617330f729Sjoerg         if (BaseRecord) {
2627330f729Sjoerg           if (!BaseRecord->hasDefinition() ||
2637330f729Sjoerg               VisitedDependentRecords.count(BaseRecord)) {
2647330f729Sjoerg             BaseRecord = nullptr;
2657330f729Sjoerg           } else {
2667330f729Sjoerg             VisitedDependentRecords.insert(BaseRecord);
2677330f729Sjoerg           }
2687330f729Sjoerg         }
2697330f729Sjoerg       } else {
2707330f729Sjoerg         BaseRecord = cast<CXXRecordDecl>(
2717330f729Sjoerg             BaseSpec.getType()->castAs<RecordType>()->getDecl());
2727330f729Sjoerg       }
2737330f729Sjoerg       if (BaseRecord &&
2747330f729Sjoerg           lookupInBases(Context, BaseRecord, BaseMatches, LookupInDependent)) {
2757330f729Sjoerg         // C++ [class.member.lookup]p2:
2767330f729Sjoerg         //   A member name f in one sub-object B hides a member name f in
2777330f729Sjoerg         //   a sub-object A if A is a base class sub-object of B. Any
2787330f729Sjoerg         //   declarations that are so hidden are eliminated from
2797330f729Sjoerg         //   consideration.
2807330f729Sjoerg 
2817330f729Sjoerg         // There is a path to a base class that meets the criteria. If we're
2827330f729Sjoerg         // not collecting paths or finding ambiguities, we're done.
2837330f729Sjoerg         FoundPath = FoundPathThroughBase = true;
2847330f729Sjoerg         if (!isFindingAmbiguities())
2857330f729Sjoerg           return FoundPath;
2867330f729Sjoerg       }
2877330f729Sjoerg     }
2887330f729Sjoerg 
2897330f729Sjoerg     // Pop this base specifier off the current path (if we're
2907330f729Sjoerg     // collecting paths).
2917330f729Sjoerg     if (isRecordingPaths()) {
2927330f729Sjoerg       ScratchPath.pop_back();
2937330f729Sjoerg     }
2947330f729Sjoerg 
2957330f729Sjoerg     // If we set a virtual earlier, and this isn't a path, forget it again.
2967330f729Sjoerg     if (SetVirtual && !FoundPathThroughBase) {
2977330f729Sjoerg       DetectedVirtual = nullptr;
2987330f729Sjoerg     }
2997330f729Sjoerg   }
3007330f729Sjoerg 
3017330f729Sjoerg   // Reset the scratch path access.
3027330f729Sjoerg   ScratchPath.Access = AccessToHere;
3037330f729Sjoerg 
3047330f729Sjoerg   return FoundPath;
3057330f729Sjoerg }
3067330f729Sjoerg 
lookupInBases(BaseMatchesCallback BaseMatches,CXXBasePaths & Paths,bool LookupInDependent) const3077330f729Sjoerg bool CXXRecordDecl::lookupInBases(BaseMatchesCallback BaseMatches,
3087330f729Sjoerg                                   CXXBasePaths &Paths,
3097330f729Sjoerg                                   bool LookupInDependent) const {
3107330f729Sjoerg   // If we didn't find anything, report that.
3117330f729Sjoerg   if (!Paths.lookupInBases(getASTContext(), this, BaseMatches,
3127330f729Sjoerg                            LookupInDependent))
3137330f729Sjoerg     return false;
3147330f729Sjoerg 
3157330f729Sjoerg   // If we're not recording paths or we won't ever find ambiguities,
3167330f729Sjoerg   // we're done.
3177330f729Sjoerg   if (!Paths.isRecordingPaths() || !Paths.isFindingAmbiguities())
3187330f729Sjoerg     return true;
3197330f729Sjoerg 
3207330f729Sjoerg   // C++ [class.member.lookup]p6:
3217330f729Sjoerg   //   When virtual base classes are used, a hidden declaration can be
3227330f729Sjoerg   //   reached along a path through the sub-object lattice that does
3237330f729Sjoerg   //   not pass through the hiding declaration. This is not an
3247330f729Sjoerg   //   ambiguity. The identical use with nonvirtual base classes is an
3257330f729Sjoerg   //   ambiguity; in that case there is no unique instance of the name
3267330f729Sjoerg   //   that hides all the others.
3277330f729Sjoerg   //
3287330f729Sjoerg   // FIXME: This is an O(N^2) algorithm, but DPG doesn't see an easy
3297330f729Sjoerg   // way to make it any faster.
3307330f729Sjoerg   Paths.Paths.remove_if([&Paths](const CXXBasePath &Path) {
3317330f729Sjoerg     for (const CXXBasePathElement &PE : Path) {
3327330f729Sjoerg       if (!PE.Base->isVirtual())
3337330f729Sjoerg         continue;
3347330f729Sjoerg 
3357330f729Sjoerg       CXXRecordDecl *VBase = nullptr;
3367330f729Sjoerg       if (const RecordType *Record = PE.Base->getType()->getAs<RecordType>())
3377330f729Sjoerg         VBase = cast<CXXRecordDecl>(Record->getDecl());
3387330f729Sjoerg       if (!VBase)
3397330f729Sjoerg         break;
3407330f729Sjoerg 
3417330f729Sjoerg       // The declaration(s) we found along this path were found in a
3427330f729Sjoerg       // subobject of a virtual base. Check whether this virtual
3437330f729Sjoerg       // base is a subobject of any other path; if so, then the
3447330f729Sjoerg       // declaration in this path are hidden by that patch.
3457330f729Sjoerg       for (const CXXBasePath &HidingP : Paths) {
3467330f729Sjoerg         CXXRecordDecl *HidingClass = nullptr;
3477330f729Sjoerg         if (const RecordType *Record =
3487330f729Sjoerg                 HidingP.back().Base->getType()->getAs<RecordType>())
3497330f729Sjoerg           HidingClass = cast<CXXRecordDecl>(Record->getDecl());
3507330f729Sjoerg         if (!HidingClass)
3517330f729Sjoerg           break;
3527330f729Sjoerg 
3537330f729Sjoerg         if (HidingClass->isVirtuallyDerivedFrom(VBase))
3547330f729Sjoerg           return true;
3557330f729Sjoerg       }
3567330f729Sjoerg     }
3577330f729Sjoerg     return false;
3587330f729Sjoerg   });
3597330f729Sjoerg 
3607330f729Sjoerg   return true;
3617330f729Sjoerg }
3627330f729Sjoerg 
FindBaseClass(const CXXBaseSpecifier * Specifier,CXXBasePath & Path,const CXXRecordDecl * BaseRecord)3637330f729Sjoerg bool CXXRecordDecl::FindBaseClass(const CXXBaseSpecifier *Specifier,
3647330f729Sjoerg                                   CXXBasePath &Path,
3657330f729Sjoerg                                   const CXXRecordDecl *BaseRecord) {
3667330f729Sjoerg   assert(BaseRecord->getCanonicalDecl() == BaseRecord &&
3677330f729Sjoerg          "User data for FindBaseClass is not canonical!");
3687330f729Sjoerg   return Specifier->getType()->castAs<RecordType>()->getDecl()
3697330f729Sjoerg             ->getCanonicalDecl() == BaseRecord;
3707330f729Sjoerg }
3717330f729Sjoerg 
FindVirtualBaseClass(const CXXBaseSpecifier * Specifier,CXXBasePath & Path,const CXXRecordDecl * BaseRecord)3727330f729Sjoerg bool CXXRecordDecl::FindVirtualBaseClass(const CXXBaseSpecifier *Specifier,
3737330f729Sjoerg                                          CXXBasePath &Path,
3747330f729Sjoerg                                          const CXXRecordDecl *BaseRecord) {
3757330f729Sjoerg   assert(BaseRecord->getCanonicalDecl() == BaseRecord &&
3767330f729Sjoerg          "User data for FindBaseClass is not canonical!");
3777330f729Sjoerg   return Specifier->isVirtual() &&
3787330f729Sjoerg          Specifier->getType()->castAs<RecordType>()->getDecl()
3797330f729Sjoerg             ->getCanonicalDecl() == BaseRecord;
3807330f729Sjoerg }
3817330f729Sjoerg 
isOrdinaryMember(const NamedDecl * ND)382*e038c9c4Sjoerg static bool isOrdinaryMember(const NamedDecl *ND) {
383*e038c9c4Sjoerg   return ND->isInIdentifierNamespace(Decl::IDNS_Ordinary | Decl::IDNS_Tag |
384*e038c9c4Sjoerg                                      Decl::IDNS_Member);
3857330f729Sjoerg }
3867330f729Sjoerg 
findOrdinaryMember(const CXXRecordDecl * RD,CXXBasePath & Path,DeclarationName Name)387*e038c9c4Sjoerg static bool findOrdinaryMember(const CXXRecordDecl *RD, CXXBasePath &Path,
388*e038c9c4Sjoerg                                DeclarationName Name) {
389*e038c9c4Sjoerg   Path.Decls = RD->lookup(Name).begin();
390*e038c9c4Sjoerg   for (DeclContext::lookup_iterator I = Path.Decls, E = I.end(); I != E; ++I)
391*e038c9c4Sjoerg     if (isOrdinaryMember(*I))
392*e038c9c4Sjoerg       return true;
393*e038c9c4Sjoerg 
3947330f729Sjoerg   return false;
3957330f729Sjoerg }
3967330f729Sjoerg 
hasMemberName(DeclarationName Name) const397*e038c9c4Sjoerg bool CXXRecordDecl::hasMemberName(DeclarationName Name) const {
398*e038c9c4Sjoerg   CXXBasePath P;
399*e038c9c4Sjoerg   if (findOrdinaryMember(this, P, Name))
4007330f729Sjoerg     return true;
401*e038c9c4Sjoerg 
402*e038c9c4Sjoerg   CXXBasePaths Paths(false, false, false);
403*e038c9c4Sjoerg   return lookupInBases(
404*e038c9c4Sjoerg       [Name](const CXXBaseSpecifier *Specifier, CXXBasePath &Path) {
405*e038c9c4Sjoerg         return findOrdinaryMember(Specifier->getType()->getAsCXXRecordDecl(),
406*e038c9c4Sjoerg                                   Path, Name);
407*e038c9c4Sjoerg       },
408*e038c9c4Sjoerg       Paths);
4097330f729Sjoerg }
4107330f729Sjoerg 
411*e038c9c4Sjoerg static bool
findOrdinaryMemberInDependentClasses(const CXXBaseSpecifier * Specifier,CXXBasePath & Path,DeclarationName Name)412*e038c9c4Sjoerg findOrdinaryMemberInDependentClasses(const CXXBaseSpecifier *Specifier,
413*e038c9c4Sjoerg                                      CXXBasePath &Path, DeclarationName Name) {
4147330f729Sjoerg   const TemplateSpecializationType *TST =
4157330f729Sjoerg       Specifier->getType()->getAs<TemplateSpecializationType>();
4167330f729Sjoerg   if (!TST) {
4177330f729Sjoerg     auto *RT = Specifier->getType()->getAs<RecordType>();
4187330f729Sjoerg     if (!RT)
4197330f729Sjoerg       return false;
420*e038c9c4Sjoerg     return findOrdinaryMember(cast<CXXRecordDecl>(RT->getDecl()), Path, Name);
4217330f729Sjoerg   }
4227330f729Sjoerg   TemplateName TN = TST->getTemplateName();
4237330f729Sjoerg   const auto *TD = dyn_cast_or_null<ClassTemplateDecl>(TN.getAsTemplateDecl());
4247330f729Sjoerg   if (!TD)
4257330f729Sjoerg     return false;
4267330f729Sjoerg   CXXRecordDecl *RD = TD->getTemplatedDecl();
4277330f729Sjoerg   if (!RD)
4287330f729Sjoerg     return false;
4297330f729Sjoerg   return findOrdinaryMember(RD, Path, Name);
4307330f729Sjoerg }
4317330f729Sjoerg 
lookupDependentName(DeclarationName Name,llvm::function_ref<bool (const NamedDecl * ND)> Filter)4327330f729Sjoerg std::vector<const NamedDecl *> CXXRecordDecl::lookupDependentName(
433*e038c9c4Sjoerg     DeclarationName Name,
4347330f729Sjoerg     llvm::function_ref<bool(const NamedDecl *ND)> Filter) {
4357330f729Sjoerg   std::vector<const NamedDecl *> Results;
4367330f729Sjoerg   // Lookup in the class.
437*e038c9c4Sjoerg   bool AnyOrdinaryMembers = false;
438*e038c9c4Sjoerg   for (const NamedDecl *ND : lookup(Name)) {
439*e038c9c4Sjoerg     if (isOrdinaryMember(ND))
440*e038c9c4Sjoerg       AnyOrdinaryMembers = true;
4417330f729Sjoerg     if (Filter(ND))
4427330f729Sjoerg       Results.push_back(ND);
4437330f729Sjoerg   }
444*e038c9c4Sjoerg   if (AnyOrdinaryMembers)
4457330f729Sjoerg     return Results;
446*e038c9c4Sjoerg 
4477330f729Sjoerg   // Perform lookup into our base classes.
4487330f729Sjoerg   CXXBasePaths Paths;
4497330f729Sjoerg   Paths.setOrigin(this);
4507330f729Sjoerg   if (!lookupInBases(
4517330f729Sjoerg           [&](const CXXBaseSpecifier *Specifier, CXXBasePath &Path) {
452*e038c9c4Sjoerg             return findOrdinaryMemberInDependentClasses(Specifier, Path, Name);
4537330f729Sjoerg           },
4547330f729Sjoerg           Paths, /*LookupInDependent=*/true))
4557330f729Sjoerg     return Results;
456*e038c9c4Sjoerg   for (DeclContext::lookup_iterator I = Paths.front().Decls, E = I.end();
457*e038c9c4Sjoerg        I != E; ++I) {
458*e038c9c4Sjoerg     if (isOrdinaryMember(*I) && Filter(*I))
459*e038c9c4Sjoerg       Results.push_back(*I);
4607330f729Sjoerg   }
4617330f729Sjoerg   return Results;
4627330f729Sjoerg }
4637330f729Sjoerg 
add(unsigned OverriddenSubobject,UniqueVirtualMethod Overriding)4647330f729Sjoerg void OverridingMethods::add(unsigned OverriddenSubobject,
4657330f729Sjoerg                             UniqueVirtualMethod Overriding) {
4667330f729Sjoerg   SmallVectorImpl<UniqueVirtualMethod> &SubobjectOverrides
4677330f729Sjoerg     = Overrides[OverriddenSubobject];
4687330f729Sjoerg   if (llvm::find(SubobjectOverrides, Overriding) == SubobjectOverrides.end())
4697330f729Sjoerg     SubobjectOverrides.push_back(Overriding);
4707330f729Sjoerg }
4717330f729Sjoerg 
add(const OverridingMethods & Other)4727330f729Sjoerg void OverridingMethods::add(const OverridingMethods &Other) {
4737330f729Sjoerg   for (const_iterator I = Other.begin(), IE = Other.end(); I != IE; ++I) {
4747330f729Sjoerg     for (overriding_const_iterator M = I->second.begin(),
4757330f729Sjoerg                                 MEnd = I->second.end();
4767330f729Sjoerg          M != MEnd;
4777330f729Sjoerg          ++M)
4787330f729Sjoerg       add(I->first, *M);
4797330f729Sjoerg   }
4807330f729Sjoerg }
4817330f729Sjoerg 
replaceAll(UniqueVirtualMethod Overriding)4827330f729Sjoerg void OverridingMethods::replaceAll(UniqueVirtualMethod Overriding) {
4837330f729Sjoerg   for (iterator I = begin(), IEnd = end(); I != IEnd; ++I) {
4847330f729Sjoerg     I->second.clear();
4857330f729Sjoerg     I->second.push_back(Overriding);
4867330f729Sjoerg   }
4877330f729Sjoerg }
4887330f729Sjoerg 
4897330f729Sjoerg namespace {
4907330f729Sjoerg 
4917330f729Sjoerg class FinalOverriderCollector {
4927330f729Sjoerg   /// The number of subobjects of a given class type that
4937330f729Sjoerg   /// occur within the class hierarchy.
4947330f729Sjoerg   llvm::DenseMap<const CXXRecordDecl *, unsigned> SubobjectCount;
4957330f729Sjoerg 
4967330f729Sjoerg   /// Overriders for each virtual base subobject.
4977330f729Sjoerg   llvm::DenseMap<const CXXRecordDecl *, CXXFinalOverriderMap *> VirtualOverriders;
4987330f729Sjoerg 
4997330f729Sjoerg   CXXFinalOverriderMap FinalOverriders;
5007330f729Sjoerg 
5017330f729Sjoerg public:
5027330f729Sjoerg   ~FinalOverriderCollector();
5037330f729Sjoerg 
5047330f729Sjoerg   void Collect(const CXXRecordDecl *RD, bool VirtualBase,
5057330f729Sjoerg                const CXXRecordDecl *InVirtualSubobject,
5067330f729Sjoerg                CXXFinalOverriderMap &Overriders);
5077330f729Sjoerg };
5087330f729Sjoerg 
5097330f729Sjoerg } // namespace
5107330f729Sjoerg 
Collect(const CXXRecordDecl * RD,bool VirtualBase,const CXXRecordDecl * InVirtualSubobject,CXXFinalOverriderMap & Overriders)5117330f729Sjoerg void FinalOverriderCollector::Collect(const CXXRecordDecl *RD,
5127330f729Sjoerg                                       bool VirtualBase,
5137330f729Sjoerg                                       const CXXRecordDecl *InVirtualSubobject,
5147330f729Sjoerg                                       CXXFinalOverriderMap &Overriders) {
5157330f729Sjoerg   unsigned SubobjectNumber = 0;
5167330f729Sjoerg   if (!VirtualBase)
5177330f729Sjoerg     SubobjectNumber
5187330f729Sjoerg       = ++SubobjectCount[cast<CXXRecordDecl>(RD->getCanonicalDecl())];
5197330f729Sjoerg 
5207330f729Sjoerg   for (const auto &Base : RD->bases()) {
5217330f729Sjoerg     if (const RecordType *RT = Base.getType()->getAs<RecordType>()) {
5227330f729Sjoerg       const CXXRecordDecl *BaseDecl = cast<CXXRecordDecl>(RT->getDecl());
5237330f729Sjoerg       if (!BaseDecl->isPolymorphic())
5247330f729Sjoerg         continue;
5257330f729Sjoerg 
5267330f729Sjoerg       if (Overriders.empty() && !Base.isVirtual()) {
5277330f729Sjoerg         // There are no other overriders of virtual member functions,
5287330f729Sjoerg         // so let the base class fill in our overriders for us.
5297330f729Sjoerg         Collect(BaseDecl, false, InVirtualSubobject, Overriders);
5307330f729Sjoerg         continue;
5317330f729Sjoerg       }
5327330f729Sjoerg 
5337330f729Sjoerg       // Collect all of the overridders from the base class subobject
5347330f729Sjoerg       // and merge them into the set of overridders for this class.
5357330f729Sjoerg       // For virtual base classes, populate or use the cached virtual
5367330f729Sjoerg       // overrides so that we do not walk the virtual base class (and
5377330f729Sjoerg       // its base classes) more than once.
5387330f729Sjoerg       CXXFinalOverriderMap ComputedBaseOverriders;
5397330f729Sjoerg       CXXFinalOverriderMap *BaseOverriders = &ComputedBaseOverriders;
5407330f729Sjoerg       if (Base.isVirtual()) {
5417330f729Sjoerg         CXXFinalOverriderMap *&MyVirtualOverriders = VirtualOverriders[BaseDecl];
5427330f729Sjoerg         BaseOverriders = MyVirtualOverriders;
5437330f729Sjoerg         if (!MyVirtualOverriders) {
5447330f729Sjoerg           MyVirtualOverriders = new CXXFinalOverriderMap;
5457330f729Sjoerg 
5467330f729Sjoerg           // Collect may cause VirtualOverriders to reallocate, invalidating the
5477330f729Sjoerg           // MyVirtualOverriders reference. Set BaseOverriders to the right
5487330f729Sjoerg           // value now.
5497330f729Sjoerg           BaseOverriders = MyVirtualOverriders;
5507330f729Sjoerg 
5517330f729Sjoerg           Collect(BaseDecl, true, BaseDecl, *MyVirtualOverriders);
5527330f729Sjoerg         }
5537330f729Sjoerg       } else
5547330f729Sjoerg         Collect(BaseDecl, false, InVirtualSubobject, ComputedBaseOverriders);
5557330f729Sjoerg 
5567330f729Sjoerg       // Merge the overriders from this base class into our own set of
5577330f729Sjoerg       // overriders.
5587330f729Sjoerg       for (CXXFinalOverriderMap::iterator OM = BaseOverriders->begin(),
5597330f729Sjoerg                                OMEnd = BaseOverriders->end();
5607330f729Sjoerg            OM != OMEnd;
5617330f729Sjoerg            ++OM) {
5627330f729Sjoerg         const CXXMethodDecl *CanonOM = OM->first->getCanonicalDecl();
5637330f729Sjoerg         Overriders[CanonOM].add(OM->second);
5647330f729Sjoerg       }
5657330f729Sjoerg     }
5667330f729Sjoerg   }
5677330f729Sjoerg 
5687330f729Sjoerg   for (auto *M : RD->methods()) {
5697330f729Sjoerg     // We only care about virtual methods.
5707330f729Sjoerg     if (!M->isVirtual())
5717330f729Sjoerg       continue;
5727330f729Sjoerg 
5737330f729Sjoerg     CXXMethodDecl *CanonM = M->getCanonicalDecl();
5747330f729Sjoerg     using OverriddenMethodsRange =
5757330f729Sjoerg         llvm::iterator_range<CXXMethodDecl::method_iterator>;
5767330f729Sjoerg     OverriddenMethodsRange OverriddenMethods = CanonM->overridden_methods();
5777330f729Sjoerg 
5787330f729Sjoerg     if (OverriddenMethods.begin() == OverriddenMethods.end()) {
5797330f729Sjoerg       // This is a new virtual function that does not override any
5807330f729Sjoerg       // other virtual function. Add it to the map of virtual
5817330f729Sjoerg       // functions for which we are tracking overridders.
5827330f729Sjoerg 
5837330f729Sjoerg       // C++ [class.virtual]p2:
5847330f729Sjoerg       //   For convenience we say that any virtual function overrides itself.
5857330f729Sjoerg       Overriders[CanonM].add(SubobjectNumber,
5867330f729Sjoerg                              UniqueVirtualMethod(CanonM, SubobjectNumber,
5877330f729Sjoerg                                                  InVirtualSubobject));
5887330f729Sjoerg       continue;
5897330f729Sjoerg     }
5907330f729Sjoerg 
5917330f729Sjoerg     // This virtual method overrides other virtual methods, so it does
5927330f729Sjoerg     // not add any new slots into the set of overriders. Instead, we
5937330f729Sjoerg     // replace entries in the set of overriders with the new
5947330f729Sjoerg     // overrider. To do so, we dig down to the original virtual
5957330f729Sjoerg     // functions using data recursion and update all of the methods it
5967330f729Sjoerg     // overrides.
5977330f729Sjoerg     SmallVector<OverriddenMethodsRange, 4> Stack(1, OverriddenMethods);
5987330f729Sjoerg     while (!Stack.empty()) {
5997330f729Sjoerg       for (const CXXMethodDecl *OM : Stack.pop_back_val()) {
6007330f729Sjoerg         const CXXMethodDecl *CanonOM = OM->getCanonicalDecl();
6017330f729Sjoerg 
6027330f729Sjoerg         // C++ [class.virtual]p2:
6037330f729Sjoerg         //   A virtual member function C::vf of a class object S is
6047330f729Sjoerg         //   a final overrider unless the most derived class (1.8)
6057330f729Sjoerg         //   of which S is a base class subobject (if any) declares
6067330f729Sjoerg         //   or inherits another member function that overrides vf.
6077330f729Sjoerg         //
6087330f729Sjoerg         // Treating this object like the most derived class, we
6097330f729Sjoerg         // replace any overrides from base classes with this
6107330f729Sjoerg         // overriding virtual function.
6117330f729Sjoerg         Overriders[CanonOM].replaceAll(
6127330f729Sjoerg                                UniqueVirtualMethod(CanonM, SubobjectNumber,
6137330f729Sjoerg                                                    InVirtualSubobject));
6147330f729Sjoerg 
6157330f729Sjoerg         auto OverriddenMethods = CanonOM->overridden_methods();
6167330f729Sjoerg         if (OverriddenMethods.begin() == OverriddenMethods.end())
6177330f729Sjoerg           continue;
6187330f729Sjoerg 
6197330f729Sjoerg         // Continue recursion to the methods that this virtual method
6207330f729Sjoerg         // overrides.
6217330f729Sjoerg         Stack.push_back(OverriddenMethods);
6227330f729Sjoerg       }
6237330f729Sjoerg     }
6247330f729Sjoerg 
6257330f729Sjoerg     // C++ [class.virtual]p2:
6267330f729Sjoerg     //   For convenience we say that any virtual function overrides itself.
6277330f729Sjoerg     Overriders[CanonM].add(SubobjectNumber,
6287330f729Sjoerg                            UniqueVirtualMethod(CanonM, SubobjectNumber,
6297330f729Sjoerg                                                InVirtualSubobject));
6307330f729Sjoerg   }
6317330f729Sjoerg }
6327330f729Sjoerg 
~FinalOverriderCollector()6337330f729Sjoerg FinalOverriderCollector::~FinalOverriderCollector() {
6347330f729Sjoerg   for (llvm::DenseMap<const CXXRecordDecl *, CXXFinalOverriderMap *>::iterator
6357330f729Sjoerg          VO = VirtualOverriders.begin(), VOEnd = VirtualOverriders.end();
6367330f729Sjoerg        VO != VOEnd;
6377330f729Sjoerg        ++VO)
6387330f729Sjoerg     delete VO->second;
6397330f729Sjoerg }
6407330f729Sjoerg 
6417330f729Sjoerg void
getFinalOverriders(CXXFinalOverriderMap & FinalOverriders) const6427330f729Sjoerg CXXRecordDecl::getFinalOverriders(CXXFinalOverriderMap &FinalOverriders) const {
6437330f729Sjoerg   FinalOverriderCollector Collector;
6447330f729Sjoerg   Collector.Collect(this, false, nullptr, FinalOverriders);
6457330f729Sjoerg 
6467330f729Sjoerg   // Weed out any final overriders that come from virtual base class
6477330f729Sjoerg   // subobjects that were hidden by other subobjects along any path.
6487330f729Sjoerg   // This is the final-overrider variant of C++ [class.member.lookup]p10.
6497330f729Sjoerg   for (auto &OM : FinalOverriders) {
6507330f729Sjoerg     for (auto &SO : OM.second) {
6517330f729Sjoerg       SmallVectorImpl<UniqueVirtualMethod> &Overriding = SO.second;
6527330f729Sjoerg       if (Overriding.size() < 2)
6537330f729Sjoerg         continue;
6547330f729Sjoerg 
6557330f729Sjoerg       auto IsHidden = [&Overriding](const UniqueVirtualMethod &M) {
6567330f729Sjoerg         if (!M.InVirtualSubobject)
6577330f729Sjoerg           return false;
6587330f729Sjoerg 
6597330f729Sjoerg         // We have an overriding method in a virtual base class
6607330f729Sjoerg         // subobject (or non-virtual base class subobject thereof);
6617330f729Sjoerg         // determine whether there exists an other overriding method
6627330f729Sjoerg         // in a base class subobject that hides the virtual base class
6637330f729Sjoerg         // subobject.
6647330f729Sjoerg         for (const UniqueVirtualMethod &OP : Overriding)
6657330f729Sjoerg           if (&M != &OP &&
6667330f729Sjoerg               OP.Method->getParent()->isVirtuallyDerivedFrom(
6677330f729Sjoerg                   M.InVirtualSubobject))
6687330f729Sjoerg             return true;
6697330f729Sjoerg         return false;
6707330f729Sjoerg       };
6717330f729Sjoerg 
672*e038c9c4Sjoerg       // FIXME: IsHidden reads from Overriding from the middle of a remove_if
673*e038c9c4Sjoerg       // over the same sequence! Is this guaranteed to work?
6747330f729Sjoerg       Overriding.erase(
6757330f729Sjoerg           std::remove_if(Overriding.begin(), Overriding.end(), IsHidden),
6767330f729Sjoerg           Overriding.end());
6777330f729Sjoerg     }
6787330f729Sjoerg   }
6797330f729Sjoerg }
6807330f729Sjoerg 
6817330f729Sjoerg static void
AddIndirectPrimaryBases(const CXXRecordDecl * RD,ASTContext & Context,CXXIndirectPrimaryBaseSet & Bases)6827330f729Sjoerg AddIndirectPrimaryBases(const CXXRecordDecl *RD, ASTContext &Context,
6837330f729Sjoerg                         CXXIndirectPrimaryBaseSet& Bases) {
6847330f729Sjoerg   // If the record has a virtual primary base class, add it to our set.
6857330f729Sjoerg   const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
6867330f729Sjoerg   if (Layout.isPrimaryBaseVirtual())
6877330f729Sjoerg     Bases.insert(Layout.getPrimaryBase());
6887330f729Sjoerg 
6897330f729Sjoerg   for (const auto &I : RD->bases()) {
6907330f729Sjoerg     assert(!I.getType()->isDependentType() &&
6917330f729Sjoerg            "Cannot get indirect primary bases for class with dependent bases.");
6927330f729Sjoerg 
6937330f729Sjoerg     const CXXRecordDecl *BaseDecl =
6947330f729Sjoerg       cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
6957330f729Sjoerg 
6967330f729Sjoerg     // Only bases with virtual bases participate in computing the
6977330f729Sjoerg     // indirect primary virtual base classes.
6987330f729Sjoerg     if (BaseDecl->getNumVBases())
6997330f729Sjoerg       AddIndirectPrimaryBases(BaseDecl, Context, Bases);
7007330f729Sjoerg   }
7017330f729Sjoerg 
7027330f729Sjoerg }
7037330f729Sjoerg 
7047330f729Sjoerg void
getIndirectPrimaryBases(CXXIndirectPrimaryBaseSet & Bases) const7057330f729Sjoerg CXXRecordDecl::getIndirectPrimaryBases(CXXIndirectPrimaryBaseSet& Bases) const {
7067330f729Sjoerg   ASTContext &Context = getASTContext();
7077330f729Sjoerg 
7087330f729Sjoerg   if (!getNumVBases())
7097330f729Sjoerg     return;
7107330f729Sjoerg 
7117330f729Sjoerg   for (const auto &I : bases()) {
7127330f729Sjoerg     assert(!I.getType()->isDependentType() &&
7137330f729Sjoerg            "Cannot get indirect primary bases for class with dependent bases.");
7147330f729Sjoerg 
7157330f729Sjoerg     const CXXRecordDecl *BaseDecl =
7167330f729Sjoerg       cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
7177330f729Sjoerg 
7187330f729Sjoerg     // Only bases with virtual bases participate in computing the
7197330f729Sjoerg     // indirect primary virtual base classes.
7207330f729Sjoerg     if (BaseDecl->getNumVBases())
7217330f729Sjoerg       AddIndirectPrimaryBases(BaseDecl, Context, Bases);
7227330f729Sjoerg   }
7237330f729Sjoerg }
724