Class which represents an entry of the PE relocation table. More...

#include <RelocationEntry.hpp>

Inheritance diagram for LIEF::PE::RelocationEntry:

[legend]

Collaboration diagram for LIEF::PE::RelocationEntry:

[legend]

Public Types
enum class	BASE_TYPES { UNKNOWN = -1 , ABS = 0 , HIGH = 1 , LOW = 2 , HIGHLOW = 3 , HIGHADJ = 4 , MIPS_JMPADDR = 5 \| (1 << 8) , ARM_MOV32 = 5 \| (1 << 9) , RISCV_HI20 = 5 \| (1 << 10) , SECTION = 6 , THUMB_MOV32 = 7 \| (1 << 11) , RISCV_LOW12I = 7 \| (1 << 12) , RISCV_LOW12S = 8 \| (1 << 13) , LOONARCH_MARK_LA = 8 \| (1 << 14) , MIPS_JMPADDR16 = 9 , DIR64 = 10 , HIGH3ADJ = 11 }
	Relocation type as described in https://learn.microsoft.com/en-us/windows/win32/debug/pe-format#base-relocation-types. More...
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
	RelocationEntry ()=default
	RelocationEntry (const RelocationEntry &other)
RelocationEntry &	operator= (RelocationEntry other)
	RelocationEntry (RelocationEntry &&other)=default
RelocationEntry &	operator= (RelocationEntry &&other)=default
	RelocationEntry (uint16_t position, BASE_TYPES type)
	~RelocationEntry () override=default
void	swap (RelocationEntry &other)
uint64_t	address () const override
	The address of the relocation.
void	address (uint64_t address) override
size_t	size () const override
	The size of the relocatable pointer.
void	size (size_t size) override
uint16_t	data () const
	Raw data of the relocation:
uint16_t	position () const
	Offset relative to Relocation::virtual_address where the relocation occurs.
BASE_TYPES	type () const
	Type of the relocation.
void	position (uint16_t position)
void	type (BASE_TYPES type)
void	accept (Visitor &visitor) const override
	Method so that the visitor can visit us.
Public Member Functions inherited from LIEF::Relocation
	Relocation ()=default
	Relocation (uint64_t address, uint8_t size)
	Constructor from a relocation's address and size.
	~Relocation () override=default
Relocation &	operator= (const Relocation &)=default
	Relocation (const Relocation &)=default
void	swap (Relocation &other)
virtual bool	operator< (const Relocation &rhs) const
	Comparaison based on the Relocation's address.
virtual bool	operator<= (const Relocation &rhs) const
	Comparaison based on the Relocation's address.
virtual bool	operator> (const Relocation &rhs) const
	Comparaison based on the Relocation's address.
virtual bool	operator>= (const Relocation &rhs) const
	Comparaison based on the Relocation's address.
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 uint16_t	get_position (uint16_t data)
static uint16_t	get_type (uint16_t data)
static BASE_TYPES	type_from_data (Header::MACHINE_TYPES arch, uint16_t data)

Static Public Attributes
static constexpr auto	MAX_ADDR = 1 << 12

Detailed Description

Class which represents an entry of the PE relocation table.

It extends the LIEF::Relocation object to provide an uniform API across the file formats

Member Enumeration Documentation

◆ BASE_TYPES

enum class LIEF::PE::RelocationEntry::BASE_TYPES

strong

Relocation type as described in https://learn.microsoft.com/en-us/windows/win32/debug/pe-format#base-relocation-types.

Enumerator
UNKNOWN
ABS	This value matches: IMAGE_REL_BASED_ABSOLUTE The base relocation is skipped. This type can be used to pad a block.
HIGH	This value matches: IMAGE_REL_BASED_HIGH The base relocation adds the high 16 bits of the difference to the 16-bit field at offset. The 16-bit field represents the high value of a 32-bit word. Operation: write<int16_t>(ADDR, ((read<int16_t>(ADDR) << 16) + DELTA) >> 16)
LOW	The base relocation adds the low 16 bits of the difference to the 16-bit field at offset. The 16-bit field represents the low half of a 32-bit word. Operation: write<int16_t>(ADDR, ((int32_t_t)read<int16_t>(ADDR) + DELTA))
HIGHLOW	This value matches IMAGE_REL_BASED_HIGHLOW. The base relocation applies all 32 bits of the difference to the 32-bit field at offset. Operation: write<int32_t_t>(ADDR, read<int32_t_t>(ADDR) + DELTA)
HIGHADJ	This value matches IMAGE_REL_BASED_HIGHADJ. The base relocation adds the high 16 bits of the difference to the 16-bit field at offset. The 16-bit field represents the high value of a 32-bit word. The low 16 bits of the 32-bit value are stored in the 16-bit word that follows this base relocation. This means that this base relocation occupies two slots.
MIPS_JMPADDR
ARM_MOV32
RISCV_HI20
SECTION
THUMB_MOV32
RISCV_LOW12I
RISCV_LOW12S
LOONARCH_MARK_LA
MIPS_JMPADDR16
DIR64	This value matches IMAGE_REL_BASED_DIR64. The base relocation applies the difference to the 64-bit field at offset. Operation: write<int64_t_t>(ADDR, read<int64_t_t>(ADDR) + DELTA)
HIGH3ADJ

Constructor & Destructor Documentation

◆ RelocationEntry() [1/4]

LIEF::PE::RelocationEntry::RelocationEntry ( )

default

Referenced by operator<<, operator=(), operator=(), RelocationEntry(), RelocationEntry(), and swap().

◆ RelocationEntry() [2/4]

LIEF::PE::RelocationEntry::RelocationEntry ( const RelocationEntry & other )

inline

References PE::Relocation, and RelocationEntry().

◆ RelocationEntry() [3/4]

LIEF::PE::RelocationEntry::RelocationEntry ( RelocationEntry && other )

default

References RelocationEntry().

◆ RelocationEntry() [4/4]

LIEF::PE::RelocationEntry::RelocationEntry	(	uint16_t	position,
		BASE_TYPES	type )

inline

References MAX_ADDR, position(), and type().

◆ ~RelocationEntry()

LIEF::PE::RelocationEntry::~RelocationEntry ( )

overridedefault

Member Function Documentation

◆ accept()

void LIEF::PE::RelocationEntry::accept ( Visitor & visitor ) const

overridevirtual

Method so that the visitor can visit us.

Reimplemented from LIEF::Relocation.

◆ address() [1/2]

uint64_t LIEF::PE::RelocationEntry::address ( ) const

overridevirtual

The address of the relocation.

Reimplemented from LIEF::Relocation.

Referenced by address().

◆ address() [2/2]

void LIEF::PE::RelocationEntry::address ( uint64_t address )

overridevirtual

Reimplemented from LIEF::Relocation.

References address().

◆ data()

uint16_t LIEF::PE::RelocationEntry::data ( ) const

inline

Raw data of the relocation:

The high 4 bits store the relocation type
The low 12 bits store the relocation offset

Referenced by get_position(), get_type(), and type_from_data().

◆ get_position()

uint16_t LIEF::PE::RelocationEntry::get_position ( uint16_t data )

inlinestatic

References data().

◆ get_type()

uint16_t LIEF::PE::RelocationEntry::get_type ( uint16_t data )

inlinestatic

References data().

◆ operator=() [1/2]

RelocationEntry & LIEF::PE::RelocationEntry::operator= ( RelocationEntry && other )

default

References RelocationEntry().

◆ operator=() [2/2]

RelocationEntry & LIEF::PE::RelocationEntry::operator= ( RelocationEntry other )

inline

References RelocationEntry(), and swap().

◆ position() [1/2]

uint16_t LIEF::PE::RelocationEntry::position ( ) const

inline

Offset relative to Relocation::virtual_address where the relocation occurs.

Referenced by position(), and RelocationEntry().

◆ position() [2/2]

void LIEF::PE::RelocationEntry::position ( uint16_t position )

inline

References MAX_ADDR, and position().

◆ size() [1/2]

size_t LIEF::PE::RelocationEntry::size ( ) const

overridevirtual

The size of the relocatable pointer.

Reimplemented from LIEF::Relocation.

Referenced by size().

◆ size() [2/2]

void LIEF::PE::RelocationEntry::size ( size_t size )

overridevirtual

Reimplemented from LIEF::Relocation.

References size().

◆ swap()

void LIEF::PE::RelocationEntry::swap ( RelocationEntry & other )

inline

References RelocationEntry(), and LIEF::Relocation::swap().

Referenced by operator=().

◆ type() [1/2]

BASE_TYPES LIEF::PE::RelocationEntry::type ( ) const

inline

Type of the relocation.

Referenced by RelocationEntry(), and type().

◆ type() [2/2]

void LIEF::PE::RelocationEntry::type ( BASE_TYPES type )

inline

References type().

◆ type_from_data()

BASE_TYPES LIEF::PE::RelocationEntry::type_from_data	(	Header::MACHINE_TYPES	arch,
		uint16_t	data )

static

References data().

Member Data Documentation

◆ MAX_ADDR

auto LIEF::PE::RelocationEntry::MAX_ADDR = 1 << 12

staticconstexpr

Referenced by position(), and RelocationEntry().

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

RelocationEntry.hpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ BASE_TYPES

Constructor & Destructor Documentation

◆ RelocationEntry() [1/4]

◆ RelocationEntry() [2/4]

◆ RelocationEntry() [3/4]

◆ RelocationEntry() [4/4]

◆ ~RelocationEntry()

Member Function Documentation

◆ accept()

◆ address() [1/2]

◆ address() [2/2]

◆ data()

◆ get_position()

◆ get_type()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ position() [1/2]

◆ position() [2/2]

◆ size() [1/2]

◆ size() [2/2]

◆ swap()

◆ type() [1/2]

◆ type() [2/2]

◆ type_from_data()

Member Data Documentation

◆ MAX_ADDR