[llvm] [TableGen] Only store direct superclasses in Record (PR #123072)

Jay Foad via llvm-commits llvm-commits at lists.llvm.org
Wed Jan 15 07:59:27 PST 2025


https://github.com/jayfoad created https://github.com/llvm/llvm-project/pull/123072

- **Change API of getSuperClasses**
- **Change API of getDirectSuperClasses**
- **Only store direct superclasses in Record**
- **Simplify API of getDirectSuperClasses**


>From f12511a0fd30c47ea08e6c126cae558215758183 Mon Sep 17 00:00:00 2001
From: Jay Foad <jay.foad at amd.com>
Date: Wed, 15 Jan 2025 13:34:41 +0000
Subject: [PATCH 1/4] Change API of getSuperClasses

---
 llvm/include/llvm/TableGen/Record.h           |  5 ++--
 llvm/lib/TableGen/DetailedRecordsBackend.cpp  |  4 +--
 llvm/lib/TableGen/JSONBackend.cpp             |  4 ++-
 llvm/lib/TableGen/Record.cpp                  | 26 ++++++++++++++-----
 llvm/lib/TableGen/SetTheory.cpp               |  4 ++-
 llvm/lib/TableGen/TGParser.cpp                |  9 ++++---
 llvm/utils/TableGen/CallingConvEmitter.cpp    | 11 ++++----
 .../TableGen/Common/CodeGenRegisters.cpp      |  4 ++-
 .../utils/TableGen/SearchableTableEmitter.cpp |  5 ++--
 9 files changed, 49 insertions(+), 23 deletions(-)

diff --git a/llvm/include/llvm/TableGen/Record.h b/llvm/include/llvm/TableGen/Record.h
index b15e9fc7328da0..79e9b88c34a561 100644
--- a/llvm/include/llvm/TableGen/Record.h
+++ b/llvm/include/llvm/TableGen/Record.h
@@ -1718,8 +1718,9 @@ class Record {
   ArrayRef<AssertionInfo> getAssertions() const { return Assertions; }
   ArrayRef<DumpInfo> getDumps() const { return Dumps; }
 
-  ArrayRef<std::pair<const Record *, SMRange>> getSuperClasses() const {
-    return SuperClasses;
+  void getSuperClasses(
+      SmallVectorImpl<std::pair<const Record *, SMRange>> &Classes) const {
+    Classes.append(SuperClasses);
   }
 
   /// Determine whether this record has the specified direct superclass.
diff --git a/llvm/lib/TableGen/DetailedRecordsBackend.cpp b/llvm/lib/TableGen/DetailedRecordsBackend.cpp
index 4a337248c941a1..2a1623e64e439d 100644
--- a/llvm/lib/TableGen/DetailedRecordsBackend.cpp
+++ b/llvm/lib/TableGen/DetailedRecordsBackend.cpp
@@ -152,8 +152,8 @@ void DetailedRecordsEmitter::printTemplateArgs(const Record &Rec,
 // are enclosed in parentheses.
 void DetailedRecordsEmitter::printSuperclasses(const Record &Rec,
                                                raw_ostream &OS) {
-  ArrayRef<std::pair<const Record *, SMRange>> Superclasses =
-      Rec.getSuperClasses();
+  SmallVector<std::pair<const Record *, SMRange>> Superclasses;
+  Rec.getSuperClasses(Superclasses);
   if (Superclasses.empty()) {
     OS << "  Superclasses: (none)\n";
     return;
diff --git a/llvm/lib/TableGen/JSONBackend.cpp b/llvm/lib/TableGen/JSONBackend.cpp
index d648019ac46e8d..fecd16764fca21 100644
--- a/llvm/lib/TableGen/JSONBackend.cpp
+++ b/llvm/lib/TableGen/JSONBackend.cpp
@@ -151,7 +151,9 @@ void JSONEmitter::run(raw_ostream &OS) {
 
     json::Array SuperClasses;
     // Add this def to the instance list for each of its superclasses.
-    for (const auto &[SuperClass, Loc] : Def->getSuperClasses()) {
+    SmallVector<std::pair<const Record *, SMRange>> SCs;
+    Def->getSuperClasses(SCs);
+    for (const auto &[SuperClass, Loc] : SCs) {
       std::string SuperName = SuperClass->getNameInitAsString();
       SuperClasses.push_back(SuperName);
       InstanceLists[SuperName].push_back(Name);
diff --git a/llvm/lib/TableGen/Record.cpp b/llvm/lib/TableGen/Record.cpp
index 597ccb7ca144bb..4fe2b16cd516f9 100644
--- a/llvm/lib/TableGen/Record.cpp
+++ b/llvm/lib/TableGen/Record.cpp
@@ -2395,7 +2395,9 @@ const DefInit *VarDefInit::instantiate() {
   NewRec->resolveReferences(R);
 
   // Add superclasses.
-  for (const auto &[SC, Loc] : Class->getSuperClasses())
+  SmallVector<std::pair<const Record *, SMRange>> SCs;
+  Class->getSuperClasses(SCs);
+  for (const auto &[SC, Loc] : SCs)
     NewRec->addSuperClass(SC, Loc);
 
   NewRec->addSuperClass(
@@ -2912,13 +2914,18 @@ void Record::setName(const Init *NewName) {
 // so we can step through the direct superclasses in reverse order.
 
 bool Record::hasDirectSuperClass(const Record *Superclass) const {
-  ArrayRef<std::pair<const Record *, SMRange>> SCs = getSuperClasses();
+  SmallVector<std::pair<const Record *, SMRange>> SCs;
+  getSuperClasses(SCs);
+
+  SmallVector<std::pair<const Record *, SMRange>> SSCs;
 
   for (int I = SCs.size() - 1; I >= 0; --I) {
     const Record *SC = SCs[I].first;
     if (SC == Superclass)
       return true;
-    I -= SC->getSuperClasses().size();
+    SC->getSuperClasses(SSCs);
+    I -= SSCs.size();
+    SSCs.clear();
   }
 
   return false;
@@ -2926,11 +2933,17 @@ bool Record::hasDirectSuperClass(const Record *Superclass) const {
 
 void Record::getDirectSuperClasses(
     SmallVectorImpl<const Record *> &Classes) const {
-  ArrayRef<std::pair<const Record *, SMRange>> SCs = getSuperClasses();
+  SmallVector<std::pair<const Record *, SMRange>> SCVec;
+  getSuperClasses(SCVec);
+  ArrayRef<std::pair<const Record *, SMRange>> SCs = SCVec;
+
+  SmallVector<std::pair<const Record *, SMRange>> SSCs;
 
   while (!SCs.empty()) {
     const Record *SC = SCs.back().first;
-    SCs = SCs.drop_back(1 + SC->getSuperClasses().size());
+    SC->getSuperClasses(SSCs);
+    SCs = SCs.drop_back(1 + SSCs.size());
+    SSCs.clear();
     Classes.push_back(SC);
   }
 }
@@ -3008,7 +3021,8 @@ raw_ostream &llvm::operator<<(raw_ostream &OS, const Record &R) {
   }
 
   OS << " {";
-  ArrayRef<std::pair<const Record *, SMRange>> SC = R.getSuperClasses();
+  SmallVector<std::pair<const Record *, SMRange>> SC;
+  R.getSuperClasses(SC);
   if (!SC.empty()) {
     OS << "\t//";
     for (const auto &[SC, _] : SC)
diff --git a/llvm/lib/TableGen/SetTheory.cpp b/llvm/lib/TableGen/SetTheory.cpp
index ac7ae2cbaed57b..b3a2b9d0d6fa7e 100644
--- a/llvm/lib/TableGen/SetTheory.cpp
+++ b/llvm/lib/TableGen/SetTheory.cpp
@@ -312,7 +312,9 @@ const RecVec *SetTheory::expand(const Record *Set) {
     return &I->second;
 
   // This is the first time we see Set. Find a suitable expander.
-  for (const auto &[SuperClass, Loc] : Set->getSuperClasses()) {
+  SmallVector<std::pair<const Record *, SMRange>> SCs;
+  Set->getSuperClasses(SCs);
+  for (const auto &[SuperClass, Loc] : SCs) {
     // Skip unnamed superclasses.
     if (!isa<StringInit>(SuperClass->getNameInit()))
       continue;
diff --git a/llvm/lib/TableGen/TGParser.cpp b/llvm/lib/TableGen/TGParser.cpp
index 60ae11b7f42612..317cd6b5a9213b 100644
--- a/llvm/lib/TableGen/TGParser.cpp
+++ b/llvm/lib/TableGen/TGParser.cpp
@@ -330,7 +330,9 @@ bool TGParser::AddSubClass(Record *CurRec, SubClassReference &SubClass) {
 
   // Since everything went well, we can now set the "superclass" list for the
   // current record.
-  for (const auto &[SC, Loc] : SC->getSuperClasses()) {
+  SmallVector<std::pair<const Record *, SMRange>> SCs;
+  SC->getSuperClasses(SCs);
+  for (const auto &[SC, Loc] : SCs) {
     if (CurRec->isSubClassOf(SC))
       return Error(SubClass.RefRange.Start,
                    "Already subclass of '" + SC->getName() + "'!\n");
@@ -4002,8 +4004,9 @@ bool TGParser::ParseClass() {
   Record *CurRec = const_cast<Record *>(Records.getClass(Name));
   if (CurRec) {
     // If the body was previously defined, this is an error.
-    if (!CurRec->getValues().empty() ||
-        !CurRec->getSuperClasses().empty() ||
+    SmallVector<std::pair<const Record *, SMRange>> SCs;
+    CurRec->getSuperClasses(SCs);
+    if (!CurRec->getValues().empty() || !SCs.empty() ||
         !CurRec->getTemplateArgs().empty())
       return TokError("Class '" + CurRec->getNameInitAsString() +
                       "' already defined");
diff --git a/llvm/utils/TableGen/CallingConvEmitter.cpp b/llvm/utils/TableGen/CallingConvEmitter.cpp
index b315aa7d86fe91..ce97cbf17ddf8c 100644
--- a/llvm/utils/TableGen/CallingConvEmitter.cpp
+++ b/llvm/utils/TableGen/CallingConvEmitter.cpp
@@ -109,12 +109,13 @@ void CallingConvEmitter::emitCallingConv(const Record *CC, raw_ostream &O) {
   // Emit all of the actions, in order.
   for (unsigned I = 0, E = CCActions->size(); I != E; ++I) {
     const Record *Action = CCActions->getElementAsRecord(I);
+    SmallVector<std::pair<const Record *, SMRange>> SCs;
+    Action->getSuperClasses(SCs);
     SwiftAction =
-        llvm::any_of(Action->getSuperClasses(),
-                     [](const std::pair<const Record *, SMRange> &Class) {
-                       std::string Name = Class.first->getNameInitAsString();
-                       return StringRef(Name).starts_with("CCIfSwift");
-                     });
+        llvm::any_of(SCs, [](const std::pair<const Record *, SMRange> &Class) {
+          std::string Name = Class.first->getNameInitAsString();
+          return StringRef(Name).starts_with("CCIfSwift");
+        });
 
     O << "\n";
     emitAction(Action, indent(2), O);
diff --git a/llvm/utils/TableGen/Common/CodeGenRegisters.cpp b/llvm/utils/TableGen/Common/CodeGenRegisters.cpp
index 2dbee94d7e5406..237b0d415a8a65 100644
--- a/llvm/utils/TableGen/Common/CodeGenRegisters.cpp
+++ b/llvm/utils/TableGen/Common/CodeGenRegisters.cpp
@@ -703,7 +703,9 @@ struct TupleExpander : SetTheory::Expander {
                         "Register tuple redefines register '" + Name + "'.");
 
       // Copy Proto super-classes.
-      for (const auto &[Super, Loc] : Proto->getSuperClasses())
+      SmallVector<std::pair<const Record *, SMRange>> SCs;
+      Proto->getSuperClasses(SCs);
+      for (const auto &[Super, Loc] : SCs)
         NewReg->addSuperClass(Super, Loc);
 
       // Copy Proto fields.
diff --git a/llvm/utils/TableGen/SearchableTableEmitter.cpp b/llvm/utils/TableGen/SearchableTableEmitter.cpp
index 91fde0c6630577..f5ccc99a5ad645 100644
--- a/llvm/utils/TableGen/SearchableTableEmitter.cpp
+++ b/llvm/utils/TableGen/SearchableTableEmitter.cpp
@@ -839,8 +839,9 @@ void SearchableTableEmitter::run(raw_ostream &OS) {
   const Record *SearchableTable = Records.getClass("SearchableTable");
   for (auto &NameRec : Records.getClasses()) {
     const Record *Class = NameRec.second.get();
-    if (Class->getSuperClasses().size() != 1 ||
-        !Class->isSubClassOf(SearchableTable))
+    SmallVector<std::pair<const Record *, SMRange>> SCs;
+    Class->getSuperClasses(SCs);
+    if (SCs.size() != 1 || !Class->isSubClassOf(SearchableTable))
       continue;
 
     StringRef TableName = Class->getName();

>From 2a96ff416acc805ff40934a9b14fc6e5031fc802 Mon Sep 17 00:00:00 2001
From: Jay Foad <jay.foad at amd.com>
Date: Wed, 15 Jan 2025 14:29:51 +0000
Subject: [PATCH 2/4] Change API of getDirectSuperClasses

---
 llvm/include/llvm/TableGen/Record.h |  3 ++-
 llvm/lib/TableGen/Record.cpp        | 16 +++++++++++-----
 2 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/llvm/include/llvm/TableGen/Record.h b/llvm/include/llvm/TableGen/Record.h
index 79e9b88c34a561..8b49daf6374048 100644
--- a/llvm/include/llvm/TableGen/Record.h
+++ b/llvm/include/llvm/TableGen/Record.h
@@ -1727,7 +1727,8 @@ class Record {
   bool hasDirectSuperClass(const Record *SuperClass) const;
 
   /// Append the direct superclasses of this record to Classes.
-  void getDirectSuperClasses(SmallVectorImpl<const Record *> &Classes) const;
+  void getDirectSuperClasses(
+      SmallVectorImpl<std::pair<const Record *, SMRange>> &Classes) const;
 
   bool isTemplateArg(const Init *Name) const {
     return llvm::is_contained(TemplateArgs, Name);
diff --git a/llvm/lib/TableGen/Record.cpp b/llvm/lib/TableGen/Record.cpp
index 4fe2b16cd516f9..9ad002b67765bd 100644
--- a/llvm/lib/TableGen/Record.cpp
+++ b/llvm/lib/TableGen/Record.cpp
@@ -327,13 +327,17 @@ static const RecordRecTy *resolveRecordTypes(const RecordRecTy *T1,
   SmallVector<const Record *, 4> CommonSuperClasses;
   SmallVector<const Record *, 4> Stack(T1->getClasses());
 
+  SmallVector<std::pair<const Record *, SMRange>> SCs;
+
   while (!Stack.empty()) {
     const Record *R = Stack.pop_back_val();
 
     if (T2->isSubClassOf(R)) {
       CommonSuperClasses.push_back(R);
     } else {
-      R->getDirectSuperClasses(Stack);
+      R->getDirectSuperClasses(SCs);
+      append_range(Stack, make_first_range(SCs));
+      SCs.clear();
     }
   }
 
@@ -2875,8 +2879,10 @@ void Record::checkName() {
 }
 
 const RecordRecTy *Record::getType() const {
+  SmallVector<std::pair<const Record *, SMRange>> SCs;
+  getDirectSuperClasses(SCs);
   SmallVector<const Record *, 4> DirectSCs;
-  getDirectSuperClasses(DirectSCs);
+  append_range(DirectSCs, make_first_range(SCs));
   return RecordRecTy::get(TrackedRecords, DirectSCs);
 }
 
@@ -2932,7 +2938,7 @@ bool Record::hasDirectSuperClass(const Record *Superclass) const {
 }
 
 void Record::getDirectSuperClasses(
-    SmallVectorImpl<const Record *> &Classes) const {
+    SmallVectorImpl<std::pair<const Record *, SMRange>> &Classes) const {
   SmallVector<std::pair<const Record *, SMRange>> SCVec;
   getSuperClasses(SCVec);
   ArrayRef<std::pair<const Record *, SMRange>> SCs = SCVec;
@@ -2940,11 +2946,11 @@ void Record::getDirectSuperClasses(
   SmallVector<std::pair<const Record *, SMRange>> SSCs;
 
   while (!SCs.empty()) {
-    const Record *SC = SCs.back().first;
+    auto [SC, Range] = SCs.back();
     SC->getSuperClasses(SSCs);
     SCs = SCs.drop_back(1 + SSCs.size());
     SSCs.clear();
-    Classes.push_back(SC);
+    Classes.emplace_back(SC, Range);
   }
 }
 

>From 683fe146465814b805224c65ca7d2e3707383b51 Mon Sep 17 00:00:00 2001
From: Jay Foad <jay.foad at amd.com>
Date: Wed, 15 Jan 2025 14:04:44 +0000
Subject: [PATCH 3/4] Only store direct superclasses in Record

---
 llvm/include/llvm/TableGen/Record.h           | 35 ++++++++-----
 llvm/lib/TableGen/Record.cpp                  | 49 +------------------
 llvm/lib/TableGen/TGParser.cpp                | 13 +----
 .../TableGen/Common/CodeGenRegisters.cpp      |  4 +-
 .../utils/TableGen/SearchableTableEmitter.cpp |  2 +-
 5 files changed, 30 insertions(+), 73 deletions(-)

diff --git a/llvm/include/llvm/TableGen/Record.h b/llvm/include/llvm/TableGen/Record.h
index 8b49daf6374048..52c4a92c58c6a6 100644
--- a/llvm/include/llvm/TableGen/Record.h
+++ b/llvm/include/llvm/TableGen/Record.h
@@ -1630,9 +1630,9 @@ class Record {
   SmallVector<AssertionInfo, 0> Assertions;
   SmallVector<DumpInfo, 0> Dumps;
 
-  // All superclasses in the inheritance forest in post-order (yes, it
+  // Direct superclasses, which are roots of the inheritance forest (yes, it
   // must be a forest; diamond-shaped inheritance is not allowed).
-  SmallVector<std::pair<const Record *, SMRange>, 0> SuperClasses;
+  SmallVector<std::pair<const Record *, SMRange>, 0> DirectSuperClasses;
 
   // Tracks Record instances. Not owned by Record.
   RecordKeeper &TrackedRecords;
@@ -1666,8 +1666,9 @@ class Record {
   Record(const Record &O)
       : Name(O.Name), Locs(O.Locs), TemplateArgs(O.TemplateArgs),
         Values(O.Values), Assertions(O.Assertions),
-        SuperClasses(O.SuperClasses), TrackedRecords(O.TrackedRecords),
-        ID(getNewUID(O.getRecords())), Kind(O.Kind) {}
+        DirectSuperClasses(O.DirectSuperClasses),
+        TrackedRecords(O.TrackedRecords), ID(getNewUID(O.getRecords())),
+        Kind(O.Kind) {}
 
   static unsigned getNewUID(RecordKeeper &RK);
 
@@ -1720,15 +1721,22 @@ class Record {
 
   void getSuperClasses(
       SmallVectorImpl<std::pair<const Record *, SMRange>> &Classes) const {
-    Classes.append(SuperClasses);
+    for (const auto &[SC, R] : DirectSuperClasses) {
+      SC->getSuperClasses(Classes);
+      Classes.emplace_back(SC, R);
+    }
   }
 
   /// Determine whether this record has the specified direct superclass.
-  bool hasDirectSuperClass(const Record *SuperClass) const;
+  bool hasDirectSuperClass(const Record *SuperClass) const {
+    return is_contained(make_first_range(DirectSuperClasses), SuperClass);
+  }
 
   /// Append the direct superclasses of this record to Classes.
   void getDirectSuperClasses(
-      SmallVectorImpl<std::pair<const Record *, SMRange>> &Classes) const;
+      SmallVectorImpl<std::pair<const Record *, SMRange>> &Classes) const {
+    Classes.append(DirectSuperClasses);
+  }
 
   bool isTemplateArg(const Init *Name) const {
     return llvm::is_contained(TemplateArgs, Name);
@@ -1796,29 +1804,32 @@ class Record {
   void checkUnusedTemplateArgs();
 
   bool isSubClassOf(const Record *R) const {
-    for (const auto &[SC, _] : SuperClasses)
-      if (SC == R)
+    for (const auto &[SC, _] : DirectSuperClasses) {
+      if (SC == R || SC->isSubClassOf(R))
         return true;
+    }
     return false;
   }
 
   bool isSubClassOf(StringRef Name) const {
-    for (const auto &[SC, _] : SuperClasses) {
+    for (const auto &[SC, _] : DirectSuperClasses) {
       if (const auto *SI = dyn_cast<StringInit>(SC->getNameInit())) {
         if (SI->getValue() == Name)
           return true;
       } else if (SC->getNameInitAsString() == Name) {
         return true;
       }
+      if (SC->isSubClassOf(Name))
+        return true;
     }
     return false;
   }
 
-  void addSuperClass(const Record *R, SMRange Range) {
+  void addDirectSuperClass(const Record *R, SMRange Range) {
     assert(!CorrespondingDefInit &&
            "changing type of record after it has been referenced");
     assert(!isSubClassOf(R) && "Already subclassing record!");
-    SuperClasses.push_back(std::make_pair(R, Range));
+    DirectSuperClasses.emplace_back(R, Range);
   }
 
   /// If there are any field references that refer to fields that have been
diff --git a/llvm/lib/TableGen/Record.cpp b/llvm/lib/TableGen/Record.cpp
index 9ad002b67765bd..5db47b8ce6899d 100644
--- a/llvm/lib/TableGen/Record.cpp
+++ b/llvm/lib/TableGen/Record.cpp
@@ -2398,13 +2398,8 @@ const DefInit *VarDefInit::instantiate() {
 
   NewRec->resolveReferences(R);
 
-  // Add superclasses.
-  SmallVector<std::pair<const Record *, SMRange>> SCs;
-  Class->getSuperClasses(SCs);
-  for (const auto &[SC, Loc] : SCs)
-    NewRec->addSuperClass(SC, Loc);
-
-  NewRec->addSuperClass(
+  // Add superclass.
+  NewRec->addDirectSuperClass(
       Class, SMRange(Class->getLoc().back(), Class->getLoc().back()));
 
   // Resolve internal references and store in record keeper
@@ -2914,46 +2909,6 @@ void Record::setName(const Init *NewName) {
   // this.  See TGParser::ParseDef and TGParser::ParseDefm.
 }
 
-// NOTE for the next two functions:
-// Superclasses are in post-order, so the final one is a direct
-// superclass. All of its transitive superclases immediately precede it,
-// so we can step through the direct superclasses in reverse order.
-
-bool Record::hasDirectSuperClass(const Record *Superclass) const {
-  SmallVector<std::pair<const Record *, SMRange>> SCs;
-  getSuperClasses(SCs);
-
-  SmallVector<std::pair<const Record *, SMRange>> SSCs;
-
-  for (int I = SCs.size() - 1; I >= 0; --I) {
-    const Record *SC = SCs[I].first;
-    if (SC == Superclass)
-      return true;
-    SC->getSuperClasses(SSCs);
-    I -= SSCs.size();
-    SSCs.clear();
-  }
-
-  return false;
-}
-
-void Record::getDirectSuperClasses(
-    SmallVectorImpl<std::pair<const Record *, SMRange>> &Classes) const {
-  SmallVector<std::pair<const Record *, SMRange>> SCVec;
-  getSuperClasses(SCVec);
-  ArrayRef<std::pair<const Record *, SMRange>> SCs = SCVec;
-
-  SmallVector<std::pair<const Record *, SMRange>> SSCs;
-
-  while (!SCs.empty()) {
-    auto [SC, Range] = SCs.back();
-    SC->getSuperClasses(SSCs);
-    SCs = SCs.drop_back(1 + SSCs.size());
-    SSCs.clear();
-    Classes.emplace_back(SC, Range);
-  }
-}
-
 void Record::resolveReferences(Resolver &R, const RecordVal *SkipVal) {
   const Init *OldName = getNameInit();
   const Init *NewName = Name->resolveReferences(R);
diff --git a/llvm/lib/TableGen/TGParser.cpp b/llvm/lib/TableGen/TGParser.cpp
index 317cd6b5a9213b..226aaa6991a188 100644
--- a/llvm/lib/TableGen/TGParser.cpp
+++ b/llvm/lib/TableGen/TGParser.cpp
@@ -330,19 +330,10 @@ bool TGParser::AddSubClass(Record *CurRec, SubClassReference &SubClass) {
 
   // Since everything went well, we can now set the "superclass" list for the
   // current record.
-  SmallVector<std::pair<const Record *, SMRange>> SCs;
-  SC->getSuperClasses(SCs);
-  for (const auto &[SC, Loc] : SCs) {
-    if (CurRec->isSubClassOf(SC))
-      return Error(SubClass.RefRange.Start,
-                   "Already subclass of '" + SC->getName() + "'!\n");
-    CurRec->addSuperClass(SC, Loc);
-  }
-
   if (CurRec->isSubClassOf(SC))
     return Error(SubClass.RefRange.Start,
                  "Already subclass of '" + SC->getName() + "'!\n");
-  CurRec->addSuperClass(SC, SubClass.RefRange);
+  CurRec->addDirectSuperClass(SC, SubClass.RefRange);
   return false;
 }
 
@@ -4005,7 +3996,7 @@ bool TGParser::ParseClass() {
   if (CurRec) {
     // If the body was previously defined, this is an error.
     SmallVector<std::pair<const Record *, SMRange>> SCs;
-    CurRec->getSuperClasses(SCs);
+    CurRec->getDirectSuperClasses(SCs);
     if (!CurRec->getValues().empty() || !SCs.empty() ||
         !CurRec->getTemplateArgs().empty())
       return TokError("Class '" + CurRec->getNameInitAsString() +
diff --git a/llvm/utils/TableGen/Common/CodeGenRegisters.cpp b/llvm/utils/TableGen/Common/CodeGenRegisters.cpp
index 237b0d415a8a65..a3934d644ce3bf 100644
--- a/llvm/utils/TableGen/Common/CodeGenRegisters.cpp
+++ b/llvm/utils/TableGen/Common/CodeGenRegisters.cpp
@@ -704,9 +704,9 @@ struct TupleExpander : SetTheory::Expander {
 
       // Copy Proto super-classes.
       SmallVector<std::pair<const Record *, SMRange>> SCs;
-      Proto->getSuperClasses(SCs);
+      Proto->getDirectSuperClasses(SCs);
       for (const auto &[Super, Loc] : SCs)
-        NewReg->addSuperClass(Super, Loc);
+        NewReg->addDirectSuperClass(Super, Loc);
 
       // Copy Proto fields.
       for (unsigned i = 0, e = Proto->getValues().size(); i != e; ++i) {
diff --git a/llvm/utils/TableGen/SearchableTableEmitter.cpp b/llvm/utils/TableGen/SearchableTableEmitter.cpp
index f5ccc99a5ad645..2d0436df7cc645 100644
--- a/llvm/utils/TableGen/SearchableTableEmitter.cpp
+++ b/llvm/utils/TableGen/SearchableTableEmitter.cpp
@@ -840,7 +840,7 @@ void SearchableTableEmitter::run(raw_ostream &OS) {
   for (auto &NameRec : Records.getClasses()) {
     const Record *Class = NameRec.second.get();
     SmallVector<std::pair<const Record *, SMRange>> SCs;
-    Class->getSuperClasses(SCs);
+    Class->getDirectSuperClasses(SCs);
     if (SCs.size() != 1 || !Class->isSubClassOf(SearchableTable))
       continue;
 

>From e235152c1de74e740ed51096fbdc2f61c4293bbb Mon Sep 17 00:00:00 2001
From: Jay Foad <jay.foad at amd.com>
Date: Wed, 15 Jan 2025 14:37:42 +0000
Subject: [PATCH 4/4] Simplify API of getDirectSuperClasses

---
 llvm/include/llvm/TableGen/Record.h             |  7 +++----
 llvm/lib/TableGen/Record.cpp                    | 10 ++--------
 llvm/lib/TableGen/TGParser.cpp                  |  5 ++---
 llvm/utils/TableGen/Common/CodeGenRegisters.cpp |  4 +---
 llvm/utils/TableGen/SearchableTableEmitter.cpp  |  5 ++---
 5 files changed, 10 insertions(+), 21 deletions(-)

diff --git a/llvm/include/llvm/TableGen/Record.h b/llvm/include/llvm/TableGen/Record.h
index 52c4a92c58c6a6..45da0af25894f6 100644
--- a/llvm/include/llvm/TableGen/Record.h
+++ b/llvm/include/llvm/TableGen/Record.h
@@ -1732,10 +1732,9 @@ class Record {
     return is_contained(make_first_range(DirectSuperClasses), SuperClass);
   }
 
-  /// Append the direct superclasses of this record to Classes.
-  void getDirectSuperClasses(
-      SmallVectorImpl<std::pair<const Record *, SMRange>> &Classes) const {
-    Classes.append(DirectSuperClasses);
+  /// Return the direct superclasses of this record.
+  ArrayRef<std::pair<const Record *, SMRange>> getDirectSuperClasses() const {
+    return DirectSuperClasses;
   }
 
   bool isTemplateArg(const Init *Name) const {
diff --git a/llvm/lib/TableGen/Record.cpp b/llvm/lib/TableGen/Record.cpp
index 5db47b8ce6899d..4f94b3a48f9123 100644
--- a/llvm/lib/TableGen/Record.cpp
+++ b/llvm/lib/TableGen/Record.cpp
@@ -327,17 +327,13 @@ static const RecordRecTy *resolveRecordTypes(const RecordRecTy *T1,
   SmallVector<const Record *, 4> CommonSuperClasses;
   SmallVector<const Record *, 4> Stack(T1->getClasses());
 
-  SmallVector<std::pair<const Record *, SMRange>> SCs;
-
   while (!Stack.empty()) {
     const Record *R = Stack.pop_back_val();
 
     if (T2->isSubClassOf(R)) {
       CommonSuperClasses.push_back(R);
     } else {
-      R->getDirectSuperClasses(SCs);
-      append_range(Stack, make_first_range(SCs));
-      SCs.clear();
+      append_range(Stack, make_first_range(R->getDirectSuperClasses()));
     }
   }
 
@@ -2874,10 +2870,8 @@ void Record::checkName() {
 }
 
 const RecordRecTy *Record::getType() const {
-  SmallVector<std::pair<const Record *, SMRange>> SCs;
-  getDirectSuperClasses(SCs);
   SmallVector<const Record *, 4> DirectSCs;
-  append_range(DirectSCs, make_first_range(SCs));
+  append_range(DirectSCs, make_first_range(getDirectSuperClasses()));
   return RecordRecTy::get(TrackedRecords, DirectSCs);
 }
 
diff --git a/llvm/lib/TableGen/TGParser.cpp b/llvm/lib/TableGen/TGParser.cpp
index 226aaa6991a188..b15de794408c12 100644
--- a/llvm/lib/TableGen/TGParser.cpp
+++ b/llvm/lib/TableGen/TGParser.cpp
@@ -3995,9 +3995,8 @@ bool TGParser::ParseClass() {
   Record *CurRec = const_cast<Record *>(Records.getClass(Name));
   if (CurRec) {
     // If the body was previously defined, this is an error.
-    SmallVector<std::pair<const Record *, SMRange>> SCs;
-    CurRec->getDirectSuperClasses(SCs);
-    if (!CurRec->getValues().empty() || !SCs.empty() ||
+    if (!CurRec->getValues().empty() ||
+        !CurRec->getDirectSuperClasses().empty() ||
         !CurRec->getTemplateArgs().empty())
       return TokError("Class '" + CurRec->getNameInitAsString() +
                       "' already defined");
diff --git a/llvm/utils/TableGen/Common/CodeGenRegisters.cpp b/llvm/utils/TableGen/Common/CodeGenRegisters.cpp
index a3934d644ce3bf..ed8891d704fba0 100644
--- a/llvm/utils/TableGen/Common/CodeGenRegisters.cpp
+++ b/llvm/utils/TableGen/Common/CodeGenRegisters.cpp
@@ -703,9 +703,7 @@ struct TupleExpander : SetTheory::Expander {
                         "Register tuple redefines register '" + Name + "'.");
 
       // Copy Proto super-classes.
-      SmallVector<std::pair<const Record *, SMRange>> SCs;
-      Proto->getDirectSuperClasses(SCs);
-      for (const auto &[Super, Loc] : SCs)
+      for (const auto &[Super, Loc] : Proto->getDirectSuperClasses())
         NewReg->addDirectSuperClass(Super, Loc);
 
       // Copy Proto fields.
diff --git a/llvm/utils/TableGen/SearchableTableEmitter.cpp b/llvm/utils/TableGen/SearchableTableEmitter.cpp
index 2d0436df7cc645..caae0037de9956 100644
--- a/llvm/utils/TableGen/SearchableTableEmitter.cpp
+++ b/llvm/utils/TableGen/SearchableTableEmitter.cpp
@@ -839,9 +839,8 @@ void SearchableTableEmitter::run(raw_ostream &OS) {
   const Record *SearchableTable = Records.getClass("SearchableTable");
   for (auto &NameRec : Records.getClasses()) {
     const Record *Class = NameRec.second.get();
-    SmallVector<std::pair<const Record *, SMRange>> SCs;
-    Class->getDirectSuperClasses(SCs);
-    if (SCs.size() != 1 || !Class->isSubClassOf(SearchableTable))
+    if (Class->getDirectSuperClasses().size() != 1 ||
+        !Class->isSubClassOf(SearchableTable))
       continue;
 
     StringRef TableName = Class->getName();



More information about the llvm-commits mailing list