| The Gaudi Framework v29r0 (ff2e7097)

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

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

Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
StatusCodeSvc Class Reference

`#include <src/StatusCodeSvc.h>`

Inheritance diagram for StatusCodeSvc:
[legend]
Collaboration diagram for StatusCodeSvc:
[legend]

## Classes
struct | StatCodeDat

## Public Member Functions
StatusCode | initialize () override
StatusCode | reinitialize () override
StatusCode | finalize () override
void | regFnc (const std::string &func, const std::string &lib) override
void | list () const override
bool | suppressCheck () const override
| ~StatusCodeSvc () override=default
Public Member Functions inherited from extends< Service, IStatusCodeSvc >
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...
| 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 >
StatusCode | declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
| Declare used 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 PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
| PropertyHolder ()=default
| ~PropertyHolder () override=default
Gaudi::Details::PropertyBase & | declareProperty (Gaudi::Details::PropertyBase &prop)
| Declare a property. More...
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. More...
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, TYPE &value, const std::string &doc="none") const
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. More...
Gaudi::Details::PropertyBase * | declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
| Declare a remote property. More...
StatusCode | setProperty (const Gaudi::Details::PropertyBase &p) override
| set the property form another property More...
StatusCode | setProperty (const std::string &s) override
| set the property from the formatted string More...
StatusCode | setProperty (const std::string &n, const std::string &v) override
| set the property from name and the value More...
StatusCode | setProperty (const std::string &name, const TYPE &value)
| set the property form the value More...
StatusCode | getProperty (Gaudi::Details::PropertyBase *p) const override
| get the property More...
const Gaudi::Details::PropertyBase & | getProperty (const std::string &name) const override
| get the property by name More...
StatusCode | getProperty (const std::string &n, std::string &v) const override
| convert the property to the string More...
const std::vector< Gaudi::Details::PropertyBase * > & | getProperties () const override
| get all properties More...
bool | hasProperty (const std::string &name) const override
| Return true if we have a property with the given name. More...
| PropertyHolder (const PropertyHolder &)=delete
PropertyHolder & | operator= (const PropertyHolder &)=delete
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, GaudiHandleBase &ref, const std::string &doc="none")
| Specializations for various GaudiHandles. More...
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, GaudiHandleArrayBase &ref, const std::string &doc="none")
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, DataObjectHandleBase &ref, const std::string &doc="none")
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
void | parseFilter (const std::string &str, std::string &fnc, std::string &lib)
void | filterFnc (const std::string &)
void | filterLib (const std::string &)

## Private Attributes
Gaudi::Property< std::vector< std::string > > | m_pFilter {this, "Filter"}
Gaudi::Property< bool > | m_abort {this, "AbortOnError", false}
Gaudi::Property< bool > | m_suppress {this, "SuppressCheck", false}
Gaudi::Property< bool > | m_dict {this, "IgnoreDicts", true}
std::map< std::string, StatCodeDat > | m_dat
std::set< std::string > | m_filterfnc
std::set< std::string > | m_filterlib

## Additional Inherited Members
Public Types inherited from extends< Service, IStatusCodeSvc >
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 PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using | PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
| Typedef used to refer to this class from derived classes, as in. More...
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 PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBase * | property (const std::string &name) const
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
Gaudi::StateMachine::State | m_state = Gaudi::StateMachine::OFFLINE
| Service state. More...
Gaudi::StateMachine::State | m_targetState = Gaudi::StateMachine::OFFLINE
| Service state. More...
Gaudi::Property< int > | m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}
Gaudi::Property< bool > | m_auditInit {this, "AuditServices", false, "[[deprecated]] unused"}
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()"}
SmartIF< IAuditorSvc > | m_pAuditorSvc
| Auditor Service. More...

## Detailed Description

Definition at line 12 of file StatusCodeSvc.h.

## Constructor & Destructor Documentation

StatusCodeSvc::~StatusCodeSvc | ( |  | ) |
| override default

## Member Function Documentation

void StatusCodeSvc::filterFnc | ( | const std::string & | str | ) |
| private

Definition at line 159 of file StatusCodeSvc.cpp.

160 {
161
162 auto itr = std::find_if( m_dat.begin(), m_dat.end(),
163 [&]( const std::pair<std::string, StatCodeDat>& d ) { return d.second.fnc == str; } );
164 if ( itr != std::end( m_dat ) ) m_dat.erase( itr );
165 }
std::end
T end(T...args)
std::pair
std::find_if
T find_if(T...args)
StatusCodeSvc::m_dat
std::map< std::string, StatCodeDat > m_dat
Definition: StatusCodeSvc.h:45

void StatusCodeSvc::filterLib | ( | const std::string & | str | ) |
| private

Definition at line 168 of file StatusCodeSvc.cpp.

169 {
170
171 auto itr = std::find_if( m_dat.begin(), m_dat.end(),
172 [&]( const std::pair<std::string, StatCodeDat>& d ) { return d.second.lib == str; } );
173 if ( itr != std::end( m_dat ) ) m_dat.erase( itr );
174 }
std::end
T end(T...args)
std::pair
std::find_if
T find_if(T...args)
StatusCodeSvc::m_dat
std::map< std::string, StatCodeDat > m_dat
Definition: StatusCodeSvc.h:45

StatusCode StatusCodeSvc::finalize | ( |  | ) |
| override

Definition at line 53 of file StatusCodeSvc.cpp.

54 {
55
56 if ( !m_dat.empty() ) {
57
58 info() << "listing all unchecked return codes:" << endmsg;
59
60 list();
61
62 } else {
63
64 if ( msgLevel( MSG::DEBUG ) ) debug() << "all StatusCode instances where checked" << endmsg;
65 }
66
67 return StatusCode::SUCCESS;
68 }
StatusCode::SUCCESS
Definition: StatusCode.h:31
CommonMessagingBase::info
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
Definition: CommonMessaging.h:117
MSG::DEBUG
Definition: IMessageSvc.h:16
CommonMessagingBase::debug
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
Definition: CommonMessaging.h:120
StatusCodeSvc::m_dat
std::map< std::string, StatCodeDat > m_dat
Definition: StatusCodeSvc.h:45
CommonMessagingBase::msgLevel
MSG::Level msgLevel() const
get the output level from the embedded MsgStream
Definition: CommonMessaging.h:129
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
StatusCodeSvc::list
void list() const override
Definition: StatusCodeSvc.cpp:128

StatusCode StatusCodeSvc::initialize | ( |  | ) |
| override

Definition at line 14 of file StatusCodeSvc.cpp.

15 {
16
17 StatusCode sc = Service::initialize();
18 if ( !sc.isSuccess() ) return sc;
19
20 info() << "initialize" << endmsg;
21
22 for ( const auto& itr : m_pFilter.value() ) {
23 // we need to do this if someone has gotten to regFnc before initialize
24
25 string fnc, lib;
26 parseFilter( itr, fnc, lib );
27
28 if ( !fnc.empty() ) {
29 filterFnc( fnc );
30 m_filterfnc.insert( fnc );
31 }
32
33 if ( !lib.empty() ) {
34 filterLib( lib );
35 m_filterlib.insert( lib );
36 }
37 }
38
39 return StatusCode::SUCCESS;
40 }
Service::initialize
StatusCode initialize() override
Definition: Service.cpp:64
StatusCode::SUCCESS
Definition: StatusCode.h:31
std::string::empty
T empty(T...args)
CommonMessagingBase::info
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
Definition: CommonMessaging.h:117
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
StatusCodeSvc::parseFilter
void parseFilter(const std::string &str, std::string &fnc, std::string &lib)
Definition: StatusCodeSvc.cpp:178
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:28
StatusCodeSvc::m_filterfnc
std::set< std::string > m_filterfnc
Definition: StatusCodeSvc.h:46
std::set::insert
T insert(T...args)
StatusCodeSvc::filterLib
void filterLib(const std::string &)
Definition: StatusCodeSvc.cpp:168
StatusCodeSvc::m_pFilter
Gaudi::Property< std::vector< std::string > > m_pFilter
Definition: StatusCodeSvc.h:40
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
StatusCodeSvc::filterFnc
void filterFnc(const std::string &)
Definition: StatusCodeSvc.cpp:159
StatusCodeSvc::m_filterlib
std::set< std::string > m_filterlib
Definition: StatusCodeSvc.h:46

void StatusCodeSvc::list | ( |  | ) | const
| override

Definition at line 128 of file StatusCodeSvc.cpp.

129 {
130
131 std::ostringstream os;
132 os << "Num | Function | Source Library" << endl;
133 os << "----+--------------------------------+-------------------"
134 << "-----------------------" << endl;
135
136 for ( const auto& itr : m_dat ) {
137 const auto& dat = itr.second;
138
139 os.width( 3 );
140 os.setf( ios_base::right, ios_base::adjustfield );
141 os << dat.count;
142
143 os << " | ";
144 os.width( 30 );
145 os.setf( ios_base::left, ios_base::adjustfield );
146 os << dat.fnc;
147
148 os << " | ";
149 os.setf( ios_base::left, ios_base::adjustfield );
150 os << dat.lib;
151
152 os << endl;
153 }
154
155 info() << endl << os.str() << endmsg;
156 }
std::ostringstream::setf
T setf(T...args)
CommonMessagingBase::info
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
Definition: CommonMessaging.h:117
std::endl
T endl(T...args)
std::ostringstream
STL class.
std::ostringstream::width
T width(T...args)
std::ostringstream::str
T str(T...args)
StatusCodeSvc::m_dat
std::map< std::string, StatCodeDat > m_dat
Definition: StatusCodeSvc.h:45
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209

void StatusCodeSvc::parseFilter | ( | const std::string & | str,
|  | std::string & | fnc,
|  | std::string & | lib
| ) |  |
| private

Definition at line 178 of file StatusCodeSvc.cpp.

179 {
180
181 auto loc = str.find( "=" );
182 if ( loc == std::string::npos ) {
183 fnc = str;
184 lib = "";
185 } else {
186 string key = str.substr( 0, loc );
187 string val = str.substr( loc + 1 );
188
189 toupper( key );
190
191 if ( key == "FCN" || key == "FNC" ) {
192 fnc = val;
193 lib.clear();
194 } else if ( key == "LIB" ) {
195 fnc.clear();
196 lib = val;
197 } else {
198 fnc.clear();
199 lib.clear();
200
201 warning() << "ignoring unknown token in Filter: " << str << endmsg;
202 }
203 }
204 }
CommonMessagingBase::warning
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
Definition: CommonMessaging.h:114
std::string::clear
T clear(T...args)
std::string::find
T find(T...args)
std::string::substr
T substr(T...args)
toupper
void toupper(std::string &s)
Definition: StatusCodeSvc.cpp:10
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209

void StatusCodeSvc::regFnc | ( | const std::string & | func,
|  | const std::string & | lib
| ) |  |
| override

Definition at line 73 of file StatusCodeSvc.cpp.

74 {
75
76 if ( m_state == Gaudi::StateMachine::OFFLINE || m_state == Gaudi::StateMachine::CONFIGURED ) {
77 return;
78 }
79
80 // A StatusCode instance may be create internally by ROOT dictionaries and,
81 // of course, it's not checked, so here we whitelist a few library names
82 // that are known to produce spurious reports.
83 if ( m_dict &&
84 ( lib.compare( lib.length() - 7, 7, "Dict.so" ) == 0 || lib.compare( lib.length() - 8, 8, "Cling.so" ) == 0 ||
85 lib.compare( lib.length() - 7, 7, "Core.so" ) == 0 ) ) {
86 return;
87 }
88 // this appears only with gcc 4.9...
89 if ( fnc == "_PyObject_GC_Malloc" ) return;
90 // GAUDI-1036
91 if ( fnc == "PyThread_get_thread_ident" ) return;
92 if ( fnc == "local" ) return;
93
94 {
95 const string rlib = lib.substr( lib.rfind( "/" ) + 1 );
96
97 if ( m_filterfnc.find( fnc ) != m_filterfnc.end() || m_filterlib.find( rlib ) != m_filterlib.end() ) {
98 return;
99 }
100 }
101
102 if ( m_abort ) {
103 fatal() << "Unchecked StatusCode in " << fnc << " from lib " << lib << endmsg;
104 abort();
105 }
106
107 string key = fnc + lib;
108
109 auto itr = m_dat.find( key );
110
111 if ( itr != m_dat.end() ) {
112 itr->second.count += 1;
113 } else {
114
115 const string rlib = lib.substr( lib.rfind( "/" ) + 1 );
116
117 StatCodeDat dat;
118 dat.fnc = fnc;
119 dat.lib = rlib;
120 dat.count = 1;
121
122 m_dat[key] = dat;
123 }
124 }
Gaudi::StateMachine::CONFIGURED
Definition: StateMachine.h:16
Service::m_state
Gaudi::StateMachine::State m_state
Service state.
Definition: Service.h:160
StatusCodeSvc::m_dict
Gaudi::Property< bool > m_dict
Definition: StatusCodeSvc.h:43
std::string::rfind
T rfind(T...args)
std::set::end
T end(T...args)
StatusCodeSvc::m_filterfnc
std::set< std::string > m_filterfnc
Definition: StatusCodeSvc.h:46
StatusCodeSvc::m_abort
Gaudi::Property< bool > m_abort
Definition: StatusCodeSvc.h:41
std::set::find
T find(T...args)
std::string::length
T length(T...args)
StatusCodeSvc::m_dat
std::map< std::string, StatCodeDat > m_dat
Definition: StatusCodeSvc.h:45
std::string::substr
T substr(T...args)
std::abort
T abort(T...args)
CommonMessagingBase::fatal
MsgStream & fatal() const
shortcut for the method msgStream(MSG::FATAL)
Definition: CommonMessaging.h:105
Gaudi::StateMachine::OFFLINE
Definition: StateMachine.h:15
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
std::string::compare
T compare(T...args)
StatusCodeSvc::m_filterlib
std::set< std::string > m_filterlib
Definition: StatusCodeSvc.h:46

StatusCode StatusCodeSvc::reinitialize | ( |  | ) |
| override

Definition at line 44 of file StatusCodeSvc.cpp.

45 {
46
47 info() << "reinitialize" << endmsg;
48
49 return StatusCode::SUCCESS;
50 }
StatusCode::SUCCESS
Definition: StatusCode.h:31
CommonMessagingBase::info
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
Definition: CommonMessaging.h:117
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209

bool StatusCodeSvc::suppressCheck | ( |  | ) | const
| inline override

Definition at line 22 of file StatusCodeSvc.h.

22 { return m_suppress.value(); }
StatusCodeSvc::m_suppress
Gaudi::Property< bool > m_suppress
Definition: StatusCodeSvc.h:42

## Member Data Documentation

Gaudi::Property<bool> StatusCodeSvc::m_abort {this, "AbortOnError", false}
| private

Definition at line 41 of file StatusCodeSvc.h.

std::map<std::string, StatCodeDat> StatusCodeSvc::m_dat
| private

Definition at line 45 of file StatusCodeSvc.h.

Gaudi::Property<bool> StatusCodeSvc::m_dict {this, "IgnoreDicts", true}
| private

Definition at line 43 of file StatusCodeSvc.h.

std::set<std::string> StatusCodeSvc::m_filterfnc
| private

Definition at line 46 of file StatusCodeSvc.h.

std::set<std::string> StatusCodeSvc::m_filterlib
| private

Definition at line 46 of file StatusCodeSvc.h.

Gaudi::Property<std::vector<std::string> > StatusCodeSvc::m_pFilter {this, "Filter"}
| private

Definition at line 40 of file StatusCodeSvc.h.

Gaudi::Property<bool> StatusCodeSvc::m_suppress {this, "SuppressCheck", false}
| private

Definition at line 42 of file StatusCodeSvc.h.

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

- GaudiCommonSvc/src/StatusCodeSvc.h
- GaudiCommonSvc/src/StatusCodeSvc.cpp