clues::item::GenericPointerValue Class Reference

Inheritance diagram for clues::item::GenericPointerValue:

Public Member Functions
	GenericPointerValue (const std::string_view short_name, const std::string_view long_name={}, const ItemType type=ItemType::PARAM_IN)
std::string	str () const override
	Returns a human readable string representation of the item.
ForeignPtr	ptr () const
Public Member Functions inherited from clues::item::PointerValue
	PointerValue (const ItemType type, const std::string_view short_name, const std::string_view long_name)
Public Member Functions inherited from clues::SystemCallItem
	SystemCallItem (const ItemType type, const std::string_view short_name={}, const std::string_view long_name={})
	Constructs a new SystemCallItem.
auto	type () const
bool	isIn () const
bool	isOut () const
bool	isInOut () const
bool	isReturnValue () const
void	fill (const Tracee &proc, const Word word)
	Fills the item from the given register data.
bool	needsUpdate () const
	Returns whether the item needs to be updated after the system call is finished.
std::string_view	shortName () const
	Returns the friendly short name for this item.
std::string_view	longName () const
	Returns the friendly long name for this item, if available, else the short name.
auto	hasLongName () const
bool	isZero () const
	Returns whether the parameter is set to 0 / NULL.
Word	value () const
	Returns the currently stored raw value of the item.
template<typename OTHER>
OTHER	valueAs () const
	Helper to cast the strongly typed Word m_val to other strong enum types.
ForeignPtr	asPtr () const
Flags	flags () const
bool	deferFill () const

Protected Member Functions
void	processValue (const Tracee &) override
	Processes the value stored in m_val acc. to the actual item type.
void	updateData (const Tracee &) override
	Called upon exit of the system call to update possible out parameters.
Protected Member Functions inherited from clues::SystemCallItem
void	setSystemCall (const SystemCall &sc)
	Sets the system call context this item is a part of.

Additional Inherited Members
Public Types inherited from clues::SystemCallItem
enum class	Flag { DEFER_FILL = 1 << 0 }
using	Flags = cosmos::BitMask<Flag>
Protected Attributes inherited from clues::SystemCallItem
const SystemCall *	m_call = nullptr
	The system call context this item part of.
const ItemType	m_type
	The type of item.
std::string_view	m_short_name
	A human readable short name for the item, should be one word only.
std::string_view	m_long_name
	A human readable longer name for the item.
Word	m_val
	The raw register value for the item.
Flags	m_flags
	Flags influencing the processing of the item.

Detailed Description

Definition at line 123 of file items.hxx.

Constructor & Destructor Documentation

GenericPointerValue()

clues::item::GenericPointerValue::GenericPointerValue ( const std::string_view short_name, const std::string_view long_name = {}, const ItemType type = ItemType::PARAM_IN )

inlineexplicit

Definition at line 127 of file items.hxx.

                                                 {},
                const ItemType type = ItemType::PARAM_IN) :
                        PointerValue{type, short_name, long_name} {
        }

Member Function Documentation

processValue()

void clues::item::GenericPointerValue::processValue ( const Tracee & )

inlineoverrideprotectedvirtual

Processes the value stored in m_val acc. to the actual item type.

This function is called for all parameter types upon entry to a system call, and for ItemType::RETVAL upon exit from a system call.

For parameters of ItemType::PARAM_OUT this callback can be used to reset any stored data to be filled in later when updateData() is called.

Reimplemented from clues::SystemCallItem.

Definition at line 142 of file items.hxx.

{}

ptr()

ForeignPtr clues::item::GenericPointerValue::ptr ( ) const

inline

Definition at line 136 of file items.hxx.

                               {
                return ForeignPtr{valueAs<uintptr_t>()};
        }

str()

std::string clues::item::GenericPointerValue::str ( ) const

overridevirtual

Returns a human readable string representation of the item.

This member function should be specialized in derived classes to output the item's data in a fashion suitable for the concrete item type.

Reimplemented from clues::SystemCallItem.

Definition at line 34 of file items.cxx.

                                         {
        std::stringstream ss;
        if (auto ptr = valueAs<long*>(); ptr) {
                ss << ptr;
        } else {
                ss << "NULL";
        }
        return ss.str();
}

updateData()

void clues::item::GenericPointerValue::updateData ( const Tracee & t )

inlineoverrideprotectedvirtual

Called upon exit of the system call to update possible out parameters.

This function is called for parameters of ItemType::PARAM_OUT and ItemType::PARAM_IN_OUT upon system call exit to update the data from the values returned from the system call.

The default implementation calls processValue() to allow to share the same data processing code for input and output for item types that support both.

This function is called regardless of system call success or error, so it can happen that there is no valid data returned by the kernel or pointers in userspace are broken. Implementations should take this into consideration when operating on the data.

Reimplemented from clues::SystemCallItem.

Definition at line 143 of file items.hxx.

{}

---

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

• include/items/items.hxx
• src/items/items.cxx