| The Gaudi Framework v29r0 (ff2e7097)

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

- File List
- File Members

IncidentSvc.cpp
Go to the documentation of this file.
1 #ifdef _WIN32
2 // ============================================================================
3 // Avoid conflicts between windows and the message service.
4 // ============================================================================
5 #define NOMSG
6 #define NOGDI
7 #endif
8 // ============================================================================
9 // Include Files
10 // ============================================================================
11 #include "GaudiKernel/AppReturnCode.h"
12 #include "GaudiKernel/GaudiException.h"
13 #include "GaudiKernel/IIncidentListener.h"
14 #include "GaudiKernel/ISvcLocator.h"
15 #include "GaudiKernel/Incident.h"
16 #include "GaudiKernel/LockedChrono.h"
17 #include "GaudiKernel/MsgStream.h"
18 #include "GaudiKernel/SmartIF.h"
19 #include <functional>
20 // ============================================================================
21 // Local
22 // ============================================================================
23 #include "IncidentSvc.h"
24 // ============================================================================
25 // Instantiation of a static factory class used by clients to create
26 // instances of this service
27 DECLARE_COMPONENT( IncidentSvc )
28 // ============================================================================
29 namespace
30 {
31 // ==========================================================================
32 static const std::string s_unknown = "<unknown>";
33 // Helper to get the name of the listener
34 inline const std::string& getListenerName( IIncidentListener* lis )
35 {
36 SmartIF<INamedInterface> iNamed( lis );
37 return iNamed ? iNamed->name() : s_unknown;
38 }
39 // ==========================================================================
40 }
41
42 #define ON_DEBUG if ( msgLevel( MSG::DEBUG ) )
43 #define ON_VERBOSE if ( msgLevel( MSG::VERBOSE ) )
44
45 #define DEBMSG ON_DEBUG debug()
46 #define VERMSG ON_VERBOSE verbose()
47
48 // ============================================================================
49 // Constructors and Destructors
50 // ============================================================================
51 IncidentSvc::IncidentSvc( const std::string& name, ISvcLocator* svc ) : base_class( name, svc ) {}
52 // ============================================================================
53 IncidentSvc::~IncidentSvc() { std::unique_lock<std::recursive_mutex> lock( m_listenerMapMutex ); }
54 // ============================================================================
55 // Inherited Service overrides:
56 // ============================================================================
57 StatusCode IncidentSvc::initialize()
58 {
59 // initialize the Service Base class
60 StatusCode sc = Service::initialize();
61 if ( sc.isFailure() ) return sc;
62
63 m_currentIncidentType = nullptr;
64
65 // set my own (IncidentSvc) properties via the jobOptionService
66 sc = setProperties();
67 if ( UNLIKELY( sc.isFailure() ) ) {
68 error() << "Could not set my properties" << endmsg;
69 return sc;
70 }
71 return StatusCode::SUCCESS;
72 }
73 // ============================================================================
74 StatusCode IncidentSvc::finalize()
75 {
76 DEBMSG << m_timer.outputUserTime( "Incident timing: Mean(+-rms)/Min/Max:%3%(+-%4%)/%6%/%7%[ms] ", System::milliSec )
77 << m_timer.outputUserTime( "Total:%2%[s]", System::Sec ) << endmsg;
78
79 // Finalize this specific service
80 StatusCode sc = Service::finalize();
81 if ( UNLIKELY( sc.isFailure() ) ) {
82 return sc;
83 }
84
85 return StatusCode::SUCCESS;
86 }
87 // ============================================================================
88 // Inherited IIncidentSvc overrides:
89 // ============================================================================
90 void IncidentSvc::addListener( IIncidentListener* lis, const std::string& type, long prio, bool rethrow,
91 bool singleShot )
92 {
93 static const std::string all{"ALL"};
94 std::unique_lock<std::recursive_mutex> lock( m_listenerMapMutex );
95
96 const std::string& ltype = ( !type.empty() ? type : all );
97
98 // find if the type already exists
99 auto itMap = m_listenerMap.find( ltype );
100 if ( itMap == m_listenerMap.end() ) {
101 // if not found, create and insert now a list of listeners
102 auto p = m_listenerMap.insert( {ltype, std::unique_ptr<ListenerList>( new ListenerList() )} );
103 if ( !p.second ) { /* OOPS */
104 }
105 itMap = p.first;
106 }
107 auto& llist = *itMap->second;
108 // add Listener ordered by priority -- higher priority first,
109 // and then add behind listeneres with the same priority
110 // -- so we skip over all items with higher or same priority
111 auto i = std::partition_point( std::begin( llist ), std::end( llist ),
112 [&]( const Listener& j ) { return j.priority >= prio; } );
113 // We insert before the current position
114 DEBMSG << "Adding [" << type << "] listener '" << getListenerName( lis ) << "' with priority " << prio << endmsg;
115 llist.emplace( i, lis, prio, rethrow, singleShot );
116 }
117 // ============================================================================
118 IncidentSvc::ListenerMap::iterator IncidentSvc::removeListenerFromList( ListenerMap::iterator i,
119 IIncidentListener* item, bool scheduleRemoval )
120 {
121 auto match = [&]( ListenerList::const_reference j ) { return !item || item == j.iListener; };
122
123 auto& c = *( i->second );
124 if ( !scheduleRemoval ) {
125 ON_DEBUG std::for_each( std::begin( c ), std::end( c ), [&]( ListenerList::const_reference j ) {
126 if ( match( j ) )
127 debug() << "Removing [" << i->first << "] listener '" << getListenerName( j.iListener ) << "'" << endmsg;
128 } );
129 c.erase( std::remove_if( std::begin( c ), std::end( c ), match ), std::end( c ) );
130 } else {
131 std::for_each( std::begin( c ), std::end( c ), [&]( Listener& i ) {
132 if ( match( i ) ) i.singleShot = true; // will trigger removal as soon as it is safe
133 } );
134 }
135 return c.empty() ? m_listenerMap.erase( i ) : std::next( i );
136 }
137 // ============================================================================
138 void IncidentSvc::removeListener( IIncidentListener* lis, const std::string& type )
139 {
140 std::unique_lock<std::recursive_mutex> lock( m_listenerMapMutex );
141
142 bool scheduleForRemoval = ( m_currentIncidentType && type == *m_currentIncidentType );
143 if ( type.empty() ) {
144 auto i = std::begin( m_listenerMap );
145 while ( i != std::end( m_listenerMap ) ) {
146 i = removeListenerFromList( i, lis, scheduleForRemoval );
147 }
148 } else {
149 auto i = m_listenerMap.find( type );
150 if ( i != m_listenerMap.end() ) removeListenerFromList( i, lis, scheduleForRemoval );
151 }
152 }
153 // ============================================================================
154 namespace
155 {
157 constexpr struct isSingleShot_t {
158 bool operator()( const IncidentSvc::Listener& l ) const { return l.singleShot; }
159 } isSingleShot{};
160 }
161 // ============================================================================
162 void IncidentSvc::i_fireIncident( const Incident& incident, const std::string& listenerType )
163 {
164
165 std::unique_lock<std::recursive_mutex> lock( m_listenerMapMutex );
166
167 // Wouldn't it be better to write a small 'ReturnCode' service which
168 // looks for these 'special' incidents and does whatever needs to
169 // be done instead of making a special case here?
170
171 // Special case: FailInputFile incident must set the application return code
172 if ( incident.type() == IncidentType::FailInputFile || incident.type() == IncidentType::CorruptedInputFile ) {
173 auto appmgr = serviceLocator()->as<IProperty>();
174 Gaudi::setAppReturnCode( appmgr, incident.type() == IncidentType::FailInputFile
175 ? Gaudi::ReturnCode::FailInput
176 : Gaudi::ReturnCode::CorruptedInput )
177 .ignore();
178 }
179
180 auto ilisteners = m_listenerMap.find( listenerType );
181 if ( m_listenerMap.end() == ilisteners ) return;
182
183 // setting this pointer will avoid that a call to removeListener() during
184 // the loop triggers a segfault
185 m_currentIncidentType = &incident.type();
186
187 bool firedSingleShot = false;
188
189 auto& listeners = *ilisteners->second;
190
191 for ( auto& listener : listeners ) {
192
193 VERMSG << "Calling '" << getListenerName( listener.iListener ) << "' for incident [" << incident.type() << "]"
194 << endmsg;
195
196 // handle exceptions if they occur
197 try {
198 listener.iListener->handle( incident );
199 } catch ( const GaudiException& exc ) {
200 error() << "Exception with tag=" << exc.tag() << " is caught"
201 " handling incident "
202 << *m_currentIncidentType << endmsg;
203 error() << exc << endmsg;
204 if ( listener.rethrow ) {
205 throw exc;
206 }
207 } catch ( const std::exception& exc ) {
208 error() << "Standard std::exception is caught"
209 " handling incident "
210 << *m_currentIncidentType << endmsg;
211 error() << exc.what() << endmsg;
212 if ( listener.rethrow ) {
213 throw exc;
214 }
215 } catch ( ... ) {
216 error() << "UNKNOWN Exception is caught"
217 " handling incident "
218 << *m_currentIncidentType << endmsg;
219 if ( listener.rethrow ) {
220 throw;
221 }
222 }
223 // check wheter one of the listeners is singleShot
224 firedSingleShot |= listener.singleShot;
225 }
226 if ( firedSingleShot ) {
227 // remove all the singleshot listeners that got there shot...
228 listeners.erase( std::remove_if( std::begin( listeners ), std::end( listeners ), isSingleShot ),
229 std::end( listeners ) );
230 if ( listeners.empty() ) m_listenerMap.erase( ilisteners );
231 }
232
233 m_currentIncidentType = nullptr;
234 }
235 // ============================================================================
236 void IncidentSvc::fireIncident( const Incident& incident )
237 {
238
239 Gaudi::Utils::LockedChrono timer( m_timer, m_timerLock );
240
241 // Call specific listeners
242 i_fireIncident( incident, incident.type() );
243 // Try listeners registered for ALL incidents
244 if ( incident.type() != "ALL" ) { // avoid double calls if somebody fires the incident "ALL"
245 i_fireIncident( incident, "ALL" );
246 }
247 }
248 // ============================================================================
249 void IncidentSvc::fireIncident( std::unique_ptr<Incident> incident )
250 {
251
252 DEBMSG << "Async incident '" << incident->type() << "' fired on context " << incident->context() << endmsg;
253 auto ctx = incident->context();
254 auto res = m_firedIncidents.insert( std::make_pair( ctx, IncQueue_t() ) );
255 res.first->second.push( incident.release() );
256 }
257 // ============================================================================
258
259 void IncidentSvc::getListeners( std::vector<IIncidentListener*>& l, const std::string& type ) const
260 {
261 static const std::string ALL{"ALL"};
262 std::unique_lock<std::recursive_mutex> lock( m_listenerMapMutex );
263
264 const std::string& ltype = ( !type.empty() ? type : ALL );
265
266 l.clear();
267 auto i = m_listenerMap.find( ltype );
268 if ( i != m_listenerMap.end() ) {
269 l.reserve( i->second->size() );
270 std::transform( std::begin( *i->second ), std::end( *i->second ), std::back_inserter( l ),
271 []( const Listener& j ) { return j.iListener; } );
272 }
273 }
274
275 // ============================================================================
276
277 IIncidentSvc::IncidentPack IncidentSvc::getIncidents( const EventContext* ctx )
278 {
279 IIncidentSvc::IncidentPack p;
280 if ( ctx ) {
281 auto incs = m_firedIncidents.find( *ctx );
282 if ( incs != m_firedIncidents.end() ) {
283 Incident* inc( 0 );
284
285 DEBMSG << "Collecting listeners fired on context " << *ctx << endmsg;
286 while ( incs->second.try_pop( inc ) ) {
287 std::vector<IIncidentListener*> ls;
288 getListeners( ls, inc->type() );
289 p.incidents.emplace_back( std::move( inc ) );
290 p.listeners.emplace_back( std::move( ls ) );
291 }
292 }
293 }
294 return p;
295 }
296 // ============================================================================
297 // The END
298 // ============================================================================
UNLIKELY
#define UNLIKELY(x)
Definition: Kernel.h:128
Service::initialize
StatusCode initialize() override
Definition: Service.cpp:64
StatusCode::SUCCESS
Definition: StatusCode.h:31
SmartIF< INamedInterface >
GaudiKernel.Constants.ALL
int ALL
Definition: Constants.py:11
IncidentSvc::m_timer
ChronoEntity m_timer
timer & it&#39;s lock
Definition: IncidentSvc.h:99
std::string::empty
T empty(T...args)
GaudiException
Define general base for Gaudi exception.
Definition: GaudiException.h:22
ISvcLocator
The ISvcLocator is the interface implemented by the Service Factory in the Application Manager to loc...
Definition: ISvcLocator.h:25
gaudirun.c
c
Definition: gaudirun.py:407
Incident::type
const std::string & type() const
Access to the incident type.
Definition: Incident.h:41
gaudiComponentHelp.name
name
Definition: gaudiComponentHelp.py:32
IncidentSvc::finalize
StatusCode finalize() override
Definition: IncidentSvc.cpp:74
Service::finalize
StatusCode finalize() override
Definition: Service.cpp:174
MsgStream.h
std::partition_point
T partition_point(T...args)
IncidentSvc::m_timerLock
bool m_timerLock
Definition: IncidentSvc.h:100
IncidentSvc::addListener
void addListener(IIncidentListener *lis, const std::string &type="", long priority=0, bool rethrow=false, bool singleShot=false) override
Definition: IncidentSvc.cpp:90
ON_DEBUG
#define ON_DEBUG
Definition: IncidentSvc.cpp:42
IncidentSvc::getIncidents
IIncidentSvc::IncidentPack getIncidents(const EventContext *ctx) override
Definition: IncidentSvc.cpp:277
IncidentSvc::removeListenerFromList
ListenerMap::iterator removeListenerFromList(ListenerMap::iterator, IIncidentListener *item, bool scheduleRemoval)
Definition: IncidentSvc.cpp:118
IncidentSvc::ListenerList
std::list< Listener > ListenerList
Definition: IncidentSvc.h:56
std::end
T end(T...args)
IncidentSvc::Listener::singleShot
bool singleShot
Definition: IncidentSvc.h:44
ISvcLocator::as
SmartIF< IFace > as()
Definition: ISvcLocator.h:109
System::milliSec
Definition: Timing.h:58
std::remove_if
T remove_if(T...args)
DEBMSG
#define DEBMSG
Definition: IncidentSvc.cpp:45
EventContext
This class represents an entry point to all the event specific data.
Definition: EventContext.h:24
StatusCode::isFailure
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:86
IncidentSvc::IncidentSvc
IncidentSvc(const std::string &name, ISvcLocator *svc)
Definition: IncidentSvc.cpp:51
std::unique_ptr::release
T release(T...args)
System::Sec
Definition: Timing.h:58
IncidentSvc::~IncidentSvc
~IncidentSvc() override
Definition: IncidentSvc.cpp:53
Gaudi::ReturnCode::CorruptedInput
constexpr int CorruptedInput
Definition: AppReturnCode.h:30
DECLARE_COMPONENT
#define DECLARE_COMPONENT(type)
Definition: PluginService.h:33
IIncidentSvc::IncidentPack::incidents
std::vector< std::unique_ptr< Incident > > incidents
Definition: IIncidentSvc.h:53
std::string
STL class.
Incident.h
GaudiUtils::Map::insert
std::pair< iterator, bool > insert(ValueType &&val)
Definition: Map.h:174
CommonMessagingBase::error
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
Definition: CommonMessaging.h:111
GaudiUtils::Map::end
iterator end()
Definition: Map.h:134
IIncidentListener
The interface implemented by any class wanting to listen to Incidents.
Definition: IIncidentListener.h:15
IncidentSvc::m_listenerMapMutex
std::recursive_mutex m_listenerMapMutex
Mutex to synchronize access to m_listenerMap.
Definition: IncidentSvc.h:96
std::exception::what
T what(T...args)
std::next
T next(T...args)
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:28
IncidentSvc::removeListener
void removeListener(IIncidentListener *l, const std::string &type="") override
Definition: IncidentSvc.cpp:138
GaudiException.h
gaudirun.type
type
Definition: gaudirun.py:133
Gaudi::ReturnCode::FailInput
constexpr int FailInput
Definition: AppReturnCode.h:25
SmartIF.h
GaudiUtils::Map::find
iterator find(const key_type &key)
Definition: Map.h:151
IncidentSvc::Listener::priority
long priority
Definition: IncidentSvc.h:42
std::make_pair
T make_pair(T...args)
GaudiException::tag
virtual const std::string & tag() const
name tag for the exception, or exception type
Definition: GaudiException.h:109
IncidentSvc::initialize
StatusCode initialize() override
Definition: IncidentSvc.cpp:57
IIncidentSvc::IncidentPack::listeners
std::vector< std::vector< IIncidentListener * > > listeners
Definition: IIncidentSvc.h:54
IncidentSvc::m_currentIncidentType
const std::string * m_currentIncidentType
Incident being fired.
Definition: IncidentSvc.h:93
IIncidentSvc::IncidentPack
Definition: IIncidentSvc.h:50
std::vector::clear
T clear(T...args)
std::exception
STL class.
Gaudi::setAppReturnCode
StatusCode setAppReturnCode(SmartIF< IProperty > &appmgr, int value, bool force=false)
Set the application return code.
Definition: AppReturnCode.h:51
LockedChrono.h
std::move
T move(T...args)
Service::setProperties
StatusCode setProperties()
Method for setting declared properties to the values specified for the job.
Definition: Service.cpp:295
IncidentSvc::IncQueue_t
tbb::concurrent_queue< Incident * > IncQueue_t
Definition: IncidentSvc.h:104
IncidentSvc::m_firedIncidents
tbb::concurrent_unordered_map< EventContext, IncQueue_t, EventContextHash, EventContextHash > m_firedIncidents
Definition: IncidentSvc.h:105
gaudirun.l
dictionary l
Definition: gaudirun.py:440
AppReturnCode.h
ChronoEntity::outputUserTime
std::string outputUserTime() const
print the chrono ;
Definition: ChronoEntity.cpp:89
IncidentSvc::getListeners
void getListeners(std::vector< IIncidentListener * > &lis, const std::string &type="") const override
Definition: IncidentSvc.cpp:259
std::unique_lock
GaudiUtils::Map< Gaudi::StringKey, std::unique_ptr< ListenerList >, std::unordered_map< Gaudi::StringKey, std::unique_ptr< ListenerList >, Hash< Gaudi::StringKey > > >::iterator
map_type::iterator iterator
Definition: Map.h:99
std::vector
STL class.
std::unique_ptr< ListenerList >
Gaudi::Utils::LockedChrono
Helper object, useful for measurement of CPU-performance of highly-recursive structures, e.g.
Definition: LockedChrono.h:52
Gaudi::Functional::operator()
virtual Out operator()(const vector_of_const_< In > &inputs) const =0
GaudiUtils::Map::erase
iterator erase(const_iterator pos)
Definition: Map.h:192
CommonMessagingBase::debug
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
Definition: CommonMessaging.h:120
VERMSG
#define VERMSG
Definition: IncidentSvc.cpp:46
std::begin
T begin(T...args)
IncidentSvc::i_fireIncident
void i_fireIncident(const Incident &incident, const std::string &type)
Internal function to allow incidents listening to all events.
Definition: IncidentSvc.cpp:162
std::back_inserter
T back_inserter(T...args)
Incident
Base class for all Incidents (computing events).
Definition: Incident.h:17
IncidentSvc::Listener
Definition: IncidentSvc.h:40
CommonMessaging
Definition: CommonMessaging.h:62
IncidentSvc::fireIncident
void fireIncident(const Incident &incident) override
Definition: IncidentSvc.cpp:236
IIncidentListener.h
std::transform
T transform(T...args)
IncidentSvc::m_listenerMap
ListenerMap m_listenerMap
List of auditor names.
Definition: IncidentSvc.h:89
IncidentSvc
Default implementation of the IIncidentSvc interface.
Definition: IncidentSvc.h:37
IncidentSvc.h
IProperty
The IProperty is the basic interface for all components which have properties that can be set or get...
Definition: IProperty.h:20
Incident::context
EventContext context() const
Access to the EventContext of the source of the incident.
Definition: Incident.h:53
std::for_each
T for_each(T...args)
ISvcLocator.h
Service::serviceLocator
SmartIF< ISvcLocator > & serviceLocator() const override
Retrieve pointer to service locator.
Definition: Service.cpp:292
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
std::vector::reserve
T reserve(T...args)
std::vector::emplace_back
T emplace_back(T...args)