Thread safe extension to the standard MessageSvc. More...

#include <MessageSvc/InertMessageSvc.h>

Inheritance diagram for InertMessageSvc:

[legend]

Collaboration diagram for InertMessageSvc:

[legend]

Public Member Functions
StatusCode	initialize () override
	Initialization of the service.

StatusCode	finalize () override
	Finalization of the service.

void	reportMessage (const Message &msg) override
	Implementation of IMessageSvc::reportMessage()

void	reportMessage (const Message &msg, int outputLevel) override
	Implementation of IMessageSvc::reportMessage()

void	reportMessage (const StatusCode &code, std::string_view source="") override
	Implementation of IMessageSvc::reportMessage()

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

void	reportMessage (std::string source, int type, std::string message) override

Public Member Functions inherited from MessageSvc
	MessageSvc (const std::string &name, ISvcLocator *svcloc)

StatusCode	reinitialize () override

StatusCode	initialize () override

StatusCode	finalize () override

void	reportMessage (const Message &message) override

void	reportMessage (const Message &msg, int outputLevel) override

void	reportMessage (const StatusCode &code, std::string_view source="") override

void	reportMessage (std::string source, int type, std::string message) override

void	insertMessage (const StatusCode &code, Message message) override

void	eraseMessage () override

void	eraseMessage (const StatusCode &code) override

void	eraseMessage (const StatusCode &code, const Message &message) override

void	insertStream (int message_type, std::string name, std::ostream *stream) override

void	eraseStream () override

void	eraseStream (int message_type) override

void	eraseStream (int message_type, std::ostream *stream) override

void	eraseStream (std::ostream *stream) override

std::ostream *	defaultStream () const override

void	setDefaultStream (std::ostream *stream) override

int	outputLevel () const override

int	outputLevel (std::string_view source) const override

void	setOutputLevel (int new_level) override

void	setOutputLevel (std::string_view source, int new_level) override

bool	useColor () const override

std::string	getLogColor (int logLevel) const override

int	messageCount (MSG::Level logLevel) const override

void	incrInactiveCount (MSG::Level level, std::string_view src) override

Public Member Functions inherited from extends< Service, IMessageSvc, IInactiveMessageCounter >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service.

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service.

StatusCode	sysStart () override
	Initialize Service.

StatusCode	sysStop () override
	Initialize Service.

StatusCode	sysFinalize () override
	Finalize Service.

StatusCode	sysReinitialize () override
	Re-initialize the Service.

StatusCode	sysRestart () override
	Re-initialize the Service.

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool.

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

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.

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.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

Private Member Functions
void	m_activate ()

void	m_deactivate ()

Private Attributes
bool	m_isActive = false

tbb::concurrent_bounded_queue< std::function< void()> >	m_messageActionsQueue

std::thread	m_thread

Additional Inherited Members
Public Types inherited from MessageSvc
typedef std::pair< std::string, std::ostream * >	NamedStream

typedef std::multimap< int, NamedStream >	StreamMap

typedef std::multimap< StatusCode, Message >	MessageMap

typedef std::map< std::string, int, std::less<> >	ThresholdMap

Public Types inherited from extends< Service, IMessageSvc, IInactiveMessageCounter >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory<IService( const std::string&, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Protected Member Functions inherited from MessageSvc
virtual void	i_reportMessage (const Message &msg, int outputLevel)
	Internal implementation of reportMessage(const Message&,int) without lock.

virtual void	i_reportMessage (const StatusCode &code, std::string_view source)
	Internal implementation of reportMessage(const StatusCode&,const std::string&) without lock.

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

int	outputLevel () const
	get the `Service's` output level

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Detailed Description

Thread safe extension to the standard MessageSvc.

The InertMessageSvc runs in a separate thread sleeping until the arrival of a message to print out therefore using a very limited amount of resources. The most important part of its implementation is the presence of a TBB concurrent bounded queue which not only allows to serialise the received messages in order to print them but also to put the thread where the service is located to sleep when the queue is empty.

Author: Danilo Piparo

Date: 12/02/2013

Definition at line 32 of file InertMessageSvc.h.

Member Function Documentation

◆ finalize()

StatusCode InertMessageSvc::finalize ( )

override

Finalization of the service.

◆ initialize()

StatusCode InertMessageSvc::initialize ( )

override

Initialization of the service.

Definition at line 15 of file InertMessageSvc.cpp.

                                       {
  StatusCode sc = MessageSvc::initialize(); // must be executed first
  if ( sc.isFailure() ) return sc;          // error printed already by MessageSvc
 
  info() << "Activating in a separate thread" << endmsg;
  m_thread = std::thread( &InertMessageSvc::m_activate, this );
 
  return StatusCode::SUCCESS;
}

◆ m_activate()

void InertMessageSvc::m_activate ( )

private

Definition at line 31 of file InertMessageSvc.cpp.

                                 {
  m_isActive = true;
  std::function<void()> thisMessageAction;
  while ( m_isActive || !m_messageActionsQueue.empty() ) {
    m_messageActionsQueue.pop( thisMessageAction );
    if ( thisMessageAction ) thisMessageAction();
  }
}

◆ m_deactivate()

void InertMessageSvc::m_deactivate ( )

private

Definition at line 40 of file InertMessageSvc.cpp.

                                   {
  if ( m_isActive ) {
    // This would be the last action
    m_messageActionsQueue.emplace( [this]() { m_isActive = false; } );
  }
}

◆ MessageSvc()

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

Definition at line 43 of file MessageSvc.cpp.

                                                                   : base_class( name, svcloc ) {
 
  m_outputLevel.declareUpdateHandler( [svcloc]( Gaudi::Details::PropertyBase& ) {
    SmartIF<IAppMgrUI> app = svcloc;
    if ( app ) app->outputLevelUpdate();
  } );
 
#ifndef NDEBUG
  // initialize the MsgStream static flag.
  MsgStream::enableCountInactive( m_inactCount );
#endif
 
  for ( int ic = 0; ic < MSG::NUM_LEVELS; ++ic ) {
    m_logColors[ic].declareUpdateHandler( &MessageSvc::setupColors, this );
    m_msgLimit[ic].declareUpdateHandler( &MessageSvc::setupLimits, this );
    m_thresholdProp[ic].declareUpdateHandler( &MessageSvc::setupThreshold, this );
  }
 
  m_logColors[MSG::FATAL].set( { "blue", "red" } );
  m_logColors[MSG::ERROR].set( { "white", "red" } );
  m_logColors[MSG::WARNING].set( { "yellow" } );
 
  std::fill( std::begin( m_msgCount ), std::end( m_msgCount ), 0 );
}

◆ reportMessage() [1/4]

void InertMessageSvc::reportMessage ( const Message & msg )

override

Implementation of IMessageSvc::reportMessage()

Definition at line 59 of file InertMessageSvc.cpp.

                                                        {
  // msg has to be copied as the reference may become invalid by the time it's used
  m_messageActionsQueue.emplace(
      [this, m = Message( msg )]() { this->i_reportMessage( m, this->outputLevel( m.getSource() ) ); } );
}

◆ reportMessage() [2/4]

void InertMessageSvc::reportMessage	(	const Message &	msg,
		int	outputLevel )

override

Implementation of IMessageSvc::reportMessage()

The message action is created and pushed to the message queue.

The message is captured by value since the one referenced by msg can (and basically always will given the asynchronous nature of the printing) go out of scope before the differed print.

Definition at line 53 of file InertMessageSvc.cpp.

                                                                         {
  // msg has to be copied as the reference may become invalid by the time it is used
  m_messageActionsQueue.emplace(
      [this, m = Message( msg ), outputLevel]() { this->i_reportMessage( m, outputLevel ); } );
}

◆ reportMessage() [3/4]

void InertMessageSvc::reportMessage	(	const StatusCode &	code,
		std::string_view	source = "" )

override

Implementation of IMessageSvc::reportMessage()

Definition at line 65 of file InertMessageSvc.cpp.

                                                                                   {
  // msg has to be copied as the source may become invalid by the time it's used
  m_messageActionsQueue.emplace( [this, code, s = std::string{ source }]() { this->i_reportMessage( code, s ); } );
}

◆ reportMessage() [4/4]

void MessageSvc::reportMessage	(	std::string	source,
		int	type,
		std::string	message )

override

Definition at line 62 of file MessageSvc.cpp.

                                                                              {
  reportMessage( Message{ std::move( source ), type, std::move( message ) } );
}

Member Data Documentation

◆ m_isActive

bool InertMessageSvc::m_isActive = false

private

Definition at line 56 of file InertMessageSvc.h.

◆ m_messageActionsQueue

tbb::concurrent_bounded_queue<std::function<void()> > InertMessageSvc::m_messageActionsQueue

private

Definition at line 58 of file InertMessageSvc.h.

◆ m_thread

std::thread InertMessageSvc::m_thread

private

Definition at line 60 of file InertMessageSvc.h.

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

GaudiCoreSvc/src/MessageSvc/InertMessageSvc.h
GaudiCoreSvc/src/MessageSvc/InertMessageSvc.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ finalize()

◆ initialize()

◆ m_activate()

◆ m_deactivate()

◆ MessageSvc()

◆ reportMessage() [1/4]

◆ reportMessage() [2/4]

◆ reportMessage() [3/4]

◆ reportMessage() [4/4]

Member Data Documentation

◆ m_isActive

◆ m_messageActionsQueue

◆ m_thread