Class that represents a Symbol in a Mach-O file. More...

#include <Symbol.hpp>

Inheritance diagram for LIEF::MachO::Symbol:

[legend]

Collaboration diagram for LIEF::MachO::Symbol:

[legend]

Public Types
enum class	CATEGORY : uint32_t { NONE = 0 , LOCAL , EXTERNAL , UNDEFINED , INDIRECT_ABS , INDIRECT_LOCAL , INDIRECT_ABS_LOCAL }
	Category of the symbol when the symbol comes from the LC_SYMTAB command. The category is defined according to the LC_DYSYMTAB (DynamicSymbolCommand) command. More...
enum class	ORIGIN : uint32_t { UNKNOWN = 0 , DYLD_EXPORT = 1 , DYLD_BIND = 2 , SYMTAB = 3 }
enum class	TYPE : uint32_t { UNDEFINED = 0x0u , ABSOLUTE_SYM = 0x2u , SECTION = 0xeu , PREBOUND = 0xcu , INDIRECT = 0xau }
Public Types inherited from LIEF::Object
template<class T>
using	output_t = add_pointer_t<decay_t<T>>
template<class T>
using	output_const_t = add_pointer_t<add_const_t<decay_t<T>>>

Public Member Functions
	Symbol ()=default
	Symbol (const details::nlist_32 &cmd)
	Symbol (const details::nlist_64 &cmd)
	Symbol (uint8_t n_type, uint8_t n_sect, uint8_t n_desc, uint64_t value)
Symbol &	operator= (Symbol other)
	Symbol (const Symbol &other)
void	swap (Symbol &other) noexcept
	~Symbol () override=default
int	library_ordinal () const
uint8_t	raw_type () const
	Raw value of nlist_xx.n_type.
TYPE	type () const
	Type as defined by nlist_xx.n_type & N_TYPE.
uint8_t	numberof_sections () const
	It returns the number of sections in which this symbol can be found. If the symbol can't be found in any section, it returns 0 (NO_SECT).
uint16_t	description () const
	Return information about the symbol (SYMBOL_DESCRIPTIONS).
bool	has_export_info () const
	True if the symbol is associated with an ExportInfo This value is set when the symbol comes from the Dyld Export trie.
const ExportInfo *	export_info () const
	Return the ExportInfo associated with this symbol (or nullptr if not present).
ExportInfo *	export_info ()
bool	has_binding_info () const
	True if the symbol is associated with a BindingInfo This value is set when the symbol comes from the Dyld symbol bindings.
const BindingInfo *	binding_info () const
	Return the BindingInfo associated with this symbol (or nullptr if not present).
BindingInfo *	binding_info ()
std::string	demangled_name () const
	Try to demangle the symbol or return an empty string if it is not possible.
bool	is_external () const
	True if the symbol is defined as an external symbol.
const DylibCommand *	library () const
	Return the library in which the symbol is defined. It returns a null pointer if the library can't be resolved.
DylibCommand *	library ()
ORIGIN	origin () const
	Return the origin of the symbol: from LC_SYMTAB command or from the Dyld information.
CATEGORY	category () const
	Category of the symbol according to the LC_DYSYMTAB command.
void	raw_type (uint8_t type)
void	numberof_sections (uint8_t nbsections)
void	description (uint16_t desc)
void	accept (Visitor &visitor) const override
Public Member Functions inherited from LIEF::Symbol
	Symbol ()=default
	Symbol (std::string name)
	Symbol (std::string name, uint64_t value)
	Symbol (std::string name, uint64_t value, uint64_t size)
	Symbol (const Symbol &)=default
Symbol &	operator= (const Symbol &)=default
	Symbol (Symbol &&)=default
Symbol &	operator= (Symbol &&)=default
	~Symbol () override=default
void	swap (Symbol &other) noexcept
virtual const std::string &	name () const
	Return the symbol's name.
virtual std::string &	name ()
virtual void	name (std::string name)
	Set symbol name.
virtual uint64_t	value () const
virtual void	value (uint64_t value)
virtual uint64_t	size () const
	This size of the symbol (when applicable).
virtual void	size (uint64_t value)
void	accept (Visitor &visitor) const override
	Method so that the visitor can visit us.
Public Member Functions inherited from LIEF::Object
	Object ()
	Object (const Object &other)
Object &	operator= (const Object &other)
	Object (Object &&other) noexcept=default
Object &	operator= (Object &&other) noexcept=default
template<class T>
output_t< T >	as ()
template<class T>
output_const_t< T >	as () const
virtual bool	operator== (const Object &other) const
virtual bool	operator!= (const Object &other) const
virtual	~Object ()

Static Public Member Functions
static bool	is_valid_index_ordinal (int idx)
static const Symbol &	indirect_abs ()
static const Symbol &	indirect_local ()
static const Symbol &	indirect_abs_local ()

Static Public Attributes
static constexpr int	SELF_LIBRARY_ORD = 0x0
static constexpr int	MAIN_EXECUTABLE_ORD = 0xff
static constexpr int	DYNAMIC_LOOKUP_ORD = 0xfe
static constexpr uint32_t	TYPE_MASK = 0x0e
	Same as N_TYPE.

Detailed Description

Class that represents a Symbol in a Mach-O file.

A Mach-O symbol can come from:

The symbols command (LC_SYMTAB / SymbolCommand)
The Dyld Export trie
The Dyld Symbol bindings

Member Enumeration Documentation

◆ CATEGORY

enum class LIEF::MachO::Symbol::CATEGORY : uint32_t

strong

Category of the symbol when the symbol comes from the LC_SYMTAB command. The category is defined according to the LC_DYSYMTAB (DynamicSymbolCommand) command.

Enumerator
NONE
LOCAL
EXTERNAL
UNDEFINED
INDIRECT_ABS
INDIRECT_LOCAL
INDIRECT_ABS_LOCAL

◆ ORIGIN

enum class LIEF::MachO::Symbol::ORIGIN : uint32_t

strong

Enumerator
UNKNOWN
DYLD_EXPORT
DYLD_BIND
SYMTAB	The symbol comes from the binding opcodes.

◆ TYPE

enum class LIEF::MachO::Symbol::TYPE : uint32_t

strong

Enumerator
UNDEFINED	The symbol is undefined. It is referenced in a different module.
ABSOLUTE_SYM	The symbol is absolute. The linker doesn't update his value.
SECTION	The symbol is defined in the section number given in nlist_base.n_sect .
PREBOUND	The symbol is undefined and the image is using a prebound value for the symbol. Set the n_sect field to NO_SECT .
INDIRECT	The symbol is defined to be the same as another symbol. The n_value field is an index into the string table specifying the name of the other symbol. When that symbol is linked, both this and the other symbol point to the same defined type and value.

Constructor & Destructor Documentation

◆ Symbol() [1/5]

LIEF::MachO::Symbol::Symbol ( )

default

Referenced by indirect_abs(), indirect_abs_local(), indirect_local(), operator<<, operator=(), swap(), and Symbol().

◆ Symbol() [2/5]

LIEF::MachO::Symbol::Symbol ( const details::nlist_32 & cmd )

◆ Symbol() [3/5]

LIEF::MachO::Symbol::Symbol ( const details::nlist_64 & cmd )

◆ Symbol() [4/5]

LIEF::MachO::Symbol::Symbol	(	uint8_t	n_type,
		uint8_t	n_sect,
		uint8_t	n_desc,
		uint64_t	value )

inline

References SYMTAB, and LIEF::Symbol::value().

◆ Symbol() [5/5]

LIEF::MachO::Symbol::Symbol ( const Symbol & other )

References Symbol().

◆ ~Symbol()

LIEF::MachO::Symbol::~Symbol ( )

overridedefault

Member Function Documentation

◆ accept()

void LIEF::MachO::Symbol::accept ( Visitor & visitor ) const

overridevirtual

Implements LIEF::Object.

◆ binding_info() [1/2]

BindingInfo * LIEF::MachO::Symbol::binding_info ( )

inline

◆ binding_info() [2/2]

const BindingInfo * LIEF::MachO::Symbol::binding_info ( ) const

inline

Return the BindingInfo associated with this symbol (or nullptr if not present).

See also: has_binding_info

Referenced by has_binding_info().

◆ category()

CATEGORY LIEF::MachO::Symbol::category ( ) const

inline

Category of the symbol according to the LC_DYSYMTAB command.

◆ demangled_name()

std::string LIEF::MachO::Symbol::demangled_name ( ) const

Try to demangle the symbol or return an empty string if it is not possible.

◆ description() [1/2]

uint16_t LIEF::MachO::Symbol::description ( ) const

inline

Return information about the symbol (SYMBOL_DESCRIPTIONS).

Referenced by library_ordinal().

◆ description() [2/2]

void LIEF::MachO::Symbol::description ( uint16_t desc )

inline

◆ export_info() [1/2]

ExportInfo * LIEF::MachO::Symbol::export_info ( )

inline

◆ export_info() [2/2]

const ExportInfo * LIEF::MachO::Symbol::export_info ( ) const

inline

Return the ExportInfo associated with this symbol (or nullptr if not present).

See also: has_export_info

Referenced by has_export_info().

◆ has_binding_info()

bool LIEF::MachO::Symbol::has_binding_info ( ) const

inline

True if the symbol is associated with a BindingInfo This value is set when the symbol comes from the Dyld symbol bindings.

References binding_info().

◆ has_export_info()

bool LIEF::MachO::Symbol::has_export_info ( ) const

inline

True if the symbol is associated with an ExportInfo This value is set when the symbol comes from the Dyld Export trie.

References export_info().

◆ indirect_abs()

const Symbol & LIEF::MachO::Symbol::indirect_abs ( )

static

References Symbol().

◆ indirect_abs_local()

const Symbol & LIEF::MachO::Symbol::indirect_abs_local ( )

static

References Symbol().

◆ indirect_local()

const Symbol & LIEF::MachO::Symbol::indirect_local ( )

static

References Symbol().

◆ is_external()

bool LIEF::MachO::Symbol::is_external ( ) const

inline

True if the symbol is defined as an external symbol.

References type(), and UNDEFINED.

◆ is_valid_index_ordinal()

bool LIEF::MachO::Symbol::is_valid_index_ordinal ( int idx )

inlinestatic

References DYNAMIC_LOOKUP_ORD, MAIN_EXECUTABLE_ORD, and SELF_LIBRARY_ORD.

◆ library() [1/2]

DylibCommand * LIEF::MachO::Symbol::library ( )

inline

◆ library() [2/2]

const DylibCommand * LIEF::MachO::Symbol::library ( ) const

inline

Return the library in which the symbol is defined. It returns a null pointer if the library can't be resolved.

◆ library_ordinal()

int LIEF::MachO::Symbol::library_ordinal ( ) const

inline

References description().

◆ numberof_sections() [1/2]

uint8_t LIEF::MachO::Symbol::numberof_sections ( ) const

inline

It returns the number of sections in which this symbol can be found. If the symbol can't be found in any section, it returns 0 (NO_SECT).

◆ numberof_sections() [2/2]

void LIEF::MachO::Symbol::numberof_sections ( uint8_t nbsections )

inline

◆ operator=()

Symbol & LIEF::MachO::Symbol::operator= ( Symbol other )

References Symbol().

◆ origin()

ORIGIN LIEF::MachO::Symbol::origin ( ) const

inline

Return the origin of the symbol: from LC_SYMTAB command or from the Dyld information.

◆ raw_type() [1/2]

uint8_t LIEF::MachO::Symbol::raw_type ( ) const

inline

Raw value of nlist_xx.n_type.

◆ raw_type() [2/2]

void LIEF::MachO::Symbol::raw_type ( uint8_t type )

inline

References type().

◆ swap()

void LIEF::MachO::Symbol::swap ( Symbol & other )

noexcept

References Symbol().

◆ type()

TYPE LIEF::MachO::Symbol::type ( ) const

inline

Type as defined by nlist_xx.n_type & N_TYPE.

References TYPE_MASK.

Referenced by is_external(), and raw_type().

Member Data Documentation

◆ DYNAMIC_LOOKUP_ORD

int LIEF::MachO::Symbol::DYNAMIC_LOOKUP_ORD = 0xfe

staticconstexpr

Referenced by is_valid_index_ordinal().

◆ MAIN_EXECUTABLE_ORD

int LIEF::MachO::Symbol::MAIN_EXECUTABLE_ORD = 0xff

staticconstexpr

Referenced by is_valid_index_ordinal().

◆ SELF_LIBRARY_ORD

int LIEF::MachO::Symbol::SELF_LIBRARY_ORD = 0x0

staticconstexpr

Referenced by is_valid_index_ordinal().

◆ TYPE_MASK

uint32_t LIEF::MachO::Symbol::TYPE_MASK = 0x0e

staticconstexpr

Same as N_TYPE.

Referenced by type().

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

MachO/Symbol.hpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ CATEGORY

◆ ORIGIN

◆ TYPE

Constructor & Destructor Documentation

◆ Symbol() [1/5]

◆ Symbol() [2/5]

◆ Symbol() [3/5]

◆ Symbol() [4/5]

◆ Symbol() [5/5]

◆ ~Symbol()

Member Function Documentation

◆ accept()

◆ binding_info() [1/2]

◆ binding_info() [2/2]

◆ category()

◆ demangled_name()

◆ description() [1/2]

◆ description() [2/2]

◆ export_info() [1/2]

◆ export_info() [2/2]

◆ has_binding_info()

◆ has_export_info()

◆ indirect_abs()

◆ indirect_abs_local()

◆ indirect_local()

◆ is_external()

◆ is_valid_index_ordinal()

◆ library() [1/2]

◆ library() [2/2]

◆ library_ordinal()

◆ numberof_sections() [1/2]

◆ numberof_sections() [2/2]

◆ operator=()

◆ origin()

◆ raw_type() [1/2]

◆ raw_type() [2/2]

◆ swap()

◆ type()

Member Data Documentation

◆ DYNAMIC_LOOKUP_ORD

◆ MAIN_EXECUTABLE_ORD

◆ SELF_LIBRARY_ORD

◆ TYPE_MASK