Combined mmap() arguments for the old variant of mmap() on 32-bit ABIs like I386. More...

#include <mmap.hxx>

Inheritance diagram for clues::item::OldMmapArgs:

Public Member Functions
bool	valid () const

ForeignPtr	addr () const

size_t	length () const

size_t	offset () const

cosmos::mem::MapType	type () const

cosmos::mem::MapFlags	flags () const

cosmos::mem::AccessFlags	prot () const

cosmos::FileNum	fd () const

Public Member Functions inherited from clues::item::PointerInValue
	PointerInValue (const std::string_view short_name, const std::string_view long_name={})

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.

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

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
bool	m_valid = false

ForeignPtr	m_addr = ForeignPtr::NO_POINTER

size_t	m_length = 0

size_t	m_offset = 0

cosmos::mem::MapType	m_type {0}

cosmos::mem::MapFlags	m_flags

cosmos::mem::AccessFlags	m_prot

cosmos::FileNum	m_fd

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

Combined mmap() arguments for the old variant of mmap() on 32-bit ABIs like I386.

Definition at line 75 of file mmap.hxx.

Constructor & Destructor Documentation

◆ OldMmapArgs()

clues::item::OldMmapArgs::OldMmapArgs ( )

inlineexplicit

Definition at line 79 of file mmap.hxx.

                               :
                        PointerInValue{"args"} {
        }

Member Function Documentation

◆ addr()

ForeignPtr clues::item::OldMmapArgs::addr ( ) const

inline

Definition at line 87 of file mmap.hxx.

                                {
                return m_addr;
        }

◆ fd()

cosmos::FileNum clues::item::OldMmapArgs::fd ( ) const

inline

Definition at line 111 of file mmap.hxx.

                                 {
                return m_fd;
        }

◆ flags()

cosmos::mem::MapFlags clues::item::OldMmapArgs::flags ( ) const

inline

Definition at line 103 of file mmap.hxx.

                                        {
                return m_flags;
        }

◆ length()

size_t clues::item::OldMmapArgs::length ( ) const

inline

Definition at line 91 of file mmap.hxx.

                              {
                return m_length;
        }

◆ offset()

size_t clues::item::OldMmapArgs::offset ( ) const

inline

Definition at line 95 of file mmap.hxx.

                              {
                return m_offset;
        }

◆ processValue()

void clues::item::OldMmapArgs::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 73 of file mmap.cxx.

                                                 {
        struct mmap_arg_struct args;
 
        if (!proc.readStruct(asPtr(), args)) {
                m_valid = false;
                return;
        }
 
        m_addr = ForeignPtr{static_cast<uintptr_t>(args.addr)};
        m_length = args.len;
        m_offset = args.offset;
        m_prot = cosmos::mem::AccessFlags{static_cast<int>(args.prot)};
        m_fd = cosmos::FileNum{static_cast<int>(args.fd)};
        const auto raw_flags = static_cast<int>(args.flags);
        m_flags = cosmos::mem::MapFlags{raw_flags & ~0x3};
        m_type = cosmos::mem::MapType{raw_flags & 0x3};
 
        m_valid = true;
}

◆ prot()

cosmos::mem::AccessFlags clues::item::OldMmapArgs::prot ( ) const

inline

Definition at line 107 of file mmap.hxx.

                                          {
                return m_prot;
        }

◆ str()

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

overrideprotectedvirtual

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 93 of file mmap.cxx.

                                 {
        auto &mmap_call = dynamic_cast<const MmapSystemCall&>(*m_call);
 
        std::stringstream ss;
        ss << "{hint=" << mmap_call.hint.str()
                << ", length=" << mmap_call.length.str()
                << ", prot=" << mmap_call.protection.str()
                << ", flags=" << mmap_call.flags.str()
                << ", fd=" << mmap_call.fd.str()
                << ", offset=" << mmap_call.offset.str()
                << "}";
 
        return ss.str();
}

◆ type()

cosmos::mem::MapType clues::item::OldMmapArgs::type ( ) const

inline

Definition at line 99 of file mmap.hxx.

                                      {
                return m_type;
        }

◆ valid()

bool clues::item::OldMmapArgs::valid ( ) const

inline

Definition at line 83 of file mmap.hxx.

                           {
                return m_valid;
        }

Member Data Documentation

◆ m_addr

ForeignPtr clues::item::OldMmapArgs::m_addr = ForeignPtr::NO_POINTER

protected

Definition at line 124 of file mmap.hxx.

◆ m_fd

cosmos::FileNum clues::item::OldMmapArgs::m_fd

protected

Definition at line 130 of file mmap.hxx.

◆ m_flags

cosmos::mem::MapFlags clues::item::OldMmapArgs::m_flags

protected

Definition at line 128 of file mmap.hxx.

◆ m_length

size_t clues::item::OldMmapArgs::m_length = 0

protected

Definition at line 125 of file mmap.hxx.

◆ m_offset

size_t clues::item::OldMmapArgs::m_offset = 0

protected

Definition at line 126 of file mmap.hxx.

◆ m_prot

cosmos::mem::AccessFlags clues::item::OldMmapArgs::m_prot

protected

Definition at line 129 of file mmap.hxx.

◆ m_type

cosmos::mem::MapType clues::item::OldMmapArgs::m_type {0}

protected

Definition at line 127 of file mmap.hxx.

127{0};

◆ m_valid

bool clues::item::OldMmapArgs::m_valid = false

protected

Definition at line 123 of file mmap.hxx.

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

include/items/mmap.hxx
src/items/mmap.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OldMmapArgs()

Member Function Documentation

◆ addr()

◆ fd()

◆ flags()

◆ length()

◆ offset()

◆ processValue()

◆ prot()

◆ str()

◆ type()

◆ valid()

Member Data Documentation

◆ m_addr

◆ m_fd

◆ m_flags

◆ m_length

◆ m_offset

◆ m_prot

◆ m_type

◆ m_valid