#include </builds/gaudi/Gaudi/GaudiCommonSvc/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

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

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

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 >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
	Declare used tool. More...

template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T >
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

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

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, 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 std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name More...

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property. More...

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals. More...

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string. More...

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation More...

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name More...

StatusCode	getProperty (std::string_view 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 (std::string_view name) const override
	Return true if we have a property with the given name. More...

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected More...

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Private Member Functions
void	parseFilter (const std::string &str, std::string &fnc, std::string &lib) const

bool	failsFilter (const std::string &fnc, const std::string &lib) const

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}

tbb::concurrent_unordered_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
using	Factory = Gaudi::PluginService::Factory< IService (const std::string &, ISvcLocator )>

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
std::vector< IAlgTool * > &	tools ()

	~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 > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

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"}
	flag indicating whether ToolHandle tools have been added to m_tools More...

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()"}

Gaudi::Property< bool >	m_autoRetrieveTools {this, "AutoRetrieveTools", true, "retrieve all AlgTools during initialize"}

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service More...

Detailed Description

Definition at line 22 of file StatusCodeSvc.h.

Member Function Documentation

◆ failsFilter()

bool StatusCodeSvc::failsFilter	(	const std::string &	fnc,
		const std::string &	lib
	)		const

private

Definition at line 103 of file StatusCodeSvc.cpp.

                                                                                   {
   return m_filterfnc.find( fnc ) != m_filterfnc.end() || m_filterlib.find( lib ) != m_filterlib.end();
 }

◆ finalize()

StatusCode StatusCodeSvc::finalize ( )

override

Definition at line 48 of file StatusCodeSvc.cpp.

                                    {
  
   list();
   return StatusCode::SUCCESS;
 }

◆ initialize()

StatusCode StatusCodeSvc::initialize ( )

override

Definition at line 21 of file StatusCodeSvc.cpp.

                                      {
  
   StatusCode sc = Service::initialize();
   if ( !sc.isSuccess() ) return sc;
  
   info() << "initialize" << endmsg;
  
   for ( const auto& itr : m_pFilter.value() ) {
     std::string fnc, lib;
     parseFilter( itr, fnc, lib );
     if ( !fnc.empty() ) m_filterfnc.insert( fnc );
     if ( !lib.empty() ) m_filterlib.insert( lib );
   }
  
   return StatusCode::SUCCESS;
 }

◆ list()

void StatusCodeSvc::list ( ) const

override

Definition at line 109 of file StatusCodeSvc.cpp.

                                {
  
   std::ostringstream os;
   unsigned int       N = 0;
  
   // Created a sorted map of the results
   std::map<std::string, StatCodeDat> dat_sorted( m_dat.begin(), m_dat.end() );
   for ( const auto& itr : dat_sorted ) {
     const auto& dat = itr.second;
  
     // we need to do this in case someone has gotten to regFnc before filters were setup in initialize
     if ( failsFilter( dat.fnc, dat.lib ) ) continue;
  
     N++;
     os.width( 3 );
     os.setf( std::ios_base::right, std::ios_base::adjustfield );
     os << dat.count;
  
     os << " | ";
     os.width( 30 );
     os.setf( std::ios_base::left, std::ios_base::adjustfield );
     os << dat.fnc;
  
     os << " | ";
     os.setf( std::ios_base::left, std::ios_base::adjustfield );
     os << dat.lib;
  
     os << std::endl;
   }
   if ( N > 0 ) {
     info() << "listing all unchecked return codes:" << endmsg;
     info() << std::endl
            << "Num | Function                       | Source Library" << std::endl
            << "----+--------------------------------+------------------------------------------" << std::endl
            << os.str() << endmsg;
   } else {
     if ( msgLevel( MSG::DEBUG ) ) debug() << "all StatusCode instances where checked" << endmsg;
   }
 }

◆ parseFilter()

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

private

Definition at line 151 of file StatusCodeSvc.cpp.

                                                                                             {
  
   auto loc = str.find( "=" );
   if ( loc == std::string::npos ) {
     fnc = str;
     lib = "";
   } else {
     std::string key = str.substr( 0, loc );
     std::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;
     }
   }
 }

◆ regFnc()

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

override

Definition at line 56 of file StatusCodeSvc.cpp.

                                                                        {
  
   if ( m_state == Gaudi::StateMachine::OFFLINE || m_state == Gaudi::StateMachine::CONFIGURED ) { return; }
  
   // A StatusCode instance may be create internally by ROOT dictionaries and,
   // of course, it's not checked, so here we whitelist a few library names
   // that are known to produce spurious reports.
   if ( m_dict ) {
     // ROOT's library names can end with either ".so" or ".so.x.y" with x.y the ROOT version in use
     const auto len = lib.length();
     if ( len >= 3 && lib.compare( len - 3, 3, ".so" ) == 0 ) {
       if ( ( len >= 7 && ( lib.compare( len - 7, 4, "Dict" ) == 0 || lib.compare( len - 7, 4, "Core" ) == 0 ) ) ||
            ( len >= 8 && lib.compare( len - 8, 5, "Cling" ) == 0 ) ) {
         return;
       }
     } else if ( lib.rfind( "Dict.so" ) != std::string::npos || lib.rfind( "Cling.so" ) != std::string::npos ||
                 lib.rfind( "Core.so" ) != std::string::npos ) {
       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 std::string rlib = lib.substr( lib.rfind( "/" ) + 1 );
   if ( failsFilter( fnc, rlib ) ) return;
  
   if ( m_abort ) {
     fatal() << "Unchecked StatusCode in " << fnc << " from lib " << lib << endmsg;
     msgStream().flush();
     abort();
   }
  
   const std::string key = fnc + lib;
  
   decltype( m_dat )::const_iterator itr = m_dat.find( key );
   if ( itr != m_dat.end() ) {
     ++( itr->second.count );
   } else {
     m_dat.emplace( key, StatCodeDat{fnc, rlib} );
   }
 }

◆ reinitialize()

StatusCode StatusCodeSvc::reinitialize ( )

override

Definition at line 40 of file StatusCodeSvc.cpp.

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

◆ suppressCheck()

bool StatusCodeSvc::suppressCheck ( ) const

inlineoverride

Definition at line 31 of file StatusCodeSvc.h.

31 { return m_suppress.value(); }

Member Data Documentation

◆ m_abort

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

private

Definition at line 48 of file StatusCodeSvc.h.

◆ m_dat

tbb::concurrent_unordered_map<std::string, StatCodeDat> StatusCodeSvc::m_dat

private

Definition at line 52 of file StatusCodeSvc.h.

◆ m_dict

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

private

Definition at line 50 of file StatusCodeSvc.h.

◆ m_filterfnc

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

private

Definition at line 53 of file StatusCodeSvc.h.

◆ m_filterlib

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

private

Definition at line 53 of file StatusCodeSvc.h.

◆ m_pFilter

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

private

Definition at line 47 of file StatusCodeSvc.h.

◆ m_suppress

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

private

Definition at line 49 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

Member Function Documentation

◆ failsFilter()

◆ finalize()

◆ initialize()

◆ list()

◆ parseFilter()

◆ regFnc()

◆ reinitialize()

◆ suppressCheck()

Member Data Documentation

◆ m_abort

◆ m_dat

◆ m_dict

◆ m_filterfnc

◆ m_filterlib

◆ m_pFilter

◆ m_suppress