ISF::MemoryMonitoringTool Class Reference

#include <MemoryMonitoringTool.h>

Inheritance diagram for ISF::MemoryMonitoringTool:

Collaboration diagram for ISF::MemoryMonitoringTool:

Public Member Functions
	MemoryMonitoringTool (const std::string &t, const std::string &n, const IInterface *p)
	Constructor with parameters. More...
	~MemoryMonitoringTool ()
	Destructor. More...
StatusCode	initialize ()
	Athena algtool Hooks. More...
StatusCode	finalize ()
	Athena algtool Hook. More...
virtual double	getCurrent () const
	return current memory usage in kBytes More...
virtual void	dumpCurrent (const char *infoStr, bool considerInSummary)
	dump current memory monitoring information More...
virtual void	recordCurrent (const char *infoStr)
	store the current memory monitoring information internally More...
virtual void	dumpSummary (const char *dumpCallDescr) const
	dump all internally stored memory monitoring information More...

Private Member Functions
int	computeCurMemoryUsage () const
	consolidate /proc to determine current memory usage More...

Private Attributes
unsigned int	m_numCalls
	needed to compute per event stats More...
unsigned int	m_prevCallMemUsage
double	m_accumulatedCallMemory
double	m_accumulatedIncrMemory
InfoUsagePairVector	m_table
	storing all (infoStr,memUsage) pairs created in recordCurrent(..) calls More...

Detailed Description

the code actually computing the memory usage is kindly stolen from: atlasoff:: Simulation/G4Sim/SimHelpers/SimHelpers/MemorySnooper.h

Author

Elmar.Ritsch -at- cern.ch

Definition at line 37 of file MemoryMonitoringTool.h.

Constructor & Destructor Documentation

MemoryMonitoringTool()

ISF::MemoryMonitoringTool::MemoryMonitoringTool	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p
	)

Constructor with parameters.

Constructor.

Definition at line 16 of file MemoryMonitoringTool.cxx.

                                                                       :
  base_class(t,n,p),
  m_numCalls(0),
  m_prevCallMemUsage(0),
  m_accumulatedCallMemory(0.),
  m_accumulatedIncrMemory(0.),
  m_table()
{
}

~MemoryMonitoringTool()

ISF::MemoryMonitoringTool::~MemoryMonitoringTool

(

)

Destructor.

Definition at line 29 of file MemoryMonitoringTool.cxx.

                                               {
  // clean up memory
  for (auto & p : m_table){ 
    delete p;
  }
  // reset summary table vector
  m_table.clear();
 
}

Member Function Documentation

computeCurMemoryUsage()

int ISF::MemoryMonitoringTool::computeCurMemoryUsage ( ) const

private

consolidate /proc to determine current memory usage

Definition at line 138 of file MemoryMonitoringTool.cxx.

                                                         {
  // this code is copied from:
  // atlasoff: Simulation/G4Sim/SimHelpers/SimHelpers/MemorySnooper.h
 
  int pid=getpid();
  std::ostringstream is;
  is<<pid;
  std::string spid=is.str();
  std::string filename="mem"+spid+".txt";
  std::string temp="cat /proc/"+spid+"/status | grep VmSize >"+filename;
  system(temp.c_str());
  std::ifstream in(filename.c_str());
  std::string text,mem,text1;
  in>>text>>mem>>text1;
  temp="rm -f "+filename;
  system(temp.c_str());
  float memsize=atof(mem.c_str());
 
  // finally return the memory size
  return int(memsize);
}

dumpCurrent()

void ISF::MemoryMonitoringTool::dumpCurrent ( const char *  infoStr, bool  considerInSummary  )

virtual

dump current memory monitoring information

Definition at line 66 of file MemoryMonitoringTool.cxx.

                                                                     {
 
  // get current memory usage
  int curMem = computeCurMemoryUsage();
 
  // store for different stats
  int curDiff = curMem-m_prevCallMemUsage;
 
  // use these stats for the summary table
  if (considerInSummary) {
    m_accumulatedCallMemory  += curMem;
    m_accumulatedIncrMemory  += curDiff;
    ++m_numCalls;
  }
 
  ATH_MSG_INFO( "Current Process Memory Usage " << infoStr
                << " (VmMem,diff-previous) kBytes: "
                << curMem<<" "<< curDiff );
 
  m_prevCallMemUsage = curMem;
 
  return;
}

dumpSummary()

void ISF::MemoryMonitoringTool::dumpSummary ( const char *  dumpCallDescr ) const

virtual

dump all internally stored memory monitoring information

Definition at line 108 of file MemoryMonitoringTool.cxx.

                                                                {
 
  ATH_MSG_INFO("*****************************************************\n"<<
               "*  (VmMem) MEMORY SUMMARY: (kBytes)");
 
  // loop over all (infoStr,memUsage) pairs and print them
  InfoUsagePairVector::const_iterator it    = m_table.begin();
  InfoUsagePairVector::const_iterator itEnd = m_table.end();
  for ( ; it != itEnd; ++it) {
    const char *curInfo  = (*it)->first;
    int         curUsage = (*it)->second;
 
    ATH_MSG_INFO("*  Memory Usage " << curInfo << "\t\t: " << curUsage);
  }
 
  if (m_numCalls) {
    //cppcheck-suppress uselessAssignmentPtrArg
    if (!desc) desc = "MemoryMonitor call";
    ATH_MSG_INFO( "*  Average memory per " << desc << " : "
                  << (int)(m_accumulatedCallMemory/m_numCalls) );
    ATH_MSG_INFO( "*  Average memory increase per " << desc << " : "
                  << (int)(m_accumulatedIncrMemory/m_numCalls));
  }
 
  ATH_MSG_INFO("*****************************************************");
 
  return;
}

finalize()

StatusCode ISF::MemoryMonitoringTool::finalize

(

)

Athena algtool Hook.

Definition at line 51 of file MemoryMonitoringTool.cxx.

{
  ATH_MSG_VERBOSE("finalize() ...");
  ATH_MSG_VERBOSE("finalize() successful");
  return StatusCode::SUCCESS;
}

getCurrent()

double ISF::MemoryMonitoringTool::getCurrent ( ) const

virtual

return current memory usage in kBytes

Definition at line 60 of file MemoryMonitoringTool.cxx.

                                                 {
  return double( computeCurMemoryUsage());
}

initialize()

StatusCode ISF::MemoryMonitoringTool::initialize

(

)

Athena algtool Hooks.

Definition at line 41 of file MemoryMonitoringTool.cxx.

{
  ATH_MSG_VERBOSE("initialize() ...");
 
  ATH_MSG_VERBOSE("initialize() successful");
  return StatusCode::SUCCESS;
}

recordCurrent()

void ISF::MemoryMonitoringTool::recordCurrent ( const char *  infoStr )

virtual

store the current memory monitoring information internally

Definition at line 93 of file MemoryMonitoringTool.cxx.

                                                                {
 
  int curUsage = computeCurMemoryUsage();
  ATH_MSG_VERBOSE("recording current memory footprint of "
                  << curUsage << " kBytes");
 
  // create new InfoUsagePair and store it locally in vector
  InfoUsagePair *curInfoUsage = new InfoUsagePair(infoStr, curUsage);
  m_table.push_back( curInfoUsage);
 
  return;
}

Member Data Documentation

m_accumulatedCallMemory

double ISF::MemoryMonitoringTool::m_accumulatedCallMemory

private

Definition at line 70 of file MemoryMonitoringTool.h.

m_accumulatedIncrMemory

double ISF::MemoryMonitoringTool::m_accumulatedIncrMemory

private

Definition at line 71 of file MemoryMonitoringTool.h.

m_numCalls

unsigned int ISF::MemoryMonitoringTool::m_numCalls

private

needed to compute per event stats

Definition at line 68 of file MemoryMonitoringTool.h.

m_prevCallMemUsage

unsigned int ISF::MemoryMonitoringTool::m_prevCallMemUsage

private

Definition at line 69 of file MemoryMonitoringTool.h.

m_table

InfoUsagePairVector ISF::MemoryMonitoringTool::m_table

private

storing all (infoStr,memUsage) pairs created in recordCurrent(..) calls

Definition at line 74 of file MemoryMonitoringTool.h.

---

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

• MemoryMonitoringTool.h
• MemoryMonitoringTool.cxx