#include <src/StatusCodeSvc.h>

Inheritance diagram for StatusCodeSvc:

Collaboration diagram for StatusCodeSvc:

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 (const std::string &name, ISvcLocator *svc)

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

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 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
StringArrayProperty	m_pFilter

BooleanProperty	m_abort

BooleanProperty	m_suppress

BooleanProperty	m_dict

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

Definition at line 12 of file StatusCodeSvc.h.

Constructor & Destructor Documentation

StatusCodeSvc::StatusCodeSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Definition at line 16 of file StatusCodeSvc.cpp.

   : base_class( name, svc )
 {
 
   declareProperty("Filter",m_pFilter);
   declareProperty("AbortOnError",m_abort=false);
   declareProperty("SuppressCheck", m_suppress=false);
   declareProperty("IgnoreDicts",m_dict=true);
 
 }

StatusCodeSvc::~StatusCodeSvc ( )

overridedefault

Member Function Documentation

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

private

Definition at line 189 of file StatusCodeSvc.cpp.

                                              {
 
   auto itr = std::find_if(m_dat.begin(),m_dat.end(),
                        [&](const std::pair<std::string,StatCodeDat>& d) {
         return d.second.fnc == str;
   });
   if (itr!=std::end(m_dat)) m_dat.erase(itr);
 
 }

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

private

Definition at line 201 of file StatusCodeSvc.cpp.

                                              {
 
   auto itr = std::find_if(m_dat.begin(),m_dat.end(),
                        [&](const std::pair<std::string,StatCodeDat>& d) {
         return d.second.lib == str;
   });
   if (itr!=std::end(m_dat)) m_dat.erase(itr);
 }

StatusCode StatusCodeSvc::finalize ( )

override

Definition at line 73 of file StatusCodeSvc.cpp.

                         {
 
   if (!m_dat.empty()) {
 
     info() << "listing all unchecked return codes:" << endmsg;
 
     list();
 
   } else {
 
     if (msgLevel(MSG::DEBUG))
       debug() << "all StatusCode instances where checked" << endmsg;
 
   }
 
   return StatusCode::SUCCESS;
 
 }

StatusCode StatusCodeSvc::initialize ( )

override

Definition at line 31 of file StatusCodeSvc.cpp.

                           {
 
   StatusCode sc = Service::initialize();
   if (!sc.isSuccess()) return sc;
 
   info() << "initialize" << endmsg;
 
   for (const auto& itr : m_pFilter.value()) {
     // we need to do this if someone has gotten to regFnc before initialize
 
     string fnc,lib;
     parseFilter(itr,fnc,lib);
 
     if (!fnc.empty()) {
       filterFnc(fnc);
       m_filterfnc.insert(fnc);
     }
 
     if (!lib.empty()) {
       filterLib(lib);
       m_filterlib.insert(lib);
     }
 
   }
 
   return StatusCode::SUCCESS;
 
 }

void StatusCodeSvc::list ( ) const

override

Definition at line 153 of file StatusCodeSvc.cpp.

                           {
 
 
 
   std::ostringstream os;
   os << "Num | Function                       | Source Library" << endl;
   os << "----+--------------------------------+-------------------"
      << "-----------------------" << endl;
 
   for(const auto& itr : m_dat) {
     const auto& dat = itr.second;
 
     os.width(3);
     os.setf(ios_base::right,ios_base::adjustfield);
     os << dat.count;
 
     os << " | ";
     os.width(30);
     os.setf(ios_base::left,ios_base::adjustfield);
     os << dat.fnc;
 
     os << " | ";
     os.setf(ios_base::left,ios_base::adjustfield);
     os << dat.lib;
 
     os << endl;
 
   }
 
   info() << endl << os.str() << endmsg;
 
 }

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

private

Definition at line 213 of file StatusCodeSvc.cpp.

                                                                       {
 
 
   auto loc = str.find("=");
   if (loc == std::string::npos) {
     fnc = str;
     lib = "";
   } else {
     string key = str.substr(0,loc);
     string val = str.substr(loc+1);
 
     toupper(key);
 
     if (key == "FCN" || key == "FNC") {
       fnc = val;
       lib.clear();
     } else if (key == "LIB") {
       fnc.clear();
       lib = val;
     } else {
       fnc.clear();
       lib.clear();
 
       warning() << "ignoring unknown token in Filter: " << str
       << endmsg;
     }
   }
 
 }

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

override

Definition at line 97 of file StatusCodeSvc.cpp.

                                                                 {
 
   if (m_state == Gaudi::StateMachine::OFFLINE ||
       m_state == Gaudi::StateMachine::CONFIGURED) {
     return;
   }
 
   if (m_dict &&
       (lib.compare(lib.length()-7, 7, "Dict.so") == 0 ||
        lib.compare(lib.length()-8, 8, "Cling.so") == 0)) {
     return;
   }
   // this appears only with gcc 4.9...
   if (fnc == "_PyObject_GC_Malloc") return;
   // GAUDI-1036
   if (fnc == "PyThread_get_thread_ident") return;
   if (fnc == "local") return;
 
   {
     const string rlib = lib.substr(lib.rfind("/") + 1);
 
     if (m_filterfnc.find(fnc) != m_filterfnc.end() ||
         m_filterlib.find(rlib) != m_filterlib.end() ) {
       return;
     }
   }
 
   if (m_abort) {
     fatal() << "Unchecked StatusCode in " << fnc << " from lib "
     << lib << endmsg;
     abort();
   }
 
   string key = fnc + lib;
 
   auto itr = m_dat.find(key);
 
   if (itr != m_dat.end()) {
     itr->second.count += 1;
   } else {
 
     const string rlib = lib.substr(lib.rfind("/") + 1);
 
     StatCodeDat dat;
     dat.fnc = fnc;
     dat.lib = rlib;
     dat.count = 1;
 
     m_dat[key] = dat;
   }
 
 }

StatusCode StatusCodeSvc::reinitialize ( )

override

Definition at line 63 of file StatusCodeSvc.cpp.

                             {
 
   info() << "reinitialize" << endmsg;
 
   return StatusCode::SUCCESS;
 
 }

bool StatusCodeSvc::suppressCheck ( ) const

inlineoverride

Definition at line 23 of file StatusCodeSvc.h.

23 { return m_suppress.value() ; }

StatusCodeSvc::m_suppress

BooleanProperty m_suppress

Definition: StatusCodeSvc.h:43

PropertyWithValue::value

const TYPE & value() const

explicit conversion

Definition: Property.h:341

Member Data Documentation

BooleanProperty StatusCodeSvc::m_abort

private

Definition at line 43 of file StatusCodeSvc.h.

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

private

Definition at line 45 of file StatusCodeSvc.h.

BooleanProperty StatusCodeSvc::m_dict

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.

StringArrayProperty StatusCodeSvc::m_pFilter

private

Definition at line 42 of file StatusCodeSvc.h.

BooleanProperty StatusCodeSvc::m_suppress

private

Definition at line 43 of file StatusCodeSvc.h.

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

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation