Google::AuditorBase Class Reference

Base for Google Auditors. More...

#include <GoogleAuditor.cpp>

Inheritance diagram for Google::AuditorBase:

Collaboration diagram for Google::AuditorBase:

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
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::string >	getInterfaceNames () 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
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
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::string &	name () 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::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 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::PropertyBase &	getProperty (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
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...
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...
MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...
MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...
MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...
MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...
MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...
MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...
MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...
MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...
MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) 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 PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
Gaudi::Details::PropertyBase *	property (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 Member Functions
void	startAudit ()
	Start a full event audit. More...
void	stopAudit ()
	stop a full event audit More...
bool	isSequencer (INamedInterface *i) const
	Check if the component in question is a GaudiSequencer or a Sequencer. More...
bool	isPhaseEnabled (CustomEventTypeRef type) const
	Check if auditing is enabled for the current processing phase. More...
bool	isComponentEnabled (const std::string &name) const
	Check if auditing is enabled for the given component. More...
std::string	getDumpName (CustomEventTypeRef type, const std::string &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 40 of file GoogleAuditor.cpp.

Member Function Documentation

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

inlineoverride

Definition at line 186 of file GoogleAuditor.cpp.

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

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

inlineoverride

Definition at line 195 of file GoogleAuditor.cpp.

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

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

inlineoverride

Definition at line 202 of file GoogleAuditor.cpp.

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

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

inlineoverride

Definition at line 209 of file GoogleAuditor.cpp.

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

void Google::AuditorBase::afterBeginRun ( INamedInterface *  i )

inlineoverride

Definition at line 235 of file GoogleAuditor.cpp.

{ return after( IAuditor::BeginRun, i, StatusCode::SUCCESS ); }

void Google::AuditorBase::afterEndRun ( INamedInterface *  i )

inlineoverride

Definition at line 236 of file GoogleAuditor.cpp.

{ return after( IAuditor::EndRun, i, StatusCode::SUCCESS ); }

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

inlineoverride

Definition at line 234 of file GoogleAuditor.cpp.

{ return after( IAuditor::Execute, i, s ); }

void Google::AuditorBase::afterFinalize ( INamedInterface *  i )

inlineoverride

Definition at line 237 of file GoogleAuditor.cpp.

{ return after( IAuditor::Finalize, i, StatusCode::SUCCESS ); }

void Google::AuditorBase::afterInitialize ( INamedInterface *  i )

inlineoverride

Definition at line 226 of file GoogleAuditor.cpp.

    {
      return after( IAuditor::Initialize, i, StatusCode::SUCCESS );
    }

void Google::AuditorBase::afterReinitialize ( INamedInterface *  i )

inlineoverride

Definition at line 230 of file GoogleAuditor.cpp.

    {
      return after( IAuditor::ReInitialize, i, StatusCode::SUCCESS );
    }

virtual bool Google::AuditorBase::alreadyRunning ( )

protectedpure virtual

check if we are already running the tool

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

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

inlineoverride

Definition at line 152 of file GoogleAuditor.cpp.

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

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

inlineoverride

Definition at line 159 of file GoogleAuditor.cpp.

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

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

inlineoverride

Definition at line 166 of file GoogleAuditor.cpp.

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

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

inlineoverride

Definition at line 173 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;
        }
      }
    }

void Google::AuditorBase::beforeBeginRun ( INamedInterface *  i )

inlineoverride

Definition at line 222 of file GoogleAuditor.cpp.

{ return before( IAuditor::BeginRun, i ); }

void Google::AuditorBase::beforeEndRun ( INamedInterface *  i )

inlineoverride

Definition at line 223 of file GoogleAuditor.cpp.

{ return before( IAuditor::EndRun, i ); }

void Google::AuditorBase::beforeExecute ( INamedInterface *  i )

inlineoverride

Definition at line 221 of file GoogleAuditor.cpp.

{ return before( IAuditor::Execute, i ); }

void Google::AuditorBase::beforeFinalize ( INamedInterface *  i )

inlineoverride

Definition at line 224 of file GoogleAuditor.cpp.

{ return before( IAuditor::Finalize, i ); }

void Google::AuditorBase::beforeInitialize ( INamedInterface *  i )

inlineoverride

Definition at line 219 of file GoogleAuditor.cpp.

{ return before( IAuditor::Initialize, i ); }

void Google::AuditorBase::beforeReinitialize ( INamedInterface *  i )

inlineoverride

Definition at line 220 of file GoogleAuditor.cpp.

{ return before( IAuditor::ReInitialize, i ); }

StatusCode Google::AuditorBase::finalize ( )

inlineoverridevirtual

Finalize the auditor base.

Reimplemented from Auditor.

Definition at line 66 of file GoogleAuditor.cpp.

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

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

inlineprivate

Definition at line 116 of file GoogleAuditor.cpp.

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

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

protectedpure virtual

stop the google tool

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

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.

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 130 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 ( UNLIKELY( 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();
          }
        }
      }
    }

StatusCode Google::AuditorBase::initialize ( )

inlineoverridevirtual

Initialize the auditor base.

Reimplemented from Auditor.

Reimplemented in Google::HeapChecker.

Definition at line 48 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;
    }

bool Google::AuditorBase::isComponentEnabled ( const std::string &  name ) const

inlineprivate

Check if auditing is enabled for the given component.

Definition at line 109 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() ) );
    }

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

inlineprivate

Check if auditing is enabled for the current processing phase.

Definition at line 103 of file GoogleAuditor.cpp.

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

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

inlineprivate

Check if the component in question is a GaudiSequencer or a Sequencer.

Definition at line 97 of file GoogleAuditor.cpp.

    {
      return ( dynamic_cast<GaudiSequencer*>( i ) != NULL || dynamic_cast<Sequencer*>( i ) != NULL );
    }

void Google::AuditorBase::startAudit ( )

inlineprivate

Start a full event audit.

Definition at line 74 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() );
    }

void Google::AuditorBase::stopAudit ( )

inlineprivate

stop a full event audit

Definition at line 85 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

bool Google::AuditorBase::m_audit = true

private

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

Definition at line 270 of file GoogleAuditor.cpp.

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 265 of file GoogleAuditor.cpp.

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

private

Definition at line 259 of file GoogleAuditor.cpp.

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 260 of file GoogleAuditor.cpp.

bool Google::AuditorBase::m_inFullAudit = false

private

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

Definition at line 274 of file GoogleAuditor.cpp.

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 257 of file GoogleAuditor.cpp.

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

private

Number of events processed.

Definition at line 271 of file GoogleAuditor.cpp.

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 263 of file GoogleAuditor.cpp.

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 272 of file GoogleAuditor.cpp.

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 267 of file GoogleAuditor.cpp.

std::string Google::AuditorBase::m_startedBy

private

Name of the component we are currently auditing.

Definition at line 275 of file GoogleAuditor.cpp.

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 255 of file GoogleAuditor.cpp.

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

private

Initial value:

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

Definition at line 250 of file GoogleAuditor.cpp.

---

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

• GaudiProfiling/src/component/google/GoogleAuditor.cpp