AlgErrorAuditor.cpp

Go to the documentation of this file.

// AlgErrorAuditor:
//  An auditor that monitors memory usage

#include "AlgErrorAuditor.h"
#include "GaudiKernel/MsgStream.h"
#include "GaudiKernel/IMessageSvc.h"
#include "GaudiKernel/AudFactory.h"
#include "GaudiKernel/GaudiException.h"

DECLARE_AUDITOR_FACTORY(AlgErrorAuditor);

AlgErrorAuditor::AlgErrorAuditor(const std::string& name, ISvcLocator* pSvcLocator)
  : Auditor(name, pSvcLocator), m_error(0), m_fatal(0) {

  declareProperty( "Abort", m_abort = false,
                   "Abort job upon illegal Algorithm return code");
  declareProperty( "Throw", m_throw = false,
                   "Throw GaudiException upon illegal Algorithm return code");
}

AlgErrorAuditor::~AlgErrorAuditor(){
}


void
AlgErrorAuditor:: beforeExecute(INamedInterface* ){
  m_error = msgSvc()->messageCount(MSG::ERROR);
  m_fatal = msgSvc()->messageCount(MSG::FATAL);
}

StatusCode
AlgErrorAuditor:: initialize() {

  if (m_abort && m_throw) {
    MsgStream log(msgSvc(), name());
    log << MSG::INFO << "Both \"Throw\" and \"Abort\" options have been set."
        << " Abort takes precedence." << endmsg;
  }

  return StatusCode::SUCCESS;
}


void
AlgErrorAuditor:: afterExecute(INamedInterface* alg, const StatusCode& sc) {

  bool fail(false);
  if (msgSvc()->messageCount(MSG::ERROR) != m_error && ! sc.isRecoverable() ) {
    std::ostringstream os;
    os << "Illegal Return Code: Algorithm " << alg->name()
       << " reported an ERROR, but returned a StatusCode \"" << sc << "\"";
    os << std::endl << "Error policy described in "
         << "https://twiki.cern.ch/twiki/bin/view/Atlas/ReportingErrors";

    MsgStream log(msgSvc(), name());
    log << MSG::ERROR << os.str() << endmsg;
    incrMap(alg->name(), 0);
    fail = true;

    if (m_throw && ! m_abort) {
      throw GaudiException(os.str(),"AlgErrorAuditor",0);
    }
  }

  if (msgSvc()->messageCount(MSG::FATAL) != m_fatal &&
      sc != StatusCode::FAILURE ) {
    std::ostringstream os;
    os << "Illegal Return Code: Algorithm " << alg->name()
       << " reported a FATAL, but returned a StatusCode \"" << sc << "\"";
    os << std::endl << "Error policy described in "
         << "https://twiki.cern.ch/twiki/bin/view/Atlas/ReportingErrors";

    MsgStream log(msgSvc(), name());
    log << MSG::ERROR << os.str() << endmsg;
    incrMap(alg->name(), 1);
    fail = true;

    if (m_throw && ! m_abort) {
      throw GaudiException(os.str(),"AlgErrorAuditor",0);
    }

  }

  if (fail && m_abort) {
    abort();
  }

}

StatusCode
AlgErrorAuditor::finalize() {


  std::map<std::string,int>::const_iterator itr;
  if (m_algMap[0].size() != 0) {
    MsgStream log(msgSvc(), name());
    log << MSG::INFO << "Found " << m_algMap[0].size()
        << " instances where an Algorithm::execute() produced an ERROR "
        << "but returned a SUCCESS:" << std::endl;

    for (itr = m_algMap[0].begin(); itr != m_algMap[0].end(); ++itr) {
      log << itr->first << ": " << itr->second << std::endl;
    }

    log << endmsg;
  }

  if (m_algMap[1].size() != 0) {
    MsgStream log(msgSvc(), name());
    log << MSG::INFO << "Found " << m_algMap[1].size()
        << " instances where an Algorithm::execute() produced a FATAL "
        << "but returned a SUCCESS:" << std::endl;

    for (itr = m_algMap[1].begin(); itr != m_algMap[1].end(); ++itr) {
      log << itr->first << ": " << itr->second << std::endl;
    }

    log << endmsg;
  }


  return StatusCode::SUCCESS;

}

void
AlgErrorAuditor::incrMap(const std::string& alg, int level) {
  std::map<std::string, int>::iterator itr;
  if ( (itr=m_algMap[level].find(alg)) != m_algMap[level].end()) {
    itr->second++;
  } else {
    m_algMap[level].insert( std::pair<std::string,int>(alg,1) );
  }
}