SG::DataProxy Class Reference

#include <DataProxy.h>

Inheritance diagram for SG::DataProxy:

Public Types
enum	ErrNo {   ALLOK , NOCNVSVC , NOIOA , CNVFAILED ,   T2PREGFAILED , RECURSIVEREAD , NERRORS }
typedef std::string	name_type
typedef std::string	id_type
typedef TransientAddress::TransientClidSet	CLIDCont_t
typedef std::vector< std::string >	AliasCont_t
typedef IStringPool::sgkey_t	sgkey_t

Public Member Functions
	DataProxy ()
	DataProxy (TransientAddress *tAddr, IConverter *pDataLoader, bool constFlag=false, bool resetOnly=true)
	build from TransientAddress Takes ownership of tAddr.
	DataProxy (std::unique_ptr< TransientAddress > tAddr, IConverter *pDataLoader, bool constFlag=false, bool resetOnly=true)
	build from TransientAddress
	DataProxy (TransientAddress &&tAddr, IConverter *pDataLoader, bool constFlag=false, bool resetOnly=true)
	DataProxy (DataObject *dObject, TransientAddress *tAddr, bool constFlag=false, bool resetOnly=true)
	build from DataObject
	DataProxy (DataObject *dObject, TransientAddress &&tAddr, bool constFlag=false, bool resetOnly=true)
virtual	~DataProxy ()

IRegistry implementation
typedef std::vector< IResetable * >	handleList_t
	list of bound DataHandles
typedef std::recursive_mutex	mutex_t
typedef std::lock_guard< mutex_t >	lock_t
typedef std::recursive_mutex	objMutex_t
typedef std::lock_guard< objMutex_t >	objLock_t
class	SG::DataStore
	For access to requestRelease.
unsigned int	m_refCount {}
bool	m_resetFlag = true
	reset and not delete: default is true
bool	m_boundHandles {}
	True if there are any bound handles.
std::atomic< bool >	m_const {}
	Is the proxy currently const?
bool	m_origConst {}
	Was the proxy created as const?
std::atomic< DataObject * >	m_dObject = nullptr
TransientAddress	m_tAddress
IConverter *	m_dataLoader {}
T2pMap *	m_t2p {}
handleList_t	m_handles
mutex_t	m_mutex
Athena::IMessageSvcHolder	m_ims
std::atomic< IProxyDict * >	m_store {}
	The store of which we are a part.
objMutex_t	m_objMutex
virtual unsigned long	addRef () override final
	Add reference to object.
virtual unsigned long	release () override final
	release reference to object
unsigned long	refCount () const
	return refCount
virtual const name_type &	name () const override final
	Retrieve data object key == string.
virtual const id_type &	identifier () const override final
	Retrieve data object key == string duplicated for Gaudi folks does same as name().
virtual DataObject *object	ATLAS_NOT_CONST_THREAD_SAFE () const override final
	Retrieve DataObject.
virtual void	setAddress (IOpaqueAddress *ioa) override final
	set an IOpaqueAddress
void	setAddress (CxxUtils::RefCountedPtr< IOpaqueAddress > ioa)
	set an IOpaqueAddress
virtual IOpaqueAddress *	address () const override final
	Retrieve IOpaqueAddress.
virtual IDataProviderSvc *	dataSvc () const override final
	set DataSvc (Gaudi-specific); do nothing for us
sgkey_t	sgkey () const
	< Get the primary (hashed) SG key.
void	setSGKey (sgkey_t sgkey)
	Return the ID of the store containing this proxy.
StoreID::type	storeID () const
	check if it is a transient ID (primary or symLinked):
bool	transientID (CLID id) const
	return the list of transient IDs (primary or symLinked):
CLIDCont_t	transientID () const
void	setTransientID (CLID id)
	Add a new transient ID.
AliasCont_t	alias () const
	access set of proxy aliases Returns a COPY of the alias set.
bool	hasAlias (const std::string &key) const
	Test to see if a given string is in the alias set.
void	setAlias (const std::string &key)
	Add a new proxy alias.
bool	removeAlias (const std::string &key)
	remove alias from proxy
IAddressProvider *	provider ()
	Return the address provider.
void	setProvider (IAddressProvider *provider, StoreID::type storeID)
	Set the address provider.
void	setID (CLID id, const std::string &key)
	Set the CLID / key.
void	reset (bool hard=false)
	Other methods of DataProxy (not in Interface IRegistry):
void	finalReset ()
bool	isValid () const
	called by destructor
bool	isValidAddress () const
	is the address valid?
bool	isValidObject () const
	is the object valid?
bool	updateAddress ()
void	setObject (DataObject *obj, bool doreg=true)
	set DataObject If doreg is true, then call setRegistry to set the backpointer from obj to the proxt.
DataObject *	accessData ()
	Access DataObject on-demand using conversion service.
ErrNo	errNo () const
CLID	clID () const
	Retrieve clid.
bool	isConst () const
	Check if it is a const object.
void	setConst ()
	Mark this object as const.
void	resetOnly (const bool &flag)
	set the reset only flag: Clear Store will reset and not delete.
bool	isResetOnly () const
	Check reset only:
bool	bindHandle (IResetable *ir)
void	unbindHandle (IResetable *ir)
void	setT2p (T2pMap *t2p)
virtual void	registerTransient (void *p) override final
	Register a transient object in a t2p map.
void	setStore (IProxyDict *store)
	Set the store of which we're a part.
IProxyDict *	store ()
	Return the store of which we're a part.
const IProxyDict *	store () const
	Return the store of which we're a part.
void	resetBoundHandles (bool hard)
	reset the bound DataHandles If HARD is true, then the bound objects should also clear any data that depends on the identity of the current event store.
IConverter *	loader ()
std::unique_ptr< DataObject >	readData ()
	Read in a new copy of the object referenced by this proxy.
	DataProxy (const DataProxy &)=delete
DataProxy &	operator= (const DataProxy &)=delete
DataObject *	accessDataOol ()
	Out-of-line part of accessData().
bool	requestRelease (bool force, bool hard)
	Reset/release a proxy at the end of an event.
void	resetRef ()
	Drop the reference to the data object.
void	lock (objLock_t &, DataObject *dobj)
	Lock the data object we're holding, if any.
std::unique_ptr< DataObject >	readData (objLock_t &objLock, ErrNo *errNo)
	Read in a new copy of the object referenced by this proxy.
void	setObject (objLock_t &objLock, DataObject *obj, bool doreg)
	set DataObject If doreg is true, then call setRegistry to set the backpointer from obj to the proxt.
const EventContext &	contextFromStore () const
	Retrieve the EventContext saved in the owning store.

Detailed Description

Definition at line 44 of file DataProxy.h.

Member Typedef Documentation

AliasCont_t

typedef std::vector<std::string> SG::DataProxy::AliasCont_t

Definition at line 55 of file DataProxy.h.

CLIDCont_t

typedef TransientAddress::TransientClidSet SG::DataProxy::CLIDCont_t

Definition at line 54 of file DataProxy.h.

handleList_t

typedef std::vector<IResetable*> SG::DataProxy::handleList_t

private

list of bound DataHandles

Definition at line 332 of file DataProxy.h.

id_type

typedef std::string SG::DataProxy::id_type

Definition at line 53 of file DataProxy.h.

lock_t

typedef std::lock_guard<mutex_t> SG::DataProxy::lock_t

private

Definition at line 341 of file DataProxy.h.

mutex_t

typedef std::recursive_mutex SG::DataProxy::mutex_t

private

Definition at line 340 of file DataProxy.h.

name_type

typedef std::string SG::DataProxy::name_type

Definition at line 52 of file DataProxy.h.

objLock_t

typedef std::lock_guard<objMutex_t> SG::DataProxy::objLock_t

private

Definition at line 355 of file DataProxy.h.

objMutex_t

typedef std::recursive_mutex SG::DataProxy::objMutex_t

private

Definition at line 354 of file DataProxy.h.

sgkey_t

typedef IStringPool::sgkey_t SG::DataProxy::sgkey_t

Definition at line 56 of file DataProxy.h.

Member Enumeration Documentation

ErrNo

enum SG::DataProxy::ErrNo

Enumerator
ALLOK
NOCNVSVC
NOIOA
CNVFAILED
T2PREGFAILED
RECURSIVEREAD
NERRORS

Definition at line 48 of file DataProxy.h.

               {ALLOK, NOCNVSVC, NOIOA, CNVFAILED, T2PREGFAILED,
                RECURSIVEREAD, NERRORS};

Constructor & Destructor Documentation

DataProxy() [1/7]

DataProxy::DataProxy

(

)

Definition at line 93 of file DataProxy.cxx.

{ 
}

DataProxy() [2/7]

DataProxy::DataProxy	(	TransientAddress *	tAddr,
		IConverter *	pDataLoader,
		bool	constFlag = false,
		bool	resetOnly = true )

build from TransientAddress Takes ownership of tAddr.

Definition at line 99 of file DataProxy.cxx.

  : DataProxy (std::move(*tAddr),
               svc, constFlag, resetOnly)
{
  delete tAddr;
}

DataProxy() [3/7]

DataProxy::DataProxy	(	std::unique_ptr< TransientAddress >	tAddr,
		IConverter *	pDataLoader,
		bool	constFlag = false,
		bool	resetOnly = true )

build from TransientAddress

Definition at line 110 of file DataProxy.cxx.

  : DataProxy (std::move(*tAddr), svc, constFlag, resetOnly)
{
  //assert( tAddr->clID() != 0 );
  if (svc) svc->addRef();
}

DataProxy() [4/7]

DataProxy::DataProxy	(	TransientAddress &&	tAddr,
		IConverter *	pDataLoader,
		bool	constFlag = false,
		bool	resetOnly = true )

Definition at line 119 of file DataProxy.cxx.

                                            :
  m_resetFlag(resetOnly),
  m_const(constFlag),
  m_origConst(constFlag),
  m_tAddress(std::move(tAddr)),
  m_dataLoader(svc)
{
  //assert( tAddr->clID() != 0 );
  if (svc) svc->addRef();
}

DataProxy() [5/7]

DataProxy::DataProxy	(	DataObject *	dObject,
		TransientAddress *	tAddr,
		bool	constFlag = false,
		bool	resetOnly = true )

build from DataObject

Definition at line 134 of file DataProxy.cxx.

                                            :
  m_resetFlag(resetOnly),
  m_const(constFlag),
  m_origConst(constFlag),
  m_tAddress(std::move(*tAddr))
{
  setObject(dObject);
  delete tAddr;
}

DataProxy() [6/7]

DataProxy::DataProxy	(	DataObject *	dObject,
		TransientAddress &&	tAddr,
		bool	constFlag = false,
		bool	resetOnly = true )

Definition at line 146 of file DataProxy.cxx.

                                            :
  m_resetFlag(resetOnly),
  m_const(constFlag),
  m_origConst(constFlag),
  m_tAddress(std::move(tAddr))
{
  setObject(dObject);
}

~DataProxy()

DataProxy::~DataProxy ( )

virtual

Definition at line 158 of file DataProxy.cxx.

{  
  finalReset();
}

DataProxy() [7/7]

SG::DataProxy::DataProxy ( const DataProxy & )

privatedelete

Member Function Documentation

accessData()

DataObject * SG::DataProxy::accessData

(

)

Access DataObject on-demand using conversion service.

Exceptions

runtime_error

when converter fails

accessDataOol()

DataObject * DataProxy::accessDataOol ( )

private

Out-of-line part of accessData().

Access DataObject on-demand using conversion service.

Definition at line 502 of file DataProxy.cxx.

{
  // This is done in the inlined accessData().
  //if (0 != m_dObject) return m_dObject;  // cached object
 
  objLock_t objLock (m_objMutex);
  // Check again after acquiring the lock.
  if (0 != m_dObject) return m_dObject;  // cached object
 
  if (isValidAddress()) {
    // An address provider called by isValidAddress may have set the object
    // pointer directly, rather than filling in the address.  So check
    // the cached object pointer again.
    if (0 != m_dObject) return m_dObject;  // cached object
  }
 
  std::unique_ptr<DataObject> obju = readData (objLock, &m_errno);
  if (!obju) {
    if (m_errno == NOIOA) {
      MsgStream gLog(m_ims, "DataProxy");
      gLog << MSG::WARNING
           << "accessData:  IOA pointer not set" <<endmsg;
    }
    else if (m_errno == CNVFAILED) {
      MsgStream gLog(m_ims, "DataProxy");
      gLog << MSG::WARNING 
           << "accessData: conversion failed for data object " 
           <<m_tAddress.clID() << '/' << m_tAddress.name() << '\n'
           <<" Returning NULL DataObject pointer  " << endmsg;
    }
    setObject(objLock, 0, true);
    return 0;   
  }
 
  DataBucketBase* bucket = dynamic_cast<DataBucketBase*>(obju.get());
  if (m_t2p) {
    if (bucket) {
      void* payload = bucket->object();
      m_t2p->t2pRegister(payload, this);
      m_errno=ALLOK;
 
      // Register bases as well.
      const SG::BaseInfoBase* bi = SG::BaseInfoBase::find (m_tAddress.clID());
      if (bi) {
        std::vector<CLID> base_clids = bi->get_bases();
        for (unsigned i=0; i < base_clids.size(); ++i) {
          // nb. DataProxy_cast here will give an infinite recursion!
          void* bobj = SG::Storable_cast (obju.get(), base_clids[i], nullptr, true);
          if (bobj && bobj != payload)
            m_t2p->t2pRegister (bobj, this);
        }
      }
    }
    else {
      MsgStream gLog(m_ims, "DataProxy");
      gLog << MSG::ERROR
           << "accessData: ERROR registering object in t2p map" 
           <<m_tAddress.clID() << '/' << m_tAddress.name() << '\n'
           <<" Returning NULL DataObject pointer  " << endmsg;
      obju.reset();
      m_errno=T2PREGFAILED;
    }
  }
 
  // Must get everything else set up before setting m_dObject, because
  // once we set it, it's immediately visible to other threads.
  // In particular, we were previously doing this before the t2p registration.
  // This meant that another thread could retrieve the pointer from
  // the proxy, but then fail trying to map the pointer back to the proxy.
  // See ATEAM-1126.
  std::atomic_thread_fence (std::memory_order_seq_cst);
  setObject(objLock, obju.release(), true);
 
  return m_dObject;
}

addRef()

unsigned long DataProxy::addRef ( )

finaloverridevirtual

Add reference to object.

Definition at line 290 of file DataProxy.cxx.

{ 
  lock_t lock (m_mutex);
  return ++m_refCount;
}

address()

virtual IOpaqueAddress * SG::DataProxy::address ( ) const

finaloverridevirtual

Retrieve IOpaqueAddress.

alias()

AliasCont_t SG::DataProxy::alias

(

)

const

access set of proxy aliases Returns a COPY of the alias set.

ATLAS_NOT_CONST_THREAD_SAFE()

virtual DataObject *object SG::DataProxy::ATLAS_NOT_CONST_THREAD_SAFE ( ) const

finaloverridevirtual

Retrieve DataObject.

bindHandle()

bool DataProxy::bindHandle

(

IResetable *

ir

)

Definition at line 186 of file DataProxy.cxx.

                                         {
  assert(ir);
  lock_t lock (m_mutex);
  if (ir->isSet()) {
    return false;
  } else {
    m_handles.push_back(ir);
    m_boundHandles = true;
    if (IProxyDict* store = m_store)
      store->boundHandle(ir);
    return true;
  }
}

clID()

CLID SG::DataProxy::clID

(

)

const

Retrieve clid.

contextFromStore()

const EventContext & DataProxy::contextFromStore ( ) const

private

Retrieve the EventContext saved in the owning store.

Retrieve the EventContext saved in the parent store.

If there is no context recorded in the store, return a default-initialized context.

Do not call this holding m_mutex, or we could deadlock (ATEAM-755). (The store lock must be acquired before the DataProxy lock.)

Definition at line 710 of file DataProxy.cxx.

{
  IProxyDict* store = m_store;
  if (store) {
    static const SG::sgkey_t ctxkey = 
      store->stringToKey ("EventContext", ClassID_traits<EventContext>::ID());
    SG::DataProxy* proxy = store->proxy_exact (ctxkey);
    if (proxy && proxy->object()) {
      EventContext* ctx = SG::DataProxy_cast<EventContext> (proxy);
      if (ctx) return *ctx;
    }
  }
  static const EventContext emptyContext;
  return emptyContext;
}

dataSvc()

virtual IDataProviderSvc * SG::DataProxy::dataSvc ( ) const

finaloverridevirtual

set DataSvc (Gaudi-specific); do nothing for us

errNo()

ErrNo SG::DataProxy::errNo

(

)

const

finalReset()

void DataProxy::finalReset

(

)

Definition at line 227 of file DataProxy.cxx.

{
  handleList_t handles;
  {
    objLock_t objLock (m_objMutex);
    lock_t lock (m_mutex);
    m_const=false; //hack to force the resetting of proxy ptr in VarHandleBase
 
    handles = m_handles;
 
    DataObject* dobj = m_dObject;
    resetGaudiRef(dobj);
    m_dObject = dobj;
    resetGaudiRef(m_dataLoader);
 
    if (m_handles.empty()) {
      m_boundHandles = false;
    }
  }
 
  for (auto ih: handles) {
    if (0 != ih) ih->finalReset();
  }
}

hasAlias()

bool SG::DataProxy::hasAlias

(

const std::string &

key

)

const

Test to see if a given string is in the alias set.

identifier()

virtual const id_type & SG::DataProxy::identifier ( ) const

finaloverridevirtual

Retrieve data object key == string duplicated for Gaudi folks does same as name().

isConst()

bool SG::DataProxy::isConst

(

)

const

Check if it is a const object.

isResetOnly()

bool SG::DataProxy::isResetOnly

(

)

const

Check reset only:

isValid()

bool SG::DataProxy::isValid

(

)

const

called by destructor

am I valid?

isValidAddress()

bool DataProxy::isValidAddress

(

)

const

is the address valid?

Definition at line 580 of file DataProxy.cxx.

{
  // Looking up the context is relatively expensive.
  // So first try isValid() without the context.
  {
    lock_t lock (m_mutex);
    if (const_cast<DataProxy*>(this)->m_tAddress.isValid(nullptr)) {
      return true;
    }
  }
  // Get the context.  (Must not be holding m_mutex here.)
  const EventContext& ctx = contextFromStore();
  // Try again with the context.
  lock_t lock (m_mutex);
  return const_cast<DataProxy*>(this)->m_tAddress.isValid(&ctx);
}

isValidObject()

bool SG::DataProxy::isValidObject

(

)

const

is the object valid?

loader()

IConverter * SG::DataProxy::loader

(

)

lock()

void DataProxy::lock ( objLock_t & , DataObject * dobj )

private

Lock the data object we're holding, if any.

Parameters

dobj	The data object.

Should be called with the mutex held.

Should be called with the mutex held.

Definition at line 693 of file DataProxy.cxx.

{
  DataBucketBase* bucket = dynamic_cast<DataBucketBase*>(dobj);
  if (bucket)
    bucket->lock();
}

name()

virtual const name_type & SG::DataProxy::name ( ) const

finaloverridevirtual

Retrieve data object key == string.

operator=()

DataProxy & SG::DataProxy::operator= ( const DataProxy & )

privatedelete

provider()

IAddressProvider * SG::DataProxy::provider

(

)

Return the address provider.

readData() [1/2]

std::unique_ptr< DataObject > DataProxy::readData

(

)

Read in a new copy of the object referenced by this proxy.

If this proxy has an associated loader and address, then load a new copy of the object and return it. Any existing copy held by the proxy is unaffected.

This will fail if the proxy does not refer to an object read from an input file.

Returns a null pointer on failure.

Definition at line 409 of file DataProxy.cxx.

{
  // Public wrapper for readData().
  objLock_t objLock (m_objMutex);
  return readData (objLock, nullptr);
}

readData() [2/2]

std::unique_ptr< DataObject > DataProxy::readData ( objLock_t & objLock, ErrNo * errNo )

private

Read in a new copy of the object referenced by this proxy.

Parameters

errNo

If non-null, set to the resulting error code.

If this proxy has an associated loader and address, then load a new copy of the object and return it. Any existing copy held by the proxy is unaffected.

This will fail if the proxy does not refer to an object read from an input file.

Definition at line 428 of file DataProxy.cxx.

{
  if (errNo) {
    if (*errNo == RECURSIVEREAD) {
      // This can end up being called from noexcept functions.
      // Creating a MsgStream can throw an exception --- don't let
      // it escape.
      try {
        MsgStream gLog(m_ims, "DataProxy");
        gLog << MSG::ERROR
             << "readData: ERROR recursive read for object" 
             <<m_tAddress.clID() << '/' << m_tAddress.name() << '\n'
             <<" Returning NULL DataObject pointer  " << endmsg;
      }
      catch (const GaudiException&) {
        std::println (std::cerr, "DataProxy::readData: Problem creating MsgStream");
      }
      return nullptr;
    }
    *errNo = RECURSIVEREAD;
  }
 
  IConverter* dataLoader;
  IProxyDict* store;
  IOpaqueAddress* address;
  {
    lock_t lock (m_mutex);
    if (0 == m_dataLoader) {
      //MsgStream gLog(m_ims, "DataProxy");
      //gLog << MSG::WARNING
      //      << "accessData:  IConverter ptr not set" <<endmsg;
      if (errNo) *errNo=NOCNVSVC;
      return nullptr;
    }
 
    dataLoader = m_dataLoader;
    store = m_store;
    address = m_tAddress.address();
  }
 
  if (!isValidAddress()) {
    //MsgStream gLog(m_ims, "DataProxy");
    //gLog << MSG::WARNING
    //   << "accessData:  IOA pointer not set" <<endmsg;
    if (errNo) *errNo=NOIOA;
    return nullptr;
  }
 
  SG::CurrentEventStore::Push push (store);
 
  DataObject* obj = nullptr;
  StatusCode sc;
  if (store)
    sc = store->createObj (dataLoader, address, obj);
  else
    sc = dataLoader->createObj (address, obj);
  if (sc.isSuccess()) {
    if (errNo && *errNo == RECURSIVEREAD) *errNo = ALLOK;
    return std::unique_ptr<DataObject>(obj);
  }
  if (!address) {
    MsgStream gLog(m_ims, "DataProxy");
    gLog << MSG::ERROR
         << "readData: no address for " << clID() << "/" << name()
         << " but validAddress returned true.  You may be trying to retrieve"
         << " alignments during initialization without having defined a campaign."
         << endmsg;
  }
  if (errNo) *errNo = CNVFAILED;
  return nullptr;
}

refCount()

unsigned long DataProxy::refCount

(

)

const

return refCount

Definition at line 283 of file DataProxy.cxx.

{
  lock_t lock (m_mutex);
  return m_refCount;
}

registerTransient()

void DataProxy::registerTransient ( void * p )

finaloverridevirtual

Register a transient object in a t2p map.

Parameters

trans

The object to register.

(IRegisterTransient interface.)

Parameters

trans

The object to register.

Implements SG::IRegisterTransient.

Definition at line 680 of file DataProxy.cxx.

{
  lock_t lock (m_mutex);
  if (m_t2p)
    m_t2p->t2pRegister (p, this);
}

release()

unsigned long DataProxy::release ( )

finaloverridevirtual

release reference to object

Definition at line 297 of file DataProxy.cxx.

{
  unsigned long count;
  {
    lock_t lock (m_mutex);
    count = --m_refCount;
  }
  if ( 0 == count ) delete this;
  return count;
}

removeAlias()

bool SG::DataProxy::removeAlias

(

const std::string &

key

)

remove alias from proxy

requestRelease()

bool DataProxy::requestRelease ( bool force, bool hard )

private

Reset/release a proxy at the end of an event.

Parameters

force	If true, force a release rather than a reset.
hard	Do a hard reset if true.

Returns

True if the caller should release the proxy.

This is usually called at the end of an event. No locking is done, so there should be no other threads accessing this proxy.

Release' means that we want to remove the proxy from the store. Reset' means that we keep the proxy, but remove the data object that it references. Each proxy has a flag saying whether it wants to do a release or a reset. This can be forced via the FORCE argument; this would typically be done when deleting the store. This function does not actually release the proxy. If it returns true, the caller is expected to release the proxy.

See AthenaKernel/IResetable.h for the meaning of HARD.

Definition at line 330 of file DataProxy.cxx.

                                                    {
 
  if (m_boundHandles) {
    resetBoundHandles(hard);
  }
  bool canRelease = force;
  if (!m_resetFlag) canRelease = true;
#if 0
  MsgStream gLog(m_ims, "DataProxy");
  if (gLog.level() <= MSG::VERBOSE) {
    gLog << MSG::VERBOSE << "requestRelease(): "
     << (canRelease ? " release " : " reset")
     <<" object " 
     << name() << " CLID " << clID() << " address " << MSG::hex
     << object() << MSG::dec << endmsg;
  }
#endif
  if (!canRelease) {
    resetRef();
  }
  return canRelease;
}

reset()

void DataProxy::reset

(

bool

hard = false

)

Other methods of DataProxy (not in Interface IRegistry):

Reset DataObject, Handles and IOpaqueAddress: If HARD is true, then the bound objects should also clear any data that depends on the identity of the current event store. (See IResetable.h.)

Definition at line 217 of file DataProxy.cxx.

{
  resetBoundHandles (hard);
 
  objLock_t objLock (m_objMutex);
  lock_t lock (m_mutex);
  resetRef();
}

resetBoundHandles()

void DataProxy::resetBoundHandles

(

bool

hard

)

reset the bound DataHandles If HARD is true, then the bound objects should also clear any data that depends on the identity of the current event store.

don't need no comment

(See IResetable.h.)

Definition at line 253 of file DataProxy.cxx.

                                            {
  handleList_t handles;
  {
    lock_t lock (m_mutex);
    // Early exit if the list is empty.
    if (!m_boundHandles) return;
 
    // Make a copy and drop the lock, so we're not holding the lock
    // during the callback.
    handles = m_handles;
  }
 
  for (IResetable* h : handles) {
    h->reset(hard);
  }
}

resetOnly()

void SG::DataProxy::resetOnly

(

const bool &

flag

)

set the reset only flag: Clear Store will reset and not delete.

resetRef()

void DataProxy::resetRef ( )

inlineprivate

Drop the reference to the data object.

Definition at line 203 of file DataProxy.cxx.

{
  // Skip calling resetGaudiRef for the case where the proxy has never
  // been defererenced.
  if (m_dObject) {
    DataObject* dobj = m_dObject;
    resetGaudiRef(dobj);
    m_dObject = dobj;
  }
  m_tAddress.reset();
  m_const = m_origConst;
}

setAddress() [1/2]

void DataProxy::setAddress

(

CxxUtils::RefCountedPtr< IOpaqueAddress >

ioa

)

set an IOpaqueAddress

Definition at line 389 of file DataProxy.cxx.

{
  lock_t lock (m_mutex);
  m_tAddress.setAddress(std::move(address));
}

setAddress() [2/2]

void DataProxy::setAddress ( IOpaqueAddress * ioa )

finaloverridevirtual

set an IOpaqueAddress

Definition at line 382 of file DataProxy.cxx.

{
  lock_t lock (m_mutex);
  m_tAddress.setAddress(address);
}

setAlias()

void SG::DataProxy::setAlias

(

const std::string &

key

)

Add a new proxy alias.

setConst()

void DataProxy::setConst

(

)

Mark this object as const.

(Lock the object.)

If the object held that derives from ILockable, then we also call lock on the object.

Definition at line 176 of file DataProxy.cxx.

{
  objLock_t objLock (m_objMutex);
  lock_t lock (m_mutex);
  if (!m_const) {
    m_const = true;
    this->lock (objLock, m_dObject);
  }
}

setID()

void SG::DataProxy::setID	(	CLID	id,
		const std::string &	key )

Set the CLID / key.

This will only succeed if the clid/key are currently clear.

setObject() [1/2]

void DataProxy::setObject	(	DataObject *	obj,
		bool	doreg = true )

set DataObject If doreg is true, then call setRegistry to set the backpointer from obj to the proxt.

set a DataObject address

Definition at line 374 of file DataProxy.cxx.

{
  objLock_t objLock (m_objMutex);
  setObject (objLock, dObject, doreg);
}

setObject() [2/2]

void DataProxy::setObject ( objLock_t & objLock, DataObject * obj, bool doreg )

private

set DataObject If doreg is true, then call setRegistry to set the backpointer from obj to the proxt.

set a DataObject address If doreg is true, then call setRegistry to set the backpointer from obj to the proxt.

Definition at line 356 of file DataProxy.cxx.

{
  DataObject* dobj = m_dObject.exchange (nullptr);
  std::atomic_thread_fence (std::memory_order_seq_cst);
  setGaudiRef(dObject, dobj);
  if (0 != dobj) {
    if (doreg) dobj->setRegistry(this);
    if (m_const) this->lock (objLock, dobj);
  }
  // Be sure the settings above happen before we set m_dObject.
  // Otherwise other threads may be able to see the object before those
  // settings have been made.
  std::atomic_thread_fence (std::memory_order_seq_cst);
  m_dObject = dobj;
}

setProvider()

void SG::DataProxy::setProvider	(	IAddressProvider *	provider,
		StoreID::type	storeID )

Set the address provider.

setSGKey()

void SG::DataProxy::setSGKey

(

sgkey_t

sgkey

)

Return the ID of the store containing this proxy.

setStore()

void SG::DataProxy::setStore

(

IProxyDict *

store

)

Set the store of which we're a part.

setT2p()

void DataProxy::setT2p

(

T2pMap *

t2p

)

Definition at line 163 of file DataProxy.cxx.

{
  lock_t lock (m_mutex);
  m_t2p = t2p;
}

setTransientID()

void SG::DataProxy::setTransientID

(

CLID

id

)

Add a new transient ID.

sgkey()

sgkey_t SG::DataProxy::sgkey

(

)

const

< Get the primary (hashed) SG key.

Set the primary (hashed) SG key.

store() [1/2]

IProxyDict * SG::DataProxy::store

(

)

Return the store of which we're a part.

store() [2/2]

const IProxyDict * SG::DataProxy::store

(

)

const

Return the store of which we're a part.

storeID()

StoreID::type SG::DataProxy::storeID

(

)

const

check if it is a transient ID (primary or symLinked):

transientID() [1/2]

CLIDCont_t SG::DataProxy::transientID

(

)

const

transientID() [2/2]

bool SG::DataProxy::transientID

(

CLID

id

)

const

return the list of transient IDs (primary or symLinked):

unbindHandle()

void DataProxy::unbindHandle

(

IResetable *

ir

)

Definition at line 270 of file DataProxy.cxx.

                                           {
  assert(ir);
  lock_t lock (m_mutex);
  auto ifr = find(m_handles.begin(), m_handles.end(), ir );
  if (ifr != m_handles.end()) {
    m_handles.erase(ifr);
    if (IProxyDict* store = m_store)
      store->unboundHandle(ir);
  }
  m_boundHandles = !m_handles.empty();
}

updateAddress()

bool DataProxy::updateAddress

(

)

Definition at line 597 of file DataProxy.cxx.

{
  // Be sure to get the context before acquiring the lock.
  const EventContext& ctx = contextFromStore();
  lock_t lock (m_mutex);
  return m_tAddress.isValid(&ctx, true);
}

Friends And Related Symbol Documentation

SG::DataStore

friend class SG::DataStore

friend

For access to requestRelease.

Definition at line 265 of file DataProxy.h.

Member Data Documentation

m_boundHandles

bool SG::DataProxy::m_boundHandles {}

private

True if there are any bound handles.

Definition at line 316 of file DataProxy.h.

{};

m_const

std::atomic<bool> SG::DataProxy::m_const {}

private

Is the proxy currently const?

Definition at line 319 of file DataProxy.h.

{};

m_dataLoader

IConverter* SG::DataProxy::m_dataLoader {}

private

Definition at line 327 of file DataProxy.h.

{};

m_dObject

std::atomic<DataObject*> SG::DataProxy::m_dObject = nullptr

private

Definition at line 323 of file DataProxy.h.

m_handles

handleList_t SG::DataProxy::m_handles

private

Definition at line 333 of file DataProxy.h.

m_ims

Athena::IMessageSvcHolder SG::DataProxy::m_ims

private

Definition at line 344 of file DataProxy.h.

m_mutex

mutex_t SG::DataProxy::m_mutex

mutableprivate

Definition at line 342 of file DataProxy.h.

m_objMutex

objMutex_t SG::DataProxy::m_objMutex

mutableprivate

Definition at line 356 of file DataProxy.h.

m_origConst

bool SG::DataProxy::m_origConst {}

private

Was the proxy created as const?

Definition at line 321 of file DataProxy.h.

{};

m_refCount

unsigned int SG::DataProxy::m_refCount {}

private

Definition at line 306 of file DataProxy.h.

{};

m_resetFlag

bool SG::DataProxy::m_resetFlag = true

private

reset and not delete: default is true

Definition at line 309 of file DataProxy.h.

m_store

std::atomic<IProxyDict*> SG::DataProxy::m_store {}

private

The store of which we are a part.

Definition at line 347 of file DataProxy.h.

{};

m_t2p

T2pMap* SG::DataProxy::m_t2p {}

private

Definition at line 329 of file DataProxy.h.

{};

m_tAddress

TransientAddress SG::DataProxy::m_tAddress

private

Definition at line 325 of file DataProxy.h.

---

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

• DataProxy.h
• DataProxy.cxx