| The Gaudi Framework v27r1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Types | Public Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
Gaudi::Utils::SignalMonitorSvc Class Reference

Implementation of Gaudi::ISignalMonitor. More...

Inheritance diagram for Gaudi::Utils::SignalMonitorSvc:
[legend]
Collaboration diagram for Gaudi::Utils::SignalMonitorSvc:
[legend]

## Public Types
typedef struct sigaction | handler_t
Public Types inherited from extends< Service, Gaudi::ISignalMonitor >
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...

## Public Member Functions
void | monitorSignal (int signum, bool propagate) override
| Declare a signal to be monitored. More...
void | ignoreSignal (int signum) override
| Remove the specific signal handler for the requested signal, restoring the previous signal handler. More...
bool | gotSignal (int signum) const override
| Check if the given signal has been received. More...
void | setSignal (int signum) override
| Set the flag for the given signal, as if the signal was received. More...
void | clearSignal (int signum) override
| Clear the flag for the given signal, so that a new occurrence can be identified. More...
| SignalMonitorSvc (const std::string &name, ISvcLocator *svcLoc)
| Initialize internal variables of the service and set the instance pointer. More...
| ~SignalMonitorSvc () override
| Stop monitoring signals and clear the instance pointer. More...
Public Member Functions inherited from extends< Service, Gaudi::ISignalMonitor >
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 Types
enum | MonitoringMode { ignored, trap, propagate }
| Possible monitoring modes. More...

## Private Member Functions
void | i_handle (int signum)

## Static Private Member Functions
static void | setInstance (SignalMonitorSvc *i)
static SignalMonitorSvc * | instance ()
| Method to get the singleton instance. More...
static void | dispatcher (int signum)
| Signal handler function. More...

## Private Attributes
MonitoringMode | m_monitored [NSIG]
| Array of flags to keep track of monitored signals. More...
sig_atomic_t | m_caught [NSIG]
| Array of flags for received signals. More...
handler_t | m_defaultAction
| Helper variable for default signal action. More...
handler_t | m_oldActions [NSIG]
| List of replaced signal actions (for the recovery when disable the monitoring). More...

## Static Private Attributes
static SignalMonitorSvc * | s_instance = nullptr
| Pointer to the current instance. More...

## Additional Inherited Members
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

Implementation of Gaudi::ISignalMonitor.

If instantiated, intercepts the system signals and keep track of the recorded ones.

The signal to be monitored have to be declared via the method monitorSignal(). It can be interrogated to check if a signal has been received.

Definition at line 26 of file SignalMonitorSvc.cpp.

## Member Typedef Documentation

typedef struct sigaction Gaudi::Utils::SignalMonitorSvc::handler_t

Definition at line 32 of file SignalMonitorSvc.cpp.

## Member Enumeration Documentation

enum Gaudi::Utils::SignalMonitorSvc::MonitoringMode
| private

Possible monitoring modes.

Enumerator
ignored |
trap |
propagate |

Definition at line 111 of file SignalMonitorSvc.cpp.

111 {
112 ignored, //< the signal is not monitored
113 trap, //< the signal is monitored and not propagated to previously registered handlers
114 propagate //< the signal is monitored and propagated to previously registered handlers
115 };
Gaudi::Utils::SignalMonitorSvc::propagate
Definition: SignalMonitorSvc.cpp:114
Gaudi::Utils::SignalMonitorSvc::ignored
Definition: SignalMonitorSvc.cpp:112
Gaudi::Utils::SignalMonitorSvc::trap
Definition: SignalMonitorSvc.cpp:113

## Constructor & Destructor Documentation

Gaudi::Utils::SignalMonitorSvc::SignalMonitorSvc | ( | const std::string & | name,
|  | ISvcLocator * | svcLoc
| ) |  |
| inline

Initialize internal variables of the service and set the instance pointer.

Definition at line 86 of file SignalMonitorSvc.cpp.

86 : base_class(name, svcLoc) {
87 #ifdef _WIN32
88 m_defaultAction = SIG_DFL;
89 #else
90 m_defaultAction.sa_handler = SIG_DFL;
91 sigemptyset(&m_defaultAction.sa_mask);
92 m_defaultAction.sa_flags = 0;
93 #endif
94 for(int i = 0; i < NSIG; ++i){
95 m_caught[i] = 0;
96 m_monitored[i] = ignored;
97 m_oldActions[i] = m_defaultAction;
98 }
99
100 setInstance(this);
101 }
Gaudi::Utils::SignalMonitorSvc::m_caught
sig_atomic_t m_caught[NSIG]
Array of flags for received signals.
Definition: SignalMonitorSvc.cpp:119
extends< Service, Gaudi::ISignalMonitor >::base_class
extends base_class
Typedef to this class.
Definition: extends.h:14
Gaudi::Utils::SignalMonitorSvc::ignored
Definition: SignalMonitorSvc.cpp:112
Gaudi::Utils::SignalMonitorSvc::setInstance
static void setInstance(SignalMonitorSvc *i)
Definition: SignalMonitorSvc.cpp:145
Gaudi::Utils::SignalMonitorSvc::m_monitored
MonitoringMode m_monitored[NSIG]
Array of flags to keep track of monitored signals.
Definition: SignalMonitorSvc.cpp:117
Gaudi::Utils::SignalMonitorSvc::m_oldActions
handler_t m_oldActions[NSIG]
List of replaced signal actions (for the recovery when disable the monitoring).
Definition: SignalMonitorSvc.cpp:123
Gaudi::Utils::SignalMonitorSvc::m_defaultAction
handler_t m_defaultAction
Helper variable for default signal action.
Definition: SignalMonitorSvc.cpp:121
ana.i
list i
Definition: ana.py:128

Gaudi::Utils::SignalMonitorSvc::~SignalMonitorSvc | ( |  | ) |
| inline override

Stop monitoring signals and clear the instance pointer.

Definition at line 104 of file SignalMonitorSvc.cpp.

104 {
105 for (int i = 0; i < NSIG; ++i) ignoreSignal(i);
106 setInstance(nullptr);
107 }
Gaudi::Utils::SignalMonitorSvc::ignoreSignal
void ignoreSignal(int signum) override
Remove the specific signal handler for the requested signal, restoring the previous signal handler...
Definition: SignalMonitorSvc.cpp:58
Gaudi::Utils::SignalMonitorSvc::setInstance
static void setInstance(SignalMonitorSvc *i)
Definition: SignalMonitorSvc.cpp:145
ana.i
list i
Definition: ana.py:128

## Member Function Documentation

void Gaudi::Utils::SignalMonitorSvc::clearSignal | ( | int | signum | ) |
| inline override

Clear the flag for the given signal, so that a new occurrence can be identified.

Definition at line 81 of file SignalMonitorSvc.cpp.

81 {
82 m_caught[signum] = 0;
83 }
Gaudi::Utils::SignalMonitorSvc::m_caught
sig_atomic_t m_caught[NSIG]
Array of flags for received signals.
Definition: SignalMonitorSvc.cpp:119

void Gaudi::Utils::SignalMonitorSvc::dispatcher | ( | int | signum | ) |
| static private

Signal handler function.

Definition at line 160 of file SignalMonitorSvc.cpp.

160 {
161 if (instance()) instance()->i_handle(signum);
162 }
Gaudi::Utils::SignalMonitorSvc::i_handle
void i_handle(int signum)
Definition: SignalMonitorSvc.cpp:125
Gaudi::Utils::SignalMonitorSvc::instance
static SignalMonitorSvc * instance()
Method to get the singleton instance.
Definition: SignalMonitorSvc.cpp:151

bool Gaudi::Utils::SignalMonitorSvc::gotSignal | ( | int | signum | ) | const
| inline override

Check if the given signal has been received.

Definition at line 71 of file SignalMonitorSvc.cpp.

71 {
72 return m_caught[signum] != 0;
73 }
Gaudi::Utils::SignalMonitorSvc::m_caught
sig_atomic_t m_caught[NSIG]
Array of flags for received signals.
Definition: SignalMonitorSvc.cpp:119

void Gaudi::Utils::SignalMonitorSvc::i_handle | ( | int | signum | ) |
| inline private

Definition at line 125 of file SignalMonitorSvc.cpp.

125 {
126 m_caught[signum] = 1;
127 if ( m_monitored[signum] == propagate &&
128 #ifdef _WIN32
129 m_oldActions[signum] != SIG_DFL
130 #else
131 m_oldActions[signum].sa_handler != SIG_DFL
132 #endif
133 ) {
134 #ifdef _WIN32
135 m_oldActions[signum](signum);
136 #else
137 m_oldActions[signum].sa_handler(signum);
138 #endif
139 }
140 }
Gaudi::Utils::SignalMonitorSvc::m_caught
sig_atomic_t m_caught[NSIG]
Array of flags for received signals.
Definition: SignalMonitorSvc.cpp:119
Gaudi::Utils::SignalMonitorSvc::propagate
Definition: SignalMonitorSvc.cpp:114
Gaudi::Utils::SignalMonitorSvc::m_monitored
MonitoringMode m_monitored[NSIG]
Array of flags to keep track of monitored signals.
Definition: SignalMonitorSvc.cpp:117
Gaudi::Utils::SignalMonitorSvc::m_oldActions
handler_t m_oldActions[NSIG]
List of replaced signal actions (for the recovery when disable the monitoring).
Definition: SignalMonitorSvc.cpp:123

void Gaudi::Utils::SignalMonitorSvc::ignoreSignal | ( | int | signum | ) |
| inline override

Remove the specific signal handler for the requested signal, restoring the previous signal handler.

Definition at line 58 of file SignalMonitorSvc.cpp.

58 {
59 if (m_monitored[signum]) {
60 #ifdef _WIN32
61 (void) signal(signum, m_oldActions[signum]);
62 #else
63 sigaction(signum, &m_oldActions[signum], nullptr);
64 #endif
65 m_oldActions[signum] = m_defaultAction;
66 m_monitored[signum] = ignored;
67 }
68 }
Gaudi::Utils::SignalMonitorSvc::ignored
Definition: SignalMonitorSvc.cpp:112
std::signal
T signal(T...args)
Gaudi::Utils::SignalMonitorSvc::m_monitored
MonitoringMode m_monitored[NSIG]
Array of flags to keep track of monitored signals.
Definition: SignalMonitorSvc.cpp:117
Gaudi::Utils::SignalMonitorSvc::m_oldActions
handler_t m_oldActions[NSIG]
List of replaced signal actions (for the recovery when disable the monitoring).
Definition: SignalMonitorSvc.cpp:123
Gaudi::Utils::SignalMonitorSvc::m_defaultAction
handler_t m_defaultAction
Helper variable for default signal action.
Definition: SignalMonitorSvc.cpp:121

static SignalMonitorSvc* Gaudi::Utils::SignalMonitorSvc::instance | ( |  | ) |
| inline static private

Method to get the singleton instance.

Bypass the serviceLocator for efficiency.

Definition at line 151 of file SignalMonitorSvc.cpp.

151 {
152 return s_instance;
153 }
Gaudi::Utils::SignalMonitorSvc::s_instance
static SignalMonitorSvc * s_instance
Pointer to the current instance.
Definition: SignalMonitorSvc.cpp:143

void Gaudi::Utils::SignalMonitorSvc::monitorSignal | ( | int | signum,
|  | bool | propagate
| ) |  |
| inline override

Declare a signal to be monitored.

It installs a signal handler for the requested signal.

Definition at line 37 of file SignalMonitorSvc.cpp.

37 {
38 if (!m_monitored[signum]) {
39 handler_t sa;
40 handler_t oldact;
41 #ifdef _WIN32
42 sa = SignalMonitorSvc::dispatcher;
43 oldact = signal(signum, sa);
44 #else
45 sa.sa_handler = SignalMonitorSvc::dispatcher;
46 sigemptyset(&sa.sa_mask);
47 sa.sa_flags = 0;
48 sigaction(signum, &sa, &oldact);
49 #endif
50 m_oldActions[signum] = oldact;
51 m_monitored[signum] = (propagate) ? SignalMonitorSvc::propagate
52 : SignalMonitorSvc::trap;
53 }
54 }
Gaudi::Utils::SignalMonitorSvc::propagate
Definition: SignalMonitorSvc.cpp:114
Gaudi::Utils::SignalMonitorSvc::dispatcher
static void dispatcher(int signum)
Signal handler function.
Definition: SignalMonitorSvc.cpp:160
std::signal
T signal(T...args)
Gaudi::Utils::SignalMonitorSvc::m_monitored
MonitoringMode m_monitored[NSIG]
Array of flags to keep track of monitored signals.
Definition: SignalMonitorSvc.cpp:117
Gaudi::Utils::SignalMonitorSvc::m_oldActions
handler_t m_oldActions[NSIG]
List of replaced signal actions (for the recovery when disable the monitoring).
Definition: SignalMonitorSvc.cpp:123
Gaudi::Utils::SignalMonitorSvc::trap
Definition: SignalMonitorSvc.cpp:113
Gaudi::Utils::SignalMonitorSvc::handler_t
struct sigaction handler_t
Definition: SignalMonitorSvc.cpp:32

static void Gaudi::Utils::SignalMonitorSvc::setInstance | ( | SignalMonitorSvc * | i | ) |
| inline static private

Definition at line 145 of file SignalMonitorSvc.cpp.

145 {
146 s_instance = i;
147 }
Gaudi::Utils::SignalMonitorSvc::s_instance
static SignalMonitorSvc * s_instance
Pointer to the current instance.
Definition: SignalMonitorSvc.cpp:143
ana.i
list i
Definition: ana.py:128

void Gaudi::Utils::SignalMonitorSvc::setSignal | ( | int | signum | ) |
| inline override

Set the flag for the given signal, as if the signal was received.

Definition at line 76 of file SignalMonitorSvc.cpp.

76 {
77 m_caught[signum] = 1;
78 }
Gaudi::Utils::SignalMonitorSvc::m_caught
sig_atomic_t m_caught[NSIG]
Array of flags for received signals.
Definition: SignalMonitorSvc.cpp:119

## Member Data Documentation

sig_atomic_t Gaudi::Utils::SignalMonitorSvc::m_caught[NSIG]
| private

Array of flags for received signals.

Definition at line 119 of file SignalMonitorSvc.cpp.

handler_t Gaudi::Utils::SignalMonitorSvc::m_defaultAction
| private

Helper variable for default signal action.

Definition at line 121 of file SignalMonitorSvc.cpp.

MonitoringMode Gaudi::Utils::SignalMonitorSvc::m_monitored[NSIG]
| private

Array of flags to keep track of monitored signals.

Definition at line 117 of file SignalMonitorSvc.cpp.

handler_t Gaudi::Utils::SignalMonitorSvc::m_oldActions[NSIG]
| private

List of replaced signal actions (for the recovery when disable the monitoring).

Definition at line 123 of file SignalMonitorSvc.cpp.

Gaudi::Utils::SignalMonitorSvc * Gaudi::Utils::SignalMonitorSvc::s_instance = nullptr
| static private

Pointer to the current instance.

Definition at line 143 of file SignalMonitorSvc.cpp.

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

- GaudiUtils/src/component/SignalMonitorSvc.cpp