LLVM API Documentation

Public Types | Public Member Functions | Friends
llvm::object::SymbolRef Class Reference

#include <ObjectFile.h>

List of all members.

Public Types

enum  Type {
  ST_Unknown, ST_Data, ST_Debug, ST_File,
  ST_Function, ST_Other
}
enum  Flags {
  SF_None = 0, SF_Undefined = 1U << 0, SF_Global = 1U << 1, SF_Weak = 1U << 2,
  SF_Absolute = 1U << 3, SF_ThreadLocal = 1U << 4, SF_Common = 1U << 5, SF_FormatSpecific = 1U << 31
}

Public Member Functions

 SymbolRef ()
 SymbolRef (DataRefImpl SymbolP, const ObjectFile *Owner)
bool operator== (const SymbolRef &Other) const
bool operator< (const SymbolRef &Other) const
error_code getNext (SymbolRef &Result) const
error_code getName (StringRef &Result) const
error_code getAddress (uint64_t &Result) const
error_code getFileOffset (uint64_t &Result) const
error_code getAlignment (uint32_t &Result) const
 Get the alignment of this symbol as the actual value (not log 2).
error_code getSize (uint64_t &Result) const
error_code getType (SymbolRef::Type &Result) const
error_code getNMTypeChar (char &Result) const
error_code getFlags (uint32_t &Result) const
 Get symbol flags (bitwise OR of SymbolRef::Flags)
error_code getSection (section_iterator &Result) const
 Get section this symbol is defined in reference to. Result is end_sections() if it is undefined or is an absolute symbol.
error_code getValue (uint64_t &Val) const
 Get value of the symbol in the symbol table.
DataRefImpl getRawDataRefImpl () const

Friends

class SectionRef

Detailed Description

SymbolRef - This is a value type class that represents a single symbol in the list of symbols in the object file.

Definition at line 179 of file ObjectFile.h.


Member Enumeration Documentation

Enumerator:
SF_None 
SF_Undefined 
SF_Global 
SF_Weak 
SF_Absolute 
SF_ThreadLocal 
SF_Common 
SF_FormatSpecific 

Definition at line 196 of file ObjectFile.h.

Enumerator:
ST_Unknown 
ST_Data 
ST_Debug 
ST_File 
ST_Function 
ST_Other 

Definition at line 187 of file ObjectFile.h.


Constructor & Destructor Documentation

llvm::object::SymbolRef::SymbolRef ( ) [inline]

Definition at line 185 of file ObjectFile.h.

llvm::object::SymbolRef::SymbolRef ( DataRefImpl  SymbolP,
const ObjectFile Owner 
) [inline]

Definition at line 401 of file ObjectFile.h.


Member Function Documentation

error_code llvm::object::SymbolRef::getAddress ( uint64_t &  Result) const [inline]

Returns the symbol virtual address (i.e. address at which it will be mapped).

Definition at line 421 of file ObjectFile.h.

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

Referenced by llvm::DWARFContextInMemory::DWARFContextInMemory().

error_code llvm::object::SymbolRef::getAlignment ( uint32_t &  Result) const [inline]

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

Definition at line 429 of file ObjectFile.h.

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

error_code llvm::object::SymbolRef::getFileOffset ( uint64_t &  Result) const [inline]

Definition at line 425 of file ObjectFile.h.

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

error_code llvm::object::SymbolRef::getFlags ( uint32_t &  Result) const [inline]

Get symbol flags (bitwise OR of SymbolRef::Flags)

Definition at line 441 of file ObjectFile.h.

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

error_code llvm::object::SymbolRef::getName ( StringRef Result) const [inline]
error_code llvm::object::SymbolRef::getNext ( SymbolRef Result) const [inline]

Definition at line 413 of file ObjectFile.h.

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

error_code llvm::object::SymbolRef::getNMTypeChar ( char &  Result) const [inline]

Returns the ascii char that should be displayed in a symbol table dump via nm for this symbol.

Definition at line 437 of file ObjectFile.h.

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

DataRefImpl llvm::object::SymbolRef::getRawDataRefImpl ( ) const [inline]

Definition at line 457 of file ObjectFile.h.

Referenced by llvm::object::ELFObjectFile< ELFT >::getSymbolVersion().

error_code llvm::object::SymbolRef::getSection ( section_iterator Result) const [inline]

Get section this symbol is defined in reference to. Result is end_sections() if it is undefined or is an absolute symbol.

Definition at line 445 of file ObjectFile.h.

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

Referenced by llvm::RuntimeDyldELF::processRelocationRef().

error_code llvm::object::SymbolRef::getSize ( uint64_t &  Result) const [inline]

Definition at line 433 of file ObjectFile.h.

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

error_code llvm::object::SymbolRef::getType ( SymbolRef::Type Result) const [inline]
error_code llvm::object::SymbolRef::getValue ( uint64_t &  Val) const [inline]

Get value of the symbol in the symbol table.

Definition at line 453 of file ObjectFile.h.

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

bool llvm::object::SymbolRef::operator< ( const SymbolRef Other) const [inline]

Definition at line 409 of file ObjectFile.h.

bool llvm::object::SymbolRef::operator== ( const SymbolRef Other) const [inline]

Definition at line 405 of file ObjectFile.h.


Friends And Related Function Documentation

friend class SectionRef [friend]

Definition at line 180 of file ObjectFile.h.


The documentation for this class was generated from the following file: