The Gaudi Framework  v30r3 (a5ef0a68)
Google::HeapChecker Class Reference

Auditor using the Google Heap Checker. More...

#include <GoogleAuditor.cpp>

Inheritance diagram for Google::HeapChecker:
Collaboration diagram for Google::HeapChecker:

Public Member Functions

StatusCode initialize () override
 Initialize the auditor base. More...
 
- Public Member Functions inherited from Google::AuditorBase
StatusCode finalize () override
 Finalize the auditor base. More...
 
void handle (const Incident &incident) override
 Implement the handle method for the Incident service. More...
 
void before (StandardEventType type, INamedInterface *i) override
 
void before (CustomEventTypeRef type, INamedInterface *i) override
 
void before (StandardEventType type, const std::string &s) override
 
void before (CustomEventTypeRef type, const std::string &s) override
 
void after (StandardEventType type, INamedInterface *i, const StatusCode &sc) override
 
void after (CustomEventTypeRef type, INamedInterface *i, const StatusCode &sc) override
 
void after (StandardEventType type, const std::string &s, const StatusCode &sc) override
 
void after (CustomEventTypeRef type, const std::string &s, const StatusCode &) override
 
void beforeInitialize (INamedInterface *i) override
 
void beforeReinitialize (INamedInterface *i) override
 
void beforeExecute (INamedInterface *i) override
 
void beforeBeginRun (INamedInterface *i) override
 
void beforeEndRun (INamedInterface *i) override
 
void beforeFinalize (INamedInterface *i) override
 
void afterInitialize (INamedInterface *i) override
 
void afterReinitialize (INamedInterface *i) override
 
void afterExecute (INamedInterface *i, const StatusCode &s) override
 
void afterBeginRun (INamedInterface *i) override
 
void afterEndRun (INamedInterface *i) override
 
void afterFinalize (INamedInterface *i) override
 
- Public Member Functions inherited from extends< Auditor, IIncidentListener >
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::stringgetInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
- Public Member Functions inherited from Auditor
 Auditor (const std::string &name, ISvcLocator *svcloc)
 Constructor. More...
 
 Auditor (const Auditor &a)=delete
 
Auditoroperator= (const Auditor &rhs)=delete
 
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
 
const std::stringname () const override
 
bool isEnabled () const override
 
SmartIF< ISvcLocator > & serviceLocator () const override
 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 setProperties ()
 Set the auditor's properties. More...
 
- Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
 PropertyHolder ()=default
 
Gaudi::Details::PropertyBasedeclareProperty (Gaudi::Details::PropertyBase &prop)
 Declare a property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
 Helper to wrap a regular data member and use it as a regular property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
 Declare a PropertyBase instance setting name and documentation. More...
 
Gaudi::Details::PropertyBasedeclareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
 Declare a remote property. More...
 
StatusCode setProperty (const Gaudi::Details::PropertyBase &p) override
 set the property form another property More...
 
StatusCode setProperty (const std::string &s) override
 set the property from the formatted string More...
 
StatusCode setProperty (const std::string &n, const std::string &v) override
 set the property from name and the value More...
 
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value More...
 
StatusCode getProperty (Gaudi::Details::PropertyBase *p) const override
 get the property More...
 
const Gaudi::Details::PropertyBasegetProperty (const std::string &name) const override
 get the property by name More...
 
StatusCode getProperty (const std::string &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 (const std::string &name) const override
 Return true if we have a property with the given name. More...
 
 PropertyHolder (const PropertyHolder &)=delete
 
PropertyHolderoperator= (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...
 
MSG::Level outputLevel () const
 Backward compatibility function for getting the output level. More...
 
- Public Member Functions inherited from CommonMessagingBase
virtual ~CommonMessagingBase ()=default
 Virtual destructor. More...
 
const SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () const
 shortcut for the method msgStream(MSG::INFO) More...
 

Protected Member Functions

void google_before (const std::string &s) override
 Start the google tool. More...
 
void google_after (const std::string &s) override
 stop the google tool More...
 
bool alreadyRunning () override
 check if we are already running the tool More...
 
- Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
Gaudi::Details::PropertyBaseproperty (const std::string &name) const
 
- 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...
 

Private Attributes

bool m_enabled = true
 
std::unique_ptr< HeapLeakChecker > m_checker
 

Additional Inherited Members

- Public Types inherited from extends< Auditor, IIncidentListener >
using base_class = extends
 Typedef to this class. More...
 
using extend_interfaces_base = extend_interfaces< Interfaces... >
 Typedef to the base of this class. More...
 
- Public Types inherited from 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 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...
 

Detailed Description

Auditor using the Google Heap Checker.

See

http://google-perftools.googlecode.com/svn/trunk/doc/heap_checker.html

For more details on usage.

Author
Chris Jones
Date
18/04/2011

Definition at line 334 of file GoogleAuditor.cpp.

Member Function Documentation

bool Google::HeapChecker::alreadyRunning ( )
inlineoverrideprotectedvirtual

check if we are already running the tool

Implements Google::AuditorBase.

Definition at line 378 of file GoogleAuditor.cpp.

378 { return m_enabled && m_checker; }
std::unique_ptr< HeapLeakChecker > m_checker
void Google::HeapChecker::google_after ( const std::string s)
inlineoverrideprotectedvirtual

stop the google tool

Implements Google::AuditorBase.

Definition at line 368 of file GoogleAuditor.cpp.

369  {
370  if ( m_enabled && m_checker ) {
371  if ( !m_checker->NoLeaks() ) {
372  warning() << "Leak detected for " << s << endmsg;
373  }
374  m_checker.reset();
375  }
376  }
std::unique_ptr< HeapLeakChecker > m_checker
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
T reset(T...args)
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
void Google::HeapChecker::google_before ( const std::string s)
inlineoverrideprotectedvirtual

Start the google tool.

Implements Google::AuditorBase.

Definition at line 361 of file GoogleAuditor.cpp.

362  {
363  if ( m_enabled && !m_checker ) {
364  m_checker.reset( new HeapLeakChecker( s.c_str() ) );
365  }
366  }
std::unique_ptr< HeapLeakChecker > m_checker
T reset(T...args)
T c_str(T...args)
StatusCode Google::HeapChecker::initialize ( )
inlineoverridevirtual

Initialize the auditor base.

Reimplemented from Google::AuditorBase.

Definition at line 341 of file GoogleAuditor.cpp.

342  {
343  const StatusCode sc = AuditorBase::initialize();
344  if ( sc.isFailure() ) return sc;
345 
346  const char* HEAPCHECK = getenv( "HEAPCHECK" );
347  if ( !HEAPCHECK ) {
348  fatal() << "Environment variable HEAPCHECK must be set to 'local'" << endmsg;
349  return StatusCode::FAILURE;
350  }
351  if ( std::string( HEAPCHECK ) != "local" ) {
352  warning() << "Environment variable HEAPCHECK is set to " << HEAPCHECK
353  << " Partial Program Heap Checking is disabled" << endmsg;
354  m_enabled = false;
355  }
356 
357  return sc;
358  }
constexpr static const auto FAILURE
Definition: StatusCode.h:88
bool isFailure() const
Definition: StatusCode.h:139
STL class.
T getenv(T...args)
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:51
StatusCode initialize() override
Initialize the auditor base.
MsgStream & fatal() const
shortcut for the method msgStream(MSG::FATAL)
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209

Member Data Documentation

std::unique_ptr<HeapLeakChecker> Google::HeapChecker::m_checker
private

Definition at line 382 of file GoogleAuditor.cpp.

bool Google::HeapChecker::m_enabled = true
private

Definition at line 381 of file GoogleAuditor.cpp.


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