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
	AuditorBase (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor. More...
virtual	~AuditorBase ()
	Destructor. More...
StatusCode	initialize ()
	Initialize the auditor base. 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)
void	before (CustomEventTypeRef type, INamedInterface *i)
void	before (StandardEventType type, const std::string &s)
void	before (CustomEventTypeRef type, const std::string &s)
void	after (StandardEventType type, INamedInterface *i, const StatusCode &sc)
void	after (CustomEventTypeRef type, INamedInterface *i, const StatusCode &sc)
void	after (StandardEventType type, const std::string &s, const StatusCode &sc)
void	after (CustomEventTypeRef type, const std::string &s, const StatusCode &)
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 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...
	~extends () override=default
	Virtual destructor. More...
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
const std::string &	name () const override
bool	isEnabled () const override
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 Property &	getProperty (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 >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...
Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...
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...
MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...
MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. 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 > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes
MsgStream	m_log
	Messaging object. 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
std::vector< std::string >	m_when
	When to audit the algorithms. More...
std::vector< std::string >	m_veto
	Veto list. Any component in this list will not be audited. More...
std::vector< std::string >	m_list
	Any component in this list will be audited. If empty, all will be done. More...
unsigned long long	m_eventsToSkip
	Number of events to skip before auditing. More...
bool	m_skipSequencers
	Boolean indicating if sequencers should be skipped or not. More...
int	m_freq
	The frequency to audit events. -1 means all events. More...
bool	m_audit
	Internal flag to say if auditing is enabled or not for the current event. More...
unsigned long long	m_nEvts
	Number of events processed. More...
bool	m_fullEventAudit
	Flag to indicate if full event auditing is enabled or not. More...
unsigned long long	m_nSampleEvents
	Number of events to include in a full event audit. More...
unsigned long long	m_sampleEventCount
	Internal count of the number of events currently processed during an audit. More...
bool	m_inFullAudit
	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
typedef Gaudi::PluginService::Factory< IAuditor *, const std::string &, ISvcLocator * >	Factory
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.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 313 of file GoogleAuditor.cpp.

    : base_class ( name , pSvcLocator )
    , m_log      ( msgSvc() , name )
    , m_audit    ( true )
    , m_nEvts    ( 0 )
    , m_sampleEventCount( 0 )
    , m_inFullAudit ( false )
  {
    {
      // Note: 'tmp' is needed to avoid an issue with list_of and C++11.
      const std::vector<std::string> tmp =
        boost::assign::list_of
          ("Initialize")
          ("ReInitialize")
          ("Execute")
          ("BeginRun")
          ("EndRun")
          ("Finalize");
      m_when = tmp;
    }

    declareProperty("ActivateAt", m_when,
                    "List of phases to activate the Auditoring during" );
    declareProperty("DisableFor", m_veto,
                    "List of component names to disable the auditing for" );
    declareProperty("EnableFor", m_list );
    declareProperty("ProfileFreq", m_freq = -1,
                    "The frequence to audit events. -1 means all events" );
    declareProperty("DoFullEventProfile", m_fullEventAudit = false,
                    "If true, instead of individually auditing components, the full event (or events) will be audited in one go" );
    declareProperty("FullEventNSampleEvents", m_nSampleEvents = 1,
                    "The number of events to include in a full event audit, if enabled" );
    declareProperty("SkipEvents", m_eventsToSkip = 0,
                    "Number of events to skip before activating the auditing" );
    declareProperty("SkipSequencers", m_skipSequencers = true,
                    "If true, auditing will be skipped for Sequencer objects." );
  }

virtual Google::AuditorBase::~AuditorBase ( )

inlinevirtual

Destructor.

Definition at line 50 of file GoogleAuditor.cpp.

{  }

Member Function Documentation

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

inline

Definition at line 221 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  )

inline

Definition at line 231 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  )

inline

Definition at line 239 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 &    )

inline

Definition at line 246 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 )

inline

Definition at line 266 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 267 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 265 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 268 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 263 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 264 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  )

inline

Definition at line 176 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 184 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 192 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 199 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 259 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 260 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 258 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 261 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 256 of file GoogleAuditor.cpp.

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

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

inline

Definition at line 257 of file GoogleAuditor.cpp.

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

StatusCode Google::AuditorBase::finalize ( )

inlinevirtual

Finalize the auditor base.

Reimplemented from Auditor.

Definition at line 71 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 125 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 )

inline

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 141 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  ) );
        m_log << MSG::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 ( )

inlinevirtual

Initialize the auditor base.

Reimplemented from Auditor.

Reimplemented in Google::HeapChecker.

Definition at line 53 of file GoogleAuditor.cpp.

    {
      m_log << MSG::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 117 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 111 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 104 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 80 of file GoogleAuditor.cpp.

    {
      m_log << MSG::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 92 of file GoogleAuditor.cpp.

    {
      m_log << MSG::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

private

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

Definition at line 297 of file GoogleAuditor.cpp.

unsigned long long Google::AuditorBase::m_eventsToSkip

private

Number of events to skip before auditing.

Definition at line 291 of file GoogleAuditor.cpp.

int Google::AuditorBase::m_freq

private

The frequency to audit events. -1 means all events.

Definition at line 295 of file GoogleAuditor.cpp.

bool Google::AuditorBase::m_fullEventAudit

private

Flag to indicate if full event auditing is enabled or not.

Definition at line 301 of file GoogleAuditor.cpp.

bool Google::AuditorBase::m_inFullAudit

private

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

Definition at line 307 of file GoogleAuditor.cpp.

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

private

Any component in this list will be audited. If empty, all will be done.

Definition at line 289 of file GoogleAuditor.cpp.

MsgStream Google::AuditorBase::m_log

mutableprotected

Messaging object.

Definition at line 283 of file GoogleAuditor.cpp.

unsigned long long Google::AuditorBase::m_nEvts

private

Number of events processed.

Definition at line 299 of file GoogleAuditor.cpp.

unsigned long long Google::AuditorBase::m_nSampleEvents

private

Number of events to include in a full event audit.

Definition at line 303 of file GoogleAuditor.cpp.

unsigned long long Google::AuditorBase::m_sampleEventCount

private

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

Definition at line 305 of file GoogleAuditor.cpp.

bool Google::AuditorBase::m_skipSequencers

private

Boolean indicating if sequencers should be skipped or not.

Definition at line 293 of file GoogleAuditor.cpp.

std::string Google::AuditorBase::m_startedBy

private

Name of the component we are currently auditing.

Definition at line 309 of file GoogleAuditor.cpp.

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

private

Veto list. Any component in this list will not be audited.

Definition at line 288 of file GoogleAuditor.cpp.

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

private

When to audit the algorithms.

Definition at line 287 of file GoogleAuditor.cpp.

---

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

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