[TextAPI] Add functionality to manipulate over InterfaceFiles

cyndyishida · cyndyishida · commit 8d863263e33b · 2023-08-06T19:41:20.000-07:00
InterfaceFile is the in-memory representation for tbd files. Add APIs to merge, extract, remove, and inline reexported libraries. Reviewed By: zixuw Differential Revision: https://reviews.llvm.org/D153398 (cherry picked from commit 16c1f43)
diff --git a/llvm/include/llvm/TextAPI/ArchitectureSet.h b/llvm/include/llvm/TextAPI/ArchitectureSet.h
@@ -40,13 +40,18 @@ class ArchitectureSet {
   ArchitectureSet(Architecture Arch) : ArchitectureSet() { set(Arch); }
   ArchitectureSet(const std::vector<Architecture> &Archs);
 
+  static ArchitectureSet All() { return ArchitectureSet(EndIndexVal); }
+
   void set(Architecture Arch) {
     if (Arch == AK_unknown)
       return;
     ArchSet |= 1U << static_cast<int>(Arch);
   }
 
-  void clear(Architecture Arch) { ArchSet &= ~(1U << static_cast<int>(Arch)); }
+  ArchitectureSet clear(Architecture Arch) {
+    ArchSet &= ~(1U << static_cast<int>(Arch));
+    return ArchSet;
+  }
 
   bool has(Architecture Arch) const {
     return ArchSet & (1U << static_cast<int>(Arch));
diff --git a/llvm/include/llvm/TextAPI/InterfaceFile.h b/llvm/include/llvm/TextAPI/InterfaceFile.h
@@ -372,6 +372,37 @@ class InterfaceFile {
     return SymbolsSet->undefineds();
   };
 
+  /// Extract architecture slice from Interface.
+  ///
+  /// \param Arch architecture to extract from.
+  /// \return New InterfaceFile with extracted architecture slice.
+  llvm::Expected<std::unique_ptr<InterfaceFile>>
+  extract(Architecture Arch) const;
+
+  /// Remove architecture slice from Interface.
+  ///
+  /// \param Arch architecture to remove.
+  /// \return New Interface File with removed architecture slice.
+  llvm::Expected<std::unique_ptr<InterfaceFile>>
+  remove(Architecture Arch) const;
+
+  /// Merge Interfaces for the same library. The following library attributes
+  /// must match.
+  /// * Install name, Current & Compatibility version,
+  /// * Two-level namespace enablement, and App extension enablement.
+  ///
+  /// \param O The Interface to merge.
+  /// \return New Interface File that was merged.
+  llvm::Expected<std::unique_ptr<InterfaceFile>>
+  merge(const InterfaceFile *O) const;
+
+  /// Inline reexported library into Interface.
+  ///
+  /// \param Library Interface of reexported library.
+  /// \param Overwrite Whether to overwrite preexisting inlined library.
+  void inlineLibrary(std::shared_ptr<InterfaceFile> Library,
+                     bool Overwrite = false);
+
   /// The equality is determined by attributes that impact linking
   /// compatibilities. Path, & FileKind are irrelevant since these by
   /// itself should not impact linking.
diff --git a/llvm/include/llvm/TextAPI/Symbol.h b/llvm/include/llvm/TextAPI/Symbol.h
@@ -121,6 +121,10 @@ class Symbol {
     return (Flags & SymbolFlags::Text) == SymbolFlags::Text;
   }
 
+  bool hasArchitecture(Architecture Arch) const {
+    return mapToArchitectureSet(Targets).contains(Arch);
+  }
+
   using const_target_iterator = TargetList::const_iterator;
   using const_target_range = llvm::iterator_range<const_target_iterator>;
   const_target_range targets() const { return {Targets}; }
diff --git a/llvm/include/llvm/TextAPI/TextAPIError.h b/llvm/include/llvm/TextAPI/TextAPIError.h
@@ -0,0 +1,38 @@
+//===- llvm/TextAPI/TextAPIError.h - TAPI Error -----------------*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+///
+/// \file
+/// \brief Define TAPI specific error codes.
+///
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_TEXTAPI_TEXTAPIERROR_H
+#define LLVM_TEXTAPI_TEXTAPIERROR_H
+
+#include "llvm/Support/Error.h"
+
+namespace llvm::MachO {
+enum class TextAPIErrorCode {
+  NoSuchArchitecture,
+  EmptyResults,
+  GenericFrontendError,
+};
+
+class TextAPIError : public llvm::ErrorInfo<TextAPIError> {
+public:
+  static char ID;
+  TextAPIErrorCode EC;
+
+  TextAPIError(TextAPIErrorCode EC) : EC(EC) {}
+
+  void log(raw_ostream &OS) const override;
+  std::error_code convertToErrorCode() const override;
+};
+
+} // namespace llvm::MachO
+#endif // LLVM_TEXTAPI_TEXTAPIERROR_H
diff --git a/llvm/lib/TextAPI/CMakeLists.txt b/llvm/lib/TextAPI/CMakeLists.txt
@@ -8,6 +8,7 @@ add_llvm_component_library(LLVMTextAPI
   Symbol.cpp
   SymbolSet.cpp
   Target.cpp
+  TextAPIError.cpp
   TextStub.cpp
   TextStubCommon.cpp
 
diff --git a/llvm/lib/TextAPI/InterfaceFile.cpp b/llvm/lib/TextAPI/InterfaceFile.cpp
@@ -11,6 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 #include "llvm/TextAPI/InterfaceFile.h"
+#include "llvm/TextAPI/TextAPIError.h"
 #include <iomanip>
 #include <sstream>
 
@@ -81,6 +82,267 @@ void InterfaceFile::addDocument(std::shared_ptr<InterfaceFile> &&Document) {
   Documents.insert(Pos, Document);
 }
 
+void InterfaceFile::inlineLibrary(std::shared_ptr<InterfaceFile> Library,
+                                  bool Overwrite) {
+  auto AddFwk = [&](std::shared_ptr<InterfaceFile> &&Reexport) {
+    auto It = lower_bound(
+        Documents, Reexport->getInstallName(),
+        [](std::shared_ptr<InterfaceFile> &Lhs, const StringRef Rhs) {
+          return Lhs->getInstallName() < Rhs;
+        });
+
+    if (Overwrite && It != Documents.end() &&
+        Reexport->getInstallName() == (*It)->getInstallName()) {
+      std::replace(Documents.begin(), Documents.end(), *It,
+                   std::move(Reexport));
+      return;
+    }
+
+    if ((It != Documents.end()) &&
+        !(Reexport->getInstallName() < (*It)->getInstallName()))
+      return;
+
+    Documents.emplace(It, std::move(Reexport));
+  };
+  for (auto Doc : Library->documents())
+    AddFwk(std::move(Doc));
+
+  Library->Documents.clear();
+  AddFwk(std::move(Library));
+}
+
+Expected<std::unique_ptr<InterfaceFile>>
+InterfaceFile::merge(const InterfaceFile *O) const {
+  // Verify files can be merged.
+  if (getInstallName() != O->getInstallName()) {
+    return make_error<StringError>("install names do not match",
+                                   inconvertibleErrorCode());
+  }
+
+  if (getCurrentVersion() != O->getCurrentVersion()) {
+    return make_error<StringError>("current versions do not match",
+                                   inconvertibleErrorCode());
+  }
+
+  if (getCompatibilityVersion() != O->getCompatibilityVersion()) {
+    return make_error<StringError>("compatibility versions do not match",
+                                   inconvertibleErrorCode());
+  }
+
+  if ((getSwiftABIVersion() != 0) && (O->getSwiftABIVersion() != 0) &&
+      (getSwiftABIVersion() != O->getSwiftABIVersion())) {
+    return make_error<StringError>("swift ABI versions do not match",
+                                   inconvertibleErrorCode());
+  }
+
+  if (isTwoLevelNamespace() != O->isTwoLevelNamespace()) {
+    return make_error<StringError>("two level namespace flags do not match",
+                                   inconvertibleErrorCode());
+  }
+
+  if (isApplicationExtensionSafe() != O->isApplicationExtensionSafe()) {
+    return make_error<StringError>(
+        "application extension safe flags do not match",
+        inconvertibleErrorCode());
+  }
+
+  std::unique_ptr<InterfaceFile> IF(new InterfaceFile());
+  IF->setFileType(std::max(getFileType(), O->getFileType()));
+  IF->setPath(getPath());
+  IF->setInstallName(getInstallName());
+  IF->setCurrentVersion(getCurrentVersion());
+  IF->setCompatibilityVersion(getCompatibilityVersion());
+
+  if (getSwiftABIVersion() == 0)
+    IF->setSwiftABIVersion(O->getSwiftABIVersion());
+  else
+    IF->setSwiftABIVersion(getSwiftABIVersion());
+
+  IF->setTwoLevelNamespace(isTwoLevelNamespace());
+  IF->setApplicationExtensionSafe(isApplicationExtensionSafe());
+
+  for (const auto &It : umbrellas()) {
+    if (!It.second.empty())
+      IF->addParentUmbrella(It.first, It.second);
+  }
+  for (const auto &It : O->umbrellas()) {
+    if (!It.second.empty())
+      IF->addParentUmbrella(It.first, It.second);
+  }
+  IF->addTargets(targets());
+  IF->addTargets(O->targets());
+
+  for (const auto &Lib : allowableClients())
+    for (const auto &Target : Lib.targets())
+      IF->addAllowableClient(Lib.getInstallName(), Target);
+
+  for (const auto &Lib : O->allowableClients())
+    for (const auto &Target : Lib.targets())
+      IF->addAllowableClient(Lib.getInstallName(), Target);
+
+  for (const auto &Lib : reexportedLibraries())
+    for (const auto &Target : Lib.targets())
+      IF->addReexportedLibrary(Lib.getInstallName(), Target);
+
+  for (const auto &Lib : O->reexportedLibraries())
+    for (const auto &Target : Lib.targets())
+      IF->addReexportedLibrary(Lib.getInstallName(), Target);
+
+  for (const auto &[Target, Path] : rpaths())
+    IF->addRPath(Target, Path);
+  for (const auto &[Target, Path] : O->rpaths())
+    IF->addRPath(Target, Path);
+
+  for (const auto *Sym : symbols()) {
+    IF->addSymbol(Sym->getKind(), Sym->getName(), Sym->targets(),
+                  Sym->getFlags());
+  }
+
+  for (const auto *Sym : O->symbols()) {
+    IF->addSymbol(Sym->getKind(), Sym->getName(), Sym->targets(),
+                  Sym->getFlags());
+  }
+
+  return std::move(IF);
+}
+
+Expected<std::unique_ptr<InterfaceFile>>
+InterfaceFile::remove(Architecture Arch) const {
+  if (getArchitectures() == Arch)
+    return make_error<StringError>("cannot remove last architecture slice '" +
+                                       getArchitectureName(Arch) + "'",
+                                   inconvertibleErrorCode());
+
+  if (!getArchitectures().has(Arch)) {
+    bool Found = false;
+    for (auto &Doc : Documents) {
+      if (Doc->getArchitectures().has(Arch)) {
+        Found = true;
+        break;
+      }
+    }
+
+    if (!Found)
+      return make_error<TextAPIError>(TextAPIErrorCode::NoSuchArchitecture);
+  }
+
+  std::unique_ptr<InterfaceFile> IF(new InterfaceFile());
+  IF->setFileType(getFileType());
+  IF->setPath(getPath());
+  IF->addTargets(targets(ArchitectureSet::All().clear(Arch)));
+  IF->setInstallName(getInstallName());
+  IF->setCurrentVersion(getCurrentVersion());
+  IF->setCompatibilityVersion(getCompatibilityVersion());
+  IF->setSwiftABIVersion(getSwiftABIVersion());
+  IF->setTwoLevelNamespace(isTwoLevelNamespace());
+  IF->setApplicationExtensionSafe(isApplicationExtensionSafe());
+  for (const auto &It : umbrellas())
+    if (It.first.Arch != Arch)
+      IF->addParentUmbrella(It.first, It.second);
+
+  for (const auto &Lib : allowableClients()) {
+    for (const auto &Target : Lib.targets())
+      if (Target.Arch != Arch)
+        IF->addAllowableClient(Lib.getInstallName(), Target);
+  }
+
+  for (const auto &Lib : reexportedLibraries()) {
+    for (const auto &Target : Lib.targets())
+      if (Target.Arch != Arch)
+        IF->addReexportedLibrary(Lib.getInstallName(), Target);
+  }
+
+  for (const auto *Sym : symbols()) {
+    auto Archs = Sym->getArchitectures();
+    Archs.clear(Arch);
+    if (Archs.empty())
+      continue;
+
+    IF->addSymbol(Sym->getKind(), Sym->getName(), Sym->targets(Archs),
+                  Sym->getFlags());
+  }
+
+  for (auto &Doc : Documents) {
+    // Skip the inlined document if the to be removed architecture is the
+    // only one left.
+    if (Doc->getArchitectures() == Arch)
+      continue;
+
+    // If the document doesn't contain the arch, then no work is to be done
+    // and it can be copied over.
+    if (!Doc->getArchitectures().has(Arch)) {
+      auto NewDoc = Doc;
+      IF->addDocument(std::move(NewDoc));
+      continue;
+    }
+
+    auto Result = Doc->remove(Arch);
+    if (!Result)
+      return Result;
+
+    IF->addDocument(std::move(Result.get()));
+  }
+
+  return std::move(IF);
+}
+
+Expected<std::unique_ptr<InterfaceFile>>
+InterfaceFile::extract(Architecture Arch) const {
+  if (!getArchitectures().has(Arch)) {
+    return make_error<StringError>("file doesn't have architecture '" +
+                                       getArchitectureName(Arch) + "'",
+                                   inconvertibleErrorCode());
+  }
+
+  std::unique_ptr<InterfaceFile> IF(new InterfaceFile());
+  IF->setFileType(getFileType());
+  IF->setPath(getPath());
+  IF->addTargets(targets(Arch));
+  IF->setInstallName(getInstallName());
+  IF->setCurrentVersion(getCurrentVersion());
+  IF->setCompatibilityVersion(getCompatibilityVersion());
+  IF->setSwiftABIVersion(getSwiftABIVersion());
+  IF->setTwoLevelNamespace(isTwoLevelNamespace());
+  IF->setApplicationExtensionSafe(isApplicationExtensionSafe());
+  for (const auto &It : umbrellas())
+    if (It.first.Arch == Arch)
+      IF->addParentUmbrella(It.first, It.second);
+
+  for (const auto &It : rpaths())
+    if (It.first.Arch == Arch)
+      IF->addRPath(It.first, It.second);
+
+  for (const auto &Lib : allowableClients())
+    for (const auto &Target : Lib.targets())
+      if (Target.Arch == Arch)
+        IF->addAllowableClient(Lib.getInstallName(), Target);
+
+  for (const auto &Lib : reexportedLibraries())
+    for (const auto &Target : Lib.targets())
+      if (Target.Arch == Arch)
+        IF->addReexportedLibrary(Lib.getInstallName(), Target);
+
+  for (const auto *Sym : symbols()) {
+    if (Sym->hasArchitecture(Arch))
+      IF->addSymbol(Sym->getKind(), Sym->getName(), Sym->targets(Arch),
+                    Sym->getFlags());
+  }
+
+  for (auto &Doc : Documents) {
+    // Skip documents that don't have the requested architecture.
+    if (!Doc->getArchitectures().has(Arch))
+      continue;
+
+    auto Result = Doc->extract(Arch);
+    if (!Result)
+      return Result;
+
+    IF->addDocument(std::move(Result.get()));
+  }
+
+  return std::move(IF);
+}
+
 static bool isYAMLTextStub(const FileType &Kind) {
   return (Kind >= FileType::TBD_V1) && (Kind < FileType::TBD_V5);
 }
diff --git a/llvm/lib/TextAPI/TextAPIError.cpp b/llvm/lib/TextAPI/TextAPIError.cpp
diff --git a/llvm/unittests/TextAPI/TextStubV5Tests.cpp b/llvm/unittests/TextAPI/TextStubV5Tests.cpp
