MinimalEventLoopMgr.cpp

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#define GAUDIKERNEL_MINIMALEVENTLOOPMGR_CPP
 
#include <GaudiKernel/AppReturnCode.h>
#include <GaudiKernel/GaudiException.h>
#include <GaudiKernel/IAlgManager.h>
#include <GaudiKernel/IAlgorithm.h>
#include <GaudiKernel/IIncidentListener.h>
#include <GaudiKernel/IIncidentSvc.h>
#include <GaudiKernel/Incident.h>
#include <GaudiKernel/MsgStream.h>
#include <GaudiKernel/SmartIF.h>
#include <GaudiKernel/ThreadLocalContext.h>
#include <GaudiKernel/TypeNameString.h>
 
#include <GaudiKernel/MinimalEventLoopMgr.h>
 
#include <algorithm>
 
#define ON_DEBUG if ( outputLevel() <= MSG::DEBUG )
#define ON_VERBOSE if ( outputLevel() <= MSG::VERBOSE )
 
#define DEBMSG ON_DEBUG debug()
#define VERMSG ON_VERBOSE verbose()
 
//--------------------------------------------------------------------------------------------
// Standard Constructor
//--------------------------------------------------------------------------------------------
MinimalEventLoopMgr::MinimalEventLoopMgr( const std::string& nam, ISvcLocator* svcLoc )
    : base_class( nam, svcLoc ), m_appMgrUI( svcLoc ) {}
 
//--------------------------------------------------------------------------------------------
// implementation of IAppMgrUI::initialize
//--------------------------------------------------------------------------------------------
StatusCode MinimalEventLoopMgr::initialize() {
 
  if ( !m_appMgrUI ) return StatusCode::FAILURE;
 
  StatusCode sc = Service::initialize();
  if ( !sc.isSuccess() ) {
    error() << "Failed to initialize Service Base class." << endmsg;
    return StatusCode::FAILURE;
  }
 
  auto prpMgr = serviceLocator()->as<IProperty>();
  if ( !prpMgr ) {
    error() << "Error retrieving AppMgr interface IProperty." << endmsg;
    return StatusCode::FAILURE;
  }
  if ( m_topAlgNames.value().empty() ) { setProperty( prpMgr->getProperty( "TopAlg" ) ).ignore(); }
  if ( m_outStreamNames.value().empty() ) { setProperty( prpMgr->getProperty( "OutStream" ) ).ignore(); }
 
  // Get the references to the services that are needed by the ApplicationMgr itself
  m_incidentSvc = serviceLocator()->service( "IncidentSvc" );
  if ( !m_incidentSvc ) {
    fatal() << "Error retrieving IncidentSvc." << endmsg;
    return StatusCode::FAILURE;
  }
 
  m_incidentSvc->addListener( &m_abortEventListener, IncidentType::AbortEvent );
 
  // The state is changed at this moment to allow decodeXXXX() to do something
  m_state = INITIALIZED;
 
  // Get WhiteBoard interface if implemented by EventDataSvc
  m_WB = service( "EventDataSvc" );
 
  // setup the default EventContext with slot 0
  Gaudi::Hive::setCurrentContextId( Gaudi::Hive::ContextIdType( 0 ) );
 
  //--------------------------------------------------------------------------------------------
  // Create output streams. Do not initialize them yet.
  // The state is updated temporarily in order to enable the handler, which
  // is also triggered by a change to the "OutputStream" Property.
  //--------------------------------------------------------------------------------------------
  sc = decodeOutStreams();
  if ( !sc.isSuccess() ) {
    error() << "Failed to initialize Output streams." << endmsg;
    m_state = CONFIGURED;
    return sc;
  }
  //--------------------------------------------------------------------------------------------
  // Create all needed Top Algorithms. Do not initialize them yet.
  // The state is updated temporarily in order to enable the handler, which
  // is also triggered by a change to the "TopAlg" Property.
  //--------------------------------------------------------------------------------------------
  sc = decodeTopAlgs();
  if ( !sc.isSuccess() ) {
    error() << "Failed to initialize Top Algorithms streams." << endmsg;
    m_state = CONFIGURED;
    return sc;
  }
 
  // Initialize all the new TopAlgs. In fact Algorithms are protected against
  // getting initialized twice.
  for ( auto& ita : m_topAlgList ) {
    sc = ita->sysInitialize();
    if ( !sc.isSuccess() ) {
      error() << "Unable to initialize Algorithm: " << ita->name() << endmsg;
      return sc;
    }
  }
  for ( auto& ita : m_outStreamList ) {
    sc = ita->sysInitialize();
    if ( !sc.isSuccess() ) {
      error() << "Unable to initialize Output Stream: " << ita->name() << endmsg;
      return sc;
    }
  }
 
  // get hold of the Algorithm Execution State mgr
  m_aess = serviceLocator()->service( "AlgExecStateSvc" );
  if ( !m_aess ) {
    fatal() << "Error retrieving AlgExecStateSvc." << endmsg;
    return StatusCode::FAILURE;
  }
 
  if ( m_printCFExp && !m_topAlgList.empty() ) {
    info() << "Control Flow Expression:" << endmsg;
    std::stringstream expr;
    auto&             first = m_topAlgList.front();
    for ( auto& ialg : m_topAlgList ) {
      if ( ialg != first ) expr << " >> ";
      ialg->toControlFlowExpression( expr );
    }
    info() << expr.str() << endmsg;
  }
  return StatusCode::SUCCESS;
}
//--------------------------------------------------------------------------------------------
// implementation of IAppMgrUI::start
//--------------------------------------------------------------------------------------------
StatusCode MinimalEventLoopMgr::start() {
 
  StatusCode sc = Service::start();
  if ( !sc.isSuccess() ) return sc;
 
  // Start all the new TopAlgs. In fact Algorithms are protected against getting
  // started twice.
  for ( auto& ita : m_topAlgList ) {
    sc = ita->sysStart();
    if ( !sc.isSuccess() ) {
      error() << "Unable to start Algorithm: " << ita->name() << endmsg;
      return sc;
    }
  }
  for ( auto& ita : m_outStreamList ) {
    sc = ita->sysStart();
    if ( !sc.isSuccess() ) {
      error() << "Unable to start Output Stream: " << ita->name() << endmsg;
      return sc;
    }
  }
  return StatusCode::SUCCESS;
}
//--------------------------------------------------------------------------------------------
// implementation of IAppMgrUI::stop
//--------------------------------------------------------------------------------------------
StatusCode MinimalEventLoopMgr::stop() {
 
  StatusCode sc{ StatusCode::SUCCESS };
 
  // Stop all the TopAlgs. In fact Algorithms are protected against getting
  // stopped twice.
  for ( auto& ita : m_topAlgList ) {
    sc = ita->sysStop();
    if ( !sc.isSuccess() ) {
      error() << "Unable to stop Algorithm: " << ita->name() << endmsg;
      return sc;
    }
  }
  for ( auto& ita : m_outStreamList ) {
    sc = ita->sysStop();
    if ( !sc.isSuccess() ) {
      error() << "Unable to stop Output Stream: " << ita->name() << endmsg;
      return sc;
    }
  }
 
  return Service::stop();
}
 
//--------------------------------------------------------------------------------------------
// implementation of IService::reinitialize
//--------------------------------------------------------------------------------------------
StatusCode MinimalEventLoopMgr::reinitialize() {
  StatusCode sc = StatusCode::SUCCESS;
 
  // Reinitialize all the TopAlgs.
  for ( auto& ita : m_topAlgList ) {
    sc = ita->sysReinitialize();
    if ( !sc.isSuccess() ) {
      error() << "Unable to reinitialize Algorithm: " << ita->name() << endmsg;
      return sc;
    }
  }
  for ( auto& ita : m_outStreamList ) {
    sc = ita->sysReinitialize();
    if ( !sc.isSuccess() ) {
      error() << "Unable to reinitialize Output Stream: " << ita->name() << endmsg;
      return sc;
    }
  }
 
  return sc;
}
//--------------------------------------------------------------------------------------------
// implementation of IService::restart
//--------------------------------------------------------------------------------------------
StatusCode MinimalEventLoopMgr::restart() {
  StatusCode sc = StatusCode::SUCCESS;
 
  // Restart all the TopAlgs.
  for ( auto& ita : m_topAlgList ) {
    m_aess->resetErrorCount( ita );
    sc = ita->sysRestart();
    if ( !sc.isSuccess() ) {
      error() << "Unable to restart Algorithm: " << ita->name() << endmsg;
      return sc;
    }
  }
  for ( auto& ita : m_outStreamList ) {
    m_aess->resetErrorCount( ita );
    sc = ita->sysRestart();
    if ( !sc.isSuccess() ) {
      error() << "Unable to restart Output Stream: " << ita->name() << endmsg;
      return sc;
    }
  }
 
  return sc;
}
 
//--------------------------------------------------------------------------------------------
// implementation of IService::finalize
//--------------------------------------------------------------------------------------------
StatusCode MinimalEventLoopMgr::finalize() {
  StatusCode sc    = StatusCode::SUCCESS;
  StatusCode scRet = StatusCode::SUCCESS;
  // Call the finalize() method of all top algorithms
  for ( auto& ita : m_topAlgList ) {
    sc = ita->sysFinalize();
    if ( !sc.isSuccess() ) {
      scRet = StatusCode::FAILURE;
      warning() << "Finalization of algorithm " << ita->name() << " failed" << endmsg;
    }
  }
  // Call the finalize() method of all Output streams
  for ( auto& ita : m_outStreamList ) {
    sc = ita->sysFinalize();
    if ( !sc.isSuccess() ) {
      scRet = StatusCode::FAILURE;
      warning() << "Finalization of algorithm " << ita->name() << " failed" << endmsg;
    }
  }
  // release all top algorithms
  auto algMan = serviceLocator()->as<IAlgManager>();
  for ( auto& ita : m_topAlgList ) {
    if ( algMan->removeAlgorithm( ita ).isFailure() ) {
      scRet = StatusCode::FAILURE;
      warning() << "Problems removing Algorithm " << ita->name() << endmsg;
    }
  }
  m_topAlgList.clear();
  m_outStreamList.clear();
  if ( sc.isSuccess() ) m_state = FINALIZED;
 
  m_incidentSvc->removeListener( &m_abortEventListener, IncidentType::AbortEvent );
 
  m_incidentSvc.reset();
  m_appMgrUI.reset();
 
  sc = Service::finalize();
 
  if ( sc.isFailure() ) {
    scRet = StatusCode::FAILURE;
    error() << "Problems finalizing Service base class" << endmsg;
  }
 
  return scRet;
}
 
EventContext MinimalEventLoopMgr::createEventContext() { return EventContext{ m_nevt++, 0 }; }
//--------------------------------------------------------------------------------------------
// implementation of IAppMgrUI::nextEvent
//--------------------------------------------------------------------------------------------
StatusCode MinimalEventLoopMgr::nextEvent( int /* maxevt */ ) {
  error() << "This method cannot be called on an object of type " << System::typeinfoName( typeid( *this ) ) << endmsg;
  return StatusCode::FAILURE;
}
 
//--------------------------------------------------------------------------------------------
// IEventProcessing::executeRun
//--------------------------------------------------------------------------------------------
StatusCode MinimalEventLoopMgr::executeRun( int maxevt ) {
  // Call now the nextEvent(...)
  return nextEvent( maxevt );
}
 
namespace {
  class RetCodeGuard {
  public:
    inline RetCodeGuard( SmartIF<IProperty> appmgr, int retcode )
        : m_appmgr( std::move( appmgr ) ), m_retcode( retcode ) {}
    inline void ignore() { m_retcode = Gaudi::ReturnCode::Success; }
    inline ~RetCodeGuard() {
      if ( Gaudi::ReturnCode::Success != m_retcode ) { Gaudi::setAppReturnCode( m_appmgr, m_retcode ).ignore(); }
    }
 
  private:
    SmartIF<IProperty> m_appmgr;
    int                m_retcode;
  };
} // namespace
//--------------------------------------------------------------------------------------------
// Implementation of IEventProcessor::executeEvent(void* par)
//--------------------------------------------------------------------------------------------
StatusCode MinimalEventLoopMgr::executeEvent( EventContext&& context ) {
  bool eventfailed = false;
 
  m_aess->reset( context );
 
  // select the appropriate store
  if ( m_WB.isValid() ) m_WB->selectStore( context.slot() ).ignore();
 
  // Get the IProperty interface of the ApplicationMgr to pass it to RetCodeGuard
  const auto appmgr = serviceLocator()->as<IProperty>();
  // Call the execute() method of all top algorithms
  for ( auto& ita : m_topAlgList ) {
    StatusCode sc( StatusCode::FAILURE );
    try {
      if ( m_abortEventListener.abortEvent ) {
        DEBMSG << "AbortEvent incident fired by " << m_abortEventListener.abortEventSource << endmsg;
        m_abortEventListener.abortEvent = false;
        sc.ignore();
        break;
      }
      RetCodeGuard rcg( appmgr, Gaudi::ReturnCode::UnhandledException );
      sc = ita->sysExecute( context );
      rcg.ignore(); // disarm the guard
    } catch ( const GaudiException& Exception ) {
      fatal() << ".executeEvent(): Exception with tag=" << Exception.tag() << " thrown by " << ita->name() << endmsg;
      error() << Exception << endmsg;
    } catch ( const std::exception& Exception ) {
      fatal() << ".executeEvent(): Standard std::exception thrown by " << ita->name() << endmsg;
      error() << Exception.what() << endmsg;
    } catch ( ... ) { fatal() << ".executeEvent(): UNKNOWN Exception thrown by " << ita->name() << endmsg; }
 
    if ( !sc.isSuccess() ) {
      warning() << "Execution of algorithm " << ita->name() << " failed" << endmsg;
      eventfailed = true;
    }
  }
 
  m_aess->updateEventStatus( eventfailed, context );
 
  // ensure that the abortEvent flag is cleared before the next event
  if ( m_abortEventListener.abortEvent ) {
    DEBMSG << "AbortEvent incident fired by " << m_abortEventListener.abortEventSource << endmsg;
    m_abortEventListener.abortEvent = false;
  }
 
  // Call the execute() method of all output streams
  for ( auto& ito : m_outStreamList ) {
    AlgExecStateRef state = m_aess->algExecState( ito, context );
    state.setFilterPassed( true );
    StatusCode sc = ito->sysExecute( context );
    if ( !sc.isSuccess() ) {
      warning() << "Execution of output stream " << ito->name() << " failed" << endmsg;
      eventfailed = true;
    }
  }
 
  // Check if there was an error processing current event
  if ( eventfailed ) {
    error() << "Error processing event loop." << endmsg;
    std::ostringstream ost;
    m_aess->dump( ost, context );
    debug() << "Dumping AlgExecStateSvc status:\n" << ost.str() << endmsg;
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}
//--------------------------------------------------------------------------------------------
// Implementation of IEventProcessor::stopRun()
//--------------------------------------------------------------------------------------------
StatusCode MinimalEventLoopMgr::stopRun() {
  // Set the application return code
  auto appmgr = serviceLocator()->as<IProperty>();
  if ( Gaudi::setAppReturnCode( appmgr, Gaudi::ReturnCode::ScheduledStop ).isFailure() ) {
    error() << "Could not set return code of the application (" << Gaudi::ReturnCode::ScheduledStop << ")" << endmsg;
  }
  m_scheduledStop = true;
  return StatusCode::SUCCESS;
}
 
//--------------------------------------------------------------------------------------------
// Top algorithm List handler
//--------------------------------------------------------------------------------------------
void MinimalEventLoopMgr::topAlgHandler( Gaudi::Details::PropertyBase& /* theProp */ ) {
  if ( !( decodeTopAlgs() ).isSuccess() ) {
    throw GaudiException( "Failed to initialize Top Algorithms streams.", "MinimalEventLoopMgr::topAlgHandler",
                          StatusCode::FAILURE );
  }
}
 
//--------------------------------------------------------------------------------------------
// decodeTopAlgNameList & topAlgNameListHandler
//--------------------------------------------------------------------------------------------
StatusCode MinimalEventLoopMgr::decodeTopAlgs() {
  StatusCode sc = StatusCode::SUCCESS;
  if ( CONFIGURED == m_state || INITIALIZED == m_state ) {
    auto algMan = serviceLocator()->as<IAlgManager>();
    if ( algMan ) {
      // Reset the existing Top Algorithm List
      m_topAlgList.clear();
      m_topAlgList.reserve( m_topAlgNames.value().size() );
      for ( const auto& it : m_topAlgNames.value() ) {
        Gaudi::Utils::TypeNameString item{ it };
        // Got the type and name. Now creating the algorithm, avoiding duplicate creation.
        std::string         item_name = item.name();
        const bool          CREATE    = false;
        SmartIF<IAlgorithm> alg       = algMan->algorithm( item_name, CREATE );
        if ( alg ) {
          DEBMSG << "Top Algorithm " << item_name << " already exists" << endmsg;
        } else {
          DEBMSG << "Creating Top Algorithm " << item.type() << " with name " << item_name << endmsg;
          IAlgorithm* ialg = nullptr;
          StatusCode  sc1  = algMan->createAlgorithm( item.type(), item_name, ialg );
          if ( !sc1.isSuccess() ) {
            error() << "Unable to create Top Algorithm " << item.type() << " with name " << item_name << endmsg;
            return sc1;
          }
          alg = ialg; // manage reference counting
        }
        m_topAlgList.push_back( alg );
      }
      return sc;
    }
    sc = StatusCode::FAILURE;
  }
  return sc;
}
 
//--------------------------------------------------------------------------------------------
// Output stream List handler
//--------------------------------------------------------------------------------------------
void MinimalEventLoopMgr::outStreamHandler( Gaudi::Details::PropertyBase& /* theProp */ ) {
  if ( !( decodeOutStreams() ).isSuccess() ) {
    throw GaudiException( "Failed to initialize output streams.", "MinimalEventLoopMgr::outStreamHandler",
                          StatusCode::FAILURE );
  }
}
 
//--------------------------------------------------------------------------------------------
// decodeOutStreamNameList & outStreamNameListHandler
//--------------------------------------------------------------------------------------------
StatusCode MinimalEventLoopMgr::decodeOutStreams() {
  StatusCode sc = StatusCode::SUCCESS;
  if ( CONFIGURED == m_state || INITIALIZED == m_state ) {
    auto algMan = serviceLocator()->as<IAlgManager>();
    if ( algMan ) {
      // Reset the existing Top Algorithm List
      m_outStreamList.clear();
      for ( const auto& it : m_outStreamNames.value() ) {
        Gaudi::Utils::TypeNameString item( it );
        const bool                   CREATE = false;
        SmartIF<IAlgorithm>          os     = algMan->algorithm( item, CREATE );
        if ( os ) {
          DEBMSG << "Output Stream " << item.name() << " already exists" << endmsg;
        } else {
          DEBMSG << "Creating Output Stream " << it << endmsg;
          IAlgorithm* ios = nullptr;
          StatusCode  sc1 = algMan->createAlgorithm( item.type(), item.name(), ios );
          if ( !sc1.isSuccess() ) {
            error() << "Unable to create Output Stream " << it << endmsg;
            return sc1;
          }
          os = ios; // manage reference counting
        }
        m_outStreamList.push_back( os );
      }
      return sc;
    }
    sc = StatusCode::FAILURE;
  }
  return sc;
}