MemoryAuditor Class Reference

Monitors the memory use of each algorithm. More...

#include <MemoryAuditor.h>

Inheritance diagram for MemoryAuditor:

Collaboration diagram for MemoryAuditor:

Public Member Functions
	MemoryAuditor (const std::string &name, ISvcLocator *pSvcLocator)
Public Member Functions inherited from CommonAuditor
	CommonAuditor (const std::string &name, ISvcLocator *svcloc)
	Constructor.
virtual	~CommonAuditor ()
	Destructor.
virtual void	before (StandardEventType evt, const std::string &caller)
virtual void	before (StandardEventType evt, INamedInterface *caller)
	The following methods are meant to be implemented by the child class...
virtual void	before (CustomEventTypeRef evt, const std::string &caller)
virtual void	before (CustomEventTypeRef evt, INamedInterface *caller)
virtual void	after (StandardEventType evt, const std::string &caller, const StatusCode &sc)
virtual void	after (StandardEventType evt, INamedInterface *caller, const StatusCode &sc)
virtual void	after (CustomEventTypeRef evt, const std::string &caller, const StatusCode &sc)
virtual void	after (CustomEventTypeRef evt, INamedInterface *caller, const StatusCode &sc)
Public Member Functions inherited from Auditor
	Auditor (const std::string &name, ISvcLocator *svcloc)
	Constructor.
virtual	~Auditor ()
	Destructor.
StatusCode	sysInitialize ()
	Initialization method invoked by the framework.
StatusCode	sysFinalize ()
	Finalization method invoked by the framework.
virtual void	beforeInitialize (INamedInterface *)
virtual void	afterInitialize (INamedInterface *)
virtual void	beforeReinitialize (INamedInterface *)
virtual void	afterReinitialize (INamedInterface *)
virtual void	beforeExecute (INamedInterface *)
virtual void	afterExecute (INamedInterface *, const StatusCode &)
virtual void	beforeFinalize (INamedInterface *)
virtual void	afterFinalize (INamedInterface *)
virtual void	beforeBeginRun (INamedInterface *)
virtual void	afterBeginRun (INamedInterface *)
virtual void	beforeEndRun (INamedInterface *)
virtual void	afterEndRun (INamedInterface *)
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
virtual const std::string &	name () const
virtual bool	isEnabled () const
SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.
int	outputLevel () const
	Retrieve the output level of current auditor.
void	setOutputLevel (int level)
	Set the output level for current auditor.
SmartIF< ISvcLocator > &	serviceLocator () const
	The standard service locator.
template<class T >
StatusCode	service (const std::string &name, T *&svc, bool createIf=false) const
	Access a service by name, creating it if it doesn't already exist.
virtual StatusCode	setProperty (const Property &p)
	Set a value of a property of an auditor.
virtual StatusCode	setProperty (const std::string &s)
	Implementation of IProperty::setProperty.
virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Implementation of IProperty::setProperty.
virtual StatusCode	getProperty (Property *p) const
	Get the value of a property.
virtual const Property &	getProperty (const std::string &name) const
	Get the property by name.
virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Implementation of IProperty::getProperty.
const std::vector< Property * > &	getProperties () const
	Get all properties.
template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value
StatusCode	setProperties ()
	Set the auditor's properties.
template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property.

Protected Member Functions
virtual void	i_before (CustomEventTypeRef evt, const std::string &caller)
	Default (catch-all) "before" Auditor hook.
virtual void	i_after (CustomEventTypeRef evt, const std::string &caller, const StatusCode &sc)
	Default (catch-all) "after" Auditor hook.
virtual void	i_printinfo (const std::string &msg, CustomEventTypeRef evt, const std::string &caller)
	Report the memory usage.
Protected Member Functions inherited from CommonAuditor
bool	i_auditEventType (const std::string &evt)
	Check if we are requested to audit the passed event type.
void	i_updateCustomTypes (Property &)
	Update handler for the obsolete property CustomEventTypes.

Static Protected Member Functions
static bool	getProcInfo (procInfo &info)
	Get the process informations.

Additional Inherited Members
Public Types inherited from implements2< IAuditor, IProperty >
typedef implements2	base_class
	Typedef to this class.
typedef extend_interfaces2 < IAuditor, IProperty >	extend_interfaces_base
	Typedef to the base of this class.
typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces.
Protected Attributes inherited from CommonAuditor
StringArrayProperty	m_types
StringArrayProperty	m_customTypes

Detailed Description

Monitors the memory use of each algorithm.

Author

M. Shapiro, LBNL

Marco Clemencic

Definition at line 11 of file MemoryAuditor.h.

Constructor & Destructor Documentation

MemoryAuditor::MemoryAuditor	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Definition at line 16 of file MemoryAuditor.cpp.

: CommonAuditor(name, pSvcLocator) {
}

Member Function Documentation

static bool MemoryAuditor::getProcInfo ( procInfo &  info )

inlinestaticprotected

Get the process informations.

Returns true if it was possible to retrieve the informations.

Definition at line 27 of file MemoryAuditor.h.

                                                 {
    return ProcStats::instance()->fetch(info);
  }

void MemoryAuditor::i_after ( CustomEventTypeRef  evt, const std::string &  caller, const StatusCode &  sc  )

protectedvirtual

Default (catch-all) "after" Auditor hook.

Implements CommonAuditor.

Definition at line 24 of file MemoryAuditor.cpp.

                                                                                             {
  i_printinfo("Memory usage has changed after", evt, caller);
}

void MemoryAuditor::i_before ( CustomEventTypeRef  evt, const std::string &  caller  )

protectedvirtual

Default (catch-all) "before" Auditor hook.

Implements CommonAuditor.

Reimplemented in MemStatAuditor.

Definition at line 20 of file MemoryAuditor.cpp.

                                                                            {
  i_printinfo("Memory usage before", evt, caller);
}

void MemoryAuditor::i_printinfo ( const std::string &  msg, CustomEventTypeRef  evt, const std::string &  caller  )

protectedvirtual

Report the memory usage.

Reimplemented in MemStatAuditor.

Definition at line 28 of file MemoryAuditor.cpp.

{
   procInfo info;
   // The fetch method returns true if memory usage has changed...
   if(getProcInfo(info)) {
     MsgStream log(msgSvc(), name());
     log << MSG::INFO << msg << " " << caller << " " << evt <<
       " virtual size = " << info.vsize << " MB"  <<
       " resident set size = " << info.rss << " MB" << endmsg;
   }
}

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r7/GaudiAud/src/MemoryAuditor.h
• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r7/GaudiAud/src/MemoryAuditor.cpp