Monitors the cpu time usage of each algorithm. More...

#include <src/AlgErrorAuditor.h>

Inheritance diagram for AlgErrorAuditor:

Collaboration diagram for AlgErrorAuditor:

Public Member Functions
	AlgErrorAuditor (const std::string &name, ISvcLocator *pSvcLocator)

virtual	~AlgErrorAuditor ()=default

virtual StatusCode	initialize ()

virtual StatusCode	finalize ()

virtual void	beforeExecute (INamedInterface *alg)

virtual void	afterExecute (INamedInterface *alg, const StatusCode &)

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

	~Auditor () override=default
	Destructor. More...

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

StatusCode	sysFinalize ()
	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< 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...

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

	Auditor (const std::string &name, ISvcLocator *svcloc)
	Constructor. More...

	~Auditor () override=default
	Destructor. More...

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

StatusCode	sysFinalize ()
	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< 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...

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

	implements ()=default
	Default constructor. More...

	implements (const implements &)
	Copy constructor (zero the reference count) More...

implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...

	~implements () override=default
	Virtual destructor. More...

unsigned long	addRef () override
	Reference Interface instance. More...

unsigned long	release () override
	Release Interface instance. More...

unsigned long	refCount () const override
	Current reference count. More...

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

	implements ()=default
	Default constructor. More...

	implements (const implements &)
	Copy constructor (zero the reference count) More...

implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...

	~implements () override=default
	Virtual destructor. More...

unsigned long	addRef () override
	Reference Interface instance. More...

unsigned long	release () override
	Release Interface instance. More...

unsigned long	refCount () const override
	Current reference count. More...

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

	~extend_interfaces () override=default
	Virtual destructor. More...

Private Member Functions
void	incrMap (const std::string &algName, int level)

Private Attributes
BooleanProperty	m_abort

BooleanProperty	m_throw

int	m_error

int	m_fatal

std::map< std::string, int >	m_algMap [2]

Additional Inherited Members
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 implements< Interfaces >
using	base_class = implements< Interfaces...>
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

using	iids = typename extend_interfaces_base::ext_iids

using	base_class = implements< Interfaces...>
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

using	iids = typename extend_interfaces_base::ext_iids

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

using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Protected Attributes inherited from implements< Interfaces >
unsigned long	m_refCount = 0
	Reference counter. More...

Detailed Description

Monitors the cpu time usage of each algorithm.

Author: David Quarrie

Definition at line 15 of file AlgErrorAuditor.h.

Constructor & Destructor Documentation

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

Definition at line 8 of file AlgErrorAuditor.cpp.

   : Auditor(name, pSvcLocator), m_error(0), m_fatal(0) {
 
   declareProperty( "Abort", m_abort = false,
            "Abort job upon illegal Algorithm return code");
   declareProperty( "Throw", m_throw = false,
            "Throw GaudiException upon illegal Algorithm return code");
 }

virtual AlgErrorAuditor::~AlgErrorAuditor ( )

virtualdefault

Member Function Documentation

void AlgErrorAuditor::afterExecute	(	INamedInterface *	alg,
		const StatusCode &	sc
	)

virtual

Definition at line 37 of file AlgErrorAuditor.cpp.

                                                                          {
 
   bool fail(false);
   if (msgSvc()->messageCount(MSG::ERROR) != m_error && ! sc.isRecoverable() ) {
     std::ostringstream os;
     os << "Illegal Return Code: Algorithm " << alg->name()
        << " reported an ERROR, but returned a StatusCode \"" << sc << "\"";
     os << std::endl << "Error policy described in "
      << "https://twiki.cern.ch/twiki/bin/view/AtlasComputing/ReportingErrors";
 
     MsgStream log(msgSvc(), name());
     log << MSG::ERROR << os.str() << endmsg;
     incrMap(alg->name(), 0);
     fail = true;
 
     if (m_throw && ! m_abort) {
       throw GaudiException(os.str(),"AlgErrorAuditor",0);
     }
   }
 
   if (msgSvc()->messageCount(MSG::FATAL) != m_fatal &&
       sc != StatusCode::FAILURE ) {
     std::ostringstream os;
     os << "Illegal Return Code: Algorithm " << alg->name()
        << " reported a FATAL, but returned a StatusCode \"" << sc << "\"";
     os << std::endl << "Error policy described in "
      << "https://twiki.cern.ch/twiki/bin/view/AtlasComputing/ReportingErrors";
 
     MsgStream log(msgSvc(), name());
     log << MSG::ERROR << os.str() << endmsg;
     incrMap(alg->name(), 1);
     fail = true;
 
     if (m_throw && ! m_abort) {
       throw GaudiException(os.str(),"AlgErrorAuditor",0);
     }
 
   }
 
   if (fail && m_abort) {
     abort();
   }
 
 }

void AlgErrorAuditor::beforeExecute ( INamedInterface * alg )

virtual

Definition at line 18 of file AlgErrorAuditor.cpp.

                                                 {
   m_error = msgSvc()->messageCount(MSG::ERROR);
   m_fatal = msgSvc()->messageCount(MSG::FATAL);
 }

StatusCode AlgErrorAuditor::finalize ( )

virtual

Reimplemented from Auditor.

Definition at line 83 of file AlgErrorAuditor.cpp.

                           {
 
 
   if (m_algMap[0].size() != 0) {
     MsgStream log(msgSvc(), name());
     log << MSG::INFO << "Found " << m_algMap[0].size()
     << " instances where an Algorithm::execute() produced an ERROR "
     << "but returned a SUCCESS:" << std::endl;
 
     for (const auto&  i : m_algMap[0] ) {
       log << i.first << ": " << i.second << std::endl;
     }
 
     log << endmsg;
   }
 
   if (m_algMap[1].size() != 0) {
     MsgStream log(msgSvc(), name());
     log << MSG::INFO << "Found " << m_algMap[1].size()
     << " instances where an Algorithm::execute() produced a FATAL "
     << "but returned a SUCCESS:" << std::endl;
 
     for (const auto& i : m_algMap[1]) {
       log << i.first << ": " << i.second << std::endl;
     }
 
     log << endmsg;
   }
   return StatusCode::SUCCESS;
 }

void AlgErrorAuditor::incrMap	(	const std::string &	algName,
		int	level
	)

private

Definition at line 115 of file AlgErrorAuditor.cpp.

                                                         {
   auto i=m_algMap[level].find(alg);
   if ( i != m_algMap[level].end()) {
     i->second++;
   } else {
     m_algMap[level].emplace( alg,1 );
   }
 }

StatusCode AlgErrorAuditor::initialize ( )

virtual

Reimplemented from Auditor.

Definition at line 24 of file AlgErrorAuditor.cpp.

                              {
 
   if (m_abort && m_throw) {
     MsgStream log(msgSvc(), name());
     log << MSG::INFO << "Both \"Throw\" and \"Abort\" options have been set."
     << " Abort takes precedence." << endmsg;
   }
 
   return StatusCode::SUCCESS;
 }

Member Data Documentation

BooleanProperty AlgErrorAuditor::m_abort

private

Definition at line 27 of file AlgErrorAuditor.h.

std::map<std::string, int> AlgErrorAuditor::m_algMap[2]

private

Definition at line 34 of file AlgErrorAuditor.h.

int AlgErrorAuditor::m_error

private

Definition at line 31 of file AlgErrorAuditor.h.

int AlgErrorAuditor::m_fatal

private

Definition at line 32 of file AlgErrorAuditor.h.

BooleanProperty AlgErrorAuditor::m_throw

private

Definition at line 27 of file AlgErrorAuditor.h.

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

GaudiAud/src/AlgErrorAuditor.h
GaudiAud/src/AlgErrorAuditor.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation