Gaudi::Utils::StopSignalHandler Class Reference

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

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

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

Constructor & Destructor Documentation

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

inline

Definition at line 341 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 396 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 409 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 455 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 351 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 453 of file SignalMonitorSvc.cpp.

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

private

Pointer to the incident service.

Definition at line 451 of file SignalMonitorSvc.cpp.

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

private

Pointer to the signal monitor service.

Definition at line 449 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 445 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 447 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 443 of file SignalMonitorSvc.cpp.

---

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

• GaudiUtils/src/component/SignalMonitorSvc.cpp