Athena::RCUSvc Class Reference

Service to allow cleaning up RCU objects at the EndEvent. More...

#include <RCUSvc.h>

Inheritance diagram for Athena::RCUSvc:

Collaboration diagram for Athena::RCUSvc:

Public Member Functions
	RCUSvc (const std::string &name, ISvcLocator *svc)
	Standard Gaudi constructor. More...
virtual StatusCode	initialize () override
	Standard Gaudi initialize method. More...
virtual size_t	getNumSlots () const override
	Return the current number of event slots. More...
virtual void	add (IRCUObject *obj) override
	Add a new RCU object to the set being managed. More...
virtual StatusCode	remove (IRCUObject *obj) override
	Remove an RCU object to the set being managed. More...
virtual void	handle (const Incident &inc) override
	Gaudi incident handler. More...

Private Types
typedef std::unordered_set< IRCUObject * >	set_t
	Set of managed objects. More...
typedef std::lock_guard< std::recursive_mutex >	lock_t

Private Attributes
set_t	m_objs
ServiceHandle< IInterface >	m_hiveWhiteBoardSvc
	The hive WB service. Used to get the current number of slots. More...
ServiceHandle< IIncidentSvc >	m_incidentSvc
	Gaudi incident service. More...
std::recursive_mutex	m_mutex
	Mutex protecting access to m_objs. More...

Detailed Description

Service to allow cleaning up RCU objects at the EndEvent.

For a summary of RCU usage, see AthenaKernel/RCUObject.h. This service keeps a registry of RCU objects. At EndEvent, it declares them quiescent for the current event slot.

Definition at line 39 of file RCUSvc.h.

Member Typedef Documentation

lock_t

typedef std::lock_guard<std::recursive_mutex> Athena::RCUSvc::lock_t

private

Definition at line 102 of file RCUSvc.h.

set_t

typedef std::unordered_set<IRCUObject*> Athena::RCUSvc::set_t

private

Set of managed objects.

Definition at line 89 of file RCUSvc.h.

Constructor & Destructor Documentation

RCUSvc()

Athena::RCUSvc::RCUSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Standard Gaudi constructor.

Parameters

name	Service name.
svc	Service locator.
name	Service name. @svc Service locator.

Definition at line 24 of file RCUSvc.cxx.

  : extends<AthService, IRCUSvc, IIncidentListener> (name, svc),
  m_hiveWhiteBoardSvc ("EventDataSvc", name),
  m_incidentSvc ("IncidentSvc", name)
{
  declareProperty ("HiveWhiteBoardSvc", m_hiveWhiteBoardSvc);
  declareProperty ("IncidentSvc", m_incidentSvc);
}

Member Function Documentation

add()

void Athena::RCUSvc::add ( IRCUObject *  obj )

overridevirtual

Add a new RCU object to the set being managed.

Parameters

obj	The RCU object to add.

Definition at line 67 of file RCUSvc.cxx.

{
  lock_t g (m_mutex);
  m_objs.insert (obj);
}

getNumSlots()

size_t Athena::RCUSvc::getNumSlots ( ) const

overridevirtual

Return the current number of event slots.

Definition at line 51 of file RCUSvc.cxx.

{
  // In non-MT mode, `EventDataSvc' does not have an IHiveWhiteBoard interface.
  // Fall back to one slot in that case.
  const SmartIF<IHiveWhiteBoard> wb (m_hiveWhiteBoardSvc.get());
  if (wb) {
    return wb->getNumberOfStores();
  }
  return 1;
}

handle()

void Athena::RCUSvc::handle ( const Incident &  inc )

overridevirtual

Gaudi incident handler.

Declare all managed objects quiescent at EndEvent.

Definition at line 96 of file RCUSvc.cxx.

{
  if (inc.type() == IncidentType::EndEvent) {
    lock_t g (m_mutex);
    // Be careful --- calling quiescent() below may lead to objects being
    // removed from the set.
    std::vector<IRCUObject*> objs (m_objs.begin(), m_objs.end());
    for (IRCUObject* p : objs) {
      if (m_objs.find(p) != m_objs.end()) {
        p->quiescent (inc.context());
      }
    }
  }
}

initialize()

StatusCode Athena::RCUSvc::initialize ( )

overridevirtual

Standard Gaudi initialize method.

Definition at line 37 of file RCUSvc.cxx.

{
  ATH_CHECK( AthService::initialize() );
  ATH_CHECK( m_hiveWhiteBoardSvc.retrieve() );
  ATH_CHECK( m_incidentSvc.retrieve() );
 
  m_incidentSvc->addListener (this, IncidentType::EndEvent);
  return StatusCode::SUCCESS;
}

remove()

StatusCode Athena::RCUSvc::remove ( IRCUObject *  obj )

overridevirtual

Remove an RCU object to the set being managed.

Parameters

obj	The RCU object to remove.

Returns failure if the requested object isn't in the managed set.

Definition at line 80 of file RCUSvc.cxx.

{
  lock_t g (m_mutex);
  set_t::iterator it = m_objs.find (obj);
  if (it == m_objs.end())
    return StatusCode::FAILURE;
  m_objs.erase (it);
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_hiveWhiteBoardSvc

ServiceHandle<IInterface> Athena::RCUSvc::m_hiveWhiteBoardSvc

private

The hive WB service. Used to get the current number of slots.

Definition at line 93 of file RCUSvc.h.

m_incidentSvc

ServiceHandle<IIncidentSvc> Athena::RCUSvc::m_incidentSvc

private

Gaudi incident service.

Definition at line 96 of file RCUSvc.h.

m_mutex

std::recursive_mutex Athena::RCUSvc::m_mutex

private

Mutex protecting access to m_objs.

Definition at line 101 of file RCUSvc.h.

m_objs

set_t Athena::RCUSvc::m_objs

private

Definition at line 90 of file RCUSvc.h.

---

The documentation for this class was generated from the following files:

• RCUSvc.h
• RCUSvc.cxx