StatusCodeSvc.cpp

Go to the documentation of this file.

#include "StatusCodeSvc.h"
#include "GaudiKernel/MsgStream.h"
#include "GaudiKernel/StatusCode.h"

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

using namespace std;
//
//
inline void toupper(std::string &s)
{
  std::transform(s.begin(), s.end(), s.begin(),
                 (int(*)(int)) toupper);
}

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

  declareProperty("Filter",m_pFilter);
  declareProperty("AbortOnError",m_abort=false);
  declareProperty("SuppressCheck", m_suppress=false);
  declareProperty("IgnoreDicts",m_dict=true);

}

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */


StatusCode
StatusCodeSvc::initialize() {

  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;

}

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

StatusCode
StatusCodeSvc::reinitialize() {

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

  return StatusCode::SUCCESS;

}

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
StatusCode
StatusCodeSvc::finalize() {
  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;

}


/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

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

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

}

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

void
StatusCodeSvc::list() const {

  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::filterFnc(const std::string& str) {

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

  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);
}

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

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


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

}

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

DECLARE_COMPONENT(StatusCodeSvc)