edm::eventsetup::DataProxy Class Reference

#include <DataProxy.h>

Inheritance diagram for edm::eventsetup::DataProxy:

Public Member Functions
bool	cacheIsValid () const
	DataProxy ()
	DataProxy (DataProxy const &)=delete
void const *	get (EventSetupRecordImpl const &, DataKey const &, bool iTransiently, ActivityRegistry const *, EventSetupImpl const *, ESParentContext const &) const
void const *	getAfterPrefetch (const EventSetupRecordImpl &iRecord, const DataKey &iKey, bool iTransiently) const
virtual void	initializeForNewIOV ()
void	invalidate ()
DataProxy const &	operator= (DataProxy const &)=delete
void	prefetchAsync (WaitingTaskHolder, EventSetupRecordImpl const &, DataKey const &, EventSetupImpl const *, ServiceToken const &, ESParentContext const &) const
ComponentDescription const *	providerDescription () const
	returns the description of the DataProxyProvider which owns this Proxy More...
void	resetIfTransient ()
void	setProviderDescription (ComponentDescription const *iDesc)
virtual	~DataProxy ()

Protected Member Functions
void	clearCacheIsValid ()
virtual void const *	getAfterPrefetchImpl () const =0
virtual void	invalidateCache ()=0
virtual void	invalidateTransientCache ()
virtual void	prefetchAsyncImpl (WaitingTaskHolder, EventSetupRecordImpl const &, DataKey const &iKey, EventSetupImpl const *, ServiceToken const &, ESParentContext const &)=0

Private Attributes
void const *	cache_
std::atomic< bool >	cacheIsValid_
ComponentDescription const *	description_
std::atomic< bool >	nonTransientAccessRequested_

Detailed Description

Description: Base class for data Proxies held by a EventSetupRecord

Usage: This class defines the interface used to handle retrieving data from an EventSetup Record.

Definition at line 42 of file DataProxy.h.

Constructor & Destructor Documentation

DataProxy() [1/2]

DataProxy< RecordT, DataT, Initializer >::DataProxy

(

)

Definition at line 38 of file DataProxy.cc.

        : description_(dummyDescription()),
          cache_(nullptr),
          cacheIsValid_(false),
          nonTransientAccessRequested_(false) {}

DataProxy() [2/2]

edm::eventsetup::DataProxy::DataProxy ( DataProxy const &  )

delete

~DataProxy()

DataProxy< RecordT, DataT, Initializer >::~DataProxy ( )

virtual

Definition at line 44 of file DataProxy.cc.

{}

Member Function Documentation

cacheIsValid()

bool edm::eventsetup::DataProxy::cacheIsValid ( ) const

inline

Definition at line 50 of file DataProxy.h.

References cacheIsValid_.

Referenced by get(), getAfterPrefetch(), and edm::eventsetup::EventSetupRecordImpl::wasGotten().

{ return cacheIsValid_.load(std::memory_order_acquire); }

clearCacheIsValid()

void DataProxy< RecordT, DataT, Initializer >::clearCacheIsValid ( )

protected

Definition at line 46 of file DataProxy.cc.

References cache_, cacheIsValid_, and nonTransientAccessRequested_.

Referenced by invalidate(), and resetIfTransient().

                                      {
      nonTransientAccessRequested_.store(false, std::memory_order_release);
      cache_ = nullptr;
      cacheIsValid_.store(false, std::memory_order_release);
    }

get()

const void * DataProxy< RecordT, DataT, Initializer >::get	(	EventSetupRecordImpl const &	iRecord,
		DataKey const &	iKey,
		bool	iTransiently,
		ActivityRegistry const *	activityRegistry,
		EventSetupImpl const *	iEventSetupImpl,
		ESParentContext const &	iParent
	)		const

Definition at line 99 of file DataProxy.cc.

References cacheIsValid(), Exception, getAfterPrefetch(), and edm::errors::LogicError.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), submitPVValidationJobs.BetterConfigParser::__updateDict(), rrapi.RRApi::columns(), rrapi.RRApi::count(), rrapi.RRApi::data(), betterConfigParser.BetterConfigParser::getCompares(), edm::eventsetup::EventSetupRecordImpl::getFromProxy(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), submitPVValidationJobs.BetterConfigParser::getResultingSection(), rrapi.RRApi::report(), rrapi.RRApi::reports(), rrapi.RRApi::tables(), rrapi.RRApi::tags(), rrapi.RRApi::templates(), and rrapi.RRApi::workspaces().

                                                                     {
      if (!cacheIsValid()) {
        throw edm::Exception(errors::LogicError) << "DataProxy::get called without first doing prefetch.\nThis should "
                                                    "not be able to happen.\nPlease contact framework developers";
      }
      return getAfterPrefetch(iRecord, iKey, iTransiently);
    }

getAfterPrefetch()

void const * DataProxy< RecordT, DataT, Initializer >::getAfterPrefetch	(	const EventSetupRecordImpl &	iRecord,
		const DataKey &	iKey,
		bool	iTransiently
	)		const

Definition at line 77 of file DataProxy.cc.

References cache_, cacheIsValid(), cacheIsValid_, getAfterPrefetchImpl(), LIKELY, nonTransientAccessRequested_, and UNLIKELY.

Referenced by get(), and edm::eventsetup::EventSetupRecordImpl::getFromProxyAfterPrefetch().

                                                                     {
      //We need to set the AccessType for each request so this can't be called in an earlier function in the stack.
      //This also must be before the cache_ check since we want to setCacheIsValid before a possible
      // exception throw. If we don't, 'getImpl' will be called again on a second request for the data.

      if LIKELY (!iTransiently) {
        nonTransientAccessRequested_.store(true, std::memory_order_release);
      }

      if UNLIKELY (!cacheIsValid()) {
        cache_ = getAfterPrefetchImpl();
        cacheIsValid_.store(true, std::memory_order_release);
      }

      if UNLIKELY (nullptr == cache_) {
        throwMakeException(iRecord, iKey);
      }
      return cache_;
    }

getAfterPrefetchImpl()

virtual void const* edm::eventsetup::DataProxy::getAfterPrefetchImpl ( ) const

protectedpure virtual

used to retrieve the data from the implementation. The data is then cached locally.

Implemented in edm::eventsetup::CallbackProxy< CallbackT, RecordT, DataT >, edm::eventsetup::ESSourceDataProxyTemplate< DataT >, edm::eventsetup::ESSourceConcurrentDataProxyTemplate< DataT >, and edm::test::TestDataProxy< T >.

Referenced by getAfterPrefetch().

initializeForNewIOV()

virtual void edm::eventsetup::DataProxy::initializeForNewIOV ( )

inlinevirtual

Reimplemented in DataProxy< RecordT, DataT, Initializer >.

Definition at line 80 of file DataProxy.h.

{}

invalidate()

void edm::eventsetup::DataProxy::invalidate ( )

inline

Definition at line 71 of file DataProxy.h.

References clearCacheIsValid(), and invalidateCache().

                        {
        clearCacheIsValid();
        invalidateCache();
      }

invalidateCache()

virtual void edm::eventsetup::DataProxy::invalidateCache ( )

protectedpure virtual

indicates that the Proxy should invalidate any cached information as that information has 'expired' (i.e. we have moved to a new IOV)

Implemented in edm::eventsetup::DataProxyTemplate< RecordT, DataT >, edm::eventsetup::CallbackProxy< CallbackT, RecordT, DataT >, edm::test::TestDataProxy< T >, and edm::eventsetup::ESSourceDataProxyBase.

Referenced by invalidate(), and invalidateTransientCache().

invalidateTransientCache()

void DataProxy< RecordT, DataT, Initializer >::invalidateTransientCache ( )

protectedvirtual

indicates that the Proxy should invalidate any cached information as that information was accessed transiently and therefore is not intended to be kept over the entire IOV. Default is to call invalidateCache().

Reimplemented in edm::eventsetup::ESSourceDataProxyBase.

Definition at line 59 of file DataProxy.cc.

References invalidateCache().

Referenced by resetIfTransient().

{ invalidateCache(); }

operator=()

DataProxy const& edm::eventsetup::DataProxy::operator= ( DataProxy const &  )

delete

prefetchAsync()

void DataProxy< RecordT, DataT, Initializer >::prefetchAsync	(	WaitingTaskHolder	iTask,
		EventSetupRecordImpl const &	iRecord,
		DataKey const &	iKey,
		EventSetupImpl const *	iEventSetupImpl,
		ServiceToken const &	iToken,
		ESParentContext const &	iParent
	)		const

Definition at line 68 of file DataProxy.cc.

References prefetchAsyncImpl().

Referenced by edm::eventsetup::EventSetupRecordImpl::prefetchAsync().

                                                                        {
      const_cast<DataProxy*>(this)->prefetchAsyncImpl(iTask, iRecord, iKey, iEventSetupImpl, iToken, iParent);
    }

prefetchAsyncImpl()

virtual void edm::eventsetup::DataProxy::prefetchAsyncImpl ( WaitingTaskHolder  , EventSetupRecordImpl const &  , DataKey const &  iKey, EventSetupImpl const *  , ServiceToken const &  , ESParentContext const &    )

protectedpure virtual

This is the function which does the real work of getting the data if it is not already cached. The returning 'void const*' must point to an instance of the class type corresponding to the type designated in iKey. So if iKey refers to a base class interface the pointer must be a pointer to that base class interface and not a pointer to an inheriting class instance.

Implemented in edm::eventsetup::DataProxyTemplate< RecordT, DataT >, edm::eventsetup::CallbackProxy< CallbackT, RecordT, DataT >, edm::eventsetup::ESSourceDataProxyNonConcurrentBase, edm::test::TestDataProxy< T >, and edm::eventsetup::ESSourceDataProxyConcurrentBase.

Referenced by prefetchAsync().

providerDescription()

ComponentDescription const* edm::eventsetup::DataProxy::providerDescription ( ) const

inline

returns the description of the DataProxyProvider which owns this Proxy

Definition at line 68 of file DataProxy.h.

References description_.

Referenced by edm::eventsetup::EventSetupRecordImpl::add(), edm::eventsetup::EventSetupRecordImpl::getFromProxy(), edm::eventsetup::EventSetupRecordImpl::getFromProxyAfterPrefetch(), and edm::eventsetup::EventSetupRecordImpl::providerDescription().

{ return description_; }

resetIfTransient()

void DataProxy< RecordT, DataT, Initializer >::resetIfTransient

(

)

Definition at line 52 of file DataProxy.cc.

References clearCacheIsValid(), invalidateTransientCache(), and nonTransientAccessRequested_.

                                     {
      if (!nonTransientAccessRequested_.load(std::memory_order_acquire)) {
        clearCacheIsValid();
        invalidateTransientCache();
      }
    }

setProviderDescription()

void edm::eventsetup::DataProxy::setProviderDescription ( ComponentDescription const *  iDesc )

inline

Definition at line 78 of file DataProxy.h.

References description_.

{ description_ = iDesc; }

Member Data Documentation

cache_

void const* edm::eventsetup::DataProxy::cache_

mutableprivate

Definition at line 117 of file DataProxy.h.

Referenced by clearCacheIsValid(), and getAfterPrefetch().

cacheIsValid_

std::atomic<bool> edm::eventsetup::DataProxy::cacheIsValid_

mutableprivate

Definition at line 118 of file DataProxy.h.

Referenced by cacheIsValid(), clearCacheIsValid(), and getAfterPrefetch().

description_

ComponentDescription const* edm::eventsetup::DataProxy::description_

private

Definition at line 116 of file DataProxy.h.

Referenced by providerDescription(), and setProviderDescription().

nonTransientAccessRequested_

std::atomic<bool> edm::eventsetup::DataProxy::nonTransientAccessRequested_

mutableprivate

Definition at line 151 of file DataProxy.h.

Referenced by clearCacheIsValid(), getAfterPrefetch(), and resetIfTransient().