| The Gaudi Framework v32r1 (f65d50dc)

StatusCodeSvc.cpp
Go to the documentation of this file.
1 #include "StatusCodeSvc.h"
2 #include "GaudiKernel/StatusCode.h"
3
4 //
6 //
7 inline void toupper( std::string& s ) { std::transform( s.begin(), s.end(), s.begin(), (int ( * )( int ))toupper ); }
8
9 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
10
11 StatusCode StatusCodeSvc::initialize() {
12
13 StatusCode sc = Service::initialize();
14 if ( !sc.isSuccess() ) return sc;
15
16 info() << "initialize" << endmsg;
17
18 for ( const auto& itr : m_pFilter.value() ) {
19 std::string fnc, lib;
20 parseFilter( itr, fnc, lib );
21 if ( !fnc.empty() ) m_filterfnc.insert( fnc );
22 if ( !lib.empty() ) m_filterlib.insert( lib );
23 }
24
25 return StatusCode::SUCCESS;
26 }
27
28 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
29
30 StatusCode StatusCodeSvc::reinitialize() {
31
32 info() << "reinitialize" << endmsg;
33
34 return StatusCode::SUCCESS;
35 }
36
37 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
38 StatusCode StatusCodeSvc::finalize() {
39
40 list();
41 return StatusCode::SUCCESS;
42 }
43
44 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
45
46 void StatusCodeSvc::regFnc( const std::string& fnc, const std::string& lib ) {
47
48 if ( m_state == Gaudi::StateMachine::OFFLINE || m_state == Gaudi::StateMachine::CONFIGURED ) { return; }
49
50 // A StatusCode instance may be create internally by ROOT dictionaries and,
51 // of course, it's not checked, so here we whitelist a few library names
52 // that are known to produce spurious reports.
53 if ( m_dict ) {
54 // ROOT's library names can end with either ".so" or ".so.x.y" with x.y the ROOT version in use
55 const auto len = lib.length();
56 if ( len >= 3 && lib.compare( len - 3, 3, ".so" ) == 0 ) {
57 if ( ( len >= 7 && ( lib.compare( len - 7, 4, "Dict" ) == 0 || lib.compare( len - 7, 4, "Core" ) == 0 ) ) ||
58 ( len >= 8 && lib.compare( len - 8, 5, "Cling" ) == 0 ) ) {
59 return;
60 }
61 } else if ( lib.rfind( "Dict.so" ) != std::string::npos || lib.rfind( "Cling.so" ) != std::string::npos ||
62 lib.rfind( "Core.so" ) != std::string::npos ) {
63 return;
64 }
65 }
66 // this appears only with gcc 4.9...
67 if ( fnc == "_PyObject_GC_Malloc" ) return;
68 // GAUDI-1036
69 if ( fnc == "PyThread_get_thread_ident" ) return;
70 if ( fnc == "local" ) return;
71
72 const std::string rlib = lib.substr( lib.rfind( "/" ) + 1 );
73 if ( failsFilter( fnc, rlib ) ) return;
74
75 if ( m_abort ) {
76 fatal() << "Unchecked StatusCode in " << fnc << " from lib " << lib << endmsg;
77 msgStream().flush();
78 abort();
79 }
80
81 const std::string key = fnc + lib;
82
83 decltype( m_dat )::const_iterator itr = m_dat.find( key );
84 if ( itr != m_dat.end() ) {
85 ++( itr->second.count );
86 } else {
87 m_dat.emplace( key, StatCodeDat{fnc, rlib} );
88 }
89 }
90
91 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
92
93 bool StatusCodeSvc::failsFilter( const std::string& fnc, const std::string& lib ) const {
94 return m_filterfnc.find( fnc ) != m_filterfnc.end() || m_filterlib.find( lib ) != m_filterlib.end();
95 }
96
97 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
98
99 void StatusCodeSvc::list() const {
100
101 std::ostringstream os;
102 unsigned int N = 0;
103
104 // Created a sorted map of the results
105 std::map<std::string, StatCodeDat> dat_sorted( m_dat.begin(), m_dat.end() );
106 for ( const auto& itr : dat_sorted ) {
107 const auto& dat = itr.second;
108
109 // we need to do this in case someone has gotten to regFnc before filters were setup in initialize
110 if ( failsFilter( dat.fnc, dat.lib ) ) continue;
111
112 N++;
113 os.width( 3 );
114 os.setf( std::ios_base::right, std::ios_base::adjustfield );
115 os << dat.count;
116
117 os << " | ";
118 os.width( 30 );
119 os.setf( std::ios_base::left, std::ios_base::adjustfield );
120 os << dat.fnc;
121
122 os << " | ";
123 os.setf( std::ios_base::left, std::ios_base::adjustfield );
124 os << dat.lib;
125
126 os << std::endl;
127 }
128 if ( N > 0 ) {
129 info() << "listing all unchecked return codes:" << endmsg;
130 info() << std::endl
131 << "Num | Function | Source Library" << std::endl
132 << "----+--------------------------------+------------------------------------------" << std::endl
133 << os.str() << endmsg;
134 } else {
135 if ( msgLevel( MSG::DEBUG ) ) debug() << "all StatusCode instances where checked" << endmsg;
136 }
137 }
138
139 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
140
141 void StatusCodeSvc::parseFilter( const std::string& str, std::string& fnc, std::string& lib ) const {
142
143 auto loc = str.find( "=" );
144 if ( loc == std::string::npos ) {
145 fnc = str;
146 lib = "";
147 } else {
148 std::string key = str.substr( 0, loc );
149 std::string val = str.substr( loc + 1 );
150
151 toupper( key );
152
153 if ( key == "FCN" || key == "FNC" ) {
154 fnc = val;
155 lib.clear();
156 } else if ( key == "LIB" ) {
157 fnc.clear();
158 lib = val;
159 } else {
160 fnc.clear();
161 lib.clear();
162
163 warning() << "ignoring unknown token in Filter: " << str << endmsg;
164 }
165 }
166 }
167
168 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
169
170 DECLARE_COMPONENT( StatusCodeSvc )
std::ostringstream::setf
T setf(T... args)
Service::initialize
StatusCode initialize() override
Definition: Service.cpp:60
std::string::empty
T empty(T... args)
Gaudi::StateMachine::CONFIGURED
Definition: StateMachine.h:14
Service::m_state
Gaudi::StateMachine::State m_state
Service state.
Definition: Service.h:153
CommonMessagingBase::warning
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
Definition: CommonMessaging.h:101
StatusCodeSvc::m_dict
Gaudi::Property< bool > m_dict
Definition: StatusCodeSvc.h:40
StatusCodeSvc::reinitialize
StatusCode reinitialize() override
Definition: StatusCodeSvc.cpp:30
std::string::rfind
T rfind(T... args)
MSG::DEBUG
Definition: IMessageSvc.h:15
std::endl
T endl(T... args)
StatusCode::SUCCESS
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
StatusCodeSvc::list
void list() const override
Definition: StatusCodeSvc.cpp:99
StatusCodeSvc::failsFilter
bool failsFilter(const std::string &fnc, const std::string &lib) const
Definition: StatusCodeSvc.cpp:93
std::set::end
T end(T... args)
CommonMessagingBase::info
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
Definition: CommonMessaging.h:104
std::map
STL class.
StatusCodeSvc.h
CommonMessaging< implements< IService, IProperty, IStateful > >::msgLevel
MSG::Level msgLevel() const
get the cached level (originally extracted from the embedded MsgStream)
Definition: CommonMessaging.h:138
std::string
STL class.
DECLARE_COMPONENT
#define DECLARE_COMPONENT(type)
Definition: PluginServiceV1.h:46
StatusCodeSvc::initialize
StatusCode initialize() override
Definition: StatusCodeSvc.cpp:11
IOTest.N
int N
Definition: IOTest.py:99
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
std::ostringstream
STL class.
MsgStream::flush
MsgStream & flush()
Definition: MsgStream.h:113
std::ostringstream::width
T width(T... args)
std::ostringstream::str
T str(T... args)
CommonMessagingBase::debug
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
Definition: CommonMessaging.h:107
std::string::clear
T clear(T... args)
CommonMessagingBase::msgStream
MsgStream & msgStream() const
Return an uninitialized MsgStream.
Definition: CommonMessaging.h:71
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:267
StatusCodeSvc::m_filterfnc
std::set< std::string > m_filterfnc
Definition: StatusCodeSvc.h:43
StatusCodeSvc::parseFilter
void parseFilter(const std::string &str, std::string &fnc, std::string &lib) const
Definition: StatusCodeSvc.cpp:141
StatusCodeSvc::regFnc
void regFnc(const std::string &func, const std::string &lib) override
Definition: StatusCodeSvc.cpp:46
StatusCodeSvc::m_dat
tbb::concurrent_unordered_map< std::string, StatCodeDat > m_dat
Definition: StatusCodeSvc.h:42
StatusCodeSvc::m_abort
Gaudi::Property< bool > m_abort
Definition: StatusCodeSvc.h:38
std::set::insert
T insert(T... args)
std::set::find
T find(T... args)
std::string::length
T length(T... args)
gaudirun.s
string s
Definition: gaudirun.py:316
std::string::substr
T substr(T... args)
std::transform
T transform(T... args)
StatusCode.h
Gaudi::StateMachine::OFFLINE
Definition: StateMachine.h:13
StatusCodeSvc::m_pFilter
Gaudi::Property< std::vector< std::string > > m_pFilter
Definition: StatusCodeSvc.h:37
StatusCodeSvc
Definition: StatusCodeSvc.h:12
toupper
void toupper(std::string &s)
Definition: StatusCodeSvc.cpp:7
CommonMessagingBase::fatal
MsgStream & fatal() const
shortcut for the method msgStream(MSG::FATAL)
Definition: CommonMessaging.h:92
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192
StatusCodeSvc::StatCodeDat
Definition: StatusCodeSvc.h:24
std::string::compare
T compare(T... args)
StatusCodeSvc::finalize
StatusCode finalize() override
Definition: StatusCodeSvc.cpp:38
StatusCodeSvc::m_filterlib
std::set< std::string > m_filterlib
Definition: StatusCodeSvc.h:43