memInfo Class Reference

Memory usage information for the process running this object. More...

Public Member Functions
	memInfo ()
	Construct null. More...
	~memInfo ()
	Destructor. More...
const memInfo &	update ()
	Parse /proc/<pid>/status. More...
int	peak () const
	Access the stored peak memory (VmPeak in /proc/<pid>/status) More...
int	size () const
	Access the stored memory size (VmSize in /proc/<pid>/status) More...
int	rss () const
	Access the stored rss value (VmRSS in /proc/<pid>/status) More...
bool	valid () const
	True if the memory information appears valid. More...

Private Attributes
int	peak_
	Peak memory used by the process (VmPeak in /proc/<pid>/status) More...
int	size_
	Memory used by the process (VmSize in /proc/<pid>/status) More...
int	rss_
	Resident set size of the process (VmRSS in /proc/<pid>/status) More...

Friends
Istream &	operator>> (Istream &, memInfo &)
	Read peak/size/rss from stream. More...
Ostream &	operator<< (Ostream &, const memInfo &)
	Write peak/size/rss to stream. More...

Detailed Description

Memory usage information for the process running this object.

Note

Uses the information from /proc/<pid>/status

Source files

• memInfo.H
• memInfo.C

Definition at line 53 of file memInfo.H.

Constructor & Destructor Documentation

memInfo()

memInfo

(

)

Construct null.

Definition at line 30 of file memInfo.C.

References memInfo::update().

Here is the call graph for this function:

~memInfo()

~memInfo

(

)

Destructor.

Definition at line 42 of file memInfo.C.

Member Function Documentation

update()

const Foam::memInfo & update

(

)

Parse /proc/<pid>/status.

Definition at line 48 of file memInfo.C.

References ISstream::getLine(), IOstream::good(), Foam::name(), and Foam::pid().

Referenced by main(), and memInfo::memInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

peak()

int peak ( ) const

inline

Access the stored peak memory (VmPeak in /proc/<pid>/status)

The value is stored from the previous update()

Definition at line 88 of file memInfo.H.

size()

int size ( ) const

inline

Access the stored memory size (VmSize in /proc/<pid>/status)

The value is stored from the previous update()

Definition at line 95 of file memInfo.H.

Referenced by indexedOctree< Foam::treeDataFace >::indexedOctree().

Here is the caller graph for this function:

rss()

int rss ( ) const

inline

Access the stored rss value (VmRSS in /proc/<pid>/status)

The value is stored from the previous update()

Definition at line 102 of file memInfo.H.

valid()

bool valid

(

)

const

True if the memory information appears valid.

Definition at line 82 of file memInfo.C.

Referenced by vtkPV3Foam::printMemory(), and vtkPV4Foam::printMemory().

Here is the caller graph for this function:

Friends And Related Function Documentation

operator>>

Istream& operator>> ( Istream &  , memInfo &    )

friend

Read peak/size/rss from stream.

operator<<

Ostream& operator<< ( Ostream &  , const memInfo &    )

friend

Write peak/size/rss to stream.

Field Documentation

peak_

int peak_

private

Peak memory used by the process (VmPeak in /proc/<pid>/status)

Definition at line 58 of file memInfo.H.

size_

int size_

private

Memory used by the process (VmSize in /proc/<pid>/status)

Definition at line 61 of file memInfo.H.

rss_

int rss_

private

Resident set size of the process (VmRSS in /proc/<pid>/status)

Definition at line 64 of file memInfo.H.

---

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

• src/OSspecific/POSIX/memInfo/memInfo.H
• src/OSspecific/POSIX/memInfo/memInfo.C
• src/OSspecific/POSIX/memInfo/memInfoIO.C