LLVM  16.0.0git
Public Member Functions | Friends | List of all members
llvm::object::SectionRef Class Reference

This is a value type class that represents a single section in the list of sections in the object file. More...

#include "llvm/Object/ObjectFile.h"

Inheritance diagram for llvm::object::SectionRef:
Inheritance graph
[legend]

Public Member Functions

 SectionRef ()=default
 
 SectionRef (DataRefImpl SectionP, const ObjectFile *Owner)
 SectionRef. More...
 
bool operator== (const SectionRef &Other) const
 
bool operator!= (const SectionRef &Other) const
 
bool operator< (const SectionRef &Other) const
 
void moveNext ()
 
Expected< StringRef > getName () const
 
uint64_t getAddress () const
 
uint64_t getIndex () const
 
uint64_t getSize () const
 
Expected< StringRef > getContents () const
 
uint64_t getAlignment () const
 Get the alignment of this section as the actual value (not log 2). More...
 
bool isCompressed () const
 
bool isText () const
 Whether this section contains instructions. More...
 
bool isData () const
 Whether this section contains data, not instructions. More...
 
bool isBSS () const
 Whether this section contains BSS uninitialized data. More...
 
bool isVirtual () const
 
bool isBitcode () const
 
bool isStripped () const
 
bool isBerkeleyText () const
 Whether this section will be placed in the text segment, according to the Berkeley size format. More...
 
bool isBerkeleyData () const
 Whether this section will be placed in the data segment, according to the Berkeley size format. More...
 
bool isDebugSection () const
 Whether this section is a debug section. More...
 
bool containsSymbol (SymbolRef S) const
 
relocation_iterator relocation_begin () const
 
relocation_iterator relocation_end () const
 
iterator_range< relocation_iterator > relocations () const
 
Expected< section_iterator > getRelocatedSection () const
 Returns the related section if this section contains relocations. More...
 
DataRefImpl getRawDataRefImpl () const
 
const ObjectFile * getObject () const
 

Friends

class SymbolRef
 

Detailed Description

This is a value type class that represents a single section in the list of sections in the object file.

Definition at line 80 of file ObjectFile.h.

Constructor & Destructor Documentation

◆ SectionRef() [1/2]

llvm::object::SectionRef::SectionRef ( )
default

◆ SectionRef() [2/2]

llvm::object::SectionRef::SectionRef ( DataRefImpl  SectionP,
const ObjectFile *  Owner 
)
inline

SectionRef.

Definition at line 435 of file ObjectFile.h.

Member Function Documentation

◆ containsSymbol()

bool SectionRef::containsSymbol ( SymbolRef  S) const

Definition at line 46 of file ObjectFile.cpp.

References llvm::consumeError(), S, and llvm::Expected< T >::takeError().

◆ getAddress()

uint64_t llvm::object::SectionRef::getAddress ( ) const
inline

Definition at line 462 of file ObjectFile.h.

References llvm::object::ObjectFile::getSectionAddress().

Referenced by llvm::getOffset(), and llvm::RuntimeDyldMachO::getRelocationValueRef().

◆ getAlignment()

uint64_t llvm::object::SectionRef::getAlignment ( ) const
inline

Get the alignment of this section as the actual value (not log 2).

Definition at line 482 of file ObjectFile.h.

References llvm::object::ObjectFile::getSectionAlignment().

◆ getContents()

Expected< StringRef > llvm::object::SectionRef::getContents ( ) const
inline

Definition at line 474 of file ObjectFile.h.

References llvm::object::ObjectFile::getSectionContents(), and llvm::Expected< T >::takeError().

Referenced by llvm::object::ResourceSectionRef::load().

◆ getIndex()

uint64_t llvm::object::SectionRef::getIndex ( ) const
inline

Definition at line 466 of file ObjectFile.h.

References llvm::object::ObjectFile::getSectionIndex().

Referenced by llvm::jitlink::COFFLinkGraphBuilder::forEachRelocation().

◆ getName()

Expected< StringRef > llvm::object::SectionRef::getName ( ) const
inline

Definition at line 458 of file ObjectFile.h.

References llvm::object::ObjectFile::getSectionName().

◆ getObject()

const ObjectFile * llvm::object::SectionRef::getObject ( ) const
inline

Definition at line 542 of file ObjectFile.h.

Referenced by llvm::object::ELFSectionRef::ELFSectionRef(), llvm::object::ELFSectionRef::getObject(), and handleCompressedSection().

◆ getRawDataRefImpl()

DataRefImpl llvm::object::SectionRef::getRawDataRefImpl ( ) const
inline

Definition at line 538 of file ObjectFile.h.

Referenced by llvm::object::ELFSectionRef::getFlags(), llvm::DenseMapInfo< object::SectionRef >::getHashValue(), llvm::object::ELFSectionRef::getOffset(), llvm::object::MachOObjectFile::getSectionID(), llvm::object::COFFObjectFile::getSectionID(), llvm::object::MachOObjectFile::getSectionType(), llvm::object::ELFSectionRef::getType(), and llvm::RuntimeDyldMachO::populateIndirectSymbolPointersSection().

◆ getRelocatedSection()

Expected< section_iterator > llvm::object::SectionRef::getRelocatedSection ( ) const
inline

Returns the related section if this section contains relocations.

The returned section may or may not have applied its relocations.

Definition at line 534 of file ObjectFile.h.

References llvm::object::ObjectFile::getRelocatedSection().

◆ getSize()

uint64_t llvm::object::SectionRef::getSize ( ) const
inline

Definition at line 470 of file ObjectFile.h.

References llvm::object::ObjectFile::getSectionSize().

◆ isBerkeleyData()

bool llvm::object::SectionRef::isBerkeleyData ( ) const
inline

Whether this section will be placed in the data segment, according to the Berkeley size format.

This is true if the section is allocatable and contains data (e.g. PROGBITS), but is not text.

Definition at line 518 of file ObjectFile.h.

References llvm::object::ObjectFile::isBerkeleyData().

◆ isBerkeleyText()

bool llvm::object::SectionRef::isBerkeleyText ( ) const
inline

Whether this section will be placed in the text segment, according to the Berkeley size format.

This is true if the section is allocatable, and contains either code or readonly data.

Definition at line 514 of file ObjectFile.h.

References llvm::object::ObjectFile::isBerkeleyText().

◆ isBitcode()

bool llvm::object::SectionRef::isBitcode ( ) const
inline

Definition at line 506 of file ObjectFile.h.

References llvm::object::ObjectFile::isSectionBitcode().

◆ isBSS()

bool llvm::object::SectionRef::isBSS ( ) const
inline

Whether this section contains BSS uninitialized data.

Definition at line 498 of file ObjectFile.h.

References llvm::object::ObjectFile::isSectionBSS().

◆ isCompressed()

bool llvm::object::SectionRef::isCompressed ( ) const
inline

Definition at line 486 of file ObjectFile.h.

References llvm::object::ObjectFile::isSectionCompressed().

◆ isData()

bool llvm::object::SectionRef::isData ( ) const
inline

Whether this section contains data, not instructions.

Definition at line 494 of file ObjectFile.h.

References llvm::object::ObjectFile::isSectionData().

◆ isDebugSection()

bool llvm::object::SectionRef::isDebugSection ( ) const
inline

Whether this section is a debug section.

Definition at line 522 of file ObjectFile.h.

References llvm::object::ObjectFile::isDebugSection().

Referenced by llvm::object::ObjectFile::hasDebugInfo().

◆ isStripped()

bool llvm::object::SectionRef::isStripped ( ) const
inline

Definition at line 510 of file ObjectFile.h.

References llvm::object::ObjectFile::isSectionStripped().

◆ isText()

bool llvm::object::SectionRef::isText ( ) const
inline

Whether this section contains instructions.

Definition at line 490 of file ObjectFile.h.

References llvm::object::ObjectFile::isSectionText().

Referenced by llvm::RuntimeDyldMachO::getRelocationValueRef(), and llvm::RuntimeDyldMachO::processScatteredVANILLA().

◆ isVirtual()

bool llvm::object::SectionRef::isVirtual ( ) const
inline

Definition at line 502 of file ObjectFile.h.

References llvm::object::ObjectFile::isSectionVirtual().

◆ moveNext()

void llvm::object::SectionRef::moveNext ( )
inline

Definition at line 454 of file ObjectFile.h.

References llvm::object::ObjectFile::moveSectionNext().

◆ operator!=()

bool llvm::object::SectionRef::operator!= ( const SectionRef &  Other) const
inline

Definition at line 445 of file ObjectFile.h.

References Other.

◆ operator<()

bool llvm::object::SectionRef::operator< ( const SectionRef &  Other) const
inline

Definition at line 449 of file ObjectFile.h.

References assert(), and Other.

◆ operator==()

bool llvm::object::SectionRef::operator== ( const SectionRef &  Other) const
inline

Definition at line 440 of file ObjectFile.h.

References Other.

◆ relocation_begin()

relocation_iterator llvm::object::SectionRef::relocation_begin ( ) const
inline

Definition at line 526 of file ObjectFile.h.

References llvm::object::ObjectFile::section_rel_begin().

Referenced by relocations().

◆ relocation_end()

relocation_iterator llvm::object::SectionRef::relocation_end ( ) const
inline

Definition at line 530 of file ObjectFile.h.

References llvm::object::ObjectFile::section_rel_end().

Referenced by relocations().

◆ relocations()

iterator_range<relocation_iterator> llvm::object::SectionRef::relocations ( ) const
inline

Definition at line 132 of file ObjectFile.h.

References llvm::make_range(), relocation_begin(), and relocation_end().

Referenced by llvm::jitlink::COFFLinkGraphBuilder::forEachRelocation().

Friends And Related Function Documentation

◆ SymbolRef

friend class SymbolRef
friend

Definition at line 81 of file ObjectFile.h.

The documentation for this class was generated from the following files:
Generated on Sat Dec 3 2022 19:02:26 for LLVM by   doxygen 1.8.17