MemoryAuditor Class Reference

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

Inheritance diagram for MemoryAuditor:

Collaboration diagram for MemoryAuditor:

Protected Member Functions
void	before (std::string const &evt, std::string const &, EventContext const &) override
	Default (catch-all) "before" Auditor hook. More...
void	after (std::string const &evt, std::string const &caller, EventContext const &, const StatusCode &sc) override
	Default (catch-all) "after" Auditor hook. More...
virtual void	i_printinfo (std::string_view msg, std::string const &evt, std::string_view caller)
	Report the memory usage. More...
Protected Member Functions inherited from CommonMessaging< implements< IAuditor, IProperty > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...
MSG::Level	resetMessaging ()
	Reinitialize internal states. More...
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Additional Inherited Members
Public Types inherited from Gaudi::Auditor
using	Factory = Gaudi::PluginService::Factory< IAuditor *(const std::string &, ISvcLocator *)>
Public Types inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
	Typedef used to refer to this class from derived classes, as in. More...
Public Types inherited from CommonMessaging< implements< IAuditor, IProperty > >
using	base_class = CommonMessaging
Public Member Functions inherited from Gaudi::Auditor
	Auditor (std::string name, ISvcLocator *svcloc)
	Auditor (const Auditor &a)=delete
Auditor &	operator= (const Auditor &rhs)=delete
StatusCode	sysInitialize () override
StatusCode	sysFinalize () override
void	before (std::string const &, std::string const &, EventContext const &) override
void	after (std::string const &, std::string const &, EventContext const &, StatusCode const &=StatusCode::SUCCESS) override
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
const std::string &	name () const override
bool	isEnabled () const override
SmartIF< ISvcLocator > &	serviceLocator () const override
	The standard service locator. More...
template<class T = IService>
SmartIF< T >	service (std::string_view name, bool createIf=false) const
	Access a service by name, creating it if it doesn't already exist. More...
Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
	PropertyHolder ()=default
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...
	requires (!Gaudi::Details::is_gaudi_property_v< TYPE >) Gaudi
	Helper to wrap a regular data member and use it as a regular property. More...
Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...
StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name More...
StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property. More...
virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...
virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...
StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals. More...
StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string. More...
StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation More...
StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...
const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name More...
StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string More...
const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...
bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name. More...
Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected More...
void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)
	PropertyHolder (const PropertyHolder &)=delete
PropertyHolder &	operator= (const PropertyHolder &)=delete
Public Member Functions inherited from CommonMessaging< implements< IAuditor, IProperty > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Detailed Description

Monitors the memory use of each algorithm.

Author

M. Shapiro, LBNL

Marco Clemencic

Definition at line 22 of file MemoryAuditor.cpp.

Member Function Documentation

after()

void MemoryAuditor::after ( std::string const &  evt, std::string const &  caller, EventContext const &  , const StatusCode &  sc  )

overrideprotected

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

Definition at line 43 of file MemoryAuditor.cpp.

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

before()

void MemoryAuditor::before ( std::string const &  evt, std::string const &  caller, EventContext const &    )

overrideprotected

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

Definition at line 39 of file MemoryAuditor.cpp.

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

i_printinfo()

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

protectedvirtual

Report the memory usage.

Get the process informations. fetch true if it was possible to retrieve the informations.

Definition at line 47 of file MemoryAuditor.cpp.

                                                                                                 {
  if ( procInfo pInfo; ProcStats::instance()->fetch( pInfo ) ) {
    if ( pInfo.vsize > 0 ) {
      info() << msg << " " << caller << " " << evt << " virtual size = " << pInfo.vsize << " MB"
             << " resident set size = " << pInfo.rss << " MB" << endmsg;
    }
  }
}

---

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

• GaudiAud/src/MemoryAuditor.cpp