StatusCodeSvc Class Reference

#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< BASE, Interfaces >
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...
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 extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~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< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
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 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...
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... 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 17 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 198 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 210 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 76 of file StatusCodeSvc.cpp.

                        {
  MsgStream log( msgSvc(), name() );

  if (!m_dat.empty()) {

    log << MSG::INFO << "listing all unchecked return codes:" << endmsg;

    list();

  } else {

    if (msgLevel(MSG::DEBUG))
      log << MSG::DEBUG << "all StatusCode instances where checked" << endmsg;

  }

  return StatusCode::SUCCESS;

}

StatusCode StatusCodeSvc::initialize ( )

override

Definition at line 32 of file StatusCodeSvc.cpp.

                          {

  StatusCode sc = Service::initialize();
  if (!sc.isSuccess()) return sc;

  MsgStream log( msgSvc(), name() );
  log << MSG::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 158 of file StatusCodeSvc.cpp.

                          {

  MsgStream log( msgSvc(), name() );
  log << MSG::INFO << endl;


  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;

  }


  log << os.str() << endmsg;

}

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

private

Definition at line 222 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();

      MsgStream log( msgSvc(), name() );
      log << MSG::WARNING << "ignoring unknown token in Filter: " << str
      << endmsg;
    }
  }

}

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

override

Definition at line 101 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) {
    MsgStream log( msgSvc(), name() );
    log << MSG::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 65 of file StatusCodeSvc.cpp.

                            {

  MsgStream log( msgSvc(), name() );
  log << MSG::INFO << "reinitialize" << endmsg;

  return StatusCode::SUCCESS;

}

bool StatusCodeSvc::suppressCheck ( ) const

inlineoverride

Definition at line 22 of file StatusCodeSvc.h.

{ return m_suppress.value() ; }

Member Data Documentation

BooleanProperty StatusCodeSvc::m_abort

private

Definition at line 42 of file StatusCodeSvc.h.

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

private

Definition at line 44 of file StatusCodeSvc.h.

BooleanProperty StatusCodeSvc::m_dict

private

Definition at line 42 of file StatusCodeSvc.h.

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

private

Definition at line 45 of file StatusCodeSvc.h.

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

private

Definition at line 45 of file StatusCodeSvc.h.

StringArrayProperty StatusCodeSvc::m_pFilter

private

Definition at line 41 of file StatusCodeSvc.h.

BooleanProperty StatusCodeSvc::m_suppress

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