The enum value used with file seal operations in the fcntl() system call. More...

#include <fcntl.hxx>

Inheritance diagram for clues::item::FileSealSettings:

Public Member Functions
	FileSealSettings (const ItemType type)

auto	flags () const
	Returns the currently stored SealFlags.

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

Public Member Functions inherited from clues::item::ValueParameter
	ValueParameter (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 &proc) override
	Processes the value stored in m_val acc. to the actual item type.

Protected Member Functions inherited from clues::SystemCallItem
virtual void	updateData (const Tracee &t)
	Called upon exit of the system call to update possible out parameters.

void	setSystemCall (const SystemCall &sc)
	Sets the system call context this item is a part of.

Protected Attributes
cosmos::FileDescriptor::SealFlags	m_flags

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 enum value used with file seal operations in the fcntl() system call.

Definition at line 276 of file fcntl.hxx.

Constructor & Destructor Documentation

◆ FileSealSettings()

clues::item::FileSealSettings::FileSealSettings ( const ItemType type )

inlineexplicit

Definition at line 280 of file fcntl.hxx.

                                                       :
                        ValueParameter{type, "flags", "seal flags"} {
        }

Member Function Documentation

◆ flags()

auto clues::item::FileSealSettings::flags ( ) const

inline

Returns the currently stored SealFlags.

Definition at line 285 of file fcntl.hxx.

                           {
                return m_flags;
        }

◆ processValue()

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

overrideprotectedvirtual

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 379 of file fcntl.cxx.

                                                  {
        m_flags = cosmos::FileDescriptor::SealFlags{valueAs<unsigned int>()};
}

◆ str()

std::string clues::item::FileSealSettings::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 383 of file fcntl.cxx.

                                      {
        BITFLAGS_FORMAT_START(m_flags);
 
        BITFLAGS_ADD(F_SEAL_SEAL);
        BITFLAGS_ADD(F_SEAL_SHRINK);
        BITFLAGS_ADD(F_SEAL_GROW);
        BITFLAGS_ADD(F_SEAL_WRITE);
        BITFLAGS_ADD(F_SEAL_FUTURE_WRITE);
 
        return BITFLAGS_STR();
}

Member Data Documentation

◆ m_flags

cosmos::FileDescriptor::SealFlags clues::item::FileSealSettings::m_flags

protected

Definition at line 297 of file fcntl.hxx.

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

include/items/fcntl.hxx
src/items/fcntl.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members