Use a minimal event store implementation, and adds everything required to satisfy the IDataProviderSvc, IDataManagerSvc and IHiveWhiteBoard interfaces by throwing exceptions except when the functionality is really needed... More...

Inheritance diagram for EvtStoreSvc:

[legend]

Collaboration diagram for EvtStoreSvc:

[legend]

Public Member Functions
CLID	rootCLID () const override

const std::string &	rootName () const override

StatusCode	setDataLoader (IConversionSvc svc, IDataProviderSvc dpsvc) override

size_t	allocateStore (int evtnumber) override
	Allocate a store partition for a given event number.

StatusCode	freeStore (size_t partition) override
	Free a store partition.

size_t	freeSlots () override

StatusCode	selectStore (size_t partition) override
	Activate a partition object. The identifies the partition uniquely.

StatusCode	clearStore () override

StatusCode	clearStore (size_t partition) override
	Remove all data objects in one 'slot' of the data store.

StatusCode	setNumberOfStores (size_t slots) override
	Set the number of event slots (copies of DataSvc objects).

size_t	getNumberOfStores () const override

size_t	getPartitionNumber (int eventnumber) const override
	Get the partition number corresponding to a given event.

bool	exists (const DataObjID &id) override

StatusCode	objectParent (const DataObject , IRegistry &) override

StatusCode	objectParent (const IRegistry , IRegistry &) override

StatusCode	objectLeaves (const DataObject , std::vector< IRegistry > &) override

StatusCode	objectLeaves (const IRegistry , std::vector< IRegistry > &) override

StatusCode	clearSubTree (std::string_view) override

StatusCode	clearSubTree (DataObject *obj) override

StatusCode	traverseSubTree (std::string_view, IDataStoreAgent *) override

StatusCode	traverseSubTree (DataObject obj, IDataStoreAgent pAgent) override

StatusCode	traverseTree (IDataStoreAgent *pAgent) override

StatusCode	setRoot (std::string root_name, DataObject *pObject) override

StatusCode	setRoot (std::string root_path, IOpaqueAddress *pRootAddr) override

StatusCode	unregisterAddress (std::string_view) override

StatusCode	unregisterAddress (IRegistry *, std::string_view) override

StatusCode	registerAddress (std::string_view fullPath, IOpaqueAddress *pAddress) override

StatusCode	registerAddress (IRegistry parentObj, std::string_view objectPath, IOpaqueAddress pAddress) override

StatusCode	registerObject (std::string_view parentPath, std::string_view objectPath, DataObject *pObject) override

StatusCode	registerObject (DataObject parentObj, std::string_view objectPath, DataObject pObject) override

StatusCode	unregisterObject (std::string_view) override

StatusCode	unregisterObject (DataObject *obj) override

StatusCode	unregisterObject (DataObject *obj, std::string_view sr) override

StatusCode	retrieveObject (IRegistry pDirectory, std::string_view path, DataObject &pObject) override

StatusCode	findObject (IRegistry pDirectory, std::string_view path, DataObject &pObject) override

StatusCode	findObject (std::string_view fullPath, DataObject *&pObject) override

StatusCode	updateObject (IRegistry *) override

StatusCode	updateObject (DataObject *) override

StatusCode	addPreLoadItem (const DataStoreItem &) override

StatusCode	removePreLoadItem (const DataStoreItem &) override

StatusCode	resetPreLoad () override

StatusCode	preLoad () override

StatusCode	linkObject (IRegistry , std::string_view, DataObject ) override

StatusCode	linkObject (std::string_view, DataObject *) override

StatusCode	unlinkObject (IRegistry *, std::string_view) override

StatusCode	unlinkObject (DataObject *, std::string_view) override

StatusCode	unlinkObject (std::string_view) override

StatusCode	initialize () override

StatusCode	finalize () override

Public Member Functions inherited from extends< Service, IDataProviderSvc, IDataManagerSvc, IHiveWhiteBoard >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service.

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service.

StatusCode	sysStart () override
	Initialize Service.

StatusCode	sysStop () override
	Initialize Service.

StatusCode	sysFinalize () override
	Finalize Service.

StatusCode	sysReinitialize () override
	Re-initialize the Service.

StatusCode	sysRestart () override
	Re-initialize the Service.

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool.

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Private Member Functions
std::size_t	poolSize () const

void	fillStats (Partition &p) const

void	initStore (Partition &p) const

Private Attributes
Gaudi::Property< CLID >	m_rootCLID { this, "RootCLID", 110 , "CLID of root entry" }

Gaudi::Property< std::string >	m_rootName { this, "RootName", "/Event", "name of root entry" }

Gaudi::Property< bool >	m_forceLeaves

Gaudi::Property< std::string >	m_loader { this, "DataLoader", "EventPersistencySvc" }

Gaudi::Property< size_t >	m_slots { this, "EventSlots", 1, "number of event slots" }

Gaudi::Property< bool >	m_printPoolStats { this, "PrintPoolStats", false, "Print memory pool statistics" }

Gaudi::Property< std::size_t >	m_poolSize { this, "PoolSize", 1024, "Initial per-event memory pool size [KiB]" }

Gaudi::Property< std::size_t >	m_estStoreBuckets

Gaudi::Accumulators::AveragingCounter< std::size_t >	m_usedPoolSize

Gaudi::Accumulators::AveragingCounter< std::size_t >	m_servedPoolAllocations

Gaudi::Accumulators::AveragingCounter< std::size_t >	m_usedPoolAllocations

Gaudi::Accumulators::AveragingCounter< std::size_t >	m_storeEntries

Gaudi::Accumulators::AveragingCounter< std::size_t >	m_storeBuckets

SmartIF< IConversionSvc >	m_dataLoader

std::vector< DataStoreItem >	m_preLoads
	Items to be pre-loaded.

std::vector< Synced< Partition > >	m_partitions
	The actual store(s)

tbb::concurrent_queue< size_t >	m_freeSlots

Gaudi::Property< std::vector< std::string > >	m_inhibitPrefixes

Gaudi::Property< bool >	m_followLinksToAncestors

std::string_view	m_onlyThisID

Additional Inherited Members
Public Types inherited from extends< Service, IDataProviderSvc, IDataManagerSvc, IHiveWhiteBoard >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory<IService( const std::string&, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

int	outputLevel () const
	get the `Service's` output level

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const override final
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Detailed Description

Use a minimal event store implementation, and adds everything required to satisfy the IDataProviderSvc, IDataManagerSvc and IHiveWhiteBoard interfaces by throwing exceptions except when the functionality is really needed...

Author: Gerhard Raven

Version: 1.0

Definition at line 235 of file EvtStoreSvc.cpp.

Member Function Documentation

◆ addPreLoadItem()

StatusCode EvtStoreSvc::addPreLoadItem ( const DataStoreItem & item )

override

Definition at line 653 of file EvtStoreSvc.cpp.

                                                                  {
  auto i = std::find( m_preLoads.begin(), m_preLoads.end(), item );
  if ( i == m_preLoads.end() ) m_preLoads.push_back( item );
  return StatusCode::SUCCESS;
}

◆ allocateStore()

size_t EvtStoreSvc::allocateStore ( int evtnumber )

override

Allocate a store partition for a given event number.

Definition at line 419 of file EvtStoreSvc.cpp.

                                                 {
  // take next free slot in the list
  size_t slot = std::string::npos;
  if ( m_freeSlots.try_pop( slot ) ) {
    assert( slot != std::string::npos );
    assert( slot < m_partitions.size() );
    [[maybe_unused]] auto prev = m_partitions[slot].with_lock(
        [evtnumber]( Partition& p ) { return std::exchange( p.eventNumber, evtnumber ); } );
    assert( prev == -1 ); // or whatever value represents 'free'
  }
  return slot;
}

◆ clearStore() [1/2]

StatusCode EvtStoreSvc::clearStore ( )

override

Definition at line 480 of file EvtStoreSvc.cpp.

                                   {
  m_onlyThisID = {};
  return fwd( [this]( Partition& p ) {
    fillStats( p );
    initStore( p ); // replace with a clean store
    return StatusCode::SUCCESS;
  } );
}

◆ clearStore() [2/2]

StatusCode EvtStoreSvc::clearStore ( size_t partition )

override

Remove all data objects in one 'slot' of the data store.

Definition at line 465 of file EvtStoreSvc.cpp.

                                                     {
  m_onlyThisID = {};
  return m_partitions[partition].with_lock( [this]( Partition& p ) {
    fillStats( p );
    initStore( p ); // replace with a clean store
    return StatusCode::SUCCESS;
  } );
}

◆ clearSubTree() [1/2]

StatusCode EvtStoreSvc::clearSubTree ( DataObject * obj )

inlineoverride

Definition at line 320 of file EvtStoreSvc.cpp.

                                                      {
    return obj && obj->registry() ? clearSubTree( obj->registry()->identifier() ) : StatusCode::FAILURE;
  }

◆ clearSubTree() [2/2]

StatusCode EvtStoreSvc::clearSubTree ( std::string_view top )

override

Definition at line 473 of file EvtStoreSvc.cpp.

                                                         {
  top = normalize_path( top, rootName() );
  return fwd( [&]( Partition& p ) {
    p.store->erase_if( [top]( const auto& value ) { return value.first.starts_with( top ); } );
    return StatusCode::SUCCESS;
  } );
}

◆ exists()

bool EvtStoreSvc::exists ( const DataObjID & id )

inlineoverride

Definition at line 309 of file EvtStoreSvc.cpp.

                                                    {
    DataObject* pObject{ nullptr };
    return findObject( id.fullKey(), pObject ).isSuccess();
  }

◆ fillStats()

void EvtStoreSvc::fillStats ( Partition & p ) const

inlineprivate

Definition at line 252 of file EvtStoreSvc.cpp.

                                       {
    if ( !m_printPoolStats ) return;
    auto n_allocs = p.store->num_allocations();
    if ( n_allocs ) {
      m_storeEntries += p.store->size();
      m_usedPoolSize += p.store->used_bytes();
      m_storeBuckets += p.store->used_buckets();
      m_usedPoolAllocations += p.store->used_blocks();
      m_servedPoolAllocations += n_allocs;
    }
  }

◆ finalize()

StatusCode EvtStoreSvc::finalize ( )

inlineoverride

Definition at line 395 of file EvtStoreSvc.cpp.

                                 {
    if ( m_printPoolStats ) {
      info() << "Mean memory pool usage: " << float( 1e-3f * float( m_usedPoolSize.mean() ) ) << " KiB serving "
             << float( m_servedPoolAllocations.mean() ) << " allocations from " << float( m_usedPoolAllocations.mean() )
             << " to produce " << float( m_storeEntries.mean() ) << " entries in " << float( m_storeBuckets.mean() )
             << " buckets" << endmsg;
    }
    setDataLoader( nullptr, nullptr ).ignore(); // release
    return extends::finalize();
  }

◆ findObject() [1/2]

StatusCode EvtStoreSvc::findObject	(	IRegistry *	pDirectory,
		std::string_view	path,
		DataObject *&	pObject )

override

Definition at line 644 of file EvtStoreSvc.cpp.

                                                                                                     {
  return retrieveObject( pDirectory, path, pObject );
}

◆ findObject() [2/2]

StatusCode EvtStoreSvc::findObject	(	std::string_view	fullPath,
		DataObject *&	pObject )

override

Definition at line 647 of file EvtStoreSvc.cpp.

                                                                                  {
  return retrieveObject( nullptr, fullPath, pObject );
}

◆ freeSlots()

size_t EvtStoreSvc::freeSlots ( )

inlineoverride

Definition at line 302 of file EvtStoreSvc.cpp.

302{ return m_freeSlots.unsafe_size(); }

◆ freeStore()

StatusCode EvtStoreSvc::freeStore ( size_t partition )

override

Free a store partition.

Definition at line 457 of file EvtStoreSvc.cpp.

                                                    {
  assert( partition < m_partitions.size() );
  auto prev = m_partitions[partition].with_lock( []( Partition& p ) { return std::exchange( p.eventNumber, -1 ); } );
  if ( prev == -1 ) return StatusCode::FAILURE; // double free -- should never happen!
  m_freeSlots.push( partition );
  return StatusCode::SUCCESS;
}

◆ getNumberOfStores()

size_t EvtStoreSvc::getNumberOfStores ( ) const

inlineoverride

Definition at line 307 of file EvtStoreSvc.cpp.

307{ return m_slots; }

EvtStoreSvc::m_slots

Gaudi::Property< size_t > m_slots

Definition EvtStoreSvc.cpp:241

◆ getPartitionNumber()

size_t EvtStoreSvc::getPartitionNumber ( int eventnumber ) const

override

Get the partition number corresponding to a given event.

Definition at line 446 of file EvtStoreSvc.cpp.

                                                              {
  auto i = std::find_if( begin( m_partitions ), end( m_partitions ),
                         with_lock( [eventnumber]( const Partition& p ) { return p.eventNumber == eventnumber; } ) );
  return i != end( m_partitions ) ? std::distance( begin( m_partitions ), i ) : std::string::npos;
}

◆ initialize()

StatusCode EvtStoreSvc::initialize ( )

inlineoverride

Definition at line 373 of file EvtStoreSvc.cpp.

                                   {
    Entry::setDataProviderSvc( this );
    extends::initialize().ignore();
    if ( !setNumberOfStores( m_slots ).isSuccess() ) {
      error() << "Cannot set number of slots" << endmsg;
      return StatusCode::FAILURE;
    }
    m_partitions = std::vector<Synced<Partition>>( m_slots );
    // m_partitions is now full of empty std::optionals, fill them now.
    for ( auto& synced_p : m_partitions ) {
      synced_p.with_lock( [this]( Partition& p ) { initStore( p ); } );
    }
    for ( size_t i = 0; i < m_slots; i++ ) { m_freeSlots.push( i ); }
    selectStore( 0 ).ignore();
 
    auto loader = serviceLocator()->service( m_loader ).as<IConversionSvc>().get();
    if ( !loader ) {
      error() << "Cannot get IConversionSvc " << m_loader.value() << endmsg;
      return StatusCode::FAILURE;
    }
    return setDataLoader( loader, nullptr );
  }

◆ initStore()

void EvtStoreSvc::initStore ( Partition & p ) const

inlineprivate

Definition at line 264 of file EvtStoreSvc.cpp.

                                       {
    if ( p.store ) {
      // re-use the existing memory pool
      p.store->reset();
    } else {
      p.store.emplace( m_estStoreBuckets, poolSize() );
    }
  }

◆ linkObject() [1/2]

StatusCode EvtStoreSvc::linkObject	(	IRegistry *	,
		std::string_view	,
		DataObject *	)

inlineoverride

Definition at line 367 of file EvtStoreSvc.cpp.

367{ return dummy( __FUNCTION__ ); }

◆ linkObject() [2/2]

StatusCode EvtStoreSvc::linkObject	(	std::string_view	,
		DataObject *	)

inlineoverride

Definition at line 368 of file EvtStoreSvc.cpp.

368{ return dummy( __FUNCTION__ ); }

◆ objectLeaves() [1/2]

StatusCode EvtStoreSvc::objectLeaves	(	const DataObject *	,
		std::vector< IRegistry * > &	)

inlineoverride

Definition at line 316 of file EvtStoreSvc.cpp.

316{ return dummy( __FUNCTION__ ); }

◆ objectLeaves() [2/2]

StatusCode EvtStoreSvc::objectLeaves	(	const IRegistry *	,
		std::vector< IRegistry * > &	)

inlineoverride

Definition at line 317 of file EvtStoreSvc.cpp.

317{ return dummy( __FUNCTION__ ); }

◆ objectParent() [1/2]

StatusCode EvtStoreSvc::objectParent	(	const DataObject *	,
		IRegistry *&	)

inlineoverride

Definition at line 314 of file EvtStoreSvc.cpp.

314{ return dummy( __FUNCTION__ ); }

◆ objectParent() [2/2]

StatusCode EvtStoreSvc::objectParent	(	const IRegistry *	,
		IRegistry *&	)

inlineoverride

Definition at line 315 of file EvtStoreSvc.cpp.

315{ return dummy( __FUNCTION__ ); }

◆ poolSize()

std::size_t EvtStoreSvc::poolSize ( ) const

inlineprivate

Definition at line 250 of file EvtStoreSvc.cpp.

250{ return m_poolSize * 1024; }

EvtStoreSvc::m_poolSize

Gaudi::Property< std::size_t > m_poolSize

Definition EvtStoreSvc.cpp:243

◆ preLoad()

StatusCode EvtStoreSvc::preLoad ( )

override

Definition at line 663 of file EvtStoreSvc.cpp.

                                {
  for ( const auto& i : m_preLoads ) {
    DataObject* pObj;
    if ( msgLevel( MSG::DEBUG ) ) debug() << "Preloading " << i.path() << endmsg;
    retrieveObject( nullptr, i.path(), pObj ).ignore();
  }
  return StatusCode::SUCCESS;
}

◆ registerAddress() [1/2]

StatusCode EvtStoreSvc::registerAddress	(	IRegistry *	parentObj,
		std::string_view	objectPath,
		IOpaqueAddress *	pAddress )

override

Definition at line 552 of file EvtStoreSvc.cpp.

                                                                                                     {
  auto addr = std::unique_ptr<IOpaqueAddress>( pAddr );
  if ( !addr ) return Status::INVALID_OBJ_ADDR; // Precondition: Address must be valid
  if ( msgLevel( MSG::DEBUG ) ) {
    debug() << "registerAddress( (IRegistry*)" << (void*)pReg << ", " << path << ", (IOpaqueAddress*)" << addr.get()
            << "[ " << addr->par()[0] << ", " << addr->par()[1] << " ]"
            << " )" << endmsg;
  }
  if ( path.empty() || path[0] != '/' ) return StatusCode::FAILURE;
  if ( !m_onlyThisID.empty() && addr->par()[0] != m_onlyThisID ) {
    if ( msgLevel( MSG::DEBUG ) )
      debug() << "Attempt to load " << addr->par()[1] << " from file " << addr->par()[0] << " blocked -- different file"
              << endmsg;
    return StatusCode::SUCCESS;
  }
  if ( std::any_of(
           m_inhibitPrefixes.begin(), m_inhibitPrefixes.end(),
           [addrPath = addr->par()[1]]( std::string_view prefix ) { return addrPath.starts_with( prefix ); } ) ) {
    if ( msgLevel( MSG::DEBUG ) )
      debug() << "Attempt to load " << addr->par()[1] << " from file " << addr->par()[0] << " blocked -- path inhibited"
              << endmsg;
    return StatusCode::SUCCESS;
  }
 
  auto object = createObj( *m_dataLoader, *addr ); // Call data loader
  if ( !object ) return Status::INVALID_OBJECT;
  auto fullpath = ( pReg ? pReg->identifier() : m_rootName.value() ) + std::string{ path };
  // the data loader expects the path _including_ the root
  LocalArena dummy_arena{ fullpath.size() + 1 };
  auto       dummy = Entry{ fullpath, {}, {}, &dummy_arena };
  object->setRegistry( &dummy );
  addr->setRegistry( &dummy );
  auto status = m_dataLoader->fillObjRefs( addr.get(), object.get() );
  if ( !status.isSuccess() ) return status;
  // note: put will overwrite the registry in pObject to point at the
  //       one actually used -- so we do not dangle, pointing at dummy beyond its
  //       lifetime
  if ( msgLevel( MSG::DEBUG ) ) {
    auto ptr = object.get();
    debug() << "registerAddress: " << std::quoted( normalize_path( fullpath, rootName() ) ) << " (DataObject*)"
            << static_cast<void*>( ptr ) << ( ptr ? " -> " + System::typeinfoName( typeid( *ptr ) ) : std::string{} )
            << endmsg;
  }
  fwd( [&]( Partition& p ) {
    p.store->put( normalize_path( fullpath, rootName() ), std::move( object ), std::move( addr ) );
    return StatusCode::SUCCESS;
  } ).ignore();
  return status;
}

◆ registerAddress() [2/2]

StatusCode EvtStoreSvc::registerAddress	(	std::string_view	fullPath,
		IOpaqueAddress *	pAddress )

override

Definition at line 549 of file EvtStoreSvc.cpp.

                                                                                    {
  return registerAddress( nullptr, path, pAddr );
}

◆ registerObject() [1/2]

StatusCode EvtStoreSvc::registerObject	(	DataObject *	parentObj,
		std::string_view	objectPath,
		DataObject *	pObject )

override

Definition at line 607 of file EvtStoreSvc.cpp.

                                                                                                        {
  if ( parentObj ) return StatusCode::FAILURE;
  return fwd( [&, object = std::unique_ptr<DataObject>( pObject ),
               path = normalize_path( path, rootName() )]( Partition& p ) mutable {
    if ( m_forceLeaves ) {
      auto dir = path;
      for ( auto i = dir.rfind( '/' ); i != std::string_view::npos; i = dir.rfind( '/' ) ) {
        dir = dir.substr( 0, i );
        if ( !p.store->find( dir ) ) {
          if ( msgLevel( MSG::DEBUG ) ) {
            debug() << "registerObject: adding directory " << std::quoted( dir ) << endmsg;
          }
          p.store->put( dir, std::unique_ptr<DataObject>{} );
        }
      }
    }
    if ( msgLevel( MSG::DEBUG ) ) {
      auto ptr = object.get();
      debug() << "registerObject: " << std::quoted( path ) << " (DataObject*)" << static_cast<void*>( ptr )
              << ( ptr ? " -> " + System::typeinfoName( typeid( *ptr ) ) : std::string{} ) << endmsg;
    }
    p.store->put( path, std::move( object ) );
    return StatusCode::SUCCESS;
  } );
}

◆ registerObject() [2/2]

StatusCode EvtStoreSvc::registerObject	(	std::string_view	parentPath,
		std::string_view	objectPath,
		DataObject *	pObject )

override

Definition at line 601 of file EvtStoreSvc.cpp.

                                                              {
  return parentPath.empty()
             ? registerObject( nullptr, objectPath, pObject )
             : registerObject( nullptr, std::string{ parentPath }.append( "/" ).append( objectPath ), pObject );
}

◆ removePreLoadItem()

StatusCode EvtStoreSvc::removePreLoadItem ( const DataStoreItem & item )

override

Definition at line 658 of file EvtStoreSvc.cpp.

                                                                     {
  auto i = std::remove( m_preLoads.begin(), m_preLoads.begin(), item );
  m_preLoads.erase( i, m_preLoads.end() );
  return StatusCode::SUCCESS;
}

◆ resetPreLoad()

StatusCode EvtStoreSvc::resetPreLoad ( )

inlineoverride

Definition at line 361 of file EvtStoreSvc.cpp.

                                     {
    m_preLoads.clear();
    return StatusCode::SUCCESS;
  }

◆ retrieveObject()

StatusCode EvtStoreSvc::retrieveObject	(	IRegistry *	pDirectory,
		std::string_view	path,
		DataObject *&	pObject )

override

Definition at line 632 of file EvtStoreSvc.cpp.

                                                                                                         {
  if ( pDirectory ) return StatusCode::FAILURE;
  return fwd( [&]( Partition& p ) {
    path    = normalize_path( path, rootName() );
    pObject = const_cast<DataObject*>( p.store->get( path ) );
    if ( msgLevel( MSG::DEBUG ) ) {
      debug() << "retrieveObject: " << std::quoted( path ) << " (DataObject*)" << (void*)pObject
              << ( pObject ? " -> " + System::typeinfoName( typeid( *pObject ) ) : std::string{} ) << endmsg;
    }
    return pObject ? StatusCode::SUCCESS : StatusCode::FAILURE;
  } );
}

◆ rootCLID()

CLID EvtStoreSvc::rootCLID ( ) const

override

Definition at line 411 of file EvtStoreSvc.cpp.

411{ return m_rootCLID; }

EvtStoreSvc::m_rootCLID

Gaudi::Property< CLID > m_rootCLID

Definition EvtStoreSvc.cpp:236

◆ rootName()

const std::string & EvtStoreSvc::rootName ( ) const

override

Definition at line 412 of file EvtStoreSvc.cpp.

412{ return m_rootName; }

◆ selectStore()

StatusCode EvtStoreSvc::selectStore ( size_t partition )

override

Activate a partition object. The identifies the partition uniquely.

Definition at line 452 of file EvtStoreSvc.cpp.

                                                      {
  s_current = &m_partitions[partition];
  return StatusCode::SUCCESS;
}

◆ setDataLoader()

StatusCode EvtStoreSvc::setDataLoader	(	IConversionSvc *	svc,
		IDataProviderSvc *	dpsvc )

override

Definition at line 413 of file EvtStoreSvc.cpp.

                                                                                                    {
  m_dataLoader = pDataLoader;
  if ( m_dataLoader ) m_dataLoader->setDataProvider( dpsvc ? dpsvc : this ).ignore();
  return StatusCode::SUCCESS;
}

◆ setNumberOfStores()

StatusCode EvtStoreSvc::setNumberOfStores ( size_t slots )

override

Set the number of event slots (copies of DataSvc objects).

Definition at line 432 of file EvtStoreSvc.cpp.

                                                        {
  if ( slots < size_t{ 1 } ) {
    error() << "Invalid number of slots (" << slots << ")" << endmsg;
    return StatusCode::FAILURE;
  }
  if ( FSMState() == Gaudi::StateMachine::INITIALIZED || FSMState() == Gaudi::StateMachine::RUNNING ) {
    error() << "Too late to change the number of slots!" << endmsg;
    return StatusCode::FAILURE;
  }
  m_slots = slots;
  Gaudi::Concurrency::ConcurrencyFlags::setNumConcEvents( slots );
  return StatusCode::SUCCESS;
}

◆ setRoot() [1/2]

StatusCode EvtStoreSvc::setRoot	(	std::string	root_name,
		DataObject *	pObject )

override

Definition at line 509 of file EvtStoreSvc.cpp.

                                                                          {
  if ( msgLevel( MSG::DEBUG ) ) {
    debug() << "setRoot( " << root_path << ", (DataObject*)" << (void*)pObject << " )" << endmsg;
  }
  if ( !fwd( []( Partition& p ) {
          return p.store->empty() ? StatusCode::SUCCESS : StatusCode::FAILURE;
        } ).isSuccess() ) {
    throw GaudiException{ "setRoot called with non-empty store", "EvtStoreSvc", StatusCode::FAILURE };
  }
  return registerObject( nullptr, root_path, pObject );
}

◆ setRoot() [2/2]

StatusCode EvtStoreSvc::setRoot	(	std::string	root_path,
		IOpaqueAddress *	pRootAddr )

override

Definition at line 520 of file EvtStoreSvc.cpp.

                                                                                {
  auto rootAddr = std::unique_ptr<IOpaqueAddress>( pRootAddr );
  if ( msgLevel( MSG::DEBUG ) ) {
    debug() << "setRoot( " << root_path << ", (IOpaqueAddress*)" << rootAddr.get();
    if ( rootAddr ) debug() << "[ " << rootAddr->par()[0] << ", " << rootAddr->par()[1] << " ]";
    debug() << " )" << endmsg;
  }
  if ( !fwd( []( Partition& p ) {
          return p.store->empty() ? StatusCode::SUCCESS : StatusCode::FAILURE;
        } ).isSuccess() ) {
    throw GaudiException{ "setRoot called with non-empty store", "EvtStoreSvc", StatusCode::FAILURE };
  }
  if ( !rootAddr ) return Status::INVALID_OBJ_ADDR; // Precondition: Address must be valid
  if ( !m_followLinksToAncestors ) m_onlyThisID = rootAddr->par()[0];
  auto object = createObj( *m_dataLoader, *rootAddr ); // Call data loader
  if ( !object ) return Status::INVALID_OBJECT;
  if ( msgLevel( MSG::DEBUG ) ) { debug() << "Root Object " << root_path << " created " << endmsg; }
  LocalArena dummy_arena{ root_path.size() + 1 };
  auto       dummy = Entry{ root_path, {}, {}, &dummy_arena };
  object->setRegistry( &dummy );
  rootAddr->setRegistry( &dummy );
  auto status = m_dataLoader->fillObjRefs( rootAddr.get(), object.get() );
  if ( status.isSuccess() ) {
    auto pObject = object.get();
    status       = registerObject( nullptr, root_path, object.release() );
    if ( status.isSuccess() ) pObject->registry()->setAddress( rootAddr.release() );
  }
  return status;
}

◆ traverseSubTree() [1/2]

StatusCode EvtStoreSvc::traverseSubTree	(	DataObject *	obj,
		IDataStoreAgent *	pAgent )

inlineoverride

Definition at line 325 of file EvtStoreSvc.cpp.

                                                                                  {
    return ( obj && obj->registry() ) ? traverseSubTree( obj->registry()->identifier(), pAgent ) : StatusCode::FAILURE;
  }

◆ traverseSubTree() [2/2]

StatusCode EvtStoreSvc::traverseSubTree	(	std::string_view	top,
		IDataStoreAgent *	pAgent )

override

Definition at line 488 of file EvtStoreSvc.cpp.

                                                                                     {
  return fwd( [&]( Partition& p ) {
    top                              = normalize_path( top, rootName() );
    unsigned int nbSlashesInRootName = std::count( rootName().begin(), rootName().end(), '/' );
    auto         cmp = []( const Entry* lhs, const Entry* rhs ) { return lhs->identifier() < rhs->identifier(); };
    std::set<const Entry*, decltype( cmp )> keys{ std::move( cmp ) };
    for ( const auto& v : *p.store ) {
      if ( v.second.identifier().starts_with( top ) ) keys.insert( &v.second );
    }
    auto k = keys.begin();
    while ( k != keys.end() ) {
      const auto& id     = ( *k )->identifier();
      int         level  = std::count( id.begin(), id.end(), '/' ) + nbSlashesInRootName;
      bool        accept = pAgent->analyse( const_cast<Entry*>( *( k++ ) ), level );
      if ( !accept ) {
        k = std::find_if_not( k, keys.end(), [&id]( const auto& e ) { return e->identifier().starts_with( id ); } );
      }
    }
    return StatusCode::SUCCESS;
  } );
}

◆ traverseTree()

StatusCode EvtStoreSvc::traverseTree ( IDataStoreAgent * pAgent )

inlineoverride

Definition at line 328 of file EvtStoreSvc.cpp.

328{ return traverseSubTree( std::string_view{}, pAgent ); }

◆ unlinkObject() [1/3]

StatusCode EvtStoreSvc::unlinkObject	(	DataObject *	,
		std::string_view	)

inlineoverride

Definition at line 370 of file EvtStoreSvc.cpp.

370{ return dummy( __FUNCTION__ ); }

◆ unlinkObject() [2/3]

StatusCode EvtStoreSvc::unlinkObject	(	IRegistry *	,
		std::string_view	)

inlineoverride

Definition at line 369 of file EvtStoreSvc.cpp.

369{ return dummy( __FUNCTION__ ); }

◆ unlinkObject() [3/3]

StatusCode EvtStoreSvc::unlinkObject ( std::string_view )

inlineoverride

Definition at line 371 of file EvtStoreSvc.cpp.

371{ return dummy( __FUNCTION__ ); }

◆ unregisterAddress() [1/2]

StatusCode EvtStoreSvc::unregisterAddress	(	IRegistry *	,
		std::string_view	)

inlineoverride

Definition at line 334 of file EvtStoreSvc.cpp.

334{ return dummy( __FUNCTION__ ); };

◆ unregisterAddress() [2/2]

StatusCode EvtStoreSvc::unregisterAddress ( std::string_view )

inlineoverride

Definition at line 333 of file EvtStoreSvc.cpp.

333{ return dummy( __FUNCTION__ ); };

◆ unregisterObject() [1/3]

StatusCode EvtStoreSvc::unregisterObject ( DataObject * obj )

inlineoverride

Definition at line 342 of file EvtStoreSvc.cpp.

                                                          {
    return ( obj && obj->registry() ) ? unregisterObject( obj->registry()->identifier() ) : StatusCode::FAILURE;
  }

◆ unregisterObject() [2/3]

StatusCode EvtStoreSvc::unregisterObject	(	DataObject *	obj,
		std::string_view	sr )

inlineoverride

Definition at line 345 of file EvtStoreSvc.cpp.

                                                                             {
    return !obj              ? unregisterObject( sr )
           : obj->registry() ? unregisterObject( ( obj->registry()->identifier() + '/' ).append( sr ) )
                             : StatusCode::FAILURE;
  };

◆ unregisterObject() [3/3]

StatusCode EvtStoreSvc::unregisterObject ( std::string_view sr )

override

Definition at line 650 of file EvtStoreSvc.cpp.

                                                            {
  return fwd( [&]( Partition& p ) { return p.store->erase( sr ) != 0 ? StatusCode::SUCCESS : StatusCode::FAILURE; } );
}

◆ updateObject() [1/2]

StatusCode EvtStoreSvc::updateObject ( DataObject * )

inlineoverride

Definition at line 357 of file EvtStoreSvc.cpp.

357{ return dummy( __FUNCTION__ ); }

◆ updateObject() [2/2]

StatusCode EvtStoreSvc::updateObject ( IRegistry * )

inlineoverride

Definition at line 356 of file EvtStoreSvc.cpp.

356{ return dummy( __FUNCTION__ ); }

Member Data Documentation

◆ m_dataLoader

SmartIF<IConversionSvc> EvtStoreSvc::m_dataLoader

private

Definition at line 273 of file EvtStoreSvc.cpp.

◆ m_estStoreBuckets

Gaudi::Property<std::size_t> EvtStoreSvc::m_estStoreBuckets

private

Initial value:

{ this, "StoreBuckets", 100,

"Estimated number of buckets in the store" }

Definition at line 244 of file EvtStoreSvc.cpp.

244 { this, "StoreBuckets", 100,

245 "Estimated number of buckets in the store" };

◆ m_followLinksToAncestors

Gaudi::Property<bool> EvtStoreSvc::m_followLinksToAncestors

private

Initial value:

{
      this, "FollowLinksToAncestors", true,
      "Load objects which reside in files other than the one corresponding to the root of the event store" }

Definition at line 288 of file EvtStoreSvc.cpp.

                                              {
      this, "FollowLinksToAncestors", true,
      "Load objects which reside in files other than the one corresponding to the root of the event store" };

◆ m_forceLeaves

Gaudi::Property<bool> EvtStoreSvc::m_forceLeaves

private

Initial value:

{ this, "ForceLeaves", false,

"force creation of default leaves on registerObject" }

Definition at line 238 of file EvtStoreSvc.cpp.

238 { this, "ForceLeaves", false,

239 "force creation of default leaves on registerObject" };

◆ m_freeSlots

tbb::concurrent_queue<size_t> EvtStoreSvc::m_freeSlots

private

Definition at line 281 of file EvtStoreSvc.cpp.

◆ m_inhibitPrefixes

Gaudi::Property<std::vector<std::string> > EvtStoreSvc::m_inhibitPrefixes

private

Initial value:

{
      this,
      "InhibitedPathPrefixes",
      {},
      "Prefixes of TES locations that will not be loaded by the persistency service " }

Definition at line 283 of file EvtStoreSvc.cpp.

                                                       {
      this,
      "InhibitedPathPrefixes",
      {},
      "Prefixes of TES locations that will not be loaded by the persistency service " };

◆ m_loader

Gaudi::Property<std::string> EvtStoreSvc::m_loader { this, "DataLoader", "EventPersistencySvc" }

private

Definition at line 240 of file EvtStoreSvc.cpp.

240{ this, "DataLoader", "EventPersistencySvc" };

◆ m_onlyThisID

std::string_view EvtStoreSvc::m_onlyThisID

private

Definition at line 291 of file EvtStoreSvc.cpp.

◆ m_partitions

std::vector<Synced<Partition> > EvtStoreSvc::m_partitions

private

The actual store(s)

Definition at line 279 of file EvtStoreSvc.cpp.

◆ m_poolSize

Gaudi::Property<std::size_t> EvtStoreSvc::m_poolSize { this, "PoolSize", 1024, "Initial per-event memory pool size [KiB]" }

private

Definition at line 243 of file EvtStoreSvc.cpp.

243{ this, "PoolSize", 1024, "Initial per-event memory pool size [KiB]" };

◆ m_preLoads

std::vector<DataStoreItem> EvtStoreSvc::m_preLoads

private

Items to be pre-loaded.

Definition at line 276 of file EvtStoreSvc.cpp.

◆ m_printPoolStats

Gaudi::Property<bool> EvtStoreSvc::m_printPoolStats { this, "PrintPoolStats", false, "Print memory pool statistics" }

private

Definition at line 242 of file EvtStoreSvc.cpp.

242{ this, "PrintPoolStats", false, "Print memory pool statistics" };

◆ m_rootCLID

Gaudi::Property<CLID> EvtStoreSvc::m_rootCLID { this, "RootCLID", 110 , "CLID of root entry" }

private

Definition at line 236 of file EvtStoreSvc.cpp.

236{ this, "RootCLID", 110 /*CLID_Event*/, "CLID of root entry" };

◆ m_rootName

Gaudi::Property<std::string> EvtStoreSvc::m_rootName { this, "RootName", "/Event", "name of root entry" }

private

Definition at line 237 of file EvtStoreSvc.cpp.

237{ this, "RootName", "/Event", "name of root entry" };

◆ m_servedPoolAllocations

Gaudi::Accumulators::AveragingCounter<std::size_t> EvtStoreSvc::m_servedPoolAllocations

private

Definition at line 246 of file EvtStoreSvc.cpp.

◆ m_slots

Gaudi::Property<size_t> EvtStoreSvc::m_slots { this, "EventSlots", 1, "number of event slots" }

private

Definition at line 241 of file EvtStoreSvc.cpp.

241{ this, "EventSlots", 1, "number of event slots" };

◆ m_storeBuckets

Gaudi::Accumulators::AveragingCounter<std::size_t> EvtStoreSvc::m_storeBuckets

private

Definition at line 247 of file EvtStoreSvc.cpp.

◆ m_storeEntries

Gaudi::Accumulators::AveragingCounter<std::size_t> EvtStoreSvc::m_storeEntries

private

Definition at line 247 of file EvtStoreSvc.cpp.

◆ m_usedPoolAllocations

Gaudi::Accumulators::AveragingCounter<std::size_t> EvtStoreSvc::m_usedPoolAllocations

private

Definition at line 247 of file EvtStoreSvc.cpp.

◆ m_usedPoolSize

Gaudi::Accumulators::AveragingCounter<std::size_t> EvtStoreSvc::m_usedPoolSize

mutableprivate

Definition at line 246 of file EvtStoreSvc.cpp.

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

GaudiCommonSvc/src/DataSvc/EvtStoreSvc.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addPreLoadItem()

◆ allocateStore()

◆ clearStore() [1/2]

◆ clearStore() [2/2]

◆ clearSubTree() [1/2]

◆ clearSubTree() [2/2]

◆ exists()

◆ fillStats()

◆ finalize()

◆ findObject() [1/2]

◆ findObject() [2/2]

◆ freeSlots()

◆ freeStore()

◆ getNumberOfStores()

◆ getPartitionNumber()

◆ initialize()

◆ initStore()

◆ linkObject() [1/2]

◆ linkObject() [2/2]

◆ objectLeaves() [1/2]

◆ objectLeaves() [2/2]

◆ objectParent() [1/2]

◆ objectParent() [2/2]

◆ poolSize()

◆ preLoad()

◆ registerAddress() [1/2]

◆ registerAddress() [2/2]

◆ registerObject() [1/2]

◆ registerObject() [2/2]

◆ removePreLoadItem()

◆ resetPreLoad()

◆ retrieveObject()

◆ rootCLID()

◆ rootName()

◆ selectStore()

◆ setDataLoader()

◆ setNumberOfStores()

◆ setRoot() [1/2]

◆ setRoot() [2/2]

◆ traverseSubTree() [1/2]

◆ traverseSubTree() [2/2]

◆ traverseTree()

◆ unlinkObject() [1/3]

◆ unlinkObject() [2/3]

◆ unlinkObject() [3/3]

◆ unregisterAddress() [1/2]

◆ unregisterAddress() [2/2]

◆ unregisterObject() [1/3]

◆ unregisterObject() [2/3]

◆ unregisterObject() [3/3]

◆ updateObject() [1/2]

◆ updateObject() [2/2]

Member Data Documentation

◆ m_dataLoader

◆ m_estStoreBuckets

◆ m_followLinksToAncestors

◆ m_forceLeaves

◆ m_freeSlots

◆ m_inhibitPrefixes

◆ m_loader

◆ m_onlyThisID

◆ m_partitions

◆ m_poolSize

◆ m_preLoads

◆ m_printPoolStats

◆ m_rootCLID

◆ m_rootName

◆ m_servedPoolAllocations

◆ m_slots

◆ m_storeBuckets

◆ m_storeEntries

◆ m_usedPoolAllocations

◆ m_usedPoolSize