#include <GoogleAuditor.cpp>

Inheritance diagram for Google::AuditorBase:

[legend]

Collaboration diagram for Google::AuditorBase:

[legend]

Public Member Functions
StatusCode	initialize () override
	Initialize the auditor base. More...

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

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::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

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

	Auditor (const Auditor &a)=delete

Auditor &	operator= (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

const std::string &	name () const override

bool	isEnabled () const override

SmartIF< ISvcLocator > &	serviceLocator () const override
	The standard service locator. More...

template<class T >
StatusCode	service (std::string_view 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 (std::string_view name, bool createIf=false) const

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, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular 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...

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	setProperty (const std::string &name, const TYPE &value)
	set the property form the value 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...

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

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

virtual bool	alreadyRunning ()=0
	check if we are already running the tool 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...

Private Member Functions
void	startAudit ()
	Start a full event audit. More...

void	stopAudit ()
	stop a full event audit More...

bool	isSequencer (INamedInterface *i) const

bool	isPhaseEnabled (CustomEventTypeRef type) const
	Check if auditing is enabled for the current processing phase. More...

bool	isComponentEnabled (std::string_view name) const
	Check if auditing is enabled for the given component. More...

std::string	getDumpName (CustomEventTypeRef type, std::string_view name) const

Private Attributes
Gaudi::Property< std::vector< std::string > >	m_when

Gaudi::Property< std::vector< std::string > >	m_veto

Gaudi::Property< std::vector< std::string > >	m_list

Gaudi::Property< int >	m_freq { this, "ProfileFreq", -1, "The frequence to audit events. -1 means all events" }

Gaudi::Property< bool >	m_fullEventAudit

Gaudi::Property< unsigned long long >	m_nSampleEvents

Gaudi::Property< unsigned long long >	m_eventsToSkip

Gaudi::Property< bool >	m_skipSequencers

bool	m_audit = true
	Internal flag to say if auditing is enabled or not for the current event. More...

unsigned long long	m_nEvts = 0
	Number of events processed. More...

unsigned long long	m_sampleEventCount
	Internal count of the number of events currently processed during an audit. More...

bool	m_inFullAudit = false
	Internal flag to indicate if we are current in a full event audit. More...

std::string	m_startedBy
	Name of the component we are currently auditing. More...

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

Base for Google Auditors

Author: Chris Jones

Date: 18/04/2011

Definition at line 37 of file GoogleAuditor.cpp.

Member Function Documentation

◆ after() [1/4]

void Google::AuditorBase::after	(	CustomEventTypeRef	type,
		const std::string &	s,
		const StatusCode &
	)

inlineoverride

Definition at line 181 of file GoogleAuditor.cpp.

                                                                                           {
       if ( !m_fullEventAudit && m_audit && isPhaseEnabled( type ) && isComponentEnabled( s ) ) {
         if ( s == m_startedBy ) { google_after( getDumpName( type, s ) ); }
       }
     }

◆ after() [2/4]

void Google::AuditorBase::after	(	CustomEventTypeRef	type,
		INamedInterface *	i,
		const StatusCode &	sc
	)

inlineoverride

Definition at line 171 of file GoogleAuditor.cpp.

                                                                                              {
       if ( !m_skipSequencers || !isSequencer( i ) ) { after( type, i->name(), sc ); }
     }

◆ after() [3/4]

void Google::AuditorBase::after	(	StandardEventType	type,
		const std::string &	s,
		const StatusCode &	sc
	)

inlineoverride

Definition at line 175 of file GoogleAuditor.cpp.

                                                                                             {
       std::ostringstream t;
       t << type;
       after( t.str(), s, sc );
     }

◆ after() [4/4]

void Google::AuditorBase::after	(	StandardEventType	type,
		INamedInterface *	i,
		const StatusCode &	sc
	)

inlineoverride

Definition at line 163 of file GoogleAuditor.cpp.

                                                                                             {
       if ( !m_skipSequencers || !isSequencer( i ) ) {
         std::ostringstream t;
         t << type;
         after( t.str(), i, sc );
       }
     }

◆ alreadyRunning()

virtual bool Google::AuditorBase::alreadyRunning ( )

protectedpure virtual

check if we are already running the tool

Implemented in Google::CPUProfiler, Google::HeapChecker, and Google::HeapProfiler.

◆ before() [1/4]

void Google::AuditorBase::before	(	CustomEventTypeRef	type,
		const std::string &	s
	)

inlineoverride

Definition at line 151 of file GoogleAuditor.cpp.

                                                                         {
       if ( !m_fullEventAudit && m_audit && isPhaseEnabled( type ) && isComponentEnabled( s ) ) {
         if ( !alreadyRunning() ) {
           info() << "Starting Auditor for " << s << ":" << type << endmsg;
           m_startedBy = s;
           google_before( getDumpName( type, s ) );
         } else {
           warning() << "Auditor already running. Cannot be started for " << s << endmsg;
         }
       }
     }

◆ before() [2/4]

void Google::AuditorBase::before	(	CustomEventTypeRef	type,
		INamedInterface *	i
	)

inlineoverride

Definition at line 141 of file GoogleAuditor.cpp.

                                                                         {
       if ( !m_skipSequencers || !isSequencer( i ) ) { before( type, i->name() ); }
     }

◆ before() [3/4]

void Google::AuditorBase::before	(	StandardEventType	type,
		const std::string &	s
	)

inlineoverride

Definition at line 145 of file GoogleAuditor.cpp.

                                                                        {
       std::ostringstream t;
       t << type;
       before( t.str(), s );
     }

◆ before() [4/4]

void Google::AuditorBase::before	(	StandardEventType	type,
		INamedInterface *	i
	)

inlineoverride

Definition at line 137 of file GoogleAuditor.cpp.

                                                                        {
       if ( !m_skipSequencers || !isSequencer( i ) ) { before( type, i->name() ); }
     }

◆ finalize()

StatusCode Google::AuditorBase::finalize ( )

inlineoverridevirtual

Finalize the auditor base.

Reimplemented from Auditor.

Definition at line 61 of file GoogleAuditor.cpp.

                                    {
       if ( alreadyRunning() ) stopAudit();
       return StatusCode::SUCCESS;
     }

◆ getDumpName()

std::string Google::AuditorBase::getDumpName	(	CustomEventTypeRef	type,
		std::string_view	name
	)		const

inlineprivate

Definition at line 105 of file GoogleAuditor.cpp.

                                                                                 {
       std::ostringstream t;
       t << name << "-" << type;
       if ( type == "Execute" ) t << "-Event" << m_nEvts;
       return t.str();
     }

◆ google_after()

virtual void Google::AuditorBase::google_after ( const std::string & s )

protectedpure virtual

stop the google tool

Implemented in Google::HeapChecker, Google::HeapProfiler, and Google::CPUProfiler.

◆ google_before()

virtual void Google::AuditorBase::google_before ( const std::string & s )

protectedpure virtual

Start the google tool.

Implemented in Google::CPUProfiler, Google::HeapChecker, and Google::HeapProfiler.

◆ handle()

void Google::AuditorBase::handle ( const Incident & incident )

inlineoverride

Implement the handle method for the Incident service.

This is used to inform the tool of software incidents.

Parameters

incident The incident identifier

Definition at line 118 of file GoogleAuditor.cpp.

                                                      {
       if ( IncidentType::BeginEvent == incident.type() ) {
         ++m_nEvts;
         m_audit = ( m_nEvts > m_eventsToSkip && ( m_freq < 0 || m_nEvts == 1 || m_nEvts % m_freq == 0 ) );
         if ( msgLevel( MSG::DEBUG ) ) debug() << "Event " << m_nEvts << " Audit=" << m_audit << endmsg;
         if ( m_fullEventAudit ) {
           if ( m_inFullAudit ) {
             if ( m_sampleEventCount >= m_nSampleEvents && alreadyRunning() ) {
               stopAudit();
             } else {
               ++m_sampleEventCount;
             }
           }
           if ( m_audit && !m_inFullAudit && !alreadyRunning() ) { startAudit(); }
         }
       }
     }

◆ initialize()

StatusCode Google::AuditorBase::initialize ( )

inlineoverridevirtual

Initialize the auditor base.

Reimplemented from Auditor.

Reimplemented in Google::HeapChecker.

Definition at line 44 of file GoogleAuditor.cpp.

                                      {
       info() << "Initialised" << endmsg;
  
       // add a listener for begin event
       auto inSvc = serviceLocator()->service<IIncidentSvc>( "IncidentSvc" );
       if ( !inSvc ) return StatusCode::FAILURE;
       inSvc->addListener( this, IncidentType::BeginEvent );
  
       // sort various lists for speed when searching
       std::sort( m_when.begin(), m_when.end() );
       std::sort( m_veto.begin(), m_veto.end() );
       std::sort( m_list.begin(), m_list.end() );
  
       return StatusCode::SUCCESS;
     }

◆ isComponentEnabled()

bool Google::AuditorBase::isComponentEnabled ( std::string_view name ) const

inlineprivate

Check if auditing is enabled for the given component.

Definition at line 99 of file GoogleAuditor.cpp.

                                                                 {
       return ( std::find( m_veto.begin(), m_veto.end(), name ) == m_veto.end() &&
                ( m_list.empty() || std::find( m_list.begin(), m_list.end(), name ) != m_list.end() ) );
     }

◆ isPhaseEnabled()

bool Google::AuditorBase::isPhaseEnabled ( CustomEventTypeRef type ) const

inlineprivate

Check if auditing is enabled for the current processing phase.

Definition at line 94 of file GoogleAuditor.cpp.

                                                                 {
       return ( std::find( m_when.begin(), m_when.end(), type ) != m_when.end() );
     }

◆ isSequencer()

bool Google::AuditorBase::isSequencer ( INamedInterface * i ) const

inlineprivate

Definition at line 88 of file GoogleAuditor.cpp.

                                                         {
       if ( auto alg = dynamic_cast<IAlgorithm*>( i ) ) { return alg->isSequence(); }
       return false;
     }

◆ startAudit()

void Google::AuditorBase::startAudit ( )

inlineprivate

Start a full event audit.

Definition at line 68 of file GoogleAuditor.cpp.

                              {
       info() << " -> Starting full audit from event " << m_nEvts << " to " << m_nEvts + m_nSampleEvents << endmsg;
       m_inFullAudit      = true;
       m_sampleEventCount = 1;
       std::ostringstream t;
       t << "FULL-Events" << m_nEvts << "To" << m_nEvts + m_nSampleEvents;
       google_before( t.str() );
     }

◆ stopAudit()

void Google::AuditorBase::stopAudit ( )

inlineprivate

stop a full event audit

Definition at line 78 of file GoogleAuditor.cpp.

                             {
       info() << " -> Stopping full audit" << endmsg;
       std::ostringstream t;
       t << "FULL-Events" << m_nEvts << "To" << m_nEvts + m_nSampleEvents;
       google_after( t.str() );
       m_inFullAudit      = false;
       m_sampleEventCount = 0;
     }

Member Data Documentation

◆ m_audit

bool Google::AuditorBase::m_audit = true

private

Internal flag to say if auditing is enabled or not for the current event.

Definition at line 217 of file GoogleAuditor.cpp.

◆ m_eventsToSkip

Gaudi::Property<unsigned long long> Google::AuditorBase::m_eventsToSkip

private

Initial value:

{ this, "SkipEvents", 0,

"Number of events to skip before activating the auditing" }

Definition at line 212 of file GoogleAuditor.cpp.

◆ m_freq

Gaudi::Property<int> Google::AuditorBase::m_freq { this, "ProfileFreq", -1, "The frequence to audit events. -1 means all events" }

private

Definition at line 206 of file GoogleAuditor.cpp.

◆ m_fullEventAudit

Gaudi::Property<bool> Google::AuditorBase::m_fullEventAudit

private

Initial value:

{
        this, "DoFullEventProfile", false,
        "If true, instead of individually auditing components,  the full event (or events) will be audited in one go" }

Definition at line 207 of file GoogleAuditor.cpp.

◆ m_inFullAudit

bool Google::AuditorBase::m_inFullAudit = false

private

Internal flag to indicate if we are current in a full event audit.

Definition at line 221 of file GoogleAuditor.cpp.

◆ m_list

Gaudi::Property<std::vector<std::string> > Google::AuditorBase::m_list

private

Initial value:

{

this, "EnableFor", {}, "Any component in this list will be audited. If empty, all will be done." }

Definition at line 204 of file GoogleAuditor.cpp.

◆ m_nEvts

unsigned long long Google::AuditorBase::m_nEvts = 0

private

Number of events processed.

Definition at line 218 of file GoogleAuditor.cpp.

◆ m_nSampleEvents

Gaudi::Property<unsigned long long> Google::AuditorBase::m_nSampleEvents

private

Initial value:

{

this, "FullEventNSampleEvents", 1, "The number of events to include in a full event audit, if enabled" }

Definition at line 210 of file GoogleAuditor.cpp.

◆ m_sampleEventCount

unsigned long long Google::AuditorBase::m_sampleEventCount

private

Initial value:

=

0

Internal count of the number of events currently processed during an audit.

Definition at line 219 of file GoogleAuditor.cpp.

◆ m_skipSequencers

Gaudi::Property<bool> Google::AuditorBase::m_skipSequencers

private

Initial value:

{ this, "SkipSequencers", true,

"If true, auditing will be skipped for Sequencer objects." }

Definition at line 214 of file GoogleAuditor.cpp.

◆ m_startedBy

std::string Google::AuditorBase::m_startedBy

private

Name of the component we are currently auditing.

Definition at line 222 of file GoogleAuditor.cpp.

◆ m_veto

Gaudi::Property<std::vector<std::string> > Google::AuditorBase::m_veto

private

Initial value:

{

this, "DisableFor", {}, "List of component names to disable the auditing for" }

Definition at line 202 of file GoogleAuditor.cpp.

◆ m_when

Gaudi::Property<std::vector<std::string> > Google::AuditorBase::m_when

private

Initial value:

{ this,
                                                      "ActivateAt",
                                                      { "Initialize", "ReInitialize", "Execute", "Finalize" },
                                                      "List of phases to activate the Auditoring during" }

Definition at line 198 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 Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ after() [1/4]

◆ after() [2/4]

◆ after() [3/4]

◆ after() [4/4]

◆ alreadyRunning()

◆ before() [1/4]

◆ before() [2/4]

◆ before() [3/4]

◆ before() [4/4]

◆ finalize()

◆ getDumpName()

◆ google_after()

◆ google_before()

◆ handle()

◆ initialize()

◆ isComponentEnabled()

◆ isPhaseEnabled()

◆ isSequencer()

◆ startAudit()

◆ stopAudit()

Member Data Documentation

◆ m_audit

◆ m_eventsToSkip

◆ m_freq

◆ m_fullEventAudit

◆ m_inFullAudit

◆ m_list

◆ m_nEvts

◆ m_nSampleEvents

◆ m_sampleEventCount

◆ m_skipSequencers

◆ m_startedBy

◆ m_veto

◆ m_when