MemStatAuditor Class Reference

Just a minor modification of MemoryAuditor to allow the output memory statistics table to be printed. More...

#include <GaudiAud/MemStatAudit.h>

Inheritance diagram for MemStatAuditor:
Collaboration diagram for MemStatAuditor:

Public Member Functions

 MemStatAuditor (const std::string &name, ISvcLocator *pSvcLocator)
 local More...
 
 ~MemStatAuditor () override=default
 
StatusCode initialize () override
 
- Public Member Functions inherited from MemoryAuditor
 MemoryAuditor (const std::string &name, ISvcLocator *pSvcLocator)
 
- Public Member Functions inherited from CommonAuditor
 CommonAuditor (const std::string &name, ISvcLocator *svcloc)
 Constructor. More...
 
virtual ~CommonAuditor ()=default
 Destructor. More...
 
virtual void before (StandardEventType evt, const std::string &caller)
 
virtual void before (StandardEventType evt, INamedInterface *caller)
 
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. More...
 
 ~Auditor () override=default
 Destructor. More...
 
StatusCode sysInitialize () override
 Initialization method invoked by the framework. More...
 
StatusCode sysFinalize () override
 Finalization method invoked by the framework. More...
 
void before (StandardEventType, INamedInterface *) override
 The following methods are meant to be implemented by the child class... More...
 
void before (StandardEventType, const std::string &) override
 
void before (CustomEventTypeRef, INamedInterface *) override
 
void before (CustomEventTypeRef, const std::string &) override
 
void after (StandardEventType, INamedInterface *, const StatusCode &) override
 
void after (StandardEventType, const std::string &, const StatusCode &) override
 
void after (CustomEventTypeRef, INamedInterface *, const StatusCode &) override
 
void after (CustomEventTypeRef, const std::string &, const StatusCode &) override
 
void beforeInitialize (INamedInterface *) override
 
void afterInitialize (INamedInterface *) override
 
void beforeReinitialize (INamedInterface *) override
 
void afterReinitialize (INamedInterface *) override
 
void beforeExecute (INamedInterface *) override
 
void afterExecute (INamedInterface *, const StatusCode &) override
 
void beforeFinalize (INamedInterface *) override
 
void afterFinalize (INamedInterface *) override
 
void beforeBeginRun (INamedInterface *) override
 
void afterBeginRun (INamedInterface *) override
 
void beforeEndRun (INamedInterface *) override
 
void afterEndRun (INamedInterface *) override
 
virtual StatusCode finalize ()
 
const std::string & name () const override
 
bool isEnabled () const override
 
SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
int outputLevel () const
 Retrieve the output level of current auditor. More...
 
void setOutputLevel (int level)
 Set the output level for current auditor. More...
 
SmartIF< ISvcLocator > & serviceLocator () const
 The standard service locator. More...
 
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. More...
 
template<class T = IService>
SmartIF< T > service (const std::string &name, bool createIf=false) const
 
StatusCode setProperty (const Property &p) override
 Set a value of a property of an auditor. More...
 
StatusCode setProperty (const std::string &s) override
 Implementation of IProperty::setProperty. More...
 
StatusCode setProperty (const std::string &n, const std::string &v) override
 Implementation of IProperty::setProperty. More...
 
StatusCode getProperty (Property *p) const override
 Get the value of a property. More...
 
const PropertygetProperty (const std::string &name) const override
 Get the property by name. More...
 
StatusCode getProperty (const std::string &n, std::string &v) const override
 Implementation of IProperty::getProperty. More...
 
const std::vector< Property * > & getProperties () const override
 Get all properties. More...
 
bool hasProperty (const std::string &name) const override
 Implementation of IProperty::hasProperty. More...
 
template<class TYPE >
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value More...
 
StatusCode setProperties ()
 Set the auditor's properties. More...
 
template<class T >
PropertydeclareProperty (const std::string &name, T &property, const std::string &doc="none") const
 Declare the named property. More...
 
 Auditor (const std::string &name, ISvcLocator *svcloc)
 Constructor. More...
 
 ~Auditor () override=default
 Destructor. More...
 
StatusCode sysInitialize () override
 Initialization method invoked by the framework. More...
 
StatusCode sysFinalize () override
 Finalization method invoked by the framework. More...
 
void before (StandardEventType, INamedInterface *) override
 The following methods are meant to be implemented by the child class... More...
 
void before (StandardEventType, const std::string &) override
 
void before (CustomEventTypeRef, INamedInterface *) override
 
void before (CustomEventTypeRef, const std::string &) override
 
void after (StandardEventType, INamedInterface *, const StatusCode &) override
 
void after (StandardEventType, const std::string &, const StatusCode &) override
 
void after (CustomEventTypeRef, INamedInterface *, const StatusCode &) override
 
void after (CustomEventTypeRef, const std::string &, const StatusCode &) override
 
void beforeInitialize (INamedInterface *) override
 
void afterInitialize (INamedInterface *) override
 
void beforeReinitialize (INamedInterface *) override
 
void afterReinitialize (INamedInterface *) override
 
void beforeExecute (INamedInterface *) override
 
void afterExecute (INamedInterface *, const StatusCode &) override
 
void beforeFinalize (INamedInterface *) override
 
void afterFinalize (INamedInterface *) override
 
void beforeBeginRun (INamedInterface *) override
 
void afterBeginRun (INamedInterface *) override
 
void beforeEndRun (INamedInterface *) override
 
void afterEndRun (INamedInterface *) override
 
virtual StatusCode finalize ()
 
const std::string & name () const override
 
bool isEnabled () const override
 
SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
int outputLevel () const
 Retrieve the output level of current auditor. More...
 
void setOutputLevel (int level)
 Set the output level for current auditor. More...
 
SmartIF< ISvcLocator > & serviceLocator () const
 The standard service locator. More...
 
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. More...
 
template<class T = IService>
SmartIF< T > service (const std::string &name, bool createIf=false) const
 
StatusCode setProperty (const Property &p) override
 Set a value of a property of an auditor. More...
 
StatusCode setProperty (const std::string &s) override
 Implementation of IProperty::setProperty. More...
 
StatusCode setProperty (const std::string &n, const std::string &v) override
 Implementation of IProperty::setProperty. More...
 
StatusCode getProperty (Property *p) const override
 Get the value of a property. More...
 
const PropertygetProperty (const std::string &name) const override
 Get the property by name. More...
 
StatusCode getProperty (const std::string &n, std::string &v) const override
 Implementation of IProperty::getProperty. More...
 
const std::vector< Property * > & getProperties () const override
 Get all properties. More...
 
bool hasProperty (const std::string &name) const override
 Implementation of IProperty::hasProperty. More...
 
template<class TYPE >
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value More...
 
StatusCode setProperties ()
 Set the auditor's properties. More...
 
template<class T >
PropertydeclareProperty (const std::string &name, T &property, const std::string &doc="none") const
 Declare the named property. More...
 
- Public Member Functions inherited from implements< Interfaces >
void * i_cast (const InterfaceID &tid) const override
 Implementation of IInterface::i_cast. More...
 
StatusCode queryInterface (const InterfaceID &ti, void **pp) override
 Implementation of IInterface::queryInterface. More...
 
std::vector< std::string > getInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
 implements ()=default
 Default constructor. More...
 
 implements (const implements &)
 Copy constructor (zero the reference count) More...
 
implementsoperator= (const implements &)
 Assignment operator (do not touch the reference count). More...
 
 ~implements () override=default
 Virtual destructor. More...
 
unsigned long addRef () override
 Reference Interface instance. More...
 
unsigned long release () override
 Release Interface instance. More...
 
unsigned long refCount () const override
 Current reference count. More...
 
void * i_cast (const InterfaceID &tid) const override
 Implementation of IInterface::i_cast. More...
 
StatusCode queryInterface (const InterfaceID &ti, void **pp) override
 Implementation of IInterface::queryInterface. More...
 
std::vector< std::string > getInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
 implements ()=default
 Default constructor. More...
 
 implements (const implements &)
 Copy constructor (zero the reference count) More...
 
implementsoperator= (const implements &)
 Assignment operator (do not touch the reference count). More...
 
 ~implements () override=default
 Virtual destructor. More...
 
unsigned long addRef () override
 Reference Interface instance. More...
 
unsigned long release () override
 Release Interface instance. More...
 
unsigned long refCount () const override
 Current reference count. More...
 
- Public Member Functions inherited from extend_interfaces< Interfaces...>
 ~extend_interfaces () override=default
 Virtual destructor. More...
 
 ~extend_interfaces () override=default
 Virtual destructor. More...
 

Private Member Functions

void i_before (CustomEventTypeRef evt, const std::string &caller) override
 Re-implement i_before to avoid monitoring the memory usage before a function. More...
 
void i_printinfo (const std::string &msg, CustomEventTypeRef evt, const std::string &caller) override
 Report the memory usage. More...
 
SmartIF< IChronoStatSvc > & statSvc ()
 

Private Attributes

SmartIF< IChronoStatSvcm_stat
 
double m_vSize = -1
 vsize of the previous call to printinfo More...
 

Additional Inherited Members

- Public Types inherited from Auditor
typedef Gaudi::PluginService::Factory< IAuditor *, const std::string &, ISvcLocator * > Factory
 
typedef Gaudi::PluginService::Factory< IAuditor *, const std::string &, ISvcLocator * > Factory
 
- Public Types inherited from implements< Interfaces >
using base_class = implements< Interfaces...>
 Typedef to this class. More...
 
using extend_interfaces_base = extend_interfaces< Interfaces...>
 Typedef to the base of this class. More...
 
using iids = typename extend_interfaces_base::ext_iids
 
using base_class = implements< Interfaces...>
 Typedef to this class. More...
 
using extend_interfaces_base = extend_interfaces< Interfaces...>
 Typedef to the base of this class. More...
 
using iids = typename extend_interfaces_base::ext_iids
 
- Public Types inherited from extend_interfaces< Interfaces...>
using ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
 take union of the ext_iids of all Interfaces... More...
 
using ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
 take union of the ext_iids of all Interfaces... More...
 
- Protected Member Functions inherited from MemoryAuditor
virtual void i_after (CustomEventTypeRef evt, const std::string &caller, const StatusCode &sc)
 Default (catch-all) "after" Auditor hook. More...
 
- Protected Member Functions inherited from CommonAuditor
bool i_auditEventType (const std::string &evt)
 Check if we are requested to audit the passed event type. More...
 
void i_updateCustomTypes (Property &)
 Update handler for the obsolete property CustomEventTypes. More...
 
- Static Protected Member Functions inherited from MemoryAuditor
static bool getProcInfo (procInfo &info)
 Get the process informations. More...
 
- Protected Attributes inherited from CommonAuditor
StringArrayProperty m_types
 
StringArrayProperty m_customTypes
 
- Protected Attributes inherited from implements< Interfaces >
std::atomic_ulong m_refCount = {0}
 Reference counter. More...
 

Detailed Description

Just a minor modification of MemoryAuditor to allow the output memory statistics table to be printed.

Author
Vanya Belyaev
Marco Clemencic
Date
04/02/2001

Definition at line 15 of file MemStatAuditor.h.

Constructor & Destructor Documentation

MemStatAuditor::MemStatAuditor ( const std::string &  name,
ISvcLocator pSvcLocator 
)

local

Definition at line 18 of file MemStatAuditor.cpp.

18  :
19  MemoryAuditor(name, pSvcLocator)
20 {
21 }
const std::string & name() const override
Definition: Auditor.cpp:212
MemoryAuditor(const std::string &name, ISvcLocator *pSvcLocator)
MemStatAuditor::~MemStatAuditor ( )
overridedefault

Member Function Documentation

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

Re-implement i_before to avoid monitoring the memory usage before a function.

Reimplemented from MemoryAuditor.

Definition at line 36 of file MemStatAuditor.cpp.

36  {
37  // It's not interesting to monitor the memory usage before the methods.
38 }
void MemStatAuditor::i_printinfo ( const std::string &  msg,
CustomEventTypeRef  evt,
const std::string &  caller 
)
overrideprivatevirtual

Report the memory usage.

Reimplemented from MemoryAuditor.

Definition at line 40 of file MemStatAuditor.cpp.

40  {
41  // cannot be exactly 0
42  double deltaVSize = 0.00001;
43 
44  procInfo info;
45  if (getProcInfo(info)) {
46  MsgStream log(msgSvc(), name());
47 
48  if (info.vsize > 0) {
49  if (m_vSize > 0){
50  deltaVSize = info.vsize - m_vSize;
51  }
52  // store the current VSize to be able to monitor the increment
53  m_vSize = info.vsize;
54  }
55 
56  log << MSG::INFO << msg << " " << caller << " " << evt <<
57  " \tvirtual size = " << info.vsize << " MB" <<
58  " \tresident set size = " << info.rss << " MB" <<
59  " deltaVsize = " << deltaVSize << " MB" << endmsg;
60  }
61  // fill the stat for every call, not just when there is a change
62  // only monitor the increment in VSize
63  // Stat stv(statSvc(), caller + ":VMemUsage", info.vsize);
64  // Stat str(statSvc(), caller + ":RMemUsage", info.rss);
65  Stat sts(statSvc(), caller + ":VMem", deltaVSize);
66 }
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
Definition: Auditor.cpp:220
Small wrapper class for easy manipulation with generic counters and IStatSvc&ICounterSvc interface...
Definition: Stat.h:46
double rss
Definition: ProcStats.h:38
double m_vSize
vsize of the previous call to printinfo
static bool getProcInfo(procInfo &info)
Get the process informations.
Definition: MemoryAuditor.h:27
const std::string & name() const override
Definition: Auditor.cpp:212
double vsize
Definition: ProcStats.h:37
SmartIF< IChronoStatSvc > & statSvc()
StatusCode MemStatAuditor::initialize ( )
overridevirtual

Reimplemented from Auditor.

Definition at line 23 of file MemStatAuditor.cpp.

23  {
25  if (UNLIKELY(sc.isFailure())) return sc;
26 
27  m_stat = serviceLocator()->service("ChronoStatSvc");
28  if (UNLIKELY(!m_stat.get())) {
29  MsgStream log(msgSvc(), name());
30  log << MSG::ERROR << "Cannot get ChronoStatSvc" << endmsg;
31  return StatusCode::FAILURE;
32  }
33  return StatusCode::SUCCESS;
34 }
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
Definition: Auditor.cpp:220
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:86
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:76
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:78
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
SmartIF< ISvcLocator > & serviceLocator() const
The standard service locator.
Definition: Auditor.cpp:228
SmartIF< IChronoStatSvc > m_stat
const std::string & name() const override
Definition: Auditor.cpp:212
#define UNLIKELY(x)
Definition: Kernel.h:126
virtual StatusCode initialize()
Definition: Auditor.cpp:91
SmartIF<IChronoStatSvc>& MemStatAuditor::statSvc ( )
inlineprivate

Definition at line 27 of file MemStatAuditor.h.

27 { return m_stat; }
SmartIF< IChronoStatSvc > m_stat

Member Data Documentation

SmartIF<IChronoStatSvc> MemStatAuditor::m_stat
private

Definition at line 28 of file MemStatAuditor.h.

double MemStatAuditor::m_vSize = -1
private

vsize of the previous call to printinfo

Definition at line 31 of file MemStatAuditor.h.


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