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

Inheritance diagram for Gaudi::Utils::StopSignalHandler:

[legend]

Collaboration diagram for Gaudi::Utils::StopSignalHandler:

[legend]

Public Member Functions
StatusCode	initialize () override

StatusCode	finalize () override

void	handle (const Incident &) override

Public Member Functions inherited from extends< Service, IIncidentListener >
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
std::pair< int, bool >	i_decodeSignal (const std::string &sig)
	Function to translate the signal name to the signal number.

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

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

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

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

SmartIF< IIncidentSvc >	m_incidentSvc
	Pointer to the incident service.

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

Additional Inherited Members
Public Types inherited from extends< Service, IIncidentListener >
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 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

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 293 of file SignalMonitorSvc.cpp.

Member Function Documentation

◆ finalize()

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

inlineoverride

Definition at line 337 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();
      }

◆ handle()

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

inlineoverride

Definition at line 349 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;
            }
          }
        }
      }

◆ i_decodeSignal()

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 398 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 };
      }

◆ initialize()

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

inlineoverride

Definition at line 296 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

◆ m_appProperty

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

private

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

Definition at line 396 of file SignalMonitorSvc.cpp.

◆ m_incidentSvc

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

private

Pointer to the incident service.

Definition at line 394 of file SignalMonitorSvc.cpp.

◆ m_signalMonitor

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

private

Pointer to the signal monitor service.

Definition at line 392 of file SignalMonitorSvc.cpp.

◆ m_signals

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 388 of file SignalMonitorSvc.cpp.

◆ m_stopRequested

bool Gaudi::Utils::StopSignalHandler::m_stopRequested = false

private

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

Definition at line 390 of file SignalMonitorSvc.cpp.

◆ m_usedSignals

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

private

Initial value:

{
          this,
          "Signals",
          { "SIGINT", "SIGXCPU" },
          "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)." }

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

Definition at line 380 of file SignalMonitorSvc.cpp.

                                                       {
          this,
          "Signals",
          { "SIGINT", "SIGXCPU" },
          "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)." };

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

Member Function Documentation

◆ finalize()

◆ handle()

◆ i_decodeSignal()

◆ initialize()

Member Data Documentation

◆ m_appProperty

◆ m_incidentSvc

◆ m_signalMonitor

◆ m_signals

◆ m_stopRequested

◆ m_usedSignals