[llvm] [TextAPI] Refactor BinaryAttrs to InterfaceFile assignment (PR #81551)
Cyndy Ishida via llvm-commits
llvm-commits at lists.llvm.org
Mon Feb 12 15:53:34 PST 2024
https://github.com/cyndyishida created https://github.com/llvm/llvm-project/pull/81551
Create a helper method for this operation, so it can be reused in multiple places.
Additonally move FileType enum into its own header to avoid include cycles.
>From 49559c897ee99ee8d24ec2d1df231d59b3133417 Mon Sep 17 00:00:00 2001
From: Cyndy Ishida <cyndy_ishida at apple.com>
Date: Mon, 12 Feb 2024 15:47:21 -0800
Subject: [PATCH] [TextAPI] Refactor BinaryAttrs to InterfaceFile assignment
Create a helper method for this operation, so it can be reused in
multiple places.
Additonally move FileType enum into its own header to avoid include
cycles.
---
llvm/include/llvm/TextAPI/FileTypes.h | 49 +++++++++++++++++++
llvm/include/llvm/TextAPI/InterfaceFile.h | 49 ++++---------------
llvm/include/llvm/TextAPI/RecordsSlice.h | 3 +-
llvm/lib/TextAPI/BinaryReader/DylibReader.cpp | 1 +
llvm/lib/TextAPI/InterfaceFile.cpp | 29 +++++++++++
llvm/lib/TextAPI/RecordsSlice.cpp | 24 +--------
llvm/lib/TextAPI/TextAPIContext.h | 3 +-
llvm/lib/TextAPI/TextStubCommon.h | 1 +
8 files changed, 95 insertions(+), 64 deletions(-)
create mode 100644 llvm/include/llvm/TextAPI/FileTypes.h
diff --git a/llvm/include/llvm/TextAPI/FileTypes.h b/llvm/include/llvm/TextAPI/FileTypes.h
new file mode 100644
index 00000000000000..5876e9d5a5304e
--- /dev/null
+++ b/llvm/include/llvm/TextAPI/FileTypes.h
@@ -0,0 +1,49 @@
+//===- llvm/TextAPI/FileTypes.h - TAPI Interface File -----------*- 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_TEXTAPI_FILETYPES_H
+#define LLVM_TEXTAPI_FILETYPES_H
+
+#include "llvm/ADT/BitmaskEnum.h"
+namespace llvm::MachO {
+/// Defines the file type TextAPI files can represent.
+enum FileType : unsigned {
+ /// Invalid file type.
+ Invalid = 0U,
+
+ /// \brief MachO Dynamic Library file.
+ MachO_DynamicLibrary = 1U << 0,
+
+ /// \brief MachO Dynamic Library Stub file.
+ MachO_DynamicLibrary_Stub = 1U << 1,
+
+ /// \brief MachO Bundle file.
+ MachO_Bundle = 1U << 2,
+
+ /// Text-based stub file (.tbd) version 1.0
+ TBD_V1 = 1U << 3,
+
+ /// Text-based stub file (.tbd) version 2.0
+ TBD_V2 = 1U << 4,
+
+ /// Text-based stub file (.tbd) version 3.0
+ TBD_V3 = 1U << 5,
+
+ /// Text-based stub file (.tbd) version 4.0
+ TBD_V4 = 1U << 6,
+
+ /// Text-based stub file (.tbd) version 5.0
+ TBD_V5 = 1U << 7,
+
+ All = ~0U,
+
+ LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/All),
+};
+
+} // namespace llvm::MachO
+#endif // LLVM_TEXTAPI_FILETYPES_H
diff --git a/llvm/include/llvm/TextAPI/InterfaceFile.h b/llvm/include/llvm/TextAPI/InterfaceFile.h
index 7984a8008771e0..10a37e3a0c2f35 100644
--- a/llvm/include/llvm/TextAPI/InterfaceFile.h
+++ b/llvm/include/llvm/TextAPI/InterfaceFile.h
@@ -14,14 +14,15 @@
#ifndef LLVM_TEXTAPI_INTERFACEFILE_H
#define LLVM_TEXTAPI_INTERFACEFILE_H
-#include "llvm/ADT/BitmaskEnum.h"
#include "llvm/ADT/Hashing.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/iterator.h"
#include "llvm/Support/Allocator.h"
#include "llvm/TextAPI/ArchitectureSet.h"
+#include "llvm/TextAPI/FileTypes.h"
#include "llvm/TextAPI/PackedVersion.h"
#include "llvm/TextAPI/Platform.h"
+#include "llvm/TextAPI/RecordsSlice.h"
#include "llvm/TextAPI/Symbol.h"
#include "llvm/TextAPI/SymbolSet.h"
#include "llvm/TextAPI/Target.h"
@@ -47,44 +48,6 @@ enum class ObjCConstraintType : unsigned {
GC = 4,
};
-// clang-format off
-
-/// Defines the file type this file represents.
-enum FileType : unsigned {
- /// Invalid file type.
- Invalid = 0U,
-
- /// \brief MachO Dynamic Library file.
- MachO_DynamicLibrary = 1U << 0,
-
- /// \brief MachO Dynamic Library Stub file.
- MachO_DynamicLibrary_Stub = 1U << 1,
-
- /// \brief MachO Bundle file.
- MachO_Bundle = 1U << 2,
-
- /// Text-based stub file (.tbd) version 1.0
- TBD_V1 = 1U << 3,
-
- /// Text-based stub file (.tbd) version 2.0
- TBD_V2 = 1U << 4,
-
- /// Text-based stub file (.tbd) version 3.0
- TBD_V3 = 1U << 5,
-
- /// Text-based stub file (.tbd) version 4.0
- TBD_V4 = 1U << 6,
-
- /// Text-based stub file (.tbd) version 5.0
- TBD_V5 = 1U << 7,
-
- All = ~0U,
-
- LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/All),
-};
-
-// clang-format on
-
/// Reference to an interface file.
class InterfaceFileRef {
public:
@@ -437,6 +400,14 @@ class InterfaceFile {
void inlineLibrary(std::shared_ptr<InterfaceFile> Library,
bool Overwrite = false);
+ /// Set InterfaceFile properties from pre-gathered binary attributes,
+ /// if they are not set already.
+ ///
+ /// \param BA Attributes typically represented in load commands.
+ /// \param Targ MachO Target slice to add attributes to.
+ void setFromBinaryAttrs(const RecordsSlice::BinaryAttrs &BA,
+ const Target &Targ);
+
/// 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/RecordsSlice.h b/llvm/include/llvm/TextAPI/RecordsSlice.h
index f3db72121e68c1..5b214d0bfff567 100644
--- a/llvm/include/llvm/TextAPI/RecordsSlice.h
+++ b/llvm/include/llvm/TextAPI/RecordsSlice.h
@@ -15,7 +15,7 @@
#define LLVM_TEXTAPI_RECORDSLICE_H
#include "llvm/Support/Allocator.h"
-#include "llvm/TextAPI/InterfaceFile.h"
+#include "llvm/TextAPI/FileTypes.h"
#include "llvm/TextAPI/PackedVersion.h"
#include "llvm/TextAPI/Record.h"
#include "llvm/TextAPI/RecordVisitor.h"
@@ -191,6 +191,7 @@ class RecordsSlice {
};
using Records = llvm::SmallVector<std::shared_ptr<RecordsSlice>, 4>;
+class InterfaceFile;
std::unique_ptr<InterfaceFile> convertToInterfaceFile(const Records &Slices);
} // namespace MachO
diff --git a/llvm/lib/TextAPI/BinaryReader/DylibReader.cpp b/llvm/lib/TextAPI/BinaryReader/DylibReader.cpp
index 25b9499d189577..0694d8f28df6bd 100644
--- a/llvm/lib/TextAPI/BinaryReader/DylibReader.cpp
+++ b/llvm/lib/TextAPI/BinaryReader/DylibReader.cpp
@@ -17,6 +17,7 @@
#include "llvm/Object/MachOUniversal.h"
#include "llvm/Support/Endian.h"
#include "llvm/TargetParser/Triple.h"
+#include "llvm/TextAPI/InterfaceFile.h"
#include "llvm/TextAPI/RecordsSlice.h"
#include "llvm/TextAPI/TextAPIError.h"
#include <iomanip>
diff --git a/llvm/lib/TextAPI/InterfaceFile.cpp b/llvm/lib/TextAPI/InterfaceFile.cpp
index d712ed3868258d..9979df92674ccd 100644
--- a/llvm/lib/TextAPI/InterfaceFile.cpp
+++ b/llvm/lib/TextAPI/InterfaceFile.cpp
@@ -11,6 +11,7 @@
//===----------------------------------------------------------------------===//
#include "llvm/TextAPI/InterfaceFile.h"
+#include "llvm/TextAPI/RecordsSlice.h"
#include "llvm/TextAPI/TextAPIError.h"
#include <iomanip>
#include <sstream>
@@ -351,6 +352,34 @@ InterfaceFile::extract(Architecture Arch) const {
return std::move(IF);
}
+void InterfaceFile::setFromBinaryAttrs(const RecordsSlice::BinaryAttrs &BA,
+ const Target &Targ) {
+ if (getFileType() != BA.File)
+ setFileType(BA.File);
+ if (getInstallName().empty())
+ setInstallName(BA.InstallName);
+ if (BA.AppExtensionSafe && !isApplicationExtensionSafe())
+ setApplicationExtensionSafe();
+ if (BA.TwoLevelNamespace && !isTwoLevelNamespace())
+ setTwoLevelNamespace();
+ if (BA.OSLibNotForSharedCache && !isOSLibNotForSharedCache())
+ setOSLibNotForSharedCache();
+ if (getCurrentVersion().empty())
+ setCurrentVersion(BA.CurrentVersion);
+ if (getCompatibilityVersion().empty())
+ setCompatibilityVersion(BA.CompatVersion);
+ if (getSwiftABIVersion() == 0)
+ setSwiftABIVersion(BA.SwiftABI);
+ if (getPath().empty())
+ setPath(BA.Path);
+ if (!BA.ParentUmbrella.empty())
+ addParentUmbrella(Targ, BA.ParentUmbrella);
+ for (const auto &Client : BA.AllowableClients)
+ addAllowableClient(Client, Targ);
+ for (const auto &Lib : BA.RexportedLibraries)
+ addReexportedLibrary(Lib, Targ);
+}
+
static bool isYAMLTextStub(const FileType &Kind) {
return (Kind >= FileType::TBD_V1) && (Kind < FileType::TBD_V5);
}
diff --git a/llvm/lib/TextAPI/RecordsSlice.cpp b/llvm/lib/TextAPI/RecordsSlice.cpp
index f07853e579242b..fb961a91cc656c 100644
--- a/llvm/lib/TextAPI/RecordsSlice.cpp
+++ b/llvm/lib/TextAPI/RecordsSlice.cpp
@@ -12,6 +12,7 @@
#include "llvm/TextAPI/RecordsSlice.h"
#include "llvm/ADT/SetVector.h"
+#include "llvm/TextAPI/InterfaceFile.h"
#include "llvm/TextAPI/Record.h"
#include "llvm/TextAPI/Symbol.h"
#include <utility>
@@ -325,28 +326,7 @@ createInterfaceFile(const Records &Slices, StringRef InstallName) {
continue;
const Target &Targ = S->getTarget();
File->addTarget(Targ);
- if (File->getFileType() == FileType::Invalid)
- File->setFileType(BA.File);
- if (BA.AppExtensionSafe && !File->isApplicationExtensionSafe())
- File->setApplicationExtensionSafe();
- if (BA.TwoLevelNamespace && !File->isTwoLevelNamespace())
- File->setTwoLevelNamespace();
- if (BA.OSLibNotForSharedCache && !File->isOSLibNotForSharedCache())
- File->setOSLibNotForSharedCache();
- if (File->getCurrentVersion().empty())
- File->setCurrentVersion(BA.CurrentVersion);
- if (File->getCompatibilityVersion().empty())
- File->setCompatibilityVersion(BA.CompatVersion);
- if (File->getSwiftABIVersion() == 0)
- File->setSwiftABIVersion(BA.SwiftABI);
- if (File->getPath().empty())
- File->setPath(BA.Path);
- if (!BA.ParentUmbrella.empty())
- File->addParentUmbrella(Targ, BA.ParentUmbrella);
- for (const auto &Client : BA.AllowableClients)
- File->addAllowableClient(Client, Targ);
- for (const auto &Lib : BA.RexportedLibraries)
- File->addReexportedLibrary(Lib, Targ);
+ File->setFromBinaryAttrs(BA, Targ);
}
return File;
diff --git a/llvm/lib/TextAPI/TextAPIContext.h b/llvm/lib/TextAPI/TextAPIContext.h
index 217d1f5400ee82..3151db7b6b80e8 100644
--- a/llvm/lib/TextAPI/TextAPIContext.h
+++ b/llvm/lib/TextAPI/TextAPIContext.h
@@ -13,13 +13,12 @@
#ifndef LLVM_TEXTAPI_MACHO_CONTEXT_H
#define LLVM_TEXTAPI_MACHO_CONTEXT_H
+#include "llvm/TextAPI/FileTypes.h"
#include <string>
namespace llvm {
namespace MachO {
-enum FileType : unsigned;
-
struct TextAPIContext {
std::string ErrorMessage;
std::string Path;
diff --git a/llvm/lib/TextAPI/TextStubCommon.h b/llvm/lib/TextAPI/TextStubCommon.h
index 360910c48d4fe5..155d38a30ba0c8 100644
--- a/llvm/lib/TextAPI/TextStubCommon.h
+++ b/llvm/lib/TextAPI/TextStubCommon.h
@@ -13,6 +13,7 @@
#ifndef LLVM_TEXTAPI_TEXT_STUB_COMMON_H
#define LLVM_TEXTAPI_TEXT_STUB_COMMON_H
+#include "llvm/ADT/BitmaskEnum.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/YAMLTraits.h"
#include "llvm/TextAPI/Architecture.h"
More information about the llvm-commits
mailing list