LLVM 20.0.0git
|
Defines the interface file. More...
#include "llvm/TextAPI/InterfaceFile.h"
Public Types | |
using | const_target_iterator = TargetList::const_iterator |
using | const_target_range = llvm::iterator_range< const_target_iterator > |
using | const_filtered_target_iterator = llvm::filter_iterator< const_target_iterator, std::function< bool(const Target &)> > |
using | const_filtered_target_range = llvm::iterator_range< const_filtered_target_iterator > |
using | const_symbol_range = SymbolSet::const_symbol_range |
using | const_filtered_symbol_range = SymbolSet::const_filtered_symbol_range |
Public Member Functions | |
InterfaceFile (std::unique_ptr< SymbolSet > &&InputSymbols) | |
InterfaceFile () | |
void | setPath (StringRef Path_) |
Set the path from which this file was generated (if applicable). | |
StringRef | getPath () const |
Get the path from which this file was generated (if applicable). | |
void | setFileType (FileType Kind) |
Set the file type. | |
FileType | getFileType () const |
Get the file type. | |
ArchitectureSet | getArchitectures () const |
Get the architectures. | |
PlatformSet | getPlatforms () const |
Get the platforms. | |
void | addTarget (const Target &Target) |
Set and add target. | |
bool | hasTarget (const Target &Targ) const |
Determine if target triple slice exists in file. | |
template<typename RangeT > | |
void | addTargets (RangeT &&Targets) |
Set and add targets. | |
const_target_range | targets () const |
const_filtered_target_range | targets (ArchitectureSet Archs) const |
void | setInstallName (StringRef InstallName_) |
Set the install name of the library. | |
StringRef | getInstallName () const |
Get the install name of the library. | |
void | setCurrentVersion (PackedVersion Version) |
Set the current version of the library. | |
PackedVersion | getCurrentVersion () const |
Get the current version of the library. | |
void | setCompatibilityVersion (PackedVersion Version) |
Set the compatibility version of the library. | |
PackedVersion | getCompatibilityVersion () const |
Get the compatibility version of the library. | |
void | setSwiftABIVersion (uint8_t Version) |
Set the Swift ABI version of the library. | |
uint8_t | getSwiftABIVersion () const |
Get the Swift ABI version of the library. | |
void | setTwoLevelNamespace (bool V=true) |
Specify if the library uses two-level namespace (or flat namespace). | |
bool | isTwoLevelNamespace () const |
Check if the library uses two-level namespace. | |
void | setOSLibNotForSharedCache (bool V=true) |
Specify if the library is an OS library but not shared cache eligible. | |
bool | isOSLibNotForSharedCache () const |
Check if the library is an OS library that is not shared cache eligible. | |
void | setApplicationExtensionSafe (bool V=true) |
Specify if the library is application extension safe (or not). | |
bool | isApplicationExtensionSafe () const |
Check if the library is application extension safe. | |
bool | hasSimulatorSupport () const |
Check if the library has simulator support. | |
void | setSimulatorSupport (bool V=true) |
Specify if the library has simulator support. | |
void | setObjCConstraint (ObjCConstraintType Constraint) |
Set the Objective-C constraint. | |
ObjCConstraintType | getObjCConstraint () const |
Get the Objective-C constraint. | |
void | addParentUmbrella (const Target &Target_, StringRef Parent) |
Set the parent umbrella frameworks. | |
const std::vector< std::pair< Target, std::string > > & | umbrellas () const |
Get the list of Parent Umbrella frameworks. | |
void | addAllowableClient (StringRef InstallName, const Target &Target) |
Add an allowable client. | |
const std::vector< InterfaceFileRef > & | allowableClients () const |
Get the list of allowable clients. | |
void | addReexportedLibrary (StringRef InstallName, const Target &Target) |
Add a re-exported library. | |
const std::vector< InterfaceFileRef > & | reexportedLibraries () const |
Get the list of re-exported libraries. | |
void | addDocument (std::shared_ptr< InterfaceFile > &&Document) |
Add a library for inlining to top level library. | |
InterfaceFile * | getParent () const |
Returns the pointer to parent document if exists or nullptr otherwise. | |
const std::vector< std::shared_ptr< InterfaceFile > > & | documents () const |
Get the list of inlined libraries. | |
void | addRPath (StringRef RPath, const Target &InputTarget) |
Set the runpath search paths. | |
const std::vector< std::pair< Target, std::string > > & | rpaths () const |
Get the list of runpath search paths. | |
std::optional< const Symbol * > | getSymbol (EncodeKind Kind, StringRef Name, ObjCIFSymbolKind ObjCIF=ObjCIFSymbolKind::None) const |
Get symbol if exists in file. | |
template<typename RangeT , typename ElT = std::remove_reference_t< decltype(*std::begin(std::declval<RangeT>()))>> | |
void | addSymbol (EncodeKind Kind, StringRef Name, RangeT &&Targets, SymbolFlags Flags=SymbolFlags::None) |
Add a symbol to the symbols list or extend an existing one. | |
void | addSymbol (EncodeKind Kind, StringRef Name, TargetList &&Targets, SymbolFlags Flags=SymbolFlags::None) |
Add Symbol with multiple targets. | |
void | addSymbol (EncodeKind Kind, StringRef Name, Target &Target, SymbolFlags Flags=SymbolFlags::None) |
Add Symbol with single target. | |
size_t | symbolsCount () const |
Get size of symbol set. | |
const_symbol_range | symbols () const |
const_filtered_symbol_range | exports () const |
const_filtered_symbol_range | reexports () const |
const_filtered_symbol_range | undefineds () const |
llvm::Expected< std::unique_ptr< InterfaceFile > > | extract (Architecture Arch) const |
Extract architecture slice from Interface. | |
llvm::Expected< std::unique_ptr< InterfaceFile > > | remove (Architecture Arch) const |
Remove architecture slice from Interface. | |
llvm::Expected< std::unique_ptr< InterfaceFile > > | merge (const InterfaceFile *O) const |
Merge Interfaces for the same library. | |
void | inlineLibrary (std::shared_ptr< InterfaceFile > Library, bool Overwrite=false) |
Inline reexported library into Interface. | |
void | setFromBinaryAttrs (const RecordsSlice::BinaryAttrs &BA, const Target &Targ) |
Set InterfaceFile properties from pre-gathered binary attributes, if they are not set already. | |
bool | operator== (const InterfaceFile &O) const |
The equality is determined by attributes that impact linking compatibilities. | |
bool | operator!= (const InterfaceFile &O) const |
Defines the interface file.
Definition at line 105 of file InterfaceFile.h.
using llvm::MachO::InterfaceFile::const_filtered_symbol_range = SymbolSet::const_filtered_symbol_range |
Definition at line 361 of file InterfaceFile.h.
using llvm::MachO::InterfaceFile::const_filtered_target_iterator = llvm::filter_iterator<const_target_iterator, std::function<bool(const Target &)> > |
Definition at line 172 of file InterfaceFile.h.
using llvm::MachO::InterfaceFile::const_filtered_target_range = llvm::iterator_range<const_filtered_target_iterator> |
Definition at line 175 of file InterfaceFile.h.
Definition at line 360 of file InterfaceFile.h.
Definition at line 168 of file InterfaceFile.h.
Definition at line 169 of file InterfaceFile.h.
|
inline |
Definition at line 107 of file InterfaceFile.h.
|
inline |
Definition at line 110 of file InterfaceFile.h.
Add an allowable client.
Mach-O Dynamic libraries have the concept of allowable clients that are checked during static link time. The name of the application or library that is being generated needs to match one of the allowable clients or the linker refuses to link this library.
InstallName | The name of the client that is allowed to link this library. |
Target | The target triple for which this applies. |
Definition at line 26 of file InterfaceFile.cpp.
References llvm::MachO::addEntry(), and llvm::StringRef::empty().
Referenced by setFromBinaryAttrs().
void InterfaceFile::addDocument | ( | std::shared_ptr< InterfaceFile > && | Document | ) |
Add a library for inlining to top level library.
Document | The library to inline with top level library. |
Definition at line 84 of file InterfaceFile.cpp.
References assert(), LHS, llvm::lower_bound(), and RHS.
Set the parent umbrella frameworks.
Target_ | The target applicable to Parent |
Parent | The name of Parent |
Definition at line 42 of file InterfaceFile.cpp.
References llvm::StringRef::empty(), LHS, llvm::lower_bound(), and RHS.
Referenced by setFromBinaryAttrs().
Add a re-exported library.
InstallName | The name of the library to re-export. |
Target | The target triple for which this applies. |
Definition at line 34 of file InterfaceFile.cpp.
References llvm::MachO::addEntry(), llvm::StringRef::empty(), and llvm::Lib.
Referenced by setFromBinaryAttrs().
Set the runpath search paths.
RPath | The name of runpath. |
InputTarget | The target applicable to runpath search path. |
Definition at line 57 of file InterfaceFile.cpp.
References llvm::StringRef::empty(), LHS, llvm::lower_bound(), and RHS.
|
inline |
Add a symbol to the symbols list or extend an existing one.
Definition at line 329 of file InterfaceFile.h.
References Name.
|
inline |
Add Symbol with single target.
Kind | The kind of global symbol to record. |
Name | The name of the symbol. |
Target | The target the symbol is defined in. |
Flags | The properties the symbol holds. |
Definition at line 351 of file InterfaceFile.h.
References Name.
|
inline |
Add Symbol with multiple targets.
Kind | The kind of global symbol to record. |
Name | The name of the symbol. |
Targets | The list of targets the symbol is defined in. |
Flags | The properties the symbol holds. |
Definition at line 340 of file InterfaceFile.h.
References Name.
Set and add target.
Target | the target to add into. |
Definition at line 72 of file InterfaceFile.cpp.
References llvm::MachO::addEntry().
Referenced by addTargets().
|
inline |
Set and add targets.
Add the subset of llvm::triples that is supported by Tapi
Targets | the collection of targets. |
Definition at line 163 of file InterfaceFile.h.
References addTarget().
|
inline |
Get the list of allowable clients.
Definition at line 269 of file InterfaceFile.h.
|
inline |
Get the list of inlined libraries.
Definition at line 297 of file InterfaceFile.h.
|
inline |
Definition at line 364 of file InterfaceFile.h.
Expected< std::unique_ptr< InterfaceFile > > InterfaceFile::extract | ( | Architecture | Arch | ) | const |
Extract architecture slice from Interface.
Arch | architecture to extract from. |
Definition at line 302 of file InterfaceFile.cpp.
References allowableClients(), llvm::MachO::Target::Arch, llvm::MachO::getArchitectureName(), getArchitectures(), getCompatibilityVersion(), getCurrentVersion(), getFileType(), llvm::MachO::Symbol::getFlags(), getInstallName(), llvm::MachO::Symbol::getKind(), llvm::MachO::Symbol::getName(), getPath(), getSwiftABIVersion(), llvm::MachO::Symbol::hasArchitecture(), llvm::inconvertibleErrorCode(), InterfaceFile(), isApplicationExtensionSafe(), isTwoLevelNamespace(), llvm::Lib, reexportedLibraries(), rpaths(), Sym, symbols(), targets(), llvm::MachO::Symbol::targets(), and umbrellas().
|
inline |
Get the architectures.
Definition at line 137 of file InterfaceFile.h.
References llvm::MachO::mapToArchitectureSet().
|
inline |
Get the compatibility version of the library.
Definition at line 199 of file InterfaceFile.h.
Referenced by extract(), merge(), remove(), and setFromBinaryAttrs().
|
inline |
Get the current version of the library.
Definition at line 191 of file InterfaceFile.h.
Referenced by extract(), merge(), remove(), and setFromBinaryAttrs().
|
inline |
Get the file type.
Definition at line 132 of file InterfaceFile.h.
Referenced by extract(), merge(), remove(), and setFromBinaryAttrs().
|
inline |
Get the install name of the library.
Definition at line 185 of file InterfaceFile.h.
Referenced by extract(), merge(), remove(), and setFromBinaryAttrs().
|
inline |
Get the Objective-C constraint.
Definition at line 239 of file InterfaceFile.h.
|
inline |
Returns the pointer to parent document if exists or nullptr otherwise.
Definition at line 292 of file InterfaceFile.h.
|
inline |
Get the path from which this file was generated (if applicable).
Definition at line 119 of file InterfaceFile.h.
Referenced by extract(), merge(), remove(), and setFromBinaryAttrs().
|
inline |
Get the platforms.
Definition at line 144 of file InterfaceFile.h.
References llvm::MachO::mapToPlatformSet().
|
inline |
Get the Swift ABI version of the library.
Definition at line 205 of file InterfaceFile.h.
Referenced by extract(), merge(), remove(), and setFromBinaryAttrs().
|
inline |
Get symbol if exists in file.
Kind | The kind of global symbol to record. |
Name | The name of the symbol. |
ObjCIF | The ObjCInterface symbol type, if applicable. |
Definition at line 319 of file InterfaceFile.h.
|
inline |
Check if the library has simulator support.
Definition at line 228 of file InterfaceFile.h.
Determine if target triple slice exists in file.
Targ | the value to find. |
Definition at line 154 of file InterfaceFile.h.
References llvm::is_contained().
void InterfaceFile::inlineLibrary | ( | std::shared_ptr< InterfaceFile > | Library, |
bool | Overwrite = false |
||
) |
Inline reexported library into Interface.
Library | Interface of reexported library. |
Overwrite | Whether to overwrite preexisting inlined library. |
Definition at line 97 of file InterfaceFile.cpp.
References llvm::lower_bound().
|
inline |
Check if the library is application extension safe.
Definition at line 225 of file InterfaceFile.h.
Referenced by extract(), merge(), remove(), and setFromBinaryAttrs().
|
inline |
Check if the library is an OS library that is not shared cache eligible.
Definition at line 219 of file InterfaceFile.h.
Referenced by setFromBinaryAttrs().
|
inline |
Check if the library uses two-level namespace.
Definition at line 211 of file InterfaceFile.h.
Referenced by extract(), merge(), remove(), and setFromBinaryAttrs().
Expected< std::unique_ptr< InterfaceFile > > InterfaceFile::merge | ( | const InterfaceFile * | O | ) | const |
Merge Interfaces for the same library.
The following library attributes must match.
O | The Interface to merge. |
Definition at line 127 of file InterfaceFile.cpp.
References allowableClients(), getCompatibilityVersion(), getCurrentVersion(), getFileType(), llvm::MachO::Symbol::getFlags(), getInstallName(), llvm::MachO::Symbol::getKind(), llvm::MachO::Symbol::getName(), getPath(), getSwiftABIVersion(), llvm::inconvertibleErrorCode(), InterfaceFile(), isApplicationExtensionSafe(), isTwoLevelNamespace(), llvm::Lib, reexportedLibraries(), rpaths(), Sym, symbols(), targets(), llvm::MachO::Symbol::targets(), and umbrellas().
|
inline |
Definition at line 417 of file InterfaceFile.h.
bool InterfaceFile::operator== | ( | const InterfaceFile & | O | ) | const |
The equality is determined by attributes that impact linking compatibilities.
Path, & FileKind are irrelevant since these by itself should not impact linking. This is an expensive operation.
Definition at line 390 of file InterfaceFile.cpp.
References isYAMLTextStub(), LHS, llvm::MachO::mapToPlatformVersionSet(), and RHS.
|
inline |
Get the list of re-exported libraries.
Definition at line 282 of file InterfaceFile.h.
|
inline |
Definition at line 365 of file InterfaceFile.h.
Expected< std::unique_ptr< InterfaceFile > > InterfaceFile::remove | ( | Architecture | Arch | ) | const |
Remove architecture slice from Interface.
Arch | architecture to remove. |
Definition at line 222 of file InterfaceFile.cpp.
References llvm::MachO::ArchitectureSet::All(), allowableClients(), llvm::MachO::Target::Arch, llvm::MachO::ArchitectureSet::clear(), clear(), llvm::MachO::getArchitectureName(), getArchitectures(), llvm::MachO::Symbol::getArchitectures(), getCompatibilityVersion(), getCurrentVersion(), getFileType(), llvm::MachO::Symbol::getFlags(), getInstallName(), llvm::MachO::Symbol::getKind(), llvm::MachO::Symbol::getName(), getPath(), getSwiftABIVersion(), llvm::inconvertibleErrorCode(), InterfaceFile(), isApplicationExtensionSafe(), isTwoLevelNamespace(), llvm::Lib, llvm::MachO::NoSuchArchitecture, reexportedLibraries(), Sym, symbols(), targets(), llvm::MachO::Symbol::targets(), and umbrellas().
|
inline |
Get the list of runpath search paths.
Definition at line 309 of file InterfaceFile.h.
Specify if the library is application extension safe (or not).
Definition at line 222 of file InterfaceFile.h.
Referenced by setFromBinaryAttrs().
|
inline |
Set the compatibility version of the library.
Definition at line 194 of file InterfaceFile.h.
References llvm::Version.
Referenced by setFromBinaryAttrs().
|
inline |
Set the current version of the library.
Definition at line 188 of file InterfaceFile.h.
References llvm::Version.
Referenced by setFromBinaryAttrs().
|
inline |
Set the file type.
This is used by the YAML writer to identify the specification it should use for writing the file.
Kind | The file type. |
Definition at line 127 of file InterfaceFile.h.
Referenced by setFromBinaryAttrs().
void InterfaceFile::setFromBinaryAttrs | ( | const RecordsSlice::BinaryAttrs & | BA, |
const Target & | Targ | ||
) |
Set InterfaceFile properties from pre-gathered binary attributes, if they are not set already.
BA | Attributes typically represented in load commands. |
Targ | MachO Target slice to add attributes to. |
Definition at line 358 of file InterfaceFile.cpp.
References addAllowableClient(), addParentUmbrella(), addReexportedLibrary(), llvm::MachO::RecordsSlice::BinaryAttrs::AllowableClients, llvm::MachO::RecordsSlice::BinaryAttrs::AppExtensionSafe, llvm::MachO::RecordsSlice::BinaryAttrs::CompatVersion, llvm::MachO::RecordsSlice::BinaryAttrs::CurrentVersion, llvm::StringRef::empty(), llvm::MachO::RecordsSlice::BinaryAttrs::File, getCompatibilityVersion(), getCurrentVersion(), getFileType(), getInstallName(), getPath(), getSwiftABIVersion(), llvm::MachO::RecordsSlice::BinaryAttrs::InstallName, isApplicationExtensionSafe(), isOSLibNotForSharedCache(), isTwoLevelNamespace(), llvm::Lib, llvm::MachO::RecordsSlice::BinaryAttrs::OSLibNotForSharedCache, llvm::MachO::RecordsSlice::BinaryAttrs::ParentUmbrella, llvm::MachO::RecordsSlice::BinaryAttrs::Path, llvm::MachO::RecordsSlice::BinaryAttrs::RexportedLibraries, setApplicationExtensionSafe(), setCompatibilityVersion(), setCurrentVersion(), setFileType(), setInstallName(), setOSLibNotForSharedCache(), setPath(), setSwiftABIVersion(), setTwoLevelNamespace(), llvm::MachO::RecordsSlice::BinaryAttrs::SwiftABI, and llvm::MachO::RecordsSlice::BinaryAttrs::TwoLevelNamespace.
|
inline |
Set the install name of the library.
Definition at line 180 of file InterfaceFile.h.
Referenced by setFromBinaryAttrs().
|
inline |
Set the Objective-C constraint.
Definition at line 234 of file InterfaceFile.h.
Specify if the library is an OS library but not shared cache eligible.
Definition at line 214 of file InterfaceFile.h.
Referenced by setFromBinaryAttrs().
|
inline |
Set the path from which this file was generated (if applicable).
Path_ | The path to the source file. |
Definition at line 114 of file InterfaceFile.h.
Referenced by setFromBinaryAttrs().
Specify if the library has simulator support.
Definition at line 231 of file InterfaceFile.h.
|
inline |
Set the Swift ABI version of the library.
Definition at line 202 of file InterfaceFile.h.
References llvm::Version.
Referenced by setFromBinaryAttrs().
Specify if the library uses two-level namespace (or flat namespace).
Definition at line 208 of file InterfaceFile.h.
Referenced by setFromBinaryAttrs().
|
inline |
Definition at line 363 of file InterfaceFile.h.
|
inline |
Get size of symbol set.
Definition at line 358 of file InterfaceFile.h.
|
inline |
Definition at line 170 of file InterfaceFile.h.
InterfaceFile::const_filtered_target_range InterfaceFile::targets | ( | ArchitectureSet | Archs | ) | const |
Definition at line 77 of file InterfaceFile.cpp.
References llvm::MachO::ArchitectureSet::has(), and llvm::make_filter_range().
|
inline |
Get the list of Parent Umbrella frameworks.
Definition at line 250 of file InterfaceFile.h.
|
inline |
Definition at line 368 of file InterfaceFile.h.