introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical > Class Template Reference

Specialization of basic_guest_ptr<_Tp, guest_ptr_t, _Physical> to handle both uint32_t and uint64_t. More...

#include <guest_size_t_ptr.hh>

Inheritance diagram for introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >:

Collaboration diagram for introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >:

Public Member Functions
uint64_t	address () const
	Basic information.
uint64_t	page_number () const
uint64_t	page_offset () const
uint64_t	page_directory () const
const Domain &	domain () const
std::string	str () const
bool	x64 () const
	operator bool () const
auto	operator* () const
size_t	length () const
std::ostream &	write_stream (std::ostream &os) const
basic_guest_ptr< _Tp, _PtrType, _Physical > &	operator++ ()
basic_guest_ptr< _Tp, _PtrType, _Physical >	operator++ (int)
template<typename I >
basic_guest_ptr< _Tp, _PtrType, _Physical > &	operator+= (I offset)
template<typename I >
basic_guest_ptr< _Tp, _PtrType, _Physical >	operator+ (I offset)
basic_guest_ptr< _Tp, _PtrType, _Physical > &	operator-- ()
basic_guest_ptr< _Tp, _PtrType, _Physical >	operator-- (int)
template<typename I >
basic_guest_ptr< _Tp, _PtrType, _Physical > &	operator-= (I offset)
template<typename I >
basic_guest_ptr< _Tp, _PtrType, _Physical >	operator- (I offset)
template<typename PtrType >
bool	operator< (const basic_guest_ptr< void, PtrType, _Physical > &in) const
template<typename PtrType >
bool	operator<= (const basic_guest_ptr< void, PtrType, _Physical > &in) const
template<typename PtrType >
bool	operator> (const basic_guest_ptr< void, PtrType, _Physical > &in) const
template<typename PtrType >
bool	operator>= (const basic_guest_ptr< void, PtrType, _Physical > &in) const
template<typename PtrType >
bool	operator== (const basic_guest_ptr< void, PtrType, _Physical > &in) const
template<typename PtrType >
bool	operator!= (const basic_guest_ptr< void, PtrType, _Physical > &in) const
auto	at (size_t index) const
	Getter methods.
auto	operator[] (size_t index) const
auto	get () const
template<typename Tp = _Tp, typename std::enable_if_t<!std::is_pointer_v< Tp > > * dummy = nullptr>
void	set (uint64_t value) const
	Setter methods.
template<typename Tp = _Tp, typename std::enable_if_t<!std::is_pointer_v< Tp > > * dummy = nullptr>
void	set (size_t index, uint64_t value) const
template<typename Tp = _Tp, typename InTp , typename InPtrType , typename std::enable_if_t< std::is_pointer_v< std::remove_extent_t< Tp > > > * dummy = nullptr>
void	set (const basic_guest_ptr< InTp, InPtrType, _Physical > &in)
template<typename Tp = _Tp, typename InTp , typename InPtrType , typename std::enable_if_t< std::is_pointer_v< std::remove_extent_t< Tp > > > * dummy = nullptr>
void	set (size_t index, const basic_guest_ptr< InTp, InPtrType, _Physical > &in)
template<typename Tp = _Tp, typename InTp , typename InPtrType >
	GUEST_SIZET_TYPE (const basic_guest_ptr< InTp, InPtrType, _Physical > &in)
template<typename Tp = _Tp, typename InTp , typename InPtrType >
GUEST_SIZET_TYPE &	operator= (const basic_guest_ptr< InTp, InPtrType, _Physical > &in)
template<typename InTp , typename InPtrType >
	GUEST_SIZET_TYPE (basic_guest_ptr< InTp, InPtrType, _Physical > &&in) noexcept
template<typename Tp = _Tp, typename InTp , typename InPtrType >
GUEST_SIZET_TYPE &	operator= (basic_guest_ptr< InTp, InPtrType, _Physical > &&in) noexcept
	GUEST_SIZET_TYPE ()
	Common constructors.
template<typename... Arguments>
	GUEST_SIZET_TYPE (bool x64, Arguments &&... args)
template<typename... Arguments>
	GUEST_SIZET_TYPE (const Vcpu &vcpu, Arguments &&... args)
basic_guest_ptr< void, void, _Physical, void >	clone (uint64_t address) const
	Helper to create a new instance of this pointer.
template<typename... Arguments>
void	reset (const Vcpu &vcpu, Arguments &&... args)
	Reset operations.
template<typename... Arguments>
void	reset (bool x64, Arguments &&... args)
void	reset ()
template<typename U = _Tp, typename Tp , typename PtrType , typename std::enable_if_t< is_guest_size_v< Tp > > * dummy = nullptr>
void	reset (const basic_guest_ptr< Tp, PtrType, _Physical > &in)
template<typename U = _Tp, typename Tp , typename PtrType , typename std::enable_if_t< is_guest_size_v< Tp > > * dummy = nullptr>
void	reset (basic_guest_ptr< Tp, PtrType, _Physical > &&in)
	GUEST_SIZET_TYPE (const GUEST_SIZET_TYPE &) noexcept=default
	Default constructors.
GUEST_SIZET_TYPE &	operator= (const GUEST_SIZET_TYPE &) noexcept=default
	GUEST_SIZET_TYPE (GUEST_SIZET_TYPE &&) noexcept=default
GUEST_SIZET_TYPE &	operator= (GUEST_SIZET_TYPE &&) noexcept=default

Friends
template<typename U , typename PtrType , bool Physical, typename Enabled >
class	basic_guest_ptr
template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>
void	_ptr_cast_impl (const basic_guest_ptr< InTp, InPtrType, Physical > &, basic_guest_ptr< OutTp, OutPtrType, Physical > &)
	Friend the casting functions.
template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>
basic_guest_ptr< OutTp, OutPtrType, Physical >	const_ptr_cast (const basic_guest_ptr< InTp, InPtrType, Physical > &)
template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>
basic_guest_ptr< OutTp, OutPtrType, Physical >	static_ptr_cast (const basic_guest_ptr< InTp, InPtrType, Physical > &)
template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>
basic_guest_ptr< OutTp, OutPtrType, Physical >	reinterpret_ptr_cast (const basic_guest_ptr< InTp, InPtrType, Physical > &)
template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>
basic_guest_ptr< OutTp, OutPtrType, Physical >	const_ptr_cast (basic_guest_ptr< InTp, InPtrType, Physical > &&)
template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>
basic_guest_ptr< OutTp, OutPtrType, Physical >	static_ptr_cast (basic_guest_ptr< InTp, InPtrType, Physical > &&)
template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>
basic_guest_ptr< OutTp, OutPtrType, Physical >	reinterpret_ptr_cast (basic_guest_ptr< InTp, InPtrType, Physical > &&)

Detailed Description

template<typename _Tp, typename _PtrType, bool _Physical>
class introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >

Specialization of basic_guest_ptr<_Tp, guest_ptr_t, _Physical> to handle both uint32_t and uint64_t.

This class cannot return actual references or pointers, because the size can vary.

Constructor & Destructor Documentation

GUEST_SIZET_TYPE() [1/7]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename Tp = _Tp, typename InTp , typename InPtrType >

introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::GUEST_SIZET_TYPE ( const basic_guest_ptr< InTp, InPtrType, _Physical > &  in )

inline

GUEST_SIZET_TYPE() [2/7]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename InTp , typename InPtrType >

introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::GUEST_SIZET_TYPE ( basic_guest_ptr< InTp, InPtrType, _Physical > &&  in )

inlinenoexcept

GUEST_SIZET_TYPE() [3/7]

template<typename _Tp , typename _PtrType , bool _Physical>

introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::GUEST_SIZET_TYPE ( )

inline

Common constructors.

GUEST_SIZET_TYPE() [4/7]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename... Arguments>

introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::GUEST_SIZET_TYPE ( bool  x64, Arguments &&...  args  )

inline

GUEST_SIZET_TYPE() [5/7]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename... Arguments>

introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::GUEST_SIZET_TYPE ( const Vcpu &  vcpu, Arguments &&...  args  )

inline

GUEST_SIZET_TYPE() [6/7]

template<typename _Tp , typename _PtrType , bool _Physical>

introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::GUEST_SIZET_TYPE ( const GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical > &  )

defaultnoexcept

Default constructors.

GUEST_SIZET_TYPE() [7/7]

template<typename _Tp , typename _PtrType , bool _Physical>

introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::GUEST_SIZET_TYPE ( GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical > &&  )

defaultnoexcept

Member Function Documentation

address()

template<typename _Tp , typename _PtrType , bool _Physical>

uint64_t introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::address ( ) const

inline

Basic information.

at()

template<typename _Tp , typename _PtrType , bool _Physical>

auto introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::at ( size_t  index ) const

inline

Getter methods.

clone()

template<typename _Tp , typename _PtrType , bool _Physical>

basic_guest_ptr< void, void, _Physical, void > introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::clone ( uint64_t  address ) const

inline

Helper to create a new instance of this pointer.

domain()

template<typename _Tp , typename _PtrType , bool _Physical>

const Domain & introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::domain ( ) const

inline

get()

template<typename _Tp , typename _PtrType , bool _Physical>

auto introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::get ( ) const

inline

length()

template<typename _Tp , typename _PtrType , bool _Physical>

size_t introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::length ( ) const

inline

operator bool()

template<typename _Tp , typename _PtrType , bool _Physical>

introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator bool ( ) const

inlineexplicit

operator!=()

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename PtrType >

bool introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator!= ( const basic_guest_ptr< void, PtrType, _Physical > &  in ) const

inline

operator*()

template<typename _Tp , typename _PtrType , bool _Physical>

auto introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator* ( ) const

inline

operator+()

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename I >

basic_guest_ptr< _Tp, _PtrType, _Physical > introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator+ ( I  offset )

inline

operator++() [1/2]

template<typename _Tp , typename _PtrType , bool _Physical>

basic_guest_ptr< _Tp, _PtrType, _Physical > & introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator++ ( )

inline

operator++() [2/2]

template<typename _Tp , typename _PtrType , bool _Physical>

basic_guest_ptr< _Tp, _PtrType, _Physical > introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator++ ( int  )

inline

operator+=()

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename I >

basic_guest_ptr< _Tp, _PtrType, _Physical > & introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator+= ( I  offset )

inline

operator-()

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename I >

basic_guest_ptr< _Tp, _PtrType, _Physical > introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator- ( I  offset )

inline

operator--() [1/2]

template<typename _Tp , typename _PtrType , bool _Physical>

basic_guest_ptr< _Tp, _PtrType, _Physical > & introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator-- ( )

inline

operator--() [2/2]

template<typename _Tp , typename _PtrType , bool _Physical>

basic_guest_ptr< _Tp, _PtrType, _Physical > introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator-- ( int  )

inline

operator-=()

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename I >

basic_guest_ptr< _Tp, _PtrType, _Physical > & introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator-= ( I  offset )

inline

operator<()

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename PtrType >

bool introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator< ( const basic_guest_ptr< void, PtrType, _Physical > &  in ) const

inline

operator<=()

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename PtrType >

bool introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator<= ( const basic_guest_ptr< void, PtrType, _Physical > &  in ) const

inline

operator=() [1/4]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename Tp = _Tp, typename InTp , typename InPtrType >

GUEST_SIZET_TYPE & introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator= ( basic_guest_ptr< InTp, InPtrType, _Physical > &&  in )

inlinenoexcept

operator=() [2/4]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename Tp = _Tp, typename InTp , typename InPtrType >

GUEST_SIZET_TYPE & introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator= ( const basic_guest_ptr< InTp, InPtrType, _Physical > &  in )

inline

operator=() [3/4]

template<typename _Tp , typename _PtrType , bool _Physical>

GUEST_SIZET_TYPE & introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator= ( const GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical > &  )

defaultnoexcept

operator=() [4/4]

template<typename _Tp , typename _PtrType , bool _Physical>

GUEST_SIZET_TYPE & introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator= ( GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical > &&  )

defaultnoexcept

operator==()

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename PtrType >

bool introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator== ( const basic_guest_ptr< void, PtrType, _Physical > &  in ) const

inline

operator>()

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename PtrType >

bool introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator> ( const basic_guest_ptr< void, PtrType, _Physical > &  in ) const

inline

operator>=()

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename PtrType >

bool introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator>= ( const basic_guest_ptr< void, PtrType, _Physical > &  in ) const

inline

operator[]()

template<typename _Tp , typename _PtrType , bool _Physical>

auto introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::operator[] ( size_t  index ) const

inline

page_directory()

template<typename _Tp , typename _PtrType , bool _Physical>

uint64_t introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::page_directory ( ) const

inline

page_number()

template<typename _Tp , typename _PtrType , bool _Physical>

uint64_t introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::page_number ( ) const

inline

page_offset()

template<typename _Tp , typename _PtrType , bool _Physical>

uint64_t introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::page_offset ( ) const

inline

reset() [1/5]

template<typename _Tp , typename _PtrType , bool _Physical>

void introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::reset ( )

inline

reset() [2/5]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename U = _Tp, typename Tp , typename PtrType , typename std::enable_if_t< is_guest_size_v< Tp > > * dummy = nullptr>

void introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::reset ( basic_guest_ptr< Tp, PtrType, _Physical > &&  in )

inline

reset() [3/5]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename... Arguments>

void introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::reset ( bool  x64, Arguments &&...  args  )

inline

reset() [4/5]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename U = _Tp, typename Tp , typename PtrType , typename std::enable_if_t< is_guest_size_v< Tp > > * dummy = nullptr>

void introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::reset ( const basic_guest_ptr< Tp, PtrType, _Physical > &  in )

inline

reset() [5/5]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename... Arguments>

void introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::reset ( const Vcpu &  vcpu, Arguments &&...  args  )

inline

Reset operations.

set() [1/4]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename Tp = _Tp, typename InTp , typename InPtrType , typename std::enable_if_t< std::is_pointer_v< std::remove_extent_t< Tp > > > * dummy = nullptr>

void introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::set ( const basic_guest_ptr< InTp, InPtrType, _Physical > &  in )

inline

set() [2/4]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename Tp = _Tp, typename InTp , typename InPtrType , typename std::enable_if_t< std::is_pointer_v< std::remove_extent_t< Tp > > > * dummy = nullptr>

void introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::set ( size_t  index, const basic_guest_ptr< InTp, InPtrType, _Physical > &  in  )

inline

set() [3/4]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename Tp = _Tp, typename std::enable_if_t<!std::is_pointer_v< Tp > > * dummy = nullptr>

void introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::set ( size_t  index, uint64_t  value  ) const

inline

set() [4/4]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename Tp = _Tp, typename std::enable_if_t<!std::is_pointer_v< Tp > > * dummy = nullptr>

void introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::set ( uint64_t  value ) const

inline

Setter methods.

str()

template<typename _Tp , typename _PtrType , bool _Physical>

std::string introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::str ( ) const

inline

write_stream()

template<typename _Tp , typename _PtrType , bool _Physical>

std::ostream & introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::write_stream ( std::ostream &  os ) const

inline

x64()

template<typename _Tp , typename _PtrType , bool _Physical>

bool introvirt::GUEST_SIZET_TYPE< _Tp, _PtrType, _Physical >::x64 ( ) const

inline

Friends And Related Symbol Documentation

_ptr_cast_impl

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>

void _ptr_cast_impl ( const basic_guest_ptr< InTp, InPtrType, Physical > &  , basic_guest_ptr< OutTp, OutPtrType, Physical > &    )

friend

Friend the casting functions.

basic_guest_ptr

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename U , typename PtrType , bool Physical, typename Enabled >

friend class basic_guest_ptr

friend

const_ptr_cast [1/2]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>

basic_guest_ptr< OutTp, OutPtrType, Physical > const_ptr_cast ( basic_guest_ptr< InTp, InPtrType, Physical > &&  )

friend

const_ptr_cast [2/2]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>

basic_guest_ptr< OutTp, OutPtrType, Physical > const_ptr_cast ( const basic_guest_ptr< InTp, InPtrType, Physical > &  )

friend

reinterpret_ptr_cast [1/2]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>

basic_guest_ptr< OutTp, OutPtrType, Physical > reinterpret_ptr_cast ( basic_guest_ptr< InTp, InPtrType, Physical > &&  )

friend

reinterpret_ptr_cast [2/2]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>

basic_guest_ptr< OutTp, OutPtrType, Physical > reinterpret_ptr_cast ( const basic_guest_ptr< InTp, InPtrType, Physical > &  )

friend

static_ptr_cast [1/2]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>

basic_guest_ptr< OutTp, OutPtrType, Physical > static_ptr_cast ( basic_guest_ptr< InTp, InPtrType, Physical > &&  )

friend

static_ptr_cast [2/2]

template<typename _Tp , typename _PtrType , bool _Physical>

template<typename OutTp , typename OutPtrType , typename InTp , typename InPtrType , bool Physical>

basic_guest_ptr< OutTp, OutPtrType, Physical > static_ptr_cast ( const basic_guest_ptr< InTp, InPtrType, Physical > &  )

friend

---

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

• /home/runner/work/IntroVirt/IntroVirt/include/introvirt/core/memory/guest_size_t_ptr.hh