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

#include <MessageSvc/InertMessageSvc.h>

Inheritance diagram for InertMessageSvc:

Collaboration diagram for InertMessageSvc:

Public Member Functions
	InertMessageSvc (const std::string &name, ISvcLocator *pSvcLocator)
	Standard constructor. More...

virtual	~InertMessageSvc ()
	Destructor. More...

virtual StatusCode	initialize ()
	Initialization of the service. More...

virtual StatusCode	finalize ()
	Finalization of the service. More...

virtual void	reportMessage (const Message &msg)
	Implementation of IMessageSvc::reportMessage() More...

virtual void	reportMessage (const Message &msg, int outputLevel)
	Implementation of IMessageSvc::reportMessage() More...

virtual void	reportMessage (const StatusCode &code, const std::string &source="")
	Implementation of IMessageSvc::reportMessage() More...

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

	~MessageSvc () override=default

StatusCode	reinitialize () override
	Reinitialize Service. More...

StatusCode	initialize () override
	Initialize Service. More...

StatusCode	finalize () override
	Finalize Service. More...

void	reportMessage (const Message &message) override

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

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

void	reportMessage (const char source, int type, const char message) override

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

void	insertMessage (const StatusCode &code, const 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, const 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 (const std::string &source) const override

void	setOutputLevel (int new_level) override

void	setOutputLevel (const std::string &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, const std::string &src) override

Public Member Functions inherited from extends< BASE, 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...

	~extends () override=default
	Virtual destructor. 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...

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

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

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

Public Attributes
	verbosity = VERBOSE

int	evtslots = 10

int	evtMax = 50

int	cardinality = 20

int	algosInFlight = 20

tuple	whiteboard

tuple	slimeventloopmgr = HiveSlimEventLoopMgr(OutputLevel=verbosity)

tuple	scheduler

tuple	a1

tuple	a2

string	EvtSel = 'NONE'

list	ExtSvc = [whiteboard]

	EventLoop = slimeventloopmgr,

list	TopAlg = [a1,a2]

string	MessageSvcType = "InertMessageSvc"

Private Types
typedef std::function< void()>	messageAction

typedef std::shared_ptr< messageAction >	messageActionPtr
	This is done since the copy of the lambda storage is too expensive. More...

Private Member Functions
void	m_activate ()

void	m_deactivate ()

Private Attributes
bool	m_isActive

tbb::concurrent_bounded_queue< messageActionPtr >	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 >	ThresholdMap

Public Types inherited from extends< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...

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

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 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 Member Functions inherited from MessageSvc
virtual void	i_reportMessage (const Message &msg, int outputLevel)
	Internal implementation of reportMessage(const Message&,int) without lock. More...

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

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 26 of file InertMessageSvc.h.

Member Typedef Documentation

typedef std::function<void()> InertMessageSvc::messageAction

private

Definition at line 56 of file InertMessageSvc.h.

typedef std::shared_ptr<messageAction> InertMessageSvc::messageActionPtr

private

This is done since the copy of the lambda storage is too expensive.

Definition at line 58 of file InertMessageSvc.h.

Constructor & Destructor Documentation

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

Standard constructor.

Definition at line 17 of file InertMessageSvc.cpp.

   : MessageSvc(name, pSvcLocator),
     m_isActive(false){
 }

InertMessageSvc::~InertMessageSvc ( )

virtual

Destructor.

Definition at line 24 of file InertMessageSvc.cpp.

24 {

25 }

Member Function Documentation

virtual StatusCode InertMessageSvc::finalize ( )

virtual

Finalization of the service.

StatusCode InertMessageSvc::initialize ( )

virtual

Initialization of the service.

Definition at line 29 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 (std::bind(&InertMessageSvc::m_activate,
                                     this));   
 
   return StatusCode::SUCCESS;
 }

void InertMessageSvc::m_activate ( )

private

Definition at line 54 of file InertMessageSvc.cpp.

                                 {
   m_isActive=true;
   messageActionPtr thisMessageAction;
   while (m_isActive or not m_messageActionsQueue.empty()){    
     m_messageActionsQueue.pop(thisMessageAction);
     (*thisMessageAction)();   
   }
 }

void InertMessageSvc::m_deactivate ( )

private

Definition at line 65 of file InertMessageSvc.cpp.

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

void InertMessageSvc::reportMessage ( const Message & msg )

virtual

Implementation of IMessageSvc::reportMessage()

Definition at line 88 of file InertMessageSvc.cpp.

                                                       {
   m_messageActionsQueue.push(
     messageActionPtr(new messageAction([this,msg] () 
                                        {this->i_reportMessage(msg, this->outputLevel(msg.getSource()));})));
 }

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

virtual

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 80 of file InertMessageSvc.cpp.

                                                                        {
   m_messageActionsQueue.push(
     messageActionPtr(new messageAction([this, msg,outputLevel] () 
                                        {this->i_reportMessage(msg, outputLevel);})));
 }

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

virtual

Implementation of IMessageSvc::reportMessage()

Definition at line 96 of file InertMessageSvc.cpp.

                                                                                    {
   m_messageActionsQueue.push(
     messageActionPtr(new messageAction([this,code,source] () 
                                        {this->i_reportMessage(code, source);})));
 }

Member Data Documentation

tuple InertMessageSvc.a1

Initial value:

 = CPUCruncher("A1", 
                  DataOutputs = ['/Event/a1'],
                  varRuntime=.1, 
                  avgRuntime=.5 )

Definition at line 29 of file InertMessageSvc.py.

tuple InertMessageSvc.a2

Initial value:

 = CPUCruncher("A2", 
                  DataInputs = [],
                  DataOutputs = ['/Event/a2'])

Definition at line 33 of file InertMessageSvc.py.

int InertMessageSvc.algosInFlight = 20

Definition at line 17 of file InertMessageSvc.py.

int InertMessageSvc.cardinality = 20

Definition at line 16 of file InertMessageSvc.py.

InertMessageSvc.EventLoop = slimeventloopmgr,

Definition at line 45 of file InertMessageSvc.py.

int InertMessageSvc.evtMax = 50

Definition at line 15 of file InertMessageSvc.py.

string InertMessageSvc.EvtSel = 'NONE'

Definition at line 43 of file InertMessageSvc.py.

int InertMessageSvc.evtslots = 10

Definition at line 14 of file InertMessageSvc.py.

list InertMessageSvc.ExtSvc = [whiteboard]

Definition at line 44 of file InertMessageSvc.py.

bool InertMessageSvc::m_isActive

private

Definition at line 54 of file InertMessageSvc.h.

tbb::concurrent_bounded_queue<messageActionPtr> InertMessageSvc::m_messageActionsQueue

private

Definition at line 59 of file InertMessageSvc.h.

std::thread InertMessageSvc::m_thread

private

Definition at line 61 of file InertMessageSvc.h.

string InertMessageSvc.MessageSvcType = "InertMessageSvc"

Definition at line 47 of file InertMessageSvc.py.

tuple InertMessageSvc.scheduler

Initial value:

 = ForwardSchedulerSvc(MaxEventsInFlight = evtslots,
                                 MaxAlgosInFlight = algosInFlight,
                                 OutputLevel=verbosity,
                                 AlgosDependencies = [[],[]])

Definition at line 24 of file InertMessageSvc.py.

tuple InertMessageSvc.slimeventloopmgr = HiveSlimEventLoopMgr(OutputLevel=verbosity)

Definition at line 22 of file InertMessageSvc.py.

list InertMessageSvc.TopAlg = [a1,a2]

Definition at line 46 of file InertMessageSvc.py.

InertMessageSvc.verbosity = VERBOSE

Definition at line 8 of file InertMessageSvc.py.

tuple InertMessageSvc.whiteboard

Initial value:

1 = HiveWhiteBoard("EventDataSvc",

2 EventSlots = evtslots)

Definition at line 19 of file InertMessageSvc.py.

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

GaudiCoreSvc/src/MessageSvc/InertMessageSvc.h
GaudiHive/options/InertMessageSvc.py
GaudiCoreSvc/src/MessageSvc/InertMessageSvc.cpp

Public Member Functions

Public Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation