Gaudi Auditor implementation to hook algorithm executions and notify the Trigger Cost Service. More...

#include <TrigCostAuditor.h>

Inheritance diagram for TrigCostAuditor:

Collaboration diagram for TrigCostAuditor:

Public Member Functions
	TrigCostAuditor (const std::string &name, ISvcLocator *svcloc)
	Standard Gaudi Auditor constructor. More...

virtual StatusCode	initialize () override
	Initialise auditor. More...

virtual StatusCode	finalize () override
	Does nothing. More...

virtual void	before (const std::string &event, const std::string &caller, const EventContext &ctx) override
	Audit before an algorithm standard event type is called. More...

virtual void	after (const std::string &event, const std::string &caller, const EventContext &ctx, const StatusCode &sc) override
	Audit after an algorithm standard event type is called. More...

bool	msgLvl (const MSG::Level lvl) const
	Test the output level. More...

MsgStream &	msg () const
	The standard message stream. More...

MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...

void	setLevel (MSG::Level lvl)
	Change the current logging level. More...

Private Member Functions
void	callService (const std::string &caller, ITrigCostSvc::AuditType type, const EventContext &ctx)
	Performs internal call to the trigger cost service. More...

MsgStream &	msg () const
	The standard message stream. More...

MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...

void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
ServiceHandle< ITrigCostSvc >	m_trigCostSvcHandle

std::string	m_nm
	Message source name. More...

boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...

std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...

std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...

std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging) More...

Detailed Description

Gaudi Auditor implementation to hook algorithm executions and notify the Trigger Cost Service.

Only monitors the Execute event type.

Definition at line 21 of file TrigCostAuditor.h.

Constructor & Destructor Documentation

◆ TrigCostAuditor()

TrigCostAuditor::TrigCostAuditor	(	const std::string &	name,
		ISvcLocator *	svcloc
	)

Standard Gaudi Auditor constructor.

Parameters

[in]	name	The algorithm object's name
[in]	svcloc	A pointer to a service location service

Definition at line 11 of file TrigCostAuditor.cxx.

                                                                                 :
 Auditor(name, pSvcLocator),
 AthMessaging(msgSvc(), name)
 {
   ATH_MSG_DEBUG("TrigCostAuditor constructor");
 }

Member Function Documentation

◆ after()

void TrigCostAuditor::after	(	const std::string &	event,
		const std::string &	caller,
		const EventContext &	ctx,
		const StatusCode &	sc
	)

overridevirtual

Audit after an algorithm standard event type is called.

Parameters

[in]	evt	The event type. Only Execute is monitored
[in]	caller	The name of the calling algorithm
[in]	ctx	Event context
[in]	sc	StatusCode of algorithm execution

Definition at line 45 of file TrigCostAuditor.cxx.

                                                                            {
   if (event != IAuditor::Execute) return; // I only care for execution time
   ATH_MSG_DEBUG("After Execute: " << caller << " " << sc);
   callService(caller, ITrigCostSvc::AuditType::After, ctx);
 }

◆ before()

void TrigCostAuditor::before	(	const std::string &	event,
		const std::string &	caller,
		const EventContext &	ctx
	)

overridevirtual

Audit before an algorithm standard event type is called.

Parameters

[in]	evt	The event type. Only Execute is monitored
[in]	caller	The name of the calling algorithm
[in]	ctx	Event context

Definition at line 35 of file TrigCostAuditor.cxx.

                                                       {
   if (event != IAuditor::Execute) return; // I only care for execution time
   ATH_MSG_DEBUG("Before Execute: " << caller);
   callService(caller, ITrigCostSvc::AuditType::Before, ctx);
  
 }

◆ callService()

void TrigCostAuditor::callService	(	const std::string &	caller,
		ITrigCostSvc::AuditType	type,
		const EventContext &	ctx
	)

private

Performs internal call to the trigger cost service.

Parameters

[in]	caller	Name of algorithm being audited
[in]	type	AuditType::Before or AuditType::After depending on if the start or stop of execution
[in]	ctx	Event context

Definition at line 54 of file TrigCostAuditor.cxx.

                                                            {
   if (m_trigCostSvcHandle->processAlg(ctx, caller, type).isFailure()) {
     ATH_MSG_FATAL("Error in TrigCostSvc called by TrigCostAuditor, auditing algorithm: " << caller);
     throw std::runtime_error("TrigCostAuditor exception");
   }
 }

◆ finalize()

StatusCode TrigCostAuditor::finalize ( )

overridevirtual

Does nothing.

Returns: Success

Definition at line 28 of file TrigCostAuditor.cxx.

                                      {
   ATH_MSG_DEBUG("TrigCostAuditor finalize()");
   return StatusCode::SUCCESS;
 }

◆ initialize()

StatusCode TrigCostAuditor::initialize ( )

overridevirtual

Initialise auditor.

Return handle to Trigger Cost Service

Returns: Success if service handle obtained

Definition at line 20 of file TrigCostAuditor.cxx.

                                       {
   ATH_MSG_DEBUG("TrigCostAuditor initialize()");
   ATH_CHECK( m_trigCostSvcHandle.retrieve() );
   return StatusCode::SUCCESS;
 }

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

 {
   m_imsg = Athena::getMessageSvc();
   m_lvl = m_imsg ?
     static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
     MSG::INFO;
 }

◆ msg() [1/4]

MsgStream & AthMessaging::msg

inlineprivate

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 92 of file AthMessaging.h.

 {
   MsgStream* ms = m_msg_tls.get();
   if (!ms) {
     if (!m_initialized.test_and_set()) initMessaging();
     ms = new MsgStream(m_imsg,m_nm);
     m_msg_tls.reset( ms );
   }
  
   ms->setLevel (m_lvl);
   return *ms;
 }

◆ msg() [2/4]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 164 of file AthMessaging.h.

 {
   MsgStream* ms = m_msg_tls.get();
   if (!ms) {
     if (!m_initialized.test_and_set()) initMessaging();
     ms = new MsgStream(m_imsg,m_nm);
     m_msg_tls.reset( ms );
   }
  
   ms->setLevel (m_lvl);
   return *ms;
 }

◆ msg() [3/4]

MsgStream & AthMessaging::msg

inlineprivate

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 99 of file AthMessaging.h.

180 { return msg() << lvl; }

◆ msg() [4/4]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 179 of file AthMessaging.h.

180 { return msg() << lvl; }

◆ msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns: boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

 {
   if (!m_initialized.test_and_set()) initMessaging();
   if (m_lvl <= lvl) {
     msg() << lvl;
     return true;
   } else {
     return false;
   }
 }

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

 {
   m_lvl = lvl;
 }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_trigCostSvcHandle

ServiceHandle<ITrigCostSvc> TrigCostAuditor::m_trigCostSvcHandle

private

Initial value:

{ this, "TrigCostSvc", "TrigCostSvc",

"The trigger cost service to pass audit information to" }

Definition at line 76 of file TrigCostAuditor.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TrigCostAuditor()

Member Function Documentation

◆ after()

◆ before()

◆ callService()

◆ finalize()

◆ initialize()

◆ initMessaging()

◆ msg() [1/4]

◆ msg() [2/4]

◆ msg() [3/4]

◆ msg() [4/4]

◆ msgLvl()

◆ setLevel()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_nm

◆ m_trigCostSvcHandle