Auditor using the Google Heap Checker. More...

#include <GoogleAuditor.cpp>

Inheritance diagram for Google::HeapChecker:

Collaboration diagram for Google::HeapChecker:

Public Member Functions
	HeapChecker (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor. More...

virtual	~HeapChecker ()

StatusCode	initialize ()
	Initialize the auditor base. More...

Public Member Functions inherited from Google::AuditorBase
	AuditorBase (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor. More...

virtual	~AuditorBase ()
	Destructor. More...

StatusCode	finalize ()
	Finalize the auditor base. More...

void	handle (const Incident &incident)
	Implement the handle method for the Incident service. More...

void	before (StandardEventType type, INamedInterface *i)
	The following methods are meant to be implemented by the child class... More...

void	before (CustomEventTypeRef type, INamedInterface *i)
	Audit the start of a custom "event". More...

void	before (StandardEventType type, const std::string &s)
	Audit the start of a standard "event" for callers that do not implement INamedInterface. More...

void	before (CustomEventTypeRef type, const std::string &s)
	Audit the start of a custom "event" for callers that do not implement INamedInterface. More...

void	after (StandardEventType type, INamedInterface *i, const StatusCode &sc)
	Audit the end of a standard "event". More...

void	after (CustomEventTypeRef type, INamedInterface *i, const StatusCode &sc)
	Audit the end of a custom "event". More...

void	after (StandardEventType type, const std::string &s, const StatusCode &sc)
	Audit the end of a standard "event" for callers that do not implement INamedInterface. More...

void	after (CustomEventTypeRef type, const std::string &s, const StatusCode &)
	Audit the end of a custom "event" for callers that do not implement INamedInterface. More...

void	beforeInitialize (INamedInterface *i)

void	beforeReinitialize (INamedInterface *i)

void	beforeExecute (INamedInterface *i)

void	beforeBeginRun (INamedInterface *i)

void	beforeEndRun (INamedInterface *i)

void	beforeFinalize (INamedInterface *i)

void	afterInitialize (INamedInterface *i)

void	afterReinitialize (INamedInterface *i)

void	afterExecute (INamedInterface *i, const StatusCode &s)

void	afterBeginRun (INamedInterface *i)

void	afterEndRun (INamedInterface *i)

void	afterFinalize (INamedInterface *i)

Public Member Functions inherited from extends1< Auditor, IIncidentListener >
	extends1 (A1 a1, A2 a2, A3 a3)
	Templated constructor with 3 arguments. More...

	extends1 (A1 a1, A2 a2)
	Templated constructor with 2 arguments. More...

	extends1 (A1 a1)
	Templated constructor with 1 argument. More...

	extends1 ()
	Default constructor. More...

	extends1 (A1 a1, A2 a2, A3 a3)
	Templated constructor with 3 arguments. More...

	extends1 (A1 a1, A2 a2)
	Templated constructor with 2 arguments. More...

	extends1 (A1 a1)
	Templated constructor with 1 argument. More...

	extends1 ()
	Default constructor. More...

virtual void *	i_cast (const InterfaceID &tid) const
	Implementation of IInterface::i_cast. More...

virtual void *	i_cast (const InterfaceID &tid) const
	Implementation of IInterface::i_cast. More...

virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)
	Implementation of IInterface::queryInterface. More...

virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)
	Implementation of IInterface::queryInterface. More...

virtual std::vector< std::string >	getInterfaceNames () const
	Implementation of IInterface::getInterfaceNames. More...

virtual std::vector< std::string >	getInterfaceNames () const
	Implementation of IInterface::getInterfaceNames. More...

virtual	~extends1 ()
	Virtual destructor. More...

virtual	~extends1 ()
	Virtual destructor. More...

Public Member Functions inherited from Auditor
	Auditor (const std::string &name, ISvcLocator *svcloc)
	Constructor. More...

virtual	~Auditor ()
	Destructor. More...

StatusCode	sysInitialize ()
	Initialization method invoked by the framework. More...

StatusCode	sysFinalize ()
	Finalization method invoked by the framework. More...

virtual const std::string &	name () const
	Retrieve the name of the instance. More...

virtual bool	isEnabled () const
	Tell if the auditor is enabled or not. More...

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...

virtual StatusCode	setProperty (const Property &p)
	Set a value of a property of an auditor. More...

virtual StatusCode	setProperty (const std::string &s)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	getProperty (Property *p) const
	Get the value of a property. More...

virtual const Property &	getProperty (const std::string &name) const
	Get the property by name. More...

virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Implementation of IProperty::getProperty. More...

const std::vector< Property * > &	getProperties () const
	Get all properties. More...

virtual bool	hasProperty (const std::string &name) const
	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 >
Property *	declareProperty (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...

virtual	~Auditor ()
	Destructor. More...

StatusCode	sysInitialize ()
	Initialization method invoked by the framework. More...

StatusCode	sysFinalize ()
	Finalization method invoked by the framework. More...

virtual const std::string &	name () const
	Retrieve the name of the instance. More...

virtual bool	isEnabled () const
	Tell if the auditor is enabled or not. More...

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...

virtual StatusCode	setProperty (const Property &p)
	Set a value of a property of an auditor. More...

virtual StatusCode	setProperty (const std::string &s)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	getProperty (Property *p) const
	Get the value of a property. More...

virtual const Property &	getProperty (const std::string &name) const
	Get the property by name. More...

virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Implementation of IProperty::getProperty. More...

const std::vector< Property * > &	getProperties () const
	Get all properties. More...

virtual bool	hasProperty (const std::string &name) const
	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 >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Public Member Functions inherited from extend_interfaces2< IAuditor, IProperty >
virtual	~extend_interfaces2 ()
	Virtual destructor. More...

virtual	~extend_interfaces2 ()
	Virtual destructor. More...

Public Member Functions inherited from IAuditor
	DeclareInterfaceID (IAuditor, 3, 0)
	InterfaceID. More...

	DeclareInterfaceID (IAuditor, 3, 0)
	InterfaceID. More...

Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID. More...

virtual	~INamedInterface ()
	Virtual destructor (always needed for abstract classes). More...

	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID. More...

virtual	~INamedInterface ()
	Virtual destructor (always needed for abstract classes). More...

Public Member Functions inherited from IInterface
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...

virtual unsigned long	release ()=0
	Release Interface instance. More...

virtual unsigned long	refCount () const =0
	Current reference count. More...

virtual	~IInterface ()
	Virtual destructor. More...

virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...

virtual unsigned long	release ()=0
	Release Interface instance. More...

virtual unsigned long	refCount () const =0
	Current reference count. More...

virtual	~IInterface ()
	Virtual destructor. More...

Public Member Functions inherited from IProperty
	DeclareInterfaceID (IProperty, 2, 1)
	InterfaceID. More...

	DeclareInterfaceID (IProperty, 2, 1)
	InterfaceID. More...

Public Member Functions inherited from extend_interfaces1< IIncidentListener >
virtual	~extend_interfaces1 ()
	Virtual destructor. More...

virtual	~extend_interfaces1 ()
	Virtual destructor. More...

Public Member Functions inherited from IIncidentListener
	DeclareInterfaceID (IIncidentListener, 2, 0)
	InterfaceID. More...

	DeclareInterfaceID (IIncidentListener, 2, 0)
	InterfaceID. More...

Protected Member Functions
void	google_before (const std::string &s)
	Start the google tool. More...

void	google_after (const std::string &s)
	stop the google tool More...

bool	alreadyRunning ()
	check if we are already running the tool More...

Private Attributes
bool	m_enabled

HeapLeakChecker *	m_checker

Additional Inherited Members
Public Types inherited from extends1< Auditor, IIncidentListener >
typedef extends1	base_class
	Typedef to this class. More...

typedef extends1	base_class
	Typedef to this class. More...

typedef extend_interfaces1< IIncidentListener >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces1< IIncidentListener >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

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 implements2< IAuditor, IProperty >
typedef implements2	base_class
	Typedef to this class. More...

typedef implements2	base_class
	Typedef to this class. More...

typedef extend_interfaces2< IAuditor, IProperty >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces2< IAuditor, IProperty >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

Public Types inherited from extend_interfaces2< IAuditor, IProperty >
typedef mpl::fold< typename IAuditor::iid::iids::type, typename IProperty::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...

typedef mpl::fold< typename IAuditor::iid::iids::type, typename IProperty::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...

Public Types inherited from IAuditor
enum	StandardEventType { Initialize, ReInitialize, Execute, BeginRun, EndRun, Finalize, Start, Stop, ReStart, Initialize, ReInitialize, Execute, BeginRun, EndRun, Finalize, Start, Stop, ReStart }
	Defines the standard (= used by the framework) auditable event types. More...

enum	StandardEventType { Initialize, ReInitialize, Execute, BeginRun, EndRun, Finalize, Start, Stop, ReStart, Initialize, ReInitialize, Execute, BeginRun, EndRun, Finalize, Start, Stop, ReStart }
	Defines the standard (= used by the framework) auditable event types. More...

typedef std::string	CustomEventType
	Type used to allow users to specify a custom event to be audit. More...

typedef const CustomEventType &	CustomEventTypeRef
	Used in function calls for optimization purposes. More...

typedef std::string	CustomEventType
	Type used to allow users to specify a custom event to be audit. More...

typedef const CustomEventType &	CustomEventTypeRef
	Used in function calls for optimization purposes. More...

Public Types inherited from IInterface
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR, SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...

enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR, SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...

typedef Gaudi::InterfaceId< IInterface, 0, 0 >	iid
	Interface ID. More...

typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...

typedef Gaudi::InterfaceId< IInterface, 0, 0 >	iid
	Interface ID. More...

typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...

Public Types inherited from extend_interfaces1< IIncidentListener >
typedef IIncidentListener::iid::iids::type	ext_iids
	MPL set of interfaces extended by this one. More...

typedef IIncidentListener::iid::iids::type	ext_iids
	MPL set of interfaces extended by this one. More...

Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

Protected Attributes inherited from Google::AuditorBase
MsgStream	m_log
	Messaging object. 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 421 of file GoogleAuditor.cpp.

Constructor & Destructor Documentation

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

inline

Constructor.

Definition at line 427 of file GoogleAuditor.cpp.

       : AuditorBase ( name, pSvcLocator ),
         m_enabled   ( true ),
         m_checker   ( NULL )
     { }

virtual Google::HeapChecker::~HeapChecker ( )

inlinevirtual

Definition at line 433 of file GoogleAuditor.cpp.

433 { delete m_checker; }

Google::HeapChecker::m_checker

HeapLeakChecker * m_checker

Definition: GoogleAuditor.cpp:490

Member Function Documentation

bool Google::HeapChecker::alreadyRunning ( )

inlineprotectedvirtual

check if we are already running the tool

Implements Google::AuditorBase.

Definition at line 485 of file GoogleAuditor.cpp.

485 { return m_enabled && m_checker != NULL ; }

Google::HeapChecker::m_checker

HeapLeakChecker * m_checker

Definition: GoogleAuditor.cpp:490

Google::HeapChecker::m_enabled

bool m_enabled

Definition: GoogleAuditor.cpp:489

void Google::HeapChecker::google_after ( const std::string & s )

inlineprotectedvirtual

stop the google tool

Implements Google::AuditorBase.

Definition at line 472 of file GoogleAuditor.cpp.

     {
       if ( m_enabled && m_checker )
       {
         if ( ! m_checker->NoLeaks() )
         {
           m_log << MSG::WARNING << "Leak detected for " << s << endmsg;
         }
         delete m_checker;
         m_checker = NULL;
       }
     }

void Google::HeapChecker::google_before ( const std::string & s )

inlineprotectedvirtual

Start the google tool.

Implements Google::AuditorBase.

Definition at line 464 of file GoogleAuditor.cpp.

     {
       if ( m_enabled && !m_checker )
       {
         m_checker = new HeapLeakChecker(s.c_str());
       }
     }

StatusCode Google::HeapChecker::initialize ( )

inlinevirtual

Initialize the auditor base.

Reimplemented from Google::AuditorBase.

Definition at line 437 of file GoogleAuditor.cpp.

     {
       const StatusCode sc = AuditorBase::initialize();
       if ( sc.isFailure() ) return sc;
 
       const char * HEAPCHECK = getenv("HEAPCHECK");
       if ( !HEAPCHECK )
       {
         m_log << MSG::FATAL
               << "Environment variable HEAPCHECK must be set to 'local'"
               << endmsg;
         return StatusCode::FAILURE;
       }
       if ( std::string(HEAPCHECK) != "local" )
       {
         m_log << MSG::WARNING
               << "Environment variable HEAPCHECK is set to " << HEAPCHECK
               << " Partial Program Heap Checking is disabled"
               << endmsg;
         m_enabled = false;
       }
 
       return sc;
     }

Member Data Documentation

HeapLeakChecker* Google::HeapChecker::m_checker

private

Definition at line 490 of file GoogleAuditor.cpp.

bool Google::HeapChecker::m_enabled

private

Definition at line 489 of file GoogleAuditor.cpp.

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

GaudiProfiling/src/component/google/GoogleAuditor.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation