LLVM 22.0.0git
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
llvm::object::Archive Class Reference

#include "llvm/Object/Archive.h"

Inheritance diagram for llvm::object::Archive:
[legend]

Classes

class  Child
class  ChildFallibleIterator
class  Symbol
class  symbol_iterator

Public Types

enum  Kind {
  K_GNU , K_GNU64 , K_BSD , K_DARWIN ,
  K_DARWIN64 , K_COFF , K_AIXBIG
}
using child_iterator = fallible_iterator<ChildFallibleIterator>

Public Member Functions

 Archive (MemoryBufferRef Source, Error &Err)
 Archive (Archive const &)=delete
Archive & operator= (Archive const &)=delete
Kind kind () const
bool isThin () const
child_iterator child_begin (Error &Err, bool SkipInternal=true) const
child_iterator child_end () const
iterator_range< child_iterator > children (Error &Err, bool SkipInternal=true) const
symbol_iterator symbol_begin () const
symbol_iterator symbol_end () const
iterator_range< symbol_iterator > symbols () const
Expected< iterator_range< symbol_iterator > > ec_symbols () const
Expected< std::optional< Child > > findSym (StringRef name) const
virtual bool isEmpty () const
bool hasSymbolTable () const
StringRef getSymbolTable () const
StringRef getStringTable () const
uint32_t getNumberOfSymbols () const
uint32_t getNumberOfECSymbols () const
virtual uint64_t getFirstChildOffset () const
std::vector< std::unique_ptr< MemoryBuffer > > takeThinBuffers ()
std::unique_ptr< AbstractArchiveMemberHeader > createArchiveMemberHeader (const char *RawHeaderPtr, uint64_t Size, Error *Err) const
Public Member Functions inherited from llvm::object::Binary
 Binary ()=delete
 Binary (const Binary &other)=delete
virtual ~Binary ()
virtual Error initContent ()
StringRef getData () const
StringRef getFileName () const
MemoryBufferRef getMemoryBufferRef () const
unsigned int getType () const
bool isObject () const
bool isSymbolic () const
bool isArchive () const
bool isMachOUniversalBinary () const
bool isTapiUniversal () const
bool isELF () const
bool isMachO () const
bool isCOFF () const
bool isXCOFF () const
bool isWasm () const
bool isOffloadFile () const
bool isCOFFImportFile () const
bool isIR () const
bool isGOFF () const
bool isMinidump () const
bool isTapiFile () const
bool isLittleEndian () const
bool isWinRes () const
bool isDXContainer () const
Triple::ObjectFormatType getTripleObjectFormat () const

Static Public Member Functions

static Expected< std::unique_ptr< Archive > > create (MemoryBufferRef Source)
static object::Archive::Kind getDefaultKind ()
static object::Archive::Kind getDefaultKindForTriple (const Triple &T)
static bool classof (Binary const *v)
Static Public Member Functions inherited from llvm::object::Binary
static Error checkOffset (MemoryBufferRef M, uintptr_t Addr, const uint64_t Size)

Static Public Attributes

static const uint64_t MaxMemberSize = 9999999999
 Size field is 10 decimal digits long.

Protected Member Functions

uint64_t getArchiveMagicLen () const
void setFirstRegular (const Child &C)
Protected Member Functions inherited from llvm::object::Binary
 Binary (unsigned int Type, MemoryBufferRef Source)

Protected Attributes

StringRef SymbolTable
StringRef ECSymbolTable
StringRef StringTable
Protected Attributes inherited from llvm::object::Binary
MemoryBufferRef Data

Additional Inherited Members

Protected Types inherited from llvm::object::Binary
enum  {
  ID_Archive , ID_MachOUniversalBinary , ID_COFFImportFile , ID_IR ,
  ID_TapiUniversal , ID_TapiFile , ID_Minidump , ID_WinRes ,
  ID_Offload , ID_StartObjects , ID_COFF , ID_XCOFF32 ,
  ID_XCOFF64 , ID_ELF32L , ID_ELF32B , ID_ELF64L ,
  ID_ELF64B , ID_MachO32L , ID_MachO32B , ID_MachO64L ,
  ID_MachO64B , ID_GOFF , ID_Wasm , ID_DXContainer ,
  ID_EndObjects
}
Static Protected Member Functions inherited from llvm::object::Binary
static unsigned int getELFType (bool isLE, bool is64Bits)
static unsigned int getMachOType (bool isLE, bool is64Bits)

Detailed Description

Definition at line 159 of file Archive.h.

Member Typedef Documentation

◆ child_iterator

using llvm::object::Archive::child_iterator = fallible_iterator<ChildFallibleIterator>

Definition at line 290 of file Archive.h.

Member Enumeration Documentation

◆ Kind

enum llvm::object::Archive::Kind
Enumerator
K_GNU 
K_GNU64 
K_BSD 
K_DARWIN 
K_DARWIN64 
K_COFF 
K_AIXBIG 

Definition at line 344 of file Archive.h.

Constructor & Destructor Documentation

◆ Archive() [1/2]

Archive::Archive ( MemoryBufferRef Source,
Error & Err )

Definition at line 706 of file Archive.cpp.

References llvm::object::ArchiveMagic, llvm::object::BigArchiveMagic, llvm::object::Binary::Binary(), llvm::CallingConv::C, child_begin(), child_end(), llvm::object::Binary::Data, ECSymbolTable, llvm::errorCodeToError(), llvm::Expected< T >::get(), I, llvm::object::Binary::ID_Archive, llvm::object::invalid_file_type, K_AIXBIG, K_BSD, K_COFF, K_DARWIN64, K_GNU, K_GNU64, llvm::make_error(), llvm::object::parse_failed, setFirstRegular(), llvm::StringRef::starts_with(), StringTable, llvm::Error::success(), SymbolTable, llvm::Expected< T >::takeError(), and llvm::object::ThinArchiveMagic.

Referenced by Archive(), llvm::object::BigArchive::BigArchive(), operator=(), and llvm::object::Archive::Symbol::Symbol().

◆ Archive() [2/2]

llvm::object::Archive::Archive ( Archive const & )
delete

References Archive().

Member Function Documentation

◆ child_begin()

Archive::child_iterator Archive::child_begin ( Error & Err,
bool SkipInternal = true ) const

Definition at line 984 of file Archive.cpp.

References llvm::CallingConv::C, child_end(), llvm::object::Binary::Data, getFirstChildOffset(), isEmpty(), and llvm::fallible_iterator< ChildFallibleIterator >::itr().

Referenced by Archive(), llvm::object::BigArchive::BigArchive(), and children().

◆ child_end()

Archive::child_iterator Archive::child_end ( ) const

Definition at line 1000 of file Archive.cpp.

References llvm::fallible_iterator< ChildFallibleIterator >::end().

Referenced by Archive(), llvm::object::BigArchive::BigArchive(), child_begin(), and children().

◆ children()

iterator_range< child_iterator > llvm::object::Archive::children ( Error & Err,
bool SkipInternal = true ) const
inline

Definition at line 353 of file Archive.h.

References child_begin(), child_end(), and llvm::make_range().

Referenced by appendFile(), llvm::objcopy::createNewArchiveMembers(), and doList().

◆ classof()

bool llvm::object::Archive::classof ( Binary const * v)
inlinestatic

Definition at line 366 of file Archive.h.

References llvm::object::Binary::Binary().

◆ create()

Expected< std::unique_ptr< Archive > > Archive::create ( MemoryBufferRef Source)
static

Definition at line 666 of file Archive.cpp.

References llvm::object::BigArchiveMagic, llvm::StringRef::starts_with(), and llvm::Error::success().

Referenced by llvm::orc::COFFPlatform::Create(), llvm::orc::StaticLibraryDefinitionGenerator::Create(), llvm::object::createBinary(), llvm::object::extractOffloadBinaries(), and llvm::object::MachOUniversalBinary::ObjectForArch::getAsArchive().

◆ createArchiveMemberHeader()

std::unique_ptr< AbstractArchiveMemberHeader > Archive::createArchiveMemberHeader ( const char * RawHeaderPtr,
uint64_t Size,
Error * Err ) const

Definition at line 682 of file Archive.cpp.

References K_AIXBIG, kind(), and Size.

◆ ec_symbols()

Expected< iterator_range< Archive::symbol_iterator > > Archive::ec_symbols ( ) const

Definition at line 1192 of file Archive.cpp.

References llvm::Count, ECSymbolTable, getNumberOfSymbols(), llvm::make_range(), malformedError(), llvm::StringRef::npos, llvm::support::endian::read16le(), llvm::support::endian::read32le(), and SymbolTable.

◆ findSym()

Expected< std::optional< Archive::Child > > Archive::findSym ( StringRef name) const

Definition at line 1261 of file Archive.cpp.

References llvm::object::Archive::Symbol::getMember(), llvm::object::Archive::Symbol::getName(), name, symbol_begin(), and symbol_end().

◆ getArchiveMagicLen()

uint64_t Archive::getArchiveMagicLen ( ) const
protected

Definition at line 691 of file Archive.cpp.

References llvm::object::ArchiveMagic, llvm::object::BigArchiveMagic, isThin(), K_AIXBIG, and llvm::object::ThinArchiveMagic.

Referenced by getFirstChildOffset(), and isEmpty().

◆ getDefaultKind()

object::Archive::Kind Archive::getDefaultKind ( )
static

Definition at line 979 of file Archive.cpp.

References getDefaultKindForTriple(), and llvm::sys::getDefaultTargetTriple().

Referenced by llvm::NewArchiveMember::detectKindFromObject().

◆ getDefaultKindForTriple()

object::Archive::Kind Archive::getDefaultKindForTriple ( const Triple & T)
static

Definition at line 969 of file Archive.cpp.

References K_AIXBIG, K_COFF, K_DARWIN, K_GNU, and T.

Referenced by llvm::NewArchiveMember::detectKindFromObject(), and getDefaultKind().

◆ getFirstChildOffset()

virtual uint64_t llvm::object::Archive::getFirstChildOffset ( ) const
inlinevirtual

Reimplemented in llvm::object::BigArchive.

Definition at line 377 of file Archive.h.

References getArchiveMagicLen().

Referenced by child_begin().

◆ getNumberOfECSymbols()

uint32_t Archive::getNumberOfECSymbols ( ) const

Definition at line 1255 of file Archive.cpp.

References ECSymbolTable, and llvm::support::endian::read32le().

◆ getNumberOfSymbols()

uint32_t Archive::getNumberOfSymbols ( ) const

Definition at line 1237 of file Archive.cpp.

References llvm::StringRef::begin(), getSymbolTable(), hasSymbolTable(), K_AIXBIG, K_BSD, K_DARWIN64, K_GNU, K_GNU64, kind(), llvm::support::endian::read32be(), llvm::support::endian::read32le(), llvm::support::endian::read64be(), and llvm::support::endian::read64le().

Referenced by ec_symbols(), and symbol_end().

◆ getStringTable()

StringRef llvm::object::Archive::getStringTable ( ) const
inline

Definition at line 374 of file Archive.h.

References StringTable.

Referenced by symbol_begin().

◆ getSymbolTable()

StringRef llvm::object::Archive::getSymbolTable ( ) const
inline

Definition at line 373 of file Archive.h.

References SymbolTable.

Referenced by getNumberOfSymbols(), and symbol_begin().

◆ hasSymbolTable()

bool Archive::hasSymbolTable ( ) const

Definition at line 1282 of file Archive.cpp.

References SymbolTable.

Referenced by llvm::objcopy::executeObjcopyOnArchive(), getNumberOfSymbols(), and symbol_begin().

◆ isEmpty()

bool Archive::isEmpty ( ) const
virtual

Reimplemented in llvm::object::BigArchive.

Definition at line 1278 of file Archive.cpp.

References llvm::object::Binary::Data, and getArchiveMagicLen().

Referenced by child_begin().

◆ isThin()

bool llvm::object::Archive::isThin ( ) const
inline

Definition at line 347 of file Archive.h.

Referenced by llvm::object::Archive::Child::Child(), llvm::objcopy::executeObjcopyOnArchive(), getArchiveMagicLen(), llvm::object::Archive::Child::getBuffer(), and llvm::object::Archive::Child::getFullName().

◆ kind()

Kind llvm::object::Archive::kind ( ) const
inline

Definition at line 346 of file Archive.h.

Referenced by createArchiveMemberHeader(), llvm::objcopy::executeObjcopyOnArchive(), getNumberOfSymbols(), and symbol_begin().

◆ operator=()

Archive & llvm::object::Archive::operator= ( Archive const & )
delete

References Archive().

◆ setFirstRegular()

void Archive::setFirstRegular ( const Child & C)
protected

Definition at line 701 of file Archive.cpp.

References llvm::CallingConv::C.

Referenced by Archive(), and llvm::object::BigArchive::BigArchive().

◆ symbol_begin()

Archive::symbol_iterator Archive::symbol_begin ( ) const

Definition at line 1130 of file Archive.cpp.

References llvm::StringRef::begin(), getStringTable(), getSymbolTable(), hasSymbolTable(), K_AIXBIG, K_BSD, K_DARWIN64, K_GNU, K_GNU64, kind(), llvm::support::endian::read32be(), llvm::support::endian::read32le(), llvm::support::endian::read64be(), and llvm::support::endian::read64le().

Referenced by findSym(), and symbols().

◆ symbol_end()

Archive::symbol_iterator Archive::symbol_end ( ) const

Definition at line 1188 of file Archive.cpp.

References getNumberOfSymbols().

Referenced by findSym(), and symbols().

◆ symbols()

iterator_range< symbol_iterator > llvm::object::Archive::symbols ( ) const
inline

Definition at line 360 of file Archive.h.

References llvm::make_range(), symbol_begin(), and symbol_end().

◆ takeThinBuffers()

std::vector< std::unique_ptr< MemoryBuffer > > llvm::object::Archive::takeThinBuffers ( )
inline

Definition at line 379 of file Archive.h.

Member Data Documentation

◆ ECSymbolTable

StringRef llvm::object::Archive::ECSymbolTable
protected

Definition at line 392 of file Archive.h.

Referenced by Archive(), ec_symbols(), and getNumberOfECSymbols().

◆ MaxMemberSize

const uint64_t llvm::object::Archive::MaxMemberSize = 9999999999
static

Size field is 10 decimal digits long.

Definition at line 342 of file Archive.h.

Referenced by computeMemberData().

◆ StringTable

StringRef llvm::object::Archive::StringTable
protected

Definition at line 393 of file Archive.h.

Referenced by Archive(), llvm::object::BigArchive::BigArchive(), and getStringTable().

◆ SymbolTable

StringRef llvm::object::Archive::SymbolTable
protected

Definition at line 391 of file Archive.h.

Referenced by appendGlobalSymbolTableInfo(), Archive(), llvm::object::BigArchive::BigArchive(), ec_symbols(), getSymbolTable(), and hasSymbolTable().

The documentation for this class was generated from the following files:
Generated on for LLVM by doxygen 1.14.0