#include <TestStore.h>

Inheritance diagram for SGTest::TestStore:

Collaboration diagram for SGTest::TestStore:

Public Types
typedef std::unordered_map< const void , SG::DataProxy >	tmap_t

typedef SG::SGKeyMap< SG::DataProxy * >	kmap_t

typedef std::unordered_map< TestStoreRemap, TestStoreRemap, TestStoreRemapHash >	remap_t

typedef std::mutex	mutex_t

typedef std::lock_guard< mutex_t >	lock_t

typedef SG::sgkey_t	sgkey_t
	Type of the keys. More...

Public Member Functions
virtual unsigned long	addRef () override

virtual unsigned long	release () override

virtual StatusCode	queryInterface (const InterfaceID &, void **) override

virtual std::vector< const SG::DataProxy * >	proxies () const override
	Return the list of all current proxies in store. More...

virtual const std::string *	keyToString (sgkey_t) const override
	Find the string corresponding to a given key. More...

virtual void	registerKey (sgkey_t, const std::string &, CLID) override
	Remember an additional mapping from key to string/CLID. More...

virtual const std::string &	name () const override

virtual SG::DataProxy *	proxy (const void *const pTransient) const override
	Get a proxy referencing a given transient object. More...

virtual SG::DataProxy *	proxy (const CLID &id, const std::string &key) const override
	Get proxy with given id and key. More...

virtual SG::DataProxy *	proxy_exact (SG::sgkey_t sgkey) const override
	Get proxy given a hashed key+clid. More...

virtual sgkey_t	stringToKey (const std::string &str, CLID clid) override
	Find the key for a string/CLID pair. More...

virtual const std::string *	keyToString (sgkey_t key, CLID &clid) const override
	Find the string and CLID corresponding to a given key. More...

virtual bool	tryELRemap (sgkey_t sgkey_in, size_t index_in, sgkey_t &sgkey_out, size_t &index_out) override
	Test to see if the target of an ElementLink has moved. More...

virtual StatusCode	addToStore (CLID, SG::DataProxy *proxy) override
	Add a new proxy to the store. More...

virtual void	boundHandle (IResetable *handle) override
	Tell the store that a handle has been bound to a proxy. More...

virtual void	unboundHandle (IResetable *handle) override
	Tell the store that a handle has been unbound from a proxy. More...

virtual SG::DataProxy *	recordObject (SG::DataObjectSharedPtr< DataObject > obj, const std::string &key, bool allowMods, bool returnExisting) override
	Record an object in the store. More...

template<class T >
void	record (const T *p, const std::string &key)

template<class T >
void	record (std::unique_ptr< T > up, const std::string &key)

void	remap (sgkey_t sgkey_in, sgkey_t sgkey_out, size_t index_in=0, size_t index_out=0)

template<class T >
void	remap (const std::string &key_in, const std::string &key_out, size_t index_in=0, size_t index_out=0)

void	alias (SG::DataProxy *proxy, const std::string &newKey)

SG::DataProxy *	proxy (lock_t &, const void *const pTransient) const

SG::DataProxy *	proxy (lock_t &, const CLID &id, const std::string &key) const

SG::DataProxy *	record1 (lock_t &, const void p, DataObject obj, CLID clid, const std::string &key)

	DeclareInterfaceID (IProxyDict, 2, 0)

	DeclareInterfaceID (INamedInterface, 2, 0)

virtual StatusCode	createObj (IConverter cvt, IOpaqueAddress addr, DataObject *&refpObject)
	Call converter to create an object, possibly with locking. More...

virtual IProxyDict *	hiveProxyDict () override
	Return the current event-slot-specific store. More...

virtual SG::SourceID	sourceID (const std::string &key="EventSelector") const
	Return the metadata source ID for the current event slot. More...

Public Attributes
tmap_t	m_tmap

kmap_t	m_kmap

remap_t	m_remap

SG::StringPool m_stringPool	ATLAS_THREAD_SAFE

std::vector< IResetable * >	m_boundHandles

std::vector< std::pair< CLID, std::string > > m_missedProxies	ATLAS_THREAD_SAFE

mutex_t	m_mutex

Detailed Description

Definition at line 50 of file TestStore.h.

Member Typedef Documentation

◆ kmap_t

typedef SG::SGKeyMap<SG::DataProxy*> SGTest::TestStore::kmap_t

Definition at line 125 of file TestStore.h.

◆ lock_t

typedef std::lock_guard<mutex_t> SGTest::TestStore::lock_t

Definition at line 139 of file TestStore.h.

◆ mutex_t

typedef std::mutex SGTest::TestStore::mutex_t

Definition at line 138 of file TestStore.h.

◆ remap_t

typedef std::unordered_map<TestStoreRemap, TestStoreRemap, TestStoreRemapHash> SGTest::TestStore::remap_t

Definition at line 128 of file TestStore.h.

◆ sgkey_t

typedef SG::sgkey_t IStringPool::sgkey_t

inherited

Type of the keys.

Definition at line 34 of file IStringPool.h.

◆ tmap_t

typedef std::unordered_map<const void*, SG::DataProxy*> SGTest::TestStore::tmap_t

Definition at line 122 of file TestStore.h.

Member Function Documentation

◆ addRef()

unsigned long SGTest::TestStore::addRef ( )

overridevirtual

Definition at line 26 of file TestStore.cxx.

 {
   std::cout << "addRef\n"; std::abort();
 }

◆ addToStore()

StatusCode SGTest::TestStore::addToStore	(	CLID	id,
		SG::DataProxy *	proxy
	)

overridevirtual

Add a new proxy to the store.

Parameters

id	CLID as which the proxy should be added.
proxy	The proxy to add.

Simple addition of a proxy to the store. The key is taken as the primary key of the proxy. Does not handle things like overwrite, history, symlinks, etc. Should return failure if there is already an entry for this clid/key.

Implements IProxyDict.

Definition at line 194 of file TestStore.cxx.

 {
   lock_t lock (m_mutex);
   proxy->setStore (this);
   m_kmap[proxy->sgkey()] = proxy;
   proxy->addRef();
   return StatusCode::SUCCESS;
 }

◆ alias()

void SGTest::TestStore::alias	(	SG::DataProxy *	proxy,
		const std::string &	newKey
	)

Definition at line 254 of file TestStore.cxx.

 {
   lock_t lock (m_mutex);
   sgkey_t sgkey = m_stringPool.stringToKey (newKey, proxy->clID());
   m_kmap[sgkey] = proxy;
   proxy->addRef();
   proxy->setAlias (newKey);
 }

◆ boundHandle()

void SGTest::TestStore::boundHandle ( IResetable * handle )

overridevirtual

Tell the store that a handle has been bound to a proxy.

Parameters

handle The handle that was bound. The default implementation does nothing.

Reimplemented from IProxyDict.

Definition at line 204 of file TestStore.cxx.

 {
   lock_t lock (m_mutex);
   m_boundHandles.push_back (handle);
 }

◆ createObj()

StatusCode IProxyDict::createObj	(	IConverter *	cvt,
		IOpaqueAddress *	addr,
		DataObject *&	refpObject
	)

virtualinherited

Call converter to create an object, possibly with locking.

Parameters

cvt	The converter to call.
addr	Opaque address information for the object to create.
refpObject	Reference to location of the pointer of the created object.

This calls the createObj method on cvt to create the referenced transient object.

This will also lock the store, if that is required.

The default implementation just forwards the method call, with no locking.

Reimplemented in StoreGateSvc, and SGImplSvc.

Definition at line 70 of file IProxyDict.cxx.

 {
   return cvt->createObj (addr, refpObject);
 }

◆ DeclareInterfaceID() [1/2]

IHiveStore::DeclareInterfaceID	(	INamedInterface	,
		2	,
		0
	)

inherited

◆ DeclareInterfaceID() [2/2]

IProxyDict::DeclareInterfaceID	(	IProxyDict	,
		2	,
		0
	)

inherited

◆ hiveProxyDict()

IProxyDict * IProxyDict::hiveProxyDict ( )

overridevirtualinherited

Return the current event-slot-specific store.

The default version just returns this.

Implements IHiveStore.

Reimplemented in StoreGateSvc, and SGImplSvc.

Definition at line 83 of file IProxyDict.cxx.

 {
   return this;
 }

◆ keyToString() [1/2]

const std::string * SGTest::TestStore::keyToString	(	sgkey_t	key,
		CLID &	clid
	)		const

overridevirtual

Find the string and CLID corresponding to a given key.

Parameters

key	The key to look up.
clid[out]	The found CLID.

Returns: Pointer to the string found, or null. We can find keys as long as the corresponding string was given to either stringToKey() or registerKey().

Implements IStringPool.

Definition at line 175 of file TestStore.cxx.

 {
   lock_t lock (m_mutex);
   return m_stringPool.keyToString (key, clid);
 }

◆ keyToString() [2/2]

const std::string * SGTest::TestStore::keyToString ( sgkey_t key ) const

overridevirtual

Find the string corresponding to a given key.

Parameters

key	The key to look up.

Returns: Pointer to the string found, or null. We can find keys as long as the corresponding string was given to either stringToKey() or registerKey().

Implements IStringPool.

Definition at line 50 of file TestStore.cxx.

 {
   return m_stringPool.keyToString (key);
 }

◆ name()

const std::string & SGTest::TestStore::name ( ) const

overridevirtual

Definition at line 115 of file TestStore.cxx.

 {
   static const std::string nm = "TestStore";
   return nm;
 }

◆ proxies()

std::vector< const SG::DataProxy * > SGTest::TestStore::proxies ( ) const

overridevirtual

Return the list of all current proxies in store.

Implements IProxyDict.

Definition at line 44 of file TestStore.cxx.

 {
   std::cout << "proxies\n"; std::abort();
 }

◆ proxy() [1/4]

SG::DataProxy * SGTest::TestStore::proxy	(	const CLID &	id,
		const std::string &	key
	)		const

overridevirtual

Get proxy with given id and key.

Parameters

id	The `CLID` of the desired object.
key	The key of the desired object.

If the key is a null string, then it is a default key. Finding a proxy via the default key should succeed only if there is exactly one object with the given CLID in the store. Finding a proxy via a default key is considered deprecated for the case of the event store.

Returns 0 to flag failure

Implements IProxyDict.

Definition at line 139 of file TestStore.cxx.

 {
   lock_t lock (m_mutex);
   return proxy (lock, id, key);
 }

◆ proxy() [2/4]

SG::DataProxy * SGTest::TestStore::proxy ( const void *const pTransient ) const

overridevirtual

Get a proxy referencing a given transient object.

Parameters

pTransient The object to find.

Returns 0 to flag failure

Implements IProxyDict.

Definition at line 122 of file TestStore.cxx.

 {
   lock_t lock (m_mutex);
   return proxy (lock, pTransient);
 }

◆ proxy() [3/4]

SG::DataProxy * SGTest::TestStore::proxy	(	lock_t &	,
		const CLID &	id,
		const std::string &	key
	)		const

Definition at line 147 of file TestStore.cxx.

 {
   sgkey_t sgkey = m_stringPool.stringToKey (key, id);
   kmap_t::const_iterator i = m_kmap.find (sgkey);
   if (i != m_kmap.end())
     return i->second;
   m_missedProxies.emplace_back (id, key);
   return 0;
 }

◆ proxy() [4/4]

SG::DataProxy * SGTest::TestStore::proxy	(	lock_t &	,
		const void *const	pTransient
	)		const

Definition at line 130 of file TestStore.cxx.

 { 
   tmap_t::const_iterator i = m_tmap.find (pTransient);
   if (i != m_tmap.end())
     return i->second;
   return 0;
 }

◆ proxy_exact()

SG::DataProxy * SGTest::TestStore::proxy_exact ( SG::sgkey_t sgkey ) const

overridevirtual

Get proxy given a hashed key+clid.

Parameters

sgkey Hashed key to look up.

Find an exact match; no handling of aliases, etc. Returns 0 to flag failure.

Implements IProxyDict.

Definition at line 158 of file TestStore.cxx.

 {
   lock_t lock (m_mutex);
   kmap_t::const_iterator i = m_kmap.find (sgkey);
   if (i != m_kmap.end())
     return i->second;
   return 0;
 }

◆ queryInterface()

StatusCode SGTest::TestStore::queryInterface	(	const InterfaceID &	,
		void **
	)

overridevirtual

Definition at line 38 of file TestStore.cxx.

 {
   std::cout << "queryInterface\n"; std::abort();
 }

◆ record() [1/2]

template<class T >

void SGTest::TestStore::record	(	const T *	p,
		const std::string &	key
	)

inline

Definition at line 85 of file TestStore.h.

   {
     lock_t lock (m_mutex);
     T* p_nc ATLAS_THREAD_SAFE = const_cast<T*>(p);
     DataObject* obj = SG::asStorable<T>(p_nc);
     CLID clid = ClassID_traits<T>::ID();
     record1 (lock, p, obj, clid, key);
   }

◆ record() [2/2]

template<class T >

void SGTest::TestStore::record	(	std::unique_ptr< T >	up,
		const std::string &	key
	)

inline

Definition at line 96 of file TestStore.h.

   {
     lock_t lock (m_mutex);
     T* p = up.get();
     DataObject* obj = SG::asStorable<T>(std::move (up));
     CLID clid = ClassID_traits<T>::ID();
     record1 (lock, p, obj, clid, key);
   }

◆ record1()

SG::DataProxy * SGTest::TestStore::record1	(	lock_t &	,
		const void *	p,
		DataObject *	obj,
		CLID	clid,
		const std::string &	key
	)

Definition at line 221 of file TestStore.cxx.

 {
   sgkey_t sgkey = m_stringPool.stringToKey (key, clid);
   if (m_kmap.find (sgkey) != m_kmap.end()) {
     SG::DataProxy* dp = m_kmap[sgkey];
     dp->setObject (obj);
     if (dp->clID() == CLID_NULL)
       dp->setID (clid, key);
     m_tmap[p] = dp;
     return dp;
   }
  
   SG::DataProxy* dp = new SG::DataProxy(obj, SG::TransientAddress(clid, key));
   dp->setStore (this);
   m_tmap[p] = dp;
  
   m_kmap[sgkey] = dp;
   dp->addRef();
   dp->setSGKey (sgkey);
   return dp;
 }

◆ recordObject()

SG::DataProxy * SGTest::TestStore::recordObject	(	SG::DataObjectSharedPtr< DataObject >	obj,
		const std::string &	key,
		bool	allowMods,
		bool	returnExisting
	)

overridevirtual

Record an object in the store.

Parameters

obj	The data object to store.
key	The key as which it should be stored.
allowMods	If false, the object will be recorded as const.
returnExisting	If true, return proxy if this key already exists. If the object has been recorded under a different key, then make an alias. If the object has been recorded under a different clid, then make a link.

Full-blown record. obj should usually be something deriving from SG::DataBucket.

Returns the proxy for the recorded object; nullptr on failure. If the requested CLID/key combination already exists in the store, the behavior is controlled by returnExisting. If true, then the existing proxy is returned; otherwise, nullptr is returned. In either case, obj is destroyed.

Implements IProxyDict.

Definition at line 64 of file TestStore.cxx.

 {
   lock_t lock (m_mutex);
   const void* raw_ptr = obj.get();
   if (DataBucketBase* bucket = dynamic_cast<DataBucketBase*> (obj.get())) {
     raw_ptr = bucket->object();
   }
  
   CLID clid = obj->clID();
   SG::DataProxy* proxy = this->proxy (lock, clid, key);
   if (proxy) {
     if (returnExisting)
       return proxy;
     else
       return nullptr;
   }
  
   proxy = this->proxy (lock, raw_ptr);
   if (proxy) {
     sgkey_t sgkey = m_stringPool.stringToKey (key, obj->clID());
     if (!returnExisting)
       return nullptr;
     if (obj->clID() == proxy->clID()) {
       // Alias?
       m_kmap[sgkey] = proxy;
       proxy->addRef();
       proxy->setAlias (key);
       return proxy;
     }
     if (key == proxy->name()) {
       // Symlink?
       m_kmap[sgkey] = proxy;
       proxy->addRef();
       proxy->setTransientID (obj->clID());
       return proxy;
     }
  
     // Error.
     return nullptr;
   }
   
   proxy = record1 (lock, raw_ptr, obj.get(), clid, key);
   if (!allowMods)
     proxy->setConst();
   return proxy;
 }

◆ registerKey()

void SGTest::TestStore::registerKey	(	sgkey_t	key,
		const std::string &	str,
		CLID	clid
	)

overridevirtual

Remember an additional mapping from key to string/CLID.

Parameters

key	The key to enter.
str	The string to enter.
clid	The CLID associated with the string.

Returns: True if successful; false if the key already corresponds to a different string.

This registers an additional mapping from a key to a string; it can be found later through lookup() on the string. Logs an error if key already corresponds to a different string.

Implements IStringPool.

Definition at line 56 of file TestStore.cxx.

 {
   std::cout << "registerKey\n"; std::abort();
 }

◆ release()

unsigned long SGTest::TestStore::release ( )

overridevirtual

Definition at line 32 of file TestStore.cxx.

 {
   std::cout << "release\n"; std::abort();
 }

◆ remap() [1/2]

template<class T >

void SGTest::TestStore::remap	(	const std::string &	key_in,
		const std::string &	key_out,
		size_t	index_in = `0`,
		size_t	index_out = `0`
	)

inline

Definition at line 111 of file TestStore.h.

   {
     CLID clid = ClassID_traits<T>::ID();
     sgkey_t sgkey_in = stringToKey (key_in, clid);
     sgkey_t sgkey_out = stringToKey (key_out, clid);
     remap (sgkey_in, sgkey_out, index_in, index_out);
   }

◆ remap() [2/2]

void SGTest::TestStore::remap	(	sgkey_t	sgkey_in,
		sgkey_t	sgkey_out,
		size_t	index_in = `0`,
		size_t	index_out = `0`
	)

Definition at line 245 of file TestStore.cxx.

 {
   lock_t lock (m_mutex);
   m_remap[TestStoreRemap(sgkey_in, index_in)] =
     TestStoreRemap(sgkey_out, index_out);
 }

◆ sourceID()

SG::SourceID IProxyDict::sourceID ( const std::string & key = "EventSelector" ) const

virtualinherited

Return the metadata source ID for the current event slot.

Parameters

key	SG key of the DataHeader to query. Returns an empty string if no source has been set.

The default version always returns an empty string.

Reimplemented in StoreGateSvc, and SGImplSvc.

Definition at line 97 of file IProxyDict.cxx.

 {
   return SG::SourceID();
 }

◆ stringToKey()

sgkey_t SGTest::TestStore::stringToKey	(	const std::string &	str,
		CLID	clid
	)

overridevirtual

Find the key for a string/CLID pair.

Parameters

str	The string to look up.
clid	The CLID associated with the string.

Returns: A key identifying the string. A given string will always return the same key. Will abort in case of a hash collision!

Implements IStringPool.

Definition at line 168 of file TestStore.cxx.

 {
   lock_t lock (m_mutex);
   return m_stringPool.stringToKey (str, clid);
 }

◆ tryELRemap()

bool SGTest::TestStore::tryELRemap	(	sgkey_t	sgkey_in,
		size_t	index_in,
		sgkey_t &	sgkey_out,
		size_t &	index_out
	)

overridevirtual

Test to see if the target of an ElementLink has moved.

Parameters

sgkey_in	Original hashed key of the EL.
index_in	Original index of the EL.
sgkey_out[out]	New hashed key for the EL.
index_out[out]	New index for the EL.

Returns: True if there is a remapping; false otherwise.

The default implementation here always returns false.

Reimplemented from IProxyDict.

Definition at line 182 of file TestStore.cxx.

 {
   lock_t lock (m_mutex);
   remap_t::iterator i = m_remap.find (TestStoreRemap (sgkey_in, index_in));
   if (i == m_remap.end()) return false;
   sgkey_out = i->second.key;
   index_out = i->second.index;
   return true;
 }

◆ unboundHandle()

void SGTest::TestStore::unboundHandle ( IResetable * handle )

overridevirtual

Tell the store that a handle has been unbound from a proxy.

Parameters

handle The handle that was unbound. The default implementation does nothing.

Reimplemented from IProxyDict.

Definition at line 211 of file TestStore.cxx.

 {
   lock_t lock (m_mutex);
   std::vector<IResetable*>::iterator it =
     std::find (m_boundHandles.begin(), m_boundHandles.end(), handle);
   if (it != m_boundHandles.end())
     m_boundHandles.erase (it);
 }

Member Data Documentation

◆ ATLAS_THREAD_SAFE [1/2]

SG::StringPool m_stringPool SGTest::TestStore::ATLAS_THREAD_SAFE

mutable

Definition at line 131 of file TestStore.h.

◆ ATLAS_THREAD_SAFE [2/2]

std::vector<std::pair<CLID, std::string> > m_missedProxies SGTest::TestStore::ATLAS_THREAD_SAFE

mutable

Definition at line 136 of file TestStore.h.

◆ m_boundHandles

std::vector<IResetable*> SGTest::TestStore::m_boundHandles

Definition at line 133 of file TestStore.h.

◆ m_kmap

kmap_t SGTest::TestStore::m_kmap

Definition at line 126 of file TestStore.h.

◆ m_mutex

mutex_t SGTest::TestStore::m_mutex

mutable

Definition at line 140 of file TestStore.h.

◆ m_remap

remap_t SGTest::TestStore::m_remap

Definition at line 129 of file TestStore.h.

◆ m_tmap

tmap_t SGTest::TestStore::m_tmap

Definition at line 123 of file TestStore.h.

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

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ kmap_t

◆ lock_t

◆ mutex_t

◆ remap_t

◆ sgkey_t

◆ tmap_t

Member Function Documentation

◆ addRef()

◆ addToStore()

◆ alias()

◆ boundHandle()

◆ createObj()

◆ DeclareInterfaceID() [1/2]

◆ DeclareInterfaceID() [2/2]

◆ hiveProxyDict()

◆ keyToString() [1/2]

◆ keyToString() [2/2]

◆ name()

◆ proxies()

◆ proxy() [1/4]

◆ proxy() [2/4]

◆ proxy() [3/4]

◆ proxy() [4/4]

◆ proxy_exact()

◆ queryInterface()

◆ record() [1/2]

◆ record() [2/2]

◆ record1()

◆ recordObject()

◆ registerKey()

◆ release()

◆ remap() [1/2]

◆ remap() [2/2]

◆ sourceID()

◆ stringToKey()

◆ tryELRemap()

◆ unboundHandle()

Member Data Documentation

◆ ATLAS_THREAD_SAFE [1/2]

◆ ATLAS_THREAD_SAFE [2/2]

◆ m_boundHandles

◆ m_kmap

◆ m_mutex

◆ m_remap

◆ m_tmap