Service that stop the processing if a signal is received. More...

Inheritance diagram for Gaudi::Utils::StopSignalHandler:

Collaboration diagram for Gaudi::Utils::StopSignalHandler:

Public Member Functions
	StopSignalHandler (const std::string &name, ISvcLocator *svcLoc)

StatusCode	initialize () override

StatusCode	finalize () override

void	handle (const Incident &) override

Public Member Functions inherited from extends< Service, 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 Service
const std::string &	name () const override
	Retrieve name of the service. More...

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

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

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

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

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

StatusCode	setProperty (const Property &p) override

StatusCode	setProperty (const std::string &s) override

StatusCode	setProperty (const std::string &n, const std::string &v) override

StatusCode	getProperty (Property *p) const override

const Property &	getProperty (const std::string &name) const override

StatusCode	getProperty (const std::string &n, std::string &v) const override

const std::vector< Property * > &	getProperties () const override

bool	hasProperty (const std::string &name) const override

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

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

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

StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...

template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const

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

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

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

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

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. 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...

Private Member Functions
std::pair< int, bool >	i_decodeSignal (const std::string &sig)
	Function to translate the signal name to the signal number. More...

Private Attributes
std::vector< std::string >	m_usedSignals
	List of signal names or numbers (encoded as strings) to use to schedule a stop. More...

std::map< int, bool >	m_signals
	Map of monitored signal numbers to the flag telling if they have to be propagated or not. More...

bool	m_stopRequested
	Flag to remember if the stop has been requested because of a signal. More...

SmartIF< Gaudi::ISignalMonitor >	m_signalMonitor
	Pointer to the signal monitor service. More...

SmartIF< IIncidentSvc >	m_incidentSvc
	Pointer to the incident service. More...

SmartIF< IProperty >	m_appProperty
	Pointer to the interface to set the return code of the application. More...

Additional Inherited Members
Public Types inherited from extends< Service, 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 Service
typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
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...

Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...

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

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...

Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...

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

Detailed Description

Service that stop the processing if a signal is received.

The signals to be intercepted have to be declared in the property Signals as a list of strings (signal names or numbers). If '+' is appended to the signal name, then the signal is propagated to the signal handlers already registered when this service is initialized.

Definition at line 340 of file SignalMonitorSvc.cpp.

Constructor & Destructor Documentation

Gaudi::Utils::StopSignalHandler::StopSignalHandler	(	const std::string &	name,
		ISvcLocator *	svcLoc
	)

inline

Definition at line 343 of file SignalMonitorSvc.cpp.

                                                                    : base_class(name, svcLoc) {
         m_usedSignals.reserve(2);
         m_usedSignals.push_back("SIGINT");
         m_usedSignals.push_back("SIGXCPU");
         m_stopRequested = false;
         declareProperty("Signals", m_usedSignals,
             "List of signal names or numbers to use to schedule a stop. "
             "If the signal is followed by a '+' the signal is propagated the previously "
             "registered handler (if any).");
       }

Member Function Documentation

StatusCode Gaudi::Utils::StopSignalHandler::finalize ( )

inlineoverride

Definition at line 398 of file SignalMonitorSvc.cpp.

                                      {
         m_incidentSvc->removeListener(this, IncidentType::BeginEvent);
         m_incidentSvc.reset();
         // disable the monitoring of the signals
         std::for_each( std::begin(m_signals), std::end(m_signals),
                        [&](const std::pair<int,bool>& s) {
             // tell the signal monitor that we are interested in these signals
             m_signalMonitor->ignoreSignal(s.first);
         } );
         m_signalMonitor.reset();
         return Service::finalize();
       }

void Gaudi::Utils::StopSignalHandler::handle ( const Incident & )

inlineoverride

Definition at line 411 of file SignalMonitorSvc.cpp.

                                             {
         if (!m_stopRequested) {
           const SigMap& sigmap(SigMap::instance());
           for (const auto& s : m_signals ) {
             if (!m_signalMonitor->gotSignal(s.first)) continue;
             warning() << "Received signal '" << sigmap.name(s.first)
                       << "' (" << s.first;
             const std::string &desc = sigmap.desc(s.first);
             if ( ! desc.empty() ) warning() << ", " << desc;
             warning() << ")" << endmsg;
             m_stopRequested = true;
             // Report the termination by signal at the end of the application
             using Gaudi::ReturnCode::SignalOffset;
             if (Gaudi::setAppReturnCode(m_appProperty, SignalOffset + s.first).isFailure()) {
               error() << "Could not set return code of the application ("
                   << SignalOffset + s.first << ")"
                   << endmsg;
             }
             
           }
           if (m_stopRequested) {
             auto ep = serviceLocator()->as<IEventProcessor>();
             if (ep) {
               warning() << "Scheduling a stop" << endmsg;
               ep->stopRun().ignore();
             }
             else {
               warning() << "Cannot stop the processing because the IEventProcessor interface cannot be retrieved." << endmsg;
             }
           }
         }
       }

std::pair<int, bool> Gaudi::Utils::StopSignalHandler::i_decodeSignal ( const std::string & sig )

inlineprivate

Function to translate the signal name to the signal number.

Definition at line 457 of file SignalMonitorSvc.cpp.

                                                               {
         debug() << "Decoding signal declaration '" << sig << "'" << endmsg;
         if ( sig.empty() || sig == "+" ) {
           debug() << "Empty signal, ignored" << endmsg;
           return {-1, false}; // silently ignore empty strings
         }
         const SigMap& sigmap(SigMap::instance());
         std::string signal = sig;
         bool propagate = false;
         // Check if the signal must be propagated
         if (signal[signal.size() - 1] == '+') {
           debug() << "Must be propagated to previously registered signal handlers" << endmsg;
           propagate = true;
           signal.erase(signal.size() - 1, 1); // remove the '+' at the end of the string
         }
         int signum = -1;
         // check if the signal is a number
         if (std::isdigit(signal[0])){
           std::istringstream ss(signal);
           ss >> signum;
         } else {
           // try to find the signal name in the list of known signals
           signum = sigmap.signum(signal);
         }
         if (signum < 0) {
           warning() << "Cannot understand signal identifier '" << sig << "', ignored" << endmsg;
         } else {
           verbose() << "Matched signal '" << sigmap.name(signum)
                     << "' (" << signum;
           const std::string &desc = sigmap.desc(signum);
           if ( ! desc.empty() ) {
             verbose() << ", " << desc;
           }
           verbose() << ")" << endmsg;
         }
         return {signum, propagate};
       }

StatusCode Gaudi::Utils::StopSignalHandler::initialize ( )

inlineoverride

Definition at line 353 of file SignalMonitorSvc.cpp.

                                        {
         StatusCode sc = Service::initialize();
         if (sc.isFailure()) {
           return sc;
         }
         std::string serviceName("Gaudi::Utils::SignalMonitorSvc");
         m_signalMonitor = serviceLocator()->service(serviceName);
         if ( ! m_signalMonitor ) {
           error() << "Cannot retrieve " << serviceName << endmsg;
           return StatusCode::FAILURE;
         }
         serviceName = "IncidentSvc";
         m_incidentSvc = serviceLocator()->service(serviceName);
         if ( ! m_incidentSvc ) {
           error() << "Cannot retrieve " << serviceName << endmsg;
           return StatusCode::FAILURE;
         }
         // Get the IMainAppStatus interface of the ApplicationMgr
         m_appProperty = serviceLocator();
         if ( ! m_appProperty ) {
           warning() << "Cannot retrieve IProperty interface of ApplicationMgr, "
                        "the return code will not be changed" << endmsg;
         }
         // Decode the signal names
         for (const auto&  signame : m_usedSignals ) {
           auto sigid = i_decodeSignal(signame);
           if (sigid.first >= 0) {
             m_signals[sigid.first] = sigid.second;
           }
         }
         debug() << "Stopping on the signals:" << endmsg;
         const SigMap& sigmap(SigMap::instance());
         for (const auto& s : m_signals ) {
           debug() << "\t" << sigmap.name(s.first) << ": "
                   << sigmap.desc(s.first) << " (" << s.first << ")";
           if (s.second) debug() << " propagated";
           debug() << endmsg;
           // tell the signal monitor that we are interested in these signals
           m_signalMonitor->monitorSignal(s.first, s.second);
         }
         m_stopRequested = false;
         debug() << "Register to the IncidentSvc" << endmsg;
         m_incidentSvc->addListener(this, IncidentType::BeginEvent);
         return StatusCode::SUCCESS;
       }

Member Data Documentation

SmartIF<IProperty> Gaudi::Utils::StopSignalHandler::m_appProperty

private

Pointer to the interface to set the return code of the application.

Definition at line 455 of file SignalMonitorSvc.cpp.

SmartIF<IIncidentSvc> Gaudi::Utils::StopSignalHandler::m_incidentSvc

private

Pointer to the incident service.

Definition at line 453 of file SignalMonitorSvc.cpp.

SmartIF<Gaudi::ISignalMonitor> Gaudi::Utils::StopSignalHandler::m_signalMonitor

private

Pointer to the signal monitor service.

Definition at line 451 of file SignalMonitorSvc.cpp.

std::map<int, bool> Gaudi::Utils::StopSignalHandler::m_signals

private

Map of monitored signal numbers to the flag telling if they have to be propagated or not.

Definition at line 447 of file SignalMonitorSvc.cpp.

bool Gaudi::Utils::StopSignalHandler::m_stopRequested

private

Flag to remember if the stop has been requested because of a signal.

Definition at line 449 of file SignalMonitorSvc.cpp.

std::vector<std::string> Gaudi::Utils::StopSignalHandler::m_usedSignals

private

List of signal names or numbers (encoded as strings) to use to schedule a stop.

Definition at line 445 of file SignalMonitorSvc.cpp.

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

GaudiUtils/src/component/SignalMonitorSvc.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation