The struct timespec used for various timing and timeout operations in system calls. More...

#include <time.hxx>

Inheritance diagram for clues::item::TimeSpecParameter:

Public Member Functions
	TimeSpecParameter (const std::string_view short_name, const std::string_view long_name={}, const ItemType type=ItemType::PARAM_IN, const bool remain_semantics=false)

std::string	str () const override
	Returns a human readable string representation of the item.

const std::optional< struct timespec > &	spec () const

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 &proc) override
	Processes the value stored in m_val acc. to the actual item type.

void	updateData (const Tracee &proc) override
	Called upon exit of the system call to update possible out parameters.

void	fetch (const Tracee &proc)

bool	needTime32Conversion () const
	Checks whether the current ABI context requires conversion of 32 bit to 64 bit.

Protected Member Functions inherited from clues::SystemCallItem
void	setSystemCall (const SystemCall &sc)
	Sets the system call context this item is a part of.

Protected Attributes
std::optional< struct timespec >	m_timespec

bool	m_remain_semantics = false

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.

Additional Inherited Members
Public Types inherited from clues::SystemCallItem
enum class	Flag { DEFER_FILL = 1 << 0 }

using	Flags = cosmos::BitMask<Flag>

Detailed Description

The struct timespec used for various timing and timeout operations in system calls.

Definition at line 16 of file time.hxx.

Constructor & Destructor Documentation

◆ TimeSpecParameter()

clues::item::TimeSpecParameter::TimeSpecParameter	(	const std::string_view	short_name,
		const std::string_view	long_name = {},
		const ItemType	type = ItemType::PARAM_IN,
		const bool	remain_semantics = false )

inlineexplicit

Definition at line 19 of file time.hxx.

                                                 {},
                const ItemType type = ItemType::PARAM_IN,
                const bool remain_semantics = false) :
                        SystemCallItem{type, short_name, long_name},
                        m_remain_semantics{remain_semantics} {
        }

Member Function Documentation

◆ fetch()

void clues::item::TimeSpecParameter::fetch ( const Tracee & proc )

protected

Definition at line 60 of file time.cxx.

                                                {
        if (!m_timespec) {
                m_timespec = timespec{};
        }
 
        if (needTime32Conversion()) {
                struct timespec32 ts32;
                if (!proc.readStruct(asPtr(), ts32)) {
                        m_timespec.reset();
                        return;
                }
 
                m_timespec->tv_sec = ts32.tv_sec;
                m_timespec->tv_nsec = ts32.tv_nsec;
        } else if (!proc.readStruct(asPtr(), *m_timespec)) {
                m_timespec.reset();
        }
}

◆ needTime32Conversion()

bool clues::item::TimeSpecParameter::needTime32Conversion ( ) const

protected

Checks whether the current ABI context requires conversion of 32 bit to 64 bit.

Definition at line 43 of file time.cxx.

                                                   {
        /*
         * currently we only cover 32-bit emulation binaries on X86-64.
         */
 
        if (!m_call->is32BitEmulationABI()) {
                return false;
        }
 
        /* now we need to check which system call we're on */
        return cosmos::in_list(m_call->callNr(), {
                        SystemCallNr::CLOCK_NANOSLEEP,
                        SystemCallNr::FUTEX,
                        SystemCallNr::NANOSLEEP
        });
}

◆ processValue()

void clues::item::TimeSpecParameter::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 36 of file time.hxx.

                                                       {
                if (this->isOut())
                        m_timespec.reset();
                else
                        fetch(proc);
        }

◆ spec()

const std::optional< struct timespec > & clues::item::TimeSpecParameter::spec ( ) const

inline

Definition at line 30 of file time.hxx.

                                                         {
                return m_timespec;
        }

◆ str()

std::string clues::item::TimeSpecParameter::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 79 of file time.cxx.

                                       {
        if (!m_timespec) {
                if (m_remain_semantics) {
                        /* still show that a pointer was passed */
                        return format::pointer(asPtr());
                } else {
                        return "NULL";
                }
        }
 
        return format::timespec(*m_timespec);
}

◆ updateData()

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

overrideprotectedvirtual

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 18 of file time.cxx.

                                                     {
        if (m_remain_semantics) {
                /*
                 * special logic for clock_nanosleep remain semantics &
                 * similar cases:
                 *
                 * - on success, remaining time is not updated
                 * - on special kernel error code, transparent restart will
                 *   happen
                 * - otherwise only if EINTR is observed will the time be
                 *   updated
                 */
                if (m_call->hasResultValue())
                       return;
 
                const auto error = *m_call->error();
 
                if (!error.hasErrorCode() || error.errorCode() != cosmos::Errno::INTERRUPTED) {
                        return;
                }
        }
 
        fetch(proc);
}

Member Data Documentation

◆ m_remain_semantics

bool clues::item::TimeSpecParameter::m_remain_semantics = false

protected

Definition at line 53 of file time.hxx.

◆ m_timespec

std::optional<struct timespec> clues::item::TimeSpecParameter::m_timespec

protected

Definition at line 52 of file time.hxx.

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

include/items/time.hxx
src/items/time.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TimeSpecParameter()

Member Function Documentation

◆ fetch()

◆ needTime32Conversion()

◆ processValue()

◆ spec()

◆ str()

◆ updateData()

Member Data Documentation

◆ m_remain_semantics

◆ m_timespec