libclues
Linux C++ Tracing Library
Loading...
Searching...
No Matches
clues::item::ProcessIDItem Class Reference
+ Inheritance diagram for clues::item::ProcessIDItem:

Public Member Functions

 ProcessIDItem (const ItemType type, const std::string_view desc)
 
auto pid () const
 
std::string str () const override
 Returns a human readable string representation of the item.
 
- 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.
 
- 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::ProcessID m_pid = cosmos::ProcessID::INVALID
 
- Protected Attributes inherited from clues::SystemCallItem
const SystemCallm_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

Definition at line 15 of file process.hxx.

Constructor & Destructor Documentation

◆ ProcessIDItem()

clues::item::ProcessIDItem::ProcessIDItem ( const ItemType type,
const std::string_view desc )
inlineexplicit

Definition at line 19 of file process.hxx.

19 :
20 SystemCallItem{type, "pid", desc} {
21 }
SystemCallItem(const ItemType type, const std::string_view short_name={}, const std::string_view long_name={})
Constructs a new SystemCallItem.

Member Function Documentation

◆ pid()

auto clues::item::ProcessIDItem::pid ( ) const
inline

Definition at line 23 of file process.hxx.

23{ return m_pid; }

◆ processValue()

void clues::item::ProcessIDItem::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 34 of file process.hxx.

34 {
36 }
OTHER valueAs() const
Helper to cast the strongly typed Word m_val to other strong enum types.

◆ str()

std::string clues::item::ProcessIDItem::str ( ) const
inlineoverridevirtual

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 25 of file process.hxx.

25 {
26 if (m_pid == cosmos::ProcessID::INVALID)
27 return "-1";
28
29 return SystemCallItem::str();
30 }
virtual std::string str() const
Returns a human readable string representation of the item.

Member Data Documentation

◆ m_pid

cosmos::ProcessID clues::item::ProcessIDItem::m_pid = cosmos::ProcessID::INVALID
protected

Definition at line 40 of file process.hxx.


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